home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / comm / qslvr122.lha / QSilver.Doc < prev    next >
Text File  |  1993-07-11  |  12KB  |  388 lines
  1.  
  2.         ***************************************************************
  3.  
  4.         Q U I C K   S I L V E R   F I L E   R E Q U E S T   S E R V E R
  5.  
  6.         ***************************************************************
  7.  
  8.                      The ARexx Alternative  by Roger Clark
  9.                               v1.22   10 July 93
  10.  
  11.         ***************************************************************
  12.  
  13.   I.  Introduction.
  14.  
  15.    Welcome  to  Quick  Silver,  a  fully functional FidoNet file request server
  16. written  entirely in ARexx.  This project has taken the better part of 8 months
  17. to  complete,  and  has  been tested online for over six months with no bugs in
  18. sight.   I  hope  to  add  more features in the future.  For now, it serves the
  19. files  and  has  a few other nice features.  Here's a basic overview of what is
  20. available.
  21.  
  22.         o MAGIC filename support, with password protection
  23.  
  24.         o Multiple directory paths, each can have it's own password
  25.  
  26.         o FTS-001 compliant NetMail status report
  27.  
  28.         o FTS-001 compliant NetMail for first time callers
  29.  
  30.         o Nodelist support to allow/not allow unlisted nodes or points 
  31.           access to your files
  32.  
  33.         o Ability to lockout specified nodes and points from your system
  34.  
  35.         o Filter to check for file extensions that you do not want
  36.           Quick Silver to send (.info .Desc .BBS etc.)
  37.  
  38.         o Update Requests now supported. Format is as follows:
  39.           FILENAME [!PASSWORD] +/-Uyymmdd[hhmmss] for normal date/time
  40.           FILENAME [!PASSWORD] +/-unix_timestamp  for unix style request
  41.  
  42.         o Wildcard pattern matching supported with the standard ? and *
  43.           characters.
  44.  
  45.         o Database file for improved speed when locating files. (Optional)
  46.  
  47.  
  48.  II.  Setup.
  49.  
  50.    The  setup for Quick Silver is fairly straight forward, and should only take
  51. a few moments to accomplish.
  52.  
  53.         o Copy QSilver.rexx to your systems Rexx: directory
  54.  
  55.         o Make a directory for Quick Silver's data and configuration files.
  56.           Example: "Mail:QSilver"
  57.  
  58.         o Copy "QSilver.CFG" to this directory
  59.  
  60.         o Make a subdirectory for Quick Silver's accounting files.
  61.           Example: "Mail:QSilver/Accounts"
  62.  
  63.         o If you wish to use a custom HEADER file or FIRST TIME CALLER file
  64.           then edit the included "QSilver.Header" and "FirstTime.TXT" and
  65.           place them in the Quick Silver data directory.
  66.  
  67.         o Tell your mailer/frontend how to call Quick Silver.  You need to
  68.           pass the following to Quick Silver:
  69.  
  70.           [Input File] [Output File] [Configuration File] [Caller's Node
  71.           Number] [Caller's Name]
  72.  
  73.           TrapDoor users:
  74.           FREQUEST "RX QSilver.rexx %i %o {Path to QSilver.CFG} %n %S"
  75.  
  76.         o Edit the QSilver.CFG file to reflect your system's information
  77.  
  78. III.  Configuration File.
  79.  
  80. Note: Parameters in [] are required, {} are optional.
  81.  
  82. Keyword      Description
  83. ------------ -----------------------------------------------------------------
  84.  
  85. SYSOP        Your name.  This is used for the LOCALMSG netmail.
  86.  
  87.              Usage: SYSOP [Name]
  88.  
  89.              SYSOP Roger Clark
  90.  
  91.  
  92.  
  93. NODE         Your 4-Dimensional FidoNet Node Number.
  94.  
  95.              Usage: NODE [Node number]
  96.  
  97.              NODE 1:382/105.0
  98.  
  99.  
  100.  
  101. NAME         Your BBS Name.
  102.  
  103.              Usage: NAME [BBS Name]
  104.  
  105.              NAME The Hotel California
  106.  
  107.  
  108.  
  109. PRIORITY     Task priority you wish Quick Silver to run at.  Default is 4.
  110.  
  111.              Usage: PRIORITY [Task Priority]
  112.  
  113.              PRIORITY 0
  114.  
  115.  
  116.  
  117. NODELIST     Path to your Nodelist Files.  Required for nodelist support when
  118.              using the (NO)POINT or (NO)UNLISTED keywords.  Also will include
  119.              data from the nodelist in your Quick Silver log file.  Access to
  120.              the nodelist is via the traplist.library by Martin J Laubach. As
  121.              of version 1.22, this defaults to "Nodelist:"
  122.  
  123.              Usage: NODELIST [Pathname]
  124.  
  125.              NODELIST DH0:Mail/Nodelist
  126.  
  127.  
  128.  
  129. LOGFILE      Path to Quick Silver's log file. Omitting this keyword will tell
  130.              Quick Silver not to keep a log of the file request results for
  131.              your personal records.
  132.  
  133.              Usage: LOGFILE [Pathname]
  134.  
  135.              LOGFILE DH0:Mail/QSilver/QSilver.Log
  136.  
  137.  
  138.  
  139. LOCALMSG     Tells Quick Silver to create a netmail in your Inbound directory
  140. NOLOCALMSG   that is a copy of the reply sent to the requesting system.  This
  141.              option requires the INBOUND keyword to specify the directory so
  142.              your mail processor can properly import the message.
  143.  
  144.              Usage: LOCALMSG
  145.                 or: NOLOCALMSG
  146.  
  147.              LOCALMSG
  148.  
  149.  
  150.              
  151. INBOUND      Path that your mail processor uses for inbound files.  This is 
  152.              only required if you specify the LOCALMSG keyword in your config
  153.              file.  The path defaults to "Inbound:".
  154.  
  155.              Usage: INBOUND [Pathname]
  156.  
  157.              INBOUND Mail:Inbound
  158.  
  159.  
  160.  
  161. ACCTPATH     Path for Quick Silver's accounting files.  Omitting this keyword
  162.              will tell Quick Silver not to keep accounting data for calling
  163.              systems.
  164.  
  165.              Usage: ACCTPATH [Pathname]
  166.  
  167.              ACCTPATH DH0:Mail/QSilver/Accounts
  168.  
  169.  
  170.  
  171. DATABASE     Path to the new (v1.21+) optional DataBase file for Quick Silver.
  172.              This file will speedup file location on most systems.  By ommiting
  173.              this keyword, Quick Silver will function the same as previous
  174.              versions.
  175.  
  176.              Usage: DATABASE [Pathname]
  177.  
  178.              DATABASE DH0:Mail/QSilver/QSilver.DBase
  179.  
  180.  
  181.  
  182. SCREEN       Public Screen name to open status window on.  This can only be
  183.              used with WorkBench 2.0+.  Please note that screen names are
  184.              case sensitive.  Default is no display.
  185.  
  186.              Usage: SCREEN [Screen Name]
  187.  
  188.              SCREEN TrapDoor
  189.  
  190.  
  191.  
  192. SCREENPOS    Defines the X and Y coordinates of the upper-left corner for the
  193.              status window.  Only effective if SCREEN keyword is used.
  194.              Default is 100 75.
  195.  
  196.              Usage: SCREENPOS [X-Coordinate Y-Coordinate]
  197.  
  198.              SCREENPOS 100 75
  199.  
  200.  
  201.  
  202. HEADER       Path and name of Header file for Quick Silver's report file.
  203.              Omitting this keyword will create a report file with a generic
  204.              header.
  205.  
  206.              Usage: HEADER [Path to file]
  207.  
  208.              HEADER DH0:Mail/QSilver/QSilver.Header
  209.  
  210.  
  211.  
  212. FIRSTCALL    Path and name of the data file to be sent to first time callers.
  213.              Omitting this keyword will tell Quick Silver not to send a file
  214.              to first time callers.
  215.  
  216.              Usage: FIRSTCALL [Path to file]
  217.  
  218.              FIRSTCALL DH0:Mail/QSilver/FirstTime.TXT
  219.  
  220.  
  221.  
  222. MAXBYTES     Maximum number of bytes to be requested in one session.  If the
  223.              current file is large enough to exceed this limit, Quick Silver
  224.              will skip this file and go on to the next, and a error message 
  225.              will be added to the report file to inform the caller of the 
  226.              problem.  It is therefore adviseable to set this value larger than
  227.              the biggest file that is available for requesting. If this keyword
  228.              is omitted or set to zero, then no limit is imposed.
  229.  
  230.              Usage: MAXBYTES [Number of bytes]
  231.  
  232.              MAXBYTES 750000
  233.  
  234.  
  235.  
  236. MAXFILES     Maximum number of files to be requested in one session.  Quick
  237.              Silver will simply stop processing the request file when it reaches
  238.              the limit set with this keyword.  A message will be added to the
  239.              report file telling the caller that the maximum file per call limit
  240.              was exceeded.  If this keyword is omitted or set to zero, then no
  241.              limit is imposed.
  242.  
  243.              Usage: MAXFILES [Number of files]
  244.  
  245.              MAXFILES 10
  246.  
  247.  
  248.  
  249. MAXMATCH     Maximum files to match with a single wildcard.  Quick Silver will
  250.              only send as many matches to a wildcard as you specify.  If this
  251.              keyword is omitted or set to zero, then all files that match the
  252.              requested wildcard will be sent.  NOTE: *.* is not accepted as a
  253.              valid wilcard, nor is any other *. wildcard. ie: *.LHA would be 
  254.              rejected as a bad wildcard pattern.
  255.  
  256.              Usage: MAXMATCH [Number of matched files to send]
  257.  
  258.              MAXMATCH 5
  259.  
  260.  
  261.  
  262. MAGIC        Defines a standard name for a file to be requested and may be
  263.              followed by the PASSWORD keyword.
  264.  
  265.              Usage: MAGIC [Magic Filename] [Path] {PASSWORD} {file password}
  266.  
  267.              MAGIC Files DH0:BBS/Files.LHA
  268.              MAGIC QSilver DH0:Beta/QSilver.LHA PASSWORD Secret
  269.  
  270.  
  271.  
  272. DEFCOMMENT   Defines the comment that Quick Silver should use in its reply
  273.              message if the filenote for a requested file is not set.
  274.  
  275.              Usage: DEFCOMMENT [Comment]
  276.  
  277.              DEFCOMMENT No File Description Available
  278.  
  279.  
  280.  
  281. DLGDESC      Tells Quick Silver to try to use the internal DLG comments
  282. NODLGDESC    rather than the AmigaDos FileComment.
  283.  
  284.              Usage: DLGDESC
  285.                 or: NODLGDESC
  286.  
  287.              NODLGDESC
  288.  
  289.  
  290.  
  291. DEFAULTSEND  Defines a file that will be sent with every file request.  This
  292.              flie is sent only if the file request resulted in files being
  293.              sucesfully requested and sent.  If this keyword is omitted then
  294.              no file will be sent.
  295.  
  296.              Usage: DEFAULTSEND [Path]
  297.  
  298.              DEFAULTSEND BBS:NewFiles.LHA
  299.  
  300.  
  301.            
  302. DIRECTORY    Defines the directory path(s) to be searched for requested files
  303.              and may be followed by the PASSWORD keyword.  If the PASSWORD
  304.              keyword is specified, then all files in that directory will require
  305.              the password if they are to be sucessfully requested. It is advised
  306.              that you list the paths that receive the most requests at the 
  307.              beginning of the list, as Quick Silver searches for files in the
  308.              order of paths specified.
  309.  
  310.              Usage: DIRECTORY [Path] {PASSWORD} {directory password}
  311.  
  312.              DIRECTORY DH0:Files/TransAmiga
  313.              DIRECTORY DH0:Files/TA-Betas PASSWORD Confidential
  314.  
  315.  
  316.  
  317. POINTS       Allow or not allow points to request files from your system.
  318. NOPOINTS
  319.              Usage: POINTS
  320.                 or: NOPOINTS
  321.  
  322.              POINTS
  323.  
  324.  
  325.  
  326. UNLISTED     Allow or not allow unlisted systems to request files from your
  327. NOUNLISTED   system.
  328.  
  329.              Usage: UNLISTED
  330.                 or: NOUNLISTED
  331.  
  332.              NOUNLISTED
  333.  
  334.  
  335.  
  336. PASSWORD     Defines the password for a DIRECTORY or MAGIC filename
  337.              Usage: PASSWORD [Password]
  338.  
  339.  
  340.  
  341. IGNORE       Tells Quick Silver to ignore any files with the indicated filetype.
  342.              Specify one file extension per IGNORE statement.
  343.  
  344.              Usage: IGNORE .INFO
  345.                     IGNORE .DESC
  346.                     IGNORE .BBS
  347.  
  348.  
  349.  
  350. EXCLUDE      Tells Quick Silver not to accept File Requests from the node or
  351.              point specified after the keyword.  Specify one node per EXCLUDE
  352.              statement. Specify the full 4D address (Z:N/n.p) when listing
  353.              the node number.
  354.  
  355.              Usage: EXCLUDE 1:234/56.0
  356.                     EXCLUDE 2:345/67.8
  357.  
  358.  
  359.  
  360.  IV. DataBase
  361.  
  362.    New  to  version  1.21  is the DataBase utility.  This utility will read the
  363. directory  information  from  your QSilver.CFG file and build a master database
  364. listing.   This  is  an  optional utility, so play with it and see if the speed
  365. increase  is worth it.  You need to specify a DATABASE path in your QSilver.CFG
  366. file for the DataBase utility to work.
  367.  
  368.   Usage: DATABASE [Path to QSilver.CFG]
  369.  
  370.   DATABASE QSilver:QSilver.CFG
  371.  
  372.  
  373.  
  374.   V. Registration
  375.  
  376.    This  program  is  released  as SHAREWARE.  If you use Quick Silver for more
  377. than  30  days,  you must register the program or stop using it.  I do not like
  378. CRIPPLEWARE,  nor do I like REQUESTORS as reminders, so you won't be annoyed by
  379. either  of  these.   I  ask  that you send a $15 registration fee to me, and in
  380. return  you  will  be entitled to the 'C' version when it is completed.  Please
  381. send your registration fee, payable to:
  382.  
  383. Roger Clark
  384. 5508 Delwood Drive
  385. Austin TX 78723
  386. ----------------------
  387. [EOF]
  388.