[0m


KERMIT(1C)	    UNIX Programmer's Manual	       KERMIT(1C)



[1mNAME
     [0mkermit - kermit file transfer

[1mSYNOPSIS
     kermit [0m[ option ...] [file ...]

[1mDESCRIPTION
     [0m_K_e_r_m_i_t is a file transfer program that allows files to be
     moved between machines of many different operating systems
     and architectures.  This man page describes version 4C of
     the program.

     Arguments are optional. If _K_e_r_m_i_t is executed without argu-
     ments, it will enter command mode. Otherwise, _k_e_r_m_i_t will
     read the arguments off the command line and interpret them.

     The following notation is used in command descriptions:

     _f_n      A Unix file specification, possibly containing
	     either of the "wildcard" characters '*' or '?' ('*'
	     matches all character strings, '?' matches any sin-
	     gle character).

     _f_n_1     A Unix file specification which may not contain '*'
	     or '?'.

     _r_f_n     A remote file specification in the remote system's
	     own syntax, which may denote a single file or a
	     group of files.

     _r_f_n_1    A remote file specification which should denote only
	     a single file.

     _n	     A decimal number between 0 and 94.

     _c	     A decimal number between 0 and 127 representing the
	     value of an ASCII character.

     _c_c      A decimal number between 0 and 31, or else exactly
	     127, representing the value of an ASCII control
	     character.

     [1m[ ]     [0mAny field in square braces is optional.

     {_x,_y,_z} Alternatives are listed in curly braces.

     _K_e_r_m_i_t command line options may specify either actions or
     settings.	If _K_e_r_m_i_t is invoked with a command line that
     specifies no actions, then it will issue a prompt and begin
     interactive dialog.  Action options specify either protocol
     transactions or terminal connection.




Printed 22/10/92    Revision 1.1 of 13/12/88			1






KERMIT(1C)	    UNIX Programmer's Manual	       KERMIT(1C)



     [1mCOMMAND LINE OPTIONS

     -s [0m_f_n   Send the specified file or files. If _f_n contains
	     wildcard (meta) characters, the Unix shell expands
	     it into a list.  If _f_n is '-' then _K_e_r_m_i_t sends from
	     standard input, which must come from a file:

			 kermit -s - < foo.bar

	     or a parallel process:

			 ls -l | kermit -s -

	     You cannot use this mechanism to send terminal
	     typein.  If you want to send a file whose name is
	     "-" you can precede it with a path name, as in

			 kermit -s ./-

     [1m-r      [0mReceive a file or files.  Wait passively for files
	     to arrive.

     [1m-k      [0mReceive (passively) a file or files, sending them to
	     standard output.  This option can be used in several
	     ways:

		     kermit -k

	     Displays the incoming files on your screen; to be
	     used only in "local mode" (see below).

		     kermit -k > fn1

	     Sends the incoming file or files to the named file,
	     _f_n_1. If more than one file arrives, all are con-
	     catenated together into the single file _f_n_1.

		     kermit -k | command

	     Pipes the incoming data (single or multiple files)
	     to the indicated command, as in

		     kermit -k | sort > sorted.stuff

     [1m-a [0m_f_n_1  If you have specified a file transfer option, you
	     may specify an alternate name for a single file with
	     the [1m-a [0moption.  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



Printed 22/10/92    Revision 1.1 of 13/12/88			2






KERMIT(1C)	    UNIX Programmer's Manual	       KERMIT(1C)



	     sent, only the first file is affected by the [1m-a
	     [0moption:

		     kermit -ra baz

	     stores the first incoming file under the name baz.

     [1m-x      [0mBegin server operation.  May be used in either local
	     or remote mode.

     Before proceeding, a few words about remote and local opera-
     tion are  necessary.  _K_e_r_m_i_t is "local" if it is running on
     a PC or workstation that you are using directly, or if it is
     running on a multiuser system and transferring files over an
     external communication line - not your job's controlling
     terminal or console.  _K_e_r_m_i_t is remote if it is running on a
     multiuser system and transferring files over its own con-
     trolling terminal's communication line, connected to your PC
     or workstation.

     If you are running _K_e_r_m_i_t on a PC, it is in local mode by
     default, with the "back port" designated for file transfer
     and terminal connection.  If you are running _K_e_r_m_i_t on a
     multiuser (timesharing) system, it is in remote mode unless
     you explicitly point it at an external line for file
     transfer or terminal connection.  The following command sets
     _K_e_r_m_i_t's "mode":

     [1m-l [0m_d_e_v  Line - Specify a terminal line to use for file
	     transfer 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:

     [1m-b [0m_n Baud - Specify the baud rate for the line given in the
	  [1m-l [0moption, as in

		      kermit -l /dev/ttyi5 -b 9600

	  This option should always be included with the [1m-l
	  [0moption, since the speed of an external line is not
	  necessarily what you expect.

     [1m-p [0m_x Parity - [1me[0m, [1mo[0m, [1mm[0m, [1ms[0m, [1mn [0m(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 _K_e_r_m_i_t agrees. The
	  default parity is none.




Printed 22/10/92    Revision 1.1 of 13/12/88			3






KERMIT(1C)	    UNIX Programmer's Manual	       KERMIT(1C)



     [1m-t   [0mSpecifies half duplex, line turnaround with XON as the
	  handshake character.

     The following commands may be used only with a _K_e_r_m_i_t which
     is local - either by default or else because the [1m-l [0moption
     has been specified.

     [1m-g [0m_r_f_n  Actively request a remote server to send the named
	     file or files; _r_f_n is a file specification in the
	     remote host's own syntax.	If _f_n happens to contain
	     any special shell characters, like '*', these must
	     be quoted, as in

			 kermit -g x\*.\?

     [1m-f      [0mSend a 'finish' command to a remote server.

     [1m-c      [0mEstablish a terminal connection over the specified
	     or default communication line, before any protocol
	     transaction takes place.  Get back to the local sys-
	     tem by typing the escape character (normally
	     Control-Backslash) followed by the letter 'c'.

     [1m-n      [0mLike [1m-c, [0mbut after a protocol transaction takes
	     place; [1m-c [0mand [1m-n [0mmay both be used in the same com-
	     mand.  The use of [1m-n [0mand [1m-c [0mis illustrated below.

     On a timesharing system, the [1m-l [0mand [1m-b [0moptions will also
     have to be included with the [1m-r[0m, [1m-k[0m, or [1m-s [0moptions if the
     other _K_e_r_m_i_t is on a remote system.

     If _k_e_r_m_i_t is in local mode, the screen (stdout) is con-
     tinously updated to show the progress of the file transer.
     A dot is printed for every four data packets, other packets
     are shown by type (e.g. 'S' for Send-Init), 'T' is printed
     when there's a timeout, and '%' for each retransmission.  In
     addition, you may type (to stdin) certain "interrupt" com-
     mands during file transfer:

	  Control-F:  Interrupt the current File, and go on to
	  the next (if any).

	  Control-B:  Interrupt the entire Batch of files, ter-
	  minate the transaction.

	  Control-R:  Resend the current packet

	  Control-A:  Display a status report for the current
	  transaction.


     These interrupt characters differ from the ones used in



Printed 22/10/92    Revision 1.1 of 13/12/88			4






KERMIT(1C)	    UNIX Programmer's Manual	       KERMIT(1C)



     other _K_e_r_m_i_t implementations to avoid conflict with Unix
     shell interrupt characters.  With System III and System V
     implementations of Unix, interrupt commands must be pre-
     ceeded by the escape character (e.g. control-\).

     Several other command-line options are provided:

     [1m-i      [0mSpecifies that files should be sent or received
	     exactly "as is" with no conversions.  This option is
	     necessary for transmitting binary files.  It may
	     also be used to slightly boost efficiency in Unix-
	     to-Unix transfers of text files by eliminating
	     CRLF/newline conversion.

     [1m-w      [0mWrite-Protect - Avoid filename collisions for incom-
	     ing files.

     [1m-q      [0mQuiet - Suppress screen update during file transfer,
	     for instance to allow a file transfer to proceed in
	     the background.

     [1m-d      [0mDebug - Record 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 _K_e_r_m_i_t maintainer.

     [1m-h      [0mHelp - Display a brief synopsis of the command line
	     options.

     The command line may contain no more than one protocol
     action option.

     [1mINTERACTIVE OPERATION

     [0m_K_e_r_m_i_t's interactive command prompt is "C-Kermit>". In
     response to this prompt, you may type any valid command.
     _K_e_r_m_i_t executes the command and then prompts you for another
     command.  The process continues until you instruct the pro-
     gram to terminate.

     Commands begin with a keyword, normally an English verb,
     such as "send".  You may omit trailing characters from any
     keyword, so long as you specify sufficient characters to
     distinguish it from any other keyword valid in that field.
     Certain commonly-used keywords (such as "send", "receive",
     "connect") have special non-unique abbreviations ("s" for
     "send", "r" for "receive", "c" for "connect").

     Certain characters have special functions in interactive
     commands:





Printed 22/10/92    Revision 1.1 of 13/12/88			5






KERMIT(1C)	    UNIX Programmer's Manual	       KERMIT(1C)



     [1m?	     [0mQuestion mark, typed at any point in a command, will
	     produce 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 key-
	     words, or a list of files.

     [1mESC     [0m(The Escape or Altmode key) - Request completion of
	     the current keyword or filename, or insertion of a
	     default value.  The result will be a beep if the
	     requested operation fails.

     [1mDEL     [0m(The Delete or Rubout key) - Delete the previous
	     character from the command.  You may also use BS
	     (Backspace, Control-H) for this function.

     [1m^W      [0m(Control-W) - Erase the rightmost word from the com-
	     mand line.

     [1m^U      [0m(Control-U) - Erase the entire command.

     [1m^R      [0m(Control-R) - Redisplay the current command.

     [1mSP      [0m(Space) - Delimits fields (keywords, filenames,
	     numbers) within a command.  HT (Horizontal Tab) may
	     also be used for this purpose.

     [1mCR      [0m(Carriage Return) - Enters the command for execu-
	     tion.  [1mLF [0m(Linefeed) or [1mFF [0m(formfeed) may also be
	     used for this purpose.

     [1m\	     [0m(Backslash) - Enter any of the above characters 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.


     You may type the editing characters (DEL, ^W, etc) repeat-
     edly, to delete all the way back to the prompt.  No action
     will be performed until the 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 of '?' and ESC to feel your
     way through the commands.	One important command is "help" -
     you should use it the first time you run _K_e_r_m_i_t.

     Interactive _K_e_r_m_i_t accepts commands from files as well as
     from the keyboard.  When you enter interactive mode, _K_e_r_m_i_t
     looks for the file .kermrc in your home or current directory
     (first it looks in the home directory, then in the current
     one) and executes any commands it finds there.  These com-
     mands must be in interactive format, not Unix command-line



Printed 22/10/92    Revision 1.1 of 13/12/88			6






KERMIT(1C)	    UNIX Programmer's Manual	       KERMIT(1C)



     format.  A "take" command is also provided for use at any
     time during an interactive session.  Command files may be
     nested to any reasonable depth.

     Here is a brief list of _K_e_r_m_i_t interactive commands:

     [1m!		 [0mExecute a Unix shell command.

     [1mbye	 [0mTerminate and log out a remote _K_e_r_m_i_t server.

     [1mclose	 [0mClose a log file.

     [1mconnect	 [0mEstablish a terminal connection to a remote sys-
		 tem.

     [1mcwd	 [0mChange Working Directory.

     [1mdial	 [0mDial a telephone number.

     [1mdirectory	 [0mDisplay a directory listing.

     [1mecho	 [0mDisplay arguments literally.

     [1mexit	 [0mExit from the program, closing any open logs.

     [1mfinish	 [0mInstruct a remote _K_e_r_m_i_t server to exit, but not
		 log out.

     [1mget	 [0mGet files from a remote _K_e_r_m_i_t server.

     [1mhelp	 [0mDisplay a help message for a given command.

     [1mlog	 [0mOpen a log file - debugging, packet, session,
		 transaction.

     [1mquit	 [0mSame as 'exit'.

     [1mreceive	 [0mPassively wait for files to arrive.

     [1mremote	 [0mIssue file management commands to a remote _K_e_r_-
		 _m_i_t server.

     [1mscript	 [0mExecute a login script with a remote system.

     [1msend	 [0mSend files.

     [1mserver	 [0mBegin server operation.

     [1mset	 [0mSet various parameters.

     [1mshow	 [0mDisplay values of 'set' parameters.




Printed 22/10/92    Revision 1.1 of 13/12/88			7






KERMIT(1C)	    UNIX Programmer's Manual	       KERMIT(1C)



     [1mspace	 [0mDisplay current disk space usage.

     [1mstatistics  [0mDisplay statistics about most recent transac-
		 tion.

     [1mtake	 [0mExecute commands from a file.


     The 'set' parameters are:

     [1mblock-check	  [0mLevel of packet error detection.

     [1mdelay		  [0mHow long to wait before sending first
			  packet.

     [1mduplex		  [0mSpecify which side echoes during 'con-
			  nect'.

     [1mescape-character	  [0mCharacter to prefix "escape commands"
			  during 'connect'.

     [1mfile		  [0mSet various file parameters.

     [1mflow-control	  [0mCommunication line full-duplex flow
			  control.

     [1mhandshake		  [0mCommunication line half-duplex tur-
			  naround character.

     [1mline		  [0mCommunication line device name.

     [1mmodem-dialer	  [0mType of modem-dialer on communication
			  line.

     [1mparity		  [0mCommunication line character parity.

     [1mprompt		  [0mChange the _K_e_r_m_i_t program's prompt.

     [1mreceive		  [0mSet various parameters for inbound
			  packets.

     [1msend		  [0mSet various parameters for outbound
			  packets.

     [1mspeed		  [0mCommunication line speed.


     The 'remote' commands are:

     [1mcwd	 [0mChange remote working directory.

     [1mdelete	 [0mDelete remote files.



Printed 22/10/92    Revision 1.1 of 13/12/88			8






KERMIT(1C)	    UNIX Programmer's Manual	       KERMIT(1C)



     [1mdirectory	 [0mDisplay a listing of remote file names.

     [1mhelp	 [0mRequest help from a remote server.

     [1mhost	 [0mIssue a command to the remote host in its own
		 command language.

     [1mspace	 [0mDisplay current disk space usage on remote sys-
		 tem.

     [1mtype	 [0mDisplay a remote file on your screen.

     [1mwho	 [0mDisplay who's logged in, or get information
		 about a user.

[1mFILES
     [0m$HOME/.kermrc  _K_e_r_m_i_t initialization commands
     ./.kermrc	    more _K_e_r_m_i_t initialization commands

[1mSEE ALSO
     [0mcu(1C), uucp(1C)
     Frank da Cruz and Bill Catchings, _K_e_r_m_i_t _U_s_e_r'_s _G_u_i_d_e,
     Columbia University, 6th Edition

[1mDIAGNOSTICS
     [0mThe diagnostics produced by _K_e_r_m_i_t itself are intended to be
     self-explanatory.

[1mBUGS
     [0mSee recent issues of the Info-Kermit digest (on ARPANET or
     Usenet), or the file ckuker.bwr, for a list of bugs.
























Printed 22/10/92    Revision 1.1 of 13/12/88			9



[0m