home *** CD-ROM | disk | FTP | other *** search
/ MS DOS Archives 1 / MS-DOS_Archives_Volume_One_Walnut_Creek.iso / msdos / bbsdoors / fdoor16.arc / FILEDOOR.DOC < prev    next >
Text File  |  1988-10-15  |  5KB  |  139 lines
  1.  
  2.  
  3.                    *************************************
  4.                    *                                   *
  5.                    *             File Door             *
  6.                    *               v 1.6               *
  7.                    *                                   *
  8.                    *                                   *
  9.                    *   Written by Anthony Li for use   *
  10.                    *     as a SearchLight BBS door     *
  11.                    *                                   *
  12.                    *                                   *
  13.                    *************************************
  14.  
  15.  
  16. The documentation is brief and poorly structured, but the program's free, so
  17. enjoy.
  18.  
  19.  
  20. Introduction
  21. ------------
  22.  
  23. The purpose of the File Door is to allow the shareware version of the
  24. excellent SearchLight BBS to support extended file transfer protocols. The
  25. File Door uses only a small subset of the commands found in SearchLight's
  26. file system. But, it's enough to get the file transfers running...
  27.  
  28. The File Door is compatible with Zephyr ANSI (ZANSI.SYS)! If you have ZANSI
  29. installed, no output will be sent to the remote terminal. You must have
  30. have ANSI.SYS installed.
  31.  
  32.  
  33.  
  34.  
  35. Configuring the File Door
  36. -------------------------
  37.  
  38. I tried to keep the number of files that the File Door uses to a minimum.
  39. The File Door uses these files:
  40.  
  41.         *.DIR              -- Your file directory lists
  42.         CONFIG.BBS         -- SearchLight's configuration file
  43.         FILEDOOR.CFG       -- File Door's configuration file
  44.         FILEDOOR.ANS       -- ANSI intro screen (optional)
  45.         FILEDOOR.TXT       -- Text intro screen (optional)
  46.         FILEDOOR.EXE       -- The program
  47.  
  48.  
  49. The File Door's configuration file, FILEDOOR.CFG must be located in the same
  50. directory that you run the File Door in. The file must be in the format:
  51. -----------------------------------------------------------------------------
  52. <BBS program path>[;NO LOG]
  53. <protocol-description>;<path>;<u/l-command-line>;<d/l-command-line>
  54.    :
  55. <protocol...>
  56. -----------------------------------------------------------------------------
  57.  
  58. You may optionally disable logging of file transfers by including the line
  59. ";NO LOG" after the <BBS program path>. Otherwise, the File Door keeps
  60. track of all uploads and downloads, writing them to the file FILEDOOR.LOG.
  61.  
  62. In the upload-command-line and the download-command-line, you must specify
  63. the filename using %FILE. When the File Door runs the protocol, it replaces
  64. the string %FILE with the name of the file to transfer.
  65.  
  66. Example:
  67. --------
  68.    C:\BBS
  69.    ZModem;C:\BBS\DSZ.COM;rz %FILE;DSZ.COM sz %FILE
  70.    Kermit;C:\BBS\KERMIT.EXE;get %FILE;KERMIT.EXE send %FILE
  71.  
  72.  
  73. To add the File Door to your DOORS.DEF file, add the line:
  74. -----------------------------------------------------------------------------
  75. 1;0;1;0;File Door;<path>;FILEDOOR.EXE %G %F %M %N
  76. -----------------------------------------------------------------------------
  77.  
  78.  
  79. Addition to FILEDIR.DEF:
  80. -----------------------
  81. You can now specify that a file directory is read only (only downloads), write
  82. only (only uploads), or read/write (both uploads and downloads are allowed).
  83. You can do this by adding an additional parameter to the end of the directory
  84. entry in your FILEDIR.DEF file. If the entry contains an uppercase "R",
  85. it is read only. If it contains an uppercase "W", it is write only. If it
  86. contains both "R" and "W" it is readable and writeable. If the entry is not
  87. present, File Door assumes it is both readable and writeable.
  88.  
  89. Example:
  90. --------
  91.    UPLOADS;0;C:\BBS\UPLOADS;Newly uploaded and untested files;Write only
  92.    PRINTER;5;C:\BBS\PRINTER;Printer programs;RW
  93.    UTILITY;5;C:\BBS\UTILITY;DOS Utilities
  94.    PROGRAM;5;C:\BBS\PROGRAM;Programming languages;R
  95.  
  96. The first directory (UPLOADS) can only be uploaded to.
  97. Files can be uploaded and downloaded from the second directory (PRINTER).
  98. File Door assumes the third directory (UTILITY) is also read/write.
  99. Only downloads are allowed in the last directory (PROGRAM). NOTE: This
  100.   technique is useful for forcing uploads into a specific directory.
  101.  
  102.  
  103.  
  104.  
  105. Additional FILESx.TXT/ANS:
  106. --------------------------
  107. You can now have text files displayed for each file area, instead of just
  108. one FILES.[ANS/TXT]. The filename for area "A" is still FILES.TXT, but you
  109. can have a FILESB, for file area "B", a FILESC, for file area "C", etc.
  110. (With the [.TXT/.ANS] extension, of course.)
  111.  
  112. The text file for area "A" is not displayed. Instead, FILEDOOR.TXT/ANS is
  113. shown. The next time the user jumps from another directory into directory "A",
  114. the FILES.TXT file is shown, if it has not been shown before in SL's file
  115. section.
  116.  
  117.  
  118.  
  119.  
  120. Known bugs:
  121. -----------
  122. Passwords don't work properly yet. (Leave me mail if anybody needs 'em...)
  123.  
  124.  
  125.  
  126.  
  127. Changes from version 1.5:
  128. -------------------------
  129. The upload-download ratio checking routine has been fixed.
  130. The program now credits uploads and downloads to the user's account.
  131. The searching routine for making sure a file to be uploaded is new to the
  132.   board has been improved.
  133.  
  134.  
  135.  
  136.                                                    Anthony Li
  137.  
  138.                                           SysOp of the Brain Storm BBS!
  139.                                                 (301) 384-5960