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