termite.1

功能丰富的串口通讯程序

.\" Copyright 1996-1997 Nadav Cohen
.\" This file may be distributed under the GNU Public License, version 2, or
.\" any higher version.  See section COPYING of the GNU Public license
.\" for conditions under which this file may be redistributed.
.TH TERMITE 1 "19 Aug 1997" "User's Manual"
.SH NAME
termite \- terminal program for Linux
.SH SYNOPSIS
.B termite 
[-config] [-other filename] [-dial substring] [-dialindex number]
[-device devicenumber] [-dev devicename] [-baud newbaud]
.SH DESCRIPTION
.B termite
is a serial communication program designed to have the look-and-feel of
famous terminal programs for DOS. Some of the features are an easy to use
phone directory supporting both Telix and Terminate phonebooks, file tagger,
file manager for uploads, EMSI chat, scrollback, image save, log, macros,
configuration menus, ANSI/VT100/AVATAR emulation and many more.
.SH COMMAND-LINE
.B -config
This parameter starts termite in configuration menu only. Meaning that after
you configure the program you will exit and not continue with the terminal.
.PP
.B -other
This parameter starts termite using 'filename' as the configuration file.
.PP
.B -dial
This parameter instructs termite to dial the entry whose name contains
\'substring\' from the current phonebook. A combination between -dial and
-dialindex is possible.
.PP
.B -dialindex
This parameter instructs termite to dial the entry whose index is equal
to number. A combination between -dial and -dialindex is possible.
.PP
.B -device
This parameter starts termite with the device that corresponds to 
devicenumber.
.PP
.B -dev
This parameter starts termite with the default device as "devicename".
.PP
.B -baud
This parameter initiates the current device to newbaud.
.SH USE
Termite is a menu driven program. Almost everything in it is done by
menus so there is no need to write more than is absolutley necessary.
The thought behind termite was to make a terminal program that could give
the Linux user all the options that DOS programs give their's. This thought
created many limitations and some of these limitations are there just because
I am too lazy. Probably the biggest limitation is the inability to run 
termite in an Xterm or Rxvt.

The program splits the screen into two sections, the terminal and a status
line. The terminal allows you to write anything you wish into the modem
by just typing it. A description of the status line and its options is
in section status-line.

