home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / FDRPR130.ZIP / FDRPR.DOC < prev    next >
Encoding:
Text File  |  1995-05-03  |  35.8 KB  |  912 lines
  1. FDRPR - FrontDoor Request Processor for RA // Absolute Solutions
  2. ----------------------------------------------------------------
  3.  
  4.     Copyright 1993-1995 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.     You can optionally specify an extra switch to CREATE/UPDATE,
  229.     /Verify. If this switch is specified, FDRPR will verify that
  230.     all directories that are listed as a requestable directory
  231.     actually exists, and if it doesn't, ignore it. This can
  232.     be useful if you for example have different CD-ROMs
  233.     requestable at different times. Just specify all directories
  234.     as requestable, and FDRPR will only allow requests from
  235.     the directory the CD-ROM that currently is installed.
  236.     
  237.         It's not necessary to use CREATE and/or UPDATE. Every time
  238.         FDRPR is run, it will check if it's needed to update these
  239.         files, and if it is, it is done on the fly. But to save 
  240.         time for the systems requesting files, it can be a good
  241.         idea to update them manually every time you've changed
  242.         your list of requestable directories, the list with alias
  243.         names, or your RA's file area configuration.
  244.  
  245.  
  246.     Configuration file
  247.     ------------------
  248.  
  249.         The behaviour of FDRPR can also be defined in a
  250.         configuration file. The configuration file should be located 
  251.         in the same directory as the .EXE file, and with the same 
  252.         basename (i.e. FDRPR if you don't rename it). The extension 
  253.         should either be .CFG, or, if you prefer to have one 
  254.         configuration file per task, .%TASK%. If the .%TASK% file
  255.         exists, it will always be used. The .CFG file is only used if
  256.         the .%TASK% file doesn't exist.
  257.  
  258.         Many of the switches can either be specified as 'switch' or
  259.         'noswitch'. The setting is enabled when no isn't used, and
  260.         disabled when no is used.
  261.  
  262.         There are some macros that can be used in the configuration
  263.         file, to make maintainance easier. When using these macros,
  264.         they should begin with the characters dollar ($) and 
  265.         left bracket ([) and end with a right bracket (]). E.g. 
  266.         The macro CFGDIR should be written as $[CFGDIR]. Besides the
  267.         macros listed below, all environment variables can also be 
  268.         used as macros.
  269.  
  270.         The following macros exists:
  271.  
  272.         CfgDir
  273.                 This macro translates to the directory where the 
  274.                 FDRPR.CFG file is located. It can be useful
  275.                 when specifying the location of other files.
  276.  
  277.  
  278.  
  279.         The following switches is available in the configuration
  280.         file:
  281.         
  282.         [no]Advert              
  283.                 If enabled, FDRPR will add a text stating that 
  284.                 the message was created by FDRPR. It is not 
  285.                 possible to disable this in the unregistered version.
  286.                 Default: Enabled
  287.  
  288.  
  289.         [no]CdRom
  290.                 If enabled, FDRPR will use the CD-ROM settings in
  291.                 RACONFIG, and have the same kind of CD-ROM support
  292.                 that RA has, e.g. to make sure no other line
  293.                 currently uses the same device, and then copy the 
  294.                 requested file to the temporary CD-ROM directory.
  295.                 Default: Enabled
  296.  
  297.  
  298.         DataFileDir:<dir>
  299.                 If specified, all files created by FDRPR, e.g. the
  300.                 *.RQ* files will be created in this directory. By
  301.                 default, they are created in the same directory as
  302.                 the original list of requestable directories / alias
  303.                 names.
  304.  
  305.  
  306.         [no]Descriptions        
  307.                 If enabled, FDRPR will send a message with file
  308.                 descriptions for all successfully requested files.
  309.                 Default: Enabled
  310.         
  311.  
  312.     [no]DupeFileNames
  313.         If disabled, FDRPR will not send more then one file
  314.         with the same filename for each requested file, if
  315.         many file exists with the same filename. However,
  316.         if for instance both FD220.ARJ and FD22?.ARJ is
  317.         requested, FD220.ARJ will still be sent twice. The
  318.         mailer will normally skip the second copy of the file
  319.         in this case though, since it is exactly the same
  320.         file.
  321.         Default: Enabled
  322.  
  323.  
  324.         FailMessage:<file>
  325.                 File containing a template of the text that should
  326.                 be used for the message with the reason for a failed
  327.                 request, which is sent to the requesting system.
  328.  
  329.                 See below for information about these message
  330.                 templates.
  331.  
  332.  
  333.         [no]FormatDescriptions
  334.                 If enabled, FDRPR will ignore any newlines found
  335.                 in a file description, and wrap the description as
  336.                 fits the field best. If disabled, FDRPR will use any
  337.                 newlines found in the description, and use them, if
  338.                 possible. Descriptions without newlines, or with
  339.                 to long lines will still be wrapped by FDRPR.
  340.                 Default: Enabled
  341.  
  342.  
  343.         [no]FreeFiles           
  344.                 If enabled, FDRPR will honor the Free File setting
  345.                 for a file or file area, and not perform any limit
  346.                 checks for these files.
  347.                 Default: Disabled
  348.  
  349.  
  350.         [no]KeepPktFiles
  351.                 If enabled, FDRPR will keep all the *.PKT files sent
  352.                 to the destination, containing file descriptions,
  353.                 and failure reasons.
  354.                 Default: Disabled
  355.  
  356.  
  357.         KeyName:<Your name>
  358.                 The name your copy of FDRPR has been registered to.
  359.                 All messages created by FDRPR will use this name as
  360.                 the sender name.
  361.  
  362.  
  363.         KeyNumber:<number>
  364.                 Your registration key number, as given to you by the
  365.                 registration site.
  366.  
  367.  
  368.         [no]LogFile:<file>
  369.                 If this setting is specified as LOGFILE:<file>, log
  370.                 information will be written to the specified logfile. 
  371.                 If NOLOGFILE is specified, no loggin will be performed. 
  372.                 If neither LOGFILE or NOLOGFILE is specified, log 
  373.                 information will be written to FD's logfile.
  374.                 
  375.                 Errors detected during initialization will always be
  376.                 written to FD's logfile, ignoring this setting.
  377.  
  378.  
  379.         MaxBaseWildCards:<# of chars>
  380.                 The maximal number of allowed wildcards, e.g. ? 
  381.                 characters, in the base of a requested filename, e.g.
  382.                 not including the extension. Before checking this, all 
  383.                 * characters are converted to the corresponding number
  384.                 of ? characters, e.g. XXX*.ARJ is converted to 
  385.                 XXX?????.ARJ.
  386.                 Default is to allow any number of wildcard characters.
  387.                 If you specify 5, XXX*.* will be allowed, XX*.* will not.
  388.                 but XXX*.* will not be allowed.
  389.  
  390.  
  391.         MaxWildCards:<# of chars>
  392.                 The same kind of check as maxbasewildcards does, but
  393.                 this switch also counts wildcards in the extension.
  394.                 The difference between maxbasewildcards and this
  395.                 switch is that allows more flexibility for the user
  396.                 requesting files (e.g. if set to 8, it's ok to request
  397.                 XX*.X*), but has the disadvantage that it's hard to
  398.                 protect against requests like *.GIF.
  399.                 See maxbasewildcards for more information.
  400.                 Default is to allow any number of wildcard characters.
  401.                 If you specify 8, XXX*.* will be allowed, XX*.* will not.
  402.                 If you specify 7, XXXX*.* will be allowed, XXX*.X* also,
  403.                 but XXX*.* will not be allowed.
  404.  
  405.  
  406.         Message:<file>
  407.                 File containing a template of the text that should
  408.                 be used for the message with descriptions of the
  409.                 successfully requested files, which is sent to
  410.                 the requesting system.
  411.  
  412.                 See below for information about these message
  413.                 templates.
  414.  
  415.  
  416.         [no]MoreTime
  417.                 If enabled, FDRPR will request more time from the
  418.                 remote mailer, to be able to process the entire
  419.                 request, if needed. If this setting is disabled, 
  420.                 the remote mailer will probably disconnect the line
  421.                 if FDRPR requires more then 30 seconds to finish
  422.                 the search.
  423.                 Default: Enabled
  424.  
  425.  
  426.         [no]PassWordErrors
  427.                 If enabled, FDRPR will include all files that should
  428.                 have been sent if the correct password was used, in 
  429.                 the message with the list of failed requests. By
  430.                 default, only the requested filename will be included
  431.                 in the message.
  432.                 Default: Disabled
  433.  
  434.                 NOTE! The reason this option is disabled by default, is 
  435.                       that it could be a security risk to inform
  436.                       another system that there is a file available,
  437.                       which requires a password.
  438.  
  439.  
  440.         RAVersion
  441.         The version number of your RemoteAccess. This version
  442.         number is used to modify the behavior of FDRPR for
  443.         different versions of RemoteAccess. 
  444.         The version number should be specified with 3 digits,
  445.         without any period between the major and minor version
  446.         number. For instance, RA version 2.02 should be
  447.         specified as 202, RA version 2.50 as 250, etc.
  448.         Default: 200
  449.  
  450.  
  451.         [no]ReportFailures
  452.                 If enabled, FDRPR will create a netmail message
  453.                 to you with information about failed file requests.
  454.                 Default: Disabled
  455.  
  456.  
  457.         ReportMsgBoard:<board>
  458.                 The Hudson message board where all report messages
  459.                 are created as a result of the ReportRequests and/or
  460.                 ReportFailures setting. If neither this setting, nor
  461.                 the ReportMsgDir, is specified, these messages are
  462.                 created in FrontDoor's netmail directory.
  463.  
  464.  
  465.         ReportMsgDir:<dir>
  466.                 The *.MSG directory where all report messages, e.g. 
  467.                 those messages created as a result of the ReportRequests
  468.                 and/or ReportFailures setting. If neither this, nor
  469.                 the ReportMsgBoard setting, is specified, these messages
  470.                 are created in FrontDoor's netmail directory.
  471.  
  472.  
  473.         [no]ReportRequests
  474.                 If enabled, FDRPR will create a netmail message
  475.                 to you with information about successful file requests.
  476.                 Default: Disabled
  477.  
  478.  
  479.         [no]ResolvePath
  480.                 If enabled, FDRPR uses path resolution when trying
  481.                 to compare the paths specified in RACONFIG, and the
  482.                 paths listed in your list of requestable directories
  483.                 and aliasnames. This ensures that FDRPR always
  484.                 will be able to match these paths correct.
  485.                 However, in some environments, this seems to fail.
  486.                 I'm aware of one CD-ROM interface which doesn't
  487.                 seem to support this correctly. If you're having
  488.                 problems with file areas that are not recognized by
  489.                 FDRPR, disable this option.
  490.  
  491.                 The resolvepath setting can in some environments 
  492.                 also slow down the creation of the lists of requestable
  493.                 directories/alias names. If this seems to take a long
  494.                 time to run, try to specify noresolvepath.
  495.                 Default: Disabled
  496.  
  497.  
  498.         UnlistedAlias:<file>
  499.                 A file that contains a list of alias names, that unlisted
  500.                 systems are allowed to request. By default, unlisted
  501.                 systems can request the same alias names that are 
  502.                 allowed during unsecure sessions, but if this file is
  503.                 specified, only these aliases are allowed.
  504.  
  505.  
  506.         UnlistedList:<list>
  507.                 A file that contains a list of requestable directories,
  508.                 that unlisted systems can request from. By default,
  509.                 unlisted systems can request from the same directories
  510.                 that area allowed during unsecure sessions, but if this
  511.                 file is specified, only the directories listed in it
  512.                 is allowed.
  513.  
  514.  
  515.         [no]UnlistedOnlyFree
  516.                 If enabled, systems that are unlisted, e.g. doesn't
  517.                 exist in the nodelist, nor in the security manager,
  518.                 may only request files that either are marked as
  519.                 free in RA's file database, or files that exists in
  520.                 a file area that are set to only contain free files.
  521.  
  522.  
  523.         [no]UpdCount
  524.                 If enabled, FDRPR will update the download counters
  525.                 for all successfully requested files
  526.                 Default: Enabled
  527.  
  528.  
  529.         WorkDir:<dir>
  530.                 The directory where the temporary .PKT files are
  531.                 created, before FD sends them to the destination.
  532.                 If this parameter is not specified, the .PKT files
  533.                 will be written to the directory pointed to by
  534.                 the TEMP or TMP environment variable. If neither of
  535.                 these environment variables are specified, the .PKT
  536.                 file will be written to the root directory of the
  537.                 current drive.
  538.  
  539.  
  540.     Message templates
  541.     -----------------
  542.  
  543.         The exact contents and layout of the messages that are sent
  544.         to the requesting system, can be decided by the SysOp. Two
  545.         different messages can be sent; the message containing file
  546.         descriptions for successfully requested files, and the
  547.         message with reasons why a request failed.
  548.  
  549.         Each message should have it's own template, e.g. a file 
  550.         describing the format and contents. The names of these files
  551.         are defined in the configuration file.
  552.  
  553.         The template files are just normal textfiles, that can be
  554.         created/edited in any text editor. It's possible to insert
  555.         some unique text in each message, and to do that, a macro
  556.         is used. The exact format of the lines with file descriptions
  557.         and reasons for request failures can also be configured.
  558.  
  559.         When using a macro, it should begin with the characters
  560.         dollar ($) and left bracket ([), and end with a right 
  561.         bracket (]). E.g. The macro TOTALSIZE should be written 
  562.         as $[TOTALSIZE]. Either lower or upper characters can be 
  563.         used, there is no difference between them.
  564.  
  565.         A macro that requires parameters, should have the parameters
  566.         inside the [] characters. Ex: $[Include C:\FD\FILE.TXT].
  567.  
  568.         The following macros exists:
  569.  
  570.         PrgName
  571.                 The name of the request processor
  572.  
  573.         Version
  574.                 The version of the request processor
  575.                 
  576.         YourName 
  577.                 The full name of the SysOp requesting files
  578.  
  579.         YourFirstName
  580.                 The first name of the SysOp requesting files
  581.  
  582.         YourLastName
  583.                 The last name of the SysOp requesting files
  584.  
  585.         YourAka
  586.                 The address of the requesting system
  587.  
  588.         MyName
  589.                 Your name, as defined in FDSETUP
  590.  
  591.         MyFirstName
  592.                 Your first name, as defined in FDSETUP
  593.  
  594.         MyLastName
  595.                 Your last name, as defined in FDSETUP
  596.  
  597.         MyAka
  598.                 Your address. FDRPR will use AKA matching when
  599.                 deciding which address should be used
  600.  
  601.         FileCnt
  602.                 The number of found files, which will be sent to the
  603.                 requesting system
  604.  
  605.         FailCnt
  606.                 The number of requests that failed
  607.  
  608.         TotalSize
  609.                 The number of bytes that will be sent
  610.  
  611.         TotalSizeK
  612.                 The number of kilo bytes that will be sent
  613.  
  614.         Include <file>
  615.                 Insert contents of <file> in message
  616.                 <file> can also contain macros 
  617.  
  618.         Aliases
  619.                 Insert list of all alias names that can be requested. 
  620.                 If the alias file (the one defined in FDSETUP)
  621.                 contains comments, these comments will be included in
  622.                 this list. 
  623.                 A comment in the alias file is added at the end of
  624.                 a line with an alias name, after a ; character.
  625.  
  626.         IfFile <file1> <file2>  
  627.                 If <file1> will be sent to the requesting system,
  628.                 the contents of <file2> will be added to the message
  629.                 that is sent.
  630.                 <file1> should only specify the filename, not a drive
  631.                 or directory, but can contain wildcard characters.
  632.                 <file2> can also contain macros
  633.  
  634.         If a macro is used, that is not in the list above, FDRPR
  635.         will check to see if it is an environment variable, and if it
  636.         is, use it. An example of an environement variable that could
  637.         be useful, is TASK.
  638.  
  639.         Each template should contain ONE line that is used to format
  640.         the file descriptions / request failure reasons. The line
  641.         should start with either a @ or # character. This line can
  642.         contain normal text, or some format codes.
  643.         
  644.         Both @ and # can be used with all formatting codes, the
  645.         difference is that codes beginning with a # character,
  646.         and resulting in a numeric value, will have it's value
  647.         zero padded to the left, while codes beginning with a @
  648.         will not.
  649.  
  650.         The length of each formatting is decided by appending some
  651.         underscore (_) characters after the format code. The length 
  652.         of the field will be the total length of the format code, 
  653.         and the underscore characters following directly after.
  654.  
  655.         The format codes that are available for the message with
  656.         file descriptions are:
  657.  
  658.                 @0      - Empty string. Useful if you don't want the
  659.                           line to start with another @ character
  660.                 @@      - The character @
  661.                 @#      - The character #
  662.                 @C      - The description of the file
  663.                 @D      - The date of the file
  664.                 @F      - The name of the file
  665.                 @K / #K - The size of the file, in kilobytes
  666.         @M    - The requested filemask
  667.                 @N      - New line
  668.                 @S / #S - The size of the file, in bytes
  669.                 @T / #T - The number of downloads for this file
  670.  
  671.         The exact format of the @D code depends on the length of the
  672.         field, and the DOS country setting. The following formats are 
  673.         possible:
  674.  
  675.                 10 Sep 1993
  676.                 10 Sep 93
  677.                 10-09-93
  678.                 09-10-93
  679.                 93-09-10
  680.                 100993
  681.                 091093
  682.                 930910
  683.  
  684.         The @N code, New line, will insert a newline character in the
  685.         message, so that the reminding text in the format line will be
  686.         put on the next line of the message. Useful if you want to
  687.         create a multiline description for a file. See below for an
  688.         example.
  689.         
  690.         An example of a formatting line could be:
  691.  
  692.         @F__________  @K__k @D______ [#T] @C_______________________________
  693.  
  694.         Which would result in:
  695.  
  696.         FDRPR121.ARJ    91k 94-09-01 [34] FD Request Processor for RA
  697.  
  698.         Another example could be:
  699.  
  700.         @0File:        @F__________@NSize:        @K__k@N
  701.         Date:        @D_________@NDownloads:   #T_@NDescription: 
  702.         @C___________________________________________________________@N
  703.  
  704.         (All three lines above, should be one single line, not three
  705.         lines as they have to be written in this document).
  706.  
  707.         The above format line would result in:
  708.  
  709.         File:        FDRPR121.ARJ
  710.         Size:          91k
  711.         Date:         1 Sep 1993
  712.         Downloads:   034
  713.         Description: FD Request Processor for RA
  714.  
  715.  
  716.  
  717.         The format codes that are available for the message with
  718.         request failure reasons are:
  719.  
  720.                 @F      - The name of the requested file
  721.         @M    - The requested filemask
  722.                 @R      - The reason the request failed
  723.  
  724.  
  725.  
  726.     The lists of requestable directories and alias names
  727.     ----------------------------------------------------
  728.  
  729.         FDRPR will create some files containing information
  730.         about the requestable directories and the alias filenames.
  731.         These files will be stored in the same directory and with 
  732.         the same name, as the files specified in FDSETUP, but with
  733.         another extension. The extensions used is .RQS for the files
  734.         used during secure sessions, .RQL for the files used for
  735.         listed system during unsecure sessions, and .RQU for the
  736.         files used for unlisted systems during unsecure sessions.
  737.  
  738.         These files will be maintained automatically by FDRPR,
  739.         and is updated every time the list of requestable
  740.         directories, alias names, or FILES.RA, is modified. It is 
  741.         important that these file are not removed, since it is much 
  742.         slower to create them every time, then to use them from the 
  743.         last run.
  744.  
  745.         IMPORTANT!  If your lists of requestable directories or
  746.                     list of alias names, uses the .RQS, .RQL or .RQU 
  747.                     extensions, make sure that you changes this 
  748.                     to another extension. If you don't rename 
  749.                     the file, FDRPR will overwrite your list 
  750.                     with it's own list.
  751.  
  752.  
  753.         If your list with requestable directories contains a
  754.         directory which isn't defined as a file area in RemoteAccess,
  755.         FDRPR will switch over to the same kind of request
  756.         processing as FrontDoor does, e.g. to scan all the files
  757.         in that directory. This makes it possible to have a directory
  758.         with files that should be requestable, but not available from
  759.         the BBS.
  760.  
  761.         If a directory should be available for different types
  762.         of systems, e.g. both unlisted and listed systems, unsecure
  763.         and secure sessions, it's sufficient to specify this 
  764.         directory in the file with the lowest security that should
  765.         be allowed to request from it. As an example, a directory
  766.         that should be available for all type of requesting systems,
  767.         only has to be defined in the list of directories for
  768.         unlisted systems. 
  769.  
  770.         The files with alias names are handled in the same way, so
  771.         it's sufficient to list alias names that should be available
  772.         for both unsecure and secure sessions in the file for unsecure
  773.         sessions.
  774.  
  775.  
  776.  
  777.     Alias definitions
  778.     -----------------
  779.  
  780.         Normally, an alias definition that uses a wildcard in the
  781.         filename that should be sent, sends all files that matches
  782.         this wildcard name. 
  783.  
  784.         If you would prefer that only the newest file matching
  785.         the wildcard name is sent, add a plus (+) character before
  786.         the filename. E.g.
  787.  
  788.         NODELIST    C:\FILES\FIDO\NODELIST.A*
  789.  
  790.         could be replaced with
  791.  
  792.         NODELIST    +C:\FILES\FIDO\NODELIST.A*
  793.  
  794.  
  795.         An other variant of the alias definition, is to send the
  796.         contents of the matching file(s) as a netmail message,
  797.         instead of a file. FDRPR will read the file as it does
  798.         with a message template file, expand any macros that
  799.         exists in it, and send the result as a netmail to the
  800.         requesting person.
  801.  
  802.         To do this, you add a colon (:) character before the
  803.         filename. E.g.
  804.  
  805.         ABOUT        :C:\FILES\ABOUT.TXT
  806.  
  807.         Each matching file will be sent as a single message.
  808.  
  809.         The plus (+) character is also supported, to send only
  810.         the latest file if more then one file matches the file
  811.         specification. E.g.
  812.  
  813.         NEWBULLETIN  +:C:\FILES\BULLETIN.*
  814.  
  815.  
  816.         Another character that can be added in front of the filename,
  817.         is a slash (/) character. A file with the slash character in
  818.         front of it will be considered as a free file, and will not be
  819.         counted, when the limits of how much a node may request are
  820.         checked. E.g.
  821.  
  822.         FREEFILE     /C:\FILES\FREEFILE.TXT
  823.  
  824.         For this to work, you also have to define 'FreeFiles' in your
  825.         configuration file.
  826.  
  827.  
  828.     Another character that can be added in front of the filename,
  829.     is a pipe (|) character. A file with a pipe character in front
  830.     of it, will not be sent to the requesting system, instead it
  831.     will be created (or updated if it already exists) on your
  832.     system. This can for example be used for remote maintenance,
  833.     where you would like to create a semaphore file for
  834.     FrontDoor. E.g.
  835.  
  836.     FDEXIT1       |C:\FD\FDXIT1.255
  837.  
  838.     If FDEXIT1 is requested, it will create the FDXIT1.255
  839.     semaphore, which forces task 1 of FD to exit with errorlevel
  840.     255.
  841.  
  842.  
  843.     Use FDRPR to test file requests locally
  844.     -----------------------------------------
  845.  
  846.         FDRPR could be used to check a file request locally, to
  847.         get some information why a certain file request fails, or
  848.         just to test your setup.
  849.  
  850.         To run FDRPR like this, enter the following command:
  851.  
  852.         FDRPR /CHECK:<file>
  853.  
  854.         To test a file request that requires a password, use the
  855.         following command:
  856.  
  857.         FDRPR /CHECK:"<file> !<password>"
  858.  
  859.         To test more then one file request at the same time, use the
  860.         following command:
  861.  
  862.         FDRPR /CHECK:"<file1> [!<pwd1>],<file2> [!<pwd2>][,...]"
  863.  
  864.         To make the request more realistic, you can also add any of
  865.         the other switches. But the only switches that would make
  866.         any difference, is the /SECURE, /LISTED and the /BPS:<bps>
  867.         switches, and the /ADDRESS switch, which would have FDRPR
  868.     create the PKT file it should have sent to the requesting
  869.     system. 
  870.  
  871.  
  872.  
  873.     Legal notice
  874.     ------------
  875.  
  876.         FDRPR is provided to you as is, without warranty of any
  877.         kind. In no event shall Mats Wallin be liable to you or
  878.         anyone else for any damages or costs arising from the use
  879.         or inability to use this program.
  880.  
  881.         FDRPR is protected by copyright laws, and may not be 
  882.         modified, reversed engineered, sold or distributed in any
  883.         way that would involve some sort of trade, without written
  884.         permission from Mats Wallin.
  885.  
  886.         FrontDoor is a registered trademark of Joaquim Homrighausen.
  887.  
  888.         All other brand or product names are trademarks or registered
  889.         trademarks of their respective holder.
  890.  
  891.  
  892.     Registering
  893.     -----------
  894.  
  895.         FDRPR may be used during a 30 day trial period to allow
  896.         you to determine its suitability for your particular
  897.         application. After this trial period you must register
  898.         the program, if you are continuing to use it.
  899.  
  900.         Please see the file REGINFO.TXT for information on
  901.         how to register FDRPR.
  902.  
  903.  
  904.     Bug reports, suggestions, etc.
  905.     ------------------------------
  906.  
  907.         If you find any bugs, or have suggestions or comments on 
  908.         this program, I would appreciate if you would let me know.
  909.         Send the information to me at:
  910.  
  911.         2:270/19@fidonet       or      mw@abslu
  912.