Return to ckermit CVS log

Up to [MW Coherent from dump] / coherent / a / usr / man / COHERENT

coherent

ckermit                      Command                      ckermit




Interactive inter-system communication and file transfer

cckkeerrmmiitt [-aabbccddeeffgghhiikkllppqqrrssttwwxx] [ _f_i_l_e ... ]

cckkeerrmmiitt implements  the kkeerrmmiitt communications  protocol.  It lets
you communicate  with other systems via modem  or network, and to
exchange files with  other systems that have also implemented the
kkeerrmmiitt protocol.   Unlike the  kkeerrmmiitt command also  included with
the COHERENT system,  cckkeerrmmiitt uses an interactive shell to remove
some of the pain from  the process of exchanging files.  The name
cckkeerrmmiitt relects  the fact that  this command is written  in the C
language, and  so has been ported to  many different machines and
operating systems.

You can  run cckkeerrmmiitt in either _i_n_t_e_r_a_c_t_i_v_e  _m_o_d_e or _c_o_m_m_a_n_d _m_o_d_e.
Simply typing the command


        ckermit


invokes cckkeerrmmiitt  in interactive mode: cckkeerrmmiitt  displays a prompt,
waits for  your command, executes, then prompts  you for its next
command.   Typing the  command line  plus  one or  more arguments
invokes cckkeerrmmiitt in command mode: cckkeerrmmiitt then reads the arguments
from the command line  and executes them.  After execution of the
commands, cckkeerrmmiitt returns to interactive mode.

cckkeerrmmiitt's command-line  options name either  actions or settings.
An action option tells cckkeerrmmiitt to send a file, receive a file, or
connect to a remote system.  The command line may contain no more
than one action option.  A settings option changes one or more of
the  internal  values  that  control  how cckkeerrmmiitt  operates;  for
example, one  setting option  lets you set  the baud rate  of the
serial  port that  cckkeerrmmiitt  will be  using.  A  command line  can
contain any number of settings options.

***** Command-Line Options *****

cckkeerrmmiitt recognizes the following command-line options:

-aa _f_i_l_e_n_a_m_e
     Give  an alternate  name to a  file being  transferred.  For
     example, the command


        ckermit -s foo -a bar


transmits the  file ffoooo to a remote system,  but tells the remote
system that the file is named bbaarr. Likewise, the command





COHERENT Lexicon                                           Page 1




ckermit                      Command                      ckermit



        ckermit -ra baz


stores the first incoming file under the name bbaazz.

If more than one file arrives  or is sent, only the first file is
affected by the -aa option.

-bb _b_a_u_d_r_a_t_e
     Set the baud rate of the device to _b_a_u_d_r_a_t_e.

-cc   Connect to  serial port, and  pass all subsequent  typing to
     that port  To resume talking to your  local system, type the
     escape  character followed  by the  letter `c'.   The escape
     character is  set by default  to <ccttrrll-\>, although  you can
     change it if you wish.

-dd   Debug  mode  -- record  debugging  information  in the  file
     ddeebbuugg.lloogg in the current directory.

-ee _n Set  the length  of the  packet  to _n  where _n  is a  number
     between  ten and  about  1,000.  Lengths  of  95 or  greater
     require  that the  implementation  of kkeerrmmiitt  on the  remote
     system  support  the  long-packet  extension to  the  kkeerrmmiitt
     protocol.

-ff   Send a ``finish'' command to a remote server.

-gg _f_i_l_e
     Ask a  remote system  to send _f_i_l_e  or _f_i_l_e_s. The  file name
     must use the remote  system's own syntax; you must quote all
     characters normally expanded by the COHERENT shell, e.g.:


        ckermit -g x\*.\?


-hh   Help  --  display  a  brief  synopsis  of  the  command-line
     options.

-ii   The   ``image''  option:   specify  that   the   file  being
     transmitted  or received  is an  eight-bit binary  file, and
     therefore no  conversion should  be performed upon  the data
     being received.

-kk   Passively receive  file or  files, copying them  to standard
     output.

-ll _d_e_v_i_c_e
     Name the serial device to be used.  For example







COHERENT Lexicon                                           Page 2




ckermit                      Command                      ckermit



        ckermit -l /dev/com2


tells cckkeerrmmiitt to use device /ddeevv/ccoomm22.

-nn   Like -cc, but used after a protocol transaction has occurred.
     You can use both -cc and -nn in the same command.

-pp _x Set  parity,  where   _x  is  one  of  ee,  oo,   mm,  ss,  or  nn
     (respectively, even, odd,  mark, space, or none).  If parity
     is  other  than  none,  then  cckkeerrmmiitt  uses  the  eighth-bit
     prefixing  mechanism to transfer  binary data,  provided the
     impementation of  kkeerrmmiitt on  the remote system  agrees.  The
     default parity is none.

-qq   Quiet --  suppress screen  update during file  transfer; for
     example, this lets you transfer a file in the background.

-rr   Receive  a  file  or files.   Wait  passively  for files  to
     arrive.

-ss _f_i_l_e
     Send the specified _f_i_l_e or  _f_i_l_e_s. If _f_n is `-' then cckkeerrmmiitt
     sends from standard input, which may come from a file:


        ckermit -s - < foo.bar


