List Processor 7.O
 
                          Copyright (c) 1993 - 94 by 
        The Corporation for Research and Educational Networking (CREN)
 
Here is a brief description of the set of user requests recognized by the 
ListProcessor.  This file is intended only as a reference guide to list 
processor requests.  For a complete explanation of how the list processor 
works, more detailed information on requests listed below, and examples of how 
to submit requests to the listprocessor, please read the Listprocessor User 
Manual.  

Everything appearing in [] below is optional; everything appearing in <> is 
mandatory; all arguments are case insensitive. The vertical bar ("|") is used 
as a logical OR operator between the arguments. Please note that the brackets 
or braces or parentheses themselves are NEVER a part of the request.  In the 
syntax examples below, the word "list" must be replaced by the name of the 
list for which your request applies.  In cases where a password is called for, 
the word "password" must be replaced by your list password or a password given 
you by the list owners.  Requests may be abbreviated, but you must give at 
least as many characters as needed to distinguish the request from other 
requests or at least enter the first three characters. 

Keep in mind that when referring to a <list>, that list may be of two kinds: 
local or remote, unless otherwise noted.  Local lists are those which are run 
from the same host to which you are sending your e-mail request.  Remote lists 
are those running on other hosts.  When referring to a local list, your 
request will be immediately processed; when referring to a remote list (a list 
served by another ListProcessor on another machine which this system knows 
about), your request will be appropriately forwarded. Issue a 'LISTS' request 
to get a listing of all local and known remote lists to this ListProcessor. 

Recognized requests are:

HELP [topic]

Without arguments a file giving a brief description of all requests. Otherwise 
get specific information on the selected topic. Topics may also refer to 
requests. To learn more about this system issue a 'HELP LISTPROC' request. To 
get a listing of all available topics, send a message saying 'HELP ALL'.

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

LISTS [local|global [keywords]]

Get a list of all local mailing lists served by this server (LISTS LOCAL), or
of all known local and remote lists (LISTS GLOBAL) and a one line description
of each list. You MUST specify local or global in a LISTS request.  Adding a
keyword to the LISTS request causes the listprocessor to search only for those
lists containing that keyword in its list name or one line description.  If
multiple keywords are specified, they are treated as a logically ANDed list
of strings/regular expressions, that is, only names of lists containing ALL
of the keywords will be returned. Keywords can be surrounded by quotes but
that is not required. Only those lists' descriptions that match the keywords
are listed. 

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

RELEASE
VERSION

Get information about the current release of this ListProcessor system.

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

INFORMATION [list]

This file if no list is specified, otherwise get information about the 
specified list.

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

RECIPIENTS <list>

Get a list of all recipients (subscribers) of one list.  The review request 
can also be used for this purpose.

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

REVIEW <list> [short|description|subscribers]


Every list has associated with it a series of attributes which determine how 
the list operates and what privleges you have in sending requests to the 
listprocessor concerning the list.  The review request allows you to get the 
list's attributes or settings.   Review <list> will send you a short file of 
general information about the list and a listing of the current unconcealed 
subscribers for the specified list.  "Review <list> short" or "review <list> 
description" will result in your receiving only the short description file, 
not the subscribers.  "Review <list> subscribers" allows you to get only the 
non-concealed subscribers list. If a list is private, members only may issue 
this request. If the list is linked with any peer lists, your request will be 
forwarded to the appropriate server(s) also, except when the request is live, 
using ilp. 

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 


RUN <list> [<password> <cmd [args]>]

In some cases a list owner or manager will set up an executable program or a 
script for subscribers to a particular list.  The "Run" request will run the 
script or program on your behalf.  The "Run" request may be sent with the 
optional arguments, if any are necessary.  And you will receive the output 
from stdout and/or stderr. To get a listing of all available commands to run, 
omit the arguments, i.e. issue a 'run <list>' request. You have to belong to 
the specified list, and must have obtained the password from the list's owner; 
the owner's address may be found in the Errors-To: header line of each 
delivered message.

NOTE: DO NOT send a run request to the listprocessor unless the list manager 
or owner has specifically told you that you can do this. 

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

