home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1993 #2 / Image.iso / ham / hamlet31.zip / HAMLET31.DOC < prev    next >
Text File  |  1993-05-09  |  16KB  |  338 lines
  1.                    HamlET - A Ham Radio terminal Program
  2.                        By Paul B. Schou - KE6ET
  3.                         Copyright (c) 1991-93
  4.  
  5.     HamlET v 3.1 is Freeware. Use it and share it (noncommercially) freely.
  6.  
  7.  
  8. Features:
  9.    I wrote HamlET because I wanted some things I couldn't find in other
  10.    packet terminal programs. I wanted a small program that would run on
  11.    a single floppy and still have room to save data. I wanted a program
  12.    that would runs when it is called without having to bother with
  13.    "Press any key to continue." or other intermediate steps.
  14.    I also wanted the ability to run under DesqView or other multitasking
  15.    software. Lastly I wanted the ability to use Comm ports one through
  16.    four and be able to select IRQ's for ports three and four.
  17.  
  18.    HamlET does those things on an uncluttered split screen display. It also
  19.    can save or send ASCII files, print received stuff,
  20.    set the TNC clock and scroll the receive window. HamlET can also be
  21.    configured to call your favorite editor and logging programs. HamlET
  22.    also uses the SHIFT-F and CTRL-F keys to send sets of user definable
  23.    commands or messages. This feature is especially useful with multimode
  24.    TNC's.
  25.   
  26.  
  27. For The Impatient:
  28.    Switch to the drive/directory where HamlET.EXE is located and type
  29.                            hamlet
  30.    If you are using 1200 Baud between the TNC and the computer and your TNC
  31.    is connected to Comm 1, HamlET will run. If it doesn't read on.
  32.  
  33. The Configuration File:
  34.    A configuration file named HAMLET.CFG allows the user to select Comm
  35.    ports and Baud rates as well as send commands to the TNC. This file must
  36.    be in the same Drive/Directory as HAMLET.EXE.
  37.  
  38.    If the program doesn't find HAMLET.CFG on start up it will tell you so and
  39.    will default to COMM 1 and 1200 Baud. The same defaults will be used if the
  40.    program doesn't like the numbers in the HAMLET.CFG file. You'll be told if
  41.    the numbers are wrong.
  42.  
  43.    HAMLET.CFG consists of lines of information: A typical file looks like this:
  44.  
  45.     1           [Line 1 - Comm Port]
  46.     1200        [Line 2 - Baud Rate]
  47.     4           [Line 3 - IRQ]
  48.         ted.com
  49.         logger.exe
  50.         + Xflow Off
  51.         + MAIL OFF
  52.         + MY KE6ET
  53.         = [Time]
  54.         - MAIL ON
  55.         - CT The terminal is off.
  56.         + CT The terminal is on. Use CTRL-G to ring my bell.
  57.         [LAST LINE]
  58.  
  59.    The wording of the comments inside the brackets [ ] is optional as are 
  60.    the brackets BUT there must be something there. Anything will work as
  61.    long as its separated from the number by a few spaces. This applies to 
  62.    the first three lines and the Equal (=) sign line. The last line must
  63.    also have something in it that isn't a + - or = sign.
  64.  
  65.    The first line is the Comm Port. 1, 2, 3, or 4 are acceptable. If
  66.    you use ports 3 or 4 be sure to read the discussion in the Comm Port 
  67.    paragraphs.
  68.  
  69.    The second line is the Baud rate between the computer and the TNC. HamlET
  70.    will operate with Baud rates of 300, 1200, 2400, 4800 or 9600. 
  71.  
  72.    The third line is the IRQ or Interrupt Request. This should be set to 4
  73.    if Comm Port 1 is used and 3 if Comm Port 2 is used. See the discussion
  74.    in the Comm Port paragraphs for more detail on the IRQ's for Comm Ports
  75.    Three and Four.
  76.  
  77.    The fourth line is used to identify an Editor or other program that can be
  78.    called while in HamlET. Put the program name in this line. Be sure to
  79.    include the .COM or .EXE extension. If the program is not in the Path
  80.    include the full pathname. If you plan to use an Editor to prepare packet 
  81.    messages make sure you use an ASCII editor. DesqView users should read the 
  82.    DesqView paragraphs.
  83.    NOTE: IF YOU DON'T USE THIS FEATURE LEAVE THE FOURTH LINE BLANK.
  84.  
  85.    The fifth line is used to identify a Logging or other program that can be
  86.    called while in HamlET. Put the program name in this line. Be sure to
  87.    include the .COM or .EXE extension. If the program is not in the Path
  88.    include the full pathname. DesqView users should read the Desqview
  89.    paragraphs.
  90.    NOTE: IF YOU DON'T USE THIS FEATURE LEAVE THE FIFTH LINE BLANK.
  91.  
  92.    The rest of the file lines are sent to the TNC when the program is
  93.    started or exited.
  94.  
  95.    If you want your TNC clock set to the computer clock on start up, put this
  96.    line in the .CFG file;
  97.    = Time 
  98.  
  99.    On start up any TNC command may be sent by preceding the command with a 
  100.    plus sign (+). Thus the line;
  101.    + CT The terminal is on.
  102.    sets CText to "The terminal is on."
  103.  
  104.    When you exit the program any line preceded with a minus sign (-) will
  105.    be sent to the TNC. Thus;
  106.    - CT The terminal is off.
  107.    sets CText to "The terminal is off."
  108.  
  109.    Any number of + and - lines may be included in the HAMLET.CFG file as long
  110.    as they are after the fifth line. The + and - lines may be intermingled.
  111.  
  112.    A sample HAMLET.CFG file is included in HAMLET.ZIP. Edit the file with any
  113.    ASCII editor or word processor to reflect your configuration. If you use a
  114.    non ASCII word processor to create or modify the .CFG file be sure to save
  115.    it as an ASCII file.
  116.  
  117.  
  118. Setting the TNC parameters:
  119.    HamlET is designed to work with the default parameters of most TNC's.
  120.    These settings are changes from typical default settings.   The first 
  121.    five are  the most important.
  122.  
  123.      Parameter       Setting
  124.         Xflow          OFF      HamlET uses hardware flow control. Xflow
  125.                 must be off to avoid conflicts. The serial
  126.                 cable must be a standard cable. A three wire
  127.                 cable might not work in overflow situations.
  128.  
  129.      CMSg        ON    If you want CT messages sent when someone 
  130.                                 connects, this must be ON.
  131.  
  132.         Echo            OFF     Turning Echo OFF prevents what you send
  133.                 from appearing in the receive window.
  134.  
  135.         Flow            OFF     Turning Flow OFF allows incoming data to
  136.                                 be received while you are typing. HamlET
  137.                 will separate the send and receive data.
  138.  
  139.         LFIgnore        ON      HamlET works with this OFF or ON unless
  140.                                 sending an ASCII file. Turn it ON to be sure.  
  141.  
  142.         NEwmode         ON      Personal preference. I would rather let the TNC
  143.                 switch back to Command mode after a disconnect.
  144.  
  145.         PIdcheck        OFF     If you get a lot of ASCII stuff from Nodes
  146.                                 turn this OFF to eliminate the trash.
  147.  
  148.         STREAMCall      ON      If you allow multiple users, turn this ON to
  149.                 help sort them out.
  150.  
  151.         USers           2 - 10  Allow as many users as you want, up to your
  152.                 TNC's limit.
  153.  
  154.  
  155. Using HamlET
  156.    HamlET features a split screen display. The top two thirds is the Receive
  157.    window. Any incoming data will appear in the Receive window. Data that has
  158.    scrolled off the receive window can be reviewed by using the PgUp and PgDn
  159.    keys. Pressing End returns from the Scroll mode to the normal Receive mode.
  160.    The bottom third is the Send window. Anything typed in the Send window is
  161.    immediately sent to the TNC. Limited editing capabilities are available by
  162.    using the backspace key. The windows are separated by a double line with
  163.    the computer time running on the right side. The bottom line or prompt line
  164.    shows what some function keys do.
  165.  
  166.    F1-Help
  167.       F1 Brings up a small help menu that gives a little more information
  168.       about the special keys. You probably won't need this too often.
  169.  
  170.    F2-Print
  171.       If a printer is connected to printer port 1, F2 will start the
  172.       printer. If the printer is not on or if the program detects a printer
  173.       error you will hear a beep. If the printer is OK the word "Print" in
  174.       the prompt line will flash. Anything received from the TNC will now be
  175.       printed as well as appearing in the Receive window. Pressing F2 a second
  176.       time will turn the print function off and "Print" will stop flashing.
  177.  
  178.    F3-Save
  179.       F3 is used when you want to save incoming information to an ASCII file.
  180.       Pressing F3 will open a small window that asks you to name the file
  181.       that information is to be saved to. You may include a full path and
  182.       file name. If you just input a file name the file will be saved in the 
  183.       current directory. If the file exists HamlET APPENDS data to the end of
  184.       the file. If the file doesn't exist HamlET will create a new file.
  185.       The word "Save" in the Prompt line will flash while data is saved.
  186.       Press F3 again to stop saving.
  187.  
  188.    F4-Send
  189.       F4 is used to send prepared ASCII text files to the TNC. The files
  190.       can consist of commands for the TNC or text to be sent to another
  191.       station. Pressing F4 will open a small window that asks you for a file
  192.       name. Enter the file name that you want to send. This feature is useful
  193.       for sending prepared messages or for sending brag tapes. For instance
  194.       a file named QTH could send your name and address. You may also prepare
  195.       messages or a series of messages to be sent to your local bulletin board.
  196.  
  197.       When you send a file using F4, the transmitted text will appear in the
  198.       Send window and the flashing words "Any Key" will replace "F4-Send" on
  199.       the prompt line. Pressing any key but the Escape key will abort
  200.       transmission of the file. The Escape key will also abort the file
  201.       transmission but it will close the HamlET program which probably is
  202.       not what you want to do.
  203.  
  204.       If the file length exceeds the TNC transmit buffer size, transmission
  205.       from the computer to the TNC will pause. The text in the Send window
  206.       will also pause. Transmission to the TNC and the Send window will
  207.       continue when the TNC buffers are emptied. This is done automatically
  208.       by the programs hardware flow control. Transmission from the TNC to the
  209.       other station can be monitored by observing the TNC status lights. XFLOW
  210.       must be OFF for hardware flow control to operate properly.
  211.  
  212.   F5-Set TNC Time
  213.       Pressing F5 will set the TNC clock to the computer time. This feature
  214.       is an alternative to using the "= Time" line in the HAMLET.CFG file.
  215.       The F5 command is not shown on the prompt line but is in the help menu.
  216.  
  217.   F6-Editor
  218.       Pressing F6 will bring up the editor or other program that you named
  219.       in line four of the hamlet.cfg file.  You may use this function to
  220.       access your favorite editor or use it to bring up a DOS shell. HamlET
  221.       users have found that naming Vern Buerg's LIST.COM in line four, to
  222.       access an editor, provides a powerful tool that can be used for editing
  223.       or file manipulation.
  224.  
  225.       LIST is shareware and Copyright (C) 1983-1991 by;
  226.       Vernon D. Buerg
  227.       139 White Oak Circle
  228.       Petaluma, CA  94952
  229.  
  230.       LIST is available from the author and many land line BBS's including:
  231.       (707) 778-8944    VOR 24-hour bulletin board
  232.       (707) 778-8841    MB  24-hour bulletin board
  233.       (415) 994-2944    VOR South 24-hour BBS
  234.  
  235.       TED.COM a Tiny EDitor developed by Tom Kihlken of PC magazine is included
  236.       in the HAMLET.ZIP file. This is a very efficient editor that uses less
  237.       than 4K of disk space. The documentation for it is also included.
  238.  
  239.   F7-Log
  240.       Pressing F7 will bring up the Logging or other program that you named
  241.       in line five of the hamlet.cfg file.  You may use this function to
  242.       access your favorite logger or any other program that you might want to
  243.       use.
  244.  
  245.  
  246.  
  247.   PgUp-Scroll
  248.       Pressing the PgUp key switches the Receive screen to the Scroll mode.
  249.       Subsequent PgUp or PgDn key presses allow scrolling through the last five
  250.       or six pages. Pressing the End key returns to the receive mode. In Scroll
  251.       mode the Send window and the F2-Print and F3-Save functions remain active.
  252.  
  253.   SHIFT-F1 through SHIFT-F10 and CTRL-F1 through CTRL-F10
  254.       These keys allow access to prepared files.  You may prepare up to 20
  255.       files named SF1.TXT through SF10.TXT and CF1.TXT through CF10.TXT. The
  256.       content of these files will be sent when the corresponding F key is
  257.       pressed while holding the SHIFT or CTRL key. This feature is especially
  258.       useful when using a multimode TNC. A series of commands can be sent to
  259.       configure the TNC for the desired mode.
  260.  
  261.  
  262. Comm Ports
  263.    The PC and it's clones were originally designed to handle only two comm 
  264.    ports. When the need for more serial capability was recognized most PC's
  265.    and/or I/O cards added Comm 3 and Comm 4 at the addresses and using the
  266.    Interrupt Requests (IRQ's) as shown. Most software that uses Comm 3 and 4 
  267.    also expects these addresses and IRQ's.
  268.       
  269.    Port        Base Address    IRQ
  270.  
  271.    Comm1       03F8             4
  272.    Comm2       02F8         3
  273.    Comm3       03E8         4
  274.    Comm4       02E8         3
  275.  
  276.    Unfortunately this causes an immediate conflict between ports 1 and 3 and
  277.    between ports 2 and 4. If a modem is connected to port 1, a mouse to port 2
  278.    and a TNC to port 3 the modem and the TNC will conflict since they share 
  279.    the same IRQ. The associated software cannot tell which port generated the 
  280.    IRQ. At best the program in use will cause problems and at worst the 
  281.    computer will hang up.
  282.  
  283.    There is a way to solve the problem. HamlET allows you to select other
  284.    IRQ's for comm 3 and 4. If your serial I/O board also allows selection of
  285.    other IRQ's (many of them do) all you have to do is pick a number and go.
  286.    
  287.    Be careful picking the number. Stick to 2, 5 or 7. IRQ 2 is usually 
  288.    for a second parallel port. If you are using two printer ports don't use
  289.    IRQ 2. IRQ's 5 and 7 are normally safe if other add-on boards have not 
  290.    usurped the IRQ's. HamlET accepts only IRQ's 2, 3, 4, 5 and 7. Any other
  291.    IRQ numbers will cause an error when the HAMLET.CFG file is read. To make
  292.    HamlET respond correctly first set the I/O board to the desired IRQ and Comm
  293.    Port. Then edit the first and third lines of the HAMLET.CFG file to reflect
  294.    the Port and IRQ numbers.
  295.  
  296.    This procedure applies only to Comm Ports 3 and 4. The IRQ's for Ports 1 
  297.    and 2 are fixed by the program and are not affected by line three of the 
  298.    HAMLET.CFG file.
  299.  
  300. DesqView
  301.    The HamlET program will run in DesqView without problems. Set the memory
  302.    required to 65k.  The best practice is to not use the F6-Editor or the
  303.    F7-Log functions when running in DesqView, but to open your editor and
  304.    logger in another DesqView window. Be sure to configure the serial ports
  305.    in the DesqView PIF file to reflect your configuration.
  306.  
  307. Microsoft Windows
  308.    Several Beta testers have run HamlET in Windows without problems. I
  309.    cannot verify this from personal experience.
  310.  
  311.  
  312. Usual Notices.
  313.  
  314.     HAMLET.EXE, HAMLET.CFG and this document (The Software) are copyrighted by
  315.     Paul B. Schou. The copyright owner hereby licenses you to use and distribute
  316.     the software with these restrictions:
  317.  
  318.     The program shall be supplied in its original, unmodified form, which
  319.     includes this documentation;
  320.  
  321.     For-profit use without a license is prohibited;
  322.  
  323.     The program may not be included, or bundled with other goods or services.
  324.     Exceptions may be granted upon written request only.
  325.  
  326.     No fee is charged; An exception is granted to not for profit user's groups,
  327.     which are permitted to charge a small fee (not to exceed $5.00) for
  328.     materials, handling, postage, and general overhead. No other organization
  329.     is permitted to charge any amount for distribution of copies of the software
  330.     or  documentation, or to include copies of the software or documentation
  331.     with sales of their products.
  332.  
  333.     There is no warranty of any kind. The copyright owner may not be held
  334.     liable for any damages, including any lost profits or other incidental or
  335.     consequential damages arising out of or inability to use the software.  By
  336.     using the software, you agree to this.
  337.  
  338.