home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / CEL141.ZIP / CEL141B.ZIP / CEL_DOCS.ZIP / CELUSER.DOC
Text File  |  1992-05-03  |  12KB  |  227 lines

  1. Celerity User Documentation
  2. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3. This file is a brief explanation of a few features of Celerity which would be
  4. of value to any user of Celerity.  It should also help illuminate some of the
  5. more complex features.
  6.  
  7.  
  8. 1.  Configuring your account.
  9. 2.  The command prompts.
  10. 3.  Color "pipe" commands.
  11. 4.  The QWK reader.
  12.     Afterword
  13.  
  14.  
  15. Configuring Your Account
  16. ~~~~~~~~~~~~~~~~~~~~~~~~
  17. Celerity BBS features a high level of configurability not only for sysops, but
  18. for users as well.  From the configuration section, users can tailor the BBS'
  19. interface to their specifications by enabling and disabling features, changing
  20. colors, and selecting areas to scan for newscans.
  21.  
  22. The configuration section is made up of five distinctly seperate sections.
  23. The general configuration screen, the personal data screen, the newscan
  24. configuration screen, the feature toggles, and the file listing setup.
  25.  
  26. The General Configuration Screen is characterized by terminal-specific
  27. functions.  At the upper left of the screen are sections for terminal
  28. emulation (TTY (none), VT52, Atari VT52, VT100, ANSI, and Avatar are currently
  29. supported), display length (24 or 49 lines standard), whether or not your
  30. terminal requires linefeeds, and a toggle for the help level (explained
  31. below).
  32.  
  33. Below this are selections for the eight colors used by Celerity.  The first
  34. seven are usually some color (1-15) on black, and the eighth color is an
  35. inverse color (non-black background).  There is no rule against having other
  36. colors be inverse, however.  Note that for users of Hercules/MDA adapters will
  37. find some color selections indicitive of underlining.  TTY and VT52 have no
  38. color control, and Atari VT52 and VT100 have limited color control.
  39.  
  40. On the lower left of the general configuration screen are commands for linking
  41. other configuration pages.
  42.  
  43. The Personal Data Screen allows users to edit their age, mailing address, user
  44. note, signature, and password.  The user note is shown to other users on posts
  45. from you, and in a listing of users.  The signature will be appended to posts
  46. and email.
  47.  
  48. The Newscan Configuration Screen allows you to define two types of newscans:
  49. the global newscan, which scans all selected message bases then all selected
  50. file sections, and the detailed conference configuration.  The main screen for
  51. this section lists both the message and transfer conferences, and allows you
  52. to type a key (1-5) to include that conference in your global scan.  The [T]
  53. key toggles between transfers and message conferences.
  54.  
  55. Typing [D] will take you to the detailed conference configuration.  This
  56. enables you to specify the individual sub-boards in each message conference
  57. that you wish to scan, and those you want to skip.  Note that when new subs
  58. are added to the board, they are NOT scanned by default.
  59.  
  60. The feature toggles dialog contains a list of ten features which can be
  61. adjusted to your preferences:
  62.  
  63. 1:  Use Color.  If you use the VT100, ANSI, or Avatar terminal emulations, you
  64.     can enjoy color in nearly all portions of the BBS.  For some people, the
  65.     color is too garish.  For others, color slows the data transmission down
  66.     too much.  Turning this option OFF will make the BBS function in a
  67.     monochrome mode.
  68.  
  69. 2:  Editor Type.  This option allows you to select between a normal line-based
  70.     editor and a limited full screen editor.
  71.  
  72. 3:  Prompt Format.  Prompts can be "normal", where they appear a line or two
  73.     below the last bit of text displayed before the prompt, or they may be
  74.     "floating".  A floating prompt always positions itself at the bottom of
  75.     your screen.  Again, some users prefer floating prompts, some prefer non-
  76.     floating.  Experiment to see which you prefer.
  77.  
  78. 4:  Key input.  This option allows you to toggle between normal and "single-
  79.     key" input.  See the section on "Command Prompts" below for more details.
  80.  
  81. 5:  Linefeeds.  This duplicates the selection on the main configuration
  82.     screen.
  83.  
  84. 6:  Scan Network Subs.  If you are a user on multiple boards carrying
  85.     CelerityNet, you probably only want to read messages on the one you call
  86.     most frequently.  Although you may skip them individually by de-selecting
  87.     them in the detailed scan, this is a quick and easy toggle to skip the
  88.     networked subs in your newsans.
  89.  
  90. 7:  Update QWK message pointers.  If you use the QWK message handler (see the
  91.     section on it below), you may want messages exported to a QWK packet to be
  92.     marked as "read" on the BBS.  To do so, you must enable this option.
  93.  
  94. 8:  Multinode Chat Paging.  On systems with multiple nodes, there are times
  95.     when other users incessantly page you for a chat.  If you do not want to
  96.     acknowledge these chat requests, you can flip this option off and you will
  97.     not see their chat requests.
  98.  
  99. 9:  Use Yes/No prompts.  Celerity has a unique Yes/No toggle which can be
  100.     selected by pressing Y, N, or the space bar.  This is a flashy feature
  101.     which looks nice, but isn't enjoyed by all users.  This option will
  102.     commute the flashy Yes/No prompts to a simple "Y/n"-type prompt.
  103.  
  104. 10: Help Level.  Celerity caters to users of varying degrees of familiarity
  105.     and skill with the software.  At the "Expert" level, users are presented
  106.     with bare prompts, and must type a question mark (?) to see a menu or an
  107.     area/conference list.  At the "Intermediate" level, users are shown area
  108.     lists when they change xfer or message areas, or when they change
  109.     conferences.  They must still type a question mark (?) to see a full menu.
  110.     At the "Novice" level, users are given area lists, and are given a list of
  111.     available key commands available at a certain prompt.  A question mark
  112.     brings up the normal menu.  If a user selects the "Beginner" level, a
  113.     full (or abreviated beginner) menu is displayed at every prompt, and area
  114.     lists are always given.  The higher help levels (Novice and Beginner) can
  115.     be helpful to users who are just starting to use the software, but can
  116.     become an annoyance rapidly.  Make sure you know how to change the help
  117.     level.
  118.  
  119. The final configuration screen is the file list configuration.  This was
  120. another unique Celerity feature which has since spread to many other software
  121. packages due to its intrinsic value.  This feature allows users to select
  122. which data they wish to see in file listings, as there is more data than can
  123. be displayed in a single line.  Users may select file name, extension, program
  124. name (very helpful for multiple-file uploads of the same program), file size,
  125. file download cost, date uploaded, who uploaded it, the disk numbers (ie: disk
  126. 1 of 4), how many times it has been downloaded, and finally a description.
  127. You will be required to select your file format before entering the file
  128. section.
  129.  
  130.  
  131.  
  132. The Command Prompt
  133. ~~~~~~~~~~~~~~~~~~
  134. Entry at command prompts can be in one of three forms.  T
  135.  
  136. he first is "single key" input mode, configured from the user configuration
  137. screen (see "Configuring Your Account" above).  In this mode, you do not need
  138. to press [Enter] after typing your command, save for slash (/) commands.
  139.  
  140. The second mode is "normal" data entry, selected by turning the "single key"
  141. mode off.  You enter data, then press the [Enter] key when finished.  Most
  142.  
  143. users prefer this mode.
  144.  
  145. The third mode is an extension of the second, and is called the "command
  146. stack" method.  Utilizing this feature, a user can enter a number of commands
  147. at once, and sit back while Celerity executes them.  Individual commands are
  148. seperated by a semicolon (;), and up to 80 characters can be entered.  For
  149. example, a user has just read mail from the sysop asking him to post some
  150. information about a recent upload on the fifth sub.  The user types
  151. "Q;M;1;B5;P;Upload Information;;" and presses enter.  This gives Celerity the
  152. commands to quit the mail menu, enter the message bases, select conference #1,
  153. change to the fifth sub, post a message, title it "Upload Information", and
  154. add two additional [Enter]s (specified by the semicolons without associated
  155. commands).  This feature is used often by more experienced users, but can be
  156. frustrating for beginning users who do not know the full layout of the BBS.
  157.  
  158. At nearly any menu prompt, a user can use the following commands:
  159.  
  160. /VER   -  Display version of Celerity running.
  161. /OFF   -  Instantly log off system.
  162. /O     -  Same as /OFF above.
  163. /CHAT  -  Call the sysop for a chat.
  164. /PAGE  -  Emergency chat call.  Requires a sysop-defined password.
  165.  
  166.  
  167. Color Commands
  168. ~~~~~~~~~~~~~~
  169. Celerity features a set of "pipe" commands which allow users to insert color
  170. in their posts, automessages, and electronic mail (some users incorrectly
  171. refer to these as "MCI codes" after the term used in the Telegard package).
  172. Color codes are always two-digit codes beginning with a dos pipe character
  173. (| ), which will not show up in this file if you are viewing it from within
  174. Celerity.  The second digit refers to the desired color.
  175.  
  176. |1 to |8 (one through eight) specify the user's defined color #.  Letters may
  177. also be used to specify absolute colors, with uppercase characters specifying
  178. high intensity.
  179.  
  180. |b - blue      |B - High Intensity Blue
  181. |g - green     |G - High Intensity Green
  182. |c - cyan      |C - High Intensity Cyan
  183. |r - red       |R - High Intensity Red
  184. |m - magenta   |M - High Intensity Magenta
  185. |y - brown     |Y - Yellow
  186. |w - white     |W - High Intensity White
  187. |d - dark grey
  188.  
  189.  
  190. The QWK Reader
  191. ~~~~~~~~~~~~~~
  192. Celerity is fully compatible with QWK-format offline readers.  An offline
  193. reader (such as Offline Express / Silly Little Mail Reader, KingQWK, Qmail
  194. Deluxe, and many others) enables you to read posts and view file upload lists
  195. without being connected to the BBS, thus saving phone costs and freeing up the
  196. board for other users.
  197.  
  198. To build a packet, you should select the QWK packet menu (normally [Q] from
  199. the main menu), and G)enerate a packet.  You will be asked if you would like
  200. to get all new (unread) posts, all posts/file listings from a certain date, or
  201. 20% of the posts from each sub-board.  Note that only conferences and subs
  202. which you have specified in your global newscan will be included.
  203.  
  204. Celerity will then proceed to assemble your packet and allow you to download
  205. it.  The packet will be named "CEL_0501.QWK", for example, for a packet
  206. downloaded from the Celerity support board on 05/01.  Assuming that you have
  207. already downloaded and installed a QWK offline reader, you simply run the
  208. reader after logging off the BBS.  The reader will allow you to read messages
  209. and respond to them, and will create a Reply packet (CEL_0501.REP).  On your
  210. next call to the board, you should once again enter the QWK section, and
  211. upload your reply packet.  Celerity will decode it and post your messages on
  212. the appropriate subs.
  213.  
  214. Use of the QWK packet can stimulate conversation tremendously, as users can
  215. download a large number of messages and upload a number of replies in a
  216. fraction of the time (and cost) it would take to read and post online.
  217.  
  218.  
  219. Afterword
  220. ~~~~~~~~~
  221. This file is rather sparse, and will probably be updated in the future.  Users
  222. who are Celerity experts are welcome to write sections of their own and upload
  223. them to the Celerity Support Board @310-693-8651 for inclusion in future
  224. versions of this file.
  225.  
  226.  
  227.