*@ KERMIT HELP SYSTEM MESSAGE TEXT MODULE @ *@ ====== ==== ====== ======= ==== ====== @ *CREATE(KMTHELPMTM) *PROC(KMTHELPMTM) *VERSION(101) *PARAMS(EXP&ICL) *LINESPLIT(SPACE) *@ N.B. NIL IS ASSUMED TO HAVE A VALUE OF -1 @ *1 @ text to validate command for which help required @ OR <-1> THEN J20, @ no command specified @ THEN J250, THEN J500, THEN J750, THEN J1000, THEN J1250, THEN J1500, THEN J1750, THEN J2000, THEN J9000 @ not a command, START-OF-PACKET info @ DEFAULT J10 @ invalid command @ ESAC > *10 @ invalid command entry @ is not a VME Kermit command. *20 @ no command specified, display menu @ Help is available for the following VME Kermit commands: (n.b. square brackets enclose optional parameters and should omitted when entering a command.) (1) SERVER : select Kermit Server mode (2) RECEIVE [VME-filename] : prepare to receive file [save as VME-filename] (3) SEND VME-filename [dest-filename] : send file [store as dest-filename] (4) HELP [command] [params] : obtain help [for command or command and parameters] (5) EXIT : exit from VME Kermit (6) SET param value : set Kermit parameter (7) SHOW : show value of all Kermit parameters (8) STATISTICS : display details of last transfer *30 @ Select command prompt @ Select command (Enter 1 to 8 or 0 if no further help required): *40 @ validate response to Select command @ THEN <>, <1> THEN J250, <2> THEN J500, <3> THEN J750, <4> THEN J1000, <5> THEN J1250, <6> THEN J1500, <7> THEN J1750, <8> THEN J2000 DEFAULT J50 ESAC > *50 @ invalid response to Select command prompt @ **** Invalid response, please re-select. *60 @ more help prompt @ Any more help required (YES/NO)? *70 @ validate more help reply @ OR THEN J20, OR THEN <> DEFAULT J60 ESAC > *250 @ SERVER command help @ SERVER command: Syntax: SERVER The SERVER command selects VME Kermit Server mode. All further commands are sent to VME Kermit by the user Kermit (running on your micro). File transfers are initiated via commands given to the micro Kermit. VME Kermit will remain in Server mode until the user Kermit instructs VME Kermit to exit to VME command level (after you have issued a FINISH command to the micro Kermit) or the user Kermit tells VME Kermit to log out (after you have issued a BYE command to the micro Kermit). WARNING: It is inadvisable to select VME Kermit Server mode if your micro Kermit doesn't have the following commands for communicating with servers: GET, BYE and FINISH. If in doubt, consult your documentation. ,J60 ESAC> *500 @ RECEIVE command help @ RECEIVE command: Syntax: RECEIVE [VME-filename] The RECEIVE command prepares VME Kermit for the arrival of a file from the micro Kermit. If a VME filename is specified, the file will be saved with this name. If no filename is specified, a filename will be sent by the micro Kermit and, if possible, the file will be saved with that name. After issuing the RECEIVE command, escape back to the micro Kermit and initiate the file transfer by entering a SEND command. ,J60 ESAC> *750 @ SEND command help @ SEND command: Syntax: SEND VME-filename [destination-filename] The VME file is sent to the micro Kermit. If a destination filename is included, the file will be stored by the micro with this name, otherwise the VME filename will be used. After issuing the SEND command escape back to the micro Kermit and prepare the micro for the arrival of the file by issuing a RECEIVE command. ,J60 ESAC> *1000 @ HELP command help @ HELP command: Syntax: HELP [command] [parameter(s)] The HELP command gives information for the specified command, or allows the user to request information via a menu. If a command is specified, it may be qualified by appending parameter names. ,J60 ESAC> *1250 @ EXIT command help @ EXIT command: Syntax: EXIT The EXIT command terminates the VME Kermit session, closes any logging files and returns the user to VME command level. ,J60 ESAC> *1500 @ SET command help @ OR <-1> THEN J1505, @ no parameter specified @ THEN J1520, THEN J1540, THEN J1560, THEN J1580, THEN J1600, THEN J1620, THEN J1640 DEFAULT J1504 @ invalid parameter @ ESAC > *1501 @ SET command help exit @ ,J1502 ESAC> *1502 @ more help prompt @ Any more help required? Select:- (0) No more help (1) More help for this command (2) More help for another command Enter choice (0 to 2): *1503 @ validate more help response @ THEN <>, <1> THEN J1505, <2> THEN J20 DEFAULT J1502 @ invalid response, reprompt @ ESAC > *1504 @ invalid SET parameter @ **** is not a SET parameter. *1505 @ SET command menu @ SET command: Syntax: SET parameter value The SET command establishes or modifies various parameters for file transfer or logging. The following parameters may be set: (1) DEBUG {FILE/PROTOCOL/PACKET/DEVICE/ALL} {ON/OFF} (2) DELAY seconds (3) PAUSE 10th-seconds (4) RETRY maximum-retries (5) FILE parameter value TYPE {EBCDIC/ASCII/BINARY} NAMING {UNTRANSLATED/NORMAL-FORM} OVERWRITE {ON/OFF} INCOMPLETE {DISCARD/KEEP} (6) SEND parameter value (7) RECEIVE parameter value START-OF-PACKET ctl-char PACKET-LENGTH number TIMEOUT number END-OF-LINE ctl-char PADDING number PAD-CHARACTER ctl-char QUOTE char EIGHTH-BIT-PREFIX char *1506 @ select SET parameter @ For further information enter choice (1 to 7) or 0 if no further information is required: *1507 @ validate selection @ THEN <>, <1> THEN J1520, <2> THEN J1540, <3> THEN J1560, <4> THEN J1580, <5> THEN J1600, <6> THEN J1620, <7> THEN J1640 DEFAULT J1508 @ invalid selection @ ESAC > *1508 @ invalid selection @ **** Invalid response, please re-select. *1520 @ SET DEBUG @ OR <-1> THEN J1525, @ no parameter specified @ THEN J1530, THEN J1531, THEN J1532, THEN J1533, THEN J1534 DEFAULT J1524 @ invalid parameter @ ESAC > *1521 @ SET DEBUG command help exit @ , J1522 ESAC> *1522 @ more help prompt @ Any more help required? Select:- (0) No more help (1) More help for this command (2) More help for another command Enter choice (0 to 2): *1523 @ validate more help response @ THEN <>, <1> THEN J1525, <2> THEN J20 DEFAULT J1522 @ invalid response, reprompt @ ESAC > *1524 @ invalid SET DEBUG parameter @ **** is not a SET DEBUG parameter. *1525 @ SET DEBUG command menu @ SET DEBUG: Syntax: SET DEBUG parameter option Sets the various debugging facilities on or off. The following parameters may be set: (1) FILE {ON/OFF} (2) PROTOCOL {ON/OFF} (3) PACKET {ON/OFF} (4) DEVICE {ON/OFF} (5) ALL {ON/OFF} *1526 @ select SET DEBUG parameter @ For further information enter choice (1 to 5) or 0 if no further information is required: *1527 @ validate selection @ THEN <>, <1> THEN J1530, <2> THEN J1531, <3> THEN J1532, <4> THEN J1533, <5> THEN J1534 DEFAULT J1528 @ invalid selection @ ESAC > *1528 @ invalid selection @ **** Invalid response, please re-select. *1530 @ SET DEBUG FILE @ SET DEBUG FILE: Syntax: SET DEBUG FILE option Turns file record tracing on or off. If option is ON then the contents of all file records read or written will be logged (in hex) to the job journal. The default is OFF. e.g. SET DEBUG FILE ON - turns on file record tracing. *1531 @ SET DEBUG PROTOCOL @ SET DEBUG PROTOCOL: Syntax: SET DEBUG PROTOCOL option Turns protocol state/event tracing on or off. If option is ON then the internal states and events of the protocol handler will be logged to the job journal. The default is OFF. e.g. SET DEBUG PROTOCOL ON - turns on protocol state/event tracing. *1532 @ SET DEBUG PACKET @ SET DEBUG PACKET: Syntax: SET DEBUG PACKET option Turns packet tracing on or off. If option is ON then the contents of all packets sent and received will be logged to the job journal. The default is OFF. e.g. SET DEBUG PACKET ON - turns on packet tracing. *1533 @ SET DEBUG DEVICE @ SET DEBUG DEVICE: Syntax: SET DEBUG DEVICE option Turns device tracing on or off. If option is ON then all the data sent and received over the terminal link will be logged (in hex) to the job journal. The default is OFF. e.g. SET DEBUG DEVICE ON - turns on device tracing. *1534 @ SET DEBUG ALL @ SET DEBUG ALL: Syntax: SET DEBUG ALL option Turns all tracing on or off. If option is ON then the contents of all file records read or written, the internal states and events of the protocol handler, the contents of all packets sent and received and all the data sent and received over the terminal link will be logged to the job journal. The default is OFF. e.g. SET DEBUG ALL ON - turns on all tracing. *1540 @ SET DELAY @ SET DELAY: Syntax: SET DELAY seconds Sets the length of delay before transmitting the first packet after a SEND command has been issued. The default delay is 30 seconds. The minimum delay that can be set is 5 seconds and the maximum is 300 seconds. Seconds may be expressed as a decimal value (e.g. 9) or as a hexadecimal value (e.g. X09). e.g. SET DELAY 15 - sets the delay period to 15 seconds. *1560 @ SET PAUSE @ SET PAUSE: Syntax: SET PAUSE 10ths-second Sets the length of time to pause between receiving a packet from the remote system and transmitting the next packet to it. The default pause is 0 tenths of a second. The maximum pause that can be set is 50 tenths of a second. 10ths-second may be expressed as a decimal value (e.g. 9) or as a hexadecimal value (e.g. X09). e.g. SET PAUSE 10 - sets the pause period to 10 tenths of a second. *1580 @ SET RETRY @ SET RETRY: Syntax: SET RETRY number Sets the maximum number of times to attempt to send or receive a packet before abandoning the transfer. The default retry is 4. The maximum retry that can be set is 10. Number may be expressed as a decimal value (e.g. 4) or as a hexadecimal value (e.g. X04). e.g. SET RETRY 8 - sets the retry limit to 8 retries. *1600 @ SET FILE @ OR <-1> THEN J1605, @ no parameter specified @ THEN J1610, THEN J1611, THEN J1612, THEN J1613 DEFAULT J1604 @ invalid parameter @ ESAC > *1601 @ SET FILE command help exit @ , J1602 ESAC> *1602 @ more help prompt @ Any more help required? Select:- (0) No more help (1) More help for this command (2) More help for another command Enter choice (0 to 2): *1603 @ validate more help response @ THEN <>, <1> THEN J1605, <2> THEN J20 DEFAULT J1602 @ invalid response, reprompt @ ESAC > *1604 @ invalid SET FILE parameter @ **** is not a SET FILE parameter. *1605 @ SET FILE command menu @ SET FILE: Syntax: SET FILE parameter option Sets the various file attributes. The following parameters may be set: (1) TYPE {EBCDIC/ASCII/BINARY} (2) NAMING {UNTRANSLATED/NORMAL-FORM} (3) OVERWRITE {ON/OFF} (4) INCOMPLETE {DISCARD/KEEP} *1606 @ select SET FILE parameter @ For further information enter choice (1 to 4) or 0 if no further information is required: *1607 @ validate selection @ THEN <>, <1> THEN J1610, <2> THEN J1611, <3> THEN J1612, <4> THEN J1613 DEFAULT J1608 @ invalid selection @ ESAC > *1608 @ invalid selection @ **** Invalid response, please re-select. *1610 @ SET FILE TYPE @ SET FILE TYPE: Syntax: SET FILE TYPE option Defines the type of file to be sent, or received. option may be one of: EBCDIC meaning that the VME file contains, or is to contain EBCDIC text and data conversion between EBCDIC and ASCII is required. ASCII meaning that the VME file contains, or is to contain ASCII text and no data conversion is required. BINARY meaning that the VME file contains, of is to contain binary data and no data conversion is required. Note in this case the record boundaries of the VME file are not significant to KERMIT. The default is EBCDIC. e.g. SET FILE TYPE BINARY - sets file transfer is to be binary. *1611 @ SET FILE NAMING @ SET FILE NAMING: Syntax: SET FILE NAMING option Defines how file names are to represented/interpretted. If option is NORMAL-FORM then the VME and remote file names will be normalised. If option is UNTRANSLATED then no file name normalisation will take place. The default is NORMAL-FORM. e.g. SET FILE NAMING UNTRANSLATED - turns off file name normalisation. *1612 @ SET FILE OVERWRITE @ SET FILE OVERWRITE: Syntax: SET FILE OVERWRITE option Defines the action to be taken when receiving a file and a VME file of the same name and generation number already exists. If option is ON then the file will be overwritten. If option is OFF then the file transfer will abandoned. The default is OFF. e.g. SET FILE OVERWRITE ON - incoming file will be overwritten if it already exists. *1613 @ SET FILE INCOMPLETE @ SET FILE INCOMPLETE: Syntax: SET FILE INCOMPLETE option Defines the action to be taken when receiving a file and the file transfer is abandoned. If option is KEEP then the VME file will be saved. If option is DISCARD then the VME file will not be saved. e.g. SET FILE INCOMPLETE KEEP - file to be saved if transfer abandoned. *1620 @ SET SEND @ *1640 @ SET RECEIVE @ *1650 @ SET SEND/RECEIVE @ OR <-1> THEN J1655, @ no parameter specified @ THEN J1660, THEN J1661, THEN J1662, THEN J1663, THEN J1664, THEN J1665, THEN J1666, THEN J1667 DEFAULT J1654 @ invalid parameter @ ESAC > *1651 @ SET SEND/RECEIVE command help exit @ , J1652 ESAC> *1652 @ more help prompt @ Any more help required? Select:- (0) No more help (1) More help for this command (2) More help for another command Enter choice (0 to 2): *1653 @ validate more help response @ THEN <>, <1> THEN J1655, <2> THEN J20 DEFAULT J1652 @ invalid response, reprompt @ ESAC > *1654 @ invalid SET SEND/RECEIVE parameter @ **** is not a SET SEND/RECEIVE parameter. *1655 @ SET SEND/RECEIVE command menu @ SET SEND/RECEIVE: Syntax: SET {SEND/RECEIVE} parameter option Sets the various configuration parameters to allow the tailoring of dissimilar systems to accomodate the peculiarities of the communication path. Note a number of the configuration parameters may be modified during the exchange of S or I packets and the acknowledgements to those packets. The following parameters may be set: (1) START-OF-PACKET ctl_char (2) PACKET-LENGTH number (3) TIMEOUT seconds (4) END-OF-LINE ctl-char (5) PADDING number (6) PAD-CHARACTER ctl-char (7) QUOTE char (8) EIGHTH-BIT-PREFIX char *1656 @ select SET SEND/RECEIVE parameter @ For further information enter choice (1 to 8) or 0 if no further information is required: *1657 @ validate selection @ THEN <>, <1> THEN J1660, <2> THEN J1661, <3> THEN J1662, <4> THEN J1663, <5> THEN J1664, <6> THEN J1665, <7> THEN J1666, <8> THEN J1667 DEFAULT J1658 @ invalid selection @ ESAC > *1658 @ invalid selection @ **** Invalid response, please re-select. *1660 @ SET SEND/RECEIVE START-OF-PACKET @ SET SEND/RECEIVE START-OF-PACKET: Syntax: SET {SEND/RECEIVE} START-OF-PACKET ctl-char Sets the ASCII control character to be used as the start-of-packet marker. The default is Record Separator (decimal 30, hex 1E). 'Ctl-char' may be expressed as a decimal value (e.g. 30) or as a hexadecimal value (e.g. X1E). Note a number of control characters are not accepted by VME as valid start-of-packet markers. e.g. SET SEND START-OF-PACKET X1F - sets the start-of-packet marker for output packets to Unit Separator. *1661 @ SET SEND/RECEIVE PACKET-LENGTH @ SET SEND/RECEIVE PACKET-LENGTH: Syntax: SET {SEND/RECEIVE} PACKET-LENGTH number Sets the maximum length for a packet. The maximum packet-length plus the padding (if any) must not exceed the limits of the VME terminal description (normally 80 for output and 128 for input). The default packet-length is 80 characters. The minimum packet-length that can be set is 30 characters and the maximum is defined by the terminal description (normally 80 for output and 94 for input). 'Number' may be expressed as a decimal value (e.g. 80) or as a hexadecimal value (e.g. X50). e.g. SET RECEIVE PACKET-LENGTH 72 - sets the maximum packet-length of input packets to 72 characters. *1662 @ SET SEND/RECEIVE TIMEOUT @ SET SEND/RECEIVE TIMEOUT: Syntax: SET {SEND/RECEIVE} TIMEOUT seconds Sets the length of time to wait for a packet to arrive. The default is 0 seconds i.e. indefinite wait. The maximum timeout that can be set is 94 seconds. 'Seconds' may be expressed as a decimal value (e.g. 20) or as a hexadecimal value (e.g. X14). e.g. SET RECEIVE TIMEOUT 20 - sets the timeout value for input packets to 20 seconds. *1663 @ SET SEND/RECEIVE END-OF-LINE @ SET SEND/RECEIVE END-OF-LINE: Syntax: SET {SEND/RECEIVE} END-OF-LINE ctl-char Sets the ASCII control character to be used as the end of packet terminator. The default is Carriage Return (decimal 13, hex 0D). 'Ctl-char' may be expressed as a decimal value (e.g. 13) or as a hexadecimal value (e.g. X0D). Note a number of control characters are not accepted by VME as valid end-of-line terminators. e.g. SET RECEIVE END-OF-LINE X09 - sets the input packet end-of-line terminator to Tab. *1664 @ SET SEND/RECEIVE PADDING @ SET SEND/RECEIVE PADDING: Syntax: SET {SEND/RECEIVE} PADDING number Sets the number of padding characters to be sent before each packet. The padding plus the maximum packet length must not exceed the limits of the VME terminal description (normally 80 for output and 128 for input). The default padding is 0 characters i.e. no padding. The maximum padding that can be set is defined by the VME terminal description. e.g. SET SEND PADDING 4 - sets the padding for output packets to 4 pad characters. *1665 @ SET SEND/RECEIVE PAD-CHARACTER @ SET SEND/RECEIVE PAD-CHARACTER: Syntax: SET {SEND/RECEIVE} PAD-CHARACTER ctl-char Sets the ASCII control character to be used as a pad character to be sent before each packet. The default is Null (decimal 0, hex 00). 'Ctl-char' may be expressed as a decimal value (e.g. 0) or as a hexadecimal value (e.g X00). Note a number of the control characters are not accepted by VME as valid pad characters. e.g. SET SEND PAD-CHARACTER 7 - sets the output packet pad character to Bell. *1666 @ SET SEND/RECEIVE QUOTE @ SET SEND/RECEIVE QUOTE: Syntax: SET {SEND/RECEIVE} QUOTE char Sets the printable ASCII character to be used for control character prefixing. It may be any printable character but it must be different from the eighth-bit-prefix character. The default value is Hash (#) (decimal 35, hex 23). 'Char' may be expressed as an ASCII character (e.g. #), as a decimal value (e.g. 35) or as a hexadecimal value (e.g. X23). e.g. SET SEND QUOTE ? - sets the output packet quote character to question mark. *1667 @ SET SEND/RECEIVE EIGHTH-BIT-PREFIX @ SET SEND/RECEIVE EIGHTH-BIT-PREFIX: Syntax: SET {SEND/RECEIVE} EIGHTH-BIT-PREFIX char Sets the printable ASCII character to be used for eighth bit prefixing. It may be any printable character in the range ASCII 32 to 62 or ASCII 96 TO 126 but it must be different from the control character prefix. The default value is Ampersand (&) (decimal 38, hex 26). 'Char' may be expressed as an ASCII character (e.g. &), as a decimal value (e.g. 38) or as a hexadecimal value (e.g. X26). e.g. SET SEND EIGHTH-BIT-PREFIX ! - sets the output packet eighth-bit-prefix character to exclamation mark. *1750 @ SHOW command help @ SHOW command: Syntax: SHOW Displays the current values of SET parameters, capabilities etc. ,J60 ESAC> *2000 @ STATISTICS command help @ STATISTICS command: Syntax: STATISTICS Displays statistical information about the most recent file transfer. ,J60 ESAC> *9000 @ START-OF-PACKET info @ VME I/0 cannot handle the standard Kermit START-OF-PACKET character Hex 01 (decimal 1) so initially the VME Kermit START-OF-PACKET character is set to Hex 1E (decimal 30). For a Kermit file transfer to work, the START-OF-PACKET character on the micro Kermit must be set to correspond to the VME Kermit START-OF-PACKET character. Consult the documentation for the micro Kermit to find out how to change the START-OF-PACKET character on the micro. If the VME Kermit START-OF-PACKET character isn't suitable for the micro Kermit then the START-OF-PACKET character should be altered on BOTH Kermits. Appendix 2 of the VME KERMIT User Guide lists the characters that VME I/O can handle. To change the START-OF-PACKET character on VME Kermit use the commands SET RECEIVE START-OF-PACKET and SET SEND START-OF-PACKET. HELP is available for these commands. If you attempt to alter the START-OF-PACKET character to an unacceptable character you will be notified. *END