home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / archives / cdccompass.tar.gz / cdccompass.tar / cybkerhlp.txt < prev   
Text File  |  1988-08-16  |  10KB  |  354 lines
  1. .PROC,KERHELP.
  2.   $REPLACE(ZZZKHLP)
  3. $REVERT(NOLIST)
  4. .DATA,ZZZKHLP.
  5.  
  6.  SET File-type Ascii
  7.  
  8. ASCII  files  are  files of text.   The
  9. ASCII character set is an international
  10. standard  consisting  of  95  printable
  11. characters  (including  a  blank space)
  12. and  33  other  'characters'.   You can
  13. create an  ASCII  file on the Cyber  by
  14. using one of the Cyber editors,  FSE or
  15. XEDIT,  or by giving the  TEXT  command
  16. when your terminal is in ASCII mode.
  17.  
  18. .EOR
  19.  
  20.  SET File-type Binary
  21.  
  22. BINARY  files contain information,  but
  23. this data is not in the form  of  text;
  24. it is stored as a sequence of yes-or-no
  25. BITS of data.   Kermit reads and writes
  26. BINARY files bit by bit.   When writing
  27. a  BINARY  file,  Kermit  may add extra
  28. bits to the end of the file to fill out
  29. the last word.   If you have  a  binary
  30. file  (not a text file)  which you wish
  31. to transfer from one micro  to  another
  32. via  the  Cyber,  you  may  want  Cyber
  33. Kermit  to  receive  and  send  it as a
  34. KERMIT file.
  35.  
  36. .EOR
  37.  
  38.  SET File-type Kermit
  39.  
  40. A  KERMIT  file  is  a  special kind of
  41. binary file.   You  should  not  use  a
  42. KERMIT file to store text.   You should
  43. use  a  KERMIT  file only if you do NOT
  44. wish to use your file on the  Cyber  or
  45. on  the  Amdahl.   The  advantage  of a
  46. KERMIT  file is that Cyber Kermit  does
  47. not  append data to the file to make it
  48. conform to the Cyber's large  wordsize.
  49. KERMIT  files  make sense only to Cyber
  50. Kermit;  they are useless for any other
  51. purpose.
  52.  
  53. .EOR
  54.  
  55.  SET File-type Display
  56.  
  57. DISPLAY  code  files are files of text.
  58. Almost  all  compilers  on  the   Cyber
  59. accept only DISPLAY code input;  if you
  60. are  transferring  a program text,  you
  61. probably need to  SET  the File-type to
  62. DISPLAY.   DISPLAY  code  files contain
  63. only sixty-four  printable  characters.
  64. There  are  no  lower-case  letters  in
  65. DISPLAY  code files,  so they are some-
  66. times called  'upper-case' files.   You
  67. can create a  DISPLAY  code file on the
  68. Cyber by using one of the Cyber editors
  69. FSE  or  XEDIT,  or by giving the  TEXT
  70. command when your terminal is in NORMAL
  71. mode.
  72.  
  73. .EOR
  74.  
  75.  SET File-type Eight
  76.  
  77. EIGHT  code  files  are  files of text.
  78. Some programs call  them  ASCII8  or  8
  79. files.   You can create an  EIGHT  code
  80. file on the Cyber with the  FSE  editor
  81. or with the FCOPY command.  Most people
  82. do not need to use this type of file.
  83.  
  84. .EOR
  85.  
  86.  SET DEBug OFf
  87.  
  88.  Cyber Kermit always writes a record of your Kermit session on
  89.  the log file ZZZKLOG.  This file ordinarily lists any command
  90.  you give except 'SHow' and 'STatus'.  Cyber Kermit records in
  91.  the log any changes it must make to file names, certain error
  92.  messages, and statistics for all file transfers.  When  DEBug
  93.  is SET OFf, the log contains no other information.   DEBug is
  94.  always OFf unless you SET it ON.
  95.  
  96.  Note: The Cyber command KERMIT can list or print the log file
  97.        for you.  For information, give the Cyber command
  98.  
  99.             HELPME,KERMIT
  100.  
  101. .EOR
  102.  
  103.  SET DEBug ON
  104.  
  105.  Cyber Kermit's log file always contains  all of your commands
  106.  'SHow' and 'STatus',  all changes  Cyber Kermit makes to file
  107.  names,  all error messages received from other  Kermits,  and
  108.  statistics for each file transfer.  If you SET DEBug ON, your
  109.  log file will contain a two-line entry for every packet Cyber
  110.  Kermit sends and receives.  Ordinarily you should not need to
  111.  SET DEBug ON.  (If you are curious, use a VERY short file.)
  112.  
  113. .EOR
  114.  
  115.  SENd
  116.  
  117.  The SENd command tells Cyber Kermit to send a file to another
  118.  Kermit.  The format of the command is
  119.  
  120.    SENd filename
  121.  
  122.  You must always name the file you wish to SENd.
  123.  
  124. .EOR
  125.  
  126.  Receive
  127.  
  128.  The Receive command tells Cyber Kermit to receive a file from
  129.  another Kermit.  This command has two forms:
  130.  
  131.    Receive filename
  132.  
  133.  tells Kermit to receive a file, and that the file should have
  134.  the name 'filename' if no local file has that name already.
  135.  
  136.    Receive
  137.  
  138.  tells Kermit to receive a file, and to name the file whatever
  139.  the other Kermit calls it, if possible.
  140.  
  141. .EOR
  142.  
  143.  SERver
  144.  
  145.  The SERver command tells Cyber Kermit that you will no longer
  146.  be talking to it directly, but that your commands will arrive
  147.  in packets sent by the micro Kermit.  To cancel a SERver com-
  148.  mand, use the Cyber Escape code.  To find out what your Cyber
  149.  Escape  code  is,  give the SHow command.   (The Cyber Escape
  150.  code is  CTRL-C  unless you have changed it.)   You may  also
  151.  cancel a SERver command by giving the command
  152.  
  153.    FINISH
  154.  
  155.  to your micro Kermit.
  156.  
  157. .EOR
  158.  
  159.  Exit and Quit
  160.  
  161.  Cyber Kermit (unlike some of its relatives) makes no distinc-
  162.  tion between these two commands.  Exit  and  Quit  stop Cyber
  163.  Kermit so you can give regular NOS commands to Cyber's opera-
  164.  ting system  (including the GO or BYE command to log out, the
  165.  ATTACH and GET commands to make local files  --  Cyber Kermit
  166.  cannot send permanent files  --  or the SAVE, REPLACE, DSAVE,
  167.  and  DEPLACE  commands  --  since  Cyber Kermit  cannot write
  168.  permanent files).
  169.  
  170. .EOR
  171.  
  172.  Push
  173.  
  174.  The Push command  allows you to stop Cyber Kermit temporarily
  175.  while you to give NOS commands to the Cyber operating system.
  176.  Unlike the Exit and Quit commands, the Push command saves all
  177.  the options you have SET before giving the Push command; when
  178.  you give the next KERMIT command to the Cyber, any values you
  179.  set before Pushing will be restored.
  180.  
  181. .EOR
  182.  
  183.  SET Bit-prefix
  184.  
  185.  To set a different Bit-prefix, use the command
  186.  
  187.    SET Bit-prefix X
  188.  
  189.  where 'X' is the new Bit-prefix.   The Bit-prefix must differ
  190.  from the Quote-char and the REPeat-char, and it may not be an
  191.  upper-case letter or one of the following eight characters:
  192.  
  193.        [  ]  /  ^  `  #_  ?  @
  194.  
  195.  If you do not give an argument, Cyber Kermit assumes you wish
  196.  to set the default Bit-prefix '&'.
  197.  
  198. .EOR
  199.  
  200.  SET Quote-char
  201.  
  202.  To set a different Quote-character, use the command
  203.  
  204.    SET Quote-char X
  205.  
  206.  where 'X' is the character to be used.  The Quote-char cannot
  207.  be the same as the Bit-prefix or the REPeat-char,  and it may
  208.  not be an upper-case letter or one of these eight characters:
  209.  
  210.        [  ]  /  ^  `  #_  ?  @
  211.  
  212.  If you do not give an argument, Cyber Kermit assumes you wish
  213.  to set the default Quote-char '##'.
  214.  
  215. .EOR
  216.  
  217.  SET REPeat-char
  218.  
  219.  To set a different REPeat-character, use the command
  220.  
  221.    SET REPeat-char X
  222.  
  223.  where 'X' is the new REPeat-char.   The Repeat-char cannot be
  224.  the same as the Bit-prefix or the Quote-char,  and it may not
  225.  be an upper-case letter or one of these eight characters:
  226.  
  227.        [  ]  /  ^  `  #_  ?  @
  228.  
  229.  If you do not give an argument, Cyber Kermit assumes you wish
  230.  to set the default REPeat-char '~'.
  231.  
  232. .EOR
  233.  
  234.  SET DELay
  235.  
  236.  To SET a different DELay period, use the command
  237.  
  238.       SET DELay N
  239.  
  240.  where  N is the number of seconds which Cyber Kermit will ask
  241.  your micro Kermit to wait for a response.   The DELay must be
  242.  between  5  and 94 seconds.   If you do not give an argument,
  243.  Cyber Kermit will set the default DELay period,  which  is 20
  244.  seconds.
  245.  
  246. .EOR
  247.  
  248.  SET Escape
  249.  
  250.  To SET a different Escape character, use the command
  251.  
  252.       SET Escape X
  253.  
  254.  where X is a letter or one of the following seven characters:
  255.  
  256.        [  ]  /  ^  `  #_  @
  257.  
  258.  This sets the  Escape  character to the unprintable character
  259.  you produce when you press the  CONTROL key together with the
  260.  letter or symbol you have selected.  The Escape character may
  261.  not be the same as the Marker, and it may not be CONTROL with
  262.  any one of the letters  H, J, M, P, Q, S, T,  or  X.   If you
  263.  do not type an argument for this command,  Cyber Kermit tries
  264.  to SET the default Escape character, CTRL-C.
  265.  
  266. .EOR
  267.  
  268.  SET Marker
  269.  
  270.  To SET a different Marker character, use the command
  271.  
  272.       SET Marker X
  273.  
  274.  where X is a letter or one of the following seven characters:
  275.  
  276.        [  ]  /  ^  `  #_  @
  277.  
  278.  This sets the Marker to the unprintable character you produce
  279.  when you press the  CONTROL  key  together with the letter or
  280.  symbol you have selected.   The Marker may not be the same as
  281.  the Escape character,  and it may not be CONTROL with any one
  282.  of the letters  H, J, M, P, Q, S, T,  or  X.   If you do  not
  283.  type an argument for this command,  Cyber Kermit tries to SET
  284.  Escape to the default character, CTRL-C.
  285.  
  286. .EOR
  287.  
  288.  SET Packet-length
  289.  
  290.  To  SET  a different Packet-length  for the maximum length of
  291.  packet which Cyber Kermit asks to receive,  give the  command
  292.  
  293.       SET Packet-length N
  294.  
  295.  where  N  is the length of the longest packet Cyber will then
  296.  be able to receive.   The  Packet-length must be in the range
  297.  40 -- 94.   The default Packet-length is 94,  and if you give
  298.  the  SET  Packet-length  command  without a parameter,  Cyber
  299.  Kermit SETs the Packet-length to 94.
  300.  
  301. .EOR
  302.  
  303.  SET RETry
  304.  
  305.  To SET the maximum number of retries allowed when  attempting
  306.  to transmit a single packet, give the command
  307.  
  308.       SET RETry N
  309.  
  310.  where  N  is the maximum number of retries per packet.  RETry
  311.  must be in the range 3 -- 30.   The default RETry limit is 5,
  312.  and if you give the  SET RETry  command without a  parameter,
  313.  Cyber Kermit SETs the RETry limit to 5.
  314.  
  315. .EOR
  316.  
  317.  Type
  318.  
  319. You can give the  Type  command only if
  320. Cyber Kermit is running  as  a  SERver.
  321. This  command  is  useful  for learning
  322. whether you have  SET the correct File-
  323. type,  because  you  can  interrupt the
  324. Type  command  from  your  micro.   The
  325. format of the command is
  326.  
  327.      Type Cyberfilename
  328.  
  329. You  are  not allowed to Type Binary or
  330. Kermit format files.
  331.  
  332. .EOR
  333.  
  334. You  can send the following commands to
  335. Cyber Kermit when it is in SERver mode:
  336.  
  337.  SEt-file-type             STatus
  338.  SHow                      Type
  339.  
  340. .EOR
  341.  
  342. The  SEt-file-type command requires one
  343. parameter,  the name of a type of  file
  344. recognised by Cyber Kermit:
  345.  
  346.  Ascii                     Eight
  347.  Binary                    Kermit
  348.  Display
  349.  
  350. For more information, consult the Cyber
  351. Kermit User Guide.
  352.  
  353. .DATA,DUMMY.
  354.