home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / mskermit / mskerm.txt < prev    next >
Text File  |  2020-01-01  |  59KB  |  1,429 lines

  1.                 MS-DOS KERMIT
  2.  
  3.     FOR THE IBM PC FAMILY, COMPATIBLES, AND OTHER MS-DOS COMPUTERS
  4.  
  5.              Version 3.14, January 1995
  6.  
  7. Last update: Thu Jan 12 13:39:45 1995
  8.  
  9. This file summarizes the commands and features of MS-DOS Kermit 3.14.  For
  10. detailed information, consult "Using MS-DOS Kermit", second edition, by
  11. Christine M. Gianone, published by Digital Press / Butterworth-Heinemann,
  12. Woburn, MA, 1992, ISBN 1-55558-082-3.  To order, call (USA, toll free)
  13. 1-800-366-2665, or 1-212-854-3703.
  14.  
  15. A German-language edition, "MS-DOS Kermit -- das universelle
  16. Kommunikationsprogramm", is published by Verlag Heinz Heise GmbH & Co KG,
  17. Hannover, Germany, translated by Gisbert W. Selke, ISBN 3-88229-006-4.
  18. Verlag Heinz Heise GmbH & Co. KG, Helstorfer Strasse 7, D-3000 Hannover.
  19. Tel. +49 (05 11) 53 52-0, Fax. +49 (05 11) 52 53-1 29.
  20.  
  21. A French-language edition, Christine M. Gianone, "Kermit MS-DOS Mode
  22. d'Emploi", is published by Heinz Schiefer & Cie., Versailles (1993),
  23. translated by Jean Dutertre.  ISBN 2-901143-20-2.
  24. Heinz Schiefer & Cie., 45 rue Henri de Regnier, F-78000 Versailles, France.
  25. Tel. +33 13 021 55 05, Fax. +33 13 902 3971.
  26.  
  27. MS-DOS Kermit users are requested to purchase one of these books.  They take
  28. you step-by-step through every phase of setup, use, and automation of MS-DOS
  29. Kermit, they should answer all your questions, and sales of these books is
  30. the primary source of funding for the Kermit development effort.
  31.  
  32.   TCP/IP Users: Please read NETWORKS\SETUP.DOC for TCP/IP network setup.
  33.  
  34. Internet Users: Consult our Web home page http://www.columbia/edu/kermit/.
  35.  
  36. TERMS AND CONDITIONS
  37.  
  38.   Copyright (C) 1982, 1995, Trustees of Columbia University in the City of New
  39.   York.  The MS-DOS Kermit software may not be, in whole or in part, licensed
  40.   or sold for profit as a software product itself, nor may it be included in
  41.   or distributed with commercial products or otherwise distributed by
  42.   commercial concerns to their clients or customers without written permission
  43.   of the Office of Kermit Development and Distribution, Columbia University.
  44.   This copyright notice must not be removed, altered, or obscured.
  45.  
  46. MS-DOS Kermit is a product of Kermit Distribution, Columbia University
  47. Academic Information Systems.  The principal author of the program is
  48. Professor Joe R. Doupnik of Utah State University, with help from other
  49. volunteer programmers all over the world.
  50.  
  51. Kermit software is furnished without warranty of any kind.  Neither Columbia
  52. University, nor the individual authors, nor Digital Press, nor any institution
  53. or individual that has contributed to the development and documentation
  54. warrant the software in any way.
  55.  
  56. CONTACT INFORMATION
  57.  
  58. Technical support: +1 212 854-5126, or use the e-mail addresses below.
  59. Please do not ask for technical support unless you have consulted the manual,
  60. "Using MS-DOS Kermit", as well as the files KERMIT.BWR and KERMIT.UPD from
  61. the Kermit diskette.
  62.  
  63. Kermit programs are available for hundreds of different kinds of computers on
  64. a variety of magnetic media.  For a catalog, write to:
  65.  
  66.   Kermit Distribution, Dept INFO
  67.   Columbia University Academic Information Systems
  68.   612 West 115th Street
  69.   New York, NY    10025  USA
  70.  
  71. Or call +1 212 854-3703, or Fax +1 212 662-6442 or +1 212 663-8202,
  72. or send e-mail to kermit@columbia.edu (Internet).
  73.  
  74. UPDATES
  75.  
  76. MS-DOS Kermit 3.11 was released September, 1991, and is fully described in
  77. "Using MS-DOS Kermit", second edition.  MS-DOS Kermit 3.12 through 3.14 have
  78. some new features not described in the book, but which are listed in this
  79. file, and described fully in the file KERMIT.UPD (MSKERM.UPD).
  80.  
  81. PROGRAM INSTALLATION
  82.  
  83. See the READ.ME file for installation instructions.
  84.  
  85. Read the KERMIT.BWR (MSKERM.BWR) file for problem-solving hints as well as
  86. technical details about internal modems and nonstandard serial ports, Windows,
  87. OS/2, DesqView, memory management, and many other topics.  Read the file
  88. NETWORKS\SETUP.DOC for details about network setup and installation.
  89.  
  90. APPLYING PATCHES TO MS-DOS KERMIT
  91.  
  92. Sometimes errors are discovered in MS-DOS Kermit programs after they are
  93. released.  Rather than issue new releases to correct these problems, we patch
  94. them at runtime.  The patches are contained in a small text file called:
  95.  
  96.   MSRxxx.PCH  Patch file for full-featured IBM PC version
  97.   MSRMxxx.PCH for "medium" IBM PC version
  98.   MSRLxxx.PCH for "lite" IBM PC version
  99.  
  100. where xxx is the MS-DOS Kermit version number, e.g. MSR314.PCH, MSRM314.PCH.
  101.  
  102. The patch file includes checking information -- the Kermit version and
  103. internal checksum must agree -- plus patches that Kermit applies to itself
  104. when it starts up.  The MSRxxx.PCH file should go in the same directory as
  105. your MSKERMIT.INI file.
  106.  
  107. Kermit reads the patch file and makes changes to the copy of itself which is
  108. currently running in memory.  The executable Kermit program file on your disk
  109. or file server is not modified.  Thus Kermit can be stored as read-only on a
  110. file server and shared by everyone.
  111.  
  112. CAUTION: Patches should be applied only to an executable version of MS-DOS
  113. Kermit that was obtained from Columbia University or from the diskette in the
  114. book "Using MS-DOS Kermit".
  115.  
  116. SUMMARY OF MS-DOS KERMIT COMMANDS
  117.  
  118. The commands listed are for the IBM PC, PS/2, and compatibles.    Other versions
  119. of MS-DOS Kermit (NEC PC9801, DEC Rainbow, Victor 9000, Zenith Z100, etc) may
  120. lack certain commands and features described here, primarily those having to
  121. do with networking, terminal emulation, and character-set translation.
  122.  
  123. Kermit commands consist of a sequence of "words" (verbs, nouns, numbers,
  124. filenames) separated by spaces and terminated by carriage return (Enter).
  125. Command description use this notation:
  126.  
  127.   <parameter>    - Replace this with an actual number, or filename, etc.
  128.   <number>    - Replace with an actual decimal number
  129.   <filename>    - A file specification, which may include disk & directory
  130.   <hh:mm:ss>    - Time of day in 24-hour notation, less than 12 hours from now
  131.   [<parameter>] - An optional field, which may be omitted
  132.   {A,B,C}    - Choose one of the items listed
  133.   [{A,B,C}]    - Choose zero or one of the items listed
  134.   = <value>    - Shows default value for a field
  135.  
  136. The following characters perform special functions in MS-DOS Kermit commands:
  137.  
  138.   Space        Separates command words ("fields").
  139.   TAB        (Ctrl-I) Like space
  140.   ESC        (Ctrl-[) Completes a keyword if possible.
  141.   Enter        (Ctrl-M, Carriage Return) Enters a command.
  142.   Formfeed  (Ctrl-L) Like Enter, but clears the screen first.
  143.   Linefeed  (Ctrl-J) Like Enter.
  144.   Backspace (Ctrl-H, Del) Deletes rightmost character from the command.
  145.   Ctrl-W    Deletes rightmost word from the command.
  146.   Ctrl-U    Deletes the entire command.
  147.   Ctrl-C    Cancels the current command, even if you have already entered it.
  148.   ?        (Question Mark) Requests a menu for the current command field.
  149.   ;        (Semicolon) Introduces a trailing command (in command files only)
  150.   \        (Backslash) Introduces a "backslash code".
  151.   ,        (Comma) Separates commands in a macro definition.
  152.   { }        (Braces) used for grouping characters or words together.
  153.  
  154. Backslash codes:
  155.  
  156.   \123       (up to 3 decimal digits) A decimal number or character value
  157.   \d123       (up to 3 decimal digits) Same as 123
  158.   \o123       (up to 3 octal digits) An octal (base 8) number or char value
  159.   \x123       (2 hexadecimal digits) A hexadecimal (base 16) number or character
  160.   \{ }       For grouping, e.g. \{12}6 = Ctrl-L 6, not ASCII 126 = tilde (~)
  161.   \;        Include a semicolon in a TAKE-file command or macro definition.
  162.   \%       Introduce a Kermit variable, \%1, \%2, ..., \%a, \%b, ... \%z
  163.   \K       (or \k) Introduce a Kermit connect-mode verb like \Kexit
  164.   {\Kxxx}  A user-defined macro called xxx assigned to a key
  165.   \B       (or \b) Send a BREAK signal, 275 milliseconds (OUTPUT command only)
  166.   \L       (or \l) send a Long BREAK, 1.5 seconds (OUTPUT only)
  167.   \255       Shorthand for CRLF or LFCR (INPUT command only)
  168.   \v(name) A built-in variable like \v(date)
  169.   \fname() A built-in function like \fsubstring()
  170.   \m(name) A user-defined named variable
  171.   \$(name) A DOS environment variable
  172.  
  173. * PROGRAM MANAGEMENT COMMANDS
  174.  
  175. EXIT or QUIT
  176.   Exit from MS-DOS Kermit.  Close all logs and files.  Leave serial port DTR
  177.   on.  Close network connections.  Execute ON_EXIT macro if defined.
  178.  
  179. DEFINE ON_EXIT <command, command, ...>
  180.   Define a macro to be executed automatically when Kermit EXITs.
  181.  
  182. SET EXIT WARNING {ON, OFF} = OFF
  183.   If you try to EXIT from Kermit while a connection (serial or network)
  184.   appears to be active, Kermit will warn you and give you a chance to
  185.   change your mind if SET EXIT WARNING ON.
  186.  
  187. STAY
  188.   On the MS-DOS Kermit command-line only, makes MS-DOS Kermit issue its prompt
  189.   after executing other commands on the command line, rather than EXITing as
  190.   it normally does when given command-line arguments.
  191.  
  192. PATCH [ <path> ]
  193.   Apply patches (corrections) to the running memory image from the appropriate
  194.   MSRxxx.PCH file.  Optional <path> specifies the disk and/or directory for
  195.   the patch file.
  196.  
  197. TAKE <filename>
  198.   Execute Kermit commands from the specified file instead of the keyboard.
  199.  
  200. PUSH
  201.   Go to the DOS prompt.     Return to Kermit prompt by typing the DOS EXIT
  202.   command.  Preserves connections, settings, etc.
  203.  
  204. RUN <DOS-command> [ <arguments> ]
  205.   Run a DOS program or execute a DOS command, e.g. RUN EDIT AUTOEXEC.BAT.
  206.  
  207. ECHO [ <text> ]
  208.   Display the <text> on the screen, automatically supplying carriage return
  209.   and linefeed at the end.  The <text> can contain backslash codes, variables,
  210.   etc.  Leading and trailing spaces are removed unless the <text> is
  211.   surrounded by { curly braces }.
  212.  
  213. SET PROMPT [ <text> ]
  214.   Change MS-DOS Kermit's interactive command prompt to the specified text,
  215.   which can contain backslash codes, variables, etc.  Curly braces can be used
  216.   as in the ECHO command.  If no <text>, restore default prompt.  <text> is
  217.   evaluated each time the prompt is printed, e.g.  SET PROMPT [\v(dir)]
  218.   MS-Kermit> always shows your current directory.
  219.  
  220. COMMENT <text>
  221.   For adding full-line comments to a TAKE file.
  222.  
  223. <command> ; text
  224.   Commands in TAKE files can have trailing comments preceded by semicolon (;).
  225.   Semicolon must be preceded by whitespace or else be first character on line.
  226.  
  227. <text>-
  228. <text>
  229.   Commands in TAKE files or macro definitions can be continued with hyphens,
  230.   but not in a trailing comment.
  231.  
  232. * DOS ACCESS COMMANDS
  233.  
  234. CD [<path>]
  235.   Change Directory.  Like DOS CD, but a disk drive letter can be included. 
  236.  
  237. CLS
  238.   Clear the screen.
  239.  
  240. DELETE <filespec>
  241.   Delete specified file(s).
  242.  
  243. DIRECTORY [<filespec>]
  244.   Like DOS DIR command.
  245.  
  246. RUN <command>
  247.   RUN the given DOS command or program.
  248.  
  249. TYPE <filename>
  250.   Like DOS TYPE command.
  251.  
  252. SPACE [<disk-letter>]
  253.   Show free space on current or specified disk.
  254.  
  255. SHOW MEMORY
  256.   Show free memory.
  257.  
  258. Others, such as MORE, COPY, RENAME, etc, are defined as macros in MSKERMIT.INI.
  259.  
  260. * COMMANDS FOR GETTING INFORMATION
  261.  
  262. HELP
  263.   Display a brief help message.
  264.  
  265. INTRO
  266.   A brief introduction to MS-DOS Kermit.
  267.  
  268. SHOW <category>
  269.   Display current settings, definitions, statistics selectively
  270.   (type SHOW ? for a list of categories).
  271.  
  272. VERSION
  273.   Display Kermit's version number.
  274.  
  275. Alt-h (during CONNECT only) popup help screen about special keys active
  276.   during CONNECT mode.
  277.  
  278. * COMMANDS FOR SETTING COMMUNICATION PARAMETERS
  279.  
  280. SET COM1 <address> [ <irq> ]
  281.   Specify the hardware address of COM1, which must be an NSC 8250, 16450,
  282.   16550A, or compatible UART, and, optionally, that its interrupt request
  283.   (IRQ) number is <irq>.  Also SET COM2, ..., COM4.  Give this command BEFORE
  284.   the corresponding SET PORT command.  See KERMIT.BWR.
  285.  
  286. TEST {COM1, COM2, COM3, COM4}
  287.   Tests if the given COM port is present and usable.
  288.  
  289. SET PORT {COM1, COM2, COM3, COM4} = COM1
  290.   Select a communication device (SET PORT ? for list of available devices, see
  291.   below for local area nets).  You can also say SET PORT 1, etc.  Port must be
  292.   real 8250 or 16450 or 16550A(FN) UART, or device that perfectly emulates
  293.   them.  If not, Kermit will use BIOS rather than direct hardware control.
  294.  
  295. SET PORT {BIOS1, BIOS2, BIOS3, BIOS4}
  296.   Use BIOS-level driver for COM1, COM2, COM3, or COM4, etc, rather than
  297.   Kermit's own built-in hardware driver.  Allows Kermit to be used with BIOS
  298.   itself, BIOS Int 14H interceptors (on LANs, for example), nonstandard
  299.   devices, etc.  This works with numerous network packages and drivers.
  300.  
  301. SET PORT FOSSIL {1, 2, 3, ... 99}
  302.   Use a Fossil driver on the given port, rather than Kermit's built-in COM
  303.   port driver or the PC BIOS.  A fossil driver must be installed.
  304.  
  305. SET PORT <other> - See section on Local Area Networks.
  306.  
  307. SET SPEED <number>
  308.   Communications port line speed: 1200, 2400, 9600, etc.  SET SPEED ? for list.
  309.   75/1200 is "split speed" (75 out, 1200 in).  Applies to currently selected
  310.   serial port (COM1-COM4), or to EBIOS connections.  Ignored for other SET
  311.   PORT options.
  312.  
  313. SET MODEM [ text ]
  314.   Equivalent to DEFINE _MODEM text.  Defines your modem type; text must agree
  315.   with the name of a dialing script, e.g. "set modem hayes" for HAYES.SCR.
  316.  
  317. SET CARRIER {ON, OFF} specifies treatment of Carrier Detect signal:
  318.   OFF = ignore it.
  319.   ON  = require it at all times except during DIAL macro execution.
  320.  
  321. SET PARITY {EVEN, ODD, MARK, SPACE, NONE} = NONE
  322.   Character parity to use during communication.
  323.  
  324. SET DISPLAY {7, 8} = 7
  325.   Synonym for SET TERMINAL BYTESIZE {7, 8}
  326.  
  327. SET STOP-BITS {1, 2}
  328.   This command lets users follow the instructions given by dialup services
  329.   to "set your stop bits to 1" (or, rarely, "2").
  330.  
  331. SET DUPLEX {FULL, HALF} = FULL
  332.   Select full or half duplex communication.
  333.   FULL = remote echo.  HALF = local echo plus RTS/CTS hardware handshake.
  334.  
  335. SET HANDSHAKE {NONE, XON, CR, LF, CODE <ascii-value>} = NONE
  336.   Half-duplex line turnaround character (XON is most common) for file-transfer
  337.   packets.
  338.  
  339. SET FLOW-CONTROL {XON/XOFF, RTS/CTS, NONE} = XON/XOFF
  340.   Select a full-duplex bidirectional flow-control method.
  341.   In addition XON/XOFF can be enabled in one direction only:
  342.   SET FLOW {INCOMING-XON/XOFF, OUTGOINGING-XON/XOFF}
  343.  
  344. * COMMANDS FOR CONNECTING TO A REMOTE COMPUTER OR SERVICE
  345.  
  346. DIAL <number>
  347.   Dial a modem.  See KERMIT.UPD.
  348.  
  349. CONNECT
  350.   Make a terminal connection to a device or another computer on the currently
  351.   selected port using the current communication settings.  Use Alt-x to return
  352.   ("escape back") to the MS-Kermit> prompt or Ctrl-] (your escape char)
  353.   followed by C.  You can abbreviate CONNECT as C.
  354.  
  355. HANGUP
  356.   Hang up a serial connection by lowering DTR until the next time the port is
  357.   accessed (by CONNECT, OUTPUT, INPUT, DIAL, PAUSE, or similar command), or
  358.   close current network connection.
  359.  
  360. SET ESCAPE \nnn
  361.   Change the CONNECT-mode escape character to the character whose ASCII
  362.   value is nnn, e.g. SET ESCAPE \28 for Ctrl-Backslash.
  363.  
  364. SET DEBUG SESSION
  365.   Turn off the terminal emulator, display received characters literally for
  366.   debugging: ^X = Ctrl-X, ~X = X with 8th bit on.
  367.  
  368. SET DEBUG OFF
  369.   Turn off session debugging, restore normal terminal emulation.
  370.  
  371. * COMMANDS FOR CONTROLLING TERMINAL EMULATION
  372.  
  373. SET TERMINAL [ TYPE ] {VT320, VT220, VT102, VT100, VT52, HEATH-19, ANSI,
  374.     HONEYWELL, PT200, TEK4010, D470, D463, WYSE50, NONE} = VT320
  375.   Select type of terminal to emulate.
  376.  
  377. SET ROLLBACK <number>
  378.   Number of text screens to be kept in the rollback buffer.  Each 24x80 screen
  379.   occupies about 4K; bigger screens need more space.  Also see SET TERMINAL
  380.   EXPANDED-MEMORY.
  381.  
  382. SET TERMINAL ANSWERBACK { ON, OFF, MESSAGE [ <text> ] }
  383.   Whether Kermit should respond with string "MS-DOS-KERMIT nnn_ttt" if, during
  384.   terminal emulation, it receives Ctrl-E (ENQ) from host.  Default is OFF,
  385.   no reply.  As of version 3.14 nnn = Kermit version number, ttt = terminal
  386.   type, e.g. "MS-DOS-KERMIT 314_VT320", terminated by a carriage return;
  387.   <text>, if given, appends up to 30 bytes of additional text to the standard
  388.   message, with a leading underscore added, before the carriage return.
  389.  
  390. SET TERMINAL APC {ON, OFF, UNCHECKED}
  391.   Enable, disable, or fully open up the Application Program Command feature of
  392.   the VT220/320 emulator, which the host send commands to MS-DOS Kermit
  393.   embedded in escape sequences. Default is OFF, meaning all such commands are
  394.   ignored, ON means allow execution of nominally "safe" commands, UNCHECKED
  395.   means all commands are executed without first checking for safety.
  396.  
  397. SET TERMINAL ARROW-KEYS {APPLICATION, CURSOR}
  398.   Put arrow keys in specified mode.
  399.  
  400. SET TERMINAL BELL {AUDIBLE, VISUAL, NONE} = AUDIBLE.
  401.   What to do with arriving BEL (beep, Ctrl-G) characters.
  402.  
  403. SET TERMINAL BYTESIZE {7, 8} = 7
  404.   Use 7 for stripping off parity bit, e.g. with UNIX systems, during terminal
  405.   emulation.  Use 8 for 8-bit international character sets, and for properly
  406.   receiving 8-bit control characters, such as sent by VMS.
  407.  
  408. SET TERMINAL CHARACTER-SET {LATIN1, DEC-MCS, GERMAN, FRENCH, etc} = LATIN1
  409.   Character set used by the host computer during terminal emulation.  Optional
  410.   trailing parameters G0, G1, G2, and G3 can be used to designate the character
  411.   set to the given Gn tables.  Example: SET TERM CHAR LATIN1 G1.  Type "set
  412.   ter char ?" for a complete list.
  413.  
  414. SET TERMINAL CLEAR-SCREEN
  415.   Clear the terminal screen.
  416.  
  417. SET TERMINAL CODE-PAGE CPnnn
  418.   Tells MS-DOS Kermit what code page is presently active on your PC.
  419.  
  420. SET TERMINAL COLOR <number> [, <number> [, <number> ] ]
  421.   Set fore- and background color for text terminal emulation.  The numbers are
  422.   0 (normal foreground), 1 (high-intensity foreground), 10 (fast screen update
  423.   on IBM EGA), 3x (foreground color), 4x (background color), where x is the
  424.   sum of any of 1 (Red), 2 (Green), and 4 (Blue).  Number 20 (v3.14) says to
  425.   restore to these colors after a "reset visual attributes" command from the
  426.   host, otherwise current colors are kept.
  427.  
  428. SET TERMINAL COMPRESSED-TEXT {GRAPHICS, TEXT-132}
  429.   Compressed text is how more characters are shown across the same screen.
  430.   Some video adapters support compressed text in regular text mode.  Others,
  431.   like the EGA and VGA, do not.     Use the GRAPHICS option to display compressed
  432.   text on the EGA or VGA, or else use horizontal scrolling (see \Kverbs).
  433.  
  434. SET TERMINAL CONTROLS {7-BIT, 8-BIT}
  435.   Tell VT220/320 emulator whether to send 7-bit or 8-bit control sequences when
  436.   DEC function, arrow, editing, or keypad keys are pressed.
  437.  
  438. SET TERMINAL CURSOR-STYLE {BLOCK, UNDERLINE} = UNDERLINE
  439.   Cursor style for terminal emulation.
  440.  
  441. SET TERMINAL DIRECTION {LEFT-TO-RIGHT, RIGHT-TO-LEFT}
  442.   Direction of screen writing during terminal emulation.
  443.  
  444. SET TERMINAL DISPLAY {7, 8}
  445.   Synonym for SET TERMINAL BYTESIZE.
  446.  
  447. SET TERMINAL EXPANDED-MEMORY {ON, OFF} = OFF
  448.   Whether to use expanded memory for retention of graphics screens and for
  449.   text terminal-emulation rollback screens.  See KERMIT.UPD.
  450.  
  451. SET TERMINAL GRAPHICS <name>
  452.   Specify the type of graphics adapter in your PC: CGA, EGA, VGA, others (SET
  453.   TERM GRAPH ? for complete list).  MS-DOS Kermit automatically tries to
  454.   figure out what kind of adapter you have.  Use this command if it guesses
  455.   wrong.  Applies to graphics emulation only.
  456.  
  457. SET TERMINAL GRAPHICS CHARACTER-WRITING {OPAQUE, TRANSPARENT}
  458.   Whether text characters written on graphics screens should let graphics
  459.   show through.
  460.  
  461. SET TERMINAL GRAPHICS COLOR <number> [, <number> [, <number> ] ]
  462.   Fore- and background colors for graphics screens.  Numbers same as for
  463.   SET TERMINAL COLOR.
  464.  
  465. SET TERMINAL GRAPHICS CURSOR {ON, OFF} = ON
  466.   Tell whether there should be a text cursor during graphics terminal
  467.   emulation.
  468.  
  469. SET TERMINAL HORIZONTAL-SCROLL {AUTOMATIC, MANUAL}
  470.   When Kermit's TERMINAL WIDTH is wider than the physical screen, you can view
  471.   characters off the physical screen by horizontal scrolling, which can be
  472.   manual (you push keys) or automatic (Kermit scrolls the screen automatically
  473.   as characters arrive to keep the cursor on the screen).  MANUAL is the
  474.   default for VT terminal emulation, AUTOMATIC for DG terminal emulation.
  475.  
  476. SET TERMINAL KEYCLICK {ON, OFF}
  477.   Turn keyclick sound effect on or off.
  478.  
  479. SET TERMINAL KEYPAD {APPLICATION, NUMERIC}
  480.   Put the numeric keypad into the specified mode.
  481.  
  482. SET TERMINAL MARGIN-BELL {ON, OFF}
  483.   Whether to ring the bell when the cursor nears the end of a screen line.
  484.  
  485. SET TERMINAL NEWLINE {ON, OFF}
  486.   ON means to send both a carriage return and a linefeed when you press Enter.
  487.   OFF means send only carriage return.
  488.  
  489. SET TERMINAL OUTPUT-SHIFT {NONE, AUTOMATIC, SI/SO, SS2, SS3, JIS7,
  490.     EUC-KANJI, DEC-KANJI, JIS7-KANJI} = NONE
  491.   Select the table-shifting commands surrounding a character sent to the host
  492.   when parity is other than NONE and the character has its 8th bit set.  NONE,
  493.   the default, says do nothing and thus the character's high bit is lost and
  494.   replaced by a parity bit.  SI/SO, SS2, and SS3 shift the character into G1,
  495.   G2, or G3, respectively, using ISO 2022 rules.  AUTO selects a method based
  496.   on the current GL value.  See KERMIT.UPD about Kanji.
  497.  
  498. SET TERMINAL REPLAY
  499.   Synonym for REPLAY.
  500.  
  501. SET TERMINAL RESET
  502.   Resets terminal emulator when CONNECT mode is next entered.
  503.  
  504. SET TERMINAL ROLLBACK {ON, OFF} = OFF
  505.   ON = restore rolled-back screens to the end when new characters
  506.   arrive.  OFF =  display new characters at current cursor position.
  507.  
  508. SET TERMINAL SCREEN-BACKGROUND {NORMAL, REVERSE}
  509.   REVERSE exchanges the fore- and background screen colors.
  510.  
  511. SET TERMINAL TABSTOPS {AT <n>, CLEAR AT <n>, CLEAR ALL}
  512.   Sets or clears screen tab stops at the specified positions.  <n> can be a
  513.   single number, a list of numbers, or <position>:<interval> to set tabs
  514.   beginning at the specified <position>, every <interval> spaces, e.g.
  515.   SET TAB AT 1:10.  By default, tabs are every eight spaces.  If your
  516.   tabstops get messed up, restore them to normal with "set term tab at 1:8".
  517.  
  518. SET TERMINAL TEK4010 {ENABLE, DISABLE}
  519.   Whether Kermit should automatically enter Tektronix graphics mode upon
  520.   receipt of special escape sequences from the host.  ENABLEd by default.
  521.  
  522. SET TERMINAL TIMESLICE-RELEASE {ENABLE, DISABLE} = ENABLE
  523.   ENABLE lets Kermit release a cpu time slice to mulitasking systems DESQview,
  524.   Windows, OS/2, etc, when there is no activity.
  525.  
  526. SET TERMINAL UNDERSCORE <fg-color> <bg-color>
  527.   Lets you select the fore- and background colors for underscore simulation
  528.   on color monitors.  Syntax same as SET TERM COLOR.
  529.  
  530. SET TERMINAL UPSS {DEC-MCS, LATIN1}
  531.   Select which character set to designate as your VT220/VT320 User Preferred
  532.   Supplemental Set.
  533.  
  534. SET TERMINAL VIDEO-WRITING {DIRECT, BIOS} = DEFAULT
  535.   Whether screen updates during emulation should be performed by going DIRECT
  536.   to the video adapter, or should proceed through the system's video BIOS.
  537.   DIRECT is faster.  Use BIOS if you you have trouble with DIRECT or you have
  538.   a BIOS-level speech device, etc.  Applies to text mode only.
  539.  
  540. SET TERMINAL VIDEO-CHANGE {ENABLED, DISABLED, DOS-ONLY} = DOS-ONLY
  541.   Control whether Kermit changes video modes (80 / 132 columns).
  542.  
  543. SET TERMINAL WIDTH {80, 132}
  544.   Put the video adapter into 80- or 132-column mode.  If Kermit can do this
  545.   itself, it will.  Otherwise it will try to run DOS batch program COLS80.BAT
  546.   or COLS132.BAT to do the job, which you must supply.  They should contain
  547.   whatever commands change the screen width on your PC, e.g. MODE or VMODE.
  548.  
  549. SET TERMINAL WRAP {ON, OFF}
  550.   Whether to break overlong screen lines into multiple lines.
  551.  
  552. * LOCAL AREA NETWORKS
  553.  
  554. The SET PORT command tells Kermit which type of network connection you want to
  555. use, and in some cases also the network host you want to communicate with.
  556.  
  557. SET PORT TCP/IP [ <Internet-name or Internet-address> [ <tcp-port-number> ] ]
  558. [ {NEW, RESUME} ]
  559.   Connect to an IP host using Kermit's built-in TCP/IP.  If the host is
  560.   omitted, the current TCP/IP session is continued; this lets you switch
  561.   to another type of connection and then back to your TCP/IP connection.
  562.   During a TCP/IP session, Kermit uses TELNET protocol to communicate with the
  563.   TELNET server on the remote host.  The default <tcp-port-number> is 23
  564.   (TELNET); you can optionally specify any other port except 25.
  565.  
  566. SET PORT TCP/IP <digit>
  567.   Resumes given session, 1 through 6.
  568.  
  569. SET PORT TCP/IP * [ <tcp-port-number> ]
  570.   Sets Kermit up as a TCP/IP server, awaiting a connection from a TCP client.
  571.   After giving this command, use the SERVER to make the Kermit server
  572.   available on the network, or CONNECT to have an interactive "chat" session.
  573.  
  574. SET PORT BWTCP <ip-address>
  575.   Make a TCP/IP connection via Beame & Whiteside TCP/IP, which must be loaded
  576.   on your PC.  An IP address (not hostname) is required.
  577.  
  578. SET PORT NETBIOS
  579.   Kermit awaits NETBIOS connections from other PCs on the net.  Also used with
  580.   AT&T StarLAN/StarGROUP.
  581.  
  582. SET PORT NETBIOS <name>
  583.   Tell Kermit to connect to another PC on the NETBIOS network.    Also for
  584.   AT&T StarLAN/StarGroup.
  585.  
  586. SET NETBIOS-NAME <name>
  587.   Tell Kermit to set your PC's Netbios node name to <name>.  Kermit appends
  588.   ".K" to the end of the name if you don't include it yourself.
  589.  
  590. SET PORT NOVELL
  591.   For using Novell network asynchronous communication servers (NASI/NACS).
  592.  
  593. SET PORT DECNET [<node> [<password>]]
  594.   For PATHWORKS LAT or CTERM connections.  Specify node to connect to, LAT
  595.   password if required.
  596.  
  597. SET PORT SUPERLAT <nodename>
  598.   Meridian Technology SuperLAT network interface - similar to SET PORT DECNET.
  599.  
  600. SET PORT UB-NET1
  601.   For Ungermann-Bass Net/One.
  602.  
  603. SET PORT OPENNET [<node>]
  604.   For Intel OpenNET, similar to NETBIOS.
  605.  
  606. SET PORT 3COM
  607.   For using 3COM BAPI asynchronous communication server, BRIDGE PCS or 3+OPEN
  608.   TCP versions.
  609.  
  610. SET PORT EBIOS {1, 2, 3, 4} [ name-of-server-port ]
  611.   Use Extended BIOS for communication with EBIOS-based asynchronous
  612.   communication servers like IBM's LANACS.
  613.  
  614. SET PORT TELAPI <Internet-address>
  615.   Connect to an Internet TCP/IP host through Novell LAN Workplace for DOS.
  616.  
  617. SET PORT TES <hostname>
  618.   Connect to a VMS system that is running Netware/VMS.
  619.  
  620. SET PORT {BIOS1, BIOS2, BIOS3, BIOS4}
  621.   For using any network that operates through a BIOS Int 14h interceptor.
  622.  
  623. HANGUP
  624.   Close network connection, terminate network session.
  625.  
  626. * CONNECT-MODE ESCAPE-LEVEL COMMANDS
  627.  
  628. During terminal emulation, you may type Ctrl-] (hold down Ctrl and press the
  629. rightbracket key) followed by any of the following characters (on German
  630. keyboards, hold down Strg and press +):
  631.  
  632.   ?   Help -- prints the available escape-level commands
  633.   0   (the digit zero) Transmit a NUL (ASCII 0)
  634.   A   Send TELNET Are You There
  635.   B   (also Alt-B) Transmit a BREAK signal 
  636.   C   (also Alt-X) Return to Kermit prompt level, keep connection open 
  637.   F   (also Ctrl-End) File the current text screen in the screen dump file 
  638.   H   Hangup the phone or network connection
  639.   I   Send TELNET Interrupt Process
  640.   L   Transmit a Long Break (1.8 seconds)
  641.   M   Toggle the mode line, i.e. turn it off if it is on & vice versa
  642.   P   Push to DOS; get back to CONNECT by typing EXIT at the DOS prompt
  643.   Q   Temporarily quit logging the remote session
  644.   R   Resume logging the remote session
  645.   S   (also Alt-S) Show the status of the connection 
  646.   ^]  (or whatever you have set the escape character to be)
  647.       Typing the escape character twice sends one copy of it to the host
  648.  
  649. * SET TRANSLATION INPUT COMMAND
  650.  
  651.   SET TRANSLATION ON
  652.   SET TRANSLATION INPUT <code1> <code2>
  653.  
  654. Specify that when a character that would normally be translated to <code1>
  655. arrives at the communication port during terminal emulation, it should be
  656. translated into <code2> before display on the screen.  Translations set up in
  657. this way take effect only after you give the command SET TRANSLATION INPUT ON.
  658.  
  659. * SET KEY COMMAND
  660.  
  661.   SET KEY <scancode> <value>
  662.  
  663. Assign <value> to the key whose scan code is given.  When you press the key or
  664. key combination that corresponds to the scan code during terminal emulation,
  665. the <value> is translated according to SET TERM CHARACTER-SET and then
  666. transmitted out the communication port.  If you don't know the scan code, type
  667. SET KEY alone on a line, then press the desired key or key combination when
  668. prompted, then enter the definition.  The <value> can be a single character, a
  669. text string (which may contain backslash codes), or one or more Kermit verbs.
  670.  
  671. * COMMONLY USED KERMIT KEYBOARD VERBS
  672.  
  673. The default key assignment is in parentheses.
  674.  
  675.   \Kexit    Exit from connect mode (Alt-x, Ctrl-]c)
  676.   \Kbreak    Send a BREAK signal (Alt-b, Ctrl-]b)
  677.   \Kcompose    Introduce a Compose-Key sequence
  678.   \Kdos        Push to DOS (Ctrl-]p)
  679.   \Kdump    Dump current screen to file (Ctrl-End on numeric keypad)
  680.   \Khangup    Hangup communication port connection (Ctrl-]h)
  681.   \Kignore    Ignore this key
  682.   \Klfone    Scroll left one column
  683.   \Klfpage    Scroll left 40 columns
  684.   \Klogoff    Stop session logging (Ctrl-]q)
  685.   \Klogon    Resume session logging (Ctrl-]r)
  686.   \Knethold    Enter (non-TCP/IP) network shell (Alt-z)
  687.   \Knextsession Toggle to next TCP/IP session, if any (Alt-n)
  688.   \Kmodeline    Toggle mode line off/on++ (keypad minus)
  689.   \Kprtscn    Print current screen (Print Screen)
  690.   \Kreset    Reset terminal emulator (Alt-=)
  691.   \Krtone    Scroll right one column
  692.   \Krtpage    Scroll right one 40 columns
  693.   \Ktermtype    Switch between text and graphics screens (Alt-minus)
  694.   \Kupscn    Roll back screen (PgUp)
  695.   \Kupone    Roll back screen one line (Ctrl-PgUp)
  696.   \Kdnscn    Roll screen forward (PgDn)
  697.   \Kdnone    Roll screen forward one line (Ctrl-PgDn)
  698.   \Knextsession Go to next TCP session
  699.   {\Kxxxx}    Execute macro named xxxx (xxxx can be any name)
  700.  
  701. Use SET KEY to assign or reassign these verbs to the keys of your choice.
  702. Example: "SET KEY \315 \Kexit" puts \Kexit on the F1 key.
  703.  
  704.   SET KEY CLEAR  Restore all Kermit's default key assignments.
  705.   SET KEY ON      Use BIOS to read keystrokes (scan codes).
  706.   SET KEY OFF     Use DOS rather than BIOS to read keystrokes.
  707.   SET KEY LK     Use external DEC LK250 keyboard driver (if loaded).
  708.  
  709. * PRINTER CONTROL
  710.  
  711. During terminal emulation, Kermit controls the printer according to escape
  712. sequences received from the host, including the following for VT102/220/320
  713. emulation:
  714.  
  715.   ESC [ 5 i    Begin transparent print (send port characters to printer)
  716.   ESC [ 4 i    End transparent print
  717.   ESC [ ? 5 i  Begin autoprint (send screen lines to printer)
  718.   ESC [ ? 4 i  End autoprint
  719.  
  720. Kermit also lets you use Ctrl-Print Screen to turn the printer on and off
  721. during terminal emulation.  The following command affects all these operations:
  722.  
  723. SET PRINTER <filename, PRN, or NUL>
  724.   Sends Connect mode printer material to the indicated file instead of to the
  725.   standard DOS printer name PRN; this is a "print to disk" option.  SHOW LOG
  726.   displays the current filename (defaults to PRN).
  727.  
  728. If you press Print Screen (no Ctrl), DOS gets the request itself, Kermit never
  729. sees it so the SET PRINTER command does not affect Print Screen.
  730.  
  731. * COMMANDS FOR TRANSFERRING FILES
  732.  
  733. Start a Kermit program on the remote computer, give it a "send", "receive",
  734. or "server" command, escape back to MS-DOS Kermit, and give it one of the
  735. following commands:
  736.  
  737. SEND <filename> [<alternate-name>]
  738.   Send files to remote Kermit receiver or server.  Can abbreviate as S.
  739.  
  740. PSEND <filename> <position> [ <as-name> ]
  741.   Sends a file starting at the given byte position.
  742.  
  743. RESEND <filename> [<alternate-name>]
  744.   Resumes an interrupted binary-mode transfer from the point of interruption.
  745.  
  746. RECEIVE [<filename>]
  747.   Wait for a file to arrive from the other Kermit program, which must
  748.   be given a SEND command.  Can abbreviate as R.
  749.  
  750. GET <remote-filename>
  751.   Ask a Kermit server to send the specified file(s).  Use GET <Enter>
  752.   to be prompted for remote and local names separately.
  753.  
  754. MAIL <filespec> <address>
  755.   Send the file as electronic mail to the address (if the remote Kermit
  756.   supports this feature).
  757.  
  758. * GETTING INFORMATION ABOUT FILE TRANSFER
  759.  
  760. STATISTICS
  761.   Display efficiency and other statistics about file transfers.
  762.  
  763. SHOW PROTOCOL
  764.   Display file transfer protocol-related parameter settings.
  765.  
  766. SHOW CONTROL
  767.   List file-transfer control-character prefixing.
  768.  
  769. SHOW FILE
  770.   Display file-related parameter settings
  771.  
  772. * COMMANDS FOR TALKING TO A SERVER
  773.  
  774. BYE
  775.   Shut down a remote Kermit server and log out its job
  776.  
  777. FINISH
  778.   Shut down a remote Kermit server, put it back at command level
  779.  
  780. GET <remote-filename>
  781.   Ask a Kermit server to send the specified file(s)
  782.  
  783. SEND <filename> [<alternate-name>]
  784.   Send files to remote Kermit receiver or server
  785.  
  786. REMOTE ASSIGN <variable> <value>
  787.   Tells the remote server to assign the given value to the given variable.
  788.  
  789. REMOTE CD [<directory> [<password>]]
  790.   Tell remote server to change to named directory.
  791.  
  792. REMOTE DELETE <filespec>
  793.   Tell remote server to delete the specified files.
  794.  
  795. REMOTE DIRECTORY [<filespec>]
  796.   Tell remote server to send directory listing for specified files.
  797.  
  798. REMOTE HELP
  799.   Ask the server to list the services it provides
  800.  
  801. REMOTE HOST command
  802.   Command for remote host in its own command language
  803.  
  804. REMOTE KERMIT command
  805.   Send a command to remote Kermit server in its own command language
  806.  
  807. REMOTE LOGIN user
  808.   Login to a remote Kermit server, separate prompts for password, etc.
  809.  
  810. REMOTE MESSAGE text
  811.   Send a one-line message to the remote Kermit server
  812.  
  813. REMOTE PRINT <filespec> [ <options> ]
  814.   Send the file to a remote server and ask the server to print it with the
  815.   specified options, if any.
  816.  
  817. REMOTE QUERY {KERMIT, SYSTEM, USER} <name>
  818.   Tells the remote server to send the value of given type of variable
  819.   of the given name.  MS-DOS Kermit displays it and also makes it available
  820.   in \v(query).
  821.  
  822. REMOTE SET <parameter> <value>
  823.   Tell remote server to set the specified parameter to the specified value.
  824.  
  825. REMOTE SPACE [directory]
  826.   Show disk space on remote host
  827.  
  828. REMOTE TYPE filespec
  829.   Display remote file(s)
  830.  
  831. REMOTE WHO
  832.   Display users logged on remote system
  833.  
  834. * COMMANDS FOR ACTING AS A SERVER
  835.  
  836. DISABLE <parameter>
  837.   Disable various capabilities of the server (DISABLE ? for list)
  838.  
  839. ENABLE <parameter>
  840.   Enable various capabilities of the server (ENABLE ? for list)
  841.  
  842. SET SERVER TIMEOUT <num>
  843.   How often the server should send NAK packets while waiting for a command,
  844.   0 = never (default).
  845.  
  846. SET SERVER LOGIN <name> <password>
  847.   Set up a name and password which must be sent to the server (by REMOTE
  848.   LOGIN) before it will accept any other commands.
  849.  
  850. SHOW SERVER
  851.   Examine server-related parameters.
  852.  
  853. SERVER [{<seconds>, <hh:mm:ss>}]
  854.   Act as a Kermit server, optionally for or until the given time.  Default time
  855.   is forever (until BYE or FINISH received, or interrupted with Ctrl-C).
  856.  
  857. The MS-DOS Kermit server honors the following requests:
  858.  
  859.               REMOTE ASSIGN     REMOTE QUERY
  860.   SEND          REMOTE CWD    REMOTE PRINT
  861.   GET          REMOTE DELETE    REMOTE MESSAGE
  862.   FINISH      REMOTE DIRECTORY    REMOTE SPACE
  863.   BYE          REMOTE HOST    REMOTE TYPE
  864.   LOGOUT      REMOTE KERMIT    REMOTE SET
  865.  
  866. * INTERRUPTION COMMANDS WHILE A FILE TRANSFER IS IN PROGRESS
  867.  
  868.   X or Ctrl-X: Stop sending the current file and go on to the next one, if any.
  869.   Z or Ctrl-Z: Stop sending this file, and don't send any further files.
  870.   E or Ctrl-E: Send Error packet to the remote Kermit.
  871.   C or Ctrl-C: Return to Kermit command level immediately.
  872.   Q or Ctrl-Q: Send a Ctrl-Q (Xon).
  873.   Enter key:   Try to wake up a stuck file transfer.
  874.  
  875. * CHANGING FILE TRANSFER PARAMETERS
  876.  
  877. SET ATTRIBUTES {ON, OFF} = ON
  878.   Enable/Disable processing of file attribute packets.
  879.  
  880. SET ATTRIBUTES {DATE, LENGTH, TYPE, CHARACTER-SET} {ON, OFF} = ON
  881.   Enable/Disable processing of specific file attributes.
  882.  
  883. SET BLOCK-CHECK {1, 2, 3} = 1
  884.   Level of error checking, 1 by default, 3 is strongest.
  885.  
  886. SET BLOCK-CHECK BLANK-FREE-TWO
  887.   Like SET BLOCK-CHECK 2, but formats block check characters to never
  888.   include blanks.
  889.  
  890. SET CONTROL-CHARACTER UNPREFIXED {<code>..., ALL}
  891.   Says you think it is safe to include the control character represented by
  892.   <code> without prefixing in packets that Kermit sends.  The <code> is the
  893.   numeric ASCII code for a control character.  See KERMIT.UPD.
  894.  
  895. SET CONTROL-CHARACTER PREFIXED {<code>..., ALL}
  896.   Says that the given control character(s) must be prefixed in outbound Kermit
  897.   packets.  By default, all control characters are prefixed.
  898.  
  899. SET REPEAT {COUNTS {ON, OFF}, PREFIX <character>}
  900.   Turns repeat-count prefixing (run-length encoding) on and off, and
  901.   lets you select the repeat-count prefix.
  902.  
  903. SET DEBUG PACKETS
  904.   Display packets on screen during file transfer.
  905.  
  906. SET DEBUG OFF
  907.   Turn off display of packets.
  908.  
  909. SET DESTINATION {DISK, PRINTER, SCREEN} = DISK
  910.   Direct incoming files to the specified device.
  911.  
  912. SET FILE DISPLAY {SERIAL, REGULAR, QUIET} = REGULAR
  913.   Format of Kermit's file transfer display.  Use SERIAL for hardcopy terminals,
  914.   Braille devices, speaking devices, etc.  QUIET means no display at all (used
  915.   automatically in remote mode).  Synonym: SET DISPLAY.
  916.  
  917. SET EOF {CTRL-Z, NOCTRL-Z} = NOCTRL-Z
  918.   Whether Ctrl-Z marks the end of a PC DOS text file.
  919.  
  920. SET FILE TYPE {TEXT, BINARY} = TEXT
  921.   TEXT implies record format conversion and character set translation.    Use
  922.   BINARY to send or receive files with no conversaion at all.
  923.  
  924. SET FILE COLLISION {DISCARD, OVERWRITE, RENAME, ...}
  925.   What to do when a file arrives that has the same name as an existing file:
  926.     APPEND    = Append to existing file
  927.     RENAME    = Automatically give the arriving file a unique name (default).
  928.     OVERWRITE = Overwrite the existing file with the new file.
  929.     DISCARD   = Reject any file that has the same name as an existing file.
  930.     UPDATE    = Reject incoming file if it is not newer than existing file.
  931.  
  932. SET {SEND, RECEIVE} PATHNAMES {ON, OFF}
  933.   Whether to remove/ignore (OFF) or include/obey (ON) pathnames on
  934.   outgoing/incoming files.  SEND is OFF and RECEIVE is ON by default.
  935.  
  936. SET FILE CHARACTER-SET {CP437, CP850, CP852, CP860, CP861, CP862, CP863,
  937.              CP865, CP866, SHIFT-JIS}
  938.   Tell Kermit which IBM PC code page to use when sending or receiving a text
  939.   file.     Default is your current PC code page as DOS reports it to Kermit (but
  940.   watch out, DOS tends not to report code pages correctly).  Kermit translates
  941.   between the current file character set and the transfer character set.
  942.   SHIFT-JIS is Code Page 932 for Japanese Kanji.
  943.  
  944. SET TRANSFER CHARACTER-SET {TRANSPARENT, LATIN1, LATIN2, CYRILLIC,
  945.                  HEBREW, JAPANESE-EUC}
  946.   Tell Kermit the character set used in Kermit packets.  TRANSPARENT, the
  947.   default, means no translation.  LATINx is ISO Latin Alphabet x.  CYRILLIC is
  948.   ISO 8859-5 Latin/Cyrillic, and can be used only with file character-set
  949.   CP866.  HEBREW is ISO 8859-8 Latin/Hebrew.  JAPANESE-EUC is for Japanese
  950.   Kanji and can be used only with FILE CHARACTER-SET SHIFT-JIS.  Synonym: SET
  951.   XFER CHARACTER-SET.
  952.  
  953. SET TRANSFER LOCKING-SHIFT {OFF, ON, FORCED} = ON
  954.   If PARITY is not NONE, Kermit automatically uses a locking-shift technique
  955.   for transferring 8-bit more efficiently over the 7-bit connection if other
  956.   Kermit agrees.  To turn off this feature, use OFF.  To force the use of this
  957.   feature even when parity is NONE, use FORCED.  Synonym: SET XFER ...
  958.  
  959. SET TRANSFER TRANSLATION {READABLE, INVERTIBLE} = READABLE
  960.   The default is READABLE, which optimizes character-set conversion for
  961.   "readability", rather than invertibility.  INVERTIBLE gives a unique
  962.   translation for each character between the FILE CHARACTER-SET and the
  963.   TRANSFER CHARACTER-SET.  Synonym: SET XFER ...
  964.  
  965. SET UNKNOWN-CHARACTER-SET {DISCARD, KEEP} = KEEP
  966.   What to do when a file arrives that has an unknown character set.
  967.  
  968. SET FILE WARNING {ON, OFF, NO-SUPERSEDE} = ON
  969.   Obsolete synomym for SET FILE COLLISION.
  970.  
  971. SET INCOMPLETE {KEEP, DISCARD} = KEEP
  972.   What to do with a file that does not arrive completely.
  973.  
  974. SET RETRY <number> = 5
  975.   How many times to retransmit a particular packet before giving up.
  976.  
  977. SET TIMER {ON, OFF} = ON
  978.   Enable/Disable timeouts and retransmissions during file transfer.
  979.  
  980. SET WINDOW <num> = 1
  981.   Number of sliding window packet slots.  Improves transmission efficiency.
  982.  
  983. SET SEND (or RECEIVE) <parameter> <value>
  984.   START-OF-PACKET <num> = 1  packet begin character, normally Ctrl-A
  985.   END-OF-PACKET <num> = 13   packet end character, normally carriage return
  986.   PACKET-LENGTH <num> = 94   packet length; 9024 max; > 94 for "long packets"
  987.   PAUSE <num> = 0         Interpacket pause, milliseconds
  988.   TIMEOUT <num> = 5         Timeout interval waiting for a packet, seconds
  989.   PADDING <num> = 0         How many padding characters before each packet
  990.   PADCHAR <num> = 0         Padding character to use
  991.   DOUBLE-CHAR <num>         Double packet character <char> when sending.
  992.   IGNORE-CHAR <num>         Discard <char> from packets when receiving.
  993.  
  994. Use SHOW FILE, SHOW PROTOCOL to examine current file transfer settings.
  995.  
  996. * COMMANDS FOR FILE TRANSFER WITHOUT ERROR CHECKING
  997.  
  998. Kermit can also transfer files or other information with remote computers,
  999. services, or devices that do not support the Kermit file transfer protocol.
  1000. These methods provide no error detection or correction.     No character-set
  1001. translation here.  Use with caution.
  1002.  
  1003. TRANSMIT <filename>
  1004.   Send a text file to the host as if you were typing it at the keyboard a line
  1005.   at a time.  Waits for linefeed (\10) to echo before sending next line.  Uses
  1006.   all current communication settings (parity, flow, etc).  CRLF is sent as CR
  1007.   only unless SET TRANSMIT LINE-FEEDS ON.  Empty lines are sent as pairs of
  1008.   CRs (or CRLFS) unless SET TRANSMIT FILL is used.
  1009.  
  1010. SET TRANSMIT <parameter> <value>
  1011.   Various parameters used to control TRANSMIT command.
  1012.   FILL-EMPTY-LINE {NONE, SPACE, <char>}
  1013.   LINE-FEEDS-SENT {ON, OFF}
  1014.   PAUSE <number> - pause <number> milliseconds after sending each line.
  1015.   PROMPT <char> - character to wait for before sending next line (= \10)
  1016.  
  1017. LOG SESSION <filename>
  1018.   Capture a remote file, which you must TYPE, into the named file
  1019.   (SESSION.LOG by default).  Use \Klogoff and \Klogon keyboard verbs to
  1020.   stop and restart logging (Ctrl-]q, Ctrl-]r).
  1021.  
  1022. CLOSE SESSION
  1023.   Stop capturing and close the session log file.
  1024.  
  1025. * COMMANDS FOR RECORDING THINGS
  1026.  
  1027. LOG TRANSACTION [<filename>] = TRANSACT.LOG
  1028.   Log file transfer names, times, etc, in given file.
  1029.  
  1030. LOG SESSION [<filename>] = SESSION.LOG
  1031.   Record terminal session in given file.
  1032.   Use REPLAY <filespec> to view the log.
  1033.  
  1034. LOG PACKETS [<filename>] = PACKET.LOG
  1035.   Record file transfer packets in given file.
  1036.  
  1037. WRITE {FILE, PACKET, SESSION, TRANSACTION, SCREEN} [<text>]
  1038.   Write the text to the specified log file or to the screen.  Text may contain
  1039.   backslash codes, variables, etc.  Kermit does not supply line terminators
  1040.   so include \13\10 at the end of the text if you want the text to end in CRLF.
  1041.  
  1042. CLOSE {PACKET, SESSION, TRANSACTION, READ, WRITE, ALL}
  1043.   Close specified log file and stop logging.
  1044.  
  1045. SHOW LOG
  1046.   Display names and status of log files.
  1047.  
  1048. Ctrl-]f (while in Connect mode)
  1049.   Dump current text screen into a file (even if graphics screen is showing).
  1050.  
  1051. Ctrl-End (on numeric keypad, while in Connect mode)
  1052.   Dump the current screen (text or graphics) into a file.
  1053.  
  1054. SET DUMP <name>
  1055.   Specify name of screen dump file for text screens (KERMIT.SCN by default).
  1056.   Graphics screens are saved to TEKPLTnn.TIF.
  1057.  
  1058. * MACROS
  1059.  
  1060. DEFINE <macro-or-variable-name> [<text>]
  1061.   Defines a macro or variable called "<name>" to have the given value. If
  1062.   <text> omitted, undefines the named macro or variable.  When defining
  1063.   command macros, <text> should be a list of MS-DOS Kermit commands, separated
  1064.   by commas.  The definition is copied literally (backslash codes not
  1065.   interpreted).
  1066.  
  1067. [DO] <macro-name> [<parameter1> [<parameter2> [<parameter3> [...]]]]
  1068.   Executes the macro called "<name>", and assigns the parameters, if any, to
  1069.   the variables \%1, \%2, \%3, etc, and sets the variable ARGC to the number of
  1070.   parameters plus one (1 = no parameters, 2 = 1 parameter, etc).  The variable
  1071.   \%0 is assigned the name of the macro.  These variables are available only
  1072.   within the macro.
  1073.  
  1074. ASSIGN <macro-or-variable-name> [<text>]
  1075.   Like DEFINE, copies the current value of <text> into the macro or variable,
  1076.   but (unlike DEFINE) all variables in the <text> are evaluated first.
  1077.  
  1078. SHOW MACRO [<name>]
  1079.   Shows the definition of the specified macro or variable.
  1080.  
  1081. IF DEFINED <name> <command>
  1082.   Executes the <command> if the macro or variable name is defined.
  1083.  
  1084. IF = ARGC <num> <command>
  1085.   Executes <command> if ARGC is equal to <num> (numeric constant or variable)
  1086.  
  1087. IF < ARGC <num> <command>
  1088.   Executes <command> if ARGC is less than <num>
  1089.  
  1090. IF > ARGC <num> <command>
  1091.   Executes <command> if ARGC greater than <num>
  1092.  
  1093. IF NOT > ARGC <num> <command>
  1094.   Executes <command> if ARGC less than or equal to <num>
  1095.  
  1096. IF =, <, >
  1097.   Can also be used with any numeric variables or constants, not just ARGC,
  1098.   including the other predefined numeric variables, VERSION, COUNT, and
  1099.   ERRORLEVEL, the built-in numeric variables like \v(ndate), \v(status), etc,
  1100.   or any other variable (\%1, \%a) that has a numeric value.  Use IF EQUAL to
  1101.   compare character strings (see below).
  1102.  
  1103. * VARIABLES
  1104.  
  1105. \%0 is the name of the currently executing macro (if any).  \%1 thru \%9 are
  1106. its parameters (arguments), created when the macro is invoked and destroyed
  1107. when it terminates.  If a macro invokes another macro, a new set of arguments
  1108. is created and the old set is preserved.
  1109.  
  1110. \%a through \%z are global variables that can be modified or accessed in any
  1111. context.  Created by DEFINE, ASSIGN, ASK, ASKQ, READ, GETC.
  1112.  
  1113. The following commands can be used for arithmetic on variables that have
  1114. numeric values:
  1115.  
  1116. INCREMENT <variable-name> [ <number> ]
  1117.   Adds <number>, if given, to the value of the named variable.    If no <number>
  1118.   is given, adds 1.
  1119.  
  1120. DECREMENT <variable-name> [ <number> ]
  1121.   Subtracts <number>, if given, to the value of the named variable.  If no
  1122.   <number> is given, subtracts 1.
  1123.  
  1124. Macro definitions can be used as variables too.     DEFINE or ASSIGN the macro in
  1125. the normal way, but refer to it using \m(name), for example:
  1126.  
  1127.   define phone-number 7654321
  1128.   if not defined phone-number echo Phone number is is not defined!
  1129.   echo The phone number is \m(phone-number).
  1130.   dial \m(phone-number)
  1131.  
  1132. \$(xxx) is a DOS environment variable, e.g. \$(COMSPEC).
  1133.  
  1134. \v(xxx) is a built-in variable, where xxx is its name:
  1135.   \v(argc)              Argument count to current macro
  1136.   \v(carrier)           SET CARRIER setting
  1137.   \v(charset)        Code Page currently active, such as CP437
  1138.   \v(cmdfile)           Name of currently executing command file, if any
  1139.   \v(console)           ANSI if ANSI.SYS loaded, else NONE
  1140.   \v(count)             Current SET COUNT value
  1141.   \v(cmdlevel)          Command level (for macros & TAKE files)
  1142.   \v(cps)               Characters per second, most recent file transfer
  1143.   \v(date)              Current date
  1144.   \v(inidir)            Full pathname of MSKERMIT.INI's directory
  1145.   \v(ndate)             Current date, numeric format
  1146.   \v(directory)         Current directory
  1147.   \v(dosversion)        Numeric DOS version, e.g. 500 for 5.00
  1148.   \v(errorlevel)        ERRORLEVEL value
  1149.   \v(inpath)        Drive:\path\ resulting from last IF INPATH command
  1150.   \v(input)             INPUT buffer
  1151.   \v(keyboard)          Keyboard type, e.g. 88, 101
  1152.   \v(line)              Synonym for \v(port)
  1153.   \v(monitor)           Monitor type - COLOR, MONO
  1154.   \v(parity)            Current SET PARITY setting
  1155.   \v(platform)          IBM-PC (or other)
  1156.   \v(port)              Current SET PORT setting
  1157.   \v(program)           MS-DOS_KERMIT
  1158.   \v(prompt)            Current SET PROMPT setting
  1159.   \v(query)        Result of last REMOTE QUERY command, if not a file
  1160.   \v(session)           Current TCP/IP session number (1 through 6)
  1161.   \v(tcpip_status)      Status of current TCP/IP session
  1162.   \v(space)             Free space on current disk, bytes
  1163.   \v(speed)             Current SET SPEED setting
  1164.   \v(startup)           Disk:\Directory\ from which Kermit was started
  1165.   \v(status)            Status of most recent command, 0 = success
  1166.   \v(sysid)        System identification in Kermit packets (U8)
  1167.   \v(system)            MS-DOS
  1168.   \v(terminal)          Current SET TERMINAL TYPE setting
  1169.   \v(time)              Current time
  1170.   \v(ntime)             Current time, numeric (seconds since midnight)
  1171.   \v(version)           MS-DOS Kermit numeric version number, e.g. 314
  1172.  
  1173. \fname(...) is a built-in function:
  1174.   \Fcharacter(number)   Character whose numeric value is given
  1175.   \Fcode(character)     Numeric code for the character
  1176.   \Fcontents(variable)  Contents of variable or macro
  1177.   \Fdate(filename)      Creation date of given file
  1178.   \Fdefinition(macro)   Definition of given macro
  1179.   \Ffiles(filespec)     Number of files that match the filespec
  1180.   \Findex(s1,s2,pos)    Position of string s1 in s2 starting at given position
  1181.   \Flength(string)      Length of given string
  1182.   \Fliteral(string)     String, literally, unevaluated
  1183.   \Flower(string)       String with uppercase letters lowercased
  1184.   \Flpad(string,len,char) String left padded to given length with char
  1185.   \Fmaximum(n1,n2)      Maximum of two numbers
  1186.   \Fminimum(n1,n2)      Minimum of two numbers
  1187.   \Fnextfile()          Next file from \Ffiles() list
  1188.   \Frepeat(string,num)  num repetitions of string
  1189.   \Freverse(string)     String, reversed left to right
  1190.   \Fright(string,num)   Rightmost num characters of string
  1191.   \Frpad(string,len,char) String right-padded to given length with char
  1192.   \Fsize(file)          Size (bytes) of given file
  1193.   \Fsubstr(string,pos,length) Substring of string, start position, length
  1194.   \Fupper(string)       String with lowercase letters uppercased
  1195.  
  1196. * SCRIPT COMMANDS
  1197.  
  1198. These commands are used (in conjunction with other Kermit commands) for
  1199. carrying out an automated dialog with a remote computer.
  1200.  
  1201. APC <text>
  1202.   Like OUTPUT (see below) but sends the text enclosed in an APC escape
  1203.   sequence.  See KERMIT.UPD.
  1204.  
  1205. ASK <variable> <prompt>
  1206.   Print the <prompt> on the screen, assign what user types to the <variable>.
  1207.  
  1208. ASKQ <variable> <prompt>
  1209.   Like ASK, but do not echo what user types.
  1210.  
  1211. CHECK {TCP/IP, NETWORKS, GRAPHICS, TERMINALS}
  1212.   Tests if conditional-build items are present.
  1213.  
  1214. GETC <variable> <prompt>
  1215.   Like ASK, but gets a single character.
  1216.  
  1217. GETOK <prompt>
  1218.   Like ASK, but asks a Yes or No question.  Succeeds if answer is Yes,
  1219.   fails if answer is No, otherwise reprompts.
  1220.  
  1221. OUTPUT <string>
  1222.   Send the <string> out the communications port.  May include backslash
  1223.   codes, variables, etc, plus the special items \B to send a BREAK and
  1224.   \L to send a Long BREAK.
  1225.  
  1226. SET OUTPUT PACING <msec>
  1227.   How many milliseconds (thousands of a second) to pause between each
  1228.   character in the OUTPUT string.
  1229.  
  1230. INPUT [<timeout>] <string>
  1231.   Wait up to <timeout> secs for <string> to arrive at communications port.
  1232.   If it arrives within interval, set SUCCESS, otherwise FAILURE.  String may
  1233.   contain backslash codes.
  1234.  
  1235. SET INPUT CASE {IGNORE, OBSERVE} = IGNORE
  1236.   Whether alphabet case should matter in searching for INPUT string.
  1237.  
  1238. SET INPUT DEFAULT-TIMEOUT <secs> = 1
  1239.   Timeout interval to use if none given in INPUT command.
  1240.  
  1241. SET INPUT ECHO {ON, OFF} = ON
  1242.   Whether to display characters read by INPUT command on the screen.
  1243.  
  1244. SET INPUT TIMEOUT-ACTION {PROCEED, QUIT} = PROCEED
  1245.   PROCEED means set SUCCESS or FAILURE and go on to next statement in macro
  1246.   definition or TAKE file.  QUIT means to quit from current macro or TAKE
  1247.   file immediately upon failure.
  1248.  
  1249. IF SUCCESS <command>
  1250.   Execute the <command> if the preceding command succeeded.
  1251.  
  1252. IF FAILURE <command>
  1253.   Execute the <command> if the preceding command failed.
  1254.  
  1255. PAUSE <secs>
  1256.   Do nothing for specified number of seconds, or until any character is typed
  1257.   at the keyboard.  Communications i/o is active.
  1258.  
  1259. MPAUSE <msecs>
  1260.   Like PAUSE, but number is milliseconds rather than seconds.
  1261.  
  1262. SLEEP <secs>
  1263.   Like PAUSE, but does not sample the communications channel.
  1264.  
  1265. WAIT [<timeout>] [CD] [CTS] [DSR] [RI]
  1266.   Wait <timeout> (seconds or until time hh:mm:ss) for specified modem signals.
  1267.  
  1268. CLEAR [ {INPUT-BUFFER, DEVICE-BUFFER, BOTH} ] = BOTH
  1269.   CLEAR INPUT clears the INPUT/REINPUT command buffer (characters that have
  1270.   already been read by Kermit's INPUT command).     CLEAR DEVICE clears the
  1271.   communication device buffer (characters that have not yet been read by
  1272.   by Kermit), CLEAR BOTH clears both buffers.
  1273.  
  1274. STOP
  1275.   Return immediately from current macro or TAKE file to top level.
  1276.  
  1277. STOP [ <number> ] [ <text> ]
  1278.   Return immdediately to top level, using the <number>, if specified, as the
  1279.   SUCCESS / FAILURE code, and setting the value of \v(status) to that number.
  1280.   If the <number> omitted, the SUCCESS / FAILURE status of the previous
  1281.   command is retained and \v(status) is not changed.  If the optional <text>
  1282.   is given, it is printed.
  1283.  
  1284. END
  1285.   Return from current macro or TAKE file to the macro or TAKE file which
  1286.   invoked it, or if none, to the MS-Kermit> prompt.  Synonym: POP.
  1287.  
  1288. END [ number ] [ text ]
  1289.   Return from current macro or TAKE file to the macro or TAKE file which
  1290.   invoked it, or if none, to top level.  Otherwise, identical to STOP.
  1291.   Synonym: POP.
  1292.  
  1293. GOTO <label>
  1294.   Instead of executing the next statement in the current macro definition or
  1295.   TAKE-file, go to the specified label and begin executing there.  The label
  1296.   is a word begining with a colon (:) in the left margin in a macro definition
  1297.   or TAKE file.  If not found, Kermit "POPs" one level and looks there, and so
  1298.   on through all active macros and command files.
  1299.  
  1300. FORWARD <label>
  1301.   Like GOTO, but searches only forward for the label.
  1302.  
  1303. :LOOP
  1304.   The previous line shows a label called "loop".  GOTO LOOP would find it.
  1305.  
  1306. REINPUT <timeout> <string>
  1307.   Like INPUT, but instead of waiting for <string> to arrive at communications
  1308.   port, REINPUT rescans the text that has already arrived.  If <timeout> is
  1309.   greater than zero, it also waits for additional characters from comm port.
  1310.  
  1311. SET COUNT <number>
  1312.   Sets the loop counter to <number>.
  1313.  
  1314. IF COUNT <command>
  1315.   Subtract one from COUNT.  If result > 0, execute <command>.  Use with GOTO
  1316.   to construct counted loops.
  1317.  
  1318. SET ALARM <time>
  1319.   Set an alarm <time> seconds from now, or at time hh:mm:ss.
  1320.  
  1321. IF ALARM <command>
  1322.   If the alarm time has passed, execute the <command>.
  1323.  
  1324. SET ERRORLEVEL <number>
  1325.   Set errorlevel to be returned to DOS by Kermit upon exit.
  1326.  
  1327. IF ERRORLEVEL <number> <command>
  1328.   If the ERRORLEVEL value is greater than or equal to the <number>,
  1329.   execute the <command>.
  1330.  
  1331. IF EXIST <filename> <command>
  1332.   If the named file exists, execute the <command>.
  1333.  
  1334. IF DIRECTORY <string> <command>
  1335.   Execute the <command> if <string> is the name of an existing directory
  1336.  
  1337. IF INPATH <filename> <command>
  1338.   If the named file can be found in your DOS PATH, or in the current
  1339.   directory, execute the <commmand> and set \v(inpath).
  1340.  
  1341. IF EQUAL <word1> <word2> <command>
  1342.   Execute <command> if the two words are the same.  The words may be text or
  1343.   variables.  Use { braces } for grouping.  Case is treated according to SET
  1344.   INPUT CASE.
  1345.  
  1346. IF LGT <word1> <word2> <command>
  1347. IF LLT <word1> <word2> <command>
  1348.   Execute <command> if <word1> is lexically greater than (LGT) or lexically
  1349.   less than (LLT) <word2>.  Otherwise, like IF EQUAL.
  1350.  
  1351. IF NEWER <file1> <file2> <command>
  1352.   Execute <command> if <file1> is newer than <file2>.
  1353.  
  1354. IF NUMERIC <string> <command>
  1355.   Execute <command> if <string> contains only digits.
  1356.  
  1357. OPEN {READ, WRITE, APPEND} <filename>
  1358.   Open a DOS file in the given mode.
  1359.  
  1360. READ <variable-name>
  1361.   Read a line from the current OPEN READ file into the given variable,
  1362.   discarding line terminators.    Sets FAILURE flag at end of file.
  1363.  
  1364. WRITE FILE <text>
  1365.   Write the text into the current OPEN WRITE or OPEN APPEND file; <text> can
  1366.   contain any mixture of ordinary characters, backslash codes, variable names.
  1367.  
  1368. CLOSE {READ, WRITE}
  1369.   Close the current READ or WRITE (including APPEND) file.
  1370.  
  1371. SET TAKE {ERROR, ECHO} {ON, OFF}
  1372. SET MACRO ERROR {ON, OFF}  
  1373.   Separate control of echoing and error handling in macros and TAKE files.
  1374.   ECHO ON means to echo commands as they are read from the file or macro
  1375.   definition.  ERROR ON means to exit from the command file or macro
  1376.   definition if an error occurs; ERROR OFF means don't exit, continue
  1377.   processing (e.g. let errors be handled by IF FAILURE / IF SUCCESS).
  1378.  
  1379. * MACROS DEFINED IN MSKERMIT.INI
  1380.  
  1381. STATUS               Prints SUCCESS or FAILURE status of previous command
  1382. FATAL [ message ]    Terminates macro or TAKE file with failure status
  1383. ERRSTP [ message ]   Like FATAL, but also hangs up communication connection
  1384.  
  1385. MORE filename        Runs DOS MORE command on given file
  1386. COPY file1 file2     Runs DOS COPY command
  1387. CHCP [ number ]      Runs DOS CHCP command (show or change code page)
  1388. EDIT [ filename ]    Runs your preferred editor on the given file
  1389. RENAME file1 file2   Runs DOS REN command
  1390. PWD                  Print Working (current) Directory
  1391.  
  1392. LOOKUP name          Looks up the given name in your dialing directory
  1393. DIAL [ number ]      Dials your modem
  1394. REDIAL               Redials most recent DIAL number
  1395. ATHANGUP             Hangs up Hayeslike modem using +++ and ATH0
  1396.  
  1397. CYRILLIC             Sets up for Cyrillic terminal emulation and file transfer
  1398. HEBREW               Sets up for Hebrew terminal emulation and file transfer
  1399. ROMAN                Sets up for (West European) Roman characters
  1400. EASTERN              Sets up for East European Roman characters
  1401.  
  1402. HFONT                Loads Hebrew font (cp862)
  1403. CFONT                Loads Cyrillic font (cp866)
  1404. EFONT                Loads East European Roman font (cp852)
  1405. MFONT                Loads West European Roman font (cp 850)
  1406. AFONT                Loads default font (cp437)
  1407. IFONT                Loads Icelandic font (cp861)
  1408. SCRAWL               Well, you'll see...  :-)
  1409. Note... CHCP does not work with these fonts.
  1410.  
  1411. VMS                  Set typical communications paramaters for VMS
  1412. UNIX                 Set typical communications paramaters for UNIX
  1413. IBM                  Set paramaters for IBM mainframe linemode connections
  1414. FULLSCREEN           Parameters for IBM mainframe fullscreen connections
  1415. BBS                  Set parameters for accessing a BBS
  1416. TELNET               For making TCP/IP connections with Kermit's own TCP/IP
  1417. TELAPI               For making TCP/IP connections via Novell LWP TELAPI
  1418.  
  1419. CAPTURE filename     Capture next CONNECT session into given file
  1420. TEXT                 Text-mode file transfers (= SET FILE TYPE TEXT)
  1421. BINARY               Binary-mode file transfers (= SET FILE TYPE BINARY)
  1422. NOISY                Set file transfer parameters for noisy connection
  1423. NORMAL               Set file transfer parameters for normal connection
  1424. CLEAN                Set file transfer parameters for very clean connection
  1425. FAST                 Faster than CLEAN, assumes a very transparent channel
  1426. ROBUST               Like NORMAL, assumes a non-transparent channel
  1427.  
  1428. (End of MS-DOS Kermit 3.14 Help File)
  1429.