home *** CD-ROM | disk | FTP | other *** search
/ Unix System Administration Handbook 1997 October / usah_oct97.iso / rfc / 400s / rfc412.txt < prev    next >
Text File  |  1997-06-17  |  18KB  |  564 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7. Work Information Center # 12404                                 G. Hicks
  8. Request for Comments # 412                                      Utah
  9.                                                                27-Nov-72
  10.  
  11.  
  12.  
  13.                          User FTP Documentation
  14.  
  15.      The attached document is the HELP file for the Utah-10
  16. implementation of the User FTP Process. This is what the user has
  17. typed on his console when he types 'HELP<cr>', and as such is the only
  18. documention produced to date.
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.                                                                 [Page 1]
  59.  
  60. User FTP Documentation                          Detailed Command Listing
  61.  
  62.  
  63.                          FTP User Documentation
  64.                            November 27, 1972
  65.  
  66.  
  67. I. Control Characters
  68.  
  69.       There are several control characters that have meaning to the FTP
  70. Process. First, the abort character is <control-z> (SUB), next for
  71. editing, only <control-r>, <control-a>, <control-h>, <control-v>,
  72. <control-w>, <alt-mode>, <eol>, <space>, <control-x> and <rub-out> have
  73. any meaning, <control-a> (SOH) and <control-h> (BS) are the character
  74. delete keys. <control-w> is the word delete character, Note: When dowing
  75. the ' funktion, this character will delete the entire line typed.
  76. <control-v> says take the next character literally. <alt-mode> (ESC)
  77. terminates the command giving helpful noise words, <eol> and <space> are
  78. terminators also. These last two will give no command completion or
  79. noise words. All three echo as a space however.  <control-x> (CAN) and
  80. <rub-out> (DEL) are the command abort characters. <control-r> (DC2) will
  81. retype the line as the command interpreter sees it. When using the ?  as
  82. a prompter, for initial commands, it will type-out all commands that
  83. begin with that particular character string.  If it is typed in a sub-
  84. command field, it will type out the prompt message only if it is the
  85. first character typed. At all other times, it will be accepted as part
  86. of the typed string.
  87.  
  88.  
  89. II. General Information
  90.  
  91.       The FTP user process is designed to make transferring files from
  92. one host on the ARPANET to another much easier than it has been up until
  93. now. To this end, the command language was designed to be as natural as
  94. possible.
  95.  
  96.       The command interpreter is, of course, part of this idea.
  97. Therefore, to help the user as much as possible, there are several ways
  98. to find out what is expected in the form of commands, file-names, user-
  99. names, etc. When the user has typed nothing, typing a ? will cause the
  100. interpreter to type out all the commands that are available to the user.
  101. If the user has typed anything at all, then it will respond with all
  102. commands that begin with the particular character string.
  103.  
  104.       So that the command language was as easy to learn as possible, the
  105. command interpreter will 'see' nothing that is not part of a legal
  106. command. If the user types anything that is not expected, the character
  107. is not echoed and a bell is echoed instead.
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.                                                                 [Page 2]
  115.  
  116. User FTP Documentation                          Detailed Command Listing
  117.  
  118.  
  119. III. Brief Command Listing
  120.  
  121.       The commands that are expected and their syntax are listed below.
  122. NOTE: UPPER and lower case letters are identical.
  123.  
  124.  
  125. <host-name>
  126. D<decimal host number>
  127. <octal host number>
  128. ;<any string> (useful for comments to a person that is
  129. linked to you)
  130. MODE <mode name>
  131. RETREIVE <remote file> (to) <local file>
  132. GET <remote file> (to) <local file>
  133. SEND <local file> (to) <remote file>
  134. STORE <local file> (to) <remote file>
  135. APPEND <local file> (to) <remote file>
  136. RENAME <remote file> (to be) <new remote file name>
  137. DELETE <remote file>
  138. BYE
  139. COPY <direction descriptor> <file group> (to) <file group>
  140.      (see detailed description below)
  141. LOGOUT
  142. DDT
  143. LIST <file group> (to file) <local file name>
  144. SOCKET (NOT IMPLEMENTED YET)
  145. ALLOCATE <decimal number of bytes>
  146. QUIT
  147.    foreign host)
  148. HOST <any valid ARPANET host name or number>
  149. USER <remote user name>
  150. PASSWORD <password for remote user's name>
  151. ACCOUNT <string or number for remote user's name>
  152. STATUS (see description of status command below)
  153. LOGIN <user name> <password> <optional account> <to host>
  154. BYTE <decimal byte size>
  155. TYPE <type descriptor>
  156. STRUCTURE <structure descriptor>
  157. TENEX
  158. ASCII
  159. VERBOSE
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.                                                                 [Page 3]
  171.  
  172. User FTP Documentation                          Detailed Command Listing
  173.  
  174.  
  175. IV. Detailed Description of the Commands
  176.  
  177.          The commands and their syntax are described in greater detail
  178.    blow. The words in parenthesis are noise words.  NOTE: upper and
  179.    lower case are identical. Unless otherwise noted in the command
  180.    description, all commands described are implemented.
  181.  
  182. <host name> or <host number>
  183.    Performs the ICP to the indicated host with explanatory remarks if
  184.    the ICP is not possible.
  185.  
  186. MODE <mode descriptor>
  187.    Sets the mode of the data transfer connection according to the
  188.    following sub-commandos:
  189.  
  190.    STREAM: bit stream, end of file is indicated by the data connection
  191.    closing.
  192.  
  193.    BLOCK: formats (or expects formatted) data into blocks.
  194.  
  195.    TEXT: Sends or retreives text. Forces TYPE ASCII and BYTE 8. This
  196.    command sends the appropiate commands to the foreign host, then sends
  197.    the data using the TELNET codes for EOR and EOF as per the FTP
  198.    Protocol.
  199.  
  200.    HASP: compress data.
  201.  
  202.    NOTE: Of the above sub-commands, only MODE STREAM and MODE TEXT are
  203.    implemented at present.
  204.  
  205. RETREIVE (file) <remote file> (to file) <local file name>
  206.    Sends the retr command to the remote server, sets up the data
  207.    connection according to any previous MODE, TYPE, BYTE commands. Puts
  208.    the data coming on the the data connection into the local file
  209.    specified.
  210.  
  211. GET (file) <remote file name> (to file) <local file name>
  212.    See description of RETREIVE.
  213.  
  214. STORE (local file) <file name> (onto file) <remote file>
  215.    Accepts a local file name, does the formatting according to any
  216.    previous BYTE, TYPE, MODE commands and sends it to the foreign host.
  217.  
  218. SEND (local file) <file name> (onto file) <remote file>
  219.    See description of STORE.
  220.  
  221. APPEND (local file) <file name> (to remote file) <remote file>
  222.    Does the same as a store except that the file is appended to the
  223.  
  224.  
  225.  
  226.                                                                 [Page 4]
  227.  
  228. User FTP Documentation                          Detailed Command Listing
  229.  
  230.  
  231.    remote file rather that just writing over the file.
  232.  
  233. RENAME (existing file) <file name> (to be) <new file name>
  234.    Accepts the name of n old remote file and asks for a new file name,
  235.    sends the appropiate commands and names to the foreign host causing
  236.    the old file name to be replaced by the new file name.
  237.  
  238. DELETE (file) <file name>
  239.    This command causes the remote file to be marked for deletion. It
  240.    does require that the command be confirmed twice.
  241.  
  242. BYE
  243.    Takes no arguments. Causes the server to terminate the current
  244.    session with the user. The program will return to the EXEC MODE when
  245.    the command has been acknowledged by the remote server.
  246.  
  247. COPY
  248.    This command does a variety of things. First. it allows the user do
  249.    describe a file group. EG: *.mac, *.sav, etc.  The *'s may be for
  250.    foreign files or local files according to the following sub-commands:
  251.  
  252.   REMOTE (remote file group) <remote file grouping>:
  253.    Causes the user FTP to ask the server for the file in <remote file
  254.    grouping>. Then asks the user to specify where each file is to go. A
  255.    typical sequence might look like the following:
  256.  
  257.    !copy remote (remote file group) ftp.*
  258.    Please be patient. Getting remote file names.
  259.    Got them.
  260.    !copy (file) <HICKS>FTP.MAC;| (to file) ftp.mac [New file]
  261.    [Messages and etc. follow with the above line being
  262.    repeated for each file in the remote file group.]
  263.  
  264.   LOCAL (local file grouping) <local file group>:
  265.    Causes the user FTP to accept the file group specified, and send the
  266.    file names to the server leaving off the <directory name> and version
  267.    number of the local file. The user may not specify *'d devices of *'d
  268.    directorys. A line for this might look like the following:
  269.    !copy local (local file group) ftp.*;*
  270.     [Confirm]
  271.  
  272.    Next, if the user does not specify any *'s for either the remote file
  273.    or the local file, this command is exactly like the RETREIVE or STORE
  274.    command described earlier.
  275. LOGOUT
  276.    Takes no arguments. See description of BYE command for more details.
  277.  
  278.  
  279.  
  280.  
  281.  
  282.                                                                 [Page 5]
  283.  
  284. User FTP Documentation                          Detailed Command Listing
  285.  
  286.  
  287. RESET
  288.    Takes no arguments. Causes the user process to close all connections
  289.    (if necessary), all files (if necessary), and reset the programs
  290.    parameters to their defaults.
  291.  
  292. DDT
  293.    If DDT is loaded, just starts DDT. If DDT is not loaded, it will load
  294.    DDT and then start it at its initial start-up location.  This command
  295.    will casue an abnormal interrupt if DDT is not found.
  296.  
  297. LIST (file group) <remote file group> (to file) <local file>
  298.    Esentially causes the remote server to do a directory command. The
  299.    default is *.* and since the listing will come on the data connection,
  300.    the user must specify a local file. A sample line might look like the
  301.    following: !list (file group) *.* (going to file) tty: [ok]
  302.  
  303. SOCKET <socket descriptor>
  304.    Will accept a socket descriptor for the data to go to or come from. At
  305.    present it is NOT IMPLEMENTED because we have not decided on the
  306.    format of the command to the server.
  307.  
  308. ALLOCATE <decimal number of bytes>
  309.    Accepts as its argument a decimal number of bytes (of the specified
  310.    size) telling the server how many bytes of storage to reserve for the
  311.    next store of append.
  312.  
  313. QUIT
  314.    Takes no arguments. Returns the console to the EXEC. The program may
  315.    be continued with no harm done.
  316.  
  317.    This command allows the user to send arbitrary strings to the remote
  318.    server. At present, when talking to a TENEX site, it is only useful
  319.    for doing the 'MAIL' command.  Other sites may have help commands of
  320.    whatever.
  321.  
  322. HOST <ARPANET host name of number>
  323.    Allows the user to specify an ARPANET host without actually connecting
  324.    to the host. This specified host will be the ont that is connected to
  325.    (or the attempt will be made anyway) when the next 'immediate' command
  326.    is executed. EG: LOGIN, RETREIVE, STORE, LIST, etc.
  327.  
  328. USER (name is) <remote user's name>
  329.    Sets the user name for the remote system. Useful for systems that
  330.    require no password for the specified name.  Does nothing until an
  331.    user must be 'logged into' the remote system. The programm knows this
  332.    and so will not let the user execute any commands (RETREIVE, STORE,
  333.    APPEND, LIST, STATUS, RENAME, DELETE) until he has at least specified
  334.    a remote user name. The LOGIN command does this as does this command.
  335.  
  336.  
  337.  
  338.                                                                 [Page 6]
  339.  
  340. User FTP Documentation                          Detailed Command Listing
  341.  
  342.  
  343. STATUS (of the) <sub-cmd> (at host) <ARPANET host>
  344.    Accepts as its argument one of the following sub-commands:
  345.   SERVICE (at host) <ARPANET host name or number>: Attempts to
  346.    perform the ICP to the specified host. Does not disturb any existing
  347.    connections.
  348.   <ARPANET host name or number>: See description of STATUS SERVICE
  349.   above.
  350.  
  351.   STATUS (of file) <remote file group>: Similar to the LIST
  352.    command described above except that the listing does not gone back on
  353.    the data connection but on the TELNET connection. See LIST command for
  354.    more details.
  355.   <COMMAND-TERMINATOR>: Just sneds the STAT command.
  356.    Typically, is good for finding out where your are and perhaps who you
  357.    are.
  358.  
  359. PASSWORD (is) <passowrd for remote user's name>
  360.    Sets the password for the remote user's name. It is NOT echoed and
  361.    does nothing until the next 'immediate' command is executed.
  362.  
  363. ACCOUNT (is) <account number or string>
  364.    Accepts a string of number that can be charged for any activity the
  365.    user specifies. EG: STORE, RETREIVE or APPEND. Useful only for systems
  366.    that require this information of course. Also does nothing until the
  367.    next immediate command is executed.
  368.  
  369. LOGIN <user name> <password> <optional account>
  370.    the format of this command is identical to the TENEX login command. It
  371.    accepts a user name, password, and an optional account number. If no
  372.    host has been specified, it will ask for the host to be connected to.
  373.    This command will cause the ICP to take place if necessary.
  374.  
  375. BYTE (size is) <decimal byte size>
  376.    This command sets the byte size for the data connection.  The default
  377.    byte size is 8 bytes.
  378.  
  379. Type (is) <type descriptor>
  380.    Takes as its argument one of the following subcommands:
  381.   TENEX: Shorthand that sets TYPE IMAGE and BYTE 36.
  382.   EBCDIC: Says that the data will be Ebcdic.
  383.   PRINT: Says that the data is an Ascii print file with ASA vertical
  384.    format controls.
  385.   LOCAL: Forces the user and server FTP to accept whatever
  386.    byte size the user has specified. For the present, this type is
  387.    treated the same as for IMAGE TYPE.
  388.   IMAGE: Does the same as LOCAL. Just forces the user and server FTP to
  389.    accept the specified byte size without doing any translation as is
  390.    done for ASCII type. For most efficient usage of this command, the
  391.  
  392.  
  393.  
  394.                                                                 [Page 7]
  395.  
  396. User FTP Documentation                          Detailed Command Listing
  397.  
  398.  
  399.    matching byte size should be BYTE 36 when using TENEX sites as
  400.    servers.
  401.   ASCII: Sets TYPE ASCII and 8 bit bytes. Useful for text files.
  402.    NOTE: Of the above sub-commands, only PRINT and EBCDIC are not
  403.    implemented yet.
  404.  
  405. STRUCTURE (is) <file structure descriptor>
  406.    Accepts as its argument one of the following sub-commands:
  407.   REDORD: Says the data on the data connection has record
  408.    structure information contained in it. NOTE: Since TENEX NOT support
  409.    record structured files per se, this mode only useful for sending text
  410.    files to or retreiving text files from non-TENEX sites. The <EOL> in
  411.    these files is converted to the TELNET EOR code for transmission and
  412.    EOR to <EOL> etc. for reception.
  413.  
  414.   File: Says the data stream has no record structure information in it.
  415.  
  416. TENEX
  417.    See description under TYPE TENEX.
  418.  
  419. ASCII
  420.    See description under TYPE ASCII.
  421.  
  422. VERBOSE
  423.    This command sets the command completion/no completion flag. The
  424.    program assumes the NO VERBOSE mode and thus does not complete
  425.    commands when <space> or <eol> is used as a command terminator It also
  426.    causes the noise words to be typed if in the verbose mode.
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.                                                                 [Page 8]
  451.  
  452. User FTP Documentation                          Detailed Command Listing
  453.  
  454.  
  455. V. Sample Session using the FTP
  456.  
  457.        The following scenario shows some uses of the FTP.
  458.    Everything that the user types is underlined.
  459.  
  460.    UTAH-TENEX 1.29.03 EXEC 1.38
  461.    LOGIN (USER) HICKS (PASSOWRD) (ACCOUNT #) 1200
  462.    JOB 24 ON TTY2 11-NOV-72 1:51
  463.    TERMINAL (TYPE IS) 4
  464.    ftp
  465.    FTP User Process 1.10 5-NOV-72. Type Help<cr> for help.
  466.    !login (user) network (password) (account) 4 (to host) case-10
  467.    CONNECTION IS OPEN TO CASE-10.
  468.    < CASE-10 FTP Server 1.14.0 - at SAT 11-NOV-72 2:00-EST
  469.    !tenex ? confirm with carriage return
  470.     tenex
  471.    !copy remote (remote group) ftp.*
  472.     Please be patient. Getting remote file-names.
  473.     Got them.
  474.    !copy (file) <NETWORK>FTP.MAC:32 (no file) ftp.mac [new file]
  475.    < IMAGE retreive of <NETWORK>FTP.MAC;32 startet.
  476.    < Transfer completed.
  477.    !copy (file) <NETWORK>FTP.SAV;5 (fo file) FTP.SAV;5 [new version]
  478.    < IMAGE retreive of <NETWORK>FTP.SAV;5 started.
  479.    < Transfer completed.
  480.    !copy (file) <NETWORK>FTP.REL;1 (to file) xxx
  481.    !copy (file) <NETWORK>FTP.HELP;5 (to file) ftp.help [New version]
  482.     copy (file) <NETWORK>FTP.HELP;5 (to file) FTP.HELP;1
  483.    < IMAGE retreive of <NETWORK>FTP.HELP;5 started.
  484.    < Transfer completed.
  485.    Done...
  486.    !usc-isi
  487.     Closing connections to CASE-10.
  488.     CONNECTION IS OPEN TO USC-ISI.
  489.    < USC-ISI FTP Server 1.14.0 - at SAT 11-NOV-72 2:15-PST
  490.    !log
  491.    user hicks
  492.    (password)
  493.    (account) ? account number or string for remote user's name
  494.     log
  495.    (user) hicks
  496.    (password)
  497.    (account) |
  498.    !send (local file) ftp.sav;5 (to remote file) ftp.sav
  499.    < STORE of <HICKS>FTP.SAV;P777752;a|, IMAGE type, started.
  500.    < Transfer completed.
  501.    !cp r acs.mac (to local file) acs.mac [new file]
  502.    < IMAGE Retreive of <HICKS>ACS.MAC;3 started.
  503.  
  504.  
  505.  
  506.                                                                 [Page 9]
  507.  
  508. User FTP Documentation                          Detailed Command Listing
  509.  
  510.  
  511.    < Transfer completed.
  512.    !copy 1 ? Local file group, *'s ok - TENEX sites only,
  513.     copy 1 ftp.*
  514.     [Confirm]
  515.    < Store of <HICKS>FTP.MAC;1;P777752;A1, IMAGE type, Started.
  516.    < Transfer completed.
  517.    < Store of <HICKS>FTP.SAV;2;P777753;A1, IMAGE type, Started.
  518.    < Transfer completed.
  519.    < copy of <HICKS>FTP.HELP;1;P777752;A1 IMAGE type, Started,
  520.    < Transfer completed.
  521.    !bye
  522.    !< BYE command recieved.
  523.    < Therefore connection terminated.
  524.    logout
  525.    [logout message go here]
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.          [ This RFC was put into machine readable form for entry ]
  533.          [ into the online RFC archives by Gottfried Janik 6/97 ]
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.                                                                [Page 10]
  563.  
  564.