Archive Commands

Listproc has the ability to define archive-owners in a way similar to list-owners. Archives can be defined, which can be independent of mailing list, such that an owner can add, delete or update files in that archive. Like mailing lists, the archive owners must make all requests from the e-mail address that he/she is registered as the owner and use the archive password. Only the site maintainer can create an archive, define owner(s) and grant them privileges.

An archive owner add files to the archive, update existing files, define the archives for Automatic File Distribution (see section V below). The listmanager may define multiple owners to the same archive, each with different permissions, (i.e. one owner may only have update permissions while another can add and delete files).

Owner Command:

    archive <name> <password> <review>

archive <name> <password> <update|add> <filename> [description]

archive <name> <password> <delete> <filename> [filename ...]

The above shows the three actions that the archive command performs and there related options. The review option will return a the archive owners options (i.e. their privileges registered email address and password. The update and add options will add a new file to the archive or overwrite and existing file. The description must be enclosed in quotes if it is more than one word. The description will appear after the file name in response to a user index archive-name request.

Examples:

For an archive named "myarchive" whose owner password is "foo"

ARCHIVE myarchive foo review

will provide the owner with his/her current archive settings as follows:

DIRECTORY /path/to/myarchive
PASSWORD foo
PUBLIC
UNCOMPRESSED
UNSPLIT
NO-AFD-FUI
OWNER user@foo.bar

These are the archives settings that the site manager established for this archive. The archive owner can not change any of these and must contact the site maintainer for any changes. Reviewing these options, we find that that:

DIRECTORY The path to the archive on the host on which it resides. No user will ever have to know this. The actual path is not needed in any user requests.

PUBLIC The archive shows up in response to an INDEX command

PRIVATE The archive does not show up in response to an INDEX command. Only archive subscribers, the archive owner and the manager will see the archive.

COMPRESSED The archive is stored in UNIX Compress format. Compression is transparent to end users as the file is uncompressed before being sent to users.

UNCOMPRESSED The files in the archive are stored uncompressed. Listproc can compress files to better use disk space. This would be transparent to end users.

UNSPLIT The files are not split regardless of file size. Listproc can split up large files into predetermined pieces. The splitting is done at the point the file is being mailed out. In this way, a large file can be split in a fashion to allow certain mail gateways with per message size restrictions to process the mail.

SPLIT The files are split into predetermined chunks .. The option would report the CHUNK size in bytes. (the maximum size of each portion it is split into).

NO-AFD-FUI This archive is unavailable for AFD or FUI (See section V)

AFD-FUI The archive is available for AFD or FUI.

Each of these parameters can be changed by the site maintainer only. When archives are being set up for access in this fashion, you must communicate your needs to the site maintainer.

To add a file called "test" to the archive myarchive

ARCHIVE myarchive foo add test "My Test File"

This is a test file The file will contain these two lines.

Everything after the archive command to the end of the mail message will be the body of the file. The file will also have the comment "My Test File" added to it.

To update the file called "test" to the archive myarchive

ARCHIVE myarchive foo update test "My New Test File"

This is the new test file
It will contain these two lines

As in the example above, everything after the archive command becomes the body of the file. The file called test is replaced with the new one and the comment is changed to reflect the new comment provided.

To delete file "test" from the archive "myarchive"

ARCHIVE myarchive foo delete test

It is important to remember that the archive owner must have been granted the appropriate access by the site maintainer (UPDATE, ADD and DELETE). If the owner does not have sufficient access, Listproc will return an error informing the owner that he/she has insufficient privileges for the requested operation.


[BACK] to the Table of Contents