home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / TCHT260B.ZIP / TCHAT.DOC < prev    next >
Encoding:
Text File  |  1995-06-25  |  18.1 KB  |  394 lines

  1.  
  2.  
  3.  │░    │
  4.  │▒░   │ TurboCHAT v2.60b
  5.  │▓▒░  │ By Steve Blinch of Mikerosoft Productions
  6.  │█▓▒░ │ Documentation
  7.  │██▓▒▒│
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  ┌─┤█▓▒░ Description ░▒▓█├──────────────────────────────────────────────────┐
  14.  
  15.    TurboCHAT is a windowed SysOp/User chat program. It will read page files
  16.    for both  SuperBBS  and  RemoteAccess, or  play a .MOD  file, or play  a
  17.    song from a CD in your CD-ROM drive.  Wordwrap, color  changing, macros,
  18.    and  paging  hours are  just a  few  of  it's features.
  19.  
  20.  └──────────────────────────────────────────────────────────────────────────┘
  21.  
  22.  ┌─┤█▓▒░ Disclaimer ░▒▓█├───────────────────────────────────────────────────┐
  23.  
  24.         TurboCHAT  comes  with no  warranty  of any  kind, either express
  25.     or implied,  including  but  not limited  to  implied  warranties  of
  26.     merchantability and fitness for a particular purpose, with respect to
  27.     this software and accompanying documentation. In no event shall Steve
  28.     Blinch,   Michael  Helliker,  or  any   other  member  of  Mikerosoft
  29.     Productions be  liable  for  any damages  (including loss of business
  30.     profits,  business  interruption,  loss of business  information,  or
  31.     other pecuniary loss) arising out of the use or inability to use this
  32.     software, even  if  Mikerosoft Productions has been  advised  of  the
  33.     possibility of such damages.
  34.         The execution of TCHAT.EXE or any other executable packaged  with
  35.     TurboCHAT signifies your agreement to the above terms.
  36.         TurboCHAT HAS, however, been tested on the following systems, and
  37.     has had no problems & caused no evident damage to any of them:
  38.  
  39.      a) a '486dx/33 w/SBPro, 1024k VGA card, 14400 & 2400 baud modems
  40.      b) a '386dx/33 w/no sound card, 1024k VGA card, 14400 baud modem
  41.      c) a '386sx/33 w/Adlib, 1024k SVGA card, 2400 baud modem
  42.      d) a '386sx/20 w/SB, Hercules Monochrome card, 14400 baud modem
  43.      e) a '286/12 w/no sound card, 256k VGA card, 14400 & 2400 baud modems
  44.      f) an 8086 XT w/SB, Hercules Monochrome card, 2400 baud modem
  45.  
  46.  └──────────────────────────────────────────────────────────────────────────┘
  47.  
  48.  ┌─┤█▓▒░ Setup ░▒▓█├────────────────────────────────────────────────────────┐
  49.  
  50.    All setup  is done from  TurboCHAT's  setup  program,  TCSETUP.EXE.  All
  51.    options are explained well enough in there (I hope!) that I won't bother
  52.    explaining each one here.
  53.  
  54.  └──────────────────────────────────────────────────────────────────────────┘
  55.  
  56.  ┌─┤█▓▒░ Parameters ░▒▓█├───────────────────────────────────────────────────┐
  57.  
  58.    TurboCHAT's parameters are:
  59.  
  60.      /P????????    If using a multinode  system, the path to the BBS  files
  61.                    for the current node.
  62.  
  63.      /N?           If using a multinode system,  the number of the  current
  64.                    node.
  65.  
  66.      /S<num>       If using a multitasker, a slice will be released   every
  67.                    <num>/100 of a second, defaults to 100 (release a  slice
  68.                    every second) which works pretty good.
  69.  
  70.      /C            Go directly  to chat mode; do  not ask for  page reason,
  71.                    do not play page  tune.  Useful if  you want  to make an
  72.                    "Initiate Chat" hotkey in your BBS program, say, Alt+C.
  73.  
  74.      /L            Ignore  scroll  lock status.  By default, if Scroll Lock
  75.                    is  ON when a  user attempts to page, a  message will be
  76.                    displayed and he will be returned to the BBS.  With this
  77.                    parameter, scroll lock will be ignored.
  78.  
  79.      /H            Ignore paging hours. By default, if a user tries to page
  80.                    outside of paging hours, a message will be displayed and
  81.                    he will be returned to the BBS. With this parameter, the
  82.                    paging hours will be ignored.
  83.  
  84.      /O            Override  any  restrictions  and  page the  SysOp.  This
  85.                    setting will  ignore  the maximum  number of pages,  the
  86.                    scroll  lock  status, and  the  paging hours,  and  page
  87.                    unconditionally.  Be careful with this one or you  might
  88.                    end up with some loser paging you at 3:00 in the morning
  89.                    to tell you that your board looks nice! =)
  90.  
  91.      /LSIMDOS      Load SimDOS automatically, without initiating chat  mode
  92.                    first. [see section below]
  93.  
  94.  └──────────────────────────────────────────────────────────────────────────┘
  95.  
  96.  ┌─┤█▓▒░ In-Chat Keys ░▒▓█├─────────────────────────────────────────────────┐
  97.  
  98.    The following commands are available inside TurboCHAT during chat:
  99.  
  100.     Ctrl+A <0-F>    ■ Change colors
  101.                       (0 = Black, 1 = Blue ... E = Yellow, F = White)
  102.     Ctrl+R          ■ Redraw screen
  103.     Ctrl+W          ■ Clear screen
  104.     Ctrl+Y          ■ Clear line
  105.     Ctrl+X          ■ Switch windows (SysOp <-> User Window, SysOp only)
  106.     Alt+C           ■ Change status bars (SysOp only)
  107.     Alt+G           ■ Beep user (SysOp only)
  108.     Alt+H           ■ Hang up on user (SysOp only)
  109.     Alt+J           ■ Drop to DOS (SysOp only)
  110.     Alt+S           ■ System Menu (SysOp only)
  111.     Alt+W           ■ Clear remote window (SysOp only)
  112.     Alt+E           ■ Invoke user editor (SysOp only, RemoteAccess only)
  113.     Alt+D           ■ Invoke TurboCHAT SimDOS! [see section below]
  114.     F1 to F10       ■ Send the string defined for each of these keys in
  115.                       the control file
  116.  
  117.    The following commands are in the TurboCHAT System Menu:
  118.  
  119.     Module Activity ■ Load a .MOD, change  the output  device, get info  on
  120.                       the currently playing MOD, etc.
  121.  
  122.     Time Check      ■ Enable or disable time checking for the user. If time
  123.                       checking is ON and the user runs out of time, he will
  124.                       be returned to the BBS.
  125.  
  126.     Capture Log     ■ Toggle logging the chat session to a text file.
  127.  
  128.     Chat Info       ■ Some  pretty-much  useless  information  on the  chat
  129.                       session. =)
  130.  
  131.     FunkyChat       ■ Toggles this feature on or off
  132.  
  133.     CD Player       ■ Play/Stop/Eject/Pause/Resume a CD or change songs.
  134.  
  135.     User Terminator ■ :-) Ever have a  user online  who you wish you  could
  136.                       smack upside the head really hard?  Well, here's  the
  137.                       next best thing.. Four anti-bad user options (Hangup,
  138.                       Zero Security & Hangup, Add to TRASHCAN.CTL & Hangup,
  139.                       and Zero, TRASHCAN, & Hangup) to allow you to get rid
  140.                       of your problem users quickly & effectively! :-)
  141.  
  142.  └──────────────────────────────────────────────────────────────────────────┘
  143.  
  144.  ┌─┤█▓▒░ TurboCHAT Custom Chat Screens ░▒▓█├────────────────────────────────┐
  145.  
  146.    Due to several requests for this option, I've finally decided to include
  147.    it!  This  allows you  to make your OWN screens for chat, and stops  you
  148.    from having to use one of TurboCHAT's previous two built-in ones.
  149.  
  150.    To create a screen, all you have to do is create a plain ol' ANSI  file,
  151.    with  the  extension .SCR (for example, MYCHAT.SCR).  Inside this  file,
  152.    do  your  ANSI graphics  (obviously  including two windows, one for  the
  153.    local  chat,  one for the  remote).  NOTE:  This file  *MUST NOT*  be an
  154.    animation (that is, the cursor should never move up  or to the left  and
  155.    overwrite text it has already displayed).
  156.  
  157.    Also note that the Move Cursor, Save Cursor Position, and Restore Cursor
  158.    Position ANSI code  (ESC[xxxxxH, ESC[xA, ESC[xB, ESC[xC,  ESC[xD, ESC[s,
  159.    and ESC[u) MUST NOT be used or TurboCHAT will read the file incorrectly!
  160.  
  161.    If you are using TheDraw, you can ensure that no cursor position changes
  162.    are made by running SETUP.EXE  and setting the  Maximum ANSI Line Length
  163.    to NONE (press U).
  164.  
  165.    For the message editor, you can edit TCEDSCR.DAT  to make a  semi-custom
  166.    screen.  However, you may ONLY display text on the top 4 lines and  line
  167.    number 24, as the  rest of the screen is  required for the editor  text.
  168.    (You *ARE* permitted to use cursor position changes in TCEDSCR.DAT).
  169.  
  170.    The following control codes can be used:
  171.  
  172.      @SYSOPCENTERxx@     Inserts the SysOp's name, and centers it according
  173.                          to "xx".  "xx" is the maximum width of the field
  174.                          you wish to use.  For example, placing:
  175.  
  176.                          -----------[@SYSOPCENTER26@]-----------
  177.  
  178.                          in your file would display:
  179.  
  180.                          -----------[        Your SysOp        ]-----------
  181.  
  182.                          The width between the brackets ([ & ]) is 26,  the
  183.                          number we specified above.
  184.  
  185.  
  186.      @SYSOPLEFTxx@       Inserts the SysOp's  name, and  left-justifies  it
  187.                          according  to "xx".  "xx" is the  maximum width of
  188.                          the field you wish to use.  For example, placing:
  189.  
  190.                          -----------[@SYSOPLEFT26@]-----------
  191.  
  192.                          in your file would display:
  193.  
  194.                          -----------[Your SysOp                ]-----------
  195.  
  196.                          The width between the brackets ([ & ]) is 26, the
  197.                          number we specified above.
  198.  
  199.  
  200.      @SYSOPRIGHTxx@      Inserts the SysOp's name,  and right-justifies  it
  201.                          according to "xx".  "xx" is  the maximum  width of
  202.                          the field you wish to use.  For example, placing:
  203.  
  204.                          -----------[@SYSOPRIGHT26@]-----------
  205.  
  206.                          in your file would display:
  207.  
  208.                          -----------[                Your SysOp]-----------
  209.  
  210.                          The width between the brackets ([ & ]) is 26,  the
  211.                          number we specified above.
  212.  
  213.      @USERCENTERxx@      These three work  exactly  as the  @SYSOP  control
  214.      @USERLEFTxx@        codes do, except  they insert the User's name  in-
  215.      @USERRIGHTxx@       stead of the SysOp's.
  216.  
  217.      @TCVER@             Inserts the version # of TurboCHAT (i.e. 2.60b).
  218.  
  219.      @SUBJCENTERxx@      These three Work exactly as the  @SYSOP and  @USER
  220.      @SUBJLEFTxx@        control codes do, except they insert the page rea-
  221.      @SUBJRIGHTxx@       son instead of a name.
  222.  
  223.      @FC@                This can ONLY be used in TCEDITOR.SCR.  If this is
  224.                          placed at the VERY BEGINNING of the line, the rest
  225.                          of the line will be displayed using FunkyChat.
  226.  
  227.    In the CHAT screens ONLY (not TCEDITOR.SCR), you *MUST* specify the chat
  228.    window dimensions.  This is done by  adding the  following codes to  the
  229.    *.SCR files wherever you want the boundaries to be:
  230.  
  231.       (ASCII 001)       Specify the TOP LEFT corner of the SysOp's window.
  232.       (ASCII 002)       Specify  the  BOTTOM RIGHT  corner of the  SysOp's
  233.                          window.
  234.       (ASCII 003)       Specify the TOP LEFT corner of the user's window.
  235.       (ASCII 004)       Specify  the  BOTTOM RIGHT  corner  of the  user's
  236.                          window.
  237.  
  238.    For example:
  239.  
  240.  ┌─ The top left corner of the SysOp's window.
  241.  │
  242.  │ ┌──────────────────┐
  243.  └>│                 │
  244.    │                  │
  245.    │                 │<── The bottom right corner of the SysOp's window.
  246.    └──────────────────┘
  247.    ┌──────────────────┐
  248.  ┌>│                 │
  249.  │ │                  │
  250.  │ │                 │<── The bottom right corner of the user's window.
  251.  │ └──────────────────┘
  252.  │
  253.  └─ The top left corner of the user's window
  254.  
  255.  
  256.    Also, in  CHAT screens only (not TCEDSCR.DAT),  the  FIRST LINE of  the
  257.    file *MUST* be the following:
  258.  
  259.    UseClearEOL=Yes,InfoX=17,InfoY=23,InfoFore=15,InfoBack=1,CenterInfo=Yes
  260.  
  261.  
  262.     UseClearEOL          When clearing a window, should the  ENTIRE line  be
  263.                          erased?  Clearing is MUCH faster if this option  is
  264.                          turned on.  However, with some  screens, you  might
  265.                          not want the ENTIRE line cleared (i.e. if you  have
  266.                          a box around the window,  portions of the box  will
  267.                          be erased as well as the text!)
  268.  
  269.     InfoX                The "X" coordinate (1-80) where info such as "SysOp
  270.                          has shelled to DOS" should be displayed.
  271.  
  272.     InfoY                The "Y" coordinate (1-23) where info such as "SysOp
  273.                          has shelled to DOS" should be displayed.
  274.  
  275.     InfoFore             The foreground color of the info displayed.
  276.  
  277.     InfoBack             The background color of the info displayed.
  278.  
  279.     CenterInfo           Should  info such as "SysOp has shelled to DOS"  be
  280.                          centered?  The field size is 46 characters.
  281.  
  282.                          Centered:
  283.                          -[          SysOp has shelled to DOS...         ]-
  284.  
  285.                          Uncentered:
  286.                          -[SysOp has shelled to DOS...                   ]-
  287.  
  288.    Not too difficult,  once you get used to  it!  Just play around  with it
  289.    a bit & you should be able to get the hang of it fairly easily... :-)
  290.  
  291.  └──────────────────────────────────────────────────────────────────────────┘
  292.  
  293.  ┌─┤█▓▒░ Non-ANSI Users ░▒▓█├───────────────────────────────────────────────┐
  294.  
  295.    TurboCHAT, like most of the  Mikerosoft Productions, is centered  around
  296.    ANSI graphics.  Users  who do not  support ANSI  graphics  will only  be
  297.    presented with a small line-chat, and the only page tune  available will
  298.    be the RemoteAccess style page, regardless of which page style has  been
  299.    chosen in setup.  If  the RA style  page  file is not  found, a  default
  300.    file will be created.
  301.  
  302.  └──────────────────────────────────────────────────────────────────────────┘
  303.  
  304.  ┌─┤█▓▒░ TurboCHAT Page Override ░▒▓█├──────────────────────────────────────┐
  305.  
  306.    If a user pages outside of paging hours, he will receive a message tell-
  307.    ing him of that problem.  However, if his security level is specified in
  308.    TCSetup's Page Override  menu, he will be asked if he wishes to  attempt
  309.    to override paging hours.  If  he chooses to, he will  be asked  for the
  310.    password (specified  by YOU in TCSetup),  and, if he  gets it right,  he
  311.    will be allowed to page.  If, however,  his security level is NOT  spec-
  312.    ified, he will not be allowed to override.
  313.  
  314.  └──────────────────────────────────────────────────────────────────────────┘
  315.  
  316.  ┌─┤█▓▒░ TurboCHAT Message Editor ░▒▓█├─────────────────────────────────────┐
  317.  
  318.    When a user pages and receives no answer (due to paging with scroll-lock
  319.    on, paging outside of paging hours, or  just not being  answered by  the
  320.    SysOp), TurboCHAT will now ask the user if he/she would like to  leave a
  321.    message to the SysOp.  If he/she  answers YES, TurboCHAT will load  it's
  322.    built-in message editor (which contains all the features of an  indepen-
  323.    dant message editor) and allow the user to enter a message.  The  editor
  324.    currently supports Hudson, Squish, Jam and EzyCom message bases, as they
  325.    are the only message base formats that I am aware of.
  326.  
  327.  └──────────────────────────────────────────────────────────────────────────┘
  328.  
  329.  ┌─┤█▓▒░ TurboCHAT SimDOS ░▒▓█├─────────────────────────────────────────────┐
  330.  
  331.    Tired of putting your users on hold while you drop to DOS to look  for a
  332.    file,  or copy it into a download directory, or another simple DOS task?
  333.    Well, take the user WITH you next time you shell!  SimDOS simulates most
  334.    of the internal  DOS features  included in  COMMAND.COM, and allows  the
  335.    user to drop to DOS *WITH*  you, so he  can see what  you're doing,  and
  336.    enter commands from his side too.  The  only drawback  to SimDOS is that
  337.    you cannot actually run executable software -- any attempt to do so will
  338.    result in an error message.  However, the features that it includes are:
  339.  
  340.     CD     - Changes directory
  341.     CHKDSK - Simulates CHKDSK.EXE
  342.     CLS    - Clears the screen
  343.     COPY   - Copies one or more files
  344.     DEL    - Deletes one or more files
  345.     DIR    - Displays a list of files and/or directories
  346.     EXIT   - Returns to normal chat mode
  347.     MD     - Makes a directory
  348.     MEM    - Simulates MEM.EXE
  349.     MOVE   - Moves one or more files
  350.     RD     - Removes a directory
  351.     REN    - Renames a file
  352.     TYPE   - Types a text file
  353.     VER    - Displays TurboCHAT version
  354.     <d>:   - Changes drive, where <d> is the drive letter
  355.  
  356.    * NOTE:  SimDOS can ONLY be invoked by the  SysOp, who must press  Alt+D
  357.             to fire  it up.  The  user has no  access to  SimDOS whatsoever
  358.             until the SysOp invokes it in this fashion.
  359.  
  360.    * Loading SimDOS upon Startup
  361.  
  362.      If you  wish to have  TurboCHAT startup in  SimDOS mode  automatically
  363.      (you  might want  to have a  seperate menu option  to do this in  your
  364.      SysOp menu, to  allow a remote  user to do file  maintenance, etc.  on
  365.      your computer when you're not around), use the /LSIMDOS parameter when
  366.      you invoke TurboCHAT.
  367.  
  368.      WARNING: The /LSIMDOS parameter will load SimDOS immediately, and will
  369.               give the person online FULL ACCESS to the DOS commands.  Make
  370.               SURE that only trustworthy users have access to this or some-
  371.               one might go on a deleting spree and erase your hard drive!
  372.  
  373.  └──────────────────────────────────────────────────────────────────────────┘
  374.  
  375.  ┌─┤█▓▒░ Registration ░▒▓█├─────────────────────────────────────────────────┐
  376.  
  377.    This program is freeware.  No fee will be charged for the use of it, and
  378.    no enhancer key applies to it.  If you  really like  this  program,  try
  379.    registering one of our other doors, or donating to Mikerosoft BBS.
  380.  
  381.  └──────────────────────────────────────────────────────────────────────────┘
  382.  
  383.  ┌─┤█▓▒░ Program Information ░▒▓█├──────────────────────────────────────────┐
  384.  
  385.    TurboCHAT was started in Turbo Pascal v6.0 and finished in  Turbo Pascal
  386.    v7.0.  The  first  public  copy was  released  on May 25, 1994,  through
  387.    Mikerosoft BBS.
  388.  
  389.    Need help, want to make a comment, or want to get the latest versions of
  390.    our software?  See DISTRIB.TXT for info!
  391.  
  392.  └──────────────────────────────────────────────────────────────────────────┘
  393.  
  394.