SET <list> [<option> <arg[s]>]

Each subscriber to a list has a series of five types of personal attributes or 
settings associated with the subscription to the list.  These five settings 
determine how mail is sent to the subscriber by the list, what the 
subscriber's password is, what the e-mail address the list processor knows the 
user by, whether other subscribers can know if the person is subscribed to the 
list, and a set of personal preferences for the list.  The "set" request sent 
without the optional arguments, sends back a list of all current settings for 
the specified list. Otherwise change the option to a new value for that list. 
Valid arguments are: 

    mail <ACK|NOACK|POSTPONE|DIGEST>
        ACK causes the list processor to send you a copy of all mail you send 
            to a list.
        NOACK prevents the list processor from sending you copies of mail you 
              send to a list.
    password <current-password> <new-password>  change your list password.
    address <current-password> <new-address>  change the e-mail address that 
            you are registered with.
    conceal <YES|NO> If set to yes, your name will be omitted from the list of 
              subscribers if someone requests such a list.
    preference [preferences] 

Issue a 'help set' request for more information. 

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

QUERY <list> 

Same as 'set <list>' with no arguments.

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

STATISTICS <list> {[subscriber email-address(es)] | [-all]}

Get a listing of non-concealed subscribers along with the number of messages 
each one of them has sent to the specified list. If the optional email 
addresses are given, then statistics will be collected for these users only. 
For example: stat foo-list john@address1.domain mary@address2.domain will 
generate statistics about these two subscribers to a list called foo-list.
 "-all" compiles statistics for all users that have posted on the list 
(whether currently subscribed or not).  If this request is submitted by the
list owner it will return all subscribers; when submitted by anyone else it
will return only non-concealed subscribers. 

 _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

SUBSCRIBE <list> <your name> 
JOIN <list> <your name>


The only way to subscribe to a list.  Either subscribe or join may be used as 
the request.

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

UNSUBSCRIBE <list> 
SIGNOFF <list>


Remove yourself from the specified list. 

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

PURGE <password>

Remove yourself from all local lists known to this host.  You must use a valid 
password from one of the lists to which you are subscribed.

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

WHICH 

Get a listing of local mailing lists to which you have subscribed.  There are 
no options with this request, it is sent as a single word.

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

FAX <fax-number> <archive | path-to-archive> <file> [/password] [parts] 
Same as 'get', but it faxes you the files instead to the specified number. 
In some cases the host running the list processor will have access to a fax 
modem.  This request allows you to obtain text files by having them faxed to 
you.

NOTE: DO NOT send this request unless the list owner or manager has 
specifically told you that the host has access to a fax modem and that you are 
able to do this.
  
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

GET <archive | path-to-archive> <file> [/password] [parts]

Get the requested file from the specified archive Files are usually split in 
parts locally, and in such a case you will receive the file in multiple email 
messages -- an 'index' request tells you how many parts the file has been 
split into, their sizes, and the path to the archive; if you need to obtain 
certain parts, specify them as optional arguments. If an archive is private, 
you have to provide its password as well. 

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

INDEX [archive | path-to-archive] [/password] [-all]

Get a list of files in the selected archive, or the master archive if no 
archive was specified. If an archive is private, you have to provide its 
password as well.  The path to the archive is returned with the index.

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

SEARCH <archive | path-to-archive>] [/password] [-all] <pattern>

Search all files of the specified archive (and all of its subarchives if -all 
is specified) for lines that match the pattern. The pattern can be an 
egrep(l)-style regular expression with support for the following additional 
operators: ' ' (negation), '|' and '&' (logical OR and AND), '<' '>' (group 
regular expressions). The pattern may be enclosed in single or double quotes. 
Note: . matches any character including new line. 
view <archive | path-to-archive>] [/password] [parts] 
Same as 'get' but in interactive mode justs catenates the file on the screen.

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
 
 Help is available on each of the above requests.  Help is also available on 
 the following topics: 

 listproc: Learn more about this system and list management software in 
 general. 
 
 live: Learn how to connect to this ListProcessor over the Internet with an 
 interactive client for live processing of your requests.