file

LISTSERV also functions as a file server. That is, files can be stored at a LISTSERV server and made available for retrieval by users upon their request. These files are stored in LISTSERV under a hierarchical system of filelists. As the name suggests, a filelist is a special file that holds a list of files. Each entry in a filelist describes a file that is available for retrieval and gives details such as the file's name and size and also a file's access code (also known as a FAC) which describes who is authorized to retrieve it. These files may themselves be filelists, in which case they too will hold information about available files or further filelists. In this way, filelists are organized in a hierarchical or tree structure.

There are two basic types of filelists on LISTSERV servers. The first type holds files that have been specifically placed there by file owners or LISTSERV administrators. These files may be documents, maps or diagrams, or even programs. The second type of filelist is associated with a LISTSERV mailing list. These are referred to as list filelists and retain copies of all e-mail distributed on a particular mailing list. They consist of a series of files, each of which holds a copy of the mail messages distributed on a list over an interval of time (usually, one month). These files may then be retrieved to recover any list mail distributed during a specific period. Note that e-mail distributed on a mailing list may also be retrieved via the database functions of LISTSERV (see the LISTSERV DATABASE Functions chapter for more details). Not all mailing lists have an associated list filelist, this is enabled at a list owner's discretion.

A further aspect of the file server functions of LISTSERV is the concept of packages. A package consists of one or more files that appear in a filelist. These may be, for example, a series of files that go to make up a software package. A package is declared in a LISTSERV filelist through a file that has the special name of package-name $PACKAGE. Within it will be a list of all the files that comprise the package. This list can be reviewed by sending a retrieval request for that file. However, all the files that comprise the package may also be retrieved through a request for the file: package-name PACKAGE. Note that in this case, the '$' (dollar) symbol is dropped from the name. The files that go to make up the package will then automatically be sent to the requestor. This enables users to retrieve an entire set of files that belong to a package with only one command, instead of having to retrieve each of these files individually through a series of commands.

Here is a sample filelist:

---

*  SAMPLE FILELIST for LISTSERV@EARNCC.
*
* ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
*
*  The GET/PUT authorization codes shown with each file entry describe
*  who is authorized to GET or PUT the file:
*
*     ALL = Everybody
*     LMC = LISTSERV Master Coordinators
*     PRV = Private, ie list members
*     OWN = List owners
*:    DAV = 'DAVID@UKACRL'      /* David Boon - Author              */
*
* ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
 
**********************************************************************
*
* LISTSERV SAMPLE FILELIST
*
**********************************************************************
*                             rec               last - change
* filename filetype   GET PUT -fm lrecl nrecs   date     time   Info ..
* -------- --------   --- --- --- ----- ----- -------- -------- ------
 
  LISTFILE MEMO       ALL LMC V      72   609 92/01/31 14:10:27 File ..
  PASCAL-L FILELIST   PRV OWN V      72    49 93/02/15 19:03:45 Pascal.
  PROGRAM  $PACKAGE   ALL DAV V      80    25 90/11/06 11:29:23 Packag.

---

Comment lines begin with an '*' (asterisk) character and are used to provide introductory and explanatory text for the filelist. The most important comments are those explaining the FACs (File Access Codes) in the section entitled 'The GET/PUT authorization codes shown ...'. These FACs are used against the document entries at the bottom of the filelist. In this example, the first four FACs are generic in that they do not refer to specific userids but rather to special groups of predetermined users. All of the FACs specify who is authorized to issue GET (retrieve) and PUT (store) commands for each document. The LISTFILE MEMO file entry shows that everybody (ALL) is authorized to GET this document while only users who have been designated LISTSERV Master Coordinators (LMC) are allowed to store it. The filelist also shows that this document contains 609 lines, each of up to 72 characters in length.

The PASCAL-L FILELIST entry refers to a sub-filelist. You may go on to retrieve this filelist to investigate what files are held in it. In this case, it is a list filelist and is associated with the PASCAL-L mailing list. It would contain a series of files that hold a copy of all the mail messages distributed on that list, each one covering a certain period in time. The GET and PUT FACs specify that only list members (PRV) and list owners (OWN) may retrieve or store this filelist, respectively.

