home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 17 / CD_ASCQ_17_101194.iso / vrac / intrhelp.zip / ARCHIE.DOC next >
Internet Message Format  |  1994-09-18  |  15KB
  1. Date: Saturday, 17-Sep-94 07:29 AM
  2.  
  3. From: Archie Server            \ Internet:    (archie-errors@forum.ans.net)
  4. To:   Gary Bradford            \ PRODIGY:     (ABMM81A)
  5.  
  6. Subject: archie [help] part 1 of 1
  7.  
  8. String is: Sat, 17 Sep 94 07:29 -0500
  9. Y L BRADFORD)
  10.  
  11. >> help
  12.                 Archie Email Help (Version 3.0)
  13.  
  14. HELP for the archie email server, as of 10 April, 1993.
  15.  
  16. To perform an archie search via email, send mail to
  17.  
  18.         archie@<archie_server>
  19.  
  20. Where <archie_server> is the name of an archie host.
  21.  
  22. The current (and complete) list of archie servers can be found with the
  23. "servers" command (described below). A sample list is:
  24.  
  25.     archie.au*                  139.130.4.6     Australia
  26.     archie.edvz.uni-linz.ac.at* 140.78.3.8      Austria
  27.     archie.univie.ac.at*        131.130.1.23    Austria
  28.     archie.uqam.ca*             132.208.250.10  Canada
  29.     archie.funet.fi             128.214.6.100   Finland
  30.     archie.th-darmstadt.de*     130.83.22.60    Germany
  31.     archie.ac.il*               132.65.6.15     Israel
  32.     archie.unipi.it*            131.114.21.10   Italy
  33.     archie.wide.ad.jp           133.4.3.6       Japan
  34.     archie.kr*                  128.134.1.1     Korea
  35.     archie.sogang.ac.kr*        163.239.1.11    Korea
  36.     archie.rediris.es*          130.206.1.2     Spain
  37.     archie.luth.se*             130.240.18.4    Sweden
  38.     archie.switch.ch*           130.59.1.40     Switzerland
  39.     archie.ncu.edu.tw*          140.115.19.24   Taiwan
  40.     archie.doc.ic.ac.uk*        146.169.11.3    United Kingdom
  41.     archie.unl.edu              129.93.1.14     USA (NE)
  42.     archie.internic.net*        198.48.45.10    USA (NJ)
  43.     archie.rutgers.edu*         128.6.18.15     USA (NJ)
  44.     archie.ans.net*             147.225.1.10    USA (NY)
  45.     archie.sura.net*            128.167.254.179 USA (MD)
  46.     
  47. Sites marked with an asterisk '*' run archie version 3.0
  48.  
  49.  
  50. If you do not get mail back within 1 day or so, try using the "path" command
  51. described below.
  52.  
  53.  
  54. Mail destined for the administration of individual servers should be
  55. addressed to:
  56.  
  57.         archie-admin@<archie_server>
  58.  
  59. To request the additon or deletion of a site from the archie database, send
  60. mail to:
  61.  
  62.         archie-admin@bunyip.com
  63.  
  64.  
  65. To contact the implementors of archie, send mail to:
  66.  
  67.         archie-group@bunyip.com
  68.  
  69. For your information anonymous FTP may be performed through the mail by
  70. various ftp-mail servers. Send a message with the word 'help' in it to:
  71.  
  72. For BITNET/EARN sites ONLY:
  73.  
  74.                 bitftp@pucc.princeton.edu
  75.  
  76. or (general access):
  77.  
  78.                 ftpmail@decwrl.dec.com
  79.  
  80. for an explanations on how to use them.
  81.  
  82. The "Subject:" in mail sent to archie is treated as part of the message
  83. body.
  84.  
  85. Command lines begin in the first column. All lines that do not match a valid
  86. commands are ignored. 
  87.  
  88. Under version 3.0 the email client implements all the non-interactive
  89. commands and variables of the telnet client. However, interactive commands
  90. like "pager" are not supported as they don't make much sense in the email
  91. environment.
  92.  
  93. For a complete explanation of the the archie system use the "manpage"
  94. command to request a copy of the manual page, what follows is a short
  95. summary of the valid email commands and variables.
  96.  
  97. NOTE: The "site" command of earlier versions of archie has been disabled
  98.       under version 3.0 until it can be reimplemented with the new
  99.       architecture of the system.
  100.  
  101. "Quick and dirty" summary
  102. -------------------------
  103.  
  104. For those of you who want to get something done now and read the rest of
  105. this later, send the email to an archie server with the line:
  106.  
  107.         find <foo>
  108.  
  109. (where <foo> is the name of the file you are looking for). You should get a
  110. message back with results of your search. If you want to be a bit more
  111. sophisticated, read on....
  112.  
  113.  
  114. Commands
  115. --------
  116. In the commands that follow, parameters between '[' and ']' are optional.
  117. The ellipsis ("...") signifies that the previous parameter can be repeated
  118. multiple times. A '|' character means "or".
  119.  
  120.  
  121. help [ <topic> [[ <subtopic> ] ...]]
  122.  
  123.                 The "help" command by itself produces this message.
  124.  
  125.                 An optional topic and subtopic(s) may also be given.  A
  126.                 list of words is considered to be one topic, not a list
  127.                 of individual topics. Thus, 
  128.  
  129.                         help set maxhits
  130.  
  131.                 requests help on the subtopic 'maxhits' of topic 'set',
  132.                 not on two separate topics.
  133.  
  134.  
  135. find <pattern>  This command produces a list of files matching the pattern
  136.                 <pattern>.  The <pattern> may be interpreted as a simple
  137.                 substring, a case sensitive substring, an exact string or
  138.                 a regular expression, depending on the value of the
  139.                 variable search.
  140.  
  141. prog <pattern>  This is identical to "find" and is included for backward
  142.                 compatibility with older versions of the system.
  143.  
  144.  
  145. list [ <pattern> ]
  146.  
  147.                 Produce a list of sites whose contents are contained in
  148.                 the archie database. With no argument all the sites are
  149.                 listed. If given, the <pattern> argument is interpreted
  150.                 as a regular expression (see the archie manual page for
  151.                 an explanation of regular expressons) against which to
  152.                 match site names: only those names matching are printed.
  153.                 The format of the output can be selected through the
  154.                 output_format variable (described below).
  155.  
  156.                 Note that the numerical (IP) address associated with a
  157.                 site name is valid at the time the site was last updated
  158.                 in the archie database, but may have changed subseqently.
  159.  
  160. mail <address>  Mail the results generated up until this command to
  161.                 <address>. This must be a vaid email address.
  162.  
  163. manpage [ roff | ascii ]
  164.  
  165.                 Return the archie manual page. The optional arguments
  166.                 specify the format of the returned document. "roff"
  167.                 specifies UNIX troff (or nroff) format, while ascii
  168.                 specifies plain, preformatted ASCII output. With no
  169.                 arguments it defaults to ascii. 
  170.  
  171. motd            Re-display the "message of the day", which is normally
  172.                 printed at the start of the returned message.
  173.  
  174. path <address>  Set the return address to <address>. This overrides the
  175.                 default path which the system automatically generates by
  176.                 looking at the incoming mail header. This is actually an
  177.                 alias for "set mailto <address>" (see "Variables" below),
  178.                 and is included for backwards compatability.
  179.  
  180. servers         Display a list of all publicly accessible archie servers
  181.                 worldwide. The names of the hosts, their IP addresses and
  182.                 geographical locations are listed.
  183.  
  184. domains         Give a list of the archie pseudo-domains that the archie
  185.                 server supports. See the manual page for an explanation
  186.                 of archie pseudo-domains.
  187.  
  188. set <variable> <value>
  189.  
  190.                 Set the specified <variable> to <value>. See "Variables"
  191.                 below. 
  192.  
  193. show [ <variable-name>...]
  194.  
  195.                 Without any parameters, display the status of all the
  196.                 user-settable variables, including such information as
  197.                 its type (boolean, numeric, string), whether or not it is
  198.                 set and its current value (if its type requires a
  199.                 value).  Otherwise show the status of each of the
  200.                 specified arguments. Useful for finding out what the
  201.                 default settings at a server are.
  202.  
  203. unset <variable>
  204.                 Unset the specified <variable>. The subsequent value of
  205.                 the variable is defined on a <variable>-specific basis.
  206.  
  207. version
  208.                 Print the current version of the email interface.
  209.  
  210. whatis <substring>
  211.  
  212.                 Search the Software Description Database for the given
  213.                 substring, ignoring case.  This database consists of
  214.                 names and short descriptions of many software packages,
  215.                 documents (like RFCs and educational material), and data
  216.                 files stored on the Internet.
  217.  
  218.                 Note that this database is currently maintained by hand
  219.                 and may not be completely up-to-date. 
  220.  
  221. Variables
  222. ---------
  223.  
  224. The archie email system has 3 types of variables.
  225.  
  226. 1) Numeric
  227. ----------
  228.  
  229. Numeric variables may have preset internal ranges in which the value of the
  230. variable must lie.
  231.  
  232.  
  233. maxhits         Allow the "find" command to generate at most the
  234.                 specified number of matches (hits) (permissible range:
  235.                 0-1000). Default 100.
  236.  
  237. maxhitspm       Maximum number of files (hits) per filename located in
  238.                 the find command. See the manual page for more
  239.                 information. Range 0-1000. Default 100.
  240.  
  241. maxmatch        Maximum number of filenames to return with the find
  242.                 command. This is NOT the same as maxhits which limits the
  243.                 total number of files returned. See the manual page for
  244.                 more information. Range 0-1000. Default 100.
  245.  
  246. max_split_size  Approximate maximum size, in bytes, of a file to be mailed
  247.                 to the user. Any output larger than this limit will be
  248.                 split in pieces of about this size.  This can be set by
  249.                 the user in the range 1024 to ~2Gb with a default of
  250.                 51200 bytes. Some mail gateways will not allow results of
  251.                 over 100Kb and so care should be taken when setting this
  252.                 limit.
  253.  
  254. 2) String
  255. ---------
  256.  
  257. String variables may have a predefined range of values.
  258.  
  259.  
  260. compress
  261.                 The kind of data compression the user can specify when
  262.                 mailing back output.  Currently allowed values are
  263.                 "none" and "compress" (standard UNIX compress program)
  264.                 with a default of "none"
  265.  
  266. encode          The type of post-compression encoding the user can
  267.                 specify when mailing back output.  Currently allowed
  268.                 values are "none" and "uuencode", with a default
  269.                 of "none". Note that this variable is ignored unless
  270.                 compression is enabled (via the compress) variable.
  271.  
  272. language        Allows the user to specify the language in which the
  273.                 help, etc. is presented. Individual servers may be
  274.                 configured for a range of languages.
  275.  
  276. mailto          A valid address to mail the results back to. This overrides
  277.                 the address automatically generated by the archie system
  278.                 from the incoming mail header. Setting this variable is
  279.                 equivalent to using the "path" command.
  280.  
  281. match_domain    Restrict the returned files to sites in the
  282.                 colon-separated list of domains and pseudo-domains. See
  283.                 the manual page for further information.
  284.  
  285. match_path      Restrict the files returned in the 'find' command to
  286.                 contain the colon-separated list of pathname components.
  287.                 See the manual page for further information.
  288.                 
  289. output_format   Affects the way the output of "find" and "list" is
  290.                 displayed.  User settable, with valid values of "machine"
  291.                 (machine readable format), "terse" and "verbose", with a
  292.                 default of "verbose".
  293.  
  294. search          The type of search done by the "find" (or "prog") command.
  295.                 The list of valid values is given below in order of
  296.                 increasing search times. The given search string may
  297.                 match a directory or filename in the database.
  298.  
  299.                 exact           String has to match exactly (including case)
  300.                 subcase         Substring match. Case sensitive.
  301.                 sub             Substring match. Case insensitive.
  302.                 regex           Regular expression (see ed(1)) search.
  303.                                 Case sensitive. The archie manual page
  304.                                 gives examples of regular expressions.
  305.                                 
  306.  
  307.                 There are also compound searches made up of combinations
  308.                 of the above search methods in sequence:
  309.  
  310.                 exact_sub       Try "exact". If no matches found use
  311.                                 "sub".
  312.                 exact_subcase   Try "exact". If no matches found use
  313.                                 "subcase"
  314.                 exact_regex     Try "exact". If no matches found use
  315.                                 regex.
  316.  
  317.  
  318.                 Note: unless specifically anchored to the beginning
  319.                 (with ^) or end (with $) of a line, regular expressions 
  320.                 (effectively) have ``.*'' prepended and appended to them.
  321.                 For example, it is not necessary to type
  322.  
  323.                         find .*xnlock.*
  324.  
  325.                 because
  326.  
  327.                         find xnlock
  328.  
  329.                 In this instance, the regex match is equivalent a simple
  330.                 substring match which should be used instead.
  331.  
  332. server          The archie/Prospero server to which the email interface
  333.                 connects when "find" or "list" commands are used. Usually
  334.                 defaults to "localhost" on most archie systems.
  335.  
  336. sortby          Set the method of sorting to be applied to output from
  337.                 the "find" command.
  338.  
  339.                 The five permitted methods (and their associated reverse
  340.                 orders) are:
  341.  
  342.                 none      Unsorted (default; no reverse order, though
  343.                           'rnone' is accepted)
  344.  
  345.                 filename  Sort files/directories by name, using lexical
  346.                           order (reverse order: 'rfilename')
  347.  
  348.                 hostname  Sort on the archive hostname, in lexical order
  349.                           (reverse order: 'rhostname')
  350.  
  351.                 size      Sort by size, largest files/directories first
  352.                           (reverse order: 'rsize')
  353.  
  354.                 time      Sort by modification time, with the most recent
  355.                           file/directory names first (reverse order:
  356. 'rtime')
  357.  
  358.                 
  359. 3) Boolean
  360. ----------
  361.  
  362. Currently the email interface to the archie system has no variables of type
  363. "boolean".
  364.  
  365.  
  366. >> quit
  367.  
  368.  
  369.  
  370.