home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / TIDE110.ZIP / TIDE.TXT < prev    next >
Text File  |  1997-10-16  |  39KB  |  939 lines
  1.  
  2. Tide version 1.10 Full Screen Editor
  3. Copyright 1995, 1996, 1997 Errol Smith
  4. All Rights Reserved
  5.  
  6.  
  7.  
  8. QUICK 2 MINUTE INSTALL:
  9.  
  10.  Copy the contents of this archive to a directory of your choice,
  11. eg. "C:\BBS\TIDE\"
  12.  Load your BBS's configuration program, change the Full Screen Editor
  13. command line to: "[drive]:\[path]\TIDE.EXE -N*N *M" where *N is the
  14. node number & *M enables memory swapping.
  15. eg. For Ezycom, "C:\EZY\TIDE\TIDE.EXE -N*N *M" in Messages>Misc>Ext.Editor
  16.  For Ezycom BBS's, make sure that 'Old Style MSGTMP = NO'
  17.  Exit & save your BBS setup, and test run it.  If you have problems,
  18. read the detailed installation and/or FAQ later in this file.
  19.  
  20.  
  21.  
  22. Contents:
  23.  
  24.  1 - What is Tide?
  25.  
  26.  2 - Feature Summary
  27.  
  28.  3 - License Agreement & Registration
  29.  
  30.  4 - Installation & Hardware/Software requirements
  31.  
  32.  5 - Command reference and Features in detail
  33.  
  34.  6 - Command line parameters
  35.  
  36.  7 - Problems & Frequently Asked Questions
  37.  
  38.  8 - Credits
  39.  
  40.  9 - Contacting the author.
  41.  
  42.  
  43.  
  44.  
  45. ======================================================================
  46.  1 - What is Tide?
  47. ======================================================================
  48.  
  49.    Tide is a full screen editor (FSE) for use with Ezycom,
  50.   RemoteAccess, QuickBBS, SuperBBS and other BBS systems using the
  51.   QuickBBS style of external editor interface. 
  52.  
  53.    Tide was originally started because I felt there was a need for a
  54.   more reliable, more efficient editor than the ones currently
  55.   available, (especially for Ezycom) none of which seemed to work
  56.   very reliably.
  57.    I also wanted an editor that fully supported Avatar0+ and made full
  58.   use of its powerful scrolling commands, which were perfect for a
  59.   full screen editor.
  60.    After about 8 months of developing and beta testing, 'Tide' is the
  61.   result!
  62.  
  63.  
  64.  
  65.  
  66. ======================================================================
  67.  2 - Feature summary:
  68. ======================================================================
  69.  
  70.   - Supports both AVATAR0+ & ANSI graphics commands, making extensive
  71.     use of Avatar's screen scrolling commands.
  72.   - Extremely efficient, even low speed users can use this editor! (-:
  73.   - Doorway mode for remote connections to enable 'extended' keys
  74.     such as page up/down, ctrl-home/end etc.
  75.   - Recursive word-wrap routines & automatic paragraph handling.
  76.   - Powerful paragraph reformat routine (Ctrl-D).  Will even reformat
  77.     & re-quote quoted text, fixing the dreaded 'chainsaw' effect.
  78.   - Fast spell checking routine. (Ctrl-E)
  79.   - Multi-line cut/copy/paste buffer.
  80.   - When a user runs out of time, it gives them the option to save or
  81.     abort their unfinished message.  A 10 second time-out will
  82.     automatically save the message if they do not respond.
  83.   - Reads the users screen length, and adjusts the editing/quote
  84.     window sizes accordingly.                            [ezycom only]
  85.   - General/User help. (F1)
  86.   - Sysop/Local help. (F2)
  87.   - Importing of text files. (F3)                         [local only]
  88.   - Exporting to a file. (F4)                             [local only]
  89.   - 'To:' field name/handle search. (F5)                 [ezycom only]
  90.   - Reads the users record for text/quote colours.       [ezycom only]
  91.   - Gives away time slices when idle for multitasking systems.
  92.     Directly supports OS/2, DESQview, Windows & generic timeslicing.
  93.   - Alt-J shell to DOS from within editor.
  94.   - Allows user to change privacy flag & message subject [ezycom only]
  95.   - Support for forwarding of messages.                  [ezycom only]
  96.   - Sysop (local) macros. ALT F1-F12
  97.   - Built in full screen split sysop <-> user chat. (Alt-C)
  98.   - Alter users remaining time while in editor.
  99.   - Tagline support. (optional)
  100.   - Security lockout for local/sysop keyboard functions.
  101.   - No configuration program/files needed, and no need for an
  102.     environment variable.
  103.   - Only one copy of the editor & key is needed on your system.  (but
  104.     you can have multiple copies on your system without problems)
  105.   - All help screens are built in to the .EXE file.
  106.   - Unregistered version not crippled. (all features are enabled)
  107.   - Written by a BBS user -for- BBS users.
  108.  
  109.  
  110.  
  111.  
  112. ======================================================================
  113.  3 - License Agreement & Registration
  114. ======================================================================
  115.  
  116.   IMPORTANT: Please read this license agreement before using this
  117.   software.  By using this software you acknowledge your agreement to
  118.   the terms of this license.  If you do not wish to follow the terms
  119.   of this license agreement, you must remove this software from your
  120.   system.  The only portion of the Software that you may retain is the
  121.   distribution archive itself which may be used solely for
  122.   distribution purposes.
  123.  
  124.    Distribution of this package is encouraged, so long as no charge is
  125.   levied for the distribution.  Commercial Software Libraries may not
  126.   include Tide in their libraries, without the written permission of
  127.   the author.
  128.  
  129.    The distribution archive of Tide may not be tampered with in any
  130.   way, shape or form.  Conversion to another archive format is allowed
  131.   but strongly discouraged.  Adding comments, headers or extra files
  132.   to the archive, or the removal or modification of any files in the
  133.   archive is NOT permitted.  Modifying, reverse engineering or
  134.   disassembling of Tide executables or key files is strictly
  135.   prohibited.
  136.  
  137.    Distributing the registration key or otherwise making it available
  138.   to persons other than yourself is a violation of the licensing
  139.   agreement.  Copies of the registration key may be made ONLY for
  140.   backup/archival purposes.
  141.  
  142.    The use of tampered versions of Tide, or the use of keys not
  143.   distributed by official registration sites is an infringement of
  144.   International Copyright Laws.
  145.  
  146.    'Tide' is supplied 'as is'.  This product (including any and all
  147.   files included in the original distribution archive) has no
  148.   guarantees or warranties of any kind.  Apart from the likelyhood of
  149.   it taking up disk space on your system, this product promises
  150.   nothing.
  151.  
  152.    The author will not be held liable for any damages caused to you or
  153.   your system by this product, whether from use, misuse or any other
  154.   factor.  Every effort has been made to make this product as 'safe'
  155.   as possible, but due to the nature of Bulletin Board Systems and
  156.   computers in general, there is always the chance of damage to system
  157.   files and/or any associated hardware/software.
  158.  
  159.  Registration:
  160.  
  161.    This editor is NOT free.  This software is shareware, meaning you
  162.   MUST pay for it if you intend to use it beyond a 30 day evaluation
  163.   period.  After expiration of the 30 day evaluation period, you must
  164.   either register or remove this software from your system.
  165.  
  166.    When unregistered, the editor does have some restrictions, however
  167.   it is NOT 'crippled'.  All functions are enabled, allowing you to
  168.   effectively evaluate the editor before you decide to register it or
  169.   discontinue using it.
  170.  
  171.    However, the editor won't let you edit a message larger than 100
  172.   lines long.  The editor will regularly remind you & your users that
  173.   it is only for evaluation, and occasionally put a message to this
  174.   effect on the end of saved messages.  The number of useable taglines
  175.   is also limited to 10.
  176.  
  177.    When registered, all these restrictions are removed.
  178.   Registration is A$25 (Twenty Five Australian Dollars) for a single
  179.   registration and less for group registrations (2 or more people
  180.   using one payment, eg. one cheque for 3 registrations).
  181.   
  182.    See the accompanying registration form for details on how to
  183.   register Tide.
  184.  
  185.  
  186.  
  187.  
  188.  
  189. ======================================================================
  190.  4 - Installation & Hardware/Software Requirements
  191. ======================================================================
  192.  
  193.    The only requirements for this editor are that a FOSSIL be present
  194.   for remote connections.  If you are running a BBS, then you will
  195.   most likely already have one loaded, so this isn't a problem.  It
  196.   has been tested with both X00 by Raw Gwinn and BNU by David Nugent.
  197.  
  198.    The editor should run on any hardware, even an XT, as long as it is
  199.   running some form of DOS (3.x or higher recommended), and has been
  200.   tested under OS/2 Warp, DESQview and Windows without problems.
  201.   It will also pass timeslices to these systems to help multitasking.
  202.    Typically, at least 200k of free memory is required.  In most
  203.   cases, the editor will load without the BBS doing a memory swap.
  204.  
  205.    Installation is easy.  Simply extract the distribution archive to
  206.   a directory on your system, (eg. C:\BBS\TIDE) and modify your BBS
  207.   configuration appropriately.
  208.  
  209.    This will generally involve changing the command line for the
  210.   external editor to "[drive]:[path]\TIDE.EXE -N*N *M"
  211.  
  212.    BBS detection is automatic, looking at your environment variables,
  213.   but can be overridden on the command line if you have problems (for
  214.   example, you have more than one environment variable that the
  215.   editor recognises - see "/B" under command line options)
  216.  
  217.    Order of detection is:
  218.      EZY
  219.      RA
  220.      QBBS
  221.      SBBS
  222.  
  223.    Whichever one it finds first will be the default.  (internally, all
  224.   modes except Ezycom are identical, so the editor will work with
  225.   QuickBBS even if it finds an RA environment variable first.  However
  226.   I have included the separate options for future expansion, for
  227.   example direct support of each BBS's dropfiles)
  228.  
  229.    If none of these is found, the editor defaults to the QuickBBS/RA
  230.   style of editor interface, using "DORINFO1.DEF" for the user/port
  231.   info, and "MSGTMP." for the quote & message text.  "MSGINF." is
  232.   optional (contains message information).  All these files must be in
  233.   the current directory.  See the FAQ for more info.
  234.  
  235.    Ezycom files are read from the Ezycom system directory as defined
  236.   by the "EZY" environment variable.  If Ezycom mode is forced and no
  237.   EZY environment variable exists, the current directory will be used.
  238.  
  239.  
  240.  Ezycom Installation:
  241.  
  242.    In Ezycom's CONFIG, go into 'Messages > Misc > External Editor'
  243.    And set it to:
  244.  
  245.    [path]TIDE.EXE -N*N *M
  246.  
  247.    eg. 'C:\EZY\TIDE\TIDE.EXE -N*N *M'
  248.  
  249.    Make sure that 'Messages > Misc > Old Style MSGTMP' is 'NO'.
  250.  
  251.    The -N*N passes the node number (See command line options), and 
  252.    the *M tells Ezycom to do a memory swap.
  253.  
  254.  
  255.  
  256.  RemoteAccess Installation:
  257.  
  258.    In RACONFIG, go into 'Options > Messages > External Editor'
  259.    And set it to:
  260.  
  261.    [path]TIDE.EXE -N*N *M
  262.  
  263.    eg. 'C:\RA\TIDE\TIDE.EXE -N*N *M'
  264.  
  265.    The -N*N passes the node number (See command line options), and 
  266.    the *M tells RA to do a memory swap.
  267.  
  268.  
  269.  
  270.    When you register, the KEY file should be placed in the same
  271.   directory where you installed Tide, your BBS system directory,
  272.   and/or in the current (DOS) directory that the BBS operates in.
  273.   The Key file is searched for in that order.
  274.  
  275.  
  276.  
  277. ======================================================================
  278.  5 - Command Reference & Features
  279. ======================================================================
  280.  
  281.    A summary of these commands is available in the online help.  Press
  282.   ESC H or F1 for general help and F2 for sysop/local help.
  283.  
  284.  Edit Window:
  285.  
  286.   Command:   Alternative:       Function:
  287.  
  288.   Control-A  (Ctrl-LeftArrow)   Moves the cursor to the first
  289.                                 character of the previous word.
  290.  
  291.   Control-B                     Change the case of the word the cursor
  292.                                 is on.  Order is lower case; upper
  293.                                 case; first char uppercase, remaining
  294.                                 chars lower case. ie:
  295.                                 hello -> HELLO -> Hello -> hello .....
  296.  
  297.   Control-C  (Page-Down)        Go down one page of text.
  298.  
  299.   Control-D                     Reformat and re-quote the current
  300.                                 paragraph.  The paragraph is
  301.                                 reformated from the current line
  302.                                 downwards until a blank line is
  303.                                 encountered.
  304.                                  Lines longer than the right margin
  305.                                 (70chars) are word-wrapped to the next
  306.                                 line.
  307.                                  Lines that are shorter than the
  308.                                 margin will 'pull-up' words from the
  309.                                 next line.  This effectively
  310.                                 'compacts' a paragraph.
  311.                                  If the line the cursor is on is
  312.                                 quoted (ie has a '>' in the first few
  313.                                 characters), then that quote prefix is
  314.                                 used in front of all lines in the
  315.                                 paragraph.  Also, any quote prefixes
  316.                                 in following lines are removed.  This
  317.                                 effectively re-quotes the paragraph.
  318.                                  This is an extremely powerful command
  319.                                 - when used on quoted text, it will
  320.                                 completely eliminate the dreaded
  321.                                 'chainsaw effect'.  After getting used
  322.                                 to it, you will find yourself hitting
  323.                                 Ctrl-D on all your quoted paragraphs
  324.                                 when replying to messages.
  325.                                  It can also be used to 'quote' an
  326.                                 un-quoted paragraph by adding a quote
  327.                                 prefix to the current line and then
  328.                                 running it.  Transversely, it can be
  329.                                 used to 'un-quote' a paragraph by
  330.                                 removing the quote prefix from the
  331.                                 current line before using it.
  332.                                  This is similar to the Qedit command
  333.                                 'WrapParagraph' (Alt-B).
  334.  
  335.   Control-E                     Run/restart spellchecker. Useful
  336.                                 after editing misspelled words.
  337.  
  338.   Control-F  (Ctrl-RightArrow)  Moves the cursor to the first
  339.                                 character of the next word.
  340.  
  341.   Control-G                     Paste a "<grin>".
  342.  
  343.   Control-H  (Backspace)        Delete the previous char, scrolling
  344.                                 the rest of the line left.
  345.  
  346.   Control-I  (Tab)              Move the cursor to the next tab stop.
  347.                                 If insert mode is on, the text in
  348.                                 front of the cursor will be moved
  349.                                 along with it.
  350.  
  351.   Control-J                     Centre the current line.
  352.  
  353.   Control-K  (Esc Q)            Alternative to Quote (Control-Q).
  354.  
  355.   Control-L  (Esc R)            Redraw the screen.  This can be used
  356.                                 if the user receives line noise to
  357.                                 redraw the display.
  358.  
  359.   Control-M  (Enter)            Move the cursor to the beginning of
  360.                                 the next line.  This will also insert
  361.                                 a blank line.  If the cursor was not
  362.                                 at or past the end of the line, the
  363.                                 rest of the line will be moved to the
  364.                                 next line.
  365.  
  366.   Control-N                     Insert a new line.
  367.  
  368.   Control-O  (Esc)              Alternative to ESC (Activate menu).
  369.  
  370.   Control-P                     'Paste' a line from the multiline
  371.                                 cut/copy/paste buffer.
  372.                                  This can be used to move and/or
  373.                                 copy lines of text.
  374.  
  375.   Control-Q  (Esc Q)            Switch between the quote window and
  376.                                 the edit window.  If the quote window
  377.                                 is not open, it will be opened.  This
  378.                                 will have no effect if there is
  379.                                 nothing to quote.
  380.  
  381.   Control-R  (Page-Up)          Go up one page of text.
  382.  
  383.   Control-S                     'Save' (ie. copy) the current line
  384.                                 into the multiline cut/copy/paste
  385.                                 buffer.
  386.  
  387.   Control-T                     Delete the current word, regardless of
  388.                                 where in the word the cursor is.
  389.  
  390.   Control-U                     Delete from the cursor to the end of
  391.                                 the current line.
  392.  
  393.   Control-V  (Insert)           Toggle insert/overwrite mode.
  394.  
  395.   Control-W                     Toggle quote window.  This will open
  396.                                 the quote window if it isn't open and
  397.                                 close it if it is open.
  398.  
  399.   Control-X  (Esc A)            Abort the message and exit.  You will
  400.              (Esc Esc)          be asked for confirmation.
  401.  
  402.   Control-Y                     Delete/Cut the current line. The line
  403.                                 is stored in a multiline buffer. You
  404.                                 can 'undelete' the line(s) with
  405.                                 control-P. (paste)
  406.  
  407.   Control-Z  (Esc S)            Save the message and exit the editor.
  408.  
  409.   Control-[  (Esc)              Activate the menu.
  410.  
  411.   Control-\                     Quote the current line as if from
  412.                                 the person the message is to.
  413.  
  414.  
  415.   Commands for Doorway mode & Local only:
  416.  
  417.   F1         (ESC H)            Help Screen(s)
  418.  
  419.   Page-Up    (Control-R)        Go up one page of text.
  420.  
  421.   Page-Down  (Control-C)        Go down one page of text.
  422.  
  423.   Control-Home                  Top left of edit window.
  424.  
  425.   Control-End                   Bottom right of edit window.
  426.  
  427.   Shift-Tab                     Reverse Tab.
  428.  
  429.   Alt-X                         Abort message without confirmation.
  430.  
  431.  
  432.  Quote Window:
  433.  
  434.    The following keys are for the quote window.  Function is similar
  435.   to the same keys in the edit window, except where detailed.
  436.    Use Control-Q, Control-K or ESC Q to access the quote window.  The
  437.   option will not be accessible if there is nothing to quote.
  438.  
  439.   Command:   Alternative:       Function:
  440.  
  441.   Control-C  (Page-Down)        Go down one page of text.
  442.  
  443.   Control-K  (Esc Q)            Switch between the quote window and
  444.                                 the edit window.
  445.                                 (Alternative to Control-Q)
  446.  
  447.   Control-L  (Esc R)            Redraw the screen.
  448.  
  449.   Control-M  (Enter)            Quote the current line - the quoted
  450.                                 line that the cursor is currently on
  451.                                 will be copied into the edit window.
  452.                                 If the quotemode is insert (default),
  453.                                 then the quoted line will be inserted
  454.                                 before the current edit line.  If
  455.                                 quotemode is overwrite, then the
  456.                                 quoted line will overwrite the current
  457.                                 edit line.
  458.                                  Both the current quote line and edit
  459.                                 line will be advanced.
  460.  
  461.   Control-O  (Esc)              Activate the menu.
  462.  
  463.   Control-Q  (Esc Q)            Switch between the quote window and
  464.                                 the edit window.
  465.  
  466.   Control-R  (Page-Up)          Go up one page of text.
  467.  
  468.   Control-V  (Insert)           Toggle insert/overwrite mode for
  469.                                 quoted lines.
  470.  
  471.   Control-W                     Close the quote window and return to
  472.                                 the edit window.
  473.  
  474.   Control-X  (Esc A)            Abort the message and exit.  You will
  475.              (Esc Esc)          be asked for confirmation.
  476.  
  477.   Control-Z  (Esc S)            Save the message and exit the editor.
  478.  
  479.   Control-[  (Escape)           Activate the menu.
  480.  
  481.   Quote Commands for Doorway mode & Local only:
  482.  
  483.   Page-Up    (Control-R)        Go up one page of text.
  484.  
  485.   Page-Down  (Control-C)        Go down one page of text.
  486.  
  487.   Control-Home                  Top of quote window.
  488.  
  489.   Control-End                   Bottom of quote window.
  490.  
  491.   Alt-X                         Abort message without confirmation.
  492.  
  493.  
  494.  Menu:
  495.    Press ESC or ctrl-O to access the menu.  The uppercase letter of
  496.   each function indicates which key activates the command.
  497.  
  498.   Menu       Keyboard
  499.   Command:   Alternative:       Function:
  500.  
  501.   Help       ESC H              Display the help screens.
  502.  
  503.   Save       Control-Z          Save the message and exit the editor.
  504.  
  505.   Abort      Control-X          Abort the message and exit.  You will
  506.              ESC ESC            be asked for confirmation.
  507.  
  508.   Redraw     Control-L          Redraw the screen.  This can be used
  509.                                 if the user receives line noise to
  510.                                 redraw the display.
  511.  
  512.   Quote      Control-Q          Switch between the quote window and
  513.                                 the edit window.  If the quote window
  514.                                 is not open, it will be opened.  This
  515.                                 will have no effect if there is
  516.                                 nothing to quote, and the option will
  517.                                 not appear on the menu.
  518.  
  519.   Private                       Toggle the privacy status of the
  520.                                 message on or off (if allowed in the
  521.                                 current message area).  [Ezycom Only]
  522.  
  523.   sUbject                       Change the subject of the message.
  524.                                 (if allowed in the current message
  525.                                 area) [Ezycom Only]
  526.  
  527.   spElling   Control-E          Run spell checking routine.
  528.  
  529.   Enter (or any other key)      Exit the menu.
  530.  
  531.  
  532.  Local/Sysop commands:
  533.  
  534.   F1    Display help screens.
  535.  
  536.   F2    Summary of local/sysop commands.
  537.  
  538.   F3    Import a text file into the message.  If insert is on,
  539.         imported lines will be inserted before the current line.  If
  540.         insert is off, imported lines will overwrite lines starting
  541.         from the cursor.  Imported text will be word-wrapped to the
  542.         right margin.
  543.  
  544.   F4    Export the message text to a text file.
  545.  
  546.   F5    To: field name/alias search.  This will search the BBS user
  547.         base for any user who's real name or alias matches who the
  548.         message is being posted to, and display both.  This is
  549.         especially useful if handles are used on your BBS.  For
  550.         example, this command will tell you who someone called
  551.         'Freddo' really is.  [Ezycom Only]
  552.  
  553.   ALT F1-F12
  554.         Sysop macros - see the section on sysop macros below for more
  555.         information.
  556.  
  557.   Alt-C Chat to the remote user.  This will put you into a split full
  558.         screen chat mode.  What you type and what the user types will
  559.         be in separate windows.  Press ESC to exit.  The users screen
  560.         will be automatically redrawn on exiting chat so don't be
  561.         afraid to use it! (-:
  562.  
  563.   Alt-J Shell to DOS.  Note: This may cause problems if when the
  564.         editor loads there is not much free memory.
  565.  
  566.   Alt - Decrement users remaining time
  567.  
  568.   Alt = Increment users remaining time
  569.  
  570.  
  571.  Sysop Macros:
  572.   Sysop macros are accessed by holding the ALT key and pressing
  573.   function keys F1 through F12.  The macros are defined in a text file
  574.   called 'TIDE.MAC' which should be placed in the same directory as
  575.   TIDE, or the BBS system directory.  The file is a simple text file
  576.   where each line corresponds to a macro key.  ie the first line in
  577.   the file is the macro for ALT-F1, the second line for ALT-F2 and so
  578.   on until the 12th line for ALT-F12.  The vertical bar '|' (pipe
  579.   symbol) is used to define a carriage return.
  580.  
  581.   Example: the macro: 'Regards,|Errol Smith' (without the quotes) will
  582.   produce an output like...
  583.   Regards,
  584.   Errol Smith
  585.   ...in the message.  Use the sequence '|/s|' to save the message with
  586.   the macro. eg 'Regards,|Errol Smith|/s|' would do as above but also
  587.   save the message automatically.
  588.  
  589.  
  590.  Taglines:
  591.    Taglines are optional.  If the file 'TIDE.TAG' exists in the Tide
  592.   directory, the BBS system directory or the current directory, a
  593.   random quote will be taken from it & added to the end of message
  594.   text.  Taglines look something like:
  595.  
  596.   ... This is a tagline. Please steal me!
  597.  
  598.    If you don't want taglines added to your messages, then simply
  599.   delete (or don't create in the first place), the file TIDE.TAG.
  600.    The file uses a custom format to store taglines, and I have
  601.   supplied a utility with the editor to convert normal ascii text
  602.   files into the format used.
  603.  
  604.   The usage is dead easy:
  605.   TIDETAG.EXE [inputfile] [/E]
  606.  
  607.    With no options, it will give you a little reminder of how to use
  608.   it.  The default input file is straight ascii, one tagline per line.
  609.    It will also convert the Ezycom 'RUMOURS.BBS' format.  To do so,
  610.   put a /E on the command line after the filename.
  611.    eg. TIDETAG RUMOURS.BBS /E
  612.  
  613.    The output file will always be TIDE.TAG in the current directory.
  614.   If it already exists, it will be overwritten.
  615.  
  616.    Notes:
  617.       - The "... " prefix is added by the editor, and should NOT be
  618.         part of the input text file.
  619.       - When the editor looks for TIDE.TAG, it looks in the directory
  620.         Tide was loaded from, then the BBS system directory
  621.         (as defined by the appropriate environment variable),
  622.         then the current DOS directory.  This should mean only one
  623.         copy of TIDE.TAG is needed on your system.
  624.       - Input lines longer than 65 characters will be ignored.
  625.  
  626.  
  627.  
  628.  
  629. ======================================================================
  630. 6 - Command line parameters
  631. ======================================================================
  632.  
  633.    Command line parameters must begin with either a '/' or a '-'
  634.   followed by a letter to indicate the option, then (in most cases) a
  635.   parameter.  There must be at least one space between separate
  636.   command line parameters.  Case is NOT sensitive.
  637.    eg. to define node 3 all the following will work:
  638.  
  639.    /n3 /N3 -n3 -N3
  640.  
  641.    All command line parameters are optional.  Defaults are listed
  642.   where applicable.
  643.  
  644.  
  645.   - /N#
  646.     This defines which node the editor is on, '#' being the node
  647.     number:
  648.     eg /N2
  649.  
  650.     This will normally be on the BBS config line as '/N*N'
  651.     Default is 1.  This option is MANDATORY for multiline systems.
  652.  
  653.  
  654.   - /B#####
  655.     Define BBS type.  This will override automatic detection
  656.     (see installation)
  657.     Where ##### is:
  658.    
  659.       EZY   - Ezycom
  660.       RA    - RemoteAccess
  661.       QBBS  - QuickBBS
  662.       SBBS  - SuperBBS
  663.       OTHER - Other (QuickBBS/RA style editor interface)
  664.    
  665.     Only the first letter is required, all others are ignored.
  666.  
  667.     eg. /BE /BEZY /bEzy  (force Ezycom mode)
  668.  
  669.     This will usually only be required if you have more than one
  670.     environment variable that Tide recognises (eg. you have both EZY
  671.     & RA variables and you want the editor to load up in RA mode)
  672.  
  673.  
  674.   - /S[ecure]
  675.     This will disable local sysop functions such as shell-to-dos,
  676.     import, export & changing users time.  This would normally be used
  677.     as a security measure in places where the BBS software is used for
  678.     local logins (eg schools), or is in a public area and you don't
  679.     want users accessing the operating system or otherwise being able
  680.     to 'hack' your system.  Typically this would be used in
  681.     conjunction with similar security inside the BBS, such as the
  682.     'Keyboard Password' in Ezycom.
  683.  
  684.     eg. /S /Secure /SECURE
  685.  
  686.  
  687.   - /V
  688.     Turn off video mode changes.  Tide will by default attempt to
  689.     switch to a bigger video mode to accommodate remote users with
  690.     long screen-lengths that won't fit on the current screen mode.
  691.     (eg 50 rows).  Local logins always get the full current
  692.     screenlength, regardless of their user setting.
  693.      If your BBS is already in 43/50 row mode when Tide loads, or if
  694.     none of your users have more than 24 lines then you are unlikely
  695.     to notice.  Only Ezycom passes the screenlength, so other BBS
  696.     systems will have no need for this switch.
  697.      This switch would generally only be used under a multitasker.
  698.     (eg. Desqview may switch to graphics mode to accommodate large
  699.     windows, which can get annoying)
  700.  
  701.  
  702.   - /H
  703.     Disable high ascii. (ascii codes > 127 decimal)  This will stop
  704.     users entering high ascii in messages.  The default is to allow
  705.     high ascii.
  706.     (Under Ezycom, high ascii is not allowed if the user has ibm
  707.     extended chars off.  However other BBS systems have no way of
  708.     'telling' the editor whether to allow high ascii or not.)
  709.  
  710.  
  711.   - /F########.###
  712.     If you are using a BBS system that uses a filename other than
  713.     "MSGTMP." to contain the message text, then this can be used to
  714.     override the default ("MSGTMP." for RA/QuickBBS, or "MSGTMP.nnn"
  715.     for Ezycom, where nnn is the nodenumber)
  716.  
  717.     eg. /Fmsgtxt.xyz
  718.  
  719.   - /R##
  720.     This defines the maximum number of rows available for editing.
  721.     ie the maximum length of the message in lines.
  722.     eg /R20 will limit all messages to a maximum of 20lines.
  723.  
  724.   - [filename]
  725.     Putting a filename FIRST on the command line will override
  726.     everything else and bring the editor up in local mode, with the
  727.     [filename] loaded into the quote window.
  728.      This will enable you to use the editor with an offline reader,
  729.     for example BlueWave. (in theory (: )
  730.  
  731.     eg. TIDE message.txt
  732.  
  733.  
  734.  
  735.  
  736. ======================================================================
  737.  7 - Problems & Mini F.A.Q.
  738. ======================================================================
  739.  
  740.   The editor won't load!
  741.     Double check your BBS setup.  Make sure that the command line is
  742.     correct, and that you are enabling the memory swap. (eg. *M)
  743.      Also make sure that the editor actually IS where you tell the BBS
  744.     it is. (eg if you are loading the editor from a ramdisk, make sure
  745.     that the .EXE is there and that your startup copies the editor
  746.     .EXE to the ramdisk)
  747.  
  748.  
  749.   The editor loads, but I get "WARNING!! CAN'T FIND 'MSGINFO.nnn'" or
  750.   "WARNING!! CAN'T FIND 'EXITINFO.nnn'" (possible Ezycom problem)
  751.     - The editor thinks you are running under Ezycom when you aren't -
  752.       Force the BBS type with the /Bx command line or get rid of your
  753.       EZY environment variable.
  754.     - Your EZY environment variable doesn't exist, or contains the
  755.       wrong path to your BBS system directory.
  756.     - The node number is not being passed to the editor properly.
  757.       Check you have the /N*N command line parameter.  This would be
  758.       indicated by the extension of either filename not being the
  759.       correct number for that node.
  760.     - You're running Ezycom, and haven't set:
  761.       'Messages > Misc > Old style MSGTMP'
  762.       to "NO" in your BBS configuration. Fix it!
  763.  
  764.  
  765.   I'm using Ezycom, and the editor appears to work, but the message
  766.   doesn't get saved properly, and/or there is no text to quote.
  767.     You haven't set 'Messages > Misc > Old style MSGTMP' to "NO" in
  768.     your BBS configuration. Fix it!
  769.  
  770.  
  771.   The editor only works on node 1.
  772.     You aren't correctly passing the node number to the editor.  Make
  773.     sure that you have the /N*N parameter on the editor command line.
  774.     Alternatively, you have incorrectly setup the command line for
  775.     your other node(s).
  776.  
  777.  
  778.   I get a run-time error when I try to do a shell-to-dos (alt-J) from
  779.   inside the editor.
  780.     There is not enough free memory to do a shell after the editor has
  781.     loaded.  If you want to shell to dos, exit the editor first &
  782.     shell from within your BBS software.  (remember to save the users
  783.     message first..)  Alternatively, enable the memory swap when the
  784.     editor is loaded (if you haven't already).
  785.  
  786.  
  787.   The paragraph reformat routine (Ctrl-D) leaves some of the quote
  788.   prefix (usually the initials) in the paragraph when I run it on
  789.   quoted lines;  or the reformated paragraphs don't line up with
  790.   unformated ones.
  791.     The quote prefix has a space between the initials and the ">", or
  792.     is missing a space before and/or after the quote prefix.  Go to
  793.     your BBS setup and change the quote prefix to: " @> " or " > "
  794.      ie. a space, the initials (optional), a greater than sign, then
  795.     another space.  This is the (unofficial) fidonet standard as
  796.     defined in FSC-0032.TXT.
  797.  
  798.  
  799.   There aren't enough lines available for editing big messages, and it
  800.   occasionally puts annoying 'unregistered' taglines on my messages!
  801.     Simple solution. Register!
  802.  
  803.  
  804.   Why is it called 'Tide'?
  805.     'tide' is 'edit' backwards. Get it? (-:
  806.  
  807.  
  808.   Can I use it with a BBS system other than Ezycom, RA, QuickBBS or
  809.   SuperBBS??
  810.      Yes, if your BBS software uses the RA/QuickBBS system of external
  811.     editor handling.
  812.      That is, 3 files in the CURRENT directory:
  813.     DORINFO1.DEF - standard drop file containing line/user info
  814.     MSGTMP.  - (no extension) An ascii file.  If it exists when the
  815.                editor loads, it will contain the quoted text.
  816.                When the editor exits, this file will contain the
  817.                saved message (or not exist if message aborted)
  818.                (The name of this file can be overridden on the
  819.                 command line - see /F in command line parameters)
  820.     MSGINF.  - (no extension, optional)  A text file containing
  821.                message information:
  822.                line 1: Who the message is FROM
  823.                line 2: Who the message is TO
  824.                line 3: Message subject
  825.                line 4: Message number }   Where message is being
  826.                line 5: Message area   }   posted. (not used in editor)
  827.                line 6: Private flag ("YES" or "NO")
  828.      If your BBS software does not support this method of using the
  829.     external editor, there may be 3rd party utilities to make your
  830.     system 'emulate' them.
  831.      Of course it will also work with other BBS systems using Ezycom's
  832.     advanced FSE handling, but I don't know of any at the moment! (-:
  833.  
  834.  
  835.   I want it to load faster! -
  836.     - Put the editor in a RAMDisk.  Even over a network, this will
  837.       usually decrease load time significantly.  Putting it in a local
  838.       ramdisk on each machine on your network will make the most
  839.       difference.  The editor doesn't care where it gets loaded from,
  840.       so you can have multiple copies on different machines.
  841.       Alternatively, if you don't want to/can't have a RAMdisk on each
  842.       machine in your network, then having a copy on each machine's
  843.       local hard drive will still speed things up.
  844.  
  845.     - Try disabling the memory swap when the editor loads.  (this
  846.       usually involves removing the *M from the command line).  This
  847.       will make a noticeable difference especially if your system
  848.       swaps memory out to disk.
  849.        This may or may not work, depending on how much memory your OS
  850.       & BBS software uses up.  Try it, and if the editor runs
  851.       reliably, then leave it that way!
  852.        In most cases, Tide WILL run without a memory swap.  However, a
  853.       Dos-shell from within the editor when the BBS is not swapped out
  854.       will not leave much memory for the shell.  You have been warned!
  855.  
  856.  
  857.  
  858.  
  859. ======================================================================
  860.  8 - Credits & Support/Beta sites
  861. ======================================================================
  862.  
  863.    Many thanks go to the following people for beta-testing, bug
  864.   hunting, many suggestions & general hassling:
  865.  
  866.    Dave Chapman     (The Web BBS)
  867.    Peter Davies     (Author of Ezycom)
  868.    Darren Gibbs     (Way Out West BBS)
  869.    Simon Phillips   (Zzap BBS)
  870.    Scott Farrell    (Blue Marlin BBS)
  871.    Phillip Dean     (Eagle's Nest BBS)
  872.    Robert Wilson    (Restless BBS)
  873.    Alistair Simpson (Satellite BBS)
  874.    Neil Lees        (Altered Reality)
  875.  
  876.  
  877.   Support/Beta test sites -
  878.    The latest version of Tide should be available from any of the
  879.   following BBS systems.  It should also be available on any other
  880.   Ezycom support site.  It is also being distributed via the Ezycom
  881.   file distribution network.
  882.  
  883.   The Web            61-2-528-5941  (Dave Chapman)
  884.   Way Out West       61-2-628-8888  (Darren Gibbs)
  885.   Restless           61-45-76-6185  (Robert Wilson)
  886.   Blue Marlin        61-47-76-1211  (Scott Farrell)
  887.   Altered Reality    61-3-887-2115  (Neil Lees)
  888.  
  889.  
  890.  
  891.  
  892. ======================================================================
  893.  9 - Contacting the author
  894. ======================================================================
  895.  
  896.    If you have any suggestions or comments about Tide, then feel free
  897.   to contact me.
  898.    If you are having problems with it, PLEASE read the Problems/FAQ,
  899.   and check your setup.  I don't like to tell people to RTFM! (-:
  900.    When reporting a problem, please give me as much information as
  901.   possible, including the version number that you are using.  If the
  902.   problem results in a run-time error, please tell me the error code &
  903.   procedure name that are displayed by the error handler.  Telling me
  904.   only "It doesn't work!" is not very helpful in fixing the problem!
  905.  
  906.    I can be contacted as 'Errol Smith' in the Ezycom_Utilities,
  907.   Ezycom_Support & Ezycom_Development fidonet echoes.  The
  908.   Ezycom_Utilities echo is the preferred echo.  Please do not post in
  909.   the other areas unless you do not receive the Utilities echo.
  910.   (Utility support is technically off-topic in the other echoes).
  911.  
  912.    Netmail/crashmail to my point address: (preferred)
  913.  
  914.     Errol Smith, The Web BBS, 3:712/523.5 (fidonet)
  915.  
  916.    Or netmail/crashmail to 'Errol Smith' at The Web BBS:
  917.  
  918.     Line 1: 61-2-528-5941  (v34, Mailer, Crashmail)
  919.     FidoNet   - 3:712/523
  920.     Adventure - 169:3005/2
  921.     WorldNet  - 61:9600/350
  922.  
  923.    E-mail:
  924.     errol@ros.com.au
  925.  
  926.    World Wide Web:
  927.     http://www.ros.com.au/~errol/tide.html
  928.  
  929.    Or via snail-mail (post) to:
  930.  
  931.     Errol Smith
  932.     PO Box 119
  933.     Round Corner, NSW, 2158
  934.     Australia
  935.  
  936.  
  937.  
  938.  
  939.