home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 6 / FreshFish_September1994.bin / bbs / comm / ftpcdrom-2.11.lha / FTPcdrom / ftp.doc < prev    next >
Text File  |  1994-07-09  |  8KB  |  214 lines
  1.                   FTP Simulator Door Version 2.11
  2.  
  3.   Introduction:
  4.  
  5.      With the advent of CD-ROM drives, the Citadel BBS needed a method
  6.      to access multiple directories and allow a user to transfer files
  7.      from the CD-ROM to their system.  This program allows a user to
  8.      change directory and yet is safe from the hacker.
  9.  
  10.      This program is shareware.  If you use it, you must send a small
  11.      donation to me.  The minimum amount is $10, if you find it more
  12.      valuable, feel free to send more.  If you decide not to use it
  13.      then please send me a mail message or a postcard and tell me why.
  14.  
  15.      Send all fees to:
  16.  
  17.         Custom Services
  18.         P.O. Box 254
  19.         Moorestown, NJ 08055
  20.  
  21.      Registered users will receive an updated version if they include
  22.      either a larger donation than the minimum, or a disk and postage.
  23.      Registration will get you a personalized registration key that will
  24.      eliminate the reminder.
  25.  
  26.  User Operation:
  27.  
  28.    A user runs the door from your BBS, or you run it from a CLI.  See the
  29.    USER.DOC file for an explination of the commands available.
  30.  
  31.  Installation
  32.  
  33.    This program requires the 2.04 ROM or later.  It will not run under
  34.    1.3.
  35.  
  36.    The program is simple to operate.  You copy it to a directory on your
  37.    path and setup the door entry to be:
  38.  
  39.  
  40.  #door ftp ftp  in:  anyone  modem unlimited
  41.   File transfer Program.
  42.   <ctdl-aux: >ctdl-aux:  "%d" cd0: in:
  43.  
  44.  The program has the following arguments:
  45.  
  46.    ftp "user name"  <directory 1> <directory 2>
  47.  
  48.       user name is the name the user has on the BBS.  For Citadel use
  49.                 "%d".
  50.  
  51.       directory1 is the root directory the user is allowed to examine.
  52.                  This is the directory the user will start with.  The
  53.                  user can move into any sub directory in this directory.
  54.                  The user will not be allowed to move to other places.
  55.                  This can be on a floppy, HD, or any other file system
  56.                  type device.
  57.  
  58.       directory2 is the directory attached to the room you have the door
  59.                  attached to.  This way, when a user exits the door, the
  60.                  files retrieved with the GET command are ready to be
  61.                  downloaded.
  62.  
  63.                  At this time, when a user does a GET, the file is copied
  64.                  to this directory.
  65.  
  66.       There are two other items the program uses if they are defined.
  67.       These are environment variables.
  68.  
  69.       FTP_BBS_NAME     - This will be used to display a welcome message as
  70.                          if the user is on an internet site.
  71.                          You do not have to have it, the program will
  72.                          supply a default.
  73.  
  74.       FTP_SITE_NAME    - This will be used to display the name you chose for
  75.                          your ftp site.  You do not have to have it, the
  76.                          program will supply a default.
  77.  
  78.       FTP_REGISTRATION - This is your registration key, it must match the
  79.                          FTP_BBS_NAME.  This will be supplied to you
  80.                          after your registration fee is received.
  81.  
  82.       FTP_LOG_FILE     - This is an optional name that will define a log
  83.                          file which will show how active the door was and
  84.                          what user made use of it.  This is just a file
  85.                          name.  If not defined, no log is kept.
  86.  
  87.       Define these with the command: "setenv FTP_BBS_NAME "my.bbs.name"
  88.  
  89.   I also recommend you create a room attached to directory2 and put the
  90.   USER.DOC file in there.  That will allow users to examine the door
  91.   commands.
  92.  
  93. Warranty
  94.  
  95.   30 seconds, 30 feet which ever comes first.
  96.  
  97.   If you have a problem, feel free to email me at apreston@isd.csc.com
  98.   or post it on your nearest Citadel in either the Citadel 68K, or
  99.   Sysop Only room.  You can also sent mail to
  100.  
  101.    tony preston@The Amiga Zone.NJ
  102.  
  103.   This is a STDIO door, it can be used with BBSes like DLG, and others
  104.   which have interfaces for that type of door.  If you do use this with
  105.   another type of BBS other than a Citadel, please send me the information
  106.   when you register so I can include it with the next update.
  107.  
  108.  
  109. Registration:  The door has no real restrictions except that the
  110.   unregistered version will remind your users that it is not registered
  111.   each time they move down a directory.  This reminder will slow them
  112.   up, but is harmless.  They will have to hit a return.
  113.  
  114.   The registration will get you a customized version key in the mail.
  115.   This will remove the limitations place on the unregistered version.
  116.  
  117.   Send $10 to:
  118.  
  119.     Custom Services
  120.     P. O. Box 254
  121.     Moorestown, NJ 08055
  122.  
  123.   Send Your Site Name and BBS Name exactly as you have them in the
  124.   environment variables mentioned above.  You are limited to 20 characters
  125.   for these names.
  126.  
  127.   Note: the registration key is controled by an environment variable.
  128.   If an incorrect value is registered, the users will experience a
  129.   10 second delay after an error message which says:
  130.  
  131.   ERROR: registration key error, auto delay activated
  132.  
  133.   This only occurs if the key value and your BBS name do not match.
  134. Future Plans:
  135.  
  136.   The door's GET command currently uses a COPY to move the files.  The
  137.   plan is to give the sysop more flexibilty and input the command used
  138.   with the default being the current COPY command.
  139.  
  140.   Give the ability for the user to specify a path name such as:
  141.  
  142.   Cd Aminet/Dev/c
  143.  
  144.   instead of
  145.  
  146.   Cd Aminet
  147.   Cd Dev
  148.   Cd c
  149.  
  150.   This will also include the usage of ".." and "/" as psuedonyms for
  151.   the parent directory.  This will still protect the Sysop in that
  152.   attempting to Cd above the top directory will exit the door.
  153.  
  154.  
  155.   Other commands have been suggested and will be added to the program
  156.   as time permits.
  157.  
  158.  Contents:
  159.  
  160.    The archive you have should have the following files:
  161.  
  162.    ftp.doc       This file you are reading.
  163.    user.doc      some simple user docs
  164.    ftp           68000 version
  165.    ftp.030       68030 version
  166.  
  167.  
  168.  History:
  169.  
  170.    Beta 1.0-1.03 - Initial release for testing.
  171.  
  172.    1.04Beta      - Added commands(LIST, "?")
  173.                    fixed bug in CD .. and CD / (did not work)
  174.                    fixed bug in VIEW, LIST, CD and DIR
  175.                    where error messages would come out even if
  176.                    ok.
  177.    2.00
  178.  
  179.    -- Supports LHA, LZH, LZ, Zoo, Zip, and ARC files with the VIEW command.
  180.       It will allow you to view the contents of an archive(similar to doing
  181.       LHA V FILE).
  182.    -- Supports limited wildcarding.  The "?" matches any character, the
  183.       "*" matches the rest of the string.  Using the "*" with "Sa*" matches
  184.       all files starting with the letters "Sa".  It is limited in that you
  185.       cannot match on "Sa*.lha" and only get the lha files starting with "Sa".
  186.    -- Supports sorting the directory information.  All lists will come out
  187.       in alphabetical order.
  188.    -- Now uses case sensitive names, like real unix would.
  189.    -- Supports both ".." and "/" as diretory names with the CD.  Both will
  190.       move up one level.
  191.    -- Command line supports directory names with or without the slash on
  192.       the end.  Previous version did not check for proper names.
  193.    -- Several minor bug fixes included.
  194.    -- 68030 optimized version include in the archive along with the
  195.       standard 68000 version.
  196.  
  197.    2.10
  198.  
  199.    -- Added the commands CASE to toggle the case sensitivity, C-ON to
  200.       force case sensitivity, COFF to turn off case sensitivity, and
  201.       STAT to display the current status information.
  202.    -- Added some meaningless statistics and a means for the SYSOP to
  203.       record them to a log file.
  204.    -- Added a new environment variable FTP_REGISTRATION which will allow
  205.       the registered version to be distributed and only a key needed to
  206.       unlock it.
  207.  
  208.    2.11
  209.  
  210.    -- Fixed a bug in the compare routine.  The very last character of
  211.       two names would not be compared if the names matched up to that
  212.       point.  A name like D300 matched D301.  This is fixed.
  213.  
  214.