home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_disks / 300-399 / ff343.lzh / SoftSpan / ReadMe < prev    next >
Text File  |  1990-04-16  |  10KB  |  240 lines
  1.                 Soft Span BBS (C) 1989 Mark Wolfskehl
  2.                        User Documentation
  3. ------------------------------------------------------------------------------
  4. Hello and welcome to Soft Span BBS.  This documentation will be brief and
  5. to the point.  But first, some business:
  6.  
  7. Soft-Span is distributed as shareware.  Copy this program and share it with
  8. your friends.  If you like it and use it to put up a bulletin board of
  9. your own, I request that you send me a very nominal fee of $25.  Send your
  10. check or money order to:
  11.  
  12.              Mark Wolfskehl
  13.              5 Hazelwood Avenue
  14.              Livingston, NJ  07039
  15.  
  16. Again, this is a very nominal fee considering the amount of work that went
  17. into the program's development.  I would like to add several features and 
  18. polish up the program in general, but without your support there is no reason
  19. why I should do this.
  20.  
  21. In addition, if you want the source code for the BBS (which is of a
  22. considerable amount), I will make it available under the following terms:
  23.  
  24.    1) You must have sent in your $25 registration fee
  25.    2) Send a check or money order in the amount of $100
  26.       (With the registration fee, this comes to a total of $125-
  27.        very reasonable)
  28.    3) The source code is made available for your own personal use only.
  29.       If you wish to distribute a modified version of the BBS or use any
  30.       of the code in a commercial or public domain program, contact me
  31.       and we can probably come to some sort of agreement.  However, no
  32.       such rights are granted here.
  33.  
  34. The source code is in 100% Lattice 5.0 C.
  35. ------------------------------------------------------------------------------
  36.               
  37. First, these are the files on the disk:
  38.  
  39. In the root directory:
  40.  
  41. ReadMe       -  This file
  42. Execute.Me   -  A file containing necessary assign startements
  43. SoftSpan     -  This is the Soft Span BBS program
  44.  
  45. Here are the other directories:
  46.  
  47. data         -  Contains settings and other general data for the BBS
  48. log          -  Where the user log goes
  49. text         -  Various text files and help files
  50. bases        -  Where the message base files are located
  51. dl           -  Contains the download directories
  52. ul           -  The upload directory
  53.  
  54. In:  soft_span:data
  55.  
  56. access       -  Info on "standard" access levels
  57. bases        -  Info describing the message bases
  58. dloads       -  Info describing the download and upload directories
  59. general      -  Some general settings
  60. modem        -  Description of modem messages, etc... Set for Hayes compat.
  61.  
  62. Be sure to read these files thoroughly and edit them to customize the BBS
  63. for yourself.  The documentation for these files is contained within the files
  64. themselves.
  65.  
  66. In:  soft_span:text
  67.  
  68. Bulletin.txt   - The current bulletin to users
  69. DescMenu.txt   - Descriptive menu. Called up by MENU command
  70. LogOut.txt     - Message displayed at logoff
  71. MailMenu.txt   - Menu within the mail read system
  72. Main.txt       - The BBS's main menu
  73. NewInfo.txt    - Displayed after a new user gives his info
  74. NewWelcome.txt - Displayed to new users before giving info
  75. ReadSys.txt    - Menu displayed when '?' chosen from the read system
  76. Tty_ed.txt     - Displayed within the editor if '/?' is entered
  77. Upload.txt     - Displayed before someone uploads a file
  78. Welcome.txt    - Displayed right after copyright notice
  79.  
  80. Be sure to edit these files to suit your own BBS
  81.  
  82. In:  soft_span:text/help            (General help files)
  83.  
  84. general.hlp    - General description of Soft Span's operation
  85. morehelp.hlp   - Description of the HELP command to get help on commands
  86. MsgSystem.hlp  - Explanation of the message base system
  87. tty_edit.hlp   - Help on using the tty(line) editor
  88. xfer.hlp       - Explanation of file transfers
  89.  
  90. In:  soft_span:text/cmd             (Command help files)
  91.  
  92. Each file in this directory is a help file on a specific command.
  93. The name of each file is <command>.hlp
  94. Where <command> is the name of the primary command.
  95.  
  96. In:  soft_span:bases
  97.  
  98. Each file corresponds to a mesage base (or Email, or feedback).
  99. The name of each file is <name>.base
  100. Where name is the name given to the base.
  101.  
  102. EMAIL.base   - The Email file
  103. FBACK.base   - The feedback file
  104.  
  105. -------------------------------------------------------------------------------
  106.  
  107. The software's files are set up so that you can start running the software
  108. right away from the distribution disk.
  109.  
  110. Just issue the following CLI commands:
  111.  
  112. execute execute.me
  113. run bbsport
  114.  
  115. Make sure your modem is on, and then click the requestor away.
  116.  
  117. You can now log in locally by hitting F1
  118.  
  119. Choose Quit from the intuition menu or AMIGA-Q to exit the program
  120. -------------------------------------------------------------------------------
  121. Necessary ASSIGNS:
  122.  
  123. If you install the BBS on a hard disk or in a RAM disk, you will need to
  124. assign the following logical device names:
  125.  
  126.    bbs_data:               -- This is where the configuration files go
  127.    bbs_log:                -- This is where the user log will go
  128.    bbs_text:               -- This is where the general text files/
  129.                               help directory goes
  130. ------------------------------------------------------------------------------
  131. The operation of the system is pretty much completely described in the help
  132. files.  However, here is some general information anyway:
  133.  
  134. Most listings/menus can be paused with CTRL-S and aborted with any other key.
  135. If you abort, the character you hit is placed in a buffer and immediately
  136. fed into the next input routine.
  137.  
  138. The main promt always displays the current message base and directory, if any.
  139. For instance, if the current base is AMIGA:   AMIGA>
  140. If the current directory is GAMES:    !GAMES>
  141. If the current base is AMIGA and the current directory is GAMES:
  142.               AMIGA!GAMES>
  143.  
  144. The directory name is always preceeded by an eclamation point.
  145. Don't be too confused by this system.  It is pretty similar to the CLI's
  146. command system.  Once you get used to it, it will become much more intuitive
  147. than the "dumb menu" system used by other programs.
  148. -------------------------------------------------------------------------------
  149. Notes about uploads and downloads:
  150.  
  151.   File descriptions are stored in the filenote for each download file.
  152.   To set a description name, use the FILENOTE command from the CLI.
  153.  
  154.   Uploaded files also have the computer type in the filenote.  Use LIST from
  155.   the CLI to see it.
  156.  
  157.   When files are uploaded, you'll have to move them into the appropriate
  158.    download directory at the CLI  by using the COPY or RENAME commands.
  159. -------------------------------------------------------------------------------
  160. The USERED and DEL commands do not have help files:
  161.  
  162. DEL deletes specified message(s) in the current message base
  163. For instance :
  164.   DEL 5
  165. Deletes message number five.
  166.   DEL 2-4
  167. Deletes messages 2, 3, and 4
  168. -------------------------------------------------------------------------------
  169. USERED is the user editor:
  170.  
  171. Choose N to edit new users
  172. Choose H to edit a specific user
  173. Choose U to get a user listing
  174.  
  175. When editing users, enter the letter or number corresponding to the field
  176. you want to change. Or, choose the number corresponding to a standard access
  177. level.  Choose '6' do delete the user.  Choose '0' when you're done.
  178. ------------------------------------------------------------------------------
  179.  
  180. Here's some information about CHAT
  181.  
  182. The user's handle, name, baud rate and a "chat reason" is displayed at top.
  183. When a user chooses 'CHAT', he is asked why he wishes to chat.  That reason
  184. is then displayed at top until he/she logs off.
  185.  
  186. When the user selects CHAT, the sysop will be paged by a beeping noise.
  187. The local sysop hits F2 to enter chat or F10 to deny a chat request.  The
  188. request will also be denied if the sysop doesn't respond.
  189.  
  190. In chat, the user and sysop can have a conversation.
  191.  
  192. =========================================================================
  193. Hitting F3 will bring up the user's information which can be edited as with
  194. USERED.
  195. =========================================================================
  196.  
  197. Hitting F10 exits chat and returns the user to the BBS
  198. In addition, you can break into chat in several places:
  199.         1) Before log-on, at the "Enter your handle" prompt
  200.         2) At the "Enter your password" prompt
  201.         3) At the main menu
  202. You can do this by pressing the F2 function key.
  203. -------------------------------------------------------------------------------
  204.  
  205.                           Setting up Soft-Span
  206.                           ====================
  207.  
  208. As there is currently no setup utility, you will have to log on as a new user.
  209.  
  210. To give yourself full sysop access:
  211.  
  212. Log on as a new user, giving all the required information
  213. enter CHAT
  214. enter any reason for chatting
  215. Hit F2
  216. You are now in chat
  217. Hit F3  - you will be in the user editor
  218. Give yourself access
  219. When you're done enter '0' and 'Y' to save your information
  220. You're back in chat
  221. hit F10 to exit chat
  222.  
  223. --------------------------------------------------------------------------
  224. Again, be sure to look over the files in the data directory, and in the
  225. text directory.
  226.  
  227. Once you log on, you can learn to use the system through the HELP system.
  228. The HELP files are extensive, and a careful reading of them should 
  229. elucidate the operation of the system.
  230.  
  231. I'm sorry that the documentation for setting up the system is kind of scanty,
  232. but I just don't have the time to write extensive documentation right now.
  233. My primary goal was to make the program available to the public right away,
  234. and better documentation will be forthcoming.
  235.  
  236. P.S. You'll need a text editor.  I use MicroEmacs, the version supplied with
  237.      the 1.3 system software, but you can use any you like.
  238.      Also, you'll need a working knowledge of the CLI in order to get things
  239.      running.
  240.