home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / archives / ckc072.zip / ckuker.lp < prev    next >
Text File  |  1989-02-06  |  19KB  |  628 lines
  1.  
  2.  
  3.  
  4.                                                        KERMIT(1C)
  5.  
  6.  
  7.  
  8. NAME
  9.      kermit - kermit file transfer
  10.  
  11. SYNOPSIS
  12.      kermit [ option ...] [file ...]
  13.  
  14. DESCRIPTION
  15.      Kermit is a file transfer program that allows files to be
  16.      moved between machines of many different operating systems
  17.      and architectures.  This man page describes version 4E(072)
  18.      of the program.  See the C-Kermit documentation (ckuker.doc)
  19.      or the Kermit book for further information.
  20.  
  21.      Arguments are optional. If Kermit is executed without argu-
  22.      ments, it will enter command mode. Otherwise, kermit will
  23.      read the arguments off the command line and interpret them.
  24.  
  25.      The following notation is used in command descriptions:
  26.  
  27.      fn      A Unix file specification, possibly containing
  28.              either of the "wildcard" characters '*' or '?' ('*'
  29.              matches all character strings, '?' matches any sin-
  30.              gle character).
  31.  
  32.      fn1     A Unix file specification which may not contain '*'
  33.              or '?'.
  34.  
  35.      rfn     A remote file specification in the remote system's
  36.              own syntax, which may denote a single file or a
  37.              group of files.
  38.  
  39.      rfn1    A remote file specification which should denote only
  40.              a single file.
  41.  
  42.      n       A decimal number, in most cases between 0 and 94.
  43.  
  44.      c       A decimal number between 0 and 127 representing the
  45.              value of an ASCII character.
  46.  
  47.      cc      A decimal number between 0 and 31, or else exactly
  48.              127, representing the value of an ASCII control
  49.              character.
  50.  
  51.      [ ]     Any field in square braces is optional.
  52.  
  53.      {x,y,z} Alternatives are listed in curly braces.
  54.  
  55.      Kermit command line options may specify either actions or
  56.      settings.  If Kermit is invoked with a command line that
  57.      specifies no actions, then it will issue a prompt and begin
  58.      interactive dialog.  Action options specify either protocol
  59.      transactions or terminal connection.
  60.  
  61.  
  62.  
  63.                                                                 1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. KERMIT(1C)
  71.  
  72.  
  73.  
  74.      COMMAND LINE OPTIONS
  75.  
  76.      -s fn   Send the specified file or files. If fn contains
  77.              wildcard (meta) characters, the Unix shell expands
  78.              it into a list.  If fn is '-' then Kermit sends from
  79.              standard input, which may come from a file:
  80.  
  81.                          kermit -s - < foo.bar
  82.  
  83.              or a parallel process:
  84.  
  85.                          ls -l | kermit -s -
  86.  
  87.              You cannot use this mechanism to send terminal
  88.              typein.  If you want to send a file whose name is
  89.              "-" you can precede it with a path name, as in
  90.  
  91.                          kermit -s ./-
  92.  
  93.      -r      Receive a file or files.  Wait passively for files
  94.              to arrive.
  95.  
  96.      -k      Receive (passively) a file or files, sending them to
  97.              standard output.  This option can be used in several
  98.              ways:
  99.  
  100.                      kermit -k
  101.  
  102.              Displays the incoming files on your screen; to be
  103.              used only in "local mode" (see below).
  104.  
  105.                      kermit -k > fn1
  106.  
  107.              Sends the incoming file or files to the named file,
  108.              fn1. If more than one file arrives, all are con-
  109.              catenated together into the single file fn1.
  110.  
  111.                      kermit -k | command
  112.  
  113.              Pipes the incoming data (single or multiple files)
  114.              to the indicated command, as in
  115.  
  116.                      kermit -k | sort > sorted.stuff
  117.  
  118.      -a fn1  If you have specified a file transfer option, you
  119.              may specify an alternate name for a single file with
  120.              the -a option.  For example,
  121.  
  122.                      kermit -s foo -a bar
  123.  
  124.              sends the file foo telling the receiver that its
  125.              name is bar.  If more than one file arrives or is
  126.              sent, only the first file is affected by the -a
  127.              option:
  128.  
  129.                      kermit -ra baz
  130.  
  131.  
  132.  
  133.  
  134. 2
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.                                                        KERMIT(1C)
  142.  
  143.  
  144.  
  145.              stores the first incoming file under the name baz.
  146.  
  147.      -x      Begin server operation.  May be used in either local
  148.              or remote mode.
  149.  
  150.      Before proceeding, a few words about remote and local opera-
  151.      tion are  necessary.  Kermit is "local" if it is running on
  152.      a PC or workstation that you are using directly, or if it is
  153.      running on a multiuser system and transferring files over an
  154.      external communication line - not your job's controlling
  155.      terminal or console.  Kermit is remote if it is running on a
  156.      multiuser system and transferring files over its own con-
  157.      trolling terminal's communication line, connected to your PC
  158.      or workstation.
  159.  
  160.      If you are running Kermit on most systems, Kermit runs in
  161.      remote mode by default, so on a PC or workstation, you will
  162.      have to put it into local mode.  The following command sets
  163.      Kermit's "mode":
  164.  
  165.      -l dev  Line - Specify a terminal line to use for file
  166.              transfer and terminal connection, as in
  167.  
  168.                          kermit -l /dev/ttyi5
  169.  
  170.      When an external line is being used, you might also need
  171.      some additional options for successful communication with
  172.      the remote system:
  173.  
  174.      -b n Baud - Specify the baud rate for the line given in the
  175.           -l option, as in
  176.  
  177.                       kermit -l /dev/ttyi5 -b 9600
  178.  
  179.           This option should always be included with the -l
  180.           option, since the speed of an external line is not
  181.           necessarily what you might expect.
  182.  
  183.      -p x Parity - e, o, m, s, n (even, odd, mark, space, or
  184.           none).  If parity is other than none, then the 8th-bit
  185.           prefixing mechanism will be used for transferring 8-bit
  186.           binary data, provided the opposite Kermit agrees. The
  187.           default parity is none.
  188.  
  189.      -t   Specifies half duplex, line turnaround with XON as the
  190.           handshake character.
  191.  
  192.      The following commands may be used only with a Kermit which
  193.      is local - either by default or else because the -l option
  194.      has been specified.
  195.  
  196.      -g rfn  Actively request a remote server to send the named
  197.              file or files; rfn is a file specification in the
  198.  
  199.  
  200.  
  201.                                                                 3
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208. KERMIT(1C)
  209.  
  210.  
  211.  
  212.              remote host's own syntax.  If fn happens to contain
  213.              any special shell characters, like '*', these must
  214.              be quoted, as in
  215.  
  216.                          kermit -g x\*.\?
  217.  
  218.      -f      Send a 'finish' command to a remote server.
  219.  
  220.      -c      Establish a terminal connection over the specified
  221.              or default communication line, before any protocol
  222.              transaction takes place.  Get back to the local sys-
  223.              tem by typing the escape character (normally
  224.              Control-Backslash) followed by the letter 'c'.
  225.  
  226.      -n      Like -c, but after a protocol transaction takes
  227.              place; -c and -n may both be used in the same com-
  228.              mand.  The use of -n and -c is illustrated below.
  229.  
  230.      On a timesharing system, the -l and -b options will also
  231.      have to be included with the -r, -k, or -s options if the
  232.      other Kermit is on a remote system.
  233.  
  234.      If kermit is in local mode, the screen (stdout) is con-
  235.      tinously updated to show the progress of the file transer.
  236.      A dot is printed for every four data packets, other packets
  237.      are shown by type (e.g. 'S' for Send-Init), 'T' is printed
  238.      when there's a timeout, and '%' for each retransmission.  In
  239.      addition, you may type (to stdin) certain "interrupt" com-
  240.      mands during file transfer:
  241.  
  242.           Control-F:  Interrupt the current File, and go on to
  243.           the next (if any).
  244.  
  245.           Control-B:  Interrupt the entire Batch of files, ter-
  246.           minate the transaction.
  247.  
  248.           Control-R:  Resend the current packet
  249.  
  250.           Control-A:  Display a status report for the current
  251.           transaction.
  252.  
  253.  
  254.      These interrupt characters differ from the ones used in
  255.      other Kermit implementations to avoid conflict with Unix
  256.      shell interrupt characters.  With System III and System V
  257.      implementations of Unix, interrupt commands must be pre-
  258.      ceeded by the escape character (e.g. control-\).
  259.  
  260.      Several other command-line options are provided:
  261.  
  262.      -i      Specifies that files should be sent or received
  263.              exactly "as is" with no conversions.  This option is
  264.              necessary for transmitting binary files.  It may
  265.  
  266.  
  267.  
  268. 4
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.                                                        KERMIT(1C)
  276.  
  277.  
  278.  
  279.              also be used to slightly boost efficiency in Unix-
  280.              to-Unix transfers of text files by eliminating
  281.              CRLF/newline conversion.
  282.  
  283.      -e  n   Specifies the (extended) receive-packet length, a
  284.              number between 10 and about 1000 (depending on the
  285.              system).  Lengths of 95 or greater require that the
  286.              opposite Kermit support the long packet protocol
  287.              extension.
  288.  
  289.      -w      Write-Protect - Avoid filename collisions for incom-
  290.              ing files.
  291.  
  292.      -q      Quiet - Suppress screen update during file transfer,
  293.              for instance to allow a file transfer to proceed in
  294.              the background.
  295.  
  296.      -d      Debug - Record debugging information in the file
  297.              debug.log in the current directory.  Use this option
  298.              if you believe the program is misbehaving, and show
  299.              the resulting log to your local Kermit maintainer.
  300.  
  301.      -h      Help - Display a brief synopsis of the command line
  302.              options.
  303.  
  304.      The command line may contain no more than one protocol
  305.      action option.
  306.  
  307.      INTERACTIVE OPERATION
  308.  
  309.      Kermit's interactive command prompt is "C-Kermit>". In
  310.      response to this prompt, you may type any valid command.
  311.      Kermit executes the command and then prompts you for another
  312.      command.  The process continues until you instruct the pro-
  313.      gram to terminate.
  314.  
  315.      Commands begin with a keyword, normally an English verb,
  316.      such as "send".  You may omit trailing characters from any
  317.      keyword, so long as you specify sufficient characters to
  318.      distinguish it from any other keyword valid in that field.
  319.      Certain commonly-used keywords (such as "send", "receive",
  320.      "connect") have special non-unique abbreviations ("s" for
  321.      "send", "r" for "receive", "c" for "connect").
  322.  
  323.      Certain characters have special functions in interactive
  324.      commands:
  325.  
  326.      ?       Question mark, typed at any point in a command, will
  327.              produce a message explaining what is possible or
  328.              expected at that point.  Depending on the context,
  329.              the message may be a brief phrase, a menu of key-
  330.              words, or a list of files.
  331.  
  332.  
  333.  
  334.                                                                 5
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341. KERMIT(1C)
  342.  
  343.  
  344.  
  345.      ESC     (The Escape or Altmode key) - Request completion of
  346.              the current keyword or filename, or insertion of a
  347.              default value.  The result will be a beep if the
  348.              requested operation fails.  Tab does the same thing.
  349.  
  350.      DEL     (The Delete or Rubout key) - Delete the previous
  351.              character from the command.  You may also use BS
  352.              (Backspace, Control-H) for this function.
  353.  
  354.      ^W      (Control-W) - Erase the rightmost word from the com-
  355.              mand line.
  356.  
  357.      ^U      (Control-U) - Erase the entire command.
  358.  
  359.      ^R      (Control-R) - Redisplay the current command.
  360.  
  361.      SP      (Space) - Delimits fields (keywords, filenames,
  362.              numbers) within a command.
  363.  
  364.      CR      (Carriage Return) - Enters the command for execu-
  365.              tion.  LF (Linefeed) or FF (formfeed) may also be
  366.              used for this purpose.
  367.  
  368.      \       (Backslash) - Enter any of the above characters into
  369.              the command, literally.  To enter a backslash, type
  370.              two backslashes in a row (\\).  A single backslash
  371.              immediately preceding a carriage return allows you
  372.              to continue the command on the next line.
  373.  
  374.  
  375.      You may type the editing characters (DEL, ^W, etc) repeat-
  376.      edly, to delete all the way back to the prompt.  No action
  377.      will be performed until the command is entered by typing
  378.      carriage return, linefeed, or formfeed.  If you make any
  379.      mistakes, you will receive an informative error message and
  380.      a new prompt - make liberal use of '?' and ESC to feel your
  381.      way through the commands.  One important command is "help" -
  382.      you should use it the first time you run Kermit.
  383.  
  384.      Interactive Kermit accepts commands from files as well as
  385.      from the keyboard.  Upon startup, Kermit looks for the file
  386.      .kermrc in your home or current directory (first it looks in
  387.      the home directory, then in the current one) and executes
  388.      any commands it finds there.  These commands must be in
  389.      interactive format, not Unix command-line format.  A "take"
  390.      command is also provided for use at any time during an
  391.      interactive session.  Command files may be nested to any
  392.      reasonable depth.
  393.  
  394.      Here is a brief list of Kermit interactive commands:
  395.  
  396.      ! command   Execute a Unix shell command.  A space is
  397.                  required after after the !.
  398.  
  399.  
  400.  
  401. 6
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.                                                        KERMIT(1C)
  409.  
  410.  
  411.  
  412.      % text      A comment.  Useful in take-command files.
  413.  
  414.      bye         Terminate and log out a remote Kermit server.
  415.  
  416.      close       Close a log file.
  417.  
  418.      connect     Establish a terminal connection to a remote sys-
  419.                  tem.
  420.  
  421.      cwd         Change Working Directory (also, "cd").
  422.  
  423.      dial        Dial a telephone number.
  424.  
  425.      directory   Display a directory listing.
  426.  
  427.      echo        Display arguments literally.  Useful in take-
  428.                  command files.
  429.  
  430.      exit        Exit from the program, closing any open logs.
  431.  
  432.      finish      Instruct a remote Kermit server to exit, but not
  433.                  log out.
  434.  
  435.      get         Get files from a remote Kermit server.
  436.  
  437.      hangup      Hang up the phone.
  438.  
  439.      help        Display a help message for a given command.
  440.  
  441.      log         Open a log file - debugging, packet, session,
  442.                  transaction.
  443.  
  444.      quit        Same as 'exit'.
  445.  
  446.      receive     Passively wait for files to arrive.
  447.  
  448.      remote      Issue file management commands to a remote Ker-
  449.                  mit server.
  450.  
  451.      script      Execute a login script with a remote system.
  452.  
  453.      send        Send files.
  454.  
  455.      server      Begin server operation.
  456.  
  457.      set         Set various parameters.
  458.  
  459.      show        Display values of 'set' parameters, program ver-
  460.                  sion, etc.
  461.  
  462.      space       Display current disk space usage.
  463.  
  464.      statistics  Display statistics about most recent transac-
  465.                  tion.
  466.  
  467.      take        Execute commands from a file.
  468.  
  469.  
  470.      The 'set' parameters are:
  471.  
  472.      block-check          Level of packet error detection.
  473.  
  474.      delay                How long to wait before sending first
  475.                           packet.
  476.  
  477.      duplex               Specify which side echoes during
  478.  
  479.  
  480.  
  481.                                                                 7
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488. KERMIT(1C)
  489.  
  490.  
  491.  
  492.                           'connect'.
  493.  
  494.      escape-character     Character to prefix "escape commands"
  495.                           during 'connect'.
  496.  
  497.      file                 Set various file parameters.
  498.  
  499.      flow-control         Communication line full-duplex flow
  500.                           control.
  501.  
  502.      handshake            Communication line half-duplex tur-
  503.                           naround character.
  504.  
  505.      line                 Communication line device name.
  506.  
  507.      modem-dialer         Type of modem-dialer on communication
  508.                           line.
  509.  
  510.      parity               Communication line character parity.
  511.  
  512.      prompt               Change the Kermit program's prompt.
  513.  
  514.      receive              Set various parameters for inbound
  515.                           packets.
  516.  
  517.      retry                Set the packet retransmission limit.
  518.  
  519.      send                 Set various parameters for outbound
  520.                           packets.
  521.  
  522.      speed                Communication line speed.
  523.  
  524.  
  525.      The 'remote' commands are:
  526.  
  527.      cwd         Change remote working directory (also, "remote
  528.                  cd").
  529.  
  530.      delete      Delete remote files.
  531.  
  532.      directory   Display a listing of remote file names.
  533.  
  534.      help        Request help from a remote server.
  535.  
  536.      host        Issue a command to the remote host in its own
  537.                  command language.
  538.  
  539.      space       Display current disk space usage on remote sys-
  540.                  tem.
  541.  
  542.      type        Display a remote file on your screen.
  543.  
  544.      who         Display who's logged in, or get information
  545.                  about a user.
  546.  
  547. FILES
  548.      $HOME/.kermrc  Kermit initialization commands
  549.      ./.kermrc      more Kermit initialization commands
  550.  
  551. SEE ALSO
  552.      cu(1C), uucp(1C)
  553.      Christine Gianone, Kermit User's Guide, Columbia University, 7th
  554.      Edition
  555.  
  556.  
  557.  
  558. 8
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.                                                        KERMIT(1C)
  566.  
  567.  
  568.  
  569.      Frank da Cruz,
  570.           Kermit, A File Transfer Protocol, Digital Press (1987)
  571.  
  572.      The file ckuker.doc.
  573.  
  574. DIAGNOSTICS
  575.      The diagnostics produced by Kermit itself are intended to be
  576.      self-explanatory.
  577.  
  578. BUGS
  579.      See recent issues of the Info-Kermit digest (on the Inter-
  580.      network, BITNET, USENET, etc), or the file ckuker.bwr, for a
  581.      list of bugs.  See the file ckuker.upd for descriptions of
  582.      bugs that were fixed in each release.
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.  
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.  
  622.  
  623.  
  624.                                                                 9
  625.  
  626.  
  627.  
  628.