Annotation of coherent/a/usr/man/COHERENT/ckermit, revision 1.1.1.1

1.1       root        1: 
                      2: 
                      3: ckermit                      Command                      ckermit
                      4: 
                      5: 
                      6: 
                      7: 
                      8: Interactive inter-system communication and file transfer
                      9: 
                     10: cckkeerrmmiitt [-aabbccddeeffgghhiikkllppqqrrssttwwxx] [ _f_i_l_e ... ]
                     11: 
                     12: cckkeerrmmiitt implements  the kkeerrmmiitt communications  protocol.  It lets
                     13: you communicate  with other systems via modem  or network, and to
                     14: exchange files with  other systems that have also implemented the
                     15: kkeerrmmiitt protocol.   Unlike the  kkeerrmmiitt command also  included with
                     16: the COHERENT system,  cckkeerrmmiitt uses an interactive shell to remove
                     17: some of the pain from  the process of exchanging files.  The name
                     18: cckkeerrmmiitt relects  the fact that  this command is written  in the C
                     19: language, and  so has been ported to  many different machines and
                     20: operating systems.
                     21: 
                     22: 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.
                     23: Simply typing the command
                     24: 
                     25: 
                     26:         ckermit
                     27: 
                     28: 
                     29: invokes cckkeerrmmiitt  in interactive mode: cckkeerrmmiitt  displays a prompt,
                     30: waits for  your command, executes, then prompts  you for its next
                     31: command.   Typing the  command line  plus  one or  more arguments
                     32: invokes cckkeerrmmiitt in command mode: cckkeerrmmiitt then reads the arguments
                     33: from the command line  and executes them.  After execution of the
                     34: commands, cckkeerrmmiitt returns to interactive mode.
                     35: 
                     36: cckkeerrmmiitt's command-line  options name either  actions or settings.
                     37: An action option tells cckkeerrmmiitt to send a file, receive a file, or
                     38: connect to a remote system.  The command line may contain no more
                     39: than one action option.  A settings option changes one or more of
                     40: the  internal  values  that  control  how cckkeerrmmiitt  operates;  for
                     41: example, one  setting option  lets you set  the baud rate  of the
                     42: serial  port that  cckkeerrmmiitt  will be  using.  A  command line  can
                     43: contain any number of settings options.
                     44: 
                     45: ***** Command-Line Options *****
                     46: 
                     47: cckkeerrmmiitt recognizes the following command-line options:
                     48: 
                     49: -aa _f_i_l_e_n_a_m_e
                     50:      Give  an alternate  name to a  file being  transferred.  For
                     51:      example, the command
                     52: 
                     53: 
                     54:         ckermit -s foo -a bar
                     55: 
                     56: 
                     57: transmits the  file ffoooo to a remote system,  but tells the remote
                     58: system that the file is named bbaarr. Likewise, the command
                     59: 
                     60: 
                     61: 
                     62: 
                     63: 
                     64: COHERENT Lexicon                                           Page 1
                     65: 
                     66: 
                     67: 
                     68: 
                     69: ckermit                      Command                      ckermit
                     70: 
                     71: 
                     72: 
                     73:         ckermit -ra baz
                     74: 
                     75: 
                     76: stores the first incoming file under the name bbaazz.
                     77: 
                     78: If more than one file arrives  or is sent, only the first file is
                     79: affected by the -aa option.
                     80: 
                     81: -bb _b_a_u_d_r_a_t_e
                     82:      Set the baud rate of the device to _b_a_u_d_r_a_t_e.
                     83: 
                     84: -cc   Connect to  serial port, and  pass all subsequent  typing to
                     85:      that port  To resume talking to your  local system, type the
                     86:      escape  character followed  by the  letter `c'.   The escape
                     87:      character is  set by default  to <ccttrrll-\>, although  you can
                     88:      change it if you wish.
                     89: 
                     90: -dd   Debug  mode  -- record  debugging  information  in the  file
                     91:      ddeebbuugg.lloogg in the current directory.
                     92: 
                     93: -ee _n Set  the length  of the  packet  to _n  where _n  is a  number
                     94:      between  ten and  about  1,000.  Lengths  of  95 or  greater
                     95:      require  that the  implementation  of kkeerrmmiitt  on the  remote
                     96:      system  support  the  long-packet  extension to  the  kkeerrmmiitt
                     97:      protocol.
                     98: 
                     99: -ff   Send a ``finish'' command to a remote server.
                    100: 
                    101: -gg _f_i_l_e
                    102:      Ask a  remote system  to send _f_i_l_e  or _f_i_l_e_s. The  file name
                    103:      must use the remote  system's own syntax; you must quote all
                    104:      characters normally expanded by the COHERENT shell, e.g.:
                    105: 
                    106: 
                    107:         ckermit -g x\*.\?
                    108: 
                    109: 
                    110: -hh   Help  --  display  a  brief  synopsis  of  the  command-line
                    111:      options.
                    112: 
                    113: -ii   The   ``image''  option:   specify  that   the   file  being
                    114:      transmitted  or received  is an  eight-bit binary  file, and
                    115:      therefore no  conversion should  be performed upon  the data
                    116:      being received.
                    117: 
                    118: -kk   Passively receive  file or  files, copying them  to standard
                    119:      output.
                    120: 
                    121: -ll _d_e_v_i_c_e
                    122:      Name the serial device to be used.  For example
                    123: 
                    124: 
                    125: 
                    126: 
                    127: 
                    128: 
                    129: 
                    130: COHERENT Lexicon                                           Page 2
                    131: 
                    132: 
                    133: 
                    134: 
                    135: ckermit                      Command                      ckermit
                    136: 
                    137: 
                    138: 
                    139:         ckermit -l /dev/com2
                    140: 
                    141: 
                    142: tells cckkeerrmmiitt to use device /ddeevv/ccoomm22.
                    143: 
                    144: -nn   Like -cc, but used after a protocol transaction has occurred.
                    145:      You can use both -cc and -nn in the same command.
                    146: 
                    147: -pp _x Set  parity,  where   _x  is  one  of  ee,  oo,   mm,  ss,  or  nn
                    148:      (respectively, even, odd,  mark, space, or none).  If parity
                    149:      is  other  than  none,  then  cckkeerrmmiitt  uses  the  eighth-bit
                    150:      prefixing  mechanism to transfer  binary data,  provided the
                    151:      impementation of  kkeerrmmiitt on  the remote system  agrees.  The
                    152:      default parity is none.
                    153: 
                    154: -qq   Quiet --  suppress screen  update during file  transfer; for
                    155:      example, this lets you transfer a file in the background.
                    156: 
                    157: -rr   Receive  a  file  or files.   Wait  passively  for files  to
                    158:      arrive.
                    159: 
                    160: -ss _f_i_l_e
                    161:      Send the specified _f_i_l_e or  _f_i_l_e_s. If _f_n is `-' then cckkeerrmmiitt
                    162:      sends from standard input, which may come from a file:
                    163: 
                    164: 
                    165:         ckermit -s - < foo.bar
                    166: 
                    167: 
                    168: or come from a parallel process:
                    169: 
                    170: 
                    171:         ls -l | ckermit -s -
                    172: 
                    173: 
                    174: You  cannot  use  this mechanism  to  send  text  typed from  the
                    175: keyboard.  To send a file named `-', precede it with a path name,
                    176: e.g.:
                    177: 
                    178: 
                    179:         ckermit -s ./-
                    180: 
                    181: 
                    182: -tt   Specify  half  duplex,  line  turnaround  with  XON  as  the
                    183:      handshake character.
                    184: 
                    185: -ww   Write-Protect  -- avoid  file-name  collisions for  incoming
                    186:      files.
                    187: 
                    188: -xx   Begin server  operation.  This option can  be used in either
                    189:      local or remote mode.
                    190: 
                    191: If   cckkeerrmmiitt is  in local  mode, shows the  progress of  the file
                    192: transfer.  A  dot is printed  for every four  data packets; other
                    193: packets  are shown  by  type (e.g.,  `S' for  Send-Init); `T'  is
                    194: 
                    195: 
                    196: COHERENT Lexicon                                           Page 3
                    197: 
                    198: 
                    199: 
                    200: 
                    201: ckermit                      Command                      ckermit
                    202: 
                    203: 
                    204: 
                    205: printed  when there's  a  timeout; and  `%' is  printed for  each
                    206: retransmission.
                    207: 
                    208: During file  transfer, you  can type the  following ``interrupt''
                    209: commands:
                    210: 
                    211: <ccttrrll-FF>
                    212:      Interrupt the current file and go on to the next, if any.
                    213: 
                    214: <ccttrrll-BB>
                    215:      Interrupt  the  entire  batch  of  files and  terminate  the
                    216:      transaction.
                    217: 
                    218: <ccttrrll-RR>
                    219:      Resend the current packet.
                    220: 
                    221: <ccttrrll-AA>
                    222:      Display a status report for the current transaction.
                    223: 
                    224: These  interrupt characters  differ from the  ones used  in other
                    225: implementations of  cckkeerrmmiitt to  avoid conflict with  the COHERENT
                    226: shell's interrupt characters.
                    227: 
                    228: ***** Interactive Operation *****
                    229: 
                    230: When  you invoke  cckkeerrmmiitt in  interactive  mode, it  displays the
                    231: following prompt.
                    232: 
                    233: 
                    234:         C-Kermit>
                    235: 
                    236: 
                    237: Type  any valid  cckkeerrmmiitt command;  the set  of valid  commands is
                    238: described below.   cckkeerrmmiitt executes the command  and then prompts
                    239: you  for another.   The process  continues until  you tell  it to
                    240: quit.
                    241: 
                    242: Commands begin with a  keyword, normally an English verb, such as
                    243: sseenndd. You can abbreviate any  keyword, as long as you type enough
                    244: characters to  distinguish it  from all other  keywords.  Certain
                    245: commonly  used  keywords  (e.g.,  sseenndd,  rreecceeiivvee,  ccoonnnneecctt)  hhaavvee
                    246: ssppeecciiaall  nnoonn-uunniiqquuee aabbbbrreevviiaattiioonnss  (rreessppeeccttiivveellyy,  `ss', `rr',  aanndd
                    247: `cc').
                    248: 
                    249: CCeerrttaaiinn   cchhaarraacctteerrss  hhaavvee   ssppeecciiaall  ffuunnccttiioonnss   iinn  iinntteerraaccttiivvee
                    250: ccoommmmaannddss:
                    251: 
                    252: ?    Print a  message that explains what  is possible or expected
                    253:      at the  current point within a  command.  Depending upon the
                    254:      context,  the  message may  be  a brief  phrase,  a menu  of
                    255:      keywords, or a list of files.
                    256: 
                    257: <eesscc>
                    258:      Request completion  of the current keyword  or file name, or
                    259:      insertion  of a  default value.   cckkeerrmmiitt  will beep  if the
                    260: 
                    261: 
                    262: COHERENT Lexicon                                           Page 4
                    263: 
                    264: 
                    265: 
                    266: 
                    267: ckermit                      Command                      ckermit
                    268: 
                    269: 
                    270: 
                    271:      requested operation fails.  <ttaabb> does the same thing.
                    272: 
                    273: <ddeell>
                    274:      Delete the previous character from the command.  <bbaacckkssppaaccee>
                    275:      does the same thing.
                    276: 
                    277: <ccttrrll-WW>
                    278:      Erase the rightmost word from the command line.
                    279: 
                    280: <ccttrrll-UU>
                    281:      Erase the entire command.
                    282: 
                    283: <ccttrrll-RR>
                    284:      Redisplay the current command.
                    285: 
                    286: <ssppaaccee>
                    287:      Delimit  fields  (keywords,  filenames,  numbers)  within  a
                    288:      command.
                    289: 
                    290: <rreettuurrnn>
                    291:      Execute the command.
                    292: 
                    293: \    Insert  any  of  the  above  characters  into  the  command,
                    294:      literally.    To  enter  a   literal  backslash,   type  two
                    295:      backslashes in a row (\\).  Typing one backslash immediately
                    296:      <rreettuurrnn> lets you continue the command on the next line.
                    297: 
                    298: cckkeerrmmiitt recognizes the following interactive commands:
                    299: 
                    300: ! _c_o_m_m_a_n_d
                    301:      Execute a shell command.  A space must follow the !.
                    302: 
                    303: %    A comment.  cckkeerrmmiitt ignores everything that follows the %.
                    304: 
                    305: bbyyee  Terminate and log out a remote kkeerrmmiitt server.
                    306: 
                    307: cclloossee
                    308:      Close a log file.
                    309: 
                    310: ccoonnnneecctt
                    311:      Connect to the remote system.
                    312: 
                    313: ccwwdd _d_i_r_e_c_t_o_r_y
                    314:      Change the working directory to _d_i_r_e_c_t_o_r_y.
                    315: 
                    316: ddiiaall Dial a telephone number.
                    317: 
                    318: ddiirreeccttoorryy
                    319:      Display a directory listing.
                    320: 
                    321: eecchhoo Display arguments literally.  Useful in take-command files.
                    322: 
                    323: eexxiitt Exit from the program, closing any open logs.
                    324: 
                    325: 
                    326: 
                    327: 
                    328: COHERENT Lexicon                                           Page 5
                    329: 
                    330: 
                    331: 
                    332: 
                    333: ckermit                      Command                      ckermit
                    334: 
                    335: 
                    336: 
                    337: ffiinniisshh
                    338:      Instruct a remote  kkeerrmmiitt server to exit, but not log out.
                    339: 
                    340: ggeett  Get files from a remote  kkeerrmmiitt server.
                    341: 
                    342: hhaanngguupp
                    343:      Hang up the telephone.
                    344: 
                    345: hheellpp Display a help message for a given command.
                    346: 
                    347: lloogg  Open a log file -- debugging, packet, session, transaction.
                    348: 
                    349: qquuiitt Same as eexxiitt.
                    350: 
                    351: rreecceeiivvee
                    352:      Passively wait for files to arrive.
                    353: 
                    354: rreemmoottee
                    355:      Issue file-management commands to a remote kkeerrmmiitt server.
                    356: 
                    357: ssccrriipptt
                    358:      Execute a login script with a remote system.
                    359: 
                    360: sseenndd _f_i_l_e
                    361:      Send _f_i_l_e to the remote kkeerrmmiitt server.
                    362: 
                    363: sseerrvveerr
                    364:      Begin server operation.
                    365: 
                    366: sseett  Set various internal parameters.
                    367: 
                    368: sshhooww Display values of parameters, program version, etc.
                    369: 
                    370: ssppaaccee
                    371:      Display current disk space usage.
                    372: 
                    373: ssttaattiissttiiccss
                    374:      Display statistics about most recent transaction.
                    375: 
                    376: ttaakkee Execute commands from a file.
                    377: 
                    378: Interactive  cckkeerrmmiitt accepts  commands from files as well as from
                    379: the keyboard.   Upon startup, cckkeerrmmiitt looks  for the file .kkeerrmmrrcc
                    380: first in directory $HHOOMMEE and then in the current directory; if it
                    381: finds the file, it executes all commands it finds therein.  These
                    382: commands  must be  in interactive format.   Command files  may be
                    383: nested to any reasonable depth.
                    384: 
                    385: ***** The set Command *****
                    386: 
                    387: As  noted  above,  the sseett  command  lets  you  set the  internal
                    388: parameters by which cckkeerrmmiitt operates.  The sseett command recognizes
                    389: the following arguments:
                    390: 
                    391: 
                    392: 
                    393: 
                    394: COHERENT Lexicon                                           Page 6
                    395: 
                    396: 
                    397: 
                    398: 
                    399: ckermit                      Command                      ckermit
                    400: 
                    401: 
                    402: 
                    403: bblloocckk-cchheecckk
                    404:      Level of packet error detection.
                    405: 
                    406: ddeellaayy
                    407:      Time to wait before sending first packet.
                    408: 
                    409: dduupplleexx
                    410:      Specify which side echoes during connect mode.
                    411: 
                    412: eessccaappee-cchhaarraacctteerr
                    413:      Character to prefix _e_s_c_a_p_e _c_o_m_m_a_n_d_s during connect mode.
                    414: 
                    415: ffiillee Set various file parameters.
                    416: 
                    417: ffllooww-ccoonnttrrooll
                    418:      Communication line full-duplex flow control.
                    419: 
                    420: hhaannddsshhaakkee
                    421:      Communication line half-duplex turnaround character.
                    422: 
                    423: lliinnee Communication-line device name.
                    424: 
                    425: mmooddeemm-ddiiaalleerr
                    426:      Type of modem-dialer on communication line.
                    427: 
                    428: ppaarriittyy
                    429:      Communication line character parity.
                    430: 
                    431: pprroommpptt
                    432:      Change the  cckkeerrmmiitt program's prompt.
                    433: 
                    434: rreecceeiivvee
                    435:      Set various parameters for inbound packets.
                    436: 
                    437: rreettrryy
                    438:      Set the packet retransmission limit.
                    439: 
                    440: sseenndd Set various parameters for outbound packets.
                    441: 
                    442: ssppeeeedd
                    443:      Communication line speed.
                    444: 
                    445: ***** Remote Commands *****
                    446: 
                    447: cckkeerrmmiitt also has a suite of  commands that are sent to the remote
                    448: system for execution.  They are as follows:
                    449: 
                    450: ccwwdd  Change remote working directory (also, rreemmoottee ccdd).
                    451: 
                    452: ddeelleettee
                    453:      Delete remote files.
                    454: 
                    455: ddiirreeccttoorryy
                    456:      Display a listing of remote file names.
                    457: 
                    458: 
                    459: 
                    460: COHERENT Lexicon                                           Page 7
                    461: 
                    462: 
                    463: 
                    464: 
                    465: ckermit                      Command                      ckermit
                    466: 
                    467: 
                    468: 
                    469: hheellpp Request help from a remote server.
                    470: 
                    471: hhoosstt Issue  a  command to  the  remote host  in  its own  command
                    472:      language.
                    473: 
                    474: ssppaaccee
                    475:      Display current disk space usage on remote system.
                    476: 
                    477: ttyyppee Display a remote file on your screen.
                    478: 
                    479: wwhhoo  Display the  users logged  in to  the remote system,  or get
                    480:      information about a user.
                    481: 
                    482: ***** Files *****
                    483: 
                    484: .kkeerrmmrrcc -- cckkeerrmmiitt initialization commands
                    485: 
                    486: ***** See Also *****
                    487: 
                    488: ccoommmmaannddss, kkeerrmmiitt, uuuuccpp
                    489: 
                    490: ***** Notes *****
                    491: 
                    492: The  kkeerrmmiitt protocol  was  developed at  the Columbia  University
                    493: Center for Computing Activities.
                    494: 
                    495: 
                    496: 
                    497: 
                    498: 
                    499: 
                    500: 
                    501: 
                    502: 
                    503: 
                    504: 
                    505: 
                    506: 
                    507: 
                    508: 
                    509: 
                    510: 
                    511: 
                    512: 
                    513: 
                    514: 
                    515: 
                    516: 
                    517: 
                    518: 
                    519: 
                    520: 
                    521: 
                    522: 
                    523: 
                    524: 
                    525: 
                    526: COHERENT Lexicon                                           Page 8
                    527: 
                    528: 

unix.superglobalmegacorp.com

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