home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / upc12bad.zip / sunarch.inf < prev    next >
Text File  |  1991-07-07  |  9KB  |  227 lines
  1. Copyright 1989, 1990 Michael DeCorte
  2.  
  3.  
  4.                    Help File for The Archive Server
  5.  
  6. The archive server is a program that gives you the ability to retrieve
  7. files via electronic mail.  It is a very dumb program with little error
  8. detection.  Thus if you make mistakes, you won't get what you wanted.
  9. This also means that you can ask it to do unreasonable things, but
  10. please don't.
  11.  
  12. To make the archive server do something you should send an electronic
  13. mail message to archive-server@sun.soe.clarkson.edu.  The body of the
  14. message should consist of one command per line.  The case of the text
  15. does not matter.
  16.  
  17. The archive is grouped together via directories.  Each directory is
  18. considered an archive.  An example archive is "latex-style."  Associated
  19. with each archive is an index file as well as a top level index file
  20. that lists all of the archives.  You can find out what archives are
  21. available with the command "index."
  22.  
  23. Supported commands:
  24.  
  25.   help
  26.  
  27.     Sends you this file.
  28.  
  29.   path <mail-path>
  30.  
  31.     "Path" is used to override the mail path that the archive server
  32.     chooses from the header of your mail message.  You should use this
  33.     whenever you know that the return address of your message will not
  34.     be useful to the archive server.  The archive server only knows
  35.     about domain style address.  This means that the archive-server
  36.     understands name@site.bitnet and name@site.edu and name@site.UUCP
  37.     but does not understand name@site.  If you have any doubts about
  38.     your mail address, you should ask your system administrator for a
  39.     correct domain style address.  An example use of "path" is
  40.  
  41.        path mrd@sun.soe.clarkson.edu
  42.  
  43.   index [archive...]
  44.  
  45.     "Index" mails to you a listing of the files in the specified
  46.     archives.  If an archive is not specified, then the index of the
  47.     available archives will be sent.
  48.  
  49.   send <archive> <file..>
  50.  
  51.     "Send" mails to you the files in the specified archive.  All of
  52.     the files that you request will be sent to you archived together
  53.     (see "archiver"), possible packed (see "pack"), possible encoded
  54.     (see "encoder") and split up into messages that are small enough
  55.     to be mailed (see "size").  If you specify an archive and do not
  56.     specify any files, then all of the files in that archive will be
  57.     sent.  You may have as many "sends" in the body of your mail
  58.     message as you wish.
  59.  
  60.   encodedsend <archive> <file...>
  61.  
  62.     "Encodedsend" is identical to the command "send" except that the
  63.     files are guaranteed to be encoded (see "encoder").  This is
  64.     useful if you know that the return message will go through EBCDIC
  65.     based computers.
  66.  
  67.   archiver <archiving-method>
  68.  
  69.     You may specify the method of archiving (merging a group of files
  70.     into one large file) the files with "archiver".  By default, files
  71.     that are mailable are simply stuck together with the text "cut
  72.     here" between files and; non-mailable files are archived via unix
  73.     tar.  The available archiving methods are:
  74.  
  75.       arc (the PC program)
  76.       dclshar (VMS, creates a file you can unpack with @FILE.COM)
  77.       none (the files are simply stuck together)
  78.       shar (Unix sh script)
  79.       simple (the files are separated by "cut here" - default)
  80.       tar (Unix Tar - default for non mailable files)
  81.       zoo (Unix, VMS, PC's)
  82.  
  83.   pack <packing-method>
  84.  
  85.     You may specify that the files be packed (compressed) before
  86.     delivery.  This has the advantage that the mail files will be
  87.     smaller.  By default the files are not packed. The available
  88.     packing methods are:
  89.  
  90.      compress    (the Unix command compress)
  91.      compact     (the Unix command compact - slower than compress)
  92.      none
  93.  
  94.   encoder <encoding-method>
  95.  
  96.     Non-mailable files must be converted to something mailable.  By
  97.     default this is done with "uuencode".  You may also specify that
  98.     the files must be encoded with the command "encodedsend."  The
  99.     available encoding methods are:
  100.  
  101.       btoa
  102.       rscs
  103.       uuencode (default)
  104.  
  105.   size <max-file in bytes>
  106.  
  107.     The archive server splits files up so that they are smaller than
  108.     this limit.  This is done because many sites have a maximum mail
  109.     size limit.  A value of 0 means that there is no limit.  The
  110.     archive server has a default size limit of 100000 bytes.  You may
  111.     change this if you know that you have different limits.  Most (but
  112.     not all) uucp sites have a limit of 100000 bytes.  Internet and
  113.     Bitnet sites should set this to 300000 bytes.
  114.  
  115.   length <number>
  116.  
  117.     Many mailers will truncate long lines.  To overcome this the
  118.     archive server encodes files that contains lines that are longer
  119.     than 130 characters (see "encoder").  If you know that your mail
  120.     files will not be truncated then you can set this value to
  121.     something larger.
  122.  
  123.   limit <number>
  124.  
  125.     The archive-server limits the amount of data that will be returned
  126.     by any one request.  This limit is very large.  By using this command
  127.     you may lower this limit.  This is typically done to prevent errors
  128.     by the user.
  129.  
  130.   search <string> <archive> <file...>
  131.  
  132.     You may search through the archive for a string.  A string is
  133.     considered to be any sequence of alphanumeric characters; case
  134.     does not matter.  If you only provide an archive name then all of
  135.     the files in the archive will be searched.  You will be returned
  136.     all lines that contain the string.
  137.  
  138.   find  <string...>
  139.  
  140.     You may search for file names that contain the given string.  Case
  141.     is significant in the string.  You will be returned all file names
  142.     that match the given string.
  143.  
  144.   language <string>
  145.  
  146.     This will allow you to change the language that the help files are in
  147.     to the named language.  English is the only supported language right
  148.     now though so this command doesn't really do anything yet.
  149.  
  150.  
  151.                                EXAMPLE
  152.  
  153. Here is an example message that you could send to the archive-server.
  154. It gives an example of all the supported commands.
  155.  
  156. ------
  157. help
  158. language english
  159. path mrd@sun.soe.clarkson.edu
  160. index latex-style isetl
  161. encodedsend latex-style res.sty res-sample.tex
  162. send isetl
  163. archiver tar
  164. pack compress
  165. encoder rscs
  166. size 200000
  167. length 80
  168. search resume texhax texhax.89.001 texhax.89.002
  169. find resume
  170. -----
  171.  
  172.                                APPENDIX
  173.  
  174. 1) Files are considered mailable if they do not have any lines longer
  175. than 130 characters and do not have any characters other than tabs,
  176. carriage returns, newlines, vertical tabs, formfeeds and characters
  177. between space through tilde (using ascii ordering).
  178.  
  179. 2) If you have problems or questions, you should send mail to
  180. archive-management@sun.soe.clarkson.edu.
  181.  
  182. 3) If you need to retrieve a large number of files or very large files
  183. then I strongly encourage you to obtain the archives on magnetic tape
  184. via US-mail.  If you choose to do this then mail a self-addressed
  185. stamped tape (8mm, 1/4 inch, 1/2 inch) with a check for $20 made to
  186. Clarkson University and a list of the archives that you want (eg
  187. latex-style and texhax) to:
  188.  
  189. Rob Logan
  190. ERC
  191. Clarkson University
  192. Potsdam NY 13676
  193. 315-268-2292
  194.  
  195. You can ask for as many archives as will fit on the tape but you can not
  196. ask for individual files.  The tape will be written in Unix tar format.
  197. Unless you specify otherwise the tape will be written at the highest
  198. possible density.  (1/2 inch @ 6250 BPI, 8mm @ 2.3 G/tape, 1/4 inch @ 60
  199. M/tape).  If you do not live in the USA, we will provide postage if you
  200. send a self-addressed tape without stamps and a check for $40 instead of
  201. $20.
  202.  
  203. NOTE:  if the tape is not self-addressed and stamped we will keep that
  204. tape and use it for backups.
  205.  
  206. To obtain a list of top level archives (eg. latex-style, ISETL,
  207. Freemacs) send a self addressed envelope to the above address.
  208.  
  209. For your information, the money is used to pay a student to copy the
  210. tapes; any money left over is put into an account to be used eventually
  211. to buy a disk drive dedicated to the archive server.  Contributions are
  212. strongly encouraged.
  213.  
  214. 4) If you have an archiving, packing, encoding program that runs under
  215. BSD Unix that I do not have and you would like me to support then please
  216. send it to me.  It is very easy to incorporate it into this package.
  217.  
  218. 5) If you would like to convert the various help files to another
  219. language please contact me.
  220.  
  221. 6) The archive server was written by Michael DeCorte.  It consists of a
  222. groups of bourne shell and awk scripts designed to work under BSD Unix
  223. based computers.  There are no restrictions on its redistribution
  224. provided the copyright notice is left intact.
  225.  
  226. 7) Unix is a registered trademark of AT&T.
  227.