1 02/15/85  micro_transfer, mt
  2 
  3 Syntax as a command:  mt path {-control_args}
  4 
  5 
  6 Function: transfers files between a Multics system and a remote
  7 microcomputer (personal computer) using either 1) the xmodem protocol
  8 or 2) the IBM PC-to-Host protocol.  Your terminal must be connected to
  9 the system through the tty_ I/O module.  (This is the usual method of
 10 connecting terminal to the Multics system.)
 11 
 12 
 13 Arguments:
 14 path
 15    can be one of the following:
 16       1) is the pathname of the source segment on Multics when
 17       transferring files from Multics to a microcomputer.
 18       2) is the pathname of the target segment on Multics when
 19       transferring files to Multics from a microcomputer.
 20 
 21 
 22 Control arguments:
 23 -attach_description STR, -atd STR
 24    specifies the I/O module to be used to implement the file transfer,
 25    where STR specifies the I/O module to be used and the I/O switch to
 26    which the module is to be attached.  Enclose STR in quotation marks
 27    if it contains spaces or other command language characters.  STR can
 28    be one of the following:
 29    xmodem_io_ user_i/o
 30       specifies the XMODEM protocol is to be used.  (Default)
 31    ibm_pc_io_ user_i/o
 32       specifies the IBM PC-to_Host protocol is to be used.
 33 
 34 
 35 -eof STR
 36    specifies the end-of-file sequence for the microcomputer, where STR
 37    is the end-of-file character.  STR can be a printable ASCII
 38    character or a control character; you must express the latter type
 39    in the octal equivalent and surround it by quotation marks.  When
 40    transmitting a file to a microcomputer the end-of-file character is
 41    transmitted as STR; when receiving a file from a microcomputer the
 42    occurrence of STR indicates the end-of-file to Multics.
 43 
 44 
 45 -eol STR
 46    specifies the end-of-line sequence for the microcomputer, where STR
 47    is the end-of-line character.  STR can be a printable ASCII
 48    character or a control character; you must express the latter type
 49    in the octal equivalent and surround it by quotation marks.  When
 50    transmitting files to a microcomputer, each linefeed character is
 51    translated to STR; when receiving files from a microcomputer, each
 52    occurrence of STR is translated to a linefeed character.
 53 -modes STR
 54    sets the modes for file transfer according to STR, which is a string
 55    of mode names separated by commas.  You can optionally precede many
 56    modes by ^ to turn the specified mode off.  Modes not specified in
 57    STR are left unchanged.  Modes are restored to their original value
 58    after the file transfer is complete.  (See set_tty for a list of
 59    valid modes; see "Data transfer i/o modules" for the default modes.)
 60 
 61 
 62 -receive
 63    receives data from the microcomputer.  Give either -receive or
 64    -send.
 65 -send
 66    sends data to the microcomputer.
 67 
 68 
 69 Notes on data transfer i/o modules: The micro_transfer command
 70 provides an interface between the Multics file system and a data
 71 transfer protocol.  The data transfer protocol is implemented as an I/O
 72 module.  Such I/O modules must specify a target I/O switch, and they
 73 must support the stream_input and stream_output opening modes.  The
 74 switch identified by the switch argument must be open for
 75 stream_input_output.  The following I/O modules are currently available
 76 for use with micro_transfer:
 77 xmodem_io_
 78    uses the XMODEM data transfer protocol.  The default mode string
 79    used by micro_transfer for file transfer is:
 80    "no_outp,8bit,breakall,^echoplex,rawi,^crecho,^lfecho,^tabecho,rawo"
 81 
 82 
 83 ibm_pc_io_
 84    uses the IBM PC-to-Host data transfer protocol.  This protocol does
 85    not transfer binary data or check for errors.  The default mode
 86    string used by micro_transfer for file transfer is:
 87    "^8bit,breakall,^echoplex,rawi,^crecho,^lfecho,^tabecho,rawo"
 88 
 89 Users writing their own data transfer protocol I/O modules with
 90 micro_transfer may do so.  Its descriptions would be:
 91 XXX
 92    uses the user-specified data transfer protocol for the file
 93    transfer.  The default mode string used by micro_transfer for file
 94    transfer is:
 95    "no_outp,8bit,breakall,^echoplex,rawi,^crecho,^lfecho,^tabecho,rawo"
 96 
 97 
 98 Notes on file transfer speed: There is no guarantee of any particular
 99 line speed when transferring files between Multics and a microcomputer.
100 Line speed is dependent on the microcomputer and the load of the FNP
101 and communication system for Multics.  Due to the nature of the XMODEM
102 and IBM PC-to-Host protocols, files may not be successfully transferred
103 to Multics over high-speed lines.  The actual limit depends on the site
104 configuration and current load.
105 
106 
107 Notes on procedure for using micro_transfer: Use the following
108 procedure to transfer files between Multics and a microcomputer with
109 micro_transfer:
110    1. Invoke the control program on the microcomputer.  This program is
111       a terminal emulator and file transfer program.
112    2. Connect to Multics by issuing the appropriate command to the
113       microcomputer.  To find out which command to use, refer to the
114       manual that documents the microcomputer's file transfer protocol.
115       Once connected, the standard Multics banner is displayed.
116    3. Login to Multics.
117    4. Issue micro_transfer on Multics specifying the pathname on
118       Multics and the applicable control arguments.
119 
120 
121    5. Escape now back to the microcomputer.  The escape sequence used
122       depends on the microcomputer.  To find out which escape sequence
123       to use, refer to the manual that documents the microcomputer's
124       file transfer protocol.  Upon return to the microcomputer, enter
125       the type and direction of the file transfer and the microcomputer
126       file name.  This must correspond to the type and direction
127       specified on Multics.  For example, if you used micro_transfer
128       -send, the command used for receiving a file transfer must be
129       executed on the microcomputer.
130    6. The file transfer begins.  A display indicating the status of the
131       transfer may or may not occur, depending on the communications
132       package residing on the microcomputer.
133    7. At the end of the transfer, the microcomputer returns to the
134       communications command level.