or come from a parallel process:


        ls -l | ckermit -s -


You  cannot  use  this mechanism  to  send  text  typed from  the
keyboard.  To send a file named `-', precede it with a path name,
e.g.:


        ckermit -s ./-


-tt   Specify  half  duplex,  line  turnaround  with  XON  as  the
     handshake character.

-ww   Write-Protect  -- avoid  file-name  collisions for  incoming
     files.

-xx   Begin server  operation.  This option can  be used in either
     local or remote mode.

If   cckkeerrmmiitt is  in local  mode, shows the  progress of  the file
transfer.  A  dot is printed  for every four  data packets; other
packets  are shown  by  type (e.g.,  `S' for  Send-Init); `T'  is


COHERENT Lexicon                                           Page 3




ckermit                      Command                      ckermit



printed  when there's  a  timeout; and  `%' is  printed for  each
retransmission.

During file  transfer, you  can type the  following ``interrupt''
commands:

<ccttrrll-FF>
     Interrupt the current file and go on to the next, if any.

<ccttrrll-BB>
     Interrupt  the  entire  batch  of  files and  terminate  the
     transaction.

<ccttrrll-RR>
     Resend the current packet.

<ccttrrll-AA>
     Display a status report for the current transaction.

These  interrupt characters  differ from the  ones used  in other
implementations of  cckkeerrmmiitt to  avoid conflict with  the COHERENT
shell's interrupt characters.

***** Interactive Operation *****

When  you invoke  cckkeerrmmiitt in  interactive  mode, it  displays the
following prompt.


        C-Kermit>


Type  any valid  cckkeerrmmiitt command;  the set  of valid  commands is
described below.   cckkeerrmmiitt executes the command  and then prompts
you  for another.   The process  continues until  you tell  it to
quit.

