home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / FDRPR121.ZIP / FDRPR.DOC < prev    next >
Encoding:
Text File  |  1994-09-01  |  34.0 KB  |  863 lines
  1. FDRPR - FrontDoor Request Processor for RA // Absolute Solutions
  2. ----------------------------------------------------------------
  3.  
  4.     Copyright 1993, 1994 Mats Wallin; All rights reserved.
  5.  
  6.  
  7.     Introduction
  8.     ------------
  9.  
  10.         FDRPR is a Request Processor for RemoteAccess. A Request
  11.         Processor is a program that FrontDoor executes whenever it
  12.         receives a file request. It is then the Request Processor
  13.         that processes the list of requested files, and returns
  14.         a list of files to FrontDoor, that FrontDoor then will
  15.         send.
  16.  
  17.         The advantage with a Request Processor, is that it can
  18.         be adapted for a special BBS program, or any other
  19.         program on the system that uses the Request Processor.
  20.  
  21.         This Request Processor uses the advantages of the file
  22.         system that RemoteAccess 2.00 and later versions uses.
  23.         This will speed up most file requests, especially for
  24.         systems using CD-ROMs, or accesses the file area over
  25.         a network. It will also, optionally, update the download 
  26.         counters for requested files.
  27.  
  28.         Another advantage of this Request Processor, is the possibility
  29.         to "check" a file request locally. E.g. you can run it
  30.         manually, and see what the result of a file request would
  31.         be for the system requesting files.
  32.  
  33.         One more advantage with this request processor, and that is
  34.         the possibility for it to return a message to the requesting
  35.         system, containing the descriptions of the requested files.
  36.  
  37.  
  38.  
  39.     Requirements
  40.     ------------
  41.  
  42.         FDRPR requires the following thing to run:
  43.  
  44.         * A 80286 processor or higher
  45.  
  46.         * FrontDoor 2.11 or later
  47.  
  48.         * RemoteAccess 2.00 or later
  49.  
  50.         * The environment variable FD pointing to the directory 
  51.           where SETUP.FD is located, or SETUP.FD in the current 
  52.           directory
  53.  
  54.         * A list of requestable directories in the file specified 
  55.           in FDSETUP.
  56.  
  57.         * The environment variable RA pointing to the directory 
  58.           where CONFIG.RA is located, or CONFIG.RA in the current 
  59.           directory
  60.  
  61.  
  62.     Installation
  63.     ------------
  64.  
  65.         It's very easy to install FDRPR. All that is needed, is to
  66.         copy the files in the distribution archive to the directory
  67.         you would like it be in, and then type:
  68.  
  69.         FDRPR INSTALL
  70.  
  71.         The program will then make the necessary changes to your
  72.         SETUP.FD file, and FD will in the future use FDRPR when
  73.         a file request is received.
  74.  
  75.         You should probably also study, and modify, the included
  76.         FDRPR.CFG file, to make sure FDRPR behaves the way you
  77.         would prefer. 
  78.  
  79.         FDRPR needs to install different parameters in SETUP.FD
  80.         depending on which version of FrontDoor you're using. In most
  81.         cases, FDRPR is able to detect FD version itself, but in the
  82.         few caes when it is unable to do that, you will have to
  83.         specify either /NEW (for FD 2.12/2.20b or later) or /OLD (for
  84.         FD 2.11, 2.20 or 2.20a).
  85.  
  86.         It's also possible to decide if FD should swap out of memory
  87.         before running FDRPR. This is done by specifying /SWAP or
  88.         /NOSWAP on the FDRPR INSTALL commandline. The default is
  89.         /SWAP.
  90.  
  91.  
  92.     How to use it
  93.     -------------
  94.  
  95.         FDRPR is executed by FrontDoor every time someone requests
  96.         a file. FDRPR needs some parameters to be able to know
  97.         what to do, and FrontDoor is capable of supplying these
  98.         parameters.
  99.  
  100.         The following is a list of the switches that FDRPR
  101.         supports. Switches can start either with a slash (/) or 
  102.         with a dash (-). All switches can be shortened to the shortest
  103.         unique name. The switches that accepts a value, can use
  104.         either a colon (:) or a equal character (=) between the
  105.         switch name and the actual value.
  106.  
  107.         /address:<aka>      Address of system requesting files
  108.         /bps:<bps>          BPS rate of connection
  109.         /check:<filename>   Check result of requesting specified file
  110.         /info:<filename>    Name of file containing info about
  111.                             requesting system. This parameter can be
  112.                             specified instead of /address, /bps and
  113.                             /operator
  114.         /[un]listed         If the system is listed in nodelist or not
  115.         /minutes:<min>      Max # of minutes for the file request
  116.         /node:<task>        Task number
  117.         /operator:<name>    Name of SysOp requesting files
  118.         /request:<filename> Name of file containing requested files
  119.         /[un]secure         If the session is password protected or not
  120.         /target:<filename>  Name of file where found files should be written
  121.  
  122.         FrontDoor needs to fill in some information in the command
  123.         line, and to do that, it uses the same macros as it does
  124.         for Service Requests. The macros useful for FDRPR is:
  125.  
  126.         =A   The requesting system's network address. Eg.
  127.              2:270/17.
  128.  
  129.         =B   The baud rate of the connection. Eg. 9600.
  130.  
  131.         =E   Same as =T, but the filename does not include the
  132.              complete PATH.
  133.              (Only available with FD 2.11a / 2.20b or later 
  134.              versions).
  135.              This macro is prefered over the =T macro.
  136.  
  137.         =F   Name of file containing information about requesting
  138.              system.
  139.  
  140.         =H   Number of minutes until next event not allowing
  141.              file requests
  142.  
  143.         =M   Same as =F, but the filename does not include the
  144.              complete PATH.
  145.              (Only available with FD 2.11a / 2.20b or later 
  146.              versions).
  147.              This macro is prefered over the =F macro.
  148.  
  149.         =O   The operator of the requesting system. Eg.
  150.              Bilbo_Baggins.
  151.  
  152.         =Q   Same as =R, but the filename does not include the
  153.              complete PATH.
  154.              (Only available with FD 2.11a / 2.20b or later 
  155.              versions).
  156.              This macro is prefered over the =R macro.
  157.  
  158.         =R   Name of file containing requested files
  159.  
  160.         =T   Name of file where found files should be written
  161.  
  162.         =X   Whether or not the session is password protected.
  163.              This macro can have two values, SECURE or
  164.              UNSECURE.
  165.  
  166.         =Y   The current task number used by FD, or 0 in the
  167.              shareware version.
  168.  
  169.         =W   Whether or not the system requesting files is 
  170.              listed in your nodelist. This macro can have two
  171.              values, LISTED or UNLISTED.
  172.  
  173.         If the =O macro is used, it should be enclosed with double
  174.         quote characters (") characters to prevent DOS to treat 
  175.         some special characters, e.g. < > and |, in a way that would 
  176.         prevent FDRPR from working correctly.
  177.  
  178.         This means, that a typical command line to run FDRPR, would
  179.         look like this:
  180.  
  181.         FDRPR /REQUEST:=R /TARGET:=T /=X /INFO:=F /MINUTES:=H
  182.  
  183.         or, to make it shorter:
  184.  
  185.         FDRPR /R:=R /T:=T /=X /I:=F /M:=H
  186.  
  187.         An alternative command line would be:
  188.  
  189.         FDRPR /R:=R /T:=T /=X /A:=A /O:"=O" /B:=B /M:=H
  190.  
  191.         When using FD 2.11a or 2.20b, or later versions, the 
  192.         command line aboves should be replaced with:
  193.  
  194.         FDRPR /R:=Q /T:=E /I:=M /=X /M:=H /N:=Y /=W
  195.  
  196.         or
  197.  
  198.         FDRPR /R:=Q /T:=E /=X /A:=A /O:"=O" /B:=B /M:=H /N:=Y /=W
  199.  
  200.         In most cases, one of the lines above would be the one needed, 
  201.         and should be entered in 
  202.         FDSETUP->Mailer->File Requests->Request Processor->Program
  203.  
  204.         Even if it is possible to specify a fixed # of minutes for
  205.         a file request on the command line, it should be done in
  206.         FDSETUP. FDRPR uses that number in SETUP.FD, the
  207.         possibility to specify a number of minutes on the command
  208.         line should only be used to let FD specify the number of 
  209.         minutes left to next event not allowing file requests.
  210.  
  211.  
  212.     FDRPR commands
  213.     --------------
  214.  
  215.         There are a few commands that can be specified when running
  216.         FDRPR to do certain things. The following is a list of
  217.         these commands, and what they do:
  218.  
  219.         CREATE          Create list of directories/alias names
  220.         INSTALL         Install FDRPR in FrontDoor's setup
  221.         UPDATE          Update the list of directories/alias names
  222.  
  223.         The CREATE and UPDATE commands will create the *.RQU, *.RQL and 
  224.         *.RQS files from your FD and RA configuration. CREATE always
  225.         creates new files, UPDATE will only create them if any
  226.         of the original file have been updated.
  227.  
  228.         It's not necessary to use CREATE and/or UPDATE. Every time
  229.         FDRPR is run, it will check if it's needed to update these
  230.         files, and if it is, it is done on the fly. But to save 
  231.         time for the systems requesting files, it can be a good
  232.         idea to update them manually every time you've changed
  233.         your list of requestable directories, the list with alias
  234.         names, or your RA's file area configuration.
  235.  
  236.  
  237.     Configuration file
  238.     ------------------
  239.  
  240.         The behaviour of FDRPR can also be defined in a
  241.         configuration file. The configuration file should be located 
  242.         in the same directory as the .EXE file, and with the same 
  243.         basename (i.e. FDRPR if you don't rename it). The extension 
  244.         should either be .CFG, or, if you prefer to have one 
  245.         configuration file per task, .%TASK%. If the .%TASK% file
  246.         exists, it will always be used. The .CFG file is only used if
  247.         the .%TASK% file doesn't exist.
  248.  
  249.         Many of the switches can either be specified as 'switch' or
  250.         'noswitch'. The setting is enabled when no isn't used, and
  251.         disabled when no is used.
  252.  
  253.         There are some macros that can be used in the configuration
  254.         file, to make maintainance easier. When using these macros,
  255.         they should begin with the characters dollar ($) and 
  256.         left bracket ([) and end with a right bracket (]). E.g. 
  257.         The macro CFGDIR should be written as $[CFGDIR]. Besides the
  258.         macros listed below, all environment variables can also be 
  259.         used as macros.
  260.  
  261.         The following macros exists:
  262.  
  263.         CfgDir
  264.                 This macro translates to the directory where the 
  265.                 FDRPR.CFG file is located. It can be useful
  266.                 when specifying the location of other files.
  267.  
  268.  
  269.  
  270.         The following switches is available in the configuration
  271.         file:
  272.         
  273.         [no]Advert              
  274.                 If enabled, FDRPR will add a text stating that 
  275.                 the message was created by FDRPR. It is not 
  276.                 possible to disable this in the unregistered version.
  277.                 Default: Enabled
  278.  
  279.  
  280.         [no]CdRom
  281.                 If enabled, FDRPR will use the CD-ROM settings in
  282.                 RACONFIG, and have the same kind of CD-ROM support
  283.                 that RA has, e.g. to make sure no other line
  284.                 currently uses the same device, and then copy the 
  285.                 requested file to the temporary CD-ROM directory.
  286.                 Default: Enabled
  287.  
  288.  
  289.         DataFileDir:<dir>
  290.                 If specified, all files created by FDRPR, e.g. the
  291.                 *.RQ* files will be created in this directory. By
  292.                 default, they are created in the same directory as
  293.                 the original list of requestable directories / alias
  294.                 names.
  295.  
  296.  
  297.         [no]Descriptions        
  298.                 If enabled, FDRPR will send a message with file
  299.                 descriptions for all successfully requested files.
  300.                 Default: Enabled
  301.         
  302.  
  303.         FailMessage:<file>
  304.                 File containing a template of the text that should
  305.                 be used for the message with the reason for a failed
  306.                 request, which is sent to the requesting system.
  307.  
  308.                 See below for information about these message
  309.                 templates.
  310.  
  311.  
  312.         [no]FormatDescriptions
  313.                 If enabled, FDRPR will ignore any newlines found
  314.                 in a file description, and wrap the description as
  315.                 fits the field best. If disabled, FDRPR will use any
  316.                 newlines found in the description, and use them, if
  317.                 possible. Descriptions without newlines, or with
  318.                 to long lines will still be wrapped by FDRPR.
  319.                 Default: Enabled
  320.  
  321.  
  322.         [no]FreeFiles           
  323.                 If enabled, FDRPR will honor the Free File setting
  324.                 for a file or file area, and not perform any limit
  325.                 checks for these files.
  326.                 Default: Disabled
  327.  
  328.  
  329.         [no]KeepPktFiles
  330.                 If enabled, FDRPR will keep all the *.PKT files sent
  331.                 to the destination, containing file descriptions,
  332.                 and failure reasons.
  333.                 Default: Disabled
  334.  
  335.  
  336.         KeyName:<Your name>
  337.                 The name your copy of FDRPR has been registered to.
  338.                 All messages created by FDRPR will use this name as
  339.                 the sender name.
  340.  
  341.  
  342.         KeyNumber:<number>
  343.                 Your registration key number, as given to you by the
  344.                 registration site.
  345.  
  346.  
  347.         [no]LogFile:<file>
  348.                 If this setting is specified as LOGFILE:<file>, log
  349.                 information will be written to the specified logfile. 
  350.                 If NOLOGFILE is specified, no loggin will be performed. 
  351.                 If neither LOGFILE or NOLOGFILE is specified, log 
  352.                 information will be written to FD's logfile.
  353.                 
  354.                 Errors detected during initialization will always be
  355.                 written to FD's logfile, ignoring this setting.
  356.  
  357.  
  358.         MaxBaseWildCards:<# of chars>
  359.                 The maximal number of allowed wildcards, e.g. ? 
  360.                 characters, in the base of a requested filename, e.g.
  361.                 not including the extension. Before checking this, all 
  362.                 * characters are converted to the corresponding number
  363.                 of ? characters, e.g. XXX*.ARJ is converted to 
  364.                 XXX?????.ARJ.
  365.                 Default is to allow any number of wildcard characters.
  366.                 If you specify 5, XXX*.* will be allowed, XX*.* will not.
  367.                 but XXX*.* will not be allowed.
  368.  
  369.  
  370.         MaxWildCards:<# of chars>
  371.                 The same kind of check as maxbasewildcards does, but
  372.                 this switch also counts wildcards in the extension.
  373.                 The difference between maxbasewildcards and this
  374.                 switch is that allows more flexibility for the user
  375.                 requesting files (e.g. if set to 8, it's ok to request
  376.                 XX*.X*), but has the disadvantage that it's hard to
  377.                 protect against requests like *.GIF.
  378.                 See maxbasewildcards for more information.
  379.                 Default is to allow any number of wildcard characters.
  380.                 If you specify 8, XXX*.* will be allowed, XX*.* will not.
  381.                 If you specify 7, XXXX*.* will be allowed, XXX*.X* also,
  382.                 but XXX*.* will not be allowed.
  383.  
  384.  
  385.         Message:<file>
  386.                 File containing a template of the text that should
  387.                 be used for the message with descriptions of the
  388.                 successfully requested files, which is sent to
  389.                 the requesting system.
  390.  
  391.                 See below for information about these message
  392.                 templates.
  393.  
  394.  
  395.         [no]MoreTime
  396.                 If enabled, FDRPR will request more time from the
  397.                 remote mailer, to be able to process the entire
  398.                 request, if needed. If this setting is disabled, 
  399.                 the remote mailer will probably disconnect the line
  400.                 if FDRPR requires more then 30 seconds to finish
  401.                 the search.
  402.                 Default: Enabled
  403.  
  404.  
  405.         [no]PassWordErrors
  406.                 If enabled, FDRPR will include all files that should
  407.                 have been sent if the correct password was used, in 
  408.                 the message with the list of failed requests. By
  409.                 default, only the requested filename will be included
  410.                 in the message.
  411.                 Default: Disabled
  412.  
  413.                 NOTE! The reason this option is disabled by default, is 
  414.                       that it could be a security risk to inform
  415.                       another system that there is a file available,
  416.                       which requires a password.
  417.  
  418.  
  419.         [no]ReportFailures
  420.                 If enabled, FDRPR will create a netmail message
  421.                 to you with information about failed file requests.
  422.                 Default: Disabled
  423.  
  424.  
  425.         ReportMsgBoard:<board>
  426.                 The Hudson message board where all report messages
  427.                 are created as a result of the ReportRequests and/or
  428.                 ReportFailures setting. If neither this setting, nor
  429.                 the ReportMsgDir, is specified, these messages are
  430.                 created in FrontDoor's netmail directory.
  431.  
  432.  
  433.         ReportMsgDir:<dir>
  434.                 The *.MSG directory where all report messages, e.g. 
  435.                 those messages created as a result of the ReportRequests
  436.                 and/or ReportFailures setting. If neither this, nor
  437.                 the ReportMsgBoard setting, is specified, these messages
  438.                 are created in FrontDoor's netmail directory.
  439.  
  440.  
  441.         [no]ReportRequests
  442.                 If enabled, FDRPR will create a netmail message
  443.                 to you with information about successful file requests.
  444.                 Default: Disabled
  445.  
  446.  
  447.         [no]ResolvePath
  448.                 If enabled, FDRPR uses path resolution when trying
  449.                 to compare the paths specified in RACONFIG, and the
  450.                 paths listed in your list of requestable directories
  451.                 and aliasnames. This ensures that FDRPR always
  452.                 will be able to match these paths correct.
  453.                 However, in some environments, this seems to fail.
  454.                 I'm aware of one CD-ROM interface which doesn't
  455.                 seem to support this correctly. If you're having
  456.                 problems with file areas that are not recognized by
  457.                 FDRPR, disable this option.
  458.  
  459.                 The resolvepath setting can in some environments 
  460.                 also slow down the creation of the lists of requestable
  461.                 directories/alias names. If this seems to take a long
  462.                 time to run, try to specify noresolvepath.
  463.                 Default: Disabled
  464.  
  465.  
  466.         UnlistedAlias:<file>
  467.                 A file that contains a list of alias names, that unlisted
  468.                 systems are allowed to request. By default, unlisted
  469.                 systems can request the same alias names that are 
  470.                 allowed during unsecure sessions, but if this file is
  471.                 specified, only these aliases are allowed.
  472.  
  473.  
  474.         UnlistedList:<list>
  475.                 A file that contains a list of requestable directories,
  476.                 that unlisted systems can request from. By default,
  477.                 unlisted systems can request from the same directories
  478.                 that area allowed during unsecure sessions, but if this
  479.                 file is specified, only the directories listed in it
  480.                 is allowed.
  481.  
  482.  
  483.         [no]UnlistedOnlyFree
  484.                 If enabled, systems that are unlisted, e.g. doesn't
  485.                 exist in the nodelist, nor in the security manager,
  486.                 may only request files that either are marked as
  487.                 free in RA's file database, or files that exists in
  488.                 a file area that are set to only contain free files.
  489.  
  490.  
  491.         [no]UpdCount
  492.                 If enabled, FDRPR will update the download counters
  493.                 for all successfully requested files
  494.                 Default: Enabled
  495.  
  496.  
  497.         WorkDir:<dir>
  498.                 The directory where the temporary .PKT files are
  499.                 created, before FD sends them to the destination.
  500.                 If this parameter is not specified, the .PKT files
  501.                 will be written to the directory pointed to by
  502.                 the TEMP or TMP environment variable. If neither of
  503.                 these environment variables are specified, the .PKT
  504.                 file will be written to the root directory of the
  505.                 current drive.
  506.  
  507.  
  508.     Message templates
  509.     -----------------
  510.  
  511.         The exact contents and layout of the messages that are sent
  512.         to the requesting system, can be decided by the SysOp. Two
  513.         different messages can be sent; the message containing file
  514.         descriptions for successfully requested files, and the
  515.         message with reasons why a request failed.
  516.  
  517.         Each message should have it's own template, e.g. a file 
  518.         describing the format and contents. The names of these files
  519.         are defined in the configuration file.
  520.  
  521.         The template files are just normal textfiles, that can be
  522.         created/edited in any text editor. It's possible to insert
  523.         some unique text in each message, and to do that, a macro
  524.         is used. The exact format of the lines with file descriptions
  525.         and reasons for request failures can also be configured.
  526.  
  527.         When using a macro, it should begin with the characters
  528.         dollar ($) and left bracket ([), and end with a right 
  529.         bracket (]). E.g. The macro TOTALSIZE should be written 
  530.         as $[TOTALSIZE]. Either lower or upper characters can be 
  531.         used, there is no difference between them.
  532.  
  533.         A macro that requires parameters, should have the parameters
  534.         inside the [] characters. Ex: $[Include C:\FD\FILE.TXT].
  535.  
  536.         The following macros exists:
  537.  
  538.         PrgName
  539.                 The name of the request processor
  540.  
  541.         Version
  542.                 The version of the request processor
  543.                 
  544.         YourName 
  545.                 The full name of the SysOp requesting files
  546.  
  547.         YourFirstName
  548.                 The first name of the SysOp requesting files
  549.  
  550.         YourLastName
  551.                 The last name of the SysOp requesting files
  552.  
  553.         YourAka
  554.                 The address of the requesting system
  555.  
  556.         MyName
  557.                 Your name, as defined in FDSETUP
  558.  
  559.         MyFirstName
  560.                 Your first name, as defined in FDSETUP
  561.  
  562.         MyLastName
  563.                 Your last name, as defined in FDSETUP
  564.  
  565.         MyAka
  566.                 Your address. FDRPR will use AKA matching when
  567.                 deciding which address should be used
  568.  
  569.         FileCnt
  570.                 The number of found files, which will be sent to the
  571.                 requesting system
  572.  
  573.         FailCnt
  574.                 The number of requests that failed
  575.  
  576.         TotalSize
  577.                 The number of bytes that will be sent
  578.  
  579.         TotalSizeK
  580.                 The number of kilo bytes that will be sent
  581.  
  582.         Include <file>
  583.                 Insert contents of <file> in message
  584.                 <file> can also contain macros 
  585.  
  586.         Aliases
  587.                 Insert list of all alias names that can be requested. 
  588.                 If the alias file (the one defined in FDSETUP)
  589.                 contains comments, these comments will be included in
  590.                 this list. 
  591.                 A comment in the alias file is added at the end of
  592.                 a line with an alias name, after a ; character.
  593.  
  594.         IfFile <file1> <file2>  
  595.                 If <file1> will be sent to the requesting system,
  596.                 the contents of <file2> will be added to the message
  597.                 that is sent.
  598.                 <file1> should only specify the filename, not a drive
  599.                 or directory, but can contain wildcard characters.
  600.                 <file2> can also contain macros
  601.  
  602.         If a macro is used, that is not in the list above, FDRPR
  603.         will check to see if it is an environment variable, and if it
  604.         is, use it. An example of an environement variable that could
  605.         be useful, is TASK.
  606.  
  607.         Each template should contain ONE line that is used to format
  608.         the file descriptions / request failure reasons. The line
  609.         should start with either a @ or # character. This line can
  610.         contain normal text, or some format codes.
  611.         
  612.         Both @ and # can be used with all formatting codes, the
  613.         difference is that codes beginning with a # character,
  614.         and resulting in a numeric value, will have it's value
  615.         zero padded to the left, while codes beginning with a @
  616.         will not.
  617.  
  618.         The length of each formatting is decided by appending some
  619.         underscore (_) characters after the format code. The length 
  620.         of the field will be the total length of the format code, 
  621.         and the underscore characters following directly after.
  622.  
  623.         The format codes that are available for the message with
  624.         file descriptions are:
  625.  
  626.                 @0      - Empty string. Useful if you don't want the
  627.                           line to start with another @ character
  628.                 @@      - The character @
  629.                 @#      - The character #
  630.                 @C      - The description of the file
  631.                 @D      - The date of the file
  632.                 @F      - The name of the file
  633.                 @K / #K - The size of the file, in kilobytes
  634.                 @N      - New line
  635.                 @S / #S - The size of the file, in bytes
  636.                 @T / #T - The number of downloads for this file
  637.  
  638.         The exact format of the @D code depends on the length of the
  639.         field, and the DOS country setting. The following formats are 
  640.         possible:
  641.  
  642.                 10 Sep 1993
  643.                 10 Sep 93
  644.                 10-09-93
  645.                 09-10-93
  646.                 93-09-10
  647.                 100993
  648.                 091093
  649.                 930910
  650.  
  651.         The @N code, New line, will insert a newline character in the
  652.         message, so that the reminding text in the format line will be
  653.         put on the next line of the message. Useful if you want to
  654.         create a multiline description for a file. See below for an
  655.         example.
  656.         
  657.         An example of a formatting line could be:
  658.  
  659.         @F__________  @K__k @D______ [#T] @C_______________________________
  660.  
  661.         Which would result in:
  662.  
  663.         FDRPR121.ARJ    91k 94-09-01 [34] FD Request Processor for RA
  664.  
  665.         Another example could be:
  666.  
  667.         @0File:        @F__________@NSize:        @K__k@N
  668.         Date:        @D_________@NDownloads:   #T_@NDescription: 
  669.         @C___________________________________________________________@N
  670.  
  671.         (All three lines above, should be one single line, not three
  672.         lines as they have to be written in this document).
  673.  
  674.         The above format line would result in:
  675.  
  676.         File:        FDRPR121.ARJ
  677.         Size:          91k
  678.         Date:         1 Sep 1993
  679.         Downloads:   034
  680.         Description: FD Request Processor for RA
  681.  
  682.  
  683.  
  684.         The format codes that are available for the message with
  685.         request failure reasons are:
  686.  
  687.                 @F      - The name of the requested file
  688.                 @R      - The reason the request failed
  689.  
  690.  
  691.  
  692.     The lists of requestable directories and alias names
  693.     ----------------------------------------------------
  694.  
  695.         FDRPR will create some files containing information
  696.         about the requestable directories and the alias filenames.
  697.         These files will be stored in the same directory and with 
  698.         the same name, as the files specified in FDSETUP, but with
  699.         another extension. The extensions used is .RQS for the files
  700.         used during secure sessions, .RQL for the files used for
  701.         listed system during unsecure sessions, and .RQU for the
  702.         files used for unlisted systems during unsecure sessions.
  703.  
  704.         These files will be maintained automatically by FDRPR,
  705.         and is updated every time the list of requestable
  706.         directories, alias names, or FILES.RA, is modified. It is 
  707.         important that these file are not removed, since it is much 
  708.         slower to create them every time, then to use them from the 
  709.         last run.
  710.  
  711.         IMPORTANT!  If your lists of requestable directories or
  712.                     list of alias names, uses the .RQS, .RQL or .RQU 
  713.                     extensions, make sure that you changes this 
  714.                     to another extension. If you don't rename 
  715.                     the file, FDRPR will overwrite your list 
  716.                     with it's own list.
  717.  
  718.  
  719.         If your list with requestable directories contains a
  720.         directory which isn't defined as a file area in RemoteAccess,
  721.         FDRPR will switch over to the same kind of request
  722.         processing as FrontDoor does, e.g. to scan all the files
  723.         in that directory. This makes it possible to have a directory
  724.         with files that should be requestable, but not available from
  725.         the BBS.
  726.  
  727.         If a directory should be available for different types
  728.         of systems, e.g. both unlisted and listed systems, unsecure
  729.         and secure sessions, it's sufficient to specify this 
  730.         directory in the file with the lowest security that should
  731.         be allowed to request from it. As an example, a directory
  732.         that should be available for all type of requesting systems,
  733.         only has to be defined in the list of directories for
  734.         unlisted systems. 
  735.  
  736.         The files with alias names are handled in the same way, so
  737.         it's sufficient to list alias names that should be available
  738.         for both unsecure and secure sessions in the file for unsecure
  739.         sessions.
  740.  
  741.  
  742.  
  743.     Alias definitions
  744.     -----------------
  745.  
  746.         Normally, an alias definition that uses a wildcard in the
  747.         filename that should be sent, sends all files that matches
  748.         this wildcard name. 
  749.  
  750.         If you would prefer that only the newest file matching
  751.         the wildcard name is sent, add a plus (+) character before
  752.         the filename. E.g.
  753.  
  754.         NODELIST    C:\FILES\FIDO\NODELIST.A*
  755.  
  756.         could be replaced with
  757.  
  758.         NODELIST    +C:\FILES\FIDO\NODELIST.A*
  759.  
  760.  
  761.         An other variant of the alias definition, is to send the
  762.         contents of the matching file(s) as a netmail message,
  763.         instead of a file. FDRPR will read the file as it does
  764.         with a message template file, expand any macros that
  765.         exists in it, and send the result as a netmail to the
  766.         requesting person.
  767.  
  768.         To do this, you add a colon (:) character before the
  769.         filename. E.g.
  770.  
  771.         ABOUT        :C:\FILES\ABOUT.TXT
  772.  
  773.         Each matching file will be sent as a single message.
  774.  
  775.         The plus (+) character is also supported, to send only
  776.         the latest file if more then one file matches the file
  777.         specification. E.g.
  778.  
  779.         NEWBULLETIN  +:C:\FILES\BULLETIN.*
  780.  
  781.  
  782.         Another character that can be added in front of the filename,
  783.         is a slash (/) character. A file with the slash character in
  784.         front of it will be considered as a free file, and will not be
  785.         counted, when the limits of how much a node may request are
  786.         checked. E.g.
  787.  
  788.         FREEFILE     /C:\FILES\FREEFILE.TXT
  789.  
  790.         For this to work, you also have to define 'FreeFiles' in your
  791.         configuration file.
  792.  
  793.  
  794.  
  795.     Use FDRPR to test file requests locally
  796.     -----------------------------------------
  797.  
  798.         FDRPR could be used to check a file request locally, to
  799.         get some information why a certain file request fails, or
  800.         just to test your setup.
  801.  
  802.         To run FDRPR like this, enter the following command:
  803.  
  804.         FDRPR /CHECK:<file>
  805.  
  806.         To test a file request that requires a password, use the
  807.         following command:
  808.  
  809.         FDRPR /CHECK:"<file> !<password>"
  810.  
  811.         To test more then one file request at the same time, use the
  812.         following command:
  813.  
  814.         FDRPR /CHECK:"<file1> [!<pwd1>],<file2> [!<pwd2>][,...]"
  815.  
  816.         To make the request more realistic, you can also add any of
  817.         the other switches. But the only switches that would make
  818.         any difference, is the /SECURE and the /BPS:<bps> switches,
  819.         and the /ADDRESS switch, which would have FDRPR create the
  820.         PKT file it should have sent to the requesting system.
  821.  
  822.  
  823.  
  824.     Legal notice
  825.     ------------
  826.  
  827.         FDRPR is provided to you as is, without warranty of any
  828.         kind. In no event shall Mats Wallin be liable to you or
  829.         anyone else for any damages or costs arising from the use
  830.         or inability to use this program.
  831.  
  832.         FDRPR is protected by copyright laws, and may not be 
  833.         modified, reversed engineered, sold or distributed in any
  834.         way that would involve some sort of trade, without written
  835.         permission from Mats Wallin.
  836.  
  837.         FrontDoor is a registered trademark of Joaquim Homrighausen.
  838.  
  839.         All other brand or product names are trademarks or registered
  840.         trademarks of their respective holder.
  841.  
  842.  
  843.     Registering
  844.     -----------
  845.  
  846.         FDRPR may be used during a 30 day trial period to allow
  847.         you to determine its suitability for your particular
  848.         application. After this trial period you must register
  849.         the program, if you are continuing to use it.
  850.  
  851.         Please see the file REGINFO.TXT for information on
  852.         how to register FDRPR.
  853.  
  854.  
  855.     Bug reports, suggestions, etc.
  856.     ------------------------------
  857.  
  858.         If you find any bugs, or have suggestions or comments on 
  859.         this program, I would appreciate if you would let me know.
  860.         Send the information to me at:
  861.  
  862.         2:270/19@fidonet       or      mw@abslu
  863.