Below is a list of all the hotkeys you can use while in the terminal:
.PP
.I Ctrl-Alt-A 
opens a window with all the available hotkeys.
.PP
.I Ctrl-Alt-B 
starts the scrollback feature. For more information about scrollback and
its features read the section about scrollback.
.PP
.I Ctrl-Alt-C
clears the terminal screen and puts the cursor in the top left corner.
.PP
.I Ctrl-Alt-D
starts the phonebook and dialing directory feature. For more information 
about this feature read the section about phonebook and dialing directory.
.PP
.I Ctrl-Alt-E
toggles local echo on and off. After pressing this combo a window appears
telling you what is currently selected.
.PP
.I Ctrl-Alt-H
hangs up.
.PP
.I Ctrl-Alt-I
starts the image save feature. This feature allows you to save the current
screen into a file for later viewing.
.PP
.I Ctrl-Alt-L
toggles capture on or off. If you dialed through the dialer and the current
system has a default capture file set in its entry, then this file is used.
If not, then you are asked to give a file name.
.PP
.I Ctrl-Alt-N
starts the tags sending feature. For more information read the section 
about the tagger.
.PP
.I Ctrl-Alt-W
starts the configuration menu. For more information read the section about
configuration.
.PP
.I Ctrl-Alt-P
lets you change to another device and set the settings for the current 
device. For more information about this menu see the section phonebook
and dialing directory subsection edit about device.
.PP
.I Ctrl-Alt-Q
exits the program without hanging up or resetting the device.
.PP
.I Ctrl-Alt-R
toggles the stripping of the 8th bit on and off.
.PP
.I Ctrl-Alt-T
lets you choose a new terminal emulation.
.PP
.I Ctrl-Alt-V
starts the tagger. For more information read the section about tagger.
.PP
.I Ctrl-Alt-X
exits the program with hangup and resetting of the port.
.PP
.I Ctrl-Alt-Y
toggles the the EMSI chatter on and off.
.PP
.I Ctrl-Alt-Z
sends a break single to the modem.
.PP
Use the home and end keys to control the status line (see status-line).
Use the pgup and pgdn keys to upload and download (see uploading and 
downloading).
.PP
.SH STATUS-LINE
The status line consists of four sections and can be configured in the 
"Status line" option in the configuration menu. The status line is seen
throughout all the menus and screens of the program. However, it does not
update while not in the terminal itself.
.PP
.I Section 1
has three different options. The first option is the "System name"
which shows the name of the system that you are currently connected to. This
name is automatically updated when you call from the dialer and is "Manual mode"
when you do not use the dialer. 
The second option shows the hotkey to display the help screen which shows
all the hotkeys and what they do.
The third option shows the current line status including dsr, dtr, cd, st, sr,
cts and ring. When any of these words is written in lower case that means
that they are currently inactive, and when in uppercase they are active.
For example: If cd is written 'CD' then currently there is a carrier detect.
To switch between options press the HOME key.
.PP
.I Section 2
shows the current active device and its parameters. The 
parameters include baud rate, databits, parity and stopbits.
.PP
.I Section 3 
shows the current terminal emulation.
.PP
.I Section 4
has two options depending on the line status. When not connected this section
shows the current time. However, when connected it can also show the online
time spent on the current connection. To switch between options press the
END key.
.SH PHONEBOOK AND DIALING DIRECTORY
The phone and dialing directory have many functions including multiple 
sorts and speed search and others.
The screen is made up of three parts. The first part is the upper two lines 
which are basicly information about the current phonebook, given that the 
phonebook has any special information in its header. The second part is the 
directory itself. In the directory you have a bar which highlights the 
current entry in the directory. To move the bar just use the arrow keys up, 
down, left and right and the home, end, pgup and pgdn keys. The up and down 
keys move through the different entries while the right and left keys toggle 
the information on the current entry. In the directory you can tag entries
for the dialer (see below), this is done by several keys. 
Pressing space will reverse the tag of the current entry. I.e, if the 
current entry is not tagged it will be tagged, however, if it was tagged 
the tag will be removed. Other tagging keys are '+', '-' and '*'. 
The '+' key tags all of the entries. The '-' key untags all of the entries.
The '*' key reverses the tag of all the entries. The action is identical to 
the space tagging but one difference, this function is done on all the entries
and not just the current one. Pressing Ctrl-I will insert a new empty entry. 
Pressing the delete key will delete the current entry.
Other than these keys you have many other options and below is a list of 
all available options.
.PP
.B Edit
.PP
The edit option is initiated by pressing 'e' or 'E'. This option allows you
to edit the current entry. In this option a new screen is opened and most
of the information about the current entry is displayed and can be edited.
The highlighted letters in every field are hotkeys, by pressing the letter
the bar is moved to the corresponding field.
Below is a list of all the displayed information and explanations
about each field.
.PP
.I System name
.PP
Self explanatory.
.PP
.I Phone number
.PP
This field holds the phone number without prefixes or suffixes.
.PP
.I Device
.PP
This field holds ths device to be used to call this system. If you choose
a device which is different than the default device the dialer will 
automaticly switch to this device when calling the system.
When you choose this option you go into a new window with a menu. The bar
will be set to the current selected device. Use the arrow keys to move
through the menu. Press enter or escape to choose a device. In this menu
you are also able to edit the selected device name by pressing 'E'.
.PP
.I User profile
.PP
This field holds the username to use when entering the system. Since the
current version does not support EMSI logins, this field is somewhat useless.
However, it was left in the program so that people who use macros can benefit
from this automatic name filling.
.PP
.I Password
.PP
This field holds the password for the current system. If the 'Hide passwords'
option is set to yes then you will see dots instead of the actual password
until you actually edit it.
.PP
.I Opening hours
.PP
This field holds the the hours in which the system can be called. The
dialer checks before dialing to see if the current time is with in this
time frame, if not it skips over the entry.
.PP
.I Terminal
.PP
This field holds the default terminal emulation for the system.
.PP
.I Dial prefix
.PP
This field holds the dialing prefix to use before the phone number when
dialing to this system. You can edit the current prefixes inside the menu
by pressing 'E'. However, as in the device menu, the new prefixes will
not be saved unless you do it manually in the configuration menu.
.PP
.I Dial suffix
.PP
This field holds the dialing suffix to use after the phone number when 
dialing to this system. You can edit the current prefixes inside the
menu by pressing 'E'. Read the above paragraph about Dial prefix.
.PP
.I "Comm information"
.PP
This field shows the baud rate, databits, parity and stopbits. By pressing
enter on this field you can change the baud rate for the current system.
.PP
.I "Comment 1 / Comment 2"
.PP
This field holds the comments about the system, you can fill them out with
any string you wish.
.PP
.I Capture file
.PP
This field holds the capture file name in which the sessions you make can
be saved for later viewing. Termite has an option to append this file or
overwrite it as well as an option to automatically open the capture file
when connecting to the system.
.PP
.I Local echo
.PP
This field is a toggle field, it can hold Yes or No values. You change the
values by pressing enter on the field. When this field is set to Yes all
the keys you press will be echoed to the screen as well as to the modem.
.PP
.I Strip high
.PP
This field is a toggle field (see Local echo). When this field is set
to Yes the 8th bit of every byte recieved from the modem is set to 0.
.PP
.I Backspace erase
.PP
This field is a toggle field (see Local echo). When this field is set
to Yes '\\b' characters coming from the modem will move the cursor one step
left and erase that character from the screen. If it is set to No the
cursor will move but the character will not be erased.
.PP
.I Color
.PP
This field holds the color of the entry in the dialing directory. Pressing
enter on it will open a window with all the available color combinations. Press
escape in the color menu to choose a color. Press 'B' in the color menu
to toggle blinking on and off.
.PP
.B Find
.PP
The find option is initiated by pressing 'f' or 'F' and gives you the
ability to speed search through your phone book. After pressing the key
a window will appear with an edit line. In the edit line write the
name or part of the name of the system you are looking for. Note: the
search is case-insensitive. After you write the name you press enter
to find the first matching entry. After that you can press tab to procceed
to the next matching entry. Pressing escape will get you out of the search
window.
.PP
.B Dial
.PP
The dial option is initiated by pressing 'd' or 'D' and is used to 
automatically dial tagged entries. Pressing Enter will also start the dialer
and if no entry is tagged then the current entry is dialed.
.PP
The dialer screen is split into a few boxes, in each different 
information is displayed. The upper box displays the start time and date
on which the dialer was initiated, the current time and date, the dial 
retries number and the number of seconds for the current dial. The second
box holds information about the system which is currently being dialed to.
For a full description of every field read the section on the edit option (
see above). There are two fields which are added to this box, download and
upload. These two fields tell you how many Kilo-bytes you have uploaded and
downloaded from the system. The third box displays the available hotkeys.
Pressing 'a' or 'A' will add 15 seconds to the countdown thus allowing more
time for the current dial. Pressing 'u' or 'U' will untag the current system
and the dialer will not dial to it again. Pressing enter will abort the
dialer and will put you back in the dialing directory but will not hang-up
the modem. Pressing escape will abort the dialing, hang-up the modem and return
you to the terminal. Pressing space will skip the current system and dial to
the next one. The fourth box is the output box where all the output coming
from the modem is displayed. The dialer has several configureable variables
which can be configured through the configure menu under the modem section.
The dial time, delay time and loop delay are configureable. Dial time has
already been explained above (countdown). Delay time is the pause time between 
every dial attempt. Loop delay is the pause time between every complete cycle
of dials. I.e, if you have 4 systems tagged the dialer will dial each of
the 4, assuming none of them answered the dialer will pause for Loop-delay
seconds and then restart dialing all of them again.
.PP
.B Manual
.PP
The manual option is initiated by pressing 'm' or 'M' and is used to
dial any number. This option opens an entry edit window that allows you to
edit and change the various variables of the dial. Enter the phone number
you want to dial set the rest of the variables such as device, prefix, 
suffix etc. After that simply press escape and the dialer will dial the
system.
.PP
.B Sort
.PP
The sort option is initiated by pressing 's' or 'S' and is used to sort the
list of entries. After pressing the key a menu will appear with some options.