home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 3 Comm / 03-Comm.zip / READBBPM.ZIP / ON-LINE.DOC next >
Text File  |  1992-01-19  |  20KB  |  612 lines
  1.  
  2.  
  3.  
  4.                  **********  B E T A   D R A F T **********
  5.  
  6.                                ReadBBS/PM - Version 0.9
  7.                                  Written by:  Bob Mahan
  8.  
  9.  
  10.    This on-line documentation can be view sequentially by selecting
  11.    the next message from either the Messages menu, the M> push
  12.    button, or the Hot Key ' Alt + . ' combination.
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22. Message : 1 (Introduction) . . . . .
  23. . . ReadBBS PM  Refer.. : None
  24. Online : Help Panel
  25. Subject : Welcome to ReadBBS/PM
  26.  
  27.  
  28.    This program is designed as an off-line reader for electronic Bulletin 
  29.    Board Systems (BBS).  It utilizes list boxes along with Menus, Push 
  30.    Buttons, or Hot Keys to navigate through files, conferences, and 
  31.    messages.
  32.  
  33.    A large text pane (from which you are reading this message) displayed 
  34.    the contents of either the selected file, conference, or message.  The 
  35.    text pane is also used for entering replies.
  36.  
  37.  
  38. Message : 2 (Introduction) . . . . .
  39. . . ReadBBS PM  Refer.. : None
  40. Online : Help Panel
  41. Subject : ReadBBS/PM On-line Documentation
  42.  
  43.  
  44.    This on-line documentation is presented in message format to allow 
  45.    the ReadBBS/PM software to interact with it.  This file can be used to 
  46.    learn and practice the various options that are available.
  47.  
  48.  
  49. Message : 3 (Introduction) . . . . .
  50. . . ReadBBS PM  Refer.. : 1
  51. Online : Help Panel
  52. Subject : Supported Bulletin Boards
  53.  
  54.  
  55.    This release supports only the Multi-Net BBS message format.
  56.  
  57.    The next release of the ReadBBS/PM software will support other BBS 
  58.    mail format, including the popular QWK format.  So send in your
  59.    registration so I can bribe my wife to keep working on this.
  60.  
  61.  
  62. Message : 4 (Introduction) . . . . .
  63. . . ReadBBS PM  Refer.. : None
  64. Online : Help Panel
  65. Subject : Disclaimer
  66.  
  67.  
  68.    Although this software has undergone extensive testing, no garantees 
  69.    or warrenties are implied or assumed by the use of this product.  Any 
  70.    problems that are reported will be addressed and registered users will
  71.    be notified about the fix.
  72.  
  73.  
  74. Message : 5 (Introduction) . . . . .
  75. . . ReadBBS PM  Refer.. : None
  76. Online : Help Panel
  77. Subject : Registration
  78.  
  79.  
  80.    This product is distributed as Shareware.  If you feel that the
  81.    ReadBBS/PM product is worthy, a contribution of $25.00 would be
  82.    appreciated to continue development and support.  The $25 will
  83.    register your current copy of ReadBBS/PM and entitle you to the
  84.    latest version free.
  85.  
  86.    Send a check, money order, or cash (I'm not picky) to the address
  87.    shown on the initial text pane.
  88.  
  89.  
  90. Message : 6 (Introduction) . . . . .
  91. . . ReadBBS PM  Refer.. : None
  92. Online : Help Panel
  93. Subject : Enhancements
  94.  
  95.  
  96.    Enhancement requests are always welcome.  This product has been
  97.    designed around personal BBS behavior amd usage.  Your feedback
  98.    on ways to improve ReadBBS/PM can be sent to the address shown
  99.    on the initial text pane or through various OS/2 BBS's which I frequent.  
  100.    You need not be registered to request enhancements, but it wouldn't 
  101.    hurt the cause any.
  102.  
  103.  
  104. Message : 1 (Basic Features) . . . . .
  105. . . ReadBBS PM  Refer.. : None
  106. Online : Help Panel
  107. Subject : User Interface
  108.  
  109.    ReadBBS/PM is a Presentation Manager (PM) based system with
  110.    pull-down and pop-up menus, and mouse support.  Multiple list panes 
  111.    are used to display and select drives, directories, files, conferences, 
  112.    and messages.  Push buttons for message and ongoing conference 
  113.    discussion (thread) processing are also available.
  114.  
  115.    Special 'Hot-Key' combinations have been setup to allow for quick
  116.    access to various functions.  The key combinations are shown to the 
  117.    right of the pull-down and pop-up menu item.
  118.  
  119.  
  120. Message : 2 (Basic Features) . . . . .
  121. . . ReadBBS PM  Refer.. : None
  122. Online : Help Panel
  123. Subject : Disk and Directory Lister
  124.  
  125.  
  126.    ReadBBS/PM provides generic disk and directory listings in the first 
  127.    two list boxes.  Once a directory is selected, a list of all the files within 
  128.    that directory are displayed in the text pane along with size, flags, and 
  129.    date information.
  130.  
  131.    When a specific file is selected the file contents are displayed in the 
  132.    text pane.  If the file is over 10,000 bytes in size, then only the first 
  133.    10,000 bytes are displayed by default.
  134.  
  135.  
  136. Message : 3 (Basic Features) . . . . .
  137. . . ReadBBS PM  Refer.. : 2
  138. Online : Help Panel
  139. Subject : Conference and Message Lister
  140.  
  141.  
  142.    By default, lists of conference names and message numbers are
  143.    automatically scanned for when a file is selected.  This feature is 
  144.    controlled by an option on the Conferences menu called Auto Read.  
  145.  
  146.    If ReadBBS/PM is being used as a general file manager, then this 
  147.    option can be turned off to improve the overall performance of the 
  148.    product.
  149.  
  150.  
  151. Message : 4 (Basic Features) . . . . .
  152. . . ReadBBS PM  Refer.. : 3
  153. Online : Help Panel
  154. Subject : Conference Contents List
  155.  
  156.  
  157.    When a specific conference is selected, the text pane will display a 
  158.    list of all the messages that are found for that conference.  The default 
  159.    format for the list is to include the message number, date, and subject.  
  160.  
  161.    There is an option to have a long conference contents displayed with 
  162.    the addressing (To/From) information as well.
  163.  
  164.  
  165. Message : 5 (Basic Features) . . . . .
  166. . . ReadBBS PM  Refer.. : 1
  167. Online : Help Panel
  168. Subject : Message processing
  169.  
  170.    Forward/Backward Message processing can be accomplished in a
  171.    variety of methods through the use of the keyboard and/or mouse.
  172.  
  173.    Forward message processing will display the next un-read message
  174.    by default.  So as threads are read they will not be redisplayed.
  175.  
  176.    Backward message processing will always display the previous
  177.    message number regardless of the message skipping option.
  178.  
  179.  
  180. Message : 1 (Advanced Features) . . . . .
  181. . . ReadBBS PM  Refer.. : None
  182. Online : Help Panel
  183. Subject : Integrated editor
  184.  
  185.  
  186.    An integrated text editor is available from the text pane.  This editors' 
  187.    behavior is similar to that of the OS/2 System Editor.  Cut and Paste 
  188.    operations are available as well as options for search and replace.
  189.  
  190.  
  191. Message : 2 (Advanced Features) . . . . .
  192. . . ReadBBS PM  Refer.. : None
  193. Online : Help Panel
  194. Subject : Hyper-Messaging
  195.  
  196.  
  197.    Any message number that is displayed in the header or body of a
  198.    message can be selected and jumped to automatically.  The number
  199.    can be highlighed by either dragging the mouse over the number or
  200.    by double-clicking on the number.  once the number is highlighted
  201.    the Get Message menu item found on the Text pull-down and pop-up
  202.    menus can be used to go directly to that message within the same
  203.    conference.
  204.  
  205.  
  206. Message : 3 (Advanced Features) . . . . .
  207. . . ReadBBS PM  Refer.. : None
  208. Online : Help Panel
  209. Subject : Message/Thread Top and Bottom
  210.  
  211.  
  212.    Push Buttons and Message Menu items are available for reaching the 
  213.    top or bottom message in a particular conference or thread.
  214.  
  215.    The push buttons are indicated with a single '<' or '>'.
  216.  
  217.  
  218. Message : 4 (Advanced Features) . . . . .
  219. . . ReadBBS PM  Refer.. : None
  220. Online : Help Panel
  221. Subject : Zoomed Text
  222.  
  223.  
  224.    An option on the system menu allows a user to maximize the text pane 
  225.    so that it uses the entire window.  The list boxs and Push Buttons are 
  226.    not available in this mode, but there are Message menu items and Hot 
  227.    Keys to navigate through the mail.
  228.  
  229.  
  230. Message : 5 (Advanced Features) . . . . .
  231. . . ReadBBS PM  Refer.. : None
  232. Online : Help Panel
  233. Subject : Saved Messages
  234.  
  235.  
  236.    A file can be created in the selected directory that has messages saved 
  237.    in it.  The name of the file is MESSAGES.SAV and can be accessed as a 
  238.    regular mail file.  This file can be used to archived messages of special 
  239.    interest for later reference.
  240.  
  241.  
  242. Message : 6 (Advanced Features) . . . . .
  243. . . ReadBBS PM  Refer.. : None
  244. Online : Help Panel
  245. Subject : Automatic reply file generation
  246.  
  247.  
  248.    When replying to a message, the reply file created will be pre-formatted 
  249.    with a header line showing information about the original message, the 
  250.    contents of the original message prefixed with the initials of the author, 
  251.    and the authors first name.
  252.  
  253.    A signature file is looked for in the current directory with a name of 
  254.    SIGN-IT.4ME  This file will be appended to each message reply file
  255.    automatically when the initial reply text is created.
  256.  
  257.  
  258. Message : 1 (Installation) . . . . .
  259. . . ReadBBS PM  Refer.. : None
  260. Online : Help Panel
  261. Subject : Installation Overview
  262.  
  263.  
  264.    This version of the READBBS/PM program must be installed on an OS/2 
  265.    workstation and has been tested with version 1.3 and 2.0 177h.  The 
  266.    installation is completed by unzipping the files to a directory, and 
  267.    moving two .DLL files to a directory found in the LIBPATH.
  268.  
  269.  
  270. Message : 2 (Installation) . . . . .
  271. . . ReadBBS PM  Refer.. : 1
  272. Online : Help Panel
  273. Subject : Packing List
  274.  
  275.    Below are the files that should be found in the installation directory 
  276.    after unzipping the package:
  277.  
  278.    READBBS.EXE  ... The executable module for this product
  279.    READBBS.ICO   ... A simple Icon for .EXE
  280.    ON-LINE.DOC    ... This documentation file
  281.    SIGN-IT.4ME      ... A sample signature file for replies
  282.    README.1ST     ... Initial documentation file for ReadBBS/PM
  283.    VPMBAS13.DLL ... Run-time library needed 
  284.    VPMVM13.DLL   ... Run-time library needed 
  285.  
  286.  
  287. Message : 3 (Installation) . . . . .
  288. . . ReadBBS PM  Refer.. : 1
  289. Online : Help Panel
  290. Subject : Installing the .DLLs
  291.  
  292.  
  293.    Once the .ZIP file has been unzipped, there should be a file called
  294.    READBBS.EXE along with this documentation and a sample signiture
  295.    file.  The .DLLs that this program uses are the same ones used by
  296.    Smalltalk/V PM and READBBS/PM expects to be able to find them in
  297.    the LIBPATH.  If the LIBPATH has  ;.;  (a good OS/2 practice) and
  298.    the Invocation is setup as indicated below, then the .DLL files can
  299.    remain in the install directory.
  300.  
  301.  
  302. Message : 4 (Installation) . . . . .
  303. . . ReadBBS PM  Refer.. : 1
  304. Online : Help Panel
  305. Subject : Directory Structure Guidelines
  306.  
  307.  
  308.    It is recommended that a seperate sub-directory be established for 
  309.    each BBS that is accessed.  This release will use the current directory 
  310.    of the mail to save messages and look for a signiture file.  Below is a 
  311.    sample directory tree format:
  312.  
  313.           x:\READBBS            (unzipped files including .DLLs)
  314.              +-- EEP                   (a BBS sub-directory)
  315.              +-- NSC                   (a BBS sub-directory)
  316.  
  317.  
  318. Message : 5 (Installation) . . . . .
  319. . . ReadBBS PM  Refer.. : None
  320. Online : Help Panel
  321. Subject : Setting up the Program
  322.  
  323.  
  324.    Set up a new program with the following properties:
  325.  
  326.          Program Name:       READBBS/PM
  327.          Program Path:         x:\(path installed in)\READBBS.EXE
  328.          Working Directory   x:\(path installed in)
  329.          Type:                       Presentation Manager
  330.  
  331.  
  332. Message : 1 (Usage) . . . . .
  333. . . ReadBBS PM  Refer.. : None
  334. Online : Help Panel
  335. Subject : Usage Overview
  336.  
  337.  
  338.    As this is a PM based application, this section will not discuss
  339.    window manipulation, dialog controls, mouse usage, editing, etc.
  340.    as such functions are fairly standard.  Where differences occur,
  341.    they will be noted.
  342.  
  343.    The Menu Items available from the Menu bar are dynamically made
  344.    enabled based on the state of the application.  For example, the
  345.    Conference and Messages menu items are disabled until a mail file
  346.    is selected.
  347.  
  348.  
  349. Message : 2 (Usage) . . . . .
  350. . . ReadBBS PM  Refer.. : 1
  351. Online : Help Panel
  352. Subject : List Boxes
  353.  
  354.  
  355.    Once the READBBS/PM application has been invoked, all the panes
  356.    except drives will be empty, as the user selects a item from a list, the 
  357.    pane to the right will be populated with data related to the just selected 
  358.    item.  Menus are available to act on items that have been selected.  
  359.  
  360.    These menus are also available as pop-up menus, accessed by 
  361.    pressing the right mouse button (RMB) normally.
  362.  
  363.  
  364. Message : 3 (Usage) . . . . .
  365. . . ReadBBS PM  Refer.. : 1
  366. Online : Help Panel
  367. Subject : File display
  368.  
  369.  
  370.    After a drive and directory have been selected, the large text pane will 
  371.    display a list of all the files in the directory along with information such 
  372.    as size and date.  Selecting a file to be browsed will display 10k bytes 
  373.    of the file in the text pane and if the file is a BBS mail file, the 
  374.    conferences will be displayed in the fourth list pane.
  375.  
  376.  
  377. Message : 3 (Usage) . . . . .
  378. . . ReadBBS PM  Refer.. : 1
  379. Online : Help Panel
  380. Subject : Conferences
  381.  
  382.  
  383.    When a conference is selected, the text pane will display one of two 
  384.    listings of the messages that are found in that conference.   The short 
  385.    listing will display the message number, date, and subject.  
  386.  
  387.    The long listing shows addressing information as well.  In addition, 
  388.    when a conference is selected, the message list pane will be updated 
  389.    to show a list of all the message numbers.
  390.  
  391.  
  392. Message : 4 (Usage) . . . . .
  393. . . ReadBBS PM  Refer.. : 1
  394. Online : Help Panel
  395. Subject : Messages
  396.  
  397.  
  398.    Messages in a conference can be selected an a variety of ways.  One 
  399.    main way is to use the list pane to choose a message with the mouse 
  400.    by number or use the Message push buttons (<M>).  A pair of Hot Keys 
  401.    have been established to move forward (Alt+.) and backward (Alt+,) in 
  402.    the messages.
  403.  
  404.    Another way available is to highlight a message number in the text
  405.    pane and use the Get Message option available via the pop-up menu.
  406.  
  407.  
  408. Message : 5 (Usage) . . . . .
  409. . . ReadBBS PM  Refer.. : 1
  410. Online : Help Panel
  411. Subject : Message Push Buttons and Hot Keys
  412.  
  413.    Push-buttons found in the middle can be used to navigate through the 
  414.    conference.  Below are the push buttons and their meanings:
  415.  
  416.                   < <M  Reply  M> >     
  417.                                                                              Hot Keys
  418.     where:     <  = First message 
  419.                  <M  = Message Backward                      Alt + ,
  420.              Reply  = Reply to current message           Ctrl + R
  421.                  M>  = Message Forward                         Alt + .
  422.                     >  = Last message
  423.  
  424.  
  425. Message : 6 (Usage) . . . . .
  426. . . ReadBBS PM  Refer.. : 1
  427. Online : Help Panel
  428. Subject : Thread Push Buttons and Hot Keys
  429.  
  430.    Push-buttons found in the middle can be used to navigate through
  431.    threads.  Below are the push buttons and their meanings:
  432.  
  433.                < <T  Search T> >
  434.                                                                                Hot Keys
  435.     where:     <  = First message in thread
  436.                   <T  = Thread Backward                         Ctrl + B
  437.            Search  = Complex keyword search
  438.                   T>  = Thread Forward                            Ctrl + T
  439.                     >  = Last message in thread
  440.  
  441.  
  442. Message : 1 (Advanced Usage) . . . . .
  443. . . ReadBBS PM  Refer.. : None
  444. Online : Help Panel
  445. Subject : Zooming Text
  446.  
  447.  
  448.    An option available from the system menu called Zoom Text (Alt+Z)
  449.    can be selected, if desired.  This will expand the text window to
  450.    maximum.  From there all conference and message navigation can be
  451.    handled from the menu bar or Hot Keys.  The Zoomed mode can be
  452.    toggled on and off with Alt+Z.
  453.  
  454.  
  455. Message : 2 (Advanced Usage) . . . . .
  456. . . ReadBBS PM  Refer.. : 1
  457. Online : Help Panel
  458. Subject : Auto Conference Reading
  459.  
  460.  
  461.    The AUTO READ option on the Conferences Menu is set on by default.
  462.  
  463.    If ReadBBS/PM is being used on non-message files, this option can
  464.    set off to improve the performance of the product for actions such as
  465.    file browsing, deleting, and copying.
  466.  
  467.  
  468. Message : 3 (Advanced Usage) . . . . .
  469. . . ReadBBS PM  Refer.. : 1
  470. Online : Help Panel
  471. Subject : Message Skipping
  472.  
  473.  
  474.    The SKIP READ option on the Messages Menu is set on by default.
  475.  
  476.    ReadBBS/PM keeps track of all messages read during the session
  477.    and will automatically skip any messages already read when the
  478.    Next Message menu, Hot Key, or push-button is selected.
  479.  
  480.  
  481. Message : 4 (Advanced Usage) . . . . .
  482. . . ReadBBS PM  Refer.. : 1
  483. Online : Help Panel
  484. Subject : Text Menu Navigation
  485.  
  486.  
  487.    - Get Message ... When viewing a conference list or message, any
  488.      message number can be highlighed (double clicked) and retrieved
  489.      with this option.
  490.  
  491.    - Conference List ... When viewing a message, this option will return
  492.      to the conference list for the selected conference.  This works well 
  493.      with Get Message to randomly view conference.
  494.  
  495.  
  496. Message : 5 (Advanced Usage) . . . . .
  497. . . ReadBBS PM  Refer.. : 1
  498. Online : Help Panel
  499. Subject : Text Pane Save options
  500.  
  501.  
  502.    - Save ... Save the contents of the text window in the selected file.  Save 
  503.      is not available when viewing conference lists or messages.
  504.  
  505.    - Save As ... Save the text contents into a file selected by the user.
  506.  
  507.    - Save Msg ... When viewing a message, the message can be saved
  508.      into an archive file for later reference.  The name of the archive file is 
  509.      MESSAGES.SAV and new messages are appended to the file.
  510.  
  511.  
  512. Message : 6 (Advanced Usage) . . . . .
  513. . . ReadBBS PM  Refer.. : 1
  514. Online : Help Panel
  515. Subject : Subject Search
  516.  
  517.  
  518.    Subject search can be performed by:
  519.  
  520.    1.)  Selecting the conference to obtain a list of all messages
  521.  
  522.    2.)  Performing Edit->Find (Ctrl+F).
  523.  
  524.  
  525. Message : 1 (Known Limitations) . . . . .
  526. . . ReadBBS PM  Refer.. : None
  527. Online : Help Panel
  528. Subject : File extention assignment
  529.  
  530.  
  531.    The assignment of reply file names uses the list of conferences to
  532.    assign the file extent, which may or may not the complete list.
  533.  
  534.    The first line in the reply file does show the message number and the 
  535.    name of the Conference being replied to for verification when uploading.
  536.  
  537.  
  538. Message : 2 (Known Limitations) . . . . .
  539. . . ReadBBS PM  Refer.. : None
  540. Online : Help Panel
  541. Subject : Complex Search button in-active
  542.  
  543.  
  544.    The Search push-button does nothing (yet).  
  545.  
  546.    This button will be used to invoke a prompt for one or more keywords 
  547.    that will be searched for in the entire conference.
  548.  
  549.  
  550. Message : 3 (Known Limitations) . . . . .
  551. . . ReadBBS PM  Refer.. : None
  552. Online : Help Panel
  553. Subject : Word-Wrapping
  554.  
  555.  
  556.    There is no word wrapping or checks for characters in col 72.
  557.  
  558.    The edit menu does contain an option for word wrapping of the display, 
  559.    but it is not suitable for reply files.
  560.  
  561.  
  562. Message : 1 (Known Problems) . . . . .
  563. . . ReadBBS PM  Refer.. : None
  564. Online : Help Panel
  565. Subject : Large Mail files
  566.  
  567.  
  568.    Attempts to read a 4.4 Meg mail file causes a runtime error.
  569.  
  570.    Files up to 1 Meg have been tested and function properly.
  571.  
  572.    Status:  Researching size limitation of Smalltalk
  573.  
  574.  
  575. Message : 2 (Known Problems) . . . . .
  576. . . ReadBBS PM  Refer.. : None
  577. Online : Help Panel
  578. Subject : Endless Loops
  579.  
  580.  
  581.    The program has gone into a loop during certain actions that have not 
  582.    been accounted for (yet).  Pressing Ctrl+Break will produce a run-time 
  583.    error.
  584.  
  585.    Status:  Performing a much regression testing as possible to
  586.                 identify problem area.
  587.  
  588.  
  589. Message : 2 (Known Problems) . . . . .
  590. . . ReadBBS PM  Refer.. : None
  591. Online : Help Panel
  592. Subject : Automatic Reply saving
  593.  
  594.  
  595.    A reply MUST be saved by the user prior to continuing reading.
  596.  
  597.    Status:  Reviewing event notification problem
  598.  
  599.  
  600. Message : 3 (Known Problems) . . . . .
  601. . . ReadBBS PM  Refer.. : None
  602. Online : Help Panel
  603. Subject : System Close
  604.  
  605.  
  606.    The System Close option (Alt+F4) is not working properly and does not 
  607.    close the entire application.  Please use the Exit menu to terminate 
  608.    execution.
  609.  
  610.    Status:  Refered to vendor for resolution
  611.  
  612.