home *** CD-ROM | disk | FTP | other *** search
/ A Beginner's Guide to the Internet / INTERNET.ISO / text / lists / ccinet10 / ftpmail.doc < prev    next >
Encoding:
Text File  |  1996-05-06  |  17.5 KB  |  373 lines

  1. Sender: BITFTP@PUCC.PRINCETON.EDU
  2.  
  3. BITFTP -- Princeton BITNET FTP Server
  4.  
  5. BITFTP provides a mail interface to the FTP command supplied by the IBM
  6. TCP/IP for VM product ("FAL") running on the Princeton University
  7. VM/CMS system, to allow BITNET/NetNorth/EARN users to ftp files from
  8. sites on the Internet.
  9.  
  10. To use BITFTP, send mail containing your ftp commands to
  11. BITFTP@PUCC (or to BITFTP@pucc.Princeton.EDU).
  12.  
  13. The first command in the mail file you send to BITFTP must be "FTP",
  14. "HELP", "VMS", or "FTPLIST".  Use "HELP" to request a current copy of
  15. this help file.  Use "VMS" to request a collection of tips provided by
  16. BITFTP users on how to handle binary files from BITFTP on VMS systems.
  17. Use "FTPLIST" to obtain a list of some of the hosts that allow anonymous
  18. ftp.  (Note that there is no guarantee that BITFTP can access all the
  19. hosts in that list.)
  20.  
  21. The recommended syntax for FTP requests is:
  22.  
  23.    FTP hostname NETDATA    --or--    FTP hostname XXENCODE
  24.    USER username password
  25.    <other ftp subcommands>
  26.    QUIT
  27.  
  28. For "hostname", specify the name (e.g., "Bambleweeny57.Princeton.EDU")
  29. or IP address (e.g., "128.112.64.12") of the host from which you wish
  30. to request files.  Following the hostname on the FTP command, you may
  31. specify "NETDATA" or "UUENCODE" or "XXENCODE" to tell BITFTP the format
  32. in which you wish to receive files.  Please use NETDATA format if you
  33. can, as it imposes a substantially smaller burden on both BITFTP and
  34. the network.  (Users inside IBM will be able to receive NETDATA files
  35. only if they send their requests to BITFTP via the VNET/BITNET gateway,
  36. rather than via the VNET/Internet gateway.)
  37.  
  38. The "username" in your request should be the userid that owns the files
  39. you wish to request.  If the username in your ftp request is
  40. "anonymous", no password is required; BITFTP will use your userid and
  41. and its own nodeid for the password.  If the username is not
  42. "anonymous", then you must specify the password appropriate for the
  43. username.  Note that on many systems passwords are case-sensitive; that
  44. is, the password may be required to be in lower case or mixed case or
  45. upper case.  (The same is true of directory and file names.)
  46.  
  47. The following is an example of an ftp request:
  48.  
  49.    FTP nis.nsf.net
  50.    USER anonymous
  51.    cd introducing.the.internet
  52.    get intro.to.ip
  53.    get network.gold
  54.    get where.to.start
  55.    get zen.ps
  56.    get zen.txt
  57.    QUIT
  58.  
  59. It connects to the host nis.nsf.net and requests five files from the
  60. "introducing.the.internet" directory of that host's anonymous login.
  61.  
  62. If the host you wish to connect to uses a non-standard ftp port, you can
  63. specify that port number on the FTP command immediately following the
  64. hostname field.  (This will be required only in unusual circumstances.)
  65.  
  66. BITFTP implements a subset of the ftp subcommands provided in IBM
  67. TCP/IP for VM and uses the same syntax.  Therefore, you may find it
  68. useful to obtain the IBM "TCP/IP for VM User's Guide", IBM order number
  69. SC31-6081.
  70.  
  71. The currently supported subcommands are:
  72.  
  73.   ACCT        -- to send host-dependent account information.
  74.     format:   ACCT account-information
  75.  
  76.   ASCII       -- to change the file transfer mode to ASCII.
  77.     format:   ASCII
  78.  
  79.   BINARY      -- to change the file transfer mode to image.
  80.     format:   BINARY <FIXED record-len> <VARIABLE>
  81.  
  82.   CD          -- to change the working directory.
  83.     format:   CD directory
  84.  
  85.   DIR         -- to get a list of directory entries.
  86.     format:   DIR
  87.  
  88.   EBCDIC      -- to change the file transfer mode to EBCDIC
  89.     format:   EBCDIC
  90.  
  91.   GET         -- to get a file from the foreign host.
  92.     format:   GET foreignfile <localfile>
  93.  
  94.               If you specify "localfile", it must be in
  95.               the forms "filename.filetype" or "filename",
  96.               and the filename and filetype may each be no
  97.               more than 8 characters long and may not contain
  98.               periods.  If the host you are FTPing to is a
  99.               VM/CMS system, then you should specify the
  100.               "foreignfile" as "filename.filetype"; that is,
  101.               the parts of the name should be separated by
  102.               periods, rather than blanks as they normally
  103.               are for CMS file names.
  104.  
  105.   LS          -- to list the files in a directory.
  106.     format:   LS <name>
  107.  
  108.   MODE        -- to specify Stream or Block as the file transfer
  109.                  mode.
  110.     format:   MODE <S|B>
  111.  
  112.   PWD         -- to print the working directory.
  113.     format:   PWD
  114.  
  115.   QUIT        -- to disconnect from the foreign host.
  116.     format:   QUIT
  117.  
  118.   SYSTEM      -- to get the name of the foreign host's operating
  119.                  system.
  120.     format:   SYSTEM
  121.  
  122.   TYPE        -- to specify ASCII ("A"), image ("I"), Kanji Shift
  123.                  JIS ("B"), EBCDIC ("E"), or EBCDIC IBM Kanji ("F")
  124.                  as the file transfer mode.
  125.     format:   TYPE <A|I|B|E|F>
  126.  
  127. BITFTP does not provide a PUT capability, and there is no intention to
  128. make it do so in the future, nor does it provide an MGET capability.
  129.  
  130. BITFTP accepts requests via RFC822-format mail, IBM NOTE-format mail
  131. (with headers in English, French, German, or Danish), PROFS-format
  132. messages, or files with no headers at all sent via RSCS.  It returns the
  133. requested files as NETDATA-format files or as mail files containing
  134. uuencoded or xxencoded data.  If you specify "UUENCODE", "XXENCODE", or
  135. "NETDATA" on your "FTP" command, BITFTP will attempt to use the format
  136. you request.  If you do not specify the format, BITFTP will attempt to
  137. select the appropriate format for your node.
  138.  
  139. BITFTP attempts to determine your return address by parsing the mail
  140. file it receives from you.  It uses the address specified in a
  141. "Reply-to:" line in the mail headers in preference to the address
  142. specified in the "From:" line.  If you specify a "PATH" command in the
  143. body of the mail, that address will be used in preference to either the
  144. "Reply-to:" or "From:" address.  The format of a "PATH" command is
  145. simply "PATH userid@nodeid".  If you are on BITNET/EARN/NetNorth, you
  146. should not specify a path.  In general, you need specify a path only if
  147. you get no response from requests to BITFTP otherwise.
  148.  
  149. BITFTP will not send you a file that contains more than 17825792
  150. bytes of data.  It will not send you more than 15000 lines of
  151. directory listings as the result of one request file.  Uuencoded and
  152. xxencoded files are broken up into mail files that contain no more than
  153. 750 records (containing 62 bytes each).  NETDATA-format files
  154. that are larger than 900000 bytes are sent in 900000-byte pieces
  155. using the BITSEND function.  You should be able to receive such files
  156. using the BITRCV function available from your nearest NETSERV.  (If you
  157. do not know how to use NETSERV, ask your local BITNET/EARN/NetNorth
  158. Coordinator for assistance.  Users inside IBM can get help with BITRCV
  159. from the BITNET FORUM.)  To recover the original file when BITRCV is not
  160. available for your system, use the command you normally use to receive
  161. NETDATA-format files and then catenate the files in the order shown in
  162. the BITRCV control file.
  163.  
  164. Users in the UK should note that BITFTP attempts to send NETDATA-format
  165. files through the gateway from EARN into Janet using the NIFTP facility
  166. at Rutherford Lab.  Receiving files via NIFTP requires an overt action
  167. on your part.  If you are at a Janet node and don't know how to use
  168. NIFTP, you should ask for assistance locally.  Alternatively, you can
  169. ask BITFTP to send your files encoded inside mail by specifying the
  170. "UUENCODE" or "XXENCODE" option on the FTP command.
  171.  
  172. If BITFTP sends you a file you cannot read, THE FIRST THING TO DO is to
  173. make sure that you specified "ASCII" if the file should contain textual
  174. material (or "EBCDIC" for text files from an IBM system), or that you
  175. specified "BINARY" if the file should contain binary data, executable
  176. programs, tar files, or the like.
  177.  
  178. User on IBM systems (VM/CMS or MVS/TSO) should specify "MODE B" (for
  179. "Block") when requesting files from other IBM systems, in order to
  180. preserve the record structure of the files.
  181.  
  182. VMS users should use RECEIVE/BINARY to receive the NETDATA-format binary
  183. files BITFTP sends to them.
  184.  
  185. If BITFTP sends you a uuencoded file that you cannot uudecode, the
  186. first thing to do is to translate all occurrences of 0x7E in the file to
  187. 0x5E and then try uudecoding again.  (Some gateways change 5Es to 7Es
  188. when the files pass through them.)
  189.  
  190. There are many different flavors of UUENCODE/UUDECODE.  The version that
  191. BITFTP uses puts a "guard character" (the letter "M") at the end of
  192. each encoded line (to prevent the removal of trailing blanks in the
  193. encoded data).  Most implementations of uudecode know to ignore this
  194. character.  If yours does not, then you should remove the "M" at the end
  195. of each line before attempting to uudecode the file.
  196.  
  197. When BITFTP is told to transfer a file in FIXED format, such as "BINARY
  198. FIXED 512", it will create a file whose total byte count is an integral
  199. multiple of the record length (512, in this case).  This means that the
  200. last record may be padded with binary zeros to get it to the specified
  201. record length.  In such a case, you may need to use an editor to shorten
  202. the last record so that the total byte count of the file is correct.
  203. (If the file is encoded when you receive it, shorten it AFTER you have
  204. decoded it.)
  205.  
  206. In addition to any files you request, you will also receive a mail file
  207. containing a log of your ftp session.  In that mail file, entries
  208. prefixed by ">" are your original commands; those prefixed by ">>" are
  209. your commands as interpreted by BITFTP and passed to FAL; those
  210. prefixed by ">>>" are your commands as interpreted by FAL and passed to
  211. the remote host; those prefixed by "<<<" are messages from the remote
  212. host; and those prefixed by ">>>>" are completion messages from BITFTP.
  213.  
  214. If BITFTP is unable to connect to the host you specify, it will send
  215. you mail after the first attempt, but will keep trying at intervals over
  216. two days.  The only additional mail file you will receive will be when
  217. the connection is made successfully or when BITFTP gives up after two
  218. days.
  219.  
  220. The load on BITFTP is often very heavy, and network backlogs are often
  221. so great that it may take several days for a file to get to you once
  222. BITFTP sends it on its way, so please be patient and don't send
  223. multiple requests for the same file.  If your system allows you to send
  224. interactive messages, you can inquire about BITFTP's backlog by sending
  225. the query "How are you?", e.g., on a VM system:
  226.  
  227.    TELL BITFTP AT PUCC How are you?
  228.  
  229. Questions about BITFTP and suggestions for improvements should be sent
  230. to Melinda Varian, MAINT@PUCC on BITNET or MAINT@PUCC.Princeton.EDU on
  231. the Internet.  When you have a problem, it helps if you send along a log
  232. mail file from BITFTP that illustrates the problem.  (Please send the
  233. entire mail file, including the mail headers.)
  234.  
  235. The author gratefully acknowledges the use of the SENDJANI EXEC written
  236. by Alan Flavell and an RFC822 parsing routine written by Eric Thomas.
  237. NOTE:  If you have any complaints or suggestions about the way any of
  238. these routines work in BITFTP, please send them to MAINT@PUCC (Melinda
  239. Varian), not to those authors.
  240.  
  241.  
  242. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  243.  
  244. From:  "ftpmail service on ftp-gw-1.pa.dec.com"   >INTERNET:nobody@pa.dec.com
  245. Subj:  your ftpmail request has been received [help]
  246.  
  247. Sender: nobody@ftp-gw-1.pa.dec.com
  248.   -- Help --
  249. >>> $Id: help-text,v 1.7 1993/05/05 00:49:43 vixie Exp $
  250. >>>
  251. >>> ftpmail is not a supported service. From time to time it stops working;
  252. >>> we will tend to it when we get the time. Outages of a week or more are not
  253. >>> abnormal. 
  254.  
  255. >>> commands are:
  256.  
  257.         reply <MAILADDR>        set reply addr, since headers are usually wrong
  258.         connect [HOST [USER [PASS [ACCT]]]]
  259.                                 defaults to gatekeeper.dec.com, anonymous
  260.         ascii                   files grabbed are printable ascii
  261.         binary                  files grabbed are compressed or tar or both
  262.         chdir PLACE             "get" and "ls" commands are relative to PLACE
  263.                                         (only one CHDIR per ftpmail session,
  264.                                         and it executes before any LS/DIR/GETs)
  265.         compress                compress binaries using Lempel-Ziv encoding
  266.         compact                 compress binaries using Huffman encoding
  267.         uuencode                binary files will be mailed in uuencode format
  268.         btoa                    binary files will be mailed in btoa format
  269.         chunksize SIZE          split files into SIZE-byte chunks (def: 64000)
  270.         ls (or dir) PLACE       short (long) directory listing
  271.         index THING             search for THING in ftp server's index
  272.         get FILE                get a file and have it mailed to you
  273.                                         (max 10 GET's per ftpmail session)
  274.         quit                    terminate script, ignore rest of mail message
  275.                                         (use if you have a .signature or
  276.                                          are a VMSMAIL user)
  277.  
  278. >>> notes:
  279.  
  280.         -> you should send complaints to the ftpmail-admin address.  our
  281.            postmaster does not handle ftpmail problems and you can save her
  282.            the trouble of forwarding your complaints by just mailing them to
  283.            the right address.  the "ftpmail-request" address is gone; don't
  284.            use it.
  285.  
  286.         -> the "index" command depends on the "SITE EXEC INDEX" feature of
  287.            some ftp servers.  Gatekeeper.dec.com originated this feature,
  288.            and ftp.uu.net duplicated it (with a format change to the output,
  289.            naturally).  Wuarchive.wustl.edu also has this feature, though
  290.            their index seems to be empty.  The source for an ftpd that
  291.            supports this feature is on Gatekeeper.DEC.COM in /pub/DEC/gwtools.
  292.  
  293.         -> a password of "" or '' will be sent as a null string.  if you need
  294.            this you will know it, if you don't, you won't.
  295.  
  296.         -> the "Subject:" of your request will be contained in the "Subject:"
  297.            of all of ftpmail's responses to you regarding that request.  You
  298.            can therefore use it to "tag" different requests if you have more
  299.            than one outstanding at any given time.
  300.  
  301.         -> you must give a "connect" command, default host is
  302.            gatekeeper.dec.com, default user is anonymous, default
  303.            password is your mail address with a hyphen prepended.
  304.  
  305.         -> binary files will not be compressed unless 'compress' or 'compact'
  306.            command is given; use this if at all possible, it helps a lot.
  307.            note that many files are already compressed.  if you use any of
  308.            the binary-file qualifiers (compress, compact, uuencode, btoa)
  309.            without setting 'binary' first, your session will abort in error.
  310.  
  311.         -> binary files will always be formatted into printable ASCII
  312.            with "btoa" or "uuencode" (default is "btoa").  if you don't
  313.            use the "binary" command, ftpmail will cheerfully try to mail
  314.            you the binary data, which will absolutely, positively fail.
  315.  
  316.         -> all retrieved files will be split into chunks and mailed.  the
  317.            size of the chunk is 64000 characters unless you change it with
  318.            the "chunksize" command.  CompuServe users will need to set this
  319.            to 49000.  there is no way to set it higher than 100000, so please
  320.            don't ask.
  321.  
  322.         -> if you ask for more than 10 files in a session, you will receive
  323.            an error message and your entire request will be rejected.
  324.  
  325.         -> VMS/DOS/Mac versions of uudecode, atob, compress and compact
  326.            are available, ask your LOCAL wizard about them if you can't
  327.            locate them (but try gatekeeper.dec.com in /archive/pub/VMS
  328.            if you're still using a VMS system.)
  329.  
  330.         -> several mail unsplitters are hiding on gatekeeper.dec.com in
  331.            /pub/mail/ua/misc/unsplit.  there is one in c, one in perl,
  332.            and one in VMS DCL.
  333.  
  334.         -> there is no way to request only certain parts of a file and we
  335.            do not plan to add one in the near future, so please don't ask.
  336.  
  337.         -> there is no way to delete things from the queue or to find out
  338.            the status of things in the queue, and we do not plan to add
  339.            either feature in the near future, so please don't ask.
  340.  
  341. >>> examples:
  342.  
  343.         -> connect to gatekeeper.dec.com and get a root directory listing:
  344.                 connect
  345.                 ls
  346.                 quit
  347.  
  348.         -> connect to gatekeeper.dec.com and get the README.ftp file:
  349.                 connect
  350.                 get README.ftp
  351.                 quit
  352.  
  353.         -> connect to gatekeeper.dec.com and get the gnuemacs sources:
  354.                 connect
  355.                 binary
  356.                 uuencode
  357.                 chdir /pub/GNU
  358.                 get emacs-18.58.tar.Z
  359.                 quit
  360.  
  361.         -> connect to ftp.uu.net as anonymous and get a root directory list:
  362.                 connect ftp.uu.net
  363.                 binary
  364.                 chdir /index/master
  365.                 get by-name.Z
  366.                 quit
  367.  
  368. Ftpmail was written by Paul Vixie while at the DEC Western Research Laboratory
  369. and at the DEC Network Systems Laboratory, from 1989-1993.  Ftpmail is not a
  370. product or service of Digital Equipment Corporation and no support or warranty
  371. is expressed or implied.
  372.   -- End of Help --
  373.