home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / hp3000 / hp3000doc.txt < prev    next >
Text File  |  2020-01-01  |  19KB  |  645 lines
  1.                            HP 3000 KERMIT  Version 1.0
  2.  
  3. 1.0 Introduction
  4. ----------------
  5.  
  6. This version of KERMIT was written in SPL specifically for the HP 3000.
  7. Its most notable feature is that it allows great flexibility in the
  8. way that received files are stored on the 3000.
  9.  
  10. Virtually all development work on this version was done on an HP 3000
  11. Series III.  Since the Series III is not capable of 8 bit character
  12. transmission, true "binary" file transfers must be done with 8 bit quoting.
  13.  
  14. The newer (HPIB) models in the HP 3000 Series are supposed to handle 8
  15. bit characters, so a subsequent release will address this and other issues.
  16. It does work on the newer processors, but does not attempt to use 8 bit
  17. characters.
  18.  
  19. 2.0 HP 3000 File System
  20. -----------------------
  21.  
  22. On the 3000, a disc file is divided into records.  They may be fixed or
  23. variable length, ASCII or binary.  If a less than a "full" record is written to
  24. a file with fixed length records, it will be padded with blanks (if ASCII) or
  25. binary zeros (if binary).
  26.  
  27. 2.1 Text Files
  28. --------------
  29.  
  30. Each record of a text file corresponds to a "line" of printed output.
  31. If a file contains variable length records, the file system "knows" how
  32. long each record is. Carriage return and/or linefeed are NOT generally stored
  33. in text files.
  34.  
  35. When transferring a text file to the 3000 via KERMIT, carriage returns are
  36. ignored and linefeed is assumed to be the record terminator.
  37. If a linefeed is not encountered before the maximum record size is reached,
  38. the remainder of the record is continued on the next line.  This can be
  39. of use when sending "word processor generated" documents to the HP (the CR/LF
  40. sequence may be omitted, except at the end of a paragraph).
  41.  
  42. A CR/LF sequence is appended to each record of a text file when it is
  43. transmitted from the 3000.
  44.  
  45. 2.2 Binary Files
  46. ----------------
  47.  
  48. Binary files are usually stored in 256 byte, fixed-length records.
  49. The concept of a "record" may not be meaningful, this is just the most
  50. efficient way (disc storage wise) to store the file.
  51.  
  52. This KERMIT regards binary files as a stream of 8 bit bytes.  When receiving
  53. a binary file, all records are "filled" except (possibly) the last one.
  54. Remember that the HP file system will pad this record with binary zeros
  55. unless the file is defined as having variable length records.
  56.  
  57. Another "feature" of the file system is that it assumes all binary files
  58. are made up of 16 bit words.  An odd number of bytes for the record length
  59. of a file will be rounded up.  Likewise, an odd number of bytes written
  60. as a record will have a binary zero appended REGARDLESS of variable length
  61. record structure.
  62.  
  63. 3.0 Program Operation
  64. ---------------------
  65.  
  66. HP 3000 KERMIT, like other HP programs, is invoked via the RUN command.
  67. If an INFO parameter is specified, this is interpreted as the initial command.
  68. For example, to start KERMIT in SERVER mode:
  69.  
  70.                   RUN KERMIT;INFO="SERVE"
  71.  
  72. Subsequent KERMIT commands are read from the job or session input stream.
  73. KERMIT may be initiated from a batch job, but the communications line
  74. must be specified explicitly via the SET command.
  75.  
  76. 4.0 Commands
  77. ------------
  78.  
  79. 4.1 TAKE Command
  80. --------------------
  81.  
  82. Syntax:  TAKE  filespec
  83.  
  84. The TAKE command causes subsequent commands to be taken from the specified
  85. file until EOF is reached.  If a subsequent TAKE is encountered within the
  86. original TAKE file, the first file is closed and execution continues with the
  87. second.  This means that if a TAKE appears within a TAKE file, commands
  88. that follow it (in the original take file) will be ignored.
  89.  
  90. 4.2 SERVER Command
  91. -----------------
  92.  
  93. Syntax:  SERVER
  94.  
  95. The SERVER command causes HP 3000 KERMIT to go into server mode.  Once in server
  96. mode, the only way back to command mode is the Control-Y trap.
  97.  
  98. In addition to the standard KERMIT transactions for file transfer, the
  99. following server functions are supported:
  100.  
  101.    Function            Probable Syntax (if available on local KERMIT)
  102.    -------------       ----------------------------------------------
  103.  
  104.    Finish Processing   FINISH
  105.    Type a file         REMOTE TYPE filespec
  106.    Directory Listing   REMOTE DIRECTORY [filespec]
  107.    File Space Listing  REMOTE SPACE [filespec]
  108.    Delete a file       REMOTE DELETE filespec
  109.  
  110. Wildcard file specification may be used only for the DIRECTORY and SPACE
  111. transactions.  Wildcard specifications are in the native HP 3000 format.
  112. To produce a DIRECTORY listing of all files starting with "FOO" use:
  113.  
  114.            REMOTE DIRECTORY FOO@
  115.  
  116. 4.3 SEND Command
  117. ----------------
  118.  
  119. Syntax:  SEND filespec1 [filespec2]
  120.  
  121. This command causes a file (indicated by filespec1) to be sent from the HP to
  122. the local KERMIT. Wildcard characters are not permitted.  If filespec2 is
  123. specified, the file will be sent with that name.
  124.  
  125.  
  126. 4.4 RECEIVE Command
  127. -------------------
  128.  
  129. Syntax:  RECEIVE [filespec]
  130.  
  131. The RECEIVE command causes HP KERMIT to enter receive mode and wait for the
  132. local kermit to start sending a file.  If filespec is specified, the file will
  133. be stored under that name.
  134.  
  135. 4.5 CONNECT Command
  136. -------------------
  137.  
  138. Syntax:  CONNECT
  139.  
  140. The CONNECT command causes HP KERMIT to enter a very primitive connect mode. 
  141. The HP is a half duplex machine.  Consequently, the kermit must read the 
  142. console, echo the console, read the line, and write the console in 80 byte
  143. blocks.  One must use the 'delay' parameter to force a timeout at the 
  144. appropriate time of the console read.  The escape character is checked after
  145. the console write of the line read.  The escape characters are ^ (control)
  146. ] (back bracket) C (capital C).
  147.  
  148. 4.6 SET Command
  149. ---------------
  150.  
  151. Syntax:  SET parameter-1 [parameter-2] ... [parameter-n]
  152.  
  153. This command is used to alter the many default parameters for HP KERMIT
  154. operation.
  155.  
  156. 4.6.1 DEBUG Parameter
  157. ---------------------
  158.  
  159. Syntax:  SET DEBUG number
  160.  
  161. This sets the debug level to the indicated number.  Currently, only one level
  162. exists.  This level is enabled by setting the number to any non-negative,
  163. non-zero number.  If DEBUG is enabled, packets sent and received are written
  164. to the LOG file.  The LOG file defaults to the job/session output file.  LOG
  165. output to the job/session output file is disabled when communications are
  166. taking place unless the communications line has been re-designated via the
  167. SET LINE command.
  168.  
  169. 4.6.2 LOG Parameter
  170. -------------------
  171.  
  172. Syntax:  SET LOG filespec
  173.  
  174. This command sets the LOG file to the indicated filespec.  Error and DEBUG
  175. messages (if enabled) are written to the LOG file (see SET DEBUG).
  176.  
  177. 4.6.3 HANDSHAKE Parameter
  178. -------------------------
  179.  
  180. Syntax: SET HANDSHAKE option
  181.  
  182. This specifies any handshaking that is to be done on the communications line.
  183. Options are:
  184.  
  185.      XON    Generate an XON character prior to each read.  This is the default
  186.             mode and is needed in most cases since the HP will "lose" any
  187.             characters that are transmitted when no read is active.  The local
  188.             KERMIT must be capable of waiting for an XON character before
  189.             issuing a write to the communications line.
  190.  
  191.      NONE   Generate no special characters prior to a read.
  192.  
  193.      XON2   Same as XON except in both directions.  This sets the read
  194.             termination character to XON in an attempt to synchronize
  195.             with another KERMIT having similar limitations.
  196.  
  197. 4.6.4 LINE Parameter
  198. --------------------
  199.  
  200. Syntax:  SET LINE ldev
  201.  
  202. This causes the indicated ldev (logical device number) to be used for
  203. communications purposes.
  204.  
  205. 4.6.5 SPEED Parameter
  206. ---------------------
  207.  
  208. Syntax:  SET SPEED speed
  209.  
  210. Sets the communications speed to the indicated number of characters per
  211. second.  Supported speeds are: 30, 60, 120, 240, 480, 960.
  212.  
  213. 4.6.6 DELAY Parameter
  214. ---------------------
  215.  
  216. Syntax:  SET DELAY number
  217.  
  218. Causes a pause for the indicated number of seconds prior to starting a
  219. SEND command.  This is to allow the user to escape back to the local KERMIT
  220. and enter a RECEIVE command.
  221.  
  222. 4.6.7 SEND Parameter
  223. --------------------
  224.  
  225. This parameter is used to alter the default conditions relating to how files
  226. are sent.
  227.  
  228. 4.6.7.1 PAUSE Parameter
  229. -----------------------
  230.  
  231. Syntax:  SET SEND PAUSE number
  232.  
  233. This causes a pause of number/10 seconds prior to packet transmission.
  234. A pause of this nature is needed when communicating with a KERMIT that
  235. has trouble "turning the line around".
  236.  
  237. 4.6.7.2 BINARY Parameter
  238. ------------------------
  239.  
  240. Syntax:  SET SEND BINARY option
  241.  
  242. Defines the mode (ASCII or binary) in which to transmit files.
  243. Options are:
  244.  
  245.      ON    Send all files as binary.
  246.  
  247.      OFF   Send all files as ASCII.
  248.  
  249.      AUTO  Look at how the file is defined on the HP and transmit it
  250.            accordingly.  This is the default mode.
  251.  
  252. 4.6.8 RECEIVE Parameter
  253. -----------------------
  254.  
  255. This parameter is used to alter the default conditions regarding file
  256. reception.
  257.  
  258. 4.6.8.1 BINARY Parameter
  259. ------------------------
  260.  
  261. Syntax:  SET RECEIVE BINARY option
  262.  
  263. Tells how to store received files on the 3000.  Options are:
  264.  
  265.      ON   Store files as binary.
  266.  
  267.      OFF  Store files as ASCII.
  268.  
  269. 4.6.8.2 DEVICE Parameter
  270. ------------------------
  271.  
  272. Syntax:  SET RECEIVE DEVICE [dev]
  273.  
  274. Specifies the device class for received files.  Default is DISC.
  275. This command can be used to send files directly to the system line printer:
  276.  
  277.               SET RECEIVE DEVICE LP
  278.  
  279. 4.6.8.3 FCODE Parameter
  280. ----------------------
  281.  
  282. Syntax:  SET RECEIVE FCODE n
  283.  
  284. Specifies the file code for received files.
  285.  
  286. 4.6.8.4 RECLEN Parameter
  287. ------------------------
  288.  
  289. Syntax:  SET RECEIVE RECLEN [-]n
  290.  
  291. Specifies the maximum record length (n) for a received file.  As with other
  292. HP file system commands, n is assumed to be words if positive and bytes if
  293. negative.
  294.  
  295. 4.6.8.5 BLOCKF Parameter
  296. ------------------------
  297.  
  298. Syntax:  SET RECEIVE BLOCKF n
  299.  
  300. Specifies the blocking factor for received files.  If n is 0, the file system
  301. will calculate a blocking factor automatically.
  302.  
  303. 4.6.8.6 FIXREC Parameter
  304. ------------------------
  305.  
  306. Syntax:  SET RECEIVE FIXREC option
  307.  
  308. This parameter is used to identify fixed or variable length records.  Options
  309. are:
  310.  
  311.      ON   Use fixed length records.
  312.  
  313.      OFF  Use variable length records.
  314.  
  315. 4.6.8.8 MAXREC Parameter
  316. ------------------------
  317.  
  318. Syntax:  SET RECEIVE MAXREC n
  319.  
  320. Specifies the maximum number of records that can be stored in a received
  321. file.
  322.  
  323. 4.6.8.9 MAXEXT Parameter
  324. ------------------------
  325.  
  326. Syntax:  SET RECEIVE MAXEXT n
  327.  
  328. Specifies the maximum number of extents for a received file.  This number (n)
  329. must be in the range 1 ... 32.
  330.  
  331. 4.6.8.10 SAVESP Parameter
  332. -------------------------
  333.  
  334. Syntax: SET RECEIVE SAVESP option
  335.  
  336. This parameter specifies if unused file space at the end of the file is to
  337. be returned to the operating system.  Options are:
  338.  
  339.      ON   Return unused space.
  340.  
  341.      OFF  Do not return unused space.
  342.  
  343. 4.6.8.11 PROG Parameter
  344. -----------------------
  345.  
  346. Syntax:  SET RECEIVE PROG
  347.  
  348. This parameter can be specified to set all of the other parameters needed
  349. to receive an HP 3000 program (executable) file.  It is equivalent to:
  350.  
  351.      SET RECEIVE BINARY ON
  352.      SET RECEIVE FIXREC ON
  353.      SET RECEIVE FCODE  1029
  354.      SET RECEIVE RECLEN 128
  355.      SET RECEIVE BLOCKF 1
  356.  
  357. 4.6.8.12 BIN128 Parameter
  358. -------------------------
  359.  
  360. Syntax:  SET RECEIVE BIN128
  361.  
  362. This sets up the needed parameters for receiving a binary file in the
  363. "normal" HP representation.  It is equivalent to:
  364.  
  365.      SET RECEIVE BINARY ON
  366.      SET RECEIVE FIXREC OFF
  367.      SET RECEIVE FCODE  0
  368.      SET RECEIVE RECLEN 128
  369.      SET RECEIVE BLOCKF 0
  370.  
  371. 4.6.8.13 TEXT Parameter
  372. -----------------------
  373.  
  374. Syntax:  SET RECEIVE TEXT
  375.  
  376. This sets up the needed parameters for receiving "generic" text files.
  377. It is equivalent to:
  378.  
  379.      SET RECEIVE BINARY OFF
  380.      SET RECEIVE FIXREC OFF
  381.      SET RECEIVE FCODE  0
  382.      SET RECEIVE RECLEN -254
  383.      SET RECEIVE BLOCKF 0
  384.  
  385. 4.6.8.14 TXT80 Parameter
  386. ------------------------
  387.  
  388. Syntax:  SET RECEIVE TXT80
  389.  
  390. This sets up the needed parameters for receiving 80 character text files
  391. in the manner that is most convenient for the typical text editor on the
  392. HP.  It is equivalent to:
  393.  
  394.      SET RECEIVE BINARY OFF
  395.      SET RECEIVE FIXREC ON
  396.      SET RECEIVE FCODE  0
  397.      SET RECEIVE RECLEN -80
  398.      SET RECEIVE BLOCKF 16
  399.  
  400. 4.7 EXIT Command
  401. ----------------
  402.  
  403. Syntax:  EXIT
  404.  
  405. This command causes the HP KERMIT process to terminate in an orderly
  406. manner.
  407.  
  408. 4.8 HELP Command
  409. ________________
  410.  
  411. This gives a list of commands available to the command mode.
  412.  
  413. 4.9 SHOW Command
  414. ---------------
  415.  
  416. Syntax:  SHOW parameter
  417.  
  418. This command is used to show the many default parameters for HP KERMIT
  419. operation. A SHOW ALL will show all parameters.
  420.  
  421. 4.9.1 DEBUG Parameter
  422. ---------------------
  423.  
  424. Syntax:  SHOW DEBUG number
  425.  
  426. This shows the debug number.  Currently, only one level
  427. exists.  This level is enabled by setting the number to any non-negative,
  428. non-zero number.  If DEBUG is enabled, packets sent and received are written
  429. to the LOG file.  The LOG file defaults to the job/session output file.  LOG
  430. output to the job/session output file is disabled when communications are
  431. taking place unless the communications line has been re-designated via the
  432. SET LINE command.
  433.  
  434. 4.9.2 LOG Parameter
  435. -------------------
  436.  
  437. Syntax:  SHOW LOG filespec
  438.  
  439. This command shows the LOG file to the indicated filespec.  Error and DEBUG
  440. messages (if enabled) are written to the LOG file (see SHOW DEBUG).
  441.  
  442. 4.9.3 HANDSHAKE Parameter
  443. -------------------------
  444.  
  445. Syntax: SHOW HANDSHAKE option
  446.  
  447. This shows any handshaking that is to be done on the communications line.
  448. Options are:
  449.  
  450.      XON    Generate an XON character prior to each read.  This is the default
  451.             mode and is needed in most cases since the HP will "lose" any
  452.             characters that are transmitted when no read is active.  The local
  453.             KERMIT must be capable of waiting for an XON character before
  454.             issuing a write to the communications line.
  455.  
  456.      NONE   Generate no special characters prior to a read.
  457.  
  458.      XON2   Same as XON except in both directions.  This sets the read
  459.             termination character to XON in an attempt to synchronize
  460.             with another KERMIT having similar limitations.
  461.  
  462. 4.9.4 LINE Parameter
  463. --------------------
  464.  
  465. Syntax:  SHOW LINE ldev
  466.  
  467. This shows the ldev (logical device number) to be used for
  468. communications purposes.
  469.  
  470. 4.9.5 SPEED Parameter
  471. ---------------------
  472.  
  473. Syntax:  SHOW SPEED speed
  474.  
  475. Shows the communications speed to the indicated number of characters per
  476. second.  Supported speeds are: 30, 60, 120, 240, 480, 960.
  477.  
  478. 4.9.6 DELAY Parameter
  479. ---------------------
  480.  
  481. Syntax:  SHOW DELAY number
  482.  
  483. Causes a pause for the shown number of seconds prior to starting a
  484. SEND command.  This is to allow the user to escape back to the local KERMIT
  485. and enter a RECEIVE command.
  486.  
  487. 4.9.7 SEND Parameter
  488. --------------------
  489.  
  490. This parameter is used to alter the default conditions relating to how files
  491. are sent.
  492.  
  493. 4.9.7.1 PAUSE Parameter
  494. -----------------------
  495.  
  496. Syntax:  SHOW SEND PAUSE number
  497.  
  498. This shows a pause of number/10 seconds prior to packet transmission.
  499. A pause of this nature is needed when communicating with a KERMIT that
  500. has trouble "turning the line around".
  501.  
  502. 4.9.7.2 BINARY Parameter
  503. ------------------------
  504.  
  505. Syntax:  SHOW SEND BINARY option
  506.  
  507. Shows the mode (ASCII or binary) in which to transmit files.
  508. Options are:
  509.  
  510.      ON    Send all files as binary.
  511.  
  512.      OFF   Send all files as ASCII.
  513.  
  514.      AUTO  Look at how the file is defined on the HP and transmit it
  515.            accordingly.  This is the default mode.
  516.  
  517. 4.9.8 RECEIVE Parameter
  518. -----------------------
  519.  
  520. This parameter is used to alter the default conditions regarding file
  521. reception.
  522.  
  523. 4.9.8.1 BINARY Parameter
  524. ------------------------
  525.  
  526. Syntax:  SHOW RECEIVE BINARY option
  527.  
  528. Shows how to store received files on the 3000.  Options are:
  529.  
  530.      ON   Store files as binary.
  531.  
  532.      OFF  Store files as ASCII.
  533.  
  534. 4.9.8.2 DEVICE Parameter
  535. ------------------------
  536.  
  537. Syntax:  SHOW RECEIVE DEVICE [dev]
  538.  
  539. Shows the device class for received files.  Default is DISC.
  540. This command can be used to send files directly to the system line printer:
  541.  
  542.               SHOW RECEIVE DEVICE LP
  543.  
  544. 4.9.8.3 FCODE Parameter
  545. ----------------------
  546.  
  547. Syntax:  SHOW RECEIVE FCODE n
  548.  
  549. Shows the file code for received files.
  550.  
  551. 4.9.8.4 RECLEN Parameter
  552. ------------------------
  553.  
  554. Syntax:  SHOW RECEIVE RECLEN [-]n
  555.  
  556. Shows the maximum record length (n) for a received file.  As with other
  557. HP file system commands, n is assumed to be words if positive and bytes if
  558. negative.
  559.  
  560. 4.9.8.5 BLOCKF Parameter
  561. ------------------------
  562.  
  563. Syntax:  SHOW RECEIVE BLOCKF n
  564.  
  565. Shows the blocking factor for received files.  If n is 0, the file system
  566. will calculate a blocking factor automatically.
  567.  
  568. 4.9.8.6 FIXREC Parameter
  569. ------------------------
  570.  
  571. Syntax:  SHOW RECEIVE FIXREC option
  572.  
  573. This parameter is shown to identify fixed or variable length records.  Options
  574. are:
  575.  
  576.      ON   Use fixed length records.
  577.  
  578.      OFF  Use variable length records.
  579.  
  580. 4.9.8.8 MAXREC Parameter
  581. ------------------------
  582.  
  583. Syntax:  SHOW RECEIVE MAXREC n
  584.  
  585. Shows the maximum number of records that can be stored in a received
  586. file.
  587.  
  588. 4.9.8.9 MAXEXT Parameter
  589. ------------------------
  590.  
  591. Syntax:  SHOW RECEIVE MAXEXT n
  592.  
  593. Shows the maximum number of extents for a received file.  This number (n)
  594. must be in the range 1 ... 32.
  595.  
  596. 4.9.8.10 SAVESP Parameter
  597. -------------------------
  598.  
  599. Syntax: SHOW RECEIVE SAVESP option
  600.  
  601. This parameter shows if unused file space at the end of the file is to
  602. be returned to the operating system.  Options are:
  603.  
  604.      ON   Return unused space.
  605.  
  606.      OFF  Do not return unused space.
  607.  
  608. 5.0 SHOW ALL
  609. ____________
  610.  
  611. Syntax: SHOW ALL
  612.  
  613. Shows all the parameters.
  614.  
  615. 5.1 FINISH
  616. __________
  617.  
  618. Syntax: FINISH
  619.  
  620. Used in a TAKE file or CONNECT mode to finish a server on the remote
  621. machine.
  622.  
  623. 6.0 Initial State of Parameters
  624. -------------------------------
  625.  
  626. When HP KERMIT is started, parameters are set as follows:
  627.  
  628.      Debug:            0 (No DEBUG Messages)
  629.      Log:              None
  630.      Handshake:        XON
  631.      Line:             Session output device
  632.      Speed:            Current Speed of Session Device
  633.      Delay:            10 Seconds
  634.      Send Pause:       None
  635.      Send Binary:      Auto
  636.      Receive Binary:   Off
  637.      Receive Device:   DISC
  638.      Receive Fcode:    0
  639.      Receive Reclen:   -80
  640.      Receive Blockf:   0
  641.      Receive Fixrec:   On
  642.      Receive Maxrec:   5000
  643.      Receive Maxext:   32
  644.      Receive Savesp:   On
  645.