home *** CD-ROM | disk | FTP | other *** search
/ Fun & Games 1 / FUNGAMES1.cdr / wind / softerm / hostmode.hlp < prev    next >
Encoding:
Text File  |  1992-04-01  |  11.3 KB  |  309 lines
  1.  Host Mode
  2.  ---------
  3.  
  4.  The Softerm Host mode provides a general-purpose, unattended, remote
  5.  access mode which can be used interactively by other terminals and
  6.  systems.  This is similar to an electronic BBS.
  7.  
  8.  It can transfer files using the Character, Kermit, Xmodem, Ymodem or
  9.  Softrans protocols.  Host mode functions as a server for the Kermit-Server
  10.  and Softrans file transfer protocols by automatically detecting a protocol
  11.  block while waiting for a command from the user.  This means that a
  12.  command to initiate the file transfer is not required.
  13.  
  14.  
  15.  Host Mode Interactive Commands
  16.  ------------------------------
  17.  
  18.  Host mode responds to 28 interactive commands which you enter.  The Host
  19.  system will transmit the following prompt when it is ready to receive a
  20.  command:
  21.  
  22.                     Ready
  23.  
  24.  The following control characters may be used:
  25.  
  26.       Character      Action
  27.       ---------      ------
  28.  
  29.       BS ($08)       Delete previous character
  30.       DEL ($7F)      Delete previous character
  31.       ESC ($1B)      Cancel command line
  32.       CTRL C ($03)   Cancel output
  33.       CTRL S ($13)   Stop Display
  34.       CTRL Q ($11)   Resume Display
  35.  
  36.  To abort the display of a file typed or a directory list, press CTRL C.
  37.  Output also is aborted if you press CTRL S to stop the display and it is
  38.  not resumed within 30 seconds.  Host mode will timeout and display the
  39.  Ready prompt.
  40.  
  41.  
  42.  Important
  43.  ---------
  44.  All commands are issued by the caller and tell Host mode to do something.
  45.  e.g.: If you want to send a file, you must instruct Host mode to prepare
  46.  to receive a file.
  47.  
  48.  
  49.  Exceptions to the Rule
  50.  ----------------------
  51.  Because Host mode acts as a server for the Softrans and Kermit-Server file
  52.  transfer protocols, there are no commands to send and receive using those
  53.  protocols.  You simply need to initiate the file transfer operation.
  54.  
  55.  Many of the Host commands require arguments.  The command and argument
  56.  must be separated by at least one space.
  57.  
  58.  
  59.  HELP
  60.  ----
  61.  Display this Help information.
  62.  
  63.  
  64.  BYE
  65.  ---
  66.  Terminate the current Host mode session and disconnect.
  67.  
  68.  
  69.  ACCEPT [-,&] d:\path\filename
  70.  -----------------------------
  71.  Used by the caller to send a file using character protocol.  The filename
  72.  argument specifies the name of the file to receive the data.
  73.  
  74.  If the very first character of the path\filename is a hyphen (-), the file
  75.  will replace a file of the same name on the Host system.
  76.  
  77.  Example:
  78.  
  79.       ACCEPT -C:\SOFTHOST\TEST.TXT
  80.  
  81.  If the very first character of the path/filename is an ampersand (&), the
  82.  file will append to a file of the same name on the Host system.
  83.  
  84.  Example:
  85.  
  86.       ACCEPT &C:\SOFTHOST\TEST.TXT
  87.  
  88.  If a file of the same name exists and neither special character is used,
  89.  the transfer will fail.
  90.  
  91.  The host will display a GO> prompt when the system is ready to accept
  92.  data.  Characters can be typed by the caller or a file can be transferred
  93.  using character protocol.
  94.  
  95.  The ACCEPT command is terminated by a Ctrl Z character or a 60-second
  96.  timeout.
  97.  
  98.  
  99.  CALL d:\path\filename 1='string1'...5='string5'
  100.  -----------------------------------------------
  101.  Run a script file and then return to the Host mode.  If logon processing
  102.  is in effect, all subsequent commands will observe the access restrictions
  103.  for the current user.
  104.  
  105.  Note:  We recommend that the CALLed script file does not end with the
  106.  CONVERSE command.  This command places the Host Mode machine in Online
  107.  terminal emulation mode with unpredictable results.
  108.  
  109.  The command line may include optional switches to specify the contents of
  110.  the Script Variables SV1-SV5 used in the script file as follows:
  111.  
  112.     Switch         Function
  113.     1='string'     Replaces SV1 in script file
  114.     .    .    .    .    .    .
  115.     5='string'     Replaces SV5 in script file
  116.  
  117.  Note:  The quote marks are optional and would be necessary only if the
  118.  string contained embedded spaces.
  119.  
  120.  Up to 5 strings can be specified which are substituted for dummy arguments
  121.  in the script file when the script file is run.  Each string may be up to
  122.  64 characters in length.  A dummy argument is defined in the script file
  123.  as SV followed by a number from 1 through 5.  Thus, wherever SV1 occurs in
  124.  the script file, it will be replaced by the string defined for the SV1=
  125.  switch in the CALL command line.  Note:  The maximum length of the command
  126.  line is restricted to 128 characters.
  127.  
  128.  
  129.  CD d:\path
  130.  ----------
  131.  Change the current default directory used for file names specified in file
  132.  transfer operations used in the Host mode.  The new default directory,
  133.  including a drive specifier and directory path, is entered as an argument
  134.  on the command line.  If the optional Host mode logon processing is in he
  135.  current username.
  136.  
  137.  
  138.  CURRENT
  139.  -------
  140.  Display the default directory for file transfer operations used in the
  141.  Host mode.  It initially is set to the current default directory when the
  142.  HOST() command is processed, or to the subdirectory in the password file
  143.  for the current user.
  144.  
  145.  
  146.  DELETE d:\path\filename
  147.  -----------------------
  148.  Remove an unwanted file from disk.  If no drive or directory path is
  149.  entered, the file is deleted from the current directory.  You can use the
  150.  wildcard characters ? and * in the filename and in the extension.
  151.  
  152.  This command can be abbreviated to DEL.
  153.  
  154.  
  155.  DIR d:\path\filename
  156.  --------------------
  157.  The DIR command displays a list of the filenames in a specified directory.
  158.  If no drive or directory path is specified, all files in the current
  159.  default directory will be listed.  The wildcard characters * and ? may be
  160.  used in the filename and extension parameters to list a subset of the
  161.  files in the specified directory.
  162.  
  163.  
  164.  ECHO <On or Off>
  165.  ----------------
  166.  This command turns echo mode for the ACCEPT command on or off.  If the
  167.  argument is specified as ON, characters transmitted to the host using an
  168.  ACCEPT command will be echoed back to the remote terminal or system for
  169.  visual confirmation.  If the argument is specified as OFF, characters
  170.  received are not echoed.  The echo mode defaults to ON.
  171.  
  172.  
  173.  KSEND d:\path\filename
  174.  ----------------------
  175.  Prepare the Host system to send a file using the Kermit protocol.  This
  176.  command can be used by remote Kermit programs unable to access a Kermit
  177.  server.  The command is equivalent to a Kermit protocol SEND command.  The
  178.  wildcard characters * and ? may be used in the filename or extension to
  179.  allow multiple files to be sent using a single command.
  180.  
  181.  
  182.  LF <On or Off>
  183.  --------------
  184.  This command turns the line feed mode for the TYPE and ACCEPT Host mode
  185.  commands on or off.  If the argument is specified as ON, the host will add
  186.  line feed characters after carriage returns in transmitted or echoed data.
  187.  If the argument is specified as OFF, no line feed characters are added.
  188.  The line feed mode initially is set to ON.
  189.  
  190.  
  191.  LOGOUT
  192.  ------
  193.  Terminate the current Host mode session and restart with logon processing
  194.  without a disconnect.
  195.  
  196.  
  197.  RECEIVE <profile_name or protocol_name> filename
  198.  ------------------------------------------------
  199.  Prepare the Host system to receive the designated file using the 
  200.  specified File Transfer profile or File Transfer Protocol.  If a profile 
  201.  and a protocol share the same name, the command will use the profile.
  202.  
  203.  Note:  This method lets you use the Honeywell-Kermit protocol with the
  204.  desired GCOS Mapping setting by using the appropriate profile.
  205.  
  206.  
  207.  RENAME d:\path\filename1 d:\path\filename2
  208.  ------------------------------------------
  209.  Change the name of a file in the current or a specified directory.  The
  210.  first file name entered with optional drive and path specification is the
  211.  file to be renamed, and the second file name is the new name.  A drive or
  212.  path specification is not allowed in the new filename.  The ? and *
  213.  wildcard characters are allowed.
  214.  
  215.  This command can be abbreviated to REN.
  216.  
  217.  
  218.  SEND <profile_name or protocol_name> filename
  219.  ---------------------------------------------
  220.  Prepare the Host system to send the designated file using the specified
  221.  File Transfer profile or File Transfer Protocol.  If a profile and a
  222.  protocol share the same name, the command will use the profile.
  223.  
  224.  Note:  This method lets you use the Honeywell-Kermit protocol with the
  225.  desired GCOS Mapping setting by using the appropriate profile.
  226.  
  227.  
  228.  TERMINATE
  229.  ---------
  230.  Terminate Host mode processing to interact directly with the script file
  231.  from which the HOST() command was started.  If the optional Host mode
  232.  logon processing is in effect, the command is restricted by the access
  233.  restriction code.
  234.  
  235.  
  236.  TYPE d:\path\filename
  237.  ---------------------
  238.  Cause a file to be typed or displayed by the Host system.  The command is
  239.  equivalent to a character protocol SEND command.  The display can be
  240.  cancelled by entering Ctrl C.
  241.  
  242.  
  243.  XRCV d:\path\filename
  244.  ---------------------
  245.  Prepare the Host system to receive the designated file using the Xmodem
  246.  protocol.  The filename specifies the file to receive the data.
  247.  
  248.  Note:  The caller may send the file using Xmodem, Xmodem-CRC or
  249.  Xmodem(Large Block) and the Host system will detect and adjust for the
  250.  error correction method and block size.
  251.  
  252.  
  253.  XSEND d:\path\filename
  254.  ----------------------
  255.  Prepare the Host system to send the designated file using the Xmodem
  256.  protocol.
  257.  
  258.  
  259.  X1KSEND d:\path\filename
  260.  ------------------------
  261.  Prepare the Host system to send the designated file using the Xmodem
  262.  (Large Block) protocol.
  263.  
  264.  YGRCV [d:\path\filename]
  265.  ------------------------
  266.  Prepare the Host system to receive the designated file using the Ymodem-G
  267.  protocol.  The wildcard characters * and ? may be used in the filename or
  268.  extension to allow multiple files to be transferred using a single
  269.  command.
  270.  
  271.  If the optional drive, path and file name are not specified, the command
  272.  will use the data in the protocol header block.
  273.  
  274.  
  275.  YRCV [d:\path\filename]
  276.  -----------------------
  277.  Prepare the Host system to receive the designated file using the Ymodem
  278.  protocol.  The wildcard characters * and ? may be used in the filename or
  279.  extension to allow multiple files to be transferred using a single
  280.  command.
  281.  
  282.  If the optional drive, path and file name are not specified, the command
  283.  will use the data in the protocol header block.
  284.  
  285.  Note:  The caller may send the file using Ymodem or Ymodem (Large Block)
  286.  and the Host system will detect and adjust for the block size.
  287.  
  288.  
  289.  YSEND d:\path\filename
  290.  ----------------------
  291.  Prepare the Host system to send the designated file using the Ymodem
  292.  protocol.  The wildcard characters * and ? may be used in the filename or
  293.  extension to allow multiple files to be transferred using a single
  294.  command.
  295.  
  296.  Note:  The caller may specify Ymodem-G to receive the file and the Host
  297.  system will detect and adjust for the block size and transmission method.
  298.  
  299.  
  300.  Y1KSEND d:\path\filename
  301.  ------------------------
  302.  Prepare the Host system to send the designated file using the Ymodem
  303.  (Large Block) protocol.  The wildcard characters * and ? may be used in
  304.  the filename or extension to allow multiple files to be transferred using
  305.  a single command.
  306.  
  307.  Note:  The caller may specify Ymodem-G to receive the file and the Host
  308.  system will detect and adjust for the block size and transmission method.
  309.