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