home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / XUE02.ZIP / XUE.ZIP / SYSOP.DOC < prev    next >
Encoding:
Text File  |  1995-09-29  |  39.3 KB  |  1,112 lines

  1.                                                                       
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10. ┌───────────────────────────────────────┐
  11. │                                       │
  12. │   ·                      ∙         ·  │
  13. │    .           .         :     .      │
  14. │                     ·    :            │
  15. │           .              |            │
  16. │                          │            │
  17. │             ··  ─   ── ──┼── ──  ─  ··│
  18. │   .                      │            │
  19. │                          |            │
  20. │                 .        :      .     │
  21. │           ·              ∙            │
  22. │  ·    .                            ·  │
  23. │                     ·                 │
  24. │          ·     .                      │
  25. │                      /\       .    ·  │                                  
  26. │   .                /^  ^\             │             Erebus Development
  27. │           █▄█▄█▄█/^\     ^\      /\   │                Revision 951001
  28. │            ▄ ▄ ▄    ^\     ^\  /^  ^\ │        (c) 1995 David J. Pinch
  29. │           /▄▄ ▄▄             /^       │
  30. │         /^ ▄ ▄ ▄  \        /^         │
  31. │ ^\    /^   ▄▄ ▄▄   ^\    /^     /\    │
  32. │   ^\/^     ▄ ▄ ▄       /^     /^  ^\  │
  33. │     ^\     ▄▄ ▄▄            /^      ^ │
  34. │            ▄ ▄ ▄  \       /^          │
  35. │       /^\  ▄▄ ▄▄   ^\   /^            │
  36. │     /^   ^\  ▄ ▄                      │
  37. │   /^       ^\  ▄   /\          /\     │
  38. │ /^           ^\  /^  ^\      /^  ^\   │
  39. │                 ^      ^\          ^\ │
  40. │           /\                          │
  41. │         /^  ^\       /\               │
  42. │       /^       \   /^  ^\             │
  43. │     /^           /^                   │
  44. │                /^                     │
  45. │                                       │
  46. │                                       │
  47. │                                       │
  48. └───────────────────────────────────────┘
  49.                        
  50.                        
  51.                      ───────────────────────────────────
  52.                       Copyright (c) 1995 David J. Pinch
  53.                      ───────────────────────────────────
  54.  
  55.                    
  56.  
  57.   This document is included with every Erebus product.  It may or may not
  58.   contain information relevant to the software you have downloaded.  At
  59.   this time you should refer to the documentation specific to that software
  60.   before reading this file.
  61.  
  62.   
  63.   Please refer to your MS-DOS manual if you are not familiar with the usage
  64.   of paths, enviroment variables and command-line parameters.  This document
  65.   assumes that you are an experienced MS-DOS user.
  66.   
  67.  
  68.   Chapter                                                   Search Keyword
  69.   ────────────────────────────────────────────────────────────────────────
  70.   
  71.   Hardware and Software Requirements  . . . . . . . . . . . . . . . NEEDED
  72.   
  73.   General Installation Instructions . . . . . . . . . . . . . . .  INSTALL
  74.   
  75.   The Configuration File  . . . . . . . . . . . . . . . . . . . .  INIFILE
  76.   
  77.   Configuration Commands  . . . . . . . . . . . . . . . . . . . . COMMANDS
  78.   
  79.   Command-Line Parameters . . . . . . . . . . . . . . . . . . . . . PARAMS
  80.   
  81.   Sysop Keys  . . . . . . . . . . . . . . . . . . . . . . . . . .  SYSKEYS
  82.   
  83.   Formatting Codes  . . . . . . . . . . . . . . . . . . . . . . . . FCODES
  84.   
  85.   Color Systems . . . . . . . . . . . . . . . . . . . . . . . . . COLORSYS
  86.   
  87.   Descriptive Macros  . . . . . . . . . . . . . . . . . . . . . . . MACROS
  88.   
  89.   The Menu Definition File  . . . . . . . . . . . . . . . . . . . .  MENUS
  90.   
  91.   Errors  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ERRORS
  92.   
  93.   Technical Support . . . . . . . . . . . . . . . . . . . . . . . NEEDHELP
  94.   
  95.   Credits . . . . . . . . . . . . . . . . . . . . . . . . . . . .  CREDITS
  96.   
  97.   Appendix 1: ANSI Escape Sequences . . . . . . . . . . . . . . . . .  AP1
  98.   
  99.   Appendix 2: AVATAR  . . . . . . . . . . . . . . . . . . . . . . . .  AP2
  100.   
  101.   Appendix 3: Character Sets  . . . . . . . . . . . . . . . . . . . .  AP3
  102.                                       
  103.  
  104.  
  105.  
  106.                              ───────────────────
  107.                               LICENSE AGREEMENT
  108.                              ───────────────────
  109.  
  110.  
  111.  
  112.  
  113.    
  114.      ■ The author has taken every precaution to insure that no harm
  115.        or damage will occur to computer systems operating this software.
  116.    
  117.  
  118.      ■ The author shall not be held liable for any damages resulting 
  119.        from the use, misuse, or inability to use the software.
  120.  
  121.  
  122.      ■ No warranties are offered, implied, or expressly stated. 
  123.  
  124.  
  125.      ■ All files, including the software and documentation, are 
  126.        copyrighted products of the author.
  127.  
  128.  
  129.      ■ Altering the contents of the software package is prohibited.
  130.        You may not decompile or disassemble any executable file in the
  131.        package.
  132.  
  133.  
  134.      ■ No fee may be charged for the distribution of this package without
  135.        the written permission of the author.
  136.  
  137.  
  138.      ■ This package is distributed under the Shareware concept. You are
  139.        allowed to use this package for a trial period of thirty (30)
  140.        days. After the trial period, you must register the software
  141.        or discontinue its usage. 
  142.  
  143.  
  144.  
  145.  
  146.      DO NOT USE THIS SOFTWARE IF YOU DO NOT AGREE WITH ALL OF THESE TERMS.
  147.                                    
  148.                                       
  149.                                       
  150.  
  151.  Hardware and Software Requirements                          Keyword: NEEDED
  152.  ───────────────────────────────────────────────────────────────────────────
  153.  
  154.   a. An 8088/80x86 IBM-compatible computer
  155.   
  156.      This software does not use 286- or 386-specific instructions.  It will 
  157.      work on any IBM-compatible computer using an Intel 8088/80x86 CPU.
  158.  
  159.  
  160.   b. Minimum 256K RAM (Conventional Memory)
  161.  
  162.      EMS and XMS memory will be used if available.
  163.  
  164.   
  165.   c. MS-DOS 3.3 or equivilant
  166.   
  167.      The software will automatically detect and release time slices to
  168.      Desqview, Windows/286, Windows/386, Windows NT, and OS/2. 
  169.  
  170.   
  171.   d. A FOSSIL driver [Fido/Opus/Seadog Standard Interface Layer] 
  172.  
  173.      A FOSSIL driver provides a device-independent interface to the
  174.      communications hardware.  You are expected to load a FOSSIL driver
  175.      specific to your hardware or operating system.
  176.  
  177.      For technical information, please refer to: 
  178.  
  179.      Fundamentals of FOSSIL Implementation and Use, v5
  180.      (c) 1987 VEP Software, Naugatuck, CT
  181.      (c) 1988 Rick Moore, Homewood, IL
  182.  
  183.      FREQ     : Request "FOSSIL" (sans quotes) from 1:282/4078
  184.      FTP      : ftp.fidonet.org
  185.      Download : Erebus BBS; 1-612-439-7808; Logon as GUEST (no password).
  186.  
  187.  
  188.   e. SHARE.EXE
  189.  
  190.      A file-sharing driver is required if you are operating under a
  191.      multi-tasking or networked enviroment.  SHARE.EXE manages conflicts 
  192.      when two or more instances of the program try to access the same file.
  193.  
  194.      Type HELP SHARE at your MS-DOS prompt for more information.
  195.  
  196.  
  197.   f. EGA/VGA Video Card (optional)
  198.   
  199.      Several purely aesthetic effects are available if an EGA or VGA
  200.      graphics card is detected.  These special effects include text fading
  201.      and intense backgrounds.
  202.  
  203.  General Installation Instructions                          Keyword: INSTALL
  204.  ───────────────────────────────────────────────────────────────────────────
  205.  
  206.   
  207.   1. Copy the program files to any directory.  For obvious safety reasons,  
  208.      you should not use the root directory or any directory containing
  209.      sensitive or secret files.
  210.  
  211.  
  212.   2. If you are not using a drop file, you will want to browse through
  213.      DOOR.INI and make any neccessary changes.  The sample DOOR.INI is
  214.      heavily documented.  You will need to add the following lines to  
  215.      the file:
  216.  
  217.        
  218.        ComPort = <communications port>
  219.        Locked  = <locked baud rate>
  220.  
  221.   
  222.      Refer to the chapter below for more information on these and other
  223.      settings in the configuration file.
  224.  
  225.  
  226.   3. Use the /I switch if you want to use a configuration file other 
  227.      than DOOR.INI:
  228.  
  229.  
  230.        Example: \DOORS\EREBUS.EXE /IC:\DOORS\ALLDOORS.INI
  231.        Example: \DOORS\EREBUS.EXE /INODE1.INI
  232.  
  233.   
  234.   4. Use the /P switch to point to a drop file (DOOR.SYS or DORINFOx.DEF).
  235.      You may also use the DropFile command in DOOR.INI (see below). 
  236.  
  237.  
  238.        Example: \DOORS\EREBUS.EXE /PC:\RA\DOOR.SYS
  239.        Example: \DOORS\EREBUS.EXE /PD:\BBS\NODE1\DORINFO1.DEF
  240.  
  241.  
  242.      Although using a drop file is optional, using one will ensure the
  243.      most up-to-date information when passing control to the software.
  244.  
  245.   
  246.   5. Test the program.  Please make sure that the program works both    
  247.      locally and remotely before making it available to the public.
  248.  
  249.  
  250.  The Configuration File                                     Keyword: INIFILE
  251.  ───────────────────────────────────────────────────────────────────────────
  252.  
  253.   The format of the configuration file is VARIABLE=VALUE.
  254.  
  255.     ■ Variable names are not case-sensitive.
  256.     ■ Text after a semi-colon is ignored.
  257.     ■ Literal text should be enclosed within quotation marks.
  258.   
  259.  
  260.   Boolean Values:
  261.     
  262.     You may enter a TRUE value as "1", "Yes", or "True".  You may
  263.     enter a FALSE value as "0", "No", or "False".  Abbreviations are
  264.     accepted (Y, N, T, etc).  Blank entries default to TRUE.
  265.  
  266.  
  267.   Character Values:
  268.  
  269.     There are several ways of specifying a character:
  270.  
  271.         a. Normal           VARIABLE = c
  272.         b. Literal          VARIABLE = "c"
  273.         c. Decimal          VARIABLE = #99
  274.  
  275.     The hash mark indicates that you are specifying the ASCII value
  276.     of the character (decimal notation).    
  277.  
  278.   
  279.   FileSpec/FileName Values:
  280.     
  281.     ■ Slashes are automatically appended to directory names.    
  282.     ■ You do not have to specify the extension of an external display
  283.       file (.ASC, .ANS, .AVT).  The most appropriate file will be loaded
  284.       at run-time.
  285.  
  286.   
  287.   String Values:
  288.     
  289.     Enclose the string in quotation marks if you wish to retain its
  290.     capitalization and spacing.  Otherwise, all characters between the
  291.     equal sign and the terminating CR/LF sequence are considered part
  292.     of the string.
  293.  
  294.  
  295.  Configuration Commands                                    Keyword: COMMANDS
  296.  ───────────────────────────────────────────────────────────────────────────
  297.  
  298.     AutoDetect = BOOLEAN
  299.       
  300.       If TRUE, the software will try to detect ANSI or AVATAR on
  301.       the remote system.  This setting has no affect on local sessions.
  302.  
  303.  
  304.     ChatGreeting = STRING
  305.  
  306.       The initial string sent to the remote caller when you press ALT-C
  307.       to break into chat mode.  A carriage-return/line-feed sequence
  308.       is not appended to the string.  
  309.  
  310.  
  311.     ChatHelp = FILESPEC
  312.  
  313.       The file displayed when you type /? in chat-mode.  
  314.  
  315.  
  316.     ChatSysopDigit = COLOR         ChatUserDigit = COLOR
  317.     ChatSysopHiBit = COLOR         ChatUserHiBit = COLOR
  318.     ChatSysopLower = COLOR         ChatUserLower = COLOR
  319.     ChatSysopPunct = COLOR         ChatUserPunct = COLOR
  320.     ChatSysopUpper = COLOR         ChatUserUpper = COLOR
  321.  
  322.       These settings allow you to configure the color of any text written
  323.       in chat-mode.  The default colors are the "Ice" colors used in the
  324.       popular IceChat program by Jeremey Landvoigt.
  325.  
  326.       ...Digit  =  Numbers
  327.       ...HiBit  =  IBM extended ASCII characters
  328.       ...Lower  =  Lower-case letters
  329.       ...Punct  =  Punctuation and misc. characters
  330.       ...Upper  =  Upper-case letters
  331.  
  332.  
  333.     CheckBreak = BOOLEAN
  334.  
  335.       If TRUE, pressing Control-Break will terminate the program.
  336.       Otherwise Control-Break has no effect.
  337.  
  338.  
  339.     CheckSnow = BOOLEAN
  340.  
  341.       Set this value to TRUE if you see any flickering during a screen
  342.       update.  This will force the software to slow down all video output.
  343.       Most computers can safely set this value to FALSE.
  344.  
  345.  
  346.     ClrScr = BOOLEAN
  347.  
  348.       If TRUE, the screen will be cleared during the initialization of
  349.       the door.  Normally your BBS software will clear the screen
  350.       automatically; however, local sessions started from the command-prompt
  351.       may look nicer if this value is FALSE.
  352.  
  353.  
  354.     ComPort = 1, 2, 3 or 4
  355.  
  356.       The communications port.  
  357.  
  358.  
  359.     DBS = BOOLEAN    
  360.     
  361.       Destructive Backspaces.  You must set this value to TRUE if any
  362.       remote terminals erase the character to the left of the cursor
  363.       when the backspace key is received.  Certain features are disabled
  364.       when DBS is TRUE, since the software does not have full control
  365.       of the caller's screen.
  366.  
  367.  
  368.     DirectVideo = BOOLEAN
  369.  
  370.       If TRUE, the software will write directory to video memory when
  371.       updating the screen.  Both monochrome and color monitors are supported.
  372.       If you are using a multi-tasker and notice text "bleeding", try
  373.       changing this value to FALSE.
  374.     
  375.  
  376.     DropFile = <PATH><NAME>
  377.  
  378.       The full path and name of the drop file created by your BBS. 
  379.       Currently DOOR.SYS and DORINFOx.DEF are supported.  
  380.  
  381.  
  382.     Fading = BOOLEAN
  383.  
  384.       If TRUE, certain control codes will invoke a text fade.  This is 
  385.       purely an aesthetic feature and does not affect the remote screen.  
  386.       A VGA video card is required.
  387.  
  388.  
  389.     FadeDelay = NUMBER
  390.  
  391.       The delay factor when fading and restoring the screen during
  392.       text fades.  Faster computers should use a smaller number.  The
  393.       default value is 10.
  394.  
  395.  
  396.     FancyPrompt = BOOLEAN
  397.  
  398.       If TRUE, a fancy prompt will be generated if ANSI.SYS is detected
  399.       when you shell to MS-DOS (either by pressing ALT-J or typing /D
  400.       in chat-mode).  The new prompt requires approx. 80 bytes of
  401.       enviroment space and is not permanent.
  402.  
  403.  
  404.     FlagFalse = CHARACTER
  405.     FlagTrue  = CHARACTER
  406.  
  407.       The two characters used to represent a binary string (i.e. 10100101).
  408.       The default values are "0" and "1". 
  409.  
  410.  
  411.     Locked = BAUDRATE
  412.  
  413.       The computer<->modem locked baud rate, if applicable.  A locked
  414.       baud rate will increase through-put on most systems.
  415.  
  416.  
  417.     MacroFiller = CHARACTER
  418.  
  419.       The default character used to fill-out an expanded macro.  The  
  420.       designer of an external screen may over-ride the default 
  421.       character with the ~M control code.
  422.  
  423.  
  424.     MenuDir = DIRECTORY
  425.  
  426.       The directory containing any menu files (*.MNU).  The default 
  427.       location is the program directory.  
  428.  
  429.  
  430.     Node = NUMBER
  431.  
  432.       The current node number.  This information is required for certain
  433.       inter-program communications.  You may also use the -N command-line
  434.       parameter.  The default node is 1.
  435.  
  436.  
  437.     NoiseBlink = BOOLEAN
  438.  
  439.       If TRUE, all generated line noise will blink.  This, of course,
  440.       is statistically impossible, but it is also quite annoying.
  441.  
  442.  
  443.     NoiseColor = NUMBER
  444.  
  445.       NoiseColor = x means that 1 out of x strings of generated line-noise
  446.       will be a random color.  A value of 0 or 1 means that every string
  447.       will be a different color.  The default value is 30.
  448.  
  449.  
  450.     Overscan = NUMBER
  451.  
  452.       The overscan box is the box surrounding the text window.  This setting  
  453.       allows you to change the color of the box.  VGA required.
  454.  
  455.  
  456.     TextDir = DIRECTORY
  457.  
  458.       The location of any external ASCII, ANSI and AVATAR files.  The
  459.       default directory is the program directory.  You should not specify 
  460.       any directory with secret or sensitive files.
  461.  
  462.  
  463.  Command Line Parameters                                     Keyword: PARAMS
  464.  ───────────────────────────────────────────────────────────────────────────
  465.  
  466.   You may start a parameter with a slash (/) or a dash (-).  Do not place
  467.   a space between the parameter and its value (i.e. /C1 is correct, /C 1
  468.   is incorrect).
  469.  
  470.   /B<baud>        Connection Rate
  471.  
  472.   This information is also passed in the drop file.  
  473.  
  474.  
  475.   /C<port>        Communications Port
  476.  
  477.   The information can also be specified in the configuration file with 
  478.   the COMPORT command.  
  479.                   
  480.   
  481.   /I<filespec>    Configuration File        
  482.   
  483.   This switch allows you to use a configuration file other than DOOR.INI.                
  484.   Normally the program will look for DOOR.INI in the program directory (the
  485.   directory containing the EXE).  However, if you are using a global 
  486.   configuration file, or you are using a different configuration file for
  487.   each node, then you should use this switch.
  488.  
  489.   
  490.   /L              Local Mode
  491.   
  492.   This switch forces local mode.  
  493.  
  494.  
  495.   /N<node>        Node Number
  496.   
  497.   This information is required for multi-line systems.  Otherwise, the
  498.   program defaults to Node 1.
  499.  
  500.  
  501.   /O<locked>      Locked-baud rate
  502.   
  503.   Use this switch if you have locked your comport to a specific speed.
  504.   This may increase the data throughput on some high-speed modems.  Refer
  505.   to your FOSSIL driver for more information.  
  506.  
  507.  
  508.   /P<filespec>    Path to Drop File
  509.   
  510.   You must specify the full path and name of the drop file.  You may use
  511.   either DOOR.SYS or DORINFOx.DEF.  The "x" section of the DORINFO file
  512.   is ignored.
  513.  
  514.                                        
  515.  
  516.  Sysop Keys                                                 Keyword: SYSKEYS
  517.  ───────────────────────────────────────────────────────────────────────────
  518.  
  519.   F1          Toggles the visibility of the status line. 
  520.   
  521.               NOTE: The software will scroll the local screen if you activate 
  522.               the status line while the cursor is on the bottom line of the 
  523.               screen.  This stops the status line from covering any text.  
  524.               The remote caller will not receive a CR/LF sequence.
  525.  
  526.  
  527.   Alt-C       Enters Chat Mode.
  528.  
  529.               The color settings are defined in DOOR.INI.  Words are properly 
  530.               wrapped if you or the caller type beyond the right margin of 
  531.               the screen.  Press ESC to return to the main program.
  532.               
  533.                 /?         Displays a help screen.
  534.  
  535.                 /C         Clears the screen.
  536.                 
  537.                 /D         Drops to MS-DOS.
  538.  
  539.                 /F<file>   Displays the specified file.  The file must
  540.                            exist in the text-files directory.
  541.  
  542.                 /G         Goodbye (terminates the call).
  543.                 
  544.                 /Q         Returns to the main program.
  545.   
  546.               
  547.               The slash ("/") must be the first character on the line.
  548.   
  549.   
  550.   Alt-H       Terminates the call.
  551.   
  552.   
  553.   Alt-J       Drops to MS-DOS.
  554.  
  555.  
  556.   Alt-L       Generates fake line noise.
  557.  
  558.  
  559.  Formatting Codes                                            Keyword: FCODES
  560.  ───────────────────────────────────────────────────────────────────────────
  561.                                                  
  562.   A formatting code begins with a tilde character (~), followed by 
  563.   one or more parameters.  A formatting code affects the output in some way.
  564.   NOTE: Formatting codes are CaSe SeNseTiVe!
  565.  
  566.     ~~         Displays a single tilde character (~).
  567.    
  568.     ~|         Expands into a carriage return/line feed (CR/LF) sequence.
  569.  
  570.     ~#xx       Repeats the last printed character XX times.  XX is in 
  571.                decimal notation and must be two digits.
  572.  
  573.     ~v         Text fade to black (VGA).
  574.  
  575.     ~^         Restore text from fade (VGA).
  576.  
  577.     ~C         Clears the screen.
  578.  
  579.     ~E         Clears to the end of the current line.
  580.  
  581.     ~F<file>|  Displays the specified file.  The filename can be terminated
  582.                with any invalid filename character.  Most BBS packages use
  583.                the pipe character.
  584.  
  585.     ~H         Positions the cursor in the upper-left corner (ANS/AVT).
  586.  
  587.     ~Kc        Stuffs the keyboard with the specified character.
  588.  
  589.     ~Mx        Redefines the macro filler character, where X is the character
  590.                or one of two special values:
  591.  
  592.                    D  Uses the default filler character.
  593.                    S  Uses the space character.
  594.  
  595.     ~P         Pauses                  
  596.    
  597.     ~R         Restores a saved cursor position.
  598.     
  599.     ~S         Saves the current cursor position.
  600.  
  601.                                            
  602.  Color Systems                                             Keyword: COLORSYS
  603.  ───────────────────────────────────────────────────────────────────────────
  604.  
  605.   You may change the text color in a variety of ways.  The software will
  606.   automatically convert any color code or sequence into the format required
  607.   by the caller.  
  608.  
  609.     o  Redundant codes are not processed.
  610.     o  ANSI sequences are optimized for size.
  611.     o  It is possible to use a single text file for all emulations, since
  612.        any color codes in that file are converted and optimized at run-time.
  613.  
  614.   Refer to appendices I and II if you wish to directly use ANSI and AVATAR
  615.   codes in a display string.  Otherwise, we suggest using the HexPipe or
  616.   Control-K systems, both of which use hex notation to specify the color.
  617.  
  618.     HexPipe          A pipe character (|) followed by the hex value of
  619.                      the color.
  620.  
  621.     ^K               A Control-K (ASCII #11), followed by a left bracket,
  622.                      followed by the hex value of the color.
  623.  
  624.   To write a hex color in a string:
  625.  
  626.     a. Type a pipe character (|) or a control-k/left bracket.
  627.  
  628.     b. Use the table below to find the hex value of the background color.
  629.        Per IBM limitations, you can use only colors 0 to 7 as a background
  630.        color.
  631.  
  632.     b. Use the table below to find the hex value of the foreground color.
  633.        You may any of the colors (0 to F).
  634.  
  635.     c. Add 8 to the background color if you want the foreground blink.
  636.        (1+8=9, 7+8=F, etc).
  637.  
  638.   Examples:
  639.  
  640.     1C   Light Red on a Blue Background
  641.     01   Blue on a Black Background
  642.     81   Blinking Blue on a Black Background
  643.     CF   Blinking Bright White on a Red Background
  644.    
  645.   
  646.   Bits    Hex   Dec    Description      Bits    Hex    Dec    Description
  647.   ──────────────────────────────────────────────────────────────────────────
  648.   0000  ·  0  ·  0  ·  Black            1000  ·  8  ·   8  ·  Dark Gray
  649.   0001  ·  1  ·  1  ·  Blue             1001  ·  9  ·   9  ·  Light Blue
  650.   0010  ·  2  ·  2  ·  Green            1010  ·  A  ·  10  ·  Light Green
  651.   0011  ·  3  ·  3  ·  Cyan             1011  ·  B  ·  11  ·  Light Cyan
  652.   0100  ·  4  ·  4  ·  Red              1100  ·  C  ·  12  ·  Light Red
  653.   0101  ·  5  ·  5  ·  Magenta          1101  ·  D  ·  13  ·  Light Magenta
  654.   0110  ·  6  ·  6  ·  Brown            1110  ·  E  ·  14  ·  Yellow
  655.   0111  ·  7  ·  7  ·  Light-Gray       1111  ·  F  ·  15  ·  Bright White
  656.  
  657.  
  658.  Descriptive Macros                                          Keyword: MACROS
  659.  ───────────────────────────────────────────────────────────────────────────
  660.  
  661.   A macro is a keyword that is expanded or converted to a different string.
  662.   A macro is in the format {NAME:SIZE}, where NAME is the name of the 
  663.   macro, and SIZE is the length of the resulting string (optional).  
  664.  
  665.   
  666.   If SIZE is specified, then the result will be clipped or augmented to a 
  667.   length of SIZE characters.  The MacroFiller variable in the configuration 
  668.   file specifies the character to use when filling out the string.  
  669.   The ~M formatting code can be used to redefine the filler character.
  670.  
  671.   If SIZE is positive, the macro is left-justified.  If SIZE is 
  672.   negative, the macro is right-justified.
  673.  
  674.  
  675.  The Menu Definition File                                     Keyword: MENUS
  676.  ───────────────────────────────────────────────────────────────────────────
  677.  
  678.   A menu file is human-readable and can be editted with any ASCII editor.
  679.   The format of a menu file is VARIABLE=VALUE.  The file begins with 
  680.   several commands to define the general behavior of the menu:
  681.   
  682.   ClrScr = BOOLEAN  
  683.   
  684.     Clears the screen before displaying the menu.  The default value is
  685.     FALSE.
  686.   
  687.   
  688.   Columns = NUMBER 
  689.   
  690.     Specifies the number of columns of the internal menu.  The default
  691.     value is 2.
  692.   
  693.   
  694.   Current = NUMBER
  695.  
  696.     The current item shown in the lightbar when the menu is activated.
  697.     The default value is 1 (the first item defined in the menu file).
  698.  
  699.   
  700.   Display = FILESPEC
  701.  
  702.     An external ASCII, ANSI or AVATAR file to display if the External
  703.     variable is TRUE.  The file must exist in the text files directory.
  704.     
  705.   
  706.   Erase = BOOLEAN
  707.  
  708.     If TRUE, the prompt will be erased when the menu terminates.
  709.  
  710.   
  711.   External = BOOLEAN  
  712.   
  713.     If TRUE, the file specified in the Display variable will be shown
  714.     when the menu is activated.
  715.  
  716.   
  717.   Format = STRING  
  718.   
  719.     The format of the internal display.  You may use any color codes and
  720.     formatting codes.  The {Key} macro expands into the hotkey needed
  721.     to activate the item and the {Text} macro expands into the description
  722.     of the item.
  723.  
  724.   
  725.   Internal = BOOLEAN  
  726.   
  727.     If TRUE, the internal display will be shown.  The format of the  
  728.     display is defined in the Format variable.
  729.  
  730.   
  731.   LightBar = BOOLEAN  
  732.   
  733.     If TRUE, a lightbar will be shown next to the menu prompt.  The
  734.     use can browse through the items by pressing Space or Backspace. 
  735.     
  736.   
  737.   Prompt = STRING
  738.  
  739.     The text shown on the bottom of the menu.
  740.   
  741.   
  742.   The next section defines each item in the menu.  The definition begins
  743.   with the keyword "Item", followed by one or more commands:
  744.     
  745.   Bar = STRING  
  746.   
  747.     The text shown in the lightbar if the LIGHTBAR variable is TRUE.
  748.     The {BAR} macro will expand into this string (refer to FORMAT above).
  749.  
  750.  
  751.   Command = STRING
  752.  
  753.     A command string (software specific).
  754.  
  755.  
  756.   Key = CHAR  
  757.   
  758.     The hotkey needed to activate the item.  The {KEY} macro will
  759.     expand into this character (refer to the FORMAT command above).
  760.  
  761.     
  762.   Text = STRING
  763.  
  764.     A description of the item.  This string is used when generating
  765.     the internal display.  The {TEXT} macro expands into this string
  766.     (refer to the FORMAT command above).
  767.  
  768.  
  769.  Errors                                                      Keyword: ERRORS
  770.  ───────────────────────────────────────────────────────────────────────────
  771.  
  772.   You will see a message if the software cannot recover from an error:
  773.  
  774.   ■ Runtime Error <XXX>: <description>
  775.  
  776.  ┌─────────────────────────────────────────────────────────────────────────┐
  777.  │ Please check your setup or contact David Pinch:                         │
  778.  │                                                                         │
  779.  │   P.O. Box 175          10633 N. Stonebridge Tr.        Erebus BBS      │
  780.  │   Stillwater, MN   or   Stillwater Township, MN    or   1 612 439 7808  │
  781.  │   55082-0175            55082                           1:282/4078      │
  782.  └─────────────────────────────────────────────────────────────────────────┘
  783.  
  784.   
  785.   The specific runtime error will be identified.  Please write it down
  786.   for future reference, then check your setup.  Here are the most common
  787.   errors:
  788.  
  789.     2 : File not found               
  790.     3 : Path not found
  791.     5 : File access denied
  792.  
  793.         You are specifying a non-existant configuration file, or a 
  794.         valid DOS file but not a valid configuration file (i.e. LPT3).
  795.  
  796.         The following file names are reserved by MS-DOS:
  797.  
  798.         AUX        Auxiliary Device
  799.         CLOCK$     System Clock
  800.         COM1       Communications Port 1
  801.         COM2       Communications Port 2
  802.         COM3       Communications Port 3
  803.         COM4       Communications Port 4
  804.         CON        Console
  805.         EMMXXXX0   Expanded Memory Manager
  806.         LPT1       Parallel Port 1
  807.         LPT2       Parallel Port 2
  808.         LPT3       Parallel Port 3
  809.         NUL        Nul Output Device
  810.         PRN        Printer
  811.         XMSXXXX0   Extended Memory Manager
  812.  
  813.     
  814.     8 : Insufficient memory
  815.  
  816.         Try using the memory-swapping feature of your BBS software
  817.         before executing the program.
  818.  
  819.  
  820.  Technical Support                                         Keyword: NEEDHELP
  821.  ───────────────────────────────────────────────────────────────────────────
  822.                               
  823.   1. U.S. Mail (Snail Mail)
  824.    
  825.      David Pinch                              David Pinch
  826.      P.O. Box 175                   or        10633 N. Stonebridge Tr.
  827.      Stillwater, MN 55082-0175                Stillwater, MN 55082
  828.  
  829.   
  830.   2. World Support BBS
  831.  
  832.      Erebus BBS 
  833.      1-612-439-7808 ∙ 6:00AM to 3:00AM Central ∙ 2400 to 14.4.
  834.      FidoNet 1:282/4078
  835.  
  836.      Logon as "GUEST" (no password) to download the latest version
  837.      of this software.  FREQ "EREBUS" (sans quotes) for a short (under 1K)
  838.      info packet on the latest software available from Erebus Development.
  839.  
  840.  
  841.   3. Voice
  842.   
  843.      Call 1-612-430-0496, Ext #2, 10:00 AM to 6:00 PM Central Time.
  844.      Due to my operating expenses, I will return voice calls COLLECT.
  845.      Please leave proper instructions.
  846.   
  847.   
  848.   4. Echomail Conferences (FidoNet)
  849.  
  850.        COMM                    
  851.        DOORGAMES
  852.        ON_LINE_GAMES
  853.        RA_UTIL 
  854.        RGS_DOORS (Moderator)
  855.  
  856.      I will dutifully ignore off-topic messages.  Showing disrespect
  857.      to a conference moderator is NOT the way to get my attention.
  858.  
  859.  
  860.  Credits                                                    Keyword: CREDITS
  861.  ───────────────────────────────────────────────────────────────────────────
  862.                 
  863.   DESQview is a registered trademark of Quarterdeck Office Systems.
  864.   
  865.   
  866.   Fido and FidoNet are registered trademarks of Tom Jennings.
  867.  
  868.   
  869.   IBM is a registered trademark of the International Business Machines
  870.   Corporation.
  871.   
  872.   
  873.   IceChat is (c) 1993-1995 by Jeremy Landvoigt.  
  874.   
  875.   
  876.   List is (c) 1983-1993 Vernon D. Buerg
  877.   
  878.   
  879.   Microsoft, MS, and MS-DOS are registered trademarks of Micrsoft Corp.
  880.   
  881.   
  882.   Notepad (c) 1985-1993 Microsoft Corp.
  883.  
  884.   
  885.   OS/2 is a registered trademark of International Business Machines Corp.
  886.   
  887.   
  888.   RemoteAccess is (c) 1989-1994 Wantree Development & Andrew Milner
  889.  
  890.   
  891.   Ripscript & Ripterm are registered trademarks of TeleGrafix Communications.
  892.   
  893.   
  894.   TheDraw is (c) 1986-1993 by TheSoft Programming Services and Ian E. Davis
  895.   
  896.   
  897.   TurboPascal is a registered trademark of Borland International, Inc.
  898.   
  899.   
  900.   Win, Windows, and Windows NT are registered trademarks of Micrsoft Corp.
  901.  
  902.   
  903.   WordStar is a registered trademark of MicroPro International Corporation.
  904.   
  905.    
  906.  Appendix I: ANSI Escape Sequences                              Keyword: AP1
  907.  ───────────────────────────────────────────────────────────────────────────
  908.  
  909.   ESC[xA        Cursor Up            
  910.   ESC[xB        Cursor Down          
  911.   ESC[xC        Cursor Right
  912.   ESC[xD        Cursor Left
  913.  
  914.     These four sequences provide simple cursor positioning.  The one
  915.     parameter specifies the number of columns or rows to change -- it is
  916.     not an absolute coordinate.  The cursor will not move outside of the
  917.     boundries of the video screen.  If you do not use a parameter, it
  918.     defaults to 1.
  919.  
  920.     See: ESC[xf
  921.  
  922.  
  923.   ESC[y;xf        Position Cursor
  924.   ESC[y;xH        Position Cursor (alternate sequence)
  925.  
  926.     Moves the cursor to the specified position, where Y is the vertical
  927.     row and X is the horizontal column.  The upper-left corner of the  
  928.     screen is (0,0).  If you do not specify a position, it defaults to
  929.     (0,0) (home position).
  930.  
  931.     See: ESC[xA, ESC[xB, ESC[xC, ESC[xD
  932.  
  933.   
  934.   ESC[xJ          Clear Screen
  935.  
  936.     If x is 2, the entire video screen is cleared.
  937.  
  938.     See: ESC[K
  939.  
  940.  
  941.   ESC[K           Clear to End of Line
  942.  
  943.     Erases all characters from the cursor position to the right-most
  944.     column of the screen.
  945.  
  946.   
  947.   ESC[x;y;...m    Change Color Attribute
  948.  
  949.        0   00000111   Turns off all attributes; resets the color to 7.
  950.        1   ----1---   Turns on Bold (the IBM-color high-intensity bit).
  951.        5   1-------   Turns on Blinking (the IBM-color blinking bit).
  952.       
  953.       30   -----000   Foreground Black     (IBM Color 0)
  954.       31   -----100   Foreground Red       (IBM Color 4)
  955.       32   -----010   Foreground Green     (IBM Color 2)
  956.       33   -----110   Foreground Yellow    (IBM Color 6)
  957.       34   -----001   Foreground Blue      (IBM Color 1)
  958.       35   -----101   Foreground Magenta   (IBM Color 5)
  959.       36   -----011   Foreground Cyan      (IBM Color 3)
  960.       37   -----111   Foreground White     (IBM Color 7)
  961.       
  962.       40   -000----   Background Black     (IBM Color 0)
  963.       41   -100----   Background Red       (IBM Color 4)
  964.       42   -010----   Background Green     (IBM Color 2)
  965.       43   -110----   Background Yellow    (IBM Color 6)
  966.       44   -001----   Background Blue      (IBM Color 1)
  967.       45   -101----   Background Magenta   (IBM Color 5)
  968.       46   -011----   Background Cyan      (IBM Color 3)
  969.       47   -111----   Background White     (IBM Color 7)
  970.  
  971.   
  972.   ESC[s           Save Cursor Position
  973.   ESC[u           Restore Cursor Position
  974.  
  975.     Saves the current position of the cursor.  You can later restore the 
  976.     cursor position with the ESC[u sequence.
  977.  
  978.  
  979.  Appendix II: Advanced Video Attribute Terminal Assembler and Recreator  AP2
  980.  ───────────────────────────────────────────────────────────────────────────
  981.  
  982.   The following information is based on FSC-0025.TXT (23 Aug 1988).
  983.   AVATAR was developed by Wynn Wagner II and George A. Stansilav.
  984.  
  985.   There are two forms of AVATAR:
  986.  
  987.     Full Session         o  Exchange of caller and system information
  988.                          o  Text windows with scrolling 
  989.                          o  Line-noise elimination
  990.                          o  Cursor positioning
  991.                          o  Color
  992.  
  993.     Basic Session        o  Cursor positioning
  994.                          o  Color
  995.     
  996.  
  997.   Only basic AVATAR commands are supported.  The control caret(^)  
  998.   indicates a control character (i.e. ^V indicates CONTROL-V, or ASCII #22).
  999.  
  1000.     ^L                    Clears the screen.  
  1001.                        
  1002.     ^V^Aa                 Changes to the specified attribute.  Note: The
  1003.                           hi-bit (blinking bit) of the attribute is stripped.
  1004.                           If you want blinking text, you must use the
  1005.                           ^V^B code.
  1006.  
  1007.     ^V^B                  Activates blinking text.
  1008.  
  1009.     ^V^C                  Moves the cursor up.
  1010.     ^V^D                  Moves the cursor down.
  1011.     ^V^E                  Moves the cursor left.
  1012.     ^V^F                  Moves the cursor right.
  1013.  
  1014.     ^V^G                  Clears any text from the cursor to the rightmost
  1015.                           column of the screen.
  1016.  
  1017.     ^V^Hxy                Moves the cursor to the specified position.
  1018.  
  1019.     ^Ycx                  Writes the specifed character X number of times.
  1020.  
  1021.  
  1022.  Appendix III: Character Sets                                   Keyword: AP3
  1023.  ───────────────────────────────────────────────────────────────────────────
  1024.  
  1025.  
  1026.    Dec  Hx  Abr    Dec  Hx  Abr    Dec  Hx  Abr    Dec  Hx  Abr
  1027.    ------------------------------------------------------------
  1028.     00  00  nul     08  08  bs      16  10  dle     24  18  can
  1029.     01  01  soh     09  09  tab     17  11  dc1     25  19  em
  1030.     02  02  stx     10  0A  lf      18  12  dc2     26  1A  eof
  1031.     03  03  etx     11  0B  vt      19  13  dc3     27  1B  esc
  1032.     04  04  eot     12  0C  np      20  14  dc4     28  1C  fs
  1033.     05  05  enq     13  0D  cr      21  15  nak     29  1D  gs
  1034.     06  06  ack     14  0E  so      22  16  syn     30  1E  rs
  1035.     07  07  bel     15  0F  si      23  17  etb     31  1F  us
  1036.  
  1037.  
  1038.    Dec  Hx  C      Dec  Hx  C      Dec  Hx  C      Dec  Hx  Abr
  1039.    ------------------------------------------------------------
  1040.     32  20  sp      56  38  8       80  50  P      104  68  h
  1041.     33  21  !       57  39  9       81  51  Q      105  69  i
  1042.     34  22  "       58  3A  :       82  52  R      106  6A  j
  1043.     35  23  #       59  3B  ;       83  53  S      107  6B  k
  1044.     36  24  $       60  3C  <       84  54  T      108  6C  l
  1045.     37  25  %       61  3D  =       85  55  U      109  6D  m
  1046.     38  26  &       62  3E  >       86  56  V      110  6E  n
  1047.     39  27  '       63  3F  ?       87  57  W      111  6F  o
  1048.     40  28  (       64  40  @       88  58  X      112  70  p
  1049.     41  29  )       65  41  A       89  59  Y      113  71  q
  1050.     42  2A  *       66  42  B       90  5A  Z      114  72  r
  1051.     43  2B  +       67  43  C       91  5B  [      115  73  s
  1052.     44  2C  ,       68  44  D       92  5C  \      116  74  t
  1053.     45  2D  -       69  45  E       93  5D  ]      117  75  u
  1054.     46  2E  .       70  46  F       94  5E  ^      118  76  v
  1055.     47  2F  /       71  47  G       95  5F  _      119  77  w
  1056.     48  30  0       72  48  H       96  60  `      120  78  x
  1057.     49  31  1       73  49  I       97  61  a      121  79  y
  1058.     50  32  2       74  4A  J       98  62  b      122  7A  z
  1059.     51  33  3       75  4B  K       99  63  c      123  7B  {
  1060.     52  34  4       76  4C  L      100  64  d      124  7C  |
  1061.     53  35  5       77  4D  M      101  65  e      125  7D  }
  1062.     54  36  6       78  4E  N      102  66  f      126  7E  ~
  1063.     55  37  7       79  4F  O      103  67  g      127  7F  
  1064.  
  1065.     
  1066.  
  1067.  
  1068.    IBM Extended Characters
  1069.  
  1070.    Non-IBM/DOS terminals may not correctly display the following
  1071.    characters.  You may wish to instruct your users to switch to
  1072.    a font supporting the IBM Extended Character Set.  This is 
  1073.    required in Microsoft Terminal for Windows 3.1x and many other
  1074.    terminals using a graphical enviroment.
  1075.  
  1076.    Dec  Hx  C      Dec  Hx  C      Dec  Hx  C      Dec  Hx  Abr
  1077.    ------------------------------------------------------------
  1078.    128  80  Ç      160  A0  á      192  C0  └      224  E0  α
  1079.    129  81  ü      161  A1  í      193  C1  ┴      225  E1  ß
  1080.    130  82  é      162  A2  ó      194  C2  ┬      226  E2  Γ
  1081.    131  83  â      163  A3  ú      195  C3  ├      227  E3  π
  1082.    132  84  ä      164  A4  ñ      196  C4  ─      228  E4  Σ
  1083.    133  85  à      165  A5  Ñ      197  C5  ┼      229  E5  σ
  1084.    134  86  å      166  A6  ª      198  C6  ╞      230  E6  µ
  1085.    135  87  ç      167  A7  º      199  C7  ╟      231  E7  τ
  1086.    136  88  ê      168  A8  ¿      200  C8  ╚      232  E8  Φ
  1087.    137  89  ë      169  A9  ⌐      201  C9  ╔      233  E9  Θ
  1088.    138  8A  è      170  AA  ¬      202  CA  ╩      234  EA  Ω
  1089.    139  8B  ï      171  AB  ½      203  CB  ╦      235  EB  δ
  1090.    140  8C  î      172  AC  ¼      204  CC  ╠      236  EC  ∞
  1091.    141  8D  ì      173  AD  ¡      205  CD  ═      237  ED  φ
  1092.    142  8E  Ä      174  AE  «      206  CE  ╬      238  EE  ε
  1093.    143  8F  Å      175  AF  »      207  CF  ╧      239  EF  ∩
  1094.    144  90  É      176  B0  ░      208  D0  ╨      240  F0  ≡
  1095.    145  91  æ      177  B1  ▒      209  D1  ╤      241  F1  ±
  1096.    146  92  Æ      178  B2  ▓      210  D2  ╥      242  F2  ≥
  1097.    147  93  ô      179  B3  │      211  D3  ╙      243  F3  ≤
  1098.    148  94  ö      180  B4  ┤      212  D4  ╘      244  F4  ⌠
  1099.    149  95  ò      181  B5  ╡      213  D5  ╒      245  F5  ⌡
  1100.    150  96  û      182  B6  ╢      214  D6  ╓      246  F6  ÷
  1101.    151  97  ù      183  B7  ╖      215  D7  ╫      247  F7  ≈
  1102.    152  98  ÿ      184  B8  ╕      216  D8  ╪      248  F8  °
  1103.    153  99  Ö      185  B9  ╣      217  D9  ┘      249  F9  ∙
  1104.    154  9A  Ü      186  BA  ║      218  DA  ┌      250  FA  ·
  1105.    155  9B  ¢      187  BB  ╗      219  DB  █      251  FB  √
  1106.    156  9C  £      188  BC  ╝      220  DC  ▄      252  FC  ⁿ
  1107.    157  9D  ¥      189  BD  ╜      221  DD  ▌      253  FD  ²
  1108.    158  9E  ₧      190  BE  ╛      222  DE  ▐      254  FE  ■
  1109.    159  9F  ƒ      191  BF  ┐      223  DF  ▀      255  FF
  1110.  
  1111.    
  1112.