The final document entry is for a package called PROGRAM (as denoted by the file type of $PACKAGE). This file will contain a list of other files in the SAMPLE FILELIST (not shown here) that go to make up the PROGRAM package. Its FAC shows that everybody (ALL) is allowed to retrieve this package but only David Boon (DAV, the program's author) can store it.

Locating LISTSERV Filelists

The list filelists that are associated with a LISTSERV mailing list will be located at the server managing that list. If you are searching for this type of filelist, it will be at the LISTSERV located at the same node that appears in the list's e-mail address. For example, the BITFTP mailing list is located at the node EARNCC and has an e-mail address of BITFTP-L@EARNCC. Its filelist will therefore be located at the LISTSERV server at node EARNCC. All list filelists will also have the same name as the mailing list with which they are associated. Consequently, the above filelist will have the name BITFTP-L FILELIST.

 

There are no rules governing the location of files that are not in list filelists. Unless you already know the whereabouts of a file, you will have to search for it. However, all LISTSERV filelists are organized from a common starting point. The top (or root) filelist is always called LISTSERV FILELIST and this can be retrieved to determine what files or sub-filelists are available from any particular LISTSERV. This filelist can therefore be the point of departure when searching for any file at a LISTSERV server. Some other standard filelists (which always appear as sub-filelist entries in the LISTSERV FILELIST) include the INFO and TOOLS filelists. These hold LISTSERV's help and informational files and a standard set of software tools, respectively. Other files or filelists may also be present in the LISTSERV FILELIST, which you may then go on to investigate. Note that it is usual that files of a common nature are stored together in a single filelist whose name describes its contents. The information held in each filelist (listing its available files and sub-filelists) may be obtained through the use of the INDex command. For example, to retrieve the LISTSERV FILELIST from LISTSERV at EARNCC and look at the entries it holds, the following command should be sent to that server:

INDEX LISTSERV

Commands for FILE SERVER Functions

The following LISTSERV commands enable general users to manipulate files that are stored at a server. This includes commands to search for, retrieve and subscribe to files. When sending file server commands to LISTSERV, you must address them to the server and not to any mailing lists. Note that where the PW= keyword appears in a command description, this need only be included in the command text if you have defined a personal password at the server to which you are sending file server commands. Otherwise, it need not be used. The optional F= and CLASS= command keywords may included as desired (see the section LISTSERV Command Keywords for more information).

---

INDex       Receive a listing of a filelist
GET         Retrieve a file from LISTSERV
SENDME      A synonym for the GET command
AFD         Receive a new copy of a file every time it is updated
FUI         Receive notification of file updates
Query File  Receive information on a file
GIVE        Have LISTSERV send a file to another user
PW          Manipulate your personal password

---

INDex

Use the INDex command to get a listing of the files in a particular filelist. The format of the command is:

---

INDex  < filelist >  < F= format >  < CLASS= class >

---

Where filelist specifies the name of the filelist you wish to get. If no name is specified, an index of the root filelist (called LISTSERV FILELIST) will be sent to you. For example, to get a listing of the files in the DOC FILELIST, the command:

INDEX DOC

should be sent to the LISTSERV at node EARNCC where this filelist is located. Note that the above command is the same as issuing a GET DOC FILELIST command.

 

GET

The GET (or SENDME) command is used to retrieve a specific file or package from a filelist, provided you are authorized to do so. It has the format:

---

GET  filename  filetype  < filelist >  < F= format >  < CLASS= class >

---

Where the filename and filetype identify the file or package you wish to retrieve. The optional filelist parameter identifies the filelist within which the file or package resides. If it is not supplied in the command, LISTSERV will determine the filelist through a search of its own internal filelist index. For example, to retrieve all the files that make up the PROGRAM package in the SAMPLE FILELIST (and which are listed in the PROGRAM $PACKAGE file), send the command:

GET PROGRAM PACKAGE SAMPLE

AFD

AFD is an acronym for Automatic File Distribution. This command enables you to subscribe to a file or package in a filelist. Every time this file or package is updated in its filelist, you will then automatically be sent of copy of it by the LISTSERV server. You may subscribe to any number of files for packages from any filelist with the AFD command. You may also review or delete your subscriptions at any LISTSERV server. The command has the following format:

---

AFD  options

---

Where options must be one of the following:

ADD

The ADD (or REP) option allows you to subscribe to a file or package. This means that a copy will henceforth be sent to you automatically by LISTSERV when it is updated on its filelist. The ADD option has the following format:

---

ADD  filename  filetype  < filelist >  < text >  < PW= pass >


                             < F= format >  < CLASS= class >

---

Where filename and filetype identify a file or package to which you want to subscribe. The filelist option allows you to specify the name of the filelist in which it is located. If this is not specified in the command, LISTSERV will locate the filelist through a search of its own internal filelist index. Also, if you wish to have an informational text message inserted automatically at the top of the file or package when it is sent to you, you may use the text parameter. Note that if you omit the filelist option, the text you provide in the text parameter must be enclosed in double quotes. This parameter is most commonly used by network server applications that subscribe to files at a LISTSERV on behalf of users. If you are subscribing to files directly from LISTSERV yourself, you should not need to use this option. For example, if you wanted to subscribe to the file LISTFILE MEMO in the SAMPLE FILELIST, you would send the following command to LISTSERV:

AFD ADD LISTFILE MEMO SAMPLE

If you wanted the text "New memo update." inserted at the top of the file before it is sent to you, the command would take either of the following formats:

AFD ADD LISTFILE MEMO SAMPLE New memo update.
AFD ADD LISTFILE MEMO "New memo update."

REP

This is a synonym for the ADD option.

DELete

Remove your subscription to a file or package for which you have an AFD. The DELete option has the following format:

---

DELete  filename  filetype  < filelist >  < PW= password >

---

Where filename and filetype identify a file or package to which you wish to remove an AFD. These names may also include the '*' (asterisk) wildcard character so that multiple files or packages may be removed with one DELete command. The filelist option allows you to specify the name of the filelist in which it is located. If this is not specified in the command, LISTSERV will locate the filelist through a search of its own internal filelist index.

List

The List (or Query) option shows the files or packages to which you are currently subscribed at a LISTSERV. The List option has the following format:

---

List  < (FORMAT >

---

A list of your current AFDs at the LISTSERV processing this command will be sent to you. If you include the (FORMAT option, then the file format to be used when a file or package is sent to you will also be displayed.

Query

This is a synonym for the List option.

FUI

This command is an acronym for File Update Information. It enables you to subscribe to a file or package in a filelist. Every time this file for package is updated in its filelist, you will then automatically be informed of this by the LISTSERV server. This command is similar to the AFD command, except you will only be sent notification of an update rather than the updated file or package itself. You may subscribe to any number of files for packages from any filelist with the FUI command. You may also review or delete your subscriptions at any LISTSERV server. It has the following format:

---

FUI  options

---

Where options must be one of the following:

ADD

The ADD (or REP) option allows you to subscribe to a file or package by adding an FUI to it. It has the following format:

---

ADD  filename  filetype  < filelist >  < PW= password >

---

Where filename and filetype identify a file or package to which you want to add an FUI subscription. The filelist option allows you to specify the name of the filelist in which it is located. If this is not given in the command, LISTSERV will locate the filelist through a search of its own internal filelist index. For example, if you wanted to subscribe to the file LISTFILE MEMO in the SAMPLE FILELIST, you would send the following command to LISTSERV:

FUI ADD LISTSERV MEMO SAMPLE

REP

This is a synonym for the ADD option.

DELete

Remove your subscription from a file or package for which you have an FUI. The DELete option has the following format:

---

DELete  filename  filetype  < filelist >  < PW= password >

---

Where filename and filetype identify a file or package to which you want to delete an FUI. The filelist option allows you to specify the name of the filelist in which it is located. If this is not specified in the command, LISTSERV will locate the filelist through a search of its own internal filelist index.

List

The List (or Query) option shows the files or packages for which you currently have an FUI subscription at a LISTSERV server.

Query

This is a synonym for the List option.

Query File

This command can be used to get update information on various files. It has the format:

---

Query File  filename  filetype  < filelist >  < (FLags >

---

Update information about the file or package specified in the filename and filetype parameters will be given. Optionally, you may include a filelist name in the filelist parameter. If it is omitted, LISTSERV will locate the filelist through a search of its own internal filelist index. You may also specify the (FLags option to display additional technical data about the file (which can be useful when reporting problems to LISTSERV administrators).

 

GIVE

This command can be used to have a LISTSERV server send a file or package (that you are authorized to retrieve via a GET command) to an e-mail address other than your own. It has the format:

---

GIVE  filename  filetype  < filelist >  < TO >  userid@node


                            < F= format >  < CLASS= class >

---

Where the filename and filetype identify the file or package which you wish LISTSERV to send to the specified address. The optional filelist parameter identifies the filelist within which the file or package is held. If it is not supplied in the command, LISTSERV will determine the filelist through a search of its own internal filelist index. The userid@node parameter is required and gives the e-mail address of the intended recipient. For example, the following command would direct LISTSERV send the LISTFILE MEMO document from the SAMPLE FILELIST to the user JACQUES at the node FRMOP11:

GIVE LISTFILE MEMO SAMPLE TO JACQUES@FRMOP11

PW

The PW command enables you to add, change or delete a personal password on any LISTSERV server. A personal password is designed to give you added command security on a LISTSERV since it helps prevent impostors using your e-mail address. The use of personal passwords is strongly encouraged for this reason. Every server will accept a password registration request from you at any time. Passwords are comprised of one to eight alphanumeric characters. You may change or delete your password at any time. If you forget a password you have registered at any LISTSERV server, contact that server's postmaster (whose e-mail address is given in the RELEASE command; see the section Commands for INFORMATION). The format of the PW command is:

---

PW  options

---

Where options must be one of the following:

ADD

Add a new personal password on the LISTSERV processing your command. The ADD option has the format:

---

ADD  new-password

---

Once you have registered a password on a LISTSERV server, you will be obliged to use the PW= command keyword in the commands where it appears as an option.

CHange

Change your personal password on a LISTSERV server where you already have one. It has the format:

---

CHange  old-password   new-password

or

        new-password   PW=  old-password

---

DELete

Remove your personal password from a LISTSERV where you already have one. The DELete option has the format:

---

DELete  old-password

---

Once you have removed a password from a LISTSERV server, you will no longer be obliged to use the PW= command keyword in the commands where it appears as an option.