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