home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / TCE11L.ZIP / TCEUSER.DOC < prev    next >
Text File  |  1995-01-04  |  12KB  |  277 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.  
  23.   Command-line Parameters........................................   4
  24.      -M<Color Mode #>............................................   4
  25.      [DRIVE:][\PATH\]FILENAME.EXT................................   4
  26.      -I..........................................................   4
  27.      Examples....................................................   5
  28.  
  29.   Miscellany.....................................................   6
  30.      Shell to DOS................................................   6
  31.      Advanced Tips - Color Stripping.............................   6
  32.      Using TCEDIT with an Off-Line Mail Reader...................   6
  33.  
  34. TCEDIT                                                              Page 2
  35. 1.1 beta (l)                                                        1/4/95
  36. __________________________________________________________________________
  37.  
  38. LEGAL INFORMATION
  39.  
  40. TCEDIT is Freeware.  There is no charge for its use and it is distributed
  41. as a fully functional program.
  42.  
  43. This program is Copyright (c) 1994-1995 by SmartSoft. All rights reserved.
  44.  
  45. The T.A.G. Bulletin Board System (T.A.G.) is Copyright (c) 1986-1994 by 
  46. The T.A.G. Team.
  47.  
  48.   DISCLAIMER
  49.  
  50.        TCEDIT is distributed as is.  TCEDIT is guaranteed to take up room
  51.        on your hard drive only.  The author of TCEDIT makes no guarantees
  52.        as to the usefulness of this program, nor can the author be held
  53.        liable for damage to your system.  Use at your own risk.
  54.  
  55.   DISTRIBUTION
  56.  
  57.     BBS SysOps:  You may freely distribute this archive so long as no fees
  58.     are charged, over and above any normal system access fees, and do not
  59.     add or remove files from the original archive.
  60.  
  61.     Shareware Distributors:  Please contact the author for distribution
  62.     license information.  (This includes the bundling of TCEDIT in a
  63.     software package.)
  64.  
  65.  
  66. INTRODUCTION
  67.  
  68.   PURPOSE
  69.  
  70.     TCEDIT can be used as a standalone text editor or as a Full-Screen
  71.     Editor for the T.A.G. Bulletin Board System.  Currently, no other BBS
  72.     software packages are supported.  TCEDIT has been tested with T.A.G.
  73.     versions 2.6 and up.
  74.  
  75.     This document covers the use of TCEDIT as a standalone editor.  For
  76.     details on the use of TCEDIT as a T.A.G. Full-Screen Editor, please
  77.     refer to the document TCESYSOP.DOC, also contained in this archive.
  78.  
  79.     ** NOTE ** NOTE ** NOTE ** NOTE ** NOTE ** NOTE ** NOTE ** NOTE **
  80.     This is a BETA test.  Please help us provide the very best product to
  81.     the T.A.G. BBS community.  Report bugs and other programming errors to
  82.     the FidoNet address below.
  83.  
  84.   MINIMUM REQUIREMENTS
  85.  
  86.     ANSI.SYS or a compatible ANSI driver must be loaded.
  87.  
  88.     A comport FOSSIL driver must be present if the editor is used in T.A.G.
  89.     mode.  (This is not required for standalone operation.  TCEDIT has been
  90.     tested with X00 and BNU FOSSIL drivers.)
  91.  
  92. TCEDIT                                                              Page 3
  93. 1.1 beta (l)                                                        1/4/95
  94. __________________________________________________________________________
  95.  
  96.   THANKS AND KUDOS
  97.  
  98.     Many thanks to Vickie Church, the SysOp of Vickie's Palace
  99.     (1:2330/200) and Hal Craig, the SysOp of Thirst BBS (1:374/65), as
  100.     well as the users of both systems for their help in beta testing
  101.     TCEDIT.
  102.  
  103.     Thanks also go out to Rob Carlson for maintaining the TCEDIT FAQ.
  104.  
  105.     And of course, many thanks to the users of The MindScape BBS
  106.     (1:2605/631) who endured more than one buggy beta test of TCEDIT.
  107.  
  108.   OBTAINING THE LATEST VERSION
  109.  
  110.     To receive the latest version of TCEDIT, you may FREQ "TCEDIT" from
  111.     FidoNet 1:2605/631. (Points welcome!)  You may also call MindScape BBS
  112.     directly at (908)668-7377, where there is a GUEST account available
  113.     for downloading TCEDIT.
  114.  
  115.     The MindScape BBS, 1:2605/631, is the only official "home" of
  116.     TCEDIT.  Accept no substitutes.
  117.  
  118.   SUPPORT
  119.  
  120.     For bug reports and correspondence, please send FidoNet NetMail to
  121.     SmartSoft at 1:2605/631.  There is also a support echo for TCEDIT
  122.     available.  If you are interested in carrying this echo, please contact
  123.     the System Operator at 1:2605/631 for information.  The TCEDIT design
  124.     team is also active in the TAG FidoNet echo.
  125.  
  126.  
  127. QUICK SETUP
  128.  
  129.   1. Copy the files TCEDIT.EXE to whatever directory you want.  (Perhaps
  130.      C:\TCEDIT)
  131.  
  132.   2. In order to edit any text file, at a DOS prompt type:
  133.  
  134.      TCEDIT filename.ext
  135.  
  136.      (An explanation of options and command-line switches is provided
  137.      later in this document.)
  138.  
  139.      NOTE: Only the file TCEDIT.EXE is required to use TCEDIT as a text
  140.      editor.  The TCOPTS.EXE program is for configuring some of the options
  141.      of the editor for use with a T.A.G. BBS system.  If you are not
  142.      running a T.A.G. BBS system, you can safely delete TCOPTS.EXE.
  143.  
  144. TCEDIT                                                              Page 4
  145. 1.1 beta (l)                                                        1/4/95
  146. __________________________________________________________________________
  147.  
  148. COMMAND-LINE PARAMETERS:
  149.  
  150.   To use TCEDIT as a standalone editor, the command to call the editor
  151.   is:
  152.  
  153.   TCEDIT [-M#] [-I] [DRIVE:][\PATH\]FILENAME.EXT
  154.  
  155.   All command-line switches and the filename can be upper or lower case
  156.   (or any combination), and can use either a '-' or '/' to mark the switch
  157.   (i.e., -M1 and /M1 are equivalent).
  158.  
  159.   -M#     [optional] This tells the editor what color "Mode" to use.  This
  160.           switch specifies the color and graphics codes to allow in the
  161.           editor.  There are seven modes currently supported, as follows:
  162.  
  163.           -M0  No color or graphics allowed
  164.           -M1  IBM Graphics, no color
  165.           -M2  ANSI/TCEDIT colors only
  166.           -M3  IBM Graphics & ANSI/TCEDIT colors
  167.           -M4  T.A.G. CTRL-P color codes only
  168.           -M5  IBM Graphics and T.A.G. color codes
  169.           -M6  ANSI/TCEDIT and T.A.G. colors
  170.           -M7  IBM Graphics, ANSI/TCEDIT & T.A.G. colors (default mode)
  171.  
  172.           "T.A.G. colors" is a color marking convention adopted from
  173.           the T.A.G. BBS system and usable in TCEDIT.  By using ^P
  174.           (CTRL-P) followed by a single digit from 0 to 9, all text
  175.           following will be made that foreground/background, until
  176.           another color code is encountered.  This can be useful for
  177.           T.A.G. SysOps who want to modify their system *.MSG files
  178.           with ^P codes.  When used in standalone mode, TCEDIT uses
  179.           a series of default colors that match to the "factory"
  180.           defaults of T.A.G. v2.6.
  181.  
  182.   [DRIVE:][\PATH\]FILENAME.EXT
  183.  
  184.           Where FILENAME.EXT is the file name and extension of the file you
  185.           wish to edit.  If the file does not exist, TCEDIT will create it.
  186.           Full pathing is supported.
  187.  
  188.           If no file name is provided, TCEDIT will create a file in the
  189.           current DOS directory called "NONAME.TXT".
  190.  
  191.   -I      [optional] This switch can be used in both T.A.G. mode and in
  192.           standalone mode.  This tells the editor to start up in
  193.           "Insert" mode, rather than in "Overstrike" mode.
  194.  
  195. TCEDIT                                                              Page 5
  196. 1.1 beta (l)                                                        1/4/95
  197. __________________________________________________________________________
  198.  
  199.   EXAMPLES
  200.  
  201.     TCEDIT -M0 D:\MYFILES\STUFF.TXT
  202.  
  203.     This tells TCEDIT that it is operating in standalone mode and to
  204.     edit the file STUFF.TXT which is found in the \MYFILES directory on
  205.     drive D:.  If the file doesn't exist, TCEDIT will create it.  The
  206.     "-M0" switch indicates that no color or IBM graphics characters will
  207.     be allowed.  Since the "-I" switch was not supplied, the editor will
  208.     start up in "Overstrike" mode.
  209.  
  210.     TCEDIT -I THISFILE.DOC
  211.  
  212.     This tells TCEDIT to edit the file THISFILE.DOC in the current
  213.     directory (creating it if it doesn't exist).  The "-I" switch tells
  214.     the editor to start up in "Insert" mode.  Since no -M switch
  215.     was supplied, the editor defaults to "-M7", which is full color
  216.     and IBM graphics allowed.
  217.  
  218. TCEDIT                                                              Page 6
  219. 1.1 beta (l)                                                        1/4/95
  220. __________________________________________________________________________
  221.  
  222. MISCELLANY
  223.  
  224.     SHELL TO DOS
  225.  
  226.     When used in standalone mode, TCEDIT has a "shell to DOS" command
  227.     that allows you to work in DOS, perhaps to find a file that you need
  228.     to import.  This feature does NOT work when TCEDIT is used as the
  229.     T.A.G. full-screen editor.
  230.  
  231.     To use this function, call up the "Command>" prompt.  (This can be
  232.     done by pressing '/' or '.' when the cursor is in column 1, or by
  233.     pressing CTRL-X at any time.)  At the "Command>" prompt, press 'X'.
  234.     You will now be at a DOS prompt.  To get back to TCEDIT, simply
  235.     type "exit" (without the quotes) and press ENTER.
  236.                                                      
  237.     ADVANCED TIPS - COLOR STRIPPING
  238.  
  239.     One of the best features of the color mode switch is the simple
  240.     procedure for stripping out the color codes from your ANSI files.
  241.     (For instance, to take a T.A.G. *.CLR file and strip out the color
  242.     to make a *.MSG file.)  Here's an example:  Suppose you had just
  243.     finished using an ANSI drawing program, or even TCEDIT, to create
  244.     a login text file for T.A.G., and it was named LOGIN.CLR.  To turn
  245.     this file into a color-free *.MSG file, you would only need to use the
  246.     following commands at a DOS prompt:
  247.  
  248.        COPY LOGIN.CLR LOGIN.MSG
  249.        TCEDIT -M1 LOGIN.MSG
  250.  
  251.     Once in the editor simply Save and Exit, and LOGIN.MSG will be color-
  252.     free!  The "-M1" switch allows graphics codes to remain but strips out
  253.     all ANSI and CTRL-P codes from the file.  Use "-M0" to make the file
  254.     completely text, with no IBM graphics, or use the table above under
  255.     the [-M] option to select any combination you desire.
  256.  
  257.     USING TCEDIT WITH AN OFF-LINE MAIL READER
  258.  
  259.     TCEDIT can be used with any OLR package that allows an external editor
  260.     and can pass a filename parameter.  Currently, TCEDIT has only been
  261.     tested with the BlueWave Off-Line Mail Reader system (Copyright 1992
  262.     by George Hatchew).
  263.  
  264.     You will need to check your specific Mail Reader's documentation for
  265.     details on how to change the editor.
  266.  
  267.     Example - Blue Wave
  268.  
  269.     For simplicity, put TCEDIT.EXE in your main BlueWave directory.
  270.     (For purposes of this example, it will be assumed to be C:\BWAVE.
  271.     If yours is different, use yours where you see "C:\BWAVE".)
  272.     Start BlueWave, and go to the S)etup Parameters menu.  In the
  273.     "Directories" section of setup, under "Command Lines," change the
  274.     "Editor File Path" to say "C:\BWAVE\TCEDIT.EXE @F" (without the
  275.     quotes).  The "@F" passes a filename to the editor.  You can also
  276.     put in a "-M" switch if desired.
  277.