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