Annotation of researchv10dc/lbin/kermit/ckuker.nr, revision 1.1

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

unix.superglobalmegacorp.com

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