Commands begin with a  keyword, normally an English verb, such as
sseenndd. You can abbreviate any  keyword, as long as you type enough
characters to  distinguish it  from all other  keywords.  Certain
commonly  used  keywords  (e.g.,  sseenndd,  rreecceeiivvee,  ccoonnnneecctt)  hhaavvee
ssppeecciiaall  nnoonn-uunniiqquuee aabbbbrreevviiaattiioonnss  (rreessppeeccttiivveellyy,  `ss', `rr',  aanndd
`cc').

CCeerrttaaiinn   cchhaarraacctteerrss  hhaavvee   ssppeecciiaall  ffuunnccttiioonnss   iinn  iinntteerraaccttiivvee
ccoommmmaannddss:

?    Print a  message that explains what  is possible or expected
     at the  current point within a  command.  Depending upon the
     context,  the  message may  be  a brief  phrase,  a menu  of
     keywords, or a list of files.

<eesscc>
     Request completion  of the current keyword  or file name, or
     insertion  of a  default value.   cckkeerrmmiitt  will beep  if the


COHERENT Lexicon                                           Page 4




ckermit                      Command                      ckermit



     requested operation fails.  <ttaabb> does the same thing.

<ddeell>
     Delete the previous character from the command.  <bbaacckkssppaaccee>
     does the same thing.

<ccttrrll-WW>
     Erase the rightmost word from the command line.

<ccttrrll-UU>
     Erase the entire command.

<ccttrrll-RR>
     Redisplay the current command.

<ssppaaccee>
     Delimit  fields  (keywords,  filenames,  numbers)  within  a
     command.

<rreettuurrnn>
     Execute the command.

\    Insert  any  of  the  above  characters  into  the  command,
     literally.    To  enter  a   literal  backslash,   type  two
     backslashes in a row (\\).  Typing one backslash immediately
     <rreettuurrnn> lets you continue the command on the next line.

cckkeerrmmiitt recognizes the following interactive commands:

! _c_o_m_m_a_n_d
     Execute a shell command.  A space must follow the !.

%    A comment.  cckkeerrmmiitt ignores everything that follows the %.

bbyyee  Terminate and log out a remote kkeerrmmiitt server.

cclloossee
     Close a log file.

ccoonnnneecctt
     Connect to the remote system.

ccwwdd _d_i_r_e_c_t_o_r_y
     Change the working directory to _d_i_r_e_c_t_o_r_y.

ddiiaall Dial a telephone number.

ddiirreeccttoorryy
     Display a directory listing.

eecchhoo Display arguments literally.  Useful in take-command files.

eexxiitt Exit from the program, closing any open logs.




COHERENT Lexicon                                           Page 5




ckermit                      Command                      ckermit



ffiinniisshh
     Instruct a remote  kkeerrmmiitt server to exit, but not log out.

ggeett  Get files from a remote  kkeerrmmiitt server.

hhaanngguupp
     Hang up the telephone.

hheellpp Display a help message for a given command.

lloogg  Open a log file -- debugging, packet, session, transaction.

qquuiitt Same as eexxiitt.

rreecceeiivvee
     Passively wait for files to arrive.

rreemmoottee
     Issue file-management commands to a remote kkeerrmmiitt server.

ssccrriipptt
     Execute a login script with a remote system.

sseenndd _f_i_l_e
     Send _f_i_l_e to the remote kkeerrmmiitt server.

sseerrvveerr
     Begin server operation.

sseett  Set various internal parameters.

sshhooww Display values of parameters, program version, etc.

ssppaaccee
     Display current disk space usage.

ssttaattiissttiiccss
     Display statistics about most recent transaction.

ttaakkee Execute commands from a file.

Interactive  cckkeerrmmiitt accepts  commands from files as well as from
the keyboard.   Upon startup, cckkeerrmmiitt looks  for the file .kkeerrmmrrcc
first in directory $HHOOMMEE and then in the current directory; if it
finds the file, it executes all commands it finds therein.  These
commands  must be  in interactive format.   Command files  may be
nested to any reasonable depth.

***** The set Command *****

As  noted  above,  the sseett  command  lets  you  set the  internal
parameters by which cckkeerrmmiitt operates.  The sseett command recognizes
the following arguments:




COHERENT Lexicon                                           Page 6




ckermit                      Command                      ckermit



bblloocckk-cchheecckk
     Level of packet error detection.

ddeellaayy
     Time to wait before sending first packet.

dduupplleexx
     Specify which side echoes during connect mode.

eessccaappee-cchhaarraacctteerr
     Character to prefix _e_s_c_a_p_e _c_o_m_m_a_n_d_s during connect mode.

ffiillee Set various file parameters.

ffllooww-ccoonnttrrooll
     Communication line full-duplex flow control.

hhaannddsshhaakkee
     Communication line half-duplex turnaround character.

lliinnee Communication-line device name.

mmooddeemm-ddiiaalleerr
     Type of modem-dialer on communication line.

ppaarriittyy
     Communication line character parity.

pprroommpptt
     Change the  cckkeerrmmiitt program's prompt.

rreecceeiivvee
     Set various parameters for inbound packets.

rreettrryy
     Set the packet retransmission limit.

sseenndd Set various parameters for outbound packets.

ssppeeeedd
     Communication line speed.

***** Remote Commands *****

cckkeerrmmiitt also has a suite of  commands that are sent to the remote
system for execution.  They are as follows:

ccwwdd  Change remote working directory (also, rreemmoottee ccdd).

ddeelleettee
     Delete remote files.

ddiirreeccttoorryy
     Display a listing of remote file names.



COHERENT Lexicon                                           Page 7




ckermit                      Command                      ckermit



hheellpp Request help from a remote server.

hhoosstt Issue  a  command to  the  remote host  in  its own  command
     language.

ssppaaccee
     Display current disk space usage on remote system.

ttyyppee Display a remote file on your screen.

wwhhoo  Display the  users logged  in to  the remote system,  or get
     information about a user.

***** Files *****

.kkeerrmmrrcc -- cckkeerrmmiitt initialization commands

***** See Also *****

ccoommmmaannddss, kkeerrmmiitt, uuuuccpp

***** Notes *****

The  kkeerrmmiitt protocol  was  developed at  the Columbia  University
Center for Computing Activities.
































COHERENT Lexicon                                           Page 8

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.