kermit(1C) kermit(1C)NAME kermit - invokes the Kermit file-transfer program SYNOPSIS kermit [-a fn1] [-b n] [-c] [-d] [-f] [-g rfn] [-h] [-i] [-k] [-l dev [-n]] [-p x] [-q] [-r] [-s fn] [-t] [-w] [-x] [file]... ARGUMENTS -a fn1 Specifies an alternative name for a single file if you have specified a file transfer option. For example, kermit -s foo -a bar sends the file foo, telling the receiver that its name is bar. If more than one file arrives or is sent, only the first file is affected by this option: For example: kermit -ra baz stores the first incoming file under the name baz. -b n Specifies the baud rate for the line given in the -l option, as in kermit -l /dev/ttyi5 -b 9600 This option should always be used when the -l option is used, since the speed of an external communication line is not necessarily what you expect. -c Establishes a terminal connection over the specified or default communication line, before any protocol transaction takes place. Get back to the local system by typing the escape character (normally CONTROL- Backslash) followed by the letter c. -d Records debugging information in the file debug.log in the current directory. Use this option if you believe the program is misbehaving, and show the resulting log to your local kermit maintainer. -f Sends a ``finish'' command to a remote server. file Specifies the file to be moved. -g rfn Requests (actively) a remote server to send the named file or files; rfn is a file specification in the remote host's own syntax. If fn happens to contain any January 1992 1
kermit(1C) kermit(1C)special shell characters, like *, these must be quoted, as in kermit -g x\*.\? -h Displays a brief synopsis of the command-line options. -i Specifies that files should be sent or received exactly ``as is'' with no conversions. This option is necessary for transmitting binary files. It can also be used to slightly boost efficiency in UNIX-to- UNIX(Reg.) transfers of text files by eliminating carriage-return line-feed/newline conversion. -k Receives (passively) a file or files, sending them to standard output. This option can be used in several ways. Here are some examples. kermit -k displays the incoming files on your screen; this command is to be used only in ``local mode.'' (Local mode is described in ``Interactive Operation,'' later in this manual page.) kermit -k > fn1 sends the incoming file or files to the named file, fn1. If more than one file arrives, all are concatenated together into the single file fn1. kermit -k | command pipes the incoming data (single or multiple files) to the indicated command, as in kermit -k | sort > sorted.stuff -l dev Specifies a terminal line to use for file-transfer operations and terminal connection, as in: kermit -l /dev/ttyi5 When an external line is being used, you might also need some additional options for successful communication with the remote system. -n Acts like the -c option, but after a protocol transaction takes place. The -c and -n options can both be used in the same command. 2 January 1992
kermit(1C) kermit(1C)-p x Specifies the parity: e, o, m, s, or n (even, odd, mark, space, or none). If parity is other than none, then the 8th-bit prefixing mechanism will be used for transferring 8-bit binary data, provided the opposite kermit command uses the same mechanism. The default parity is none. -q Specifies background mode (quiet); suppresses screen update during file transfer, for instance to allow a file transfer to proceed in the background. -r Receives a file or files. Causes kermit to wait passively for files to arrive. -s fn Sends the specified file or files. If fn contains metacharacters, the A/UX shell expands fn into a list. If fn is -, then kermit sends from standard input, which must come either from a file or from a parallel process, as shown in these lines: kermit -s - < foo.bar ls -l | kermit -s - You cannot use this mechanism to send the terminal type. If you want to send a file whose name is -, you can precede it with a pathname, as in kermit -s ./- -t Specifies half-duplex, line turnaround with XON as the handshake character. -w Specifies write-protect; avoid filename collisions for incoming files. -x Begins server operation. This option can be used in either local or remote mode. DESCRIPTION kermit is a file-transfer program that allows you to move files between computers with many different operating systems and architectures. This manual page describes version 4C of the program. Arguments are optional. If kermit is executed without arguments, it enters command mode. Otherwise, kermit reads the arguments off the command line and interprets them. January 1992 3
kermit(1C) kermit(1C)The following notation is used in command descriptions: [ ] Any field in brackets is optional. {x,y ,z} Alternatives are listed in braces. c A decimal number between 0 and 127 representing the value of an ASCII character. cc A decimal number between 0 and 31, or else exactly 127, representing the value of an ASCII control character. fn Specifies an A/UX file specification, possibly containing the asterisk (*) metacharacter which matches all character strings, or the question mark metacharacter (?), ``?'', which matches any single character. fn1 An A/UX file specification that may not contain * or ?. n A decimal number between 0 and 94. rfn A remote file specification in the remote system's own syntax, which can denote a single file or a group of files. rfn1 A remote file specification that should denote only a single file. The command-line options can specify either actions or settings. If kermit is invoked with a command line that specifies no actions, it issues a prompt and begins interactive dialog. Action options specify either protocol transactions or terminal connection. The command line must not contain more than one protocol action option. Interactive Operation The interactive prompt for the kermit command is: C-Kermit> In response to this prompt, you can type any valid command. The kermit command executes the command and then prompts you for another command. The process continues until you tell the program to terminate. Commands begin with a keyword, normally an English verb, such as send. You can omit trailing characters from any keyword, so long as you specify sufficient characters to 4 January 1992
kermit(1C) kermit(1C)distinguish it from any other keyword valid in that field. Certain commonly used keywords (such as send, receive, and connect) have special nonunique abbreviations (sfor send, (rfor receive, (cfor connect). Certain characters have special functions in interactive commands: ? A question mark, typed at any point in a command, causes kermit to display a message explaining what is possible or expected at that point. Depending on the context, the message may be a brief phrase, a menu of keywords, or a list of files. \ Backslash; causes any of the other characters in this list to be entered into the command, literally. To enter a backslash, type two backslashes in a row (\\). A single backslash immediately preceding a carriage return allows you to continue the command on the next line. CR Carriage return; enters the command for execution. A line-feed (LF) or form-feed (FF) can also be used for this purpose. DEL The DELETE or RUBOUT key; deletes the preceding character from the command. You can also use BS (CONTROL-H) for this function. ESC The ESCAPE or ALTMODE key; requests completion of the current keyword or filename, or insertion of a default value. The result will be a beep if the requested operation fails. ^R CONTROL-R; redisplays the current command. SP Space; delimits fields (keywords, filenames, numbers) within a command. HT (Horizontal Tab) can also be used for this purpose. ^U CONTROL-U; erases the entire command. ^W CONTROL-W; erases the rightmost word from the command line. You can type the editing characters (DEL, ^W, and so on.) repeatedly, to delete all the way back to the prompt. No action will be performed until you enter the command by pressing RETURN, the line-feed key, or the form-feed key. Command is entered by typing carriage return, linefeed, or formfeed. If you make any mistakes, you will receive an informative error message and a new prompt; make liberal use January 1992 5
kermit(1C) kermit(1C)of ? and ESC to feel your way through the commands. One important command is help; you should use it the first time you run kermit. In interactive mode, kermit accepts commands from files as well as from the keyboard. When you enter interactive mode, kermit looks for the file .kermrc in your home or current directory (first looking in the home directory, then looking in the current one) and executes any commands it finds there. These commands must be in interactive format, not A/UX command-line format. A take command is also provided for use at any time during an interactive session. Command files can be nested to any reasonable depth. Here is a brief list of kermit interactive commands: ! Executes an A/UX shell command. bye Terminates the connection to and log outs of a remote kermit server. close Closes a log file. connect Establishes a terminal connection to a remote system. cwd Changes the working directory. dial Dials a telephone number. directory Displays a directory listing. echo Displays arguments literally. exit Exits from the program, closing any open logs. finish Instructs a remote kermit server to exit, but not log out. get Gets files from a remote kermit server. help Displays a help message for a given command. log Opens a log file - debugging, packet, session, or transaction. quit Acts the same as exit. receive 6 January 1992
kermit(1C) kermit(1C)Passively waits for files to arrive. remote Issues file-management commands to a remote kermit server. script Executes a login script with a remote system. send Sends files. server Begins server operation. set Sets various parameters. show Displays values of set parameters. space Displays current disk-space usage. statistics Displays statistics about the most recent transaction. take Executes commands from a file. The set parameters are as follows: block-check Specifies the level of packet error detection. delay Specifies how long to wait before sending the first packet. duplex Specifies which side echoes during connect. escape-character Specifies the character with which to prefix escape commands during connect. file Sets various file parameters. flow-control Specifies the communications line full-duplex flow control. handshake Specifies the communications line half-duplex turnaround character. January 1992 7
kermit(1C) kermit(1C)line Specifies the communications line device name. modem-dialer Specifies the type of modem-dialer on the communications line. parity Specifies the communications line character parity. prompt Changes the kermit program's prompt. receive Sets various parameters for inbound packets. send Sets various parameters for outbound packets. speed Specifies the communications line speed. The remote commands are as follows: cwd Changes the remote working directory. delete Deletes remote files. directory Displays a listing of names of remote files. help Requests help from a remote server. host Issues a command to the remote host in its own command language. space Displays current disk-space usage on the remote system. type Displays a remote file on your screen. who Displays who's logged in, or information about a user. Remote and Local Operation The kermit program is ``local'' if it is running on a personal computer or workstation that you are using directly, or if it is running on a multi-user system and transferring files over an external communications line, not from your job's controlling terminal or console. The kermit program is remote if it is running on a multi-user system and transferring files over its own controlling terminal's communications line, connected to your personal computer or workstation. 8 January 1992
kermit(1C) kermit(1C)If you are running kermit on a personal computer, it is in local mode by default, with the ``back port'' designated for file transfer and terminal connection. If you are running kermit on a multi-user (time-sharing) system, it is in remote mode unless you explicitly point it at an external line for file transfer or terminal connection. The -g rfn, -f, -c, and -n commands can be used only with a kermit program that is local, either by default or because the -l option has been specified. On a time-sharing system, the -l and -b options must also be included with the -r, -k, or -s option if the other kermit program is on a remote system. If kermit is in local mode, the screen (standard output) is continuously updated to show the progress of the file transfer. A dot is printed for every four data packets; other packets are shown by type (for example, S for Send- Init); T is printed when there's a timeout; and % is printed for each retransmission. In addition, you can type (to standard input) the following ``interrupt'' commands during file transfer: CONTROL-F Interrupts the current file and goes on to the next (if any). CONTROL-B Interrupts the entire batch of files and terminates the transaction. CONTROL-R Resends the current packet. CONTROL-A Displays a status report for the current transaction. These interrupt characters differ from the ones used in other kermit implementations to avoid conflict with A/UX shell interrupt characters. With System III and System V implementations of the UNIX system, interrupt commands must be preceded by an escape character (such as CONTROL-\). LIMITATIONS See recent issues of the Info-Kermit digest (on ARPANET or Usenet) for a list of bugs. STATUS MESSAGES AND VALUES The diagnostics produced by kermit itself are intended to be self-explanatory. January 1992 9
kermit(1C) kermit(1C)FILES $HOME/.kermrc File containing kermit initialization commands ./.kermrc File containing kermit initialization commands /usr/bin/kermit Executable file /usr/spool/locks Directory in which kermit makes a lock file, which prevents other programs from using the serial port that kermit is using SEE ALSO cu(1C), uucp(1C) Kermit User's Guide, Frank da Cruz and Bill Catchings, Columbia University, 6th Edition 10 January 1992