home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 June / SIMTEL_0692.cdr / msdos / kermit / mskerdoc.arc / mskerm.hlp < prev    next >
Encoding:
Text File  |  1988-12-30  |  16.2 KB  |  418 lines
  1.   MS-DOS KERMIT FOR THE IBM PC FAMILY, COMPATIBLES, AND OTHER MS-DOS SYSTEMS
  2.  
  3.                             Version 2.32, 11 Dec 1988
  4.  
  5.                                 PROGRAM SUMMARY
  6.  
  7.                C. Gianone (Columbia University)
  8.                      J.R. Doupnik (Utah State University)
  9.  
  10.              See the MS-DOS KERMIT USER GUIDE for complete details
  11.  
  12. Kermit-MS can be run interactively, from a batch file, as an "external" DOS
  13. command, or with redirected or piped standard input and output.  Upon initial
  14. startup, the program executes any commands found in the file MSKERMIT.INI in
  15. the current disk or DOS path, or the file specified by "-f filename" on the
  16. Kermit command line.
  17.  
  18. * Interactive Operation:
  19.  
  20. To run Kermit-MS interactively, invoke the program from DOS command level by
  21. typing its name, usually "kermit".  When you see the command's prompt,
  22. "Kermit-MS>", you may type Kermit commands repeatedly until you are ready to
  23. exit the program.  The commands EXIT or QUIT return you to DOS.
  24.  
  25. While typing commands, use BACKSPACE to erase the character most recently
  26. typed, Ctrl-W to delete the most recent field, or Ctrl-U to delete the entire
  27. command, and enter the command by typing RETURN (Carriage Return, Enter), or
  28. Ctrl-L.  A question marked typed at any point in a command (except in a
  29. filename or character string) will give you a brief hint about what's expected
  30. at that point.  Pushing ESC key will complete the command current field, if
  31. possible, and position the cursor at the next field.  If completion is not
  32. possible, Kermit will beep.  You can cancel any command during its execution by
  33. typing Ctrl-C.
  34.  
  35. * Command Line Invocation:
  36.  
  37. Kermit-MS may be invoked with command line arguments from DOS command level,
  38. for instance:
  39.  
  40.     A>kermit set port 1, set speed 9600, connect
  41.  
  42. In this case, help and completion are not available and Kermit-MS will exit
  43. back to DOS after completing the specified commands unless you include the
  44. "stay" command.  Several commands may be given on the command line, separated
  45. by commas.
  46.  
  47. * Batch Operation:
  48.  
  49. Like other MS-DOS programs, Kermit-MS may be operated under batch with command
  50. line arguments.  If you invoke it without command line arguments, it will run
  51. interactively, reading commands from the keyboard and not the batch file.  When
  52. it exits, batch processing will continue to the end of the batch file.  An
  53. ERRLEVEL number is returned by Kermit to assist batch file controls.
  54.  
  55. * Remote Operation:
  56.  
  57. The MS-DOS CTTY command allows an MS-DOS system to be used from a terminal
  58. connected to its communication port, e.g. "CTTY COM1".  You can then use DOS,
  59. and Kermit, from a terminal or computer connected to the PC's COM1 device.
  60.  
  61. Notation:
  62.  
  63. <parameter>   - Replace this with an actual number, or filename, etc.
  64. <number>      - Replace with an actual decimal number
  65. <filespec>    - A file specification, which may include disk & directory
  66. <hh:mm:ss>    - Time of day in 24-hour notation, less than 12 hours from now
  67. [<parameter>] - An optional field, which may be omitted
  68. {A,B,C}       - Choose one of the items listed
  69. [{A,B,C}]     - Optionally choose one of the items listed
  70.  
  71. * Top-Level Kermit-MS Commands:
  72.  
  73. -F <filespec>   (From DOS command line only)
  74.   Use <filespec> instead of MSKERMIT.INI as initialization file.
  75.   "kermit -f nul" runs Kermit without any initialization file at all.
  76. ASK <variable-name> <prompt string>
  77.   Prompt user, store what user types in variable.
  78. ASSIGN <variable-name-1> <variable-name-2> 
  79.   Copy the value of variable 2 to variable 1.
  80. BYE
  81.   Shut down a remote Kermit server and log out its job.
  82. CLEAR
  83.   Clear the communications input buffer.
  84. CLOSE {PACKET, SESSION, TRANSACTION}
  85.   Close the specified log file and stop logging.
  86. COMMENT <string>
  87.   For adding comments to a TAKE command file.
  88. CONNECT
  89.   Make a terminal connection to another computer.
  90. CWD <path> or CD <path>
  91.   Change local working directory.
  92. DEFINE <macro-name> [<definition>]
  93.   Group Kermit-MS commands together into a macro, or define a variable.
  94. DELETE <filespec>
  95.   Delete local files
  96. DIRECTORY [<filespec>]
  97.   List names, sizes, and dates of local files
  98. DISABLE <function>
  99.   Prevent the specified function to be performed when in server mode.
  100. DO <macro-name> <parameters>
  101.   Perform the commands in a macro, with parameters for substitution.
  102. ECHO <text>
  103.   Display the <text> on the screen
  104. ENABLE <function>
  105.   Allow the specified function to be performed when in server mode.
  106. EXIT
  107.   Exit from Kermit-MS
  108. FINISH
  109.   Shut down a remote Kermit server
  110. GET <remote-filespec>
  111.   Ask a Kermit server to send the specified file(s).
  112. GOTO <label>
  113.   In script execution, transfer control to the specified label.
  114.   Label appears in left margin, begins with colon (:).
  115. HANGUP
  116.   Instruct modem to hangup the phone, or close the network connection.
  117. HELP
  118.   Display a brief help message about Kermit-MS.
  119. IF [NOT] <condition> <command>
  120.   In a script, execute the command if the condition is true.  Conditions are:
  121.   ALARM, COUNT, DEFINED, ERRORLEVEL, EQUAL, EXIST, FAILURE, SUCCESS
  122. INPUT [timeout] text
  123.   Input the specified text from the remote system within 'timeout' seconds
  124. LOG PACKETS <filespec>
  125.   Record file transfer packets in specified file or device
  126. LOG SESSION <filespec>
  127.   Record remote terminal session in specified file or device
  128. LOG TRANSACTION <filespec>
  129.   Report the progress of file transfers in the specified file or device
  130. LOGOUT
  131.   Logout remote server, but don't exit from Kermit-MS
  132. MAIL <file> <user>
  133.   Send the file as mail to the user, through a Kermit server
  134. OUTPUT text
  135.   Output the specified text to the remote system
  136. PAUSE [{<seconds>, <hh:mm:ss>}]
  137.   Sleep for specified number of seconds or until the specified time of day
  138. POP
  139.   When executing a command file or macro, return immediately one level up
  140. PUSH
  141.   Invoke inferior MS-DOS command processor, type EXIT to DOS to return
  142. QUIT
  143.   Exit from Kermit-MS
  144. RECEIVE <alternate-name>
  145.   Wait for files from the other Kermit
  146. REMOTE <command>
  147.   Prefix for commands to remote Kermit server (see below)
  148. RUN <program> [<arguments>]
  149.   Invoke an MS-DOS command or program, optionally with command-line arguments
  150. SEND <filename> [<alternate-name>]
  151.   Send files to remote Kermit receiver or server
  152. SERVER [{<seconds>, <hh:mm:ss>}]
  153.   Act as a Kermit server, optionally for or until the given time
  154. SET <parameter> <value>
  155.   Set various parameters (see below)
  156. SHOW
  157.   Display current settings, definitions, statistics selectively (see below)
  158. SPACE
  159.   Show disk space
  160. STATUS
  161.   Show values of all SET parameters
  162. STAY (from DOS command line only)
  163.   Stay within Kermit after other commands have executed
  164. STOP
  165.   In a command file or macro, return to Kermit-MS> prompt level immediately
  166. TAKE <filespec>
  167.   Execute Kermit-MS commands from specified file
  168. TRANSMIT filespec [prompt]
  169.   Send the characters from the file "raw" with no error checking
  170. TYPE <filespec>
  171.   Display a local file on the screen
  172. VERSION
  173.   Display Kermit-MS program version number and release date
  174. WAIT {<seconds>, <hh:mm:ss>} [\CD] [\DSR] [\CTS]
  175.   Wait (until) the specified time for the given modem signals to appear
  176.  
  177. * File specifications:
  178.  
  179. In all commands, file specifications may include fully qualified DOS paths,
  180. including device specifications.  Allowable wildcard characters are "*"
  181. (match from here to end of field) and "?" (single character), as in DOS,
  182. except "#" must be used instead of "?" to match the first character of a
  183. filename, to allow ? to give help in that position.
  184.  
  185. * Interruption commands while a file transfer in progress:
  186.  
  187. ^X Stop sending the current file and go on to the next one, if any.
  188. ^Z Stop sending this file, and don't send any further files.
  189. ^E Send Error packet to the remote Kermit.
  190. ^C Return to Kermit-MS command level immediately (without notifying the host).
  191. CR Simulate a timeout: resend the current packet, or NAK the expected one.
  192.  
  193. * Remote Commands:
  194.  
  195. REMOTE CWD [directory]
  196.   Change remote Working Directory
  197. REMOTE DELETE filespec
  198.   Delete remote file(s)
  199. REMOTE DIRECTORY [filespec]
  200.   List remote file(s)
  201. REMOTE HELP
  202.   Ask the server to list the services it provides
  203. REMOTE HOST [command]
  204.   Command for remote host in its own command language
  205. REMOTE KERMIT [command]
  206.   Send a command to remote Kermit server in its own command language
  207. REMOTE SEND text
  208.   Send a one-line message to the remote Kermit server
  209. REMOTE SPACE [directory]
  210.   Show disk space on remote host
  211. REMOTE TYPE filespec
  212.   Display remote file(s)
  213. REMOTE WHO
  214.   Display users logged on remote system
  215. * MS-DOS Kermit server honors the following requests:
  216.  
  217. SEND        REMOTE CWD        REMOTE SEND
  218. GET         REMOTE DELETE     REMOTE SPACE
  219. FINISH      REMOTE DIRECTORY  REMOTE TYPE
  220. BYE,LOGOUT  REMOTE HOST       REMOTE WHO
  221.  
  222. * SET commands:
  223.  
  224. ALARM {seconds, hh:mm:ss}
  225.   In scripts, set an alarm (for use with IF ALARM).
  226. ATTRIBUTES {ON,OFF}
  227.   Enable or disable the use of File Attribute packets.
  228. BAUD <number>
  229.   Communications port line speed (synonym for SPEED)
  230. BELL {ON,OFF}
  231.   Whether to beep at the end of a transaction
  232. BLOCK-CHECK-TYPE {1,2,3}
  233.   Level of error checking for file transfer
  234. COUNT <number>
  235.   In scripts, set up a loop counter (for use with IF COUNT)
  236. DEBUG {ON,OFF,PACKETS,SESSION}
  237.   Display packets during file transfer, ctrl chars during terminal session
  238. DEFAULT-DISK <disk-name>
  239.   Default disk drive for file i/o
  240. DELAY <number>
  241.   Amount of time to pause after a SEND command before sending the file.
  242. DESTINATION {DISK,PRINTER,SCREEN}
  243.   Default destination device for incoming files
  244. DISPLAY {QUIET,REGULAR,SERIAL,7-BIT,8-BIT}
  245.   For selecting the type of file transfer display and terminal screen displays
  246. DUMP <filespec>
  247.   Screen dump file (or device) name
  248. END-OF-LINE <ASCII-value>
  249.   Packet termination character, normally CR (\13)
  250. EOF {CTRL-Z,NOCTRL-Z}
  251.   Method for determining or marking end of file
  252. ERRORLEVEL <number>
  253.   Status code to be returned by Kermit upon exit
  254. ESCAPE <character>
  255.   Escape character for CONNECT, normally Control-right square bracket (\29)
  256. FLOW-CONTROL {XON/XOFF,NONE}
  257.   Select full-duplex flow control method
  258. HANDSHAKE {XON, CR, LF, CODE <ascii-value>}
  259.   Half-duplex line turnaround character
  260. INCOMPLETE {DISCARD,KEEP}
  261.   What to do with an incompletely received file
  262. INPUT <parameter> <value>
  263.   Various parameters for INPUT script command
  264. KEY <keycode> <definition>
  265.   Specify key redefinitions, or "keystroke macros"
  266. LOCAL-ECHO {ON,OFF}
  267.   Specify which computer does the echoing during CONNECT
  268. MODE-LINE {ON,OFF}
  269.   Whether to display a mode line during terminal emulation
  270. PARITY {EVEN,ODD,MARK,SPACE,NONE}
  271.   Character parity to use during communication
  272. PORT {1,2,3,4,COM1,COM2,COM3,COM4,BIOS1,BIOS2,BIOS3,BIOS4,NET [<name>],UB-NET1}
  273.   Select a port, driver, or network for communication
  274. PROMPT <string>
  275.   Change the "Kermit-MS>" prompt to <string>
  276. RECEIVE <parameter> <value>
  277.   Request remote Kermit to use specified parameters (see below)
  278. REMOTE {ON,OFF}
  279.   For running Kermit-MS interactively from back port
  280. RETRY <number>
  281.   Packet retransmission threshold
  282. SEND <parameter> <value>
  283.   Use the specified parameters during file transfer (see below)
  284. SPEED <number>
  285.   Communications port line speed (synonym for BAUD)
  286. TAKE-ECHO {ON,OFF}
  287.   Control echoing of commands from TAKE files and macros during execution
  288. TERMINAL <parameter> <value>
  289.   Emulation and parameters (see below)
  290. TIMER {ON,OFF}
  291.   Enable/disable timeouts during file transfer
  292. TRANSLATION INPUT <port-char> <screen-char>
  293.   Translate arriving port character to specified screen character
  294. WARNING {ON,OFF}
  295.   Specify how to handle filename collisions
  296.  
  297. * SET SEND/RECEIVE parameters:
  298.  
  299. DELAY <number>
  300.   Wait that many seconds before sending the first packet of a file
  301. PACKET-LENGTH <number>
  302.   Maximum packet length
  303.   SET REC PACK 97 or greater enables long packets
  304.   SET SEND PACK xx overrides negotiated length, but only if xx is shorter
  305. PADCHAR <ASCII-value>
  306.   Pre-packet padding character
  307. PADDING <number>
  308.   Number of padding characters per packet
  309. PAUSE <number>
  310.   Inter-packet pause, milliseconds, only for sending
  311. QUOTE <ASCII-value>
  312.   Control prefix
  313. START-OF-PACKET <ASCII-value>
  314.   Packet-start character
  315. TIMEOUT <number>
  316.   Timeout interval
  317.  
  318. * SET KEY
  319.  
  320.   Generally terminate this command with a carriage return to force Kermit to
  321.   prompt for a key to be pushed and then for a new definition.
  322.   A null definition (just a carriage return) removes an existing definition,
  323.   and Control-C exits with the current definition intact.  A question mark
  324.   response will show kinds of definitions available, including "verbs".
  325.   SET KEY CLEAR removes all definitions and restores the built-in set.
  326.   SET KEY OFF means use DOS rather than the Bios (if applicable) to obtain
  327.   keystrokes; ON means use the system Bios.
  328.  
  329. * SET TERMINAL parameters:
  330.  
  331. NONE, VT52, HEATH, VT102, TEK4010 (type of terminal to emulate)
  332. CHARACTER-SET {UK, US, ALTERNATE-ROM}
  333. CLEAR (clear the screen and screen memory)
  334. COLOR number [, number [, number]]
  335.   0   For no snow on IBM Color Graphics Adaptor (CGA)
  336.   1   High intensity
  337.   10  For fast screen update on IBM EGA
  338.   3x  Foreground color
  339.   4x  Background color
  340.       x = Sum of any of: 1 (Red), 2 (Green), 4 (Blue)
  341. CURSOR-STYLE {BLOCK, UNDERLINE}
  342. DIRECTION {LEFT-TO-RIGHT, RIGHT-TO-LEFT}
  343. KEYCLICK {ON, OFF}
  344. MARGIN-BELL {ON, OFF}
  345. NEWLINE-MODE {ON, OFF}
  346. ROLL {ON, OFF}
  347. SCREEN-BACKROUND {NORMAL, REVERSE}
  348. TAB {AT n, CLEAR AT n, CLEAR ALL}
  349. WRAP {ON, OFF}
  350.  
  351. * CONNECT escape-level commands:
  352.  
  353.   ?   Help -- prints the available single-character commands
  354.   0   (the digit zero) Transmit a NUL (ASCII 0)
  355.   B   Transmit a BREAK signal
  356.   C   Close the connection and return to Kermit-MS prompt level
  357.   F   File the current screen in the screen dump file
  358.   H   Hangup the phone (or network connection)
  359.   L   Transmit a Long Break (1.8 seconds)
  360.   M   Toggle the mode line, i.e. turn it off if it is on & vice versa
  361.   P   Push to DOS; get back to CONNECT by typing EXIT
  362.   Q   Temporarily quit logging the remote session
  363.   R   Resume logging the remote session
  364.   S   Show the status of the connection
  365.   ^]  (or whatever you have set the escape character to be)
  366.       Typing  the  escape character twice sends one copy of it to the connected
  367.       host
  368.  
  369. Escape character is normally Ctrl-].  Use SET ESCAPE to change it, or use
  370. SET KEY to assign \Kexit or other "Kermit verbs" to the keys of your choice.
  371. \Kexit is assigned to Atl-x on IBM keyboards.
  372.  
  373. * SHOW commands
  374.  
  375. COMMUNICATIONS
  376.   Port, speed, parity, flow control, handshake, echo, modem signals.
  377. FILE
  378.   Path, destination, EOF mode, display, incomplete, warning, take-echo.
  379. KEY
  380.   Displays the definition of a selected key or all defined keys
  381. LOGGING
  382.   Shows names and status of session, packet, and transaction logs.
  383. MACROS <name>
  384.   Displays the name(s) and definitions of the given macro(s)
  385. MODEM
  386.   Displays the current status of the Carrier Detect (CD), Data Set Ready (DSR
  387.   meaning the modem), and Clear to Send (CTS) modem signals.
  388. PROTOCOL
  389.   Shows the values of the SET SEND and SET RECEIVE parameters.
  390. SCRIPTS
  391.   Displays values of SET INPUT, SET ALARM, and SET COUNT parameters.
  392. STATISTICS
  393.   Displays statistical information on the most recent file transfer and values
  394.   accumulated since stating Kermit, including estimated throughput.
  395. TERMINAL
  396.   Displays values of SET TERMINAL parameters.
  397. TRANSLATION INPUT
  398.   Lists codes for received bytes and their new values, plus whether the
  399.   translation mechanism is ON or OFF (default is off)
  400.  
  401. * Backslash Notation:
  402.  
  403. \123    (up to 3 decimal digits) - A decimal number
  404. \d123   (up to 3 decimal digits) - A decimal number
  405. \o123   (up to 3 octal digits) - An octal (base 8) number (also \O)
  406. \x123   (up to 3 hexadecimal digits) - a hexadecimal number
  407. \{}     For grouping, e.g. \{27}3 = ESC 3
  408. \;      Include a semicolon in a TAKE-file command or macro definition.
  409. \%      Introduce a Kermit variable, like \%1, \%2, ..., \%a, \%b, ... \%z
  410. \K      A Kermit connect-mode verb, e.g. \Kexit, \Kbreak, etc.
  411. \b      Send a BREAK (OUTPUT command only) (also \B)
  412. \255    Shorthand for CRLF or LFCR (INPUT command only)
  413. \CD     Carrier Detect RS-232 signal (WAIT command only)
  414. \DSR    Data Set Ready RS-232 signal (WAIT command only)
  415. \CTS    Clear to Send RS-232 signal (WAIT command only)
  416.  
  417. [End of MSKERM.HLP]
  418.