home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / telecomm / ansi190 / ansi190.doc < prev    next >
Text File  |  1992-03-27  |  21KB  |  434 lines

  1.  
  2. ANSITerm                                                 By Timothy Miller
  3. Version 1.9                                            Two Worlds Software                               
  4. Documentation by Timothy Miller & Sean Dougherty
  5.  
  6. (c) Copyright July, 1992 Timothy Miller, Two Worlds Software
  7.  
  8.  NO PORTION OF THIS PROGRAM MAY BE MODIFIED, DISASSEMBLED, DECODED, 
  9.  OR REMOVED BY ANY MEANS WITHOUT PRIOR PERMISSION OF THE AUTHOR.
  10.  NO PORTION OF THIS PROGRAM MAY BE USED IN ANY OTHER PROGRAM.  THE
  11.  ABOVE ALSO APPLIES TO THE FONT FILE INCLUDED WITH ANSITERM.
  12.  ALL OTHER RIGHTS RESERVED.
  13.  
  14.  THE USER IS AUTHORIZED TO USE THE PROGRAM ANSITERM.  HE HAS
  15.  PERMISSION TO DISTRIBUTE THIS PROGRAM, AT NO COST.  NO PROFIT MAY BE
  16.  DERIVED OUT OF THE SALE OF THIS PROGRAM WITHOUT THE SPECIFIC 
  17.  PERMISSION OF THE AUTHOR.  
  18.  
  19.  THE USER IS PERMITTED TO USE THE ANSITERM PROGRAM FOR A TRIAL PERIOD 
  20.  OF THIRTY DAYS, AFTER WHICH TIME, THE USER MUST SEND THE $15 
  21.  REGISTRATION FEE TO THE ADDRESS LISTED BELOW.  IF, AFTER THIRTY DAYS,
  22.  THE USER HAS NOT REGISTERED ANSITERM, ANSITERM MUST BE REMOVED FROM
  23.  HIS COMPUTER SYSTEM.  PIRACY IS NOW A FELONY!
  24.  
  25. The author, Timothy Miller, can be contacted as:
  26.       Timothy Miller             - Excalibur II BBS (813)988-2603
  27.       Timothy Miller             - Flea Infested BBS (813)989-8564
  28.       T.MILLER23                 - GEnie
  29.       tmiller@suntan.ec.usf.edu  - Internet
  30.       millert@eggo.csee.usf.edu  - Internet
  31.         
  32.  
  33. The following files are part of the ANSITerm package:
  34.    ANSI190.PRG
  35.    ANSI190.DOC
  36.    FONT48.DAT
  37. These files MUST be included.  All other files are optional, except 
  38. XYZ which is necessary for file transfers.
  39.  
  40. ANSITerm's Features (* = New to version 1.5B, % = Updates for v. 1.8)
  41.                     (& = Updates for v. 1.9)
  42.  
  43.    - ANSITerm is a 100% ANSI VT-102 compatible terminal program that 
  44.      supports full 16 colors, blinking text, with 80 columns.
  45.    - Supports X-modem, Y-modem, and Z-modem transfers (using XYZ.TTP)
  46.    - Full mouse support and menu bars
  47.    - AutoDialer with separate options (line-feeds, local echo, etc.)
  48.      for every entry.
  49.    * Capture buffer with the ability to send and print selected blocks
  50.    * Selectable color palettes
  51.    * New intelligent memory saving techniques
  52.    * View Buffer and block functions
  53.    * Auto Z-modem Download and Upload
  54.    * Ten 79-character global macros
  55.    * Upload/Download paths can be set along with the path of XYZ.TTP
  56.    % Better compatibility with Warp 9
  57.    % "Can't find XYZ.TTP" bug fixed.
  58.    % Properly supports VT-100 tabs
  59.    % Supports Y-modem G with Alan Hamilton's XYZ 2.02
  60.    % Buffer viewer now has PRIMITIVE editing capabilities
  61.      and displays text 4 times faster
  62.    % 57600 bps MIGHT work on an Atari TT
  63.    % Terminal displays text at least 2 times faster
  64.    & ANSITerm now supports underlined text
  65.    & Type-ahead buffer now takes up the entire width of the top line
  66.    & Buffer editor Delete Block bug fixed.
  67.    & An escape character can now be typed into the editor (HELP key)
  68.    & Character for <CR> (#13) in font has been changed to something 
  69.      meaningful.  Character for <LF> (#10) has been shifted right
  70.      by one pixel so it doesn't jam up against the new <CR>.
  71.    & The dialer will now properly dial all 14 telephone number
  72.      digits.
  73.  
  74.    NOTE:  The filename of the dialer and options file that is loaded
  75.  when you run the ANSI190.PRG program is STILL "ANSIDIAL.15B".
  76.  
  77.    NOTE ALSO:  When going to a file selector, ANSITerm will sometimes
  78.  appear to lock up.  Just try hitting a few mouse buttons and the
  79.  file selector should appear.  A similar situation occurs sometimes
  80.  when exiting ANSITerm.
  81.  
  82. ShareWare Info
  83.  
  84.       This program is shareware and I have put much time into making this
  85.  into the best terminal program possible. If you use and like this program,
  86.  please support the author and allow him to make future upgrades by sending
  87.  a $15 donation or more to:
  88.  
  89.        Timothy Miller
  90.        7519 Winging Way Drive
  91.        Tampa, FL  33615-1519
  92.        U.S.A.
  93.  
  94.        Please make checks payable to Timothy Miller.  All users in the 
  95.        U.S.A. who register CAN REQUEST free updates by mail.
  96.  
  97.  
  98. File Transfers
  99.  
  100.      File transfers can be accomplished through the use of Alan Hamilton's
  101.    XYZ file transfer program. I have found no way to keep the program
  102.    in memory and call it when needed, so ANSITerm must load it each time
  103.    you transfer a file.  For hard-drive users, this is not a problem 
  104.    since ANSITerm remembers where XYZ is, but for floppy disk users, it
  105.    requires extra effort.  ANSITerm will not allow you to swap floppys 
  106.    (load XYZ from one and transfer to/from another) so the use of a RAM 
  107.    disk is recommended for this purpose.  You can set ANSITerm to load 
  108.    XYZ from the ramdisk.  (With a one floppy system, telling ANSITerm to
  109.    load XYZ from drive B: may have unpredictable results if ANSITerm is
  110.    loaded from Medium Res.  The alert box may not display right.  Try it
  111.    at your own risk.)
  112.  
  113. Menu Bars
  114.  
  115.       To select a menu, click on the title.  To make it go away, click
  116.    on the title again, outside of the window or on another title.
  117.  
  118. Auto DIALer Menu
  119.  
  120.        To select a slot that has not been selected, click anywhere on the 
  121.     line except for the field which says DIAL.
  122.  
  123.     To insert a one-second pause in any editing fields sent to the modem, 
  124.     press [F10].  This works for all macros.  To insert a pause into
  125.     the phone number, most modems require a comma.
  126.  
  127.     |DIAL|
  128.       If you click on DIAL on any line which has not been tagged for
  129.       group dial, that slot will immediately be selected, the dialer 
  130.       will go away, and the telephone number listed in that 
  131.       slot will be dialed.  If that slot has been tagged for group
  132.       dial, the dial cycle will begin.
  133.     |J|   (group dial)
  134.       If you click in the small field between DIAL and the name field
  135.       of a selected slot, that field will be tagged for group dial.  If
  136.       you click in that field again, the slot will be untagged.
  137.     |BBS Name       |
  138.       The next field to the right is the name field.  Click here to
  139.       edit.  Left and right arrow keys move the edit cursor left and
  140.       right.  Delete removes the character that the cursor is on and
  141.       moves all characters to the right left to fill in the space.
  142.       Backspace deletes the character to the left of the cursor and
  143.       moves all characters at the right of the cursor to fill in the 
  144.       space.
  145.     |I|
  146.       Initialize string.  This allows a string containing optional
  147.       modem commands to be sent to the modem before the command to
  148.       dial is sent.
  149.     |Phone number|
  150.       To the right is the phone number field.  Click here to edit the
  151.       phone number as you would for the name field.
  152.     | Baud|
  153.       Click here repeatedly until the baud rate you want is displayed.
  154.       The baud rate numbers have been shortened to provide greater space,
  155.       and the numbers are the baud rate divided by one hundred.
  156.     |Options      |
  157.       Each column of this field corresponds directly to an option in the
  158.       options menu, essentially the same order.  They are also listed
  159.       in the help menu.  The meanings of the symbols are listed with
  160.       the OPTN menu information in this manual and below:
  161.          W:  End of line wrap             B:  Destructive back space
  162.          E:  Local Echo                   A:  Application mode
  163.          R:  Cursor Application mode      N:  New line and line feed mode
  164.          G:  IBM Extended Character Graphics Set
  165.          L:  Enable blink
  166.       ZYKXCG:  Transfer protocol
  167.              Z:   Z-modem
  168.              Y:   Y-modem (batch)
  169.              K:   X-modem 1k
  170.              X:   X-modem (standard)
  171.              C:   X-modem checksum
  172.              G:   Y-modem G  (for use with error correcting modems)
  173.          C:  Capture enable               F:  Filter ANSI codes
  174.          Y:  Type-ahead buffer
  175.     | F1: | F2: | F3: |  Macros
  176.       There are 3 44-character macros for each slot in the dial menu.
  177.       To edit one, select a slot, and click on the macro you want to 
  178.       edit.  Edit as you would for the BBS name.  A return character is 
  179.       NOT automatically transmitted at the end of the macro, so you must 
  180.       put one in manually, by pressing the Enter key on the numeric
  181.       keypad.  In fact, any non-printing character (<ESC>, LF, FF, etc.)
  182.       can be entered into the macro editing field and transmitted as part
  183.       of the macro.  To transmit the macro while on-line, press the
  184.       function key corresponding to the macro you wish to send. To insert
  185.       a one-second pause, press F10 in the editing field where the pause
  186.       is needed.
  187.  
  188. Options (OPTN) Menu
  189.  
  190.     End of line wrap
  191.        With this option off, any character printed at the right most 
  192.        column will overwrite any character at that position without 
  193.        wrapping to the next line.
  194.     Destructive backspace
  195.        When this mode is on, if a backspace character is received,
  196.        the cursor will back up one column and erase any character at
  197.        that position.  If this is not selected, the cursor will back 
  198.        up on column, but not erase any character there.
  199.     Local Echo
  200.         When this option is selected, any keys that you press will be 
  201.         automatically displayed on the screen as well as transmitted. 
  202.         (half duplex mode)
  203.     Application mode
  204.         If this mode is on, the keys on the numeric keypad will send 
  205.         ANSI escape sequences instead of the characters which appear 
  206.         on the keytops.
  207.     Cursor key application mode
  208.         The cursor keys normally send ANSI escape sequences to the
  209.         modem when pressed.  If this option has been selected, a
  210.         different set of escape sequences will be transmitted by
  211.           the same keys.
  212.     New-line and line feed mode
  213.         If this option is selected, linefeed implies both return and 
  214.         linefeed, and the return key sends both return and linefeed.
  215.     IBM Extended Character Graphics Set
  216.         If this mode is on, any characters with a value greater than 
  217.         127 will cause graphics characters to be displayed.  If this 
  218.         mode is off, any such characters will have their most significant 
  219.         bit stripped.  This is for boards and on-line services that 
  220.         insist on using set or even parity.
  221.     Enable blink
  222.         When this is selected, all characters that have been printed 
  223.         with the blink attribute set will flash on and off at regular 
  224.         intervals.
  225.     Dial Command
  226.         When you click on this, you can edit the command that ANSITerm
  227.         sends to the modem to make it dial.  For example, "ATDT" for
  228.         tone dial, "ATDP" for pulse dial, or "ATDT70#," for tone
  229.         dial, call waiting off, and the comma for a pause.
  230.     RTS/CTS
  231.         Enables RTS/CTS hardware flow control. Most ST users require
  232.         a fix program for this to operate properly.         
  233.     Dial timeout
  234.         This allows you to set the number of seconds the cycle dialer
  235.         waits before skipping to the next board selected for group
  236.         dial. Click on this line to edit. If a 0 (zero) is entered,
  237.         NONE is displayed and the cycle dialer will wait until either
  238.         the modem or the user tells it to skip to the next selected
  239.         slot.  
  240.     Edit Macros
  241.         Allows you to edit the 10 global macros.  Shift and a function
  242.         key selects the macro to be edited (RETURN lets you finish 
  243.         editing), and <ESC> lets you exit back to the terminal.  To 
  244.         insert a one-second pause into a macro, press the F10 key.  To 
  245.         transmit a macro, hold the shift key and press a function key.  
  246.         The Alternate-M key combination also starts the macro editor.
  247.     Set Loadup Macro
  248.         When ANSITerm is first booted this macro is sent to the modem,
  249.         unless the DCD (Carrier Detect) line is high. 
  250.     Quit
  251.         Selecting this causes ANSITerm to exit to the program which
  252.         called it (or the GEM Desktop).  This can also be selected by
  253.         pressing the UNDO key.
  254.     o The OPTN menu will not go away if you select one of the options
  255.       so you have the chance to select or deselect more than one option
  256.       before clicking outside of it to remove it from the screen.
  257.  
  258. Select BAUD Menu
  259.  
  260.        You can click in this menu to select your baud rate.  38400 bps 
  261.    and 57600 bps are supported, but reliable operation cannot be assumed.
  262.  
  263. FILE Menu
  264.  
  265.    Download
  266.        Loads XYZ from disk (or RAMDISK) to transfer a file.  If 
  267.        Z-modem or Y-modem is selected, transfer will start immediately 
  268.        to the folder you select with the Set D/L Path option.  If
  269.        any other protocol is selected, you will immediately get a
  270.        file selector.  This can also be selected with the Alternate-D
  271.        key combination.
  272.    Upload
  273.        Loads XYZ just as Download, but it always gives you a file 
  274.        selector so that you can select the file to be uploaded (or 
  275.        wildcard for Z-modem or Y-modem).  This can also be selected 
  276.        with the Alternate-U key combination.
  277.    Z-modem, etc.
  278.        Click on one of these to select which protocol you want to use
  279.        at the moment.  As with the OPTN menu, this menu will not go
  280.        away if you select one of the protocols, so you can immediately
  281.        select upload or download without having to reselect the menu.
  282.    Save Dialer/OPTN
  283.        Saves the contents of the DIAL menu, the default download path,
  284.        and the Dial timeout to disk.  If you are using floppy disks
  285.        and running XYZ from a RAMDISK, be sure to save to the floppy disk.
  286.        This also saves the options download/upload path, dial
  287.        timeout, buffer size, delay timing, dial command, buffer
  288.        installed/uninstalled status, color palette number, Loadup Macro,
  289.        baud rate setting, RTS/CTS status, CR/LF filter status, Auto
  290.        Z-modem selected/deselected, and the ten global macros. 
  291.    Load Dialer/OPTN
  292.        Loads a dialer from disk and the options with it.  ANSITerm can
  293.        indirectly support more than one dialer menu and set of options 
  294.        this way.
  295.    Set D/L Path
  296.       This allows you to pre-set the path to which Z-modem and Y-modem
  297.       downloads will be saved.  Clicking here will give you a
  298.       file selector.
  299.    Set U/L Path
  300.       This allows you to pre-set the path to which uploads will be
  301.       directed.  Clicking here will give you a file selector.
  302.    Set XYZ Path
  303.       This is the path of the program, XYZ.TTP, to enable ANSITerm's
  304.       download and upload options.
  305.    Auto Z-modem
  306.       This selection gives ANSITerm the ability to detect Zmodem uploads
  307.       and downloads independant of XYZ. If either an upload string or
  308.       download string is detected, ANSITerm immediately runs XYZ if this
  309.       function is on.
  310.  
  311.  
  312. Capture Buffer (BUFR) menu
  313.  
  314.       If the buffer becomes 75% full, the 'Bufr' menu will change to
  315.    '75%+'.  If, while transmitting the buffer, you suspend sending
  316.    by pressing Alternate-S, the menu will change to 'Suspnd'.  
  317.    If the buffer fills completely, the menu will change to 'Filled'.
  318.  
  319.    Install Buffer
  320.       Allocates the amount of memory specified by the Bufsize editing
  321.       field and makes it available for capturing modem input, screen
  322.       snap-shots, and loading files from disk for transmit or editing.
  323.    Capture
  324.       When selected, all characters that come from the modem will be
  325.       added to the buffer.
  326.    Filter ANSI
  327.       In this mode, all ANSI escape sequences are filtered out and
  328.       only ASCII text may be added to the buffer.
  329.    Load buffer
  330.       Clears the buffer and loads the specified file into it.
  331.    Save buffer
  332.       Saves the current contents of the buffer to disk.
  333.    Clear buffer
  334.       Empties the buffer.
  335.    Print buffer
  336.       Sends the current contents of the buffer to the printer.
  337.    Send buf
  338.       Sends the current contents of the buffer to the modem and filters
  339.       linefeeds and/or carriage returns according to the setting in
  340.       Edit Buffer. 
  341.    Bufsize
  342.       You can edit this field if the buffer is NOT installed to 
  343.       change the size of the buffer.  To change the buffer size, 
  344.       you must not have a buffer installed.
  345.    Delay
  346.       This specifies the time (in 1/200 second units) that Send Buf
  347.       (and send block from the buffer editor) waits between characters 
  348.       while sending data.
  349.    FreeMem
  350.       This is not an option but rather a window that tells you how much 
  351.       free memory you have.
  352.    Used
  353.       This also not selectable, but tells you how many bytes have been 
  354.       added to the buffer.
  355.    Type Ahead
  356.       This activates the type ahead buffer. The buffer can contain up to
  357.       512 ASCII characters and control characters. The Keypad Enter will 
  358.       insert <CR> (and <LF> if NewLine/Line Feed is on), the [HELP] key 
  359.       transmits the buffer contents without a <CR> and the optional <LF>,
  360.       [F10] will insert a one second pause (this also works for the
  361.       various other editing fields that output to the modem), Up arrow
  362.       moves to the beginning, and the down arrow moves to the end.
  363.    Edit Buffer
  364.       This option switches to the edit buffer screen.  ALT-V also 
  365.       activates this.
  366.         Keys: [ESC] - Quits Edit Buffer mode, 
  367.               [HELP] - types an escape character.
  368.               [UP/DOWN/LEFT/RIGHT ARROW] - Moves cursor, 
  369.               Shift-Up - Pages Up, and  Shift-Down - Pages Down
  370.            ^A=Redraw screen   ^T=Top of buffer  ^F=Bottom of buffer
  371.            Blocks:   ^B=Begin  ^E=End  ^U=Hide  ^S=Transmit  ^P=Print
  372.                      ^D=Delete
  373.            Filters:  ^R=Return  ^L=Line Feed
  374.        IMPORTANT: These functions filter Returns and Linefeeds out 
  375.                the selection to transmit in the editor and ALSO from the 
  376.                complete buffer contents send from the terminal screen.
  377.   At the request of one of my betatesters who wanted to manually enter
  378.   ANSI escape sequences into the buffer editor, I have made the HELP
  379.   key type an escape character into the buffer.
  380.  
  381. HELP menu
  382.  
  383.       This menu has no selections.  It gives an abridged list of
  384.    the dialer options and short-cut key combinations.
  385.    Special key combinations available:
  386.    F1 to F3     Send macros corresponding to the current dialer slot
  387.                 selections.
  388.    F5           Resets printing colors to white text, black
  389.                 background, no blink, not bold, etc. for all
  390.                 characters received after this is selected, until
  391.                 an ANSI escape sequence is received that changes
  392.                 the colors.
  393.    F6           Prints the contents of the screen to the printer.  If 
  394.                 the printer is off-line, you will hear a bell ring.
  395.                 This does not print a bit-map of the screen, but
  396.                 rather the actual letters.  Bold is emphasized (bold), 
  397.                 and blinking is italicized.  Drop-down menus will not
  398.                 be printed even if they are down when F6 is pressed.
  399.    F7           Capture screen contents to the buffer
  400.    F8 or Alt-H  Causes the modem to drop carrier.
  401.    F10          Inserts a one second pause into an editing field.
  402.    Alt-D        Download               Alt-U        Upload
  403.    Alt-C        Capture                Alt-T        Send Buffer
  404.    Alt-S        Suspend Send           Alt-Y        Type-ahead
  405.    Alt-V        Edit Buffer            UNDO         Quit ANSITERM
  406.    Alt-M        Edit Global Macros     HELP         (see Type Ahead buffer)
  407.    Clr/Home     Clears the Type-Ahead Buffer
  408.  
  409. COLR menu
  410.    There are 4 selectable color palettes.  Palette #1 is the default,
  411.    unless you save the dialer file while another palette is enabled.
  412.  
  413. Other
  414.  
  415.    A yellow "C" on a red background will appear in the upper right corner 
  416.    if CAPS LOCK is on.
  417.  
  418. Acknowledgments
  419.  
  420.      I would like to thank the following people for testing ANSITerm
  421.    for me:
  422.        Sean Dougherty (another member of Two Worlds Software)
  423.        B.J. McKinney (SysOp of The Flea Infested BBS -- (813)989-8564)
  424.        Clifton Mothershed
  425.        Conan Ford (In Canada!)
  426.        
  427.      And we can't forget plaudits to Alan Hamilton for his XYZ file
  428.    transfer utility.  Be sure to register this too!
  429.  
  430. The official TWS support BBS
  431.       Excalibur II BBS -- (813)988-2603
  432.       SysOp: Aaron Oneal
  433.  
  434.