AEP: 10
Title: Use of ~/.arch-params/
Version: $Revision: 1.0 $
Last-Modified: $Date: 2002/08/26 16:29:31 $
Author: Federico Di Gregorio <fog@debian.org>
Status: Draft
Type: Standard Track
Content-Type: text/plain
Created: 19-Sep-2002
Post-History:


Abstract

    This document explains what files are present in the per-user arch
    parameters directory ($HOME/.arch-params). In the following text,
    protocol 2 extensions are identified by a +2+ appended near
    them. This document is valid for both protocols 1 and 2.


Rationale

    No rationale: this document describe the core of the Arch protocol.


File list and description

    =id 
        This file contains the user's id-string, i.e., its name
        without parentheses or quotingfollowed by a real email address
        surrounded by <>. Example:

             Jane Hacker <jane.hacker@gnu.org>

        The portion of the id-string between < and > is called the uid
        and can be used to generate per-user unique file names.

    =ui +2+
        This file holds the name of the user's preferred interface,
        for arch implementations that can use more than one interface.
        Common values are: cmdline, tk, gtk, etc.  (This is new for
        arch protocol 2.)

    =default-archive
        This file contains the name (not the location/url) of the
        preferred user's archive. Archive names have the following
        format:

            name@domain--spec

        where "name@domain" must be a real email address, and "spec"
        is optional. The following are all valid archive names:

            tom@hackerlabs.com--2002
            arch@initd.org--main
            software@srparish.net

    =locations
        This is a directory that contains the locations of registered
        archives.  A location has the format of an url and is saved as
        a single line terminated by \n in a file named after the
        archive name (see above, =default-archive for the format of
        archive names.)  As a special exception, a path that starts
        with / is treated as a file url and file:// is prepended to
        it.

    =revision-library
        This file holds the path to the current revision library. It
        must be an absolute path, on a single line, terminated by \n.


References

    No references.


Copyright

    This document has been placed in the public domain.



Local Variables:
mode: indented-text
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 72
End: