home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpm / rcpm / chat46.lbr / CHAT.HQP / CHAT.HLP
Text File  |  1986-07-14  |  10KB  |  259 lines
  1.  
  2.                  CHAT HELP
  3.  
  4.        CHAT is an RCP/M utility which allows a remote user to "chat"
  5.               with the local system operator.
  6.  
  7.  
  8.       NOTE: Current and past revisions are found in the CHAT.HIS file.
  9.         General information is found in the CHAT.INF file.
  10.  
  11.         - - - - - - - - - - - - - - - - - - - - - -
  12.  
  13. * General Background *
  14.  
  15.      This program may be used with RCP/M systems to allow the sysop to    be
  16.   summoned by and  to carry on a keyboard conversation with a remote user.
  17.  
  18.      When  in  the chat mode,  lines are automatically limited    to  MXLINE
  19.   (defaults  to  79) characters and a CR/LF (carriage return,  line  feed)
  20.   inserted  at    the  first  space entered  after  WRAP    (defaults  to  74)
  21.   characters.
  22.  
  23.      If operating with a clock and limiting a user's time-on,  the  TIMEON
  24.   equate  will    prevent BYE3/5/NUBYE/MBYE  from rudely    interrupting  your
  25.   chat session with an abrupt disconnect.
  26.  
  27.      New  feature  for MBBS systems (as of v45) - when users try CHAT  and
  28.   the  sysop is unavailable,  they will be asked if they wish to  leave  a
  29.   COMMENT.   If  so,  MBBS   will be loaded for a comment,  then they  are
  30.   returned to CP/M upon completion of their message entry.   This  feature
  31.   for use with MBYE or current versions of NUBYE.
  32.  
  33.      Also,  tied  in  with the new COMMENT support,  the sysop can  hit  a
  34.   special character (available local only, under certain BYE versions) and
  35.   drop    the user into the special comment entry routine "instantly."   The
  36.   character is currently set to a left brace ("{"), since this is filtered
  37.   out  in  BYE5/NUBYE --  if  you decide  to change  the  character,  pick
  38.   something which a user (or you) might not inadvertantly hit.    By using a
  39.   filtered  character,    no  extra  code is required to keep  it  available
  40.   locally.  Another character to consider is reverse accent ("`").
  41.  
  42.         - - - - - - - - - - - - - - - - - - - - - -
  43.  
  44.   * Detailed Set-up Help *
  45.  
  46.      This section will help you through most of the equates available  for
  47.   customization  for  your individual system  requirements.   All  equates
  48.   within CHATxx.ASM are pre-configured to the defaults shown below.
  49.  
  50. ----
  51. (1)
  52.    This one is set according to your computer's clock.
  53.  
  54. CLOCK    EQU    4        ; Set to your CPU clock speed in MHz
  55.  
  56. ----
  57. (2)
  58.      This  equate  lets you choose how many seconds CHAT will continue    to
  59.   page for sysop before aborting.   If you haven't answered by this  time,
  60.   the  user  will  be informed that you are not  available.   If  you  are
  61.   running  MBBS and have set COMMENT to YES,  the user would also be given
  62.   the option of leaving you a private message.
  63.      This number also determines the length of the special TGUIDE bar.    As
  64.   set, the bar will display above the periods as:
  65.  
  66.     |------------------------------|    <--- 30 dashes
  67. Paging:  ..........  etc
  68.  
  69.      One dash for each period printed, along with a "beep".
  70.  
  71. PGTIME    EQU    30        ; Number of seconds to "BEEP" before abort
  72.  
  73.      Set  TGUIDE to YES if you wish to display a special guide    bar  which
  74.   provides a visual  idea of how  long the page will last. This guide sets
  75.   itself according to PGTIME (see example above).
  76.  
  77. TGUIDE    EQU    YES        ; Yes, print a guide bar for estimated time
  78.                 ;     of summoning sysop prior to abort.
  79.  
  80. ----
  81. (3)
  82.      This will be the key sequence you hit to answer a page and jump  into
  83.   the chat mode.  If you prefer another key combination, change it here.
  84.  
  85. IMHERE    EQU    ESC        ; Hit this key to answer page and chat
  86.  
  87. ----
  88. (4)
  89.      This  is  a "quick" chat entry code,  (used as:   "A>CHAT    C")  which
  90.   allows you to enter CHAT in the chat mode immediately from a CP/M prompt
  91.   -- it  is  dependent on the console bell flag being on (if used)  and/or
  92.   not being a restricted chat time (if RESCHAT is set YES).  If GETCALR is
  93.   YES,    the  user's  name  will also be  displayed  (i.e.  "Hold  on  John
  94.   Turbin -").
  95.  
  96. QUICK    EQU    'C'        ; Quick chat character (i.e. CHAT C will
  97.                 ; bypass the paging routine).
  98.  
  99. ----
  100. (5)
  101.      Set   MXLINE   to    your  terminal's  maximum  number  of    characters
  102.   displayable per line,  normally 80 (NOTE:  This means 0 to 79,  NOT 1 to
  103.   80).
  104.  
  105. MXLINE    EQU    79        ; Maximum line length (normally 0 to 79)
  106.  
  107.      Set WRAP to the point at which you wish CHAT to perform an  automatic
  108.   CR/LF (carriage return, line feed) during keyboard entry.
  109.  
  110. WRAP    EQU    74        ; Location to perform wrap
  111.  
  112. ----
  113. (6)
  114.      One  of  the next 10 equates should be set according to  the  message
  115.   base you currently operate.
  116.  
  117. NONE    EQU    YES        ; Yes if none of the below systems are used
  118. ;
  119. CBBS    EQU    NO        ; Yes if CBBS system
  120. DATA    EQU    NO        ; Yes if DataTech system
  121. MBBS    EQU    NO        ; Yes if MBBS system
  122. METAL    EQU    NO        ; Yes if METAL system
  123. MINCBBS EQU    NO        ; Yes if MINICBBS system
  124. OXGATE    EQU    NO        ; Yes if OxGate system
  125. RBBS    EQU    NO        ; Yes if RBBS system
  126. SIGNON    EQU    NO        ; Yes if Signon
  127. SIMMS    EQU    NO        ; Yes if SiMMS sytem
  128.  
  129. ----
  130. (7)
  131.      The  ASKNAM equate is set YES if you have no LASTCALR file,  in which
  132.   case    the user will be requested for entry of a name.   This helps  when
  133.   you answer a page and can see the user's name on your crt.
  134.  
  135. ASKNAM    EQU    YES        ; Yes if ask user's name before paging
  136.  
  137. ----
  138. (8)
  139.      Set  GETCALR  to YES if you have a LASTCALR file available  and  CHAT
  140.   will get the callers name automatically (set ASKNAM to NO in this case).
  141.  
  142. GETCALR EQU    NO        ; Yes to get name from LASTCALR.DAT
  143. LCNAME    EQU    0        ; Column # where the caller's name starts
  144.                 ;   in LASTCALR file.  Normally set to 0,
  145.                 ;   but MBBS starts at column 11.
  146. ;
  147.  
  148.      These  equates go along with GETCALR and enable CHAT to  locate  your
  149.   LASTCALR file (defaults to Drive A, User 14).
  150. ;
  151. LASTDRV EQU    'A'        ; Drive of LASTCALR file
  152. LASTUSR EQU    14        ; User area of LASTCALR
  153. ;
  154.  
  155. ----
  156. (9)
  157.      Set  BYBELL to YES if you are using BYE's internal console bell  flag
  158.   location.   Set  LMBELL  to YES if your system uses the low memory  byte
  159.   location for console bell flag toggling (as with MBBS).   CHAT  responds
  160.   to  a user attempting to page the sysop according to the console bell is
  161.   on or off.   If on,  the user is told you are being paged - if off,  the
  162.   user    is  told you are not available (also  affected    by  RESCHAT,  when
  163.   used).
  164.      If LMBELL is set YES,  the normal byte used is 3BH, but KILBEL may be
  165.   changed to suit your system.
  166.      In any case,  set either (not both) BYBELL or LMBELL to YES,  or both
  167.   to NO.
  168.      If BYEBDOS is NO and BYBELL is YES,  BELOFF must be set to the number
  169.   of bytes between the JMP COLDBOOT and the BELLON flag in your version of
  170.   BYE.
  171.  
  172. BYBELL    EQU    NO        ; Yes, using BYE's internal console bell flag
  173. LMBELL    EQU    NO        ; Yes, low memory bell flag (KILBEL)
  174. KILBEL    EQU    3BH        ; Low memory byte used (when LMBELL is YES)
  175.                 ;   for console bell flag (0=ON, 0FFH=OFF)
  176. BELOFF    EQU    20        ; Number of bytes from COLDBOOT: to BELLON
  177.                 ; flag (BYE5 uses 20, NUBYE uses 27) if BYBELL
  178.                 ; is YES and BYEBDOS is NO
  179. ;
  180.  
  181. ----
  182. (10)
  183.      If  running MBBS along with MBYE and current versions  of NUBYE,  you
  184.   may set COMMENT to YES.  This will give the user an option to leave  you
  185.   a private comment whenever CHAT makes it known that you are not
  186.   available.  Return to CP/M is automatic and quick, once the user has
  187.   completed the message.
  188.  
  189. COMMENT EQU    NO        ; Yes, allow leaving comment when the
  190.                 ;     sysop isn't available (MBBS only)
  191.  
  192. ----
  193. (11)
  194.      Set  BYEBDOS to  YES  if your running a  current  BYE  version  which
  195.   uses the extended BDOS call 32 (read your BYE documentation to determine
  196.   whether  or  not this is available) and  81 (if TIMEON is set YES).  #32
  197.   enables CHAT to determine if BYE is resident -- if not, CHAT aborts.
  198.  
  199. BYEBDOS EQU    NO        ; Yes, using extended BDOS calls  (BYE5/NUBYE)
  200.  
  201.      Set  TIMEON to YES if using  a  clock for limiting  a user's  maximum
  202.   time-on  system.   This will temporarily disable  BYE's updating of  the
  203.   user's  time-on,  so your chat session is not rudely    interrupted  by  a
  204.   disconnect from BYE.    This will work with either BYEBDOS or B3RTC set to
  205.   YES.
  206.  
  207. TIMEON    EQU    NO        ; Yes, limiting time on system (all BYEs)
  208.  
  209.      Set B3RTC YES if you are using a BYE version like MBYE which does not
  210.   support the extended BDOS calls.  B3COFF and B3MXO should be set for all
  211.   BYE3/MBYE versions which have a real time clock buffer (RTCBUF).
  212.  
  213. B3RTC    EQU    NO        ; If YES, your clock is setup in BYE3 (or MBYE)
  214. B3COFF    EQU    25        ; OFFSET from COLDBOOT: to RTCBUF address
  215. B3MXO    EQU    24        ; OFFSET from COLDBOOT: to MXML address
  216. ;
  217. ----
  218. (12)
  219.      Set  RESCHAT  to  YES,  if your system has a clock and  you  wish    to
  220.   restrict the hours which users may page you.     If you set BELTOG to YES,
  221.   this will inform them you are unavailable, when the console bell flag is
  222.   off,    even  if this is during your "available" hours.   During the hours
  223.   CHAT is off, the user is shown the time period which CHAT may be used to
  224.   page you.
  225.  
  226. RESCHAT EQU    NO        ; Yes, restrict sysop paging to pre-
  227.                 ;     determined hours
  228.  
  229.  
  230.      These equates belong with RESCHAT - military time is displayed.   Set
  231.   these  according to your "not available" hours when RESCHAT is set  YES.
  232.   Example: 12 noon is 12, 1 pm is 13, 12 midnight is 0.
  233.  
  234. ;
  235. CHATON    EQU    16        ; Start of CHAT period
  236. CHATOFF EQU    21        ; End of CHAT period
  237.  
  238.      The next 2 equates also belong with RESCHAT and are the memory  bytes
  239.   (locations)  used by your program to store the current hour and  minute.
  240.   These  bytes    are  only used if you're not utilizing the  extended  BDOS
  241.   calls of BYE.  If EXBDOS is set YES, you may ignore these settings.
  242.  
  243. HOUR    EQU    50H        ; Location of hour
  244. MIN    EQU    51H        ; Location of minute
  245.  
  246.  
  247.         - - - - - - - - - - - - - - - - - - - - - -
  248.  
  249.  
  250. * CLOSING REMARKS *
  251.  
  252.   I  hope this guide will be of benefit to those of you just starting  out
  253.   in the RCP/M world.    While CHAT is a simple program to install and many
  254.   "old    timers" would look down on detail (such as it is),  I doubt  there
  255.   will come a time when help guides will become obsolete.
  256.  
  257.                     - Tom Brady
  258.                       Decibel RCP/M - MBBS
  259.