home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / archives / cku196.tar.Z / cku196.tar / ckuker.cpp < prev    next >
C/C++ Source or Header  |  2000-01-02  |  48KB  |  1,151 lines
  1. .\" @(#) kermit.1 7.0.196 2000/01/01 Columbia University
  2. #ifdef COMMENT
  3. This man page must be run through the C-Kermit makefile before it can
  4. be used: "make manpage".  Or you can do the following:
  5.   cc -E ckuker.cpp | grep -v ^$ | grep -v ^\# > ckuker.nr
  6. to produce the nroff source file.  THIS FILE MUST NOT CONTAIN ANY BLANK LINES!
  7. Use .sp or similar commands to produce blank lines in the nroff output.
  8. #endif /* COMMENT */
  9. #ifdef SUNOS4
  10. #define SUNOS
  11. #else
  12. #ifdef SUNOS41
  13. #define SUNOS
  14. #else
  15. #ifdef SOLARIS
  16. #define SUNOS
  17. #endif
  18. #endif
  19. #endif
  20. #ifdef HPUX10
  21. .TH KERMIT 1 "1 Jan 2000" "HP-UX C-Kermit"
  22. #define DIALOUT /dev/cul0p0
  23. #define HARDWIRE /dev/tty0p0
  24. #else
  25. .TH KERMIT 1C "1 Jan 2000" "UNIX C-Kermit"
  26. #ifdef LINUX
  27. #define DIALOUT /dev/ttyS0
  28. #else
  29. #define DIALOUT /dev/cua
  30. #endif
  31. #define HARDWIRE /dev/tty01
  32. #endif
  33. .SH NAME
  34. kermit \- C-Kermit 7.0 communications software for serial and network
  35. connections: modem dialing, file transfer and management, terminal connection,
  36. character-set translation, numeric and alpha paging, and script programming.
  37. .SH SYNOPSIS
  38. .B kermit
  39. [ command-file ] [ options ... ]
  40. .SH DESCRIPTION
  41. .I Kermit
  42. is a family of file transfer, management, and communication software programs
  43. from the Kermit Project at Columbia University available for most computers
  44. and operating systems.
  45. #ifdef HPUX10
  46. The version of Kermit for Hewlett-Packard HP-UX, called
  47. #else
  48. #ifdef SUNOS
  49. The version of Kermit for SunOS and Solaris, called
  50. #else
  51. The UNIX version of Kermit, called
  52. #endif
  53. #endif
  54. .IR "C-Kermit",
  55. #ifdef HPUX10
  56. supports both serial connections (direct or dialed) and TCP/IP connections.
  57. #else
  58. #ifdef SUNOS
  59. supports serial connections (direct or dialed),
  60. TCP/IP connections, and on systems equipped with
  61. SunLink X.25, C-Kermit can also make X.25 connections.
  62. #else
  63. supports serial connections (direct or dialed) and, in most UNIX
  64. implementations, also TCP/IP connections.  On certain platforms,
  65. C-Kermit can also make X.25 connections.
  66. #endif
  67. #endif
  68. C-Kermit can be thought of as a user-friendly and powerful alternative to cu,
  69. tip, uucp, ftp, telnet, rlogin, expect, and even your shell; a single package
  70. for both network and serial communications, offering automation, convenience,
  71. and language features not found in the other packages, and having a great deal
  72. in common with its cousins, C-Kermit on other UNIX platforms, Kermit 95 for
  73. Windows 95, Windows 98, Windows NT and 2000, and OS/2; MS-DOS Kermit for PCs
  74. with DOS and Windows 3.x, and IBM Mainframe Kermit-370 for VM/CMS, MVS/TSO,
  75. and CICS.  C-Kermit itself also runs on Digital VMS, Data General AOS/VS,
  76. Stratus VOS, OS-9, QNX, Plan 9, the Commodore Amiga, and elsewhere.
  77. Together, C-Kermit, Kermit 95, MS-DOS Kermit, and IBM Mainframe Kermit offer a
  78. consistent and nearly universal approach to inter-computer communications.
  79. .PP
  80. C-Kermit 7.0 is Copyright (C) 1985, 2000 by the Trustees of Columbia
  81. University in the City of New York.  For use and redistribution rights,
  82. see the C-Kermit COPYING.TXT file or give the C-Kermit COPYRIGHT command
  83. (summary: no license is required for own use;
  84. no license is required for distribution with Open Source operating systems;
  85. a license is required for certain other forms of redistribution).
  86. .PP
  87. #ifdef HPUX10
  88. C-Kermit 7.0 is included with HP-UX 10.00 and later by Hewlett-Packard in
  89. partnership with the Kermit Project at Columbia University.
  90. #endif
  91. .PP
  92. C-Kermit 6.0 is thoroughly documented in the book
  93. .IR "Using C-Kermit"
  94. by Frank da Cruz and Christine M. Gianone, Digital Press, Second Edition,
  95. 1997; see REFERENCES
  96. at the end of this manual page.  This manual page is not a substitute for the
  97. book.  If you are a serious user of C-Kermit, particularly if plan to write
  98. C-Kermit script programs, you should purchase the manual.  Book sales are the
  99. primary source of funding for the nonprofit Kermit Project.
  100. .PP
  101. Any new features added since the second edition of the book was
  102. published are documented in the online file
  103. .IR "ckermit2.upd"
  104. until such time as the Third Edition of the book is ready.
  105. Hints, tips, limitations, restrictions are listed in
  106. .IR "ckcbwr.txt"
  107. (general C-Kermit) and
  108. .IR "ckuker.bwr"
  109. (UNIX-specific); see FILES below.  Please consult all of these references
  110. before reporting problems or asking for technical support.
  111. .PP
  112. Kermit software is available for hundreds of different computers and operating
  113. systems from Columbia University.  For best file-transfer results, please use
  114. C-Kermit in conjunction with real Columbia University Kermit software on other
  115. computers, such as Kermit 95 for Windows 95 and NT or MS-DOS Kermit for DOS
  116. 3.x or Windows.  See CONTACTS below.
  117. .SH "MODES OF OPERATION"
  118. C-Kermit can be used in two "modes": remote and local.  In
  119. .IR "remote mode",
  120. you connect to the
  121. #ifdef HPUX10
  122. HP-UX
  123. #else
  124. UNIX
  125. #endif
  126. system from a desktop computer
  127. and transfer files between your desktop computer and
  128. #ifdef HPUX10
  129. HP-UX
  130. #else
  131. UNIX
  132. #endif
  133. C-Kermit.  In that
  134. case, connection establishment (dialing, TELNET connection, etc) is handled
  135. by the Kermit program on your desktop computer.
  136. .PP
  137. In
  138. .IR "local mode",
  139. C-Kermit establishes a connection to another computer
  140. by direct serial connection, by dialing a modem, or by making a network
  141. connection.  When used in local mode, C-Kermit gives you a terminal connection
  142. to the remote computer, using your actual terminal, emulator, or UNIX
  143. workstation terminal window or console driver for specific terminal emulation.
  144. .PP
  145. C-Kermit also has two commands interfaces: the familiar UNIX-style command-line
  146. options, and an interactive dialog with a prompt.
  147. .IR "Command-line options"
  148. give
  149. you access to a small but useful subset of C-Kermit's features for terminal
  150. connection and file transfer, plus the ability to pipe files into or out of
  151. Kermit for transfer.
  152. .PP
  153. .IR "Interactive commands"
  154. give you access to dialing, script programming,
  155. character-set translation, and, in general, detailed control and display, as
  156. well as automation, of all C-Kermit's features.  Interactive commands can also
  157. be collected into command files or macros.  C-Kermit's command and script
  158. language is portable to many and diverse platforms.
  159. .PP
  160. .SH "STARTING C-KERMIT"
  161. .PP
  162. #ifdef HPUX10
  163. You can start C-Kermit by typing "/usr/bin/kermit", or just "kermit" if your
  164. PATH includes "/usr/bin", possibly followed by command-line options.
  165. #else
  166. C-Kermit should be available as "kermit" somewhere in your PATH, perhaps as
  167. /usr/local/bin/kermit, in which case you can
  168. start C-Kermit just by typing "kermit", possibly followed by command-line
  169. options.
  170. #endif
  171. If there are no "action options" on the command line (explained
  172. below), C-Kermit starts in interactive command mode; you will see a greeting
  173. message and then the "C-Kermit>" prompt.  If you do include action options on
  174. the command line, C-Kermit takes the indicated actions and then exits directly
  175. back to UNIX.  Either way, C-Kermit executes the commands in its
  176. initialization file,
  177. #ifdef HPUX10
  178. .IR "/usr/share/lib/kermit/ckermit.ini" ,
  179. #else
  180. .IR ".kermrc" ,
  181. in your home directory (or a system-wide directory if C-Kermit was built to
  182. do this)
  183. #endif
  184. before it executes any other commands, unless you have
  185. included the `\|\c
  186. .B \-Y\c
  187. \&\|' (uppercase) command-line option, which means to skip the
  188. initialization file, or you have included the `\|\c
  189. .B -y \c
  190. \&\|
  191. .IR "filename" \c
  192. \&\|'
  193. option to specify an alternative initialization file.
  194. .PP
  195. .SH "FILE TRANSFER"
  196. .PP
  197. Here is the most common scenario for Kermit file transfer.  Many other
  198. methods are possible, most of them more convenient, but this basic method
  199. should work in all cases.
  200. .PP
  201. .in +0.5i
  202. .ll -0.5i
  203. .ta +0.2i
  204. .ti -0.2i
  205. \(bu    Start Kermit on your local computer and establish a connection to the
  206. remote computer.  If C-Kermit is on your local
  207. computer, use the sequence SET MODEM TYPE
  208. .IR "modem-name" \c
  209. \&\|, SET LINE
  210. .IR "device-name" \c
  211. \&\|, SET SPEED
  212. .IR "bits-per-second" \c
  213. \&\|, and DIAL
  214. .IR "phone-number"
  215. if you are dialing; SET LINE and SPEED for direct connections;
  216. SET NETWORK
  217. .IR "network-type"
  218. and SET HOST
  219. .IR "host-name-or-address"
  220. for network connections.
  221. .sp
  222. .ti -0.2i
  223. \(bu    SET any other necessary communication parameters, such as PARITY,
  224. DUPLEX, and FLOW-CONTROL.
  225. .sp
  226. .ti -0.2i
  227. \(bu    Give the CONNECT command.
  228. .sp
  229. .ti -0.2i
  230. \(bu    Log in to the remote computer.
  231. .sp
  232. .ti -0.2i
  233. \(bu    Start Kermit on the remote computer, give it any desired SET commands
  234. for file-, communication-, or protocol-related parameters.  If you will be
  235. transferring binary files, give the command SET FILE TYPE BINARY to the
  236. Kermit program that will be sending them.
  237. .sp
  238. .ti -0.2i
  239. \(bu    To
  240. .IR download
  241. a file or file group, give the remote Kermit a SEND command, following by
  242. a filename or "wildcard" file specification, for example:
  243. .nf
  244. .sp
  245.   send oofa.txt            (send one file)
  246. .sp
  247. .fi
  248. or:
  249. .nf
  250. .sp
  251.   send oofa.*              (send a group of files)
  252. .sp
  253. .fi
  254. To
  255. .IR upload
  256. a file or files, give the remote Kermit a RECEIVE command.  The sending Kermit
  257. will tell the receiving Kermit the name (and other attributes) of each file.
  258. .sp
  259. .ti -0.2i
  260. \(bu    Escape back to the Kermit program on your local (desktop) computer.  If
  261. your local computer is running C-Kermit, type Ctrl-\\ c (Control-backslash
  262. followed by the letter 'c') (on NeXT workstations, use Ctrl-] c).  If MS-DOS
  263. Kermit or Kermit 95, use Alt-x (hold down the Alt key, press 'x').  Now
  264. you should see your local Kermit program's prompt.
  265. .sp
  266. .ti -0.2i
  267. \(bu    If you will be transferring binary files, give the command SET FILE
  268. TYPE BINARY to the Kermit program that is sending the files.
  269. .sp
  270. .ti -0.2i
  271. \(bu    If you are
  272. .IR downloading
  273. files, tell the local Kermit program to RECEIVE.  If you are
  274. .IR "uploading",
  275. give your local Kermit program a SEND command, specifying a filename
  276. or wildcard file specification.  In other words, tell the
  277. .IR remote
  278. Kermit program what to do first, SEND or RECEIVE, then escape back to
  279. the
  280. .IR local
  281. Kermit and give it the opposite command, RECEIVE or SEND.
  282. .sp
  283. .ti -0.2i
  284. \(bu When the transfer is complete, give a CONNECT command.  Now you are
  285. talking to Kermit on the remote computer again.  Type EXIT to get back to the
  286. command prompt on the remote computer.  When you are finished using the remote
  287. computer, log out and then (if necessary) escape back to Kermit on your local
  288. computer.  Then you can make another connection or EXIT from the local Kermit
  289. program.
  290. .ll +0.5i
  291. .in -0.5i
  292. .fi
  293. .PP
  294. Note that other methods can be used to simplify the file-transfer process:
  295. .IR "client/server operation" ,
  296. in which all commands are given to the client and
  297. passed on automatically to the server, and
  298. .IR autodownload
  299. (and upload), in which the remote Kermit initiates file transfers
  300. automatically through your terminal emulator.
  301. .PP
  302. The file transfer protocol defaults in C-Kermit 7.0, unlike those for earlier
  303. releases, favor speed over robustness, on the assumption that connections in
  304. these times are usually reliable (over TCP/IP and/or error-correcting modems
  305. with hardware flow control).  If you experience file transfer failures, use
  306. the CAUTIOUS or ROBUST commands to choose more conservative (and therefore
  307. slower) protocol settings.  For fine tuning of performance, you can choose
  308. specific packet lengths, window sizes, and control-character prefixing
  309. strategies as explained in Chapter 12 of the manual,
  310. .IR "Using C-Kermit".
  311. .PP
  312. If you are accessing a remote host where C-Kermit resides via Telnet or other
  313. connection that is guaranteed reliable from end to end, and both Kermits
  314. support it (C-Kermit 7.0 does), a new "streaming" form of the Kermit protocol
  315. is used automatically to give ftp-like speeds (the limiting factor being the
  316. overhead from the remote Telnet or Rlogin server and/or PTY driver).
  317. .SH OTHER FEATURES
  318. C-Kermit includes features too numerous to be explained in a man page.  For
  319. further information about connection establishment, modem dialing, networks,
  320. terminal connection, key mapping, logging, file transfer options and features,
  321. troubleshooting, client/server operation, character-set translation during
  322. terminal connection and file transfer, "raw" up- and downloading of files,
  323. macro construction, script programming, sending numberic and alphanumeric
  324. pages, convenience features, and shortcuts, plus numerous tables, examples,
  325. and illustrations, please consult the manual and the C-Kermit 7.0 release
  326. notes.
  327. .SH "GETTING HELP"
  328. .PP
  329. C-Kermit has extensive built-in help.  You can find out what commands exist by
  330. typing ? at the C-Kermit> prompt.  You can type HELP at the C-Kermit> prompt
  331. for a "getting-started" message, or HELP followed by the name
  332. of a particular command for information about that command, for example:
  333. .nf
  334. .sp
  335.   help send
  336. .sp
  337. .fi
  338. or:
  339. .nf
  340. .sp
  341.   help set file
  342. .sp
  343. .fi
  344. You can type ? anywhere within a command to get brief help about the
  345. current command field.  You can also type the INTRO command to get a brief
  346. introduction to C-Kermit, and the MANUAL command to access this (or another)
  347. man page.  Finally, you can use the SUPPORT command for instructions on
  348. obtaining technical support.
  349. .sp
  350. .SH "ENTERING COMMANDS"
  351. .sp
  352. You can use upper or lower case for interactive-mode commands, but remember
  353. that UNIX filenames are case-sensitive.  You can abbreviate command words
  354. (but not filenames) as long as the abbreviation matches only one possibility.
  355. While typing a command, you can use the following editing characters:
  356. .nf
  357. .sp
  358.   Delete, Backspace, or Rubout erases the rightmost character.
  359.   Ctrl-W erases the rightmost "word".
  360.   Ctrl-U erases the current command line.
  361.   Ctrl-R redisplays the current command.
  362.   Ctrl-P recalls a previous command (scrolls back in command buffer).
  363.   Ctrl-N scrolls forward in a scrolled-back command buffer.
  364.   Ctrl-C cancels the current command.
  365.   Tab, Esc, or Ctrl-I tries to complete the current keyword or filename.
  366.   ? gives help about the current field.
  367. .sp
  368. .fi
  369. To enter the command and make it execute, press the Return or Enter key.
  370. .sp
  371. .SH BACKSLASH NOTATION
  372. Within an interactive command, the "\\" character (backslash) is a prefix used
  373. to enter special quantities, including ordinary characters that would
  374. otherwise be illegal or misinterpreted.  Other than that, the character
  375. following the \\ identifies what the special quantity is:
  376. .nf
  377. .sp
  378.   % A user-defined simple (scalar) variable such as \\%a or \\%1
  379.   & an array reference such as \\&a[3]
  380.   $ an environment variable such as \\$(TERM)
  381.   v (or V) a built-in variable such as \\v(time)
  382.   f (or F) a function such as \\Fsubstring(\\%a,3,2)
  383.   s (or S) compact substring notation, macronames, like \\s(foo[3:12])
  384.   : compact substring notation, all variables, like \\:(\%a[3:12])
  385.   d (or D) a decimal (base 10) number (1 to 3 digits, 0..255) such as \\d27
  386.   o (or O) an octal (base 8) number (1 to 3 digits, 0..377) such as \\o33
  387.   x (or X) a hexadecimal (base 16) number (2 digits, 00..ff) like \\x1b
  388.   \\ the backslash character itself
  389.   b (or B) the BREAK signal (OUTPUT command only)
  390.   l (or L) a Long BREAK signal (OUTPUT only)
  391.   n (or n) a NUL (0) character (OUTPUT only)
  392.   a decimal digit (a 1-, 2-, or 3-digit decimal number) such as \\27
  393.   {} used for grouping, e.g. \\{27}123
  394.   anything else: following character taken literally.
  395. .sp
  396. .fi
  397. Note that numbers turn into the character with that binary code (0-255), so
  398. you can use \\7 for a bell, \\13 for carriage return, \\10 for linefeed.
  399. For example, to have C-Kermit send a BELL to your screen, type:
  400. .nf
  401. .sp
  402.   echo \\7
  403. .sp
  404. .fi
  405. .SH "COMMAND LIST"
  406. .PP
  407. The commands most commonly used, and important for beginners to
  408. know, are marked with "*":
  409. .nf
  410. .in 0
  411. .ll 80
  412. .ta 16
  413. .sp
  414. Program Management:
  415.   BACK    Return to previous directory.
  416.   BROWSE    Invoke Web browser.
  417. * CD    Change Directory.
  418. * PWD    Print Working Directory.
  419.   CHECK    See if the given feature is configured.
  420.   CLOSE    Close the connection or a log or other local file.
  421.   COMMENT    Introduce a full-line comment.
  422.   COPYRIGHT    Display copyright notice.
  423.   DATE    Display date & time.
  424. * EXIT    Leave the program, return to UNIX.
  425. * HELP    Display a help message for a given command.
  426. * INTRO    Print a brief introduction to C-Kermit.
  427.   KERMIT    Give command-line options at the prompt.
  428.   LOG    Open a log file -- debugging, packet, session, transaction.
  429.   PUSH    Invoke local system's interactive command interpreter.
  430.   QUIT    Synonym for EXIT.
  431.   REDO    Re-execute a previous command.
  432.   RUN    Run a program or system command.
  433.   SET COMMAND    Command-related parameters: bytesize, recall buffer size.
  434.   SET PROMPT    The C-Kermit program's interactive command prompt.
  435.   SET EXIT    Items related to C-Kermit's action upon exit or SET LINE/HOST.
  436.   SHOW EXIT    Display SET EXIT parameters.
  437.   SHOW FEATURES    Show features that C-Kermit was built with.
  438.   SHOW VERSIONS    Show version numbers of each source module.
  439.   SUPPORT    Find out how to get tech support.
  440.   SUSPEND    Suspend Kermit (use only if shell supports job control!).
  441. * SHOW    Display values of SET parameters.
  442. * TAKE    Execute commands from a file.
  443.   VERSION    Display the C-Kermit program version number.
  444.   Z    Synonym for SUSPEND.
  445. * Ctrl-C    Interrupt a C-Kermit command in progress.
  446.   Ctrl-Z    Synonym for SUSPEND.
  447.   ; or #    Introduce a full-line or trailing comment.
  448.   ! or @    Synonym for RUN.
  449.   <    Synonym for REDIRECT.
  450. .sp
  451. Connection Establishment and Release:
  452. * DIAL    Dial a telephone number.
  453.   PDIAL    Partially dial a telephone number.
  454. * LOOKUP    Lookup a phone number, test dialing rules.
  455.   ANSWER    Wait for a phone call and answer it when it comes.
  456. * HANGUP    Hang up the phone or network connection.
  457.   EIGHTBIT    Shortcut to set all i/o to 8 bits.
  458.   PAD    Command for X.25 PAD (SunOS / Solaris / VOS only).
  459.   PING    Check status of remote TCP/IP host.
  460.   REDIAL    The the most recently DIALed number again.
  461.   LOG CONNECTIONS    Keep a record of each connection.
  462.   REDIRECT    Redirect standard i/o of command to communication connection.
  463.   PIPE    Make a connection through an external command or program.
  464.   SET CARRIER    Treatment of carrier on terminal connections.
  465. * SET DIAL    Parameters related to modem dialing.
  466. * SET FLOW    Communication line flow control: AUTO, RTS/CTS, XON/XOFF, etc.
  467. * SET HOST    Open connection to network host name or address.
  468. #ifdef HPUX10
  469. * SET LINE    Open serial communication device, like /dev/cul0p0.
  470. #else
  471. * SET LINE    Open serial communication device, like /dev/cua0.
  472. #endif
  473.   SET PORT    Synonym for SET LINE.
  474. * SET MODEM TYPE    Specify type of modem on SET LINE device, like USR.
  475. * SET NETWORK    Network type, X.25 (SunOS / Solaris / VOS only) or TCP/IP.
  476.   SET TCP    Specify TCP protocol options (advanced).
  477.   SET TELNET    Specify TELNET protocol options.
  478.   SET X.25    Specify X.25 connection parameters (SunOS/Solaris/VOS only).
  479.   SET PAD    Specify X.25 X.3 PAD parameters (SunOS/Solaris/VOS only).
  480. * SET PARITY    Character parity (none, even, etc) for communications.
  481. * SET SPEED    Serial communication device speed, e.g. 2400, 9600, 57600.
  482.   SET SERIAL    Set serial communications data size, parity, stop bits.
  483.   SET STOP-BITS    Set serial communications stop bits.
  484.   SHOW COMM    Display communications settings.
  485.   SHOW CONN     Display info about current connection.
  486.   SHOW DIAL    Display SET DIAL values.
  487.   SHOW MODEM    Display modem type, signals, etc.
  488.   SHOW NETWORK    Display network-related items.
  489. * TELNET    = SET NETWORK TCP/IP, SET HOST ..., CONNECT.
  490.   RLOGIN    Makes an RLOGIN connection (requires privilege).
  491.   TELOPT    Send a TELNET option negotiation (advanced).
  492.   CLOSE    Close the current connection.
  493. .sp
  494. Terminal Connection:
  495. * C    Special abbreviation for CONNECT.
  496. * CONNECT    Establish a terminal connection to a remote computer.
  497.   LOG SESSION    Record terminal session.
  498.   SET COMMAND    Bytesize between C-Kermit and your keyboard and screen.
  499. * SET DUPLEX    Specify which side echoes during CONNECT.
  500.   SET ESCAPE    Prefix for "escape commands" during CONNECT.
  501.   SET KEY    Key redefinitions in CONNECT mode.
  502.   SET TERMINAL    Terminal connection items: bytesize, character-set, echo, etc.
  503.   SHOW ESCAPE    Display current CONNECT-mode escape character.
  504.   SHOW KEY    Display keycode and assigned value or macro.
  505.   SHOW TERMINAL    Display SET TERMINAL items.
  506. * Ctrl-\\    CONNECT-mode escape character, follow by another character:
  507.       C to return to C-Kermit> prompt.
  508.       B to send BREAK signal.
  509.       ? to see other options.
  510. .sp
  511. File Transfer:
  512.   ADD SEND-LIST    Add a file specification to the SEND-LIST
  513.   ADD BINARY-PATTERNS Add a pattern to the binary file pattern list
  514.   ADD TEXT-PATTERNS Add a pattern to the text file pattern list
  515.   ASSOCIATE    A file character-set with a transfer character-set
  516.   LOG SESSION   Download a file with no error checking
  517. * SEND    Send a file or files.
  518.   MSEND    Multiple SEND - accepts a list of files, separated by spaces.
  519.   MOVE    SEND and then delete source file(s) if successful.
  520.   MMOVE    Multiple MOVE - accepts a list of files, separated by spaces.
  521.   MAIL    SEND a file to other Kermit, to be delivered as e-mail.
  522.   RESEND    Continue a incomplete SEND.
  523.   PSEND    Send part of a file.
  524. * RECEIVE    Passively wait for files to arrive from other Kermit.
  525. * R    Special abbreviation for RECEIVE.
  526. * S    Special abbreviation for SEND.
  527.   GET    Ask server to send the specified file(s).
  528.   MGET    Like GET but accepts a list of files.
  529.   REGET    Continue a incomplete download from a server.
  530.   G    Special abbreviation for GET.
  531.   FAST    Shortcut for fast file-transfer settings.
  532.   CAUTIOUS    Shortcut for medium file-transfer settings.
  533.   ROBUST    Shortcut for conservative file-transfer settings.
  534.   SET ATTRIB    Control transmission of file attributes.
  535. * SET BLOCK    Choose error-checking level, 1, 2, or 3.
  536.   SET BUFFERS    Size of send and receive packet buffers.
  537.   SET PREFIX    Which control characters to "unprefix" during file transfer.
  538.   SET DELAY    How long to wait before sending first packet.
  539.   SET DESTINATION DISK, PRINTER, or SCREEN for incoming files.
  540. * SET FILE    Transfer mode (type), character-set, collision action, etc.
  541. * SET RECEIVE    Parameters for inbound packets: packet-length, etc.
  542.   SET REPEAT    Repeat-count compression parameters.
  543.   SET RETRY    Packet retransmission limit.
  544.   SET SEND    Parameters for outbound packets: length, etc.
  545.   SET HANDSHAKE    Communication line half-duplex packet turnaround character.
  546.   SET LANGUAGE    Enable language-specific character-set translations.
  547.   SET PATTERNS    Turn off filename-pattern-based text/binary mode switching.
  548.   SET SESSION-LOG File type for session log, text or binary.
  549.   SET TRANSFER    File transfer parameters: character-set, display, etc.
  550.   SET TRANSMIT    Control aspects of TRANSMIT command execution.
  551.   SET UNKNOWN    Specify handling of unknown character sets.
  552. * SET WINDOW    File transfer packet window size, 1-31.
  553.   SHOW ATTRIB    Display SET ATTRIBUTE values.
  554.   SHOW CONTROL    Display control-character prefixing map.
  555. * SHOW FILE    Display file-related settings.
  556.   SHOW PROTOCOL    Display protocol-related settings.
  557.   SHOW LANGUAGE    Display language-related settings.
  558.   SHOW TRANSMIT    Display SET TRANSMIT values.
  559. * STATISTICS    Display statistics about most recent file transfer.
  560.   TRANSMIT    Send a file with no error checking.
  561.   XMIT    Synonym for TRANSMIT.
  562. .sp
  563. SEND Command switches:
  564.   /AS-NAME:    Name to send file under
  565.   /AFTER:    Send files modified after date-time
  566.   /BEFORE:    Send files modified before date-time
  567.   /BINARY    Send in binary mode
  568.   /COMMAND    Send from standard output of a command
  569.   /DELETE    Delete file after successfully sending
  570.   /EXCEPT:    Don't send files whose names match given pattern(s)
  571.   /FILTER:    Pass file contents through given filter program
  572.   /FILENAMES:    Specify how to send filenames
  573.   /LARGER-THAN:    Send files larger than given size
  574.   /LIST:    Send files whose names are listed in given file
  575.   /MAIL:    Send file(s) as e-mail to given address
  576.   /MOVE-TO:    Move source file to given directory after successfully sending
  577.   /NOT-AFTER:    Send files modified not after given date-time
  578.   /NOT-BEFORE:    Send files modified not before given date-time
  579.   /PATHNAMES:    Specifiy how to send pathnames
  580.   /PRINT:    Send files to be printed
  581.   /PROTOCOL:    Send files using given protocol
  582.   /QUIET    Don't display file-transfer progress
  583.   /RECOVER    Recover interrupted transfer from point of failure
  584.   /RECURSIVE    Send a directory tree
  585.   /RENAME-TO:    Rename files as specified after successfully sending
  586.   /SMALLER-THAN:    Send files smaller than given size
  587.   /STARTING-AT:    Send file starting at given byte number
  588.   /SUBJECT:    Subject for SEND /MAIL
  589.   /TEXT    Send in text mode
  590. .sp
  591. GET and RECEIVE Command switches:
  592.   /AS-NAME:    Store incoming file under given name
  593.   /BINARY    Receive in binary mode if transfer mode not specified
  594.   /COMMAND:    Send incoming file data to given command
  595.   /EXCEPT:      Don't accept incoming files whose names match
  596.   /FILENAMES:    How to treat incoming file names
  597.   /FILTER:    Filter program for incoming file data
  598.   /MOVE-TO:    Where to move a file after succussful receipt.
  599.   /PATHNAMES:    How to treat incoming path names
  600.   /PROTOCOL:    Protocol to use for receiving (RECEIVE only)
  601.   /RENAME-TO:   New name for file after succussful receipt.
  602.   /QUIET:    Suppress file-transfer display
  603.   /TEXT    Receive in text mode if transfer mode not specified
  604. .sp
  605. Switches only for GET:
  606.   /DELETE    Tells server to delete each file after successful transmission
  607.   /RECOVER    Resume interrupted file transfer from point of failure
  608.   /RECURSIVE    Tells server to send a directory tree
  609. .sp
  610. File Management:
  611. * CD    Change Directory.
  612. * PWD    Display current working directory.
  613.   COPY    Copy a file.
  614. * DELETE    Delete a file or files.
  615. * DIRECTORY    Display a directory listing.
  616.   EDIT    Edit a file.
  617.   MKDIR    Create a directory.
  618.   PRINT    Print a local file on a local printer.
  619.   PURGE    Remove backup files.
  620.   RENAME    Change the name of a local file.
  621.   RMDIR    Remove a directory.
  622.   SET PRINTER    Choose printer device.
  623.   SPACE    Display current disk space usage.
  624.   SHOW CHARACTER-SETS Display character-set translation info.
  625.   TRANSLATE    Translate a local file's character set.
  626.   TYPE    Display a file on the screen
  627.   TYPE /PAGE    Display a file on the screen, pausing after each screenful.
  628.   XLATE    Synonym for TRANSLATE.
  629. .sp
  630. Client/Server operation:
  631.   BYE    Terminate a remote Kermit server and log out its job.
  632.   DISABLE    Disallow access to selected features during server operation:
  633.   E-PACKET    Send an Error packet.
  634.   ENABLE    Allow access to selected features during server operation.
  635.   FINISH    Instruct a remote Kermit server to exit, but not log out.
  636.   G    Special abbreviation for GET.
  637.   GET    Get files from a remote Kermit server.
  638.   QUERY    (Same as REMOTE QUERY)
  639.   RETRIEVE    Like GET but server deletes files after.
  640.   REMOTE xxx    Command for server, can be redirected with > or |.
  641.   REMOTE ASSIGN    (RASG) Assign a variable
  642.   REMOTE CD    (RCD) Tell remote Kermit server to change its directory.
  643.   REMOTE COPY    (RCOPY) Tell server to copy a file.
  644.   REMOTE DELETE    (RDEL) Tell server to delete a file.
  645.   REMOTE DIR    (RDIR) Ask server for a directory listing.
  646.   REMOTE EXIT    (REXIT) Ask the server program to exit.
  647.   REMOTE HELP    (RHELP) Ask server to send a help message.
  648.   REMOTE HOST    (RHOST) Ask server to ask its host to execute a command.
  649.   REMOTE KERMIT    (RKER) Send an interactive Kermit command to the server.
  650.   REMOTE LOGIN    Authenticate yourself to a remote Kermit server.
  651.   REMOTE LOGOUT    Log out from a Kermit server previously LOGIN'd to.
  652.   REMOTE MKDIR    (RMKDIR) Tell the server to create a directory.
  653.   REMOTE PRINT    (RPRINT) Print a local file on the server's printer.
  654.   REMOTE PWD    (RPWD) Ask server to reveal its current (working) directory.
  655.   REMOTE QUERY    (RQUERY) Get value of a variable.
  656.   REMOTE RENAME    (RRENAME) Tell server to rename a file.
  657.   REMOTE RMDIR    (RRMDIR) Tell server to remove a directory.
  658.   REMOTE SET    (RSET) Send a SET command to a remote server.
  659.   REMOTE SPACE    (RSPACE) Ask server how much disk space it has left.
  660.   REMOTE TYPE    (RTYPE) Ask server to display a file on your screen.
  661.   REMOTE WHO    (RWHO) Ask server for a "who" or "finger" listing.
  662.   SERVER    Enter server mode - be a Kermit server.
  663.   SET SERVER    Set parameters for server operation.
  664.   SHOW SERVER    Show SET SERVER, ENABLE/DISABLE items.
  665. .sp
  666. Script programming:
  667.   ASK    Prompt the user, store user's reply in a variable.
  668.   ASKQ    Like ASK, but, but doesn't echo (useful for passwords).
  669.   ASSERT    Evaluate condition and set SUCCESS/FAILURE accordingly.
  670.   ASSIGN    Assign an evaluated string to a variable or macro.
  671.   CLEAR    Clear communication device input buffer or other item.
  672.   CLOSE    Close the connection, or a log or other file.
  673.   DECLARE    Declare an array.
  674.   DECREMENT    Subtract one (or other number) from a variable.
  675.   DEFINE    Define a variable or macro.
  676.   DO    Execute a macro ("DO" can be omitted).
  677.   ECHO    Display text on the screen.
  678.   ELSE    Used with IF.
  679.   END    A command file or macro.
  680.   EVALUATE    an arithmetic expression.
  681.   FAIL    Set FAILURE.
  682.   FOPEN    Open a local file
  683.   FREAD    Read from a file opened with FOPEN
  684.   FWRITE    Write to an FOPEN'd file
  685.   FSEEK    Seeks to given position in FOPEN'd file
  686.   FCLOSE    Close an FOPEN'd file
  687.   FOR    Execute commands repeatedly in a counted loop.
  688.   FORWARD    GOTO in the forward direction only.
  689.   GETC    Issue a prompt, get one character from keyboard.
  690.   GETOK    Ask question, get Yes or No answer, set SUCCESS or FAILURE.
  691.   GOTO    Go to a labeled command in a command file or macro.
  692.   IF    Conditionally execute the following command.
  693.   INCREMENT    Add one (or other number) to a variable.
  694.   INPUT    Match characters from another computer against a given text.
  695.   LOCAL    Declare local variables in a macro
  696.   MINPUT    Like INPUT, but allows several match strings.
  697.   MSLEEP    Sleep for given number of milliseconds.
  698.   OPEN    Open a local file for reading or writing.
  699.   OUTPUT    Send text to another computer.
  700.   O    Special abbreviation for OUTPUT.
  701.   PAUSE    Do nothing for a given number of seconds.
  702.   READ    Read a line from a local file into a variable.
  703.   REINPUT    Reexamine text previously received from another computer.
  704.   RETURN    Return from a user-defined function.
  705.   SCREEN    Screen operations - clear, position cursor, etc.
  706.   SCRIPT    Execute a UUCP-style login script.
  707.   SET ALARM    Set a timer to be used with IF ALARM; SHOW ALARM shows it.
  708.   SET CASE    Treatment of alphabetic case in string comparisons.
  709.   SET COMMAND    QUOTING turns on/off interpretation of backslash notation.
  710.   SET COUNT    For counted loops.
  711.   SET INPUT    Control behavior of INPUT command.
  712.   SET MACRO    Control aspects of macro execution.
  713.   SET TAKE    Control aspects of TAKE file execution.
  714.   SHIFT    Shift macro arguments left the given number of places.
  715.   SHOW ARGUMENTS Display arguments to current macro.
  716.   SHOW ARRAYS    Display information about active arrays.
  717.   SHOW COUNT    Display current COUNT value.
  718.   SHOW FUNCTIONS List names of available \\f() functions.
  719.   SHOW GLOBALS    List defined global variables \\%a..\\%z.
  720.   SHOW MACROS    List one or more macro definitions.
  721.   SHOW SCRIPTS    Show script-related settings.
  722.   SHOW VARIABLES Display values all \\v() variables.
  723.   SLEEP    Sleep for given number of seconds.
  724.   SORT    Sort an array (many options).
  725.   STATUS    Show SUCCESS or FAILURE of previous command.
  726.   STOP    Stop executing macro or command file, return to prompt.
  727.   SUCCEED    Set SUCCESS.
  728.   SWITCH    Execute selected command(s) based on value of variable.
  729.   TAKE    Execute commands from a file.
  730.   UNDEFINE    Undefine a variable
  731.   WAIT    Wait for the specified modem signals.
  732.   WHILE    Execute commands repeatedly while a condition is true.
  733.   WRITE    Write material to a local file.
  734.   WRITE-LINE    Write a line (record) to a local file.
  735.   WRITELN    Synonym for WRITE-LINE.
  736.   XECHO    Like ECHO but no CRLF at end.
  737.   XIF    Extended IF command.
  738. .ll
  739. .in
  740. .fi
  741. .SH "BUILT-IN VARIABLES"
  742. Built-in variables are referred to by \\v(name), can be used in any command,
  743. usually used in script programming.  They cannot be changed.  Type SHOW
  744. VARIABLES for a current list.
  745. .nf
  746. .sp
  747.   \\v(argc)      number of arguments in current macro
  748.   \\v(args)      number of program command-line arguments
  749.   \\v(blockcheck)current SET BLOCK-CHECK type
  750.   \\v(browser)   current Web browser
  751.   \\v(browsopts) current Web browser options
  752.   \\v(browsurl)  most recent Web browser site (URL)
  753.   \\v(byteorder) hardware byte order
  754.   \\v(charset)   current file character-set
  755.   \\v(cmdbufsize)size of command buffer
  756.   \\v(cmdfile)   name of current command file, if any
  757.   \\v(cmdlevel)  current command level
  758.   \\v(cmdsource) where command are currently coming from, macro, file, etc.
  759.   \\v(cols)      number of screen columns
  760.   \\v(connection)connection type: serial, tcp/ip, etc.
  761.   \\v(count)     current COUNT value
  762.   \\v(cps)       speed of most recent file transfer in chars per second
  763.   \\v(cpu)       CPU type C-Kermit was built for
  764.   \\v(crc16)     16-bit CRC of most recent file transfer
  765.   \\v(ctty)      device name of controlling terminal
  766.   \\v(d$ac)      SET DIAL AREA-CODE value
  767.   \\v(d$cc)      SET DIAL COUNTRY-CODE value
  768.   \\v(d$ip)      SET DIAL INTL-PREFIX value
  769.   \\v(d$lc)      SET DIAL LD-PREFIX value
  770.   \\v(d$px)      SET DIAL PBX-EXCHANGE value
  771.   \\v(date)      date as 8 Feb 1999
  772.   \\v(day)       day of week (English 3-letter abbreviation)
  773.   \\v(dialcount) current value of DIAL retry counter
  774.   \\v(dialnumber)phone number most recently dialed
  775.   \\v(dialresult)most recent dial result message or code from modem
  776.   \\v(dialstatus)return code from DIAL command (0 = OK, 22 = BUSY, etc)
  777.   \\v(dialsuffix)current SET DIAL SUFFIX value
  778.   \\v(dialtype)  code for type of call most recently placed
  779.   \\v(directory) current/default directory
  780.   \\v(download)  current download directory if any
  781.   \\v(editor)    your preferred editor
  782.   \\v(editfile)  file most recently edited
  783.   \\v(editopts)  options for editor
  784.   \\v(errno)     current "errno" (system error number) value
  785.   \\v(errstring) error message string associated with errno
  786.   \\v(escape)    decimal ASCII value of CONNECT-mode escape character
  787.   \\v(evaluate)  result of most recent EVALUATE command
  788.   \\v(exitstatus)current EXIT status (0 = good, nonzero = something failed)
  789.   \\v(filename)  name of file currently being transferred
  790.   \\v(filenumber)number of file currently being transferred (1 = first, etc)
  791.   \\v(filespec)  filespec given in most recent SEND/RECEIVE/GET command
  792.   \\v(fsize)     size of file most recently transferred
  793.   \\v(ftype)     SET FILE TYPE value (text, binary)
  794.   \\v(herald)    C-Kermit's program herald
  795.   \\v(home)      home directory
  796.   \\v(host)      computer host name (comuter where C-Kermit is running)
  797.   \\v(hwparity)  SET PARITY HARDWARE setting (if any)
  798.   \\v(input)     current INPUT buffer contents
  799.   \\v(inchar)    character most recently INPUT
  800.   \\v(incount)   how many characters arrived during last INPUT
  801.   \\v(inidir)    directory where initialization file was found
  802.   \\v(inmatch)   [M]INPUT material that matched given \\fpattern().
  803.   \\v(instatus)  status of most recent INPUT command
  804.   \\v(intime)    how long it took most recent INPUT to succeed (msec)
  805.   \\v(inwait)    most recent [M]INPUT time limit
  806.   \\v(ipaddress) IP address of C-Kermit's computer if known
  807.   \\v(kbchar)    keyboard character that interrupted PAUSE, INPUT, etc.
  808.   \\v(line)      current communications device, set by LINE or HOST
  809.   \\v(local)     0 if in remote mode, 1 if in local mode
  810.   \\v(lockdir)   UUCP lockfile directory on this platform
  811.   \\v(lockpid)   Process ID found in lockfile when port is in use
  812.   \\v(maclevel)  Current macro stack level
  813.   \\v(macro)     name of currently executing macro, if any
  814.   \\v(math_e)    Floating-point constant e
  815.   \\v(math_pi)   Floating-point constant pi
  816.   \\v(math_precision) Floating point number precision (digits)
  817.   \\v(minput)    Result of most recent MINPUT command
  818.   \\v(model)     Computer hardware model if known
  819.   \\v(modem)     Current modem type or "none"
  820.   \\v(m_aa_off)  Modem command to turn autoanswer off
  821.   \\v(m_aa_on)   Modem command to turn autoanswer on
  822.   \\v(m_xxxxx)   (many other modem commands)
  823.   \\v(m_sig_xx)  Value of modem signal xx
  824.   \\v(name)      Name by which C-Kermit was called (kermit, wermit, etc)
  825.   \\v(ndate)     Current date as 19930208 (yyyymmdd)
  826.   \\v(nday)      Numeric day of week (0 = Sunday)
  827.   \\v(newline)   System-independent newline character or sequence
  828.   \\v(ntime)     Current local time in seconds since midnight (noon = 43200)
  829.   \\v(osname)    Operating System name
  830.   \\v(osrelease) Operating System release
  831.   \\v(osversion) Operating System version
  832.   \\v(packetlen) Current SET RECEIVE PACKET-LENGTH value
  833.   \\v(parity)    Current parity setting
  834.   \\v(pexitstat) Exit status of most recently forked process
  835.   \\v(pid)       C-Kermit's process ID
  836.   \\v(platform)  Specific machine and/or operating system
  837.   \\v(printer)   Current SET PRINTER value or "(default)"
  838.   \\v(program)   Name of this program ("C-Kermit")
  839.   \\v(protocol)  Currently selected file transfer protocol
  840.   \\v(p_8bit)    Current 8th-bit prefix (Kermit protocol)
  841.   \\v(p_ctl)     Current control-character prefix (Kermit protocol)
  842.   \\v(p_rpt)     Current repeat-count prefix (Kermit protocol)
  843.   \\v(query)     Result of most recent REMOTE QUERY command
  844.   \\v(return)    Most recent RETURN value
  845.   \\v(rows)      Number of rows on the terminal screen
  846.   \\v(sendlist)  Number of entries in SEND-LIST
  847.   \\v(serial)    Serial port settings in 8N1 format
  848.   \\v(speed)     Current serial device speed, if known, or "unknown"
  849.   \\v(startup)   Current directory when C-Kermit was started
  850.   \\v(status)    0 or 1 (SUCCESS or FAILURE of previous command)
  851.   \\v(sysid)     Code for platform ID of C-Kermit's computer (U1=UNIX)
  852.   \\v(system)    UNIX (name of operating system family)
  853.   \\v(terminal)  Terminal type
  854.   \\v(test)      C-Kermit test version, if any (e.g. Beta.10)
  855.   \\v(textdir)   Where C-Kermit thinks its text files are
  856.   \\v(tfsize)    Total size of file group most recently transferred
  857.   \\v(tftime)    Transfer time of most recent file group
  858.   \\v(time)      Time as 13:45:23 (hh:mm:ss, 24-hour format)
  859.   \\v(tmpdir)    Temporary directory
  860.   \\v(trigger)   Most recent string to trigger return from CONNECT
  861.   \\v(ttyfd)     File descriptor of current communication device
  862.   \\v(ty_xx)     Used internally by TYPE
  863.   \\v(userid)    User ID of person running C-Kermit
  864.   \\v(version)   Numeric version of Kermit, e.g. 501190.
  865.   \\v(window)    Current window size (SET WINDOW value)
  866.   \\v(xferstatus)Status of most recent file transfer
  867.   \\v(xfermsg)   Error message, if any, terminating most recent transfer
  868.   \\v(xfer_xxx)  Various statistics from last file transfer.
  869.   \\v(xprogram)  C-Kermit
  870.   \\v(xversion)  Same as \\v(version)
  871. .fi
  872. .SH "BUILT-IN FUNCTIONS"
  873. Builtin functions are invoked as \\Fname(args), can be used in any command,
  874. and are usually used in script programs.  Type SHOW FUNCTIONS for a current
  875. list.  Type "help function <name>" for a description of the arguments and
  876. return value, e.g. "help function basename".
  877. .SH "COMMAND LINE OPTIONS"
  878. .PP
  879. C-Kermit accepts commands (or "options") on the command line, in the
  880. time-honored UNIX style.  Alphabetic case is significant.  All options
  881. are optional.  If one or more action options are included, Kermit exits
  882. immediately after executing the command-line options, otherwise it enters
  883. interactive command mode.
  884. .nf
  885. .ll 80
  886. .sp
  887.   kermit [filename] [-x arg [-x arg]...[-yyy]..]]
  888. .sp
  889. where:
  890. .sp
  891.   filename is the name of a command file to execute,
  892.   -x is an option requiring an argument,
  893.   -y an option with no argument.
  894. .ta 15
  895. .sp
  896. Actions:
  897.   -s files    send files
  898.   -s -    send files from stdin
  899.   -r    receive files
  900.   -k    receive files to stdout
  901.   -x    enter server mode
  902.   -O    like -x but exits after one transaction
  903.   -f    finish remote server
  904.   -g files    get remote files from server (quote wildcards)
  905.   -G files    like -g but sends file to standard output
  906.   -a name    alternate file name, used with -s, -r, -g
  907.   -c    connect (before file transfer), used with -l or -j
  908.   -n    connect (after file transfer), used with -l or -j
  909. .sp
  910. Settings:
  911.   -l line    communication line device (to make a serial connection)
  912.   -l n    open file descriptor of communication device
  913.   -j host    TCP/IP network host name (to make a network connection)
  914.   -J host    Connect like TELNET, exit when connection closes
  915.   -l n    open file descriptor of TCP/IP connection (n = number)
  916.   -X    X.25 network address
  917.   -Z    open file descriptor of X.25 connection
  918.   -o n    X.25 closed user group call info
  919.   -u    X.25 reverse-charge call
  920.   -q    quiet during file transfer
  921.   -I    connection is reliable (e.g. TCP or X.25)
  922.   -8    connection is 8-bit clean
  923.   -0    100% transparency in CONNECT mode (and no escaping back)
  924.   -i    transfer files in binary mode
  925.   -T    transfer files in text mode
  926.   -P    send/accept literal path (file) names
  927.   -V    = SET FILE PATTERNS OFF and SET XFER MODE MANUAL
  928.   -b bps    serial line speed, e.g. 1200
  929.   -m name    modem type, e.g. hayes
  930.   -p x    parity, x = e,o,m,s, or n
  931.   -t    half duplex, xon handshake
  932.   -e n    receive packet-length
  933.   -v n    window size
  934.   -L    used with -s to select recursive directory transfer
  935.   -Q    Quick file-transfer settings
  936.   -w    write over files of same name, don't backup old file
  937.   -D n    delay n seconds before sending a file
  938.   -V    "manual mode" = SET FILE PATTERNS OFF, SET TRANSFER MODE MANUAL.
  939. .sp
  940. Other:
  941.   -y name    alternate init file name
  942.   -Y    Skip init file
  943.   -R    Advise C-Kermit it will be used only in remote mode
  944.   -d    log debug info to file debug.log
  945.   -S    Stay, don't exit, after action command
  946.   -C "cmds"    Interactive-mode commands, comma-separated
  947.   -z    Force foreground operation
  948.   -B    Force background (batch) operation
  949.   -h    print command-line option help screen
  950.   =    Ignore all text that follows but assign them to \\%1..\\%9
  951.   --    Same as =
  952. .sp
  953. .fi
  954. .SH "COMMAND LINE EXAMPLES"
  955. .PP
  956. Remote-mode example (C-Kermit is on the far end):
  957. .nf
  958. .sp
  959.   kermit -v 4 -i -s oofa.bin
  960. .sp
  961. .fi
  962. sends file oofa.bin in binary mode (-i) using a window size of 4 (-v 4).
  963. .sp
  964. Local-mode example (C-Kermit makes the connection):
  965. .nf
  966. .sp
  967.   kermit -l HARDWIRE -b 19200 -c -r -n
  968. .sp
  969. .fi
  970. makes a 19200-bps direct connection out through HARDWIRE, CONNECTs (-c)
  971. so you can log in and, presumably start a remote Kermit program and tell it to
  972. send a file, then it RECEIVEs the file (-r), then it CONNECTs back (-n) so you
  973. can finish up and log out.
  974. .sp
  975. For dialing out, you must specify a modem type, and you might have to use a
  976. different device name:
  977. .nf
  978. .sp
  979.   kermit -m hayes -l DIALOUT -b 2400 -c -r -n
  980. .ll
  981. .in
  982. .fi
  983. .SH FILES
  984. .nf
  985. .ta 16
  986. #ifndef HPUX10
  987. $HOME/.kermrc    Standard C-Kermit initialization commands.
  988. #endif /* HPUX10 */
  989. $HOME/.mykermrc    Your personal C-Kermit customization file.
  990. $HOME/.kdd    Your personal dialing directory.
  991. $HOME/.ksd    Your personal services directory.
  992. #ifdef HPUX10
  993. .sp
  994. /usr/share/lib/kermit/READ.ME      Overview of HP-UX C-Kermit, please read
  995. /usr/share/lib/kermit/COPYING.TXT  Copyright, permissions, disclaimer
  996. /usr/share/lib/kermit/ckermit.ini  System-wide initialization file
  997. /usr/share/lib/kermit/ckermod.ini  Sample customization file
  998. /usr/share/lib/kermit/ckermit.kdd  Sample dialing directory
  999. /usr/share/lib/kermit/ckermit.ksd  Sample services directory
  1000. /usr/share/lib/kermit/ckermit2.txt Updates to "Using C-Kermit" 2nd Ed
  1001. /usr/share/lib/kermit/ckcbwr.txt   C-Kermit "beware" file - hints & tips
  1002. /usr/share/lib/kermit/ckubwr.txt   UNIX-specific beware file
  1003. /usr/share/lib/kermit/ck*.txt      Other plain-text documentation
  1004. /usr/share/lib/kermit/ckedemo.ksc  Macros from "Using C-Kermit"
  1005. /usr/share/lib/kermit/ckevt.ksc    Ditto
  1006. /usr/share/lib/kermit/ckepage.ksc  Alpha pager script
  1007. /var/spool/locks/LCK..*            UUCP lockfiles
  1008. #else
  1009. .fi
  1010. .PP
  1011. The following should be in a publicly accessible plain-text documentation area,
  1012. such as usr/local/lib/kermit, /usr/local/doc, or /usr/share/lib/kermit, or
  1013. available via an information server such as gopher, or by ftp from Columbia:
  1014. .nf
  1015. .ta 16
  1016. .sp
  1017. COPYING.TXT     Copyright, permissions, disclaimer.
  1018. ckaaaa.hlp      Explanation of C-Kermit files.
  1019. ckermit.ini     Standard initialization file.
  1020. ckermod.ini    Sample C-Kermit customization file.
  1021. ckermit.kdd    Sample dialing directory.
  1022. ckermit.ksd    Sample services directory.
  1023. ckermit2.txt    Supplement to "Using C-Kermit" 2nd Ed.
  1024. ckcbwr.txt    C-Kermit "beware" file - hints & tips.
  1025. ckubwr.txt    UNIX-specific beware file.
  1026. ck*.txt        Other plain-text documentation.
  1027. ckedemo.ksc     Demonstration macros from "Using C-Kermit".
  1028. ckevt.ksc       Ditto.
  1029. ckepage.ksc     Alpha pager script.
  1030. #endif
  1031. .fi
  1032. .PP
  1033. #ifndef HPUX10
  1034. If C-Kermit has not been installed on your system with the system-wide
  1035. initialization file feature, then the ckermit.ini file should be copied to
  1036. your home (login) directory and renamed to
  1037. .IR ".kermrc" .
  1038. You should not modify this file.
  1039. .sp
  1040. #endif
  1041. To make
  1042. .IR "personalized customizations" ,
  1043. copy the file
  1044. #ifdef HPUX10
  1045. /usr/share/lib/kermit/ckermod.ini
  1046. #else
  1047. ckermod.ini
  1048. #endif
  1049. file to your home directory, make any desired changes, and rename it to
  1050. .IR ".mykermrc" .
  1051. .sp
  1052. You may also create a personalized
  1053. .IR "dialing directory"
  1054. like the sample one in
  1055. #ifdef HPUX10
  1056. /usr/share/lib/kermit/ckermit.kdd.
  1057. #else
  1058. ckermit.kdd.
  1059. #endif
  1060. Your personalized dialing directory
  1061. should be stored in your home directory as
  1062. .IR ".kdd"
  1063. and your personal network directory as
  1064. .IR ".knd" .
  1065. See Chapters 5 and 6 of
  1066. .IR "Using C-Kermit"
  1067. for details.
  1068. .sp
  1069. And you may also create a personalized
  1070. .IR "services directory"
  1071. like the sample one in
  1072. #ifdef HPUX10
  1073. /usr/share/lib/kermit/ckermit.ksd.
  1074. #else
  1075. ckermit.ksd.
  1076. #endif
  1077. Your personalized services directory should be stored in your home directory as
  1078. .IR ".ksd" .
  1079. See Chapter 7 of
  1080. .I "Using C-Kermit"
  1081. for instructions.
  1082. .sp
  1083. The demonstration files illustrate C-Kermit's script programming constructs;
  1084. they are discussed in chapters 17-19 of the book.  You can run them by typing
  1085. the appropriate TAKE command at the C-Kermit> prompt, for example:
  1086. "take /usr/share/lib/kermit/ckedemo.ini".
  1087. .PD
  1088. .SH AUTHORS
  1089. Frank da Cruz, Columbia University, with contributions from hundreds of
  1090. other volunteer programmers all over the world.  See Acknowledgements in
  1091. .IR "Using C-Kermit".
  1092. .SH REFERENCES
  1093. .TP
  1094. Frank da Cruz and Christine M. Gianone,
  1095. .IR "Using C-Kermit",
  1096. Second Edition, 1997, 622 pages,
  1097. Digital Press / Butterworth-Heinemann, 313 Washington Street,
  1098. Newton, MA 02158-1626, USA.
  1099. ISBN 1-55558-164-1.  (In the USA, call +1 800 366-2665 to order Digital Press
  1100. books.)  Also available in a German edition from Verlag Heinze Heise,
  1101. Hannover.
  1102. .sp
  1103. .TP
  1104. Frank da Cruz,
  1105. .IR "Kermit, A File Transfer Protocol",
  1106. Digital Press / Butterworth-Heinemann, Woburn, MA, USA (1987).
  1107. ISBN 0-932376-88-6.  The Kermit file transfer protocol specification.
  1108. .TP
  1109. Christine M. Gianone,
  1110. .IR "Using MS-DOS Kermit",
  1111. Digital Press / Butterworth-Heinemann, Woburn, MA, USA (1992).
  1112. ISBN 1-5558-082-3.  Also available in a German edition from Heise, and a
  1113. French edition from Heinz Schiefer & Cie, Versailles.
  1114. .TP
  1115. .IR "Kermit News",
  1116. Issues 4 (1990) and 5 (1993), Columbia University,
  1117. for detailed discussions of Kermit file transfer performance.
  1118. .SH DIAGNOSTICS
  1119. The diagnostics produced by
  1120. .I C-Kermit
  1121. itself are intended to be self-explanatory.  In addition, every command
  1122. returns a SUCCESS or FAILURE status that can be tested by IF FAILURE or
  1123. IF SUCCESS.  In addition, the program itself returns an exit status code of
  1124. 0 upon successful operation or nonzero if any of various operations failed.
  1125. .SH BUGS
  1126. See the comp.protocols.kermit.* newsgroups on Usenet for discussion, or the
  1127. files ckcbwr.txt and ckubwr.txt, for a list of bugs, hints, tips. etc.  Report
  1128. bugs via e-mail to kermit-support@columbia.edu.  Visit
  1129. http://www.columbia.edu/kermit/support.html for details about tech support.
  1130. .SH CONTACTS
  1131. For more information about Kermit software and documentation, visit the
  1132. Kermit Web site:
  1133. .nf
  1134. .sp
  1135.   http://www.columbia.edu/kermit/
  1136. .sp
  1137. .fi
  1138. Or write to:
  1139. .nf
  1140. .sp
  1141.   The Kermit Project
  1142.   Columbia University
  1143.   612 West 115th Street
  1144.   New York NY  10025-7799
  1145.   USA
  1146. .sp
  1147. .fi
  1148. Or send e-mail to kermit@columbia.edu.
  1149. Or call +1 212 854-3703.  Or fax +1 212 663-8202.
  1150. .br
  1151.