home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / TCE11L.ZIP / TCESYSOP.DOC < prev    next >
Text File  |  1995-01-04  |  19KB  |  404 lines
  1.     TCEDIT - T.A.G. Configurable Editor version 1.1 beta version (l)
  2.      (Copyright (c) 1994-1995 by SmartSoft.  All rights reserved.)
  3.  
  4.  
  5.  
  6. TABLE OF CONTENTS
  7.  
  8.   Table of Contents..............................................   1
  9.   
  10.   Legal Information..............................................   2
  11.     Disclaimer...................................................   2
  12.     Distribution.................................................   2
  13.  
  14.   Introduction...................................................   2
  15.     Purpose......................................................   2
  16.     Minimum Requirements.........................................   2
  17.     Thanks and kudos.............................................   3
  18.     Obtaining the latest version.................................   3
  19.     Support......................................................   3
  20.     
  21.   Quick Setup....................................................   3
  22.      Single node.................................................   3
  23.      Multi-node..................................................   4
  24.  
  25.   Command-line Parameters........................................   5
  26.      -TAG........................................................   5
  27.      -M<Color Mode #>............................................   5
  28.      -A<import/export SL>........................................   5
  29.      -U<path>....................................................   6
  30.      -I..........................................................   6
  31.      -D..........................................................   6
  32.      Parameters passed by T.A.G..................................   6
  33.      Example.....................................................   6
  34.  
  35.   TCOPTS.........................................................   7
  36.      [T]aglines: Set Path and Name of Taglines File..............   7
  37.      [Q]uoting: Set Default for Editor Quoting...................   7
  38.      [A]utosave: Set Autosave Default............................   7
  39.      [D]ebug: Toggle Editor Debugging............................   7
  40.      [S]how Current Settings.....................................   7
  41.      [X] Exit....................................................   7
  42.  
  43.   Miscellany.....................................................   8
  44.      Taglines....................................................   8
  45.      Using TCEDIT in a multi-node environment....................   8
  46.  
  47. TCEDIT                                                              Page 2
  48. 1.1 beta (l)                                                        1/4/95
  49. __________________________________________________________________________
  50.  
  51. LEGAL INFORMATION
  52.  
  53. TCEDIT is Freeware.  There is no charge for its use and it is distributed
  54. as a fully functional program.
  55.  
  56. This program is Copyright (c) 1994-1995 by SmartSoft. All rights reserved.
  57.  
  58. The T.A.G. Bulletin Board System (T.A.G.) is Copyright (c) 1986-1994 by 
  59. The T.A.G. Team.
  60.  
  61.   DISCLAIMER
  62.  
  63.        TCEDIT is distributed as is.  TCEDIT is guaranteed to take up room
  64.        on your hard drive only.  The author of TCEDIT makes no guarantees
  65.        as to the usefulness of this program, nor can the author be held
  66.        liable for damage to your system.  Use at your own risk.
  67.  
  68.   DISTRIBUTION
  69.  
  70.     BBS SysOps:  You may freely distribute this archive so long as no fees
  71.     are charged, over and above any normal system access fees, and do not
  72.     add or remove files from the original archive.
  73.  
  74.     Shareware Distributors:  Please contact the author for distribution
  75.     license information.  (This includes the bundling of TCEDIT in a
  76.     software package.)
  77.  
  78.  
  79. INTRODUCTION
  80.  
  81.   PURPOSE
  82.  
  83.     TCEDIT can be used as a standalone text editor or as a Full-Screen
  84.     Editor for the T.A.G. Bulletin Board System.  Currently, no other BBS
  85.     software packages are supported.  TCEDIT has been tested with T.A.G.
  86.     versions 2.6 and up.
  87.  
  88.     This document covers the use of TCEDIT as a T.A.G. Full-Screen Editor.
  89.     For details on the use of TCEDIT as a standalone editor, please refer
  90.     to the document TCEUSER.DOC, also contained in this archive.
  91.  
  92.     ** NOTE ** NOTE ** NOTE ** NOTE ** NOTE ** NOTE ** NOTE ** NOTE **
  93.     This is a BETA test.  Please help us provide the very best product to
  94.     the T.A.G. BBS community.  Report bugs and other programming errors to
  95.     the FidoNet address below.
  96.  
  97.   MINIMUM REQUIREMENTS
  98.  
  99.     ANSI.SYS or a compatible ANSI driver must be loaded.
  100.  
  101.     A comport FOSSIL driver must be present if the editor is used in T.A.G.
  102.     mode.  (This is not required for standalone operation.  TCEDIT has been
  103.     tested with X00 and BNU FOSSIL drivers.)
  104.  
  105.  
  106. TCEDIT                                                              Page 3
  107. 1.1 beta (l)                                                        1/4/95
  108. __________________________________________________________________________
  109.  
  110.   THANKS AND KUDOS
  111.  
  112.     Many thanks to Vickie Church, the SysOp of Vickie's Palace
  113.     (1:2330/200) and Hal Craig, the SysOp of Thirst BBS (1:374/65), as
  114.     well as the users of both systems for their help in beta testing
  115.     TCEDIT.
  116.  
  117.     Thanks also go out to Rob Carlson for maintaining the TCEDIT FAQ.
  118.  
  119.     And of course, many thanks to the users of The MindScape BBS
  120.     (1:2605/631) who endured more than one buggy beta test of TCEDIT.
  121.  
  122.   OBTAINING THE LATEST VERSION
  123.  
  124.     To receive the latest version of TCEDIT, you may FREQ "TCEDIT" from
  125.     FidoNet 1:2605/631. (Points welcome!)  You may also call MindScape BBS
  126.     directly at (908)668-7377, where there is a GUEST account available
  127.     for downloading TCEDIT.
  128.  
  129.     The MindScape BBS, 1:2605/631, is the only official "home" of
  130.     TCEDIT.  Accept no substitutes.
  131.  
  132.   SUPPORT
  133.  
  134.     For bug reports and correspondence, please send FidoNet NetMail to
  135.     SmartSoft at 1:2605/631.  There is also a support echo for TCEDIT
  136.     available.  If you are interested in carrying this echo, please contact
  137.     the System Operator at 1:2605/631 for information.  The TCEDIT design
  138.     team is also active in the TAG FidoNet echo.
  139.  
  140. QUICK SETUP
  141.  
  142.   Single Node
  143.  
  144.   1. Copy the files TCEDIT.EXE and TCOPTS.EXE to your main BBS directory.
  145.  
  146.   2. Edit (or create) the file EXTEDIT.BAT in your main BBS directory.  The
  147.      file should contain the following command:
  148.  
  149.      TCEDIT -TAG -A255 -U<path> %1 %2 %3 %4 %5 %6 %7
  150.  
  151.      (Where <path> is the path to your USER.LST file.  If your USER.LST
  152.      file is in a directory directly below the main BBS directory, just use
  153.      the name of the directory, e.g. "-UGFILES" (without the quotes).
  154.      Otherwise, use the full path information, e.g. "-UC:\TAG\MULTI"
  155.      (without the quotes).  Note:  Do NOT use a trailing backslash.  An
  156.      explanation of these command-line switches is provided later in this
  157.      document.)
  158.  
  159.   3. Run TCOPTS and set your default parameters.  For a description of each
  160.      function, refer to the TCOPTS section later in this document.
  161.      TCEDIT.CFG will be created in your main BBS directory.
  162.  
  163.   4. If you have not already done so, give your users access to use the
  164.      Full Screen Editor.  See the T.A.G. BBS documentation for details.
  165.  
  166. TCEDIT                                                              Page 4
  167. 1.1 beta (l)                                                        1/4/95
  168. __________________________________________________________________________
  169.  
  170. QUICK SETUP
  171.  
  172.   Multi-node
  173.  
  174.   1. Copy the files TCEDIT.EXE and TCOPTS.EXE to their own directory.
  175.      (e.g., C:\TCEDIT)
  176.  
  177.   2. Edit (or create) the file EXTEDIT.BAT in each of your BBS node
  178.      directories.  The batch file in each directory should be similar to
  179.      the following:
  180.  
  181.      CD \TAG\NODE1
  182.      C:\TCEDIT\TCEDIT -TAG -A255 -U<path> %1 %2 %3 %4 %5 %6 %7
  183.  
  184.      (Where \TAG\NODE1 is the location of the STATUS.DAT for that node
  185.      and <path> is the path to your USER.LST file.  Use the full path
  186.      information, e.g. "-UC:\TAG\MULTI" (without the quotes).  Note:  Do
  187.      NOT use a trailing backslash.  An explanation of these command-line
  188.      switches is provided later in this document.)
  189.  
  190.   3. Run TCOPTS and set your default parameters.  For a description of each
  191.      function, refer to the TCOPTS section later in this document.
  192.      TCEDIT.CFG will be created in your TCEDIT directory.
  193.  
  194.   4. If you have not already done so, give your users access to use the
  195.      Full Screen Editor.  See the T.A.G. BBS documentation for details.
  196.  
  197. TCEDIT                                                              Page 5
  198. 1.1 beta (l)                                                        1/4/95
  199. __________________________________________________________________________
  200.  
  201. COMMAND-LINE PARAMETERS:
  202.  
  203.   To use TCEDIT with T.A.G., the batch file command that calls the program 
  204.   should be:
  205.  
  206.   [C:\DIR\]TCEDIT -TAG [-A###] [-M#] -Upath [-I] [-D] %1 %2 %3 %4 %5 %6 %7
  207.  
  208.   C:\DIR is the path to TCEDIT.EXE and TCEDIT.CFG.  This is optional if
  209.   those files reside in the same directory as EXTEDIT.BAT and STATUS.DAT.
  210.   (This will most likely be true only for single node systems.)
  211.   Multi-node systems, or single node systems where the SysOp wishes to
  212.   have TCEDIT reside in it's own directory, should include the full path
  213.   to TCEDIT and its support files when called by EXTEDIT.BAT.
  214.  
  215.   IMPORTANT:  Do NOT change to the TCEDIT directory in EXTEDIT.BAT to run
  216.   the editor.  TCEDIT looks for certain message files created by T.A.G. in
  217.   the directory it is called from.  If you run TCEDIT from a directory
  218.   other than the one that contains the current node's STATUS.DAT file you
  219.   will have, at best, unpredictable results.
  220.  
  221.   All six command-line switches can be upper or lower case (or any
  222.   combination), and can use either a '-' or '/' to mark the switch
  223.   (i.e., -TAG and /TAG are equivalent).  These switches can be placed in
  224.   any order, but the variables that capture information from T.A.G.
  225.   (i.e., %1, %2, and so on) should be the last thing on the command-line
  226.   and in the order shown.
  227.  
  228.   -TAG    [required] This tells TCEDIT that it is being called from the
  229.           T.A.G. BBS system and configures it accordingly.  With this flag
  230.           activated, seven other parameters are required on the command-
  231.           line along with four other optional switches and one required
  232.           switch.  The seven parameters are supplied by T.A.G. itself and
  233.           can be read using %1 through %7 in the EXTEDIT.BAT file.
  234.           (see below)
  235.  
  236.   -M#     [optional] This tells the editor what color "Mode" to use.  This
  237.           switch specifies the color and graphics codes to allow in the
  238.           editor.  There are seven modes currently supported, as follows:
  239.  
  240.           -M0  No color or graphics allowed
  241.           -M1  IBM Graphics, no color
  242.           -M2  ANSI/TCEDIT colors only
  243.           -M3  IBM Graphics & ANSI/TCEDIT colors
  244.           -M4  T.A.G. CTRL-P color codes only
  245.           -M5  IBM Graphics and T.A.G. color codes
  246.           -M6  ANSI/TCEDIT and T.A.G. colors
  247.           -M7  IBM Graphics, ANSI/TCEDIT & T.A.G. colors (default mode)
  248.  
  249.   -A###   [optional] This switch applies to T.A.G. mode only, and tells the
  250.           editor the minimum Security Level (SL) to allow to use the
  251.           CTRL-X,I and CTRL-X,W commands, which will read or write files
  252.           directly to any directory on any disk on your system.  This
  253.           access should be restricted to trusted SysOps and Co-SysOps only
  254.           (e.g., SL greater than 200).  When this switch is not supplied
  255.           the default minimum access is 256, which blocks ALL users from
  256.           the Write and Import functions.
  257.  
  258. TCEDIT                                                              Page 6
  259. 1.1 beta (l)                                                        1/4/95
  260. __________________________________________________________________________
  261.  
  262.   -Upath  [required] This flag applies to T.A.G. mode only, and tells the
  263.           editor where to find the USER.LST file, normally contained in
  264.           your GFILES directory.  DO NOT append a backslash to the end of
  265.           this switch.  If this switch is omitted or points to an incorrect
  266.           directory, a warning will be issued to both you and the user, the
  267.           default color codes will be used instead of the user's codes, and
  268.           CTRL-X,I and CTRL-X,W access will not be given.
  269.  
  270.   -I      [optional] This switch can be used in both T.A.G. mode and in
  271.           standalone mode.  This tells the editor to start up in
  272.           "Insert" mode, rather than in "Overstrike" mode.
  273.  
  274.           SysOps, please note:  At low baud rates, the amount of time
  275.           for the editor to refresh the screen when inserting characters
  276.           can become excessive.  It is NOT recommended that this switch
  277.           be used if you have callers that connect at less than 9600bps.
  278.   
  279.   -D      [optional] This switch forces debugging mode on.  Normally, this
  280.           is controlled via TCOPTS, but may be necessary if TCEDIT is
  281.           generating errors before it reads, or because it cannot read,
  282.           the TCEDIT.CFG file.  This switch will override the setting
  283.           in TCOPTS.
  284.  
  285.           Please see the TCOPTS section of this document for more
  286.           information on debugging mode.
  287.  
  288.   PARAMETERS PASSED BY TAG
  289.  
  290.   The other parameters, %1 through %7, are required in that order, and are
  291.   read straight from the T.A.G. BBS when it calls EXTEDIT.BAT.  For further
  292.   details on the values passed by T.A.G., please refer to the Main T.A.G.
  293.   documentation.
  294.  
  295.   EXAMPLE
  296.  
  297.     TCEDIT -TAG -A200 -UGFILES %1 %2 %3 %4 %5 %6 %7
  298.  
  299.     This tells TCEDIT that it is operating in T.A.G. mode, only people with
  300.     an SL of 200 or greater are allowed to use the CTRL-X,I or CTRL-X,W
  301.     commands, to start up in "Overstrike" mode, and that the file USER.LST
  302.     can be found in the directory named GFILES which is a subdirectory of
  303.     the current directory.  (Since in this case the editor is loaded up
  304.     from the main T.A.G. directory, you do not need to supply a full path
  305.     and drive name to the -U option here.  If you had your GFILES directory
  306.     somewhere else, you need to supply a full path, for example
  307.     "-UD:\MY\GFILES" would mean to find USER.LST in the directory
  308.     \MY\GFILES on drive D:.)  Remember, don't put a backslash on the end
  309.     of this path, or it will not function correctly!  Since the -M switch
  310.     was not supplied, the editor defaults to -M7.
  311.  
  312. TCEDIT                                                              Page 7
  313. 1.1 beta (l)                                                        1/4/95
  314. __________________________________________________________________________
  315.  
  316. TCOPTS
  317.  
  318.   TCEDIT comes with a special configuration program, TCOPTS.  This program
  319.   sets a number of items which determine how the editor acts.
  320.  
  321.   TCOPTS will create a file, TCEDIT.CFG, in the same directory as itself.
  322.   (TCOPTS should be in the same directory as TCEDIT, as well.)  Do not
  323.   delete this file, or your settings will revert to the default.  Use
  324.   TCOPTS to make changes to TCEDIT.CFG.
  325.  
  326.   Following is an explanation of the options in TCOPTS:
  327.  
  328.   [T]aglines: Set Path and Name of Taglines File
  329.  
  330.     If you wish to allow users to use Taglines from your T.A.G. Taglines
  331.     file, you can enter the path and filename here.  If you press <ENTER>,
  332.     TCOPTS will attempt to find a Taglines file on your current drive.  If
  333.     it cannot find a tagline file or you enter an invalid filename, this
  334.     option will be disabled.
  335.  
  336.   [Q]uoting: Set Default for Editor Quoting
  337.  
  338.     There are two settings for this option, "SMART" and "REGULAR".  When
  339.     quoting a message being replied to, T.A.G. often inserts odd line
  340.     breaks, making quoted text unwieldy.  TCEDIT, through its SMART QUOTING
  341.     algorithm, attempts to minimize some of this.  This determines the
  342.     default method TCEDIT uses.  Both methods are always available to the
  343.     user via CTRL-Q and CTRL-Y.
  344.  
  345.   [A]utosave: Set Autosave Default
  346.  
  347.     There are two settings for this option, "AUTOMATIC" and "MANUAL".  This
  348.     setting determines whether the user must confirm the saving of the
  349.     message when appending a Tagline to the message.
  350.  
  351.   [D]ebug: Toggle Editor Debugging
  352.  
  353.     This option may be toggled on or off.  When ON, or when the -D switch
  354.     has been used in EXTEDIT.BAT, TCEDIT will log errors during runtime
  355.     to a special log file (TCEDIT.ERR).  If you are having trouble with
  356.     the editor, a copy of this file sent to the TCEDIT design team will
  357.     go a long way in tracking down the source of the problem.  TCEDIT
  358.     does not truncate this file, so if you've had a significant number of
  359.     errors, or haven't had any errors in a long time, you may wish to
  360.     delete TCEDIT.ERR.
  361.  
  362.   [S]how Current Settings
  363.  
  364.     This simply displays your current setup.
  365.  
  366.   [X] Exit
  367.  
  368.     Exit from TCOPTS.
  369.  
  370. TCEDIT                                                              Page 8
  371. 1.1 beta (l)                                                        1/4/95
  372. __________________________________________________________________________
  373.  
  374. MISCELLANY
  375.  
  376.   TAGLINES
  377.  
  378.   TCEDIT has the ability to read your normal Taglines file that you have
  379.   set up for T.A.G.'s internal editor.  Because you set the path and
  380.   filename of the Taglines file via TCOPTS, it is possible to have two
  381.   separate tagline files; one for TCEDIT and one for T.A.G.'s internal
  382.   editor.  (Please see the T.A.G. documentation for specifics on the format
  383.   of the taglines file.)  However, please be sure that all of your taglines
  384.   are no longer than 75 characters in length.  Longer taglines can not only
  385.   play havoc with TCEDIT, but echomail as well.  (TCEDIT will not process
  386.   taglines that are 80 characters in length or longer.)
  387.  
  388.   USING TCEDIT IN A MULTI-NODE ENVIRONMENT
  389.  
  390.   If you are interested, here is a little more insight in how TCEDIT
  391.   functions on a multi-node system.
  392.  
  393.   When called, TCEDIT looks for two files:  The TCEDIT.CFG file, which
  394.   TCEDIT expects in the same directory as TCEDIT.EXE, and MSGTMP, a
  395.   temporary file created by T.A.G., in the "current" directory.  (MSGTMP
  396.   is used by T.A.G. to pass the data, such as quoting or the edited
  397.   message, to and from an external editor.)  By "current" directory, I
  398.   am referring to the directory DOS is in.  Unless you use a CD command
  399.   in EXTEDIT.BAT, this SHOULD be the same directory where the STATUS.DAT
  400.   for the current node is located.  If you use other utilities in your
  401.   EXTEDIT.BAT (such as a utility to change the $WHO.DAT file) you must
  402.   ensure that you change back to the proper directory before running
  403.   TCEDIT.EXE.
  404.