Return to aliases.tex CVS log

Up to [CSRG BSD Unix] / 43BSDReno / contrib / isode-beta / doc / manual

Annotation of 43BSDReno/contrib/isode-beta/doc/manual/aliases.tex, revision 1.1.1.1

1.1       root        1: % run this through LaTeX with the appropriate wrapper
                      2: 
                      3: \chapter      {The ISO Aliases Database}\label{isoaliases}
                      4: The database \file{isoaliases} in the ISODE \verb"ETCDIR" directory
                      5: (usually \file{/usr/etc/})
                      6: contains a simple mapping between names (terse strings)
                      7: and values (e.g., user-friendly names and distinguished names).
                      8: 
                      9: The database itself is an ordinary ASCII text file containing an entry for
                     10: each locally defined alias.
                     11: Each entry contains
                     12: \begin{itemize}
                     13: \item  the alias, a simple string; and,
                     14: 
                     15: \item  a user-friendly name or a distinguished name.
                     16: \end{itemize}
                     17: Blanks and/or tab characters are used to seperate items.
                     18: However, double-quotes may be used to prevent separation for items containing
                     19: embedded whitspace.
                     20: The sharp character (`\verb"#"') at the beginning of a line indicates a
                     21: commentary line.
                     22: 
                     23: \section      {Accessing the Database}\label{isoalias}
                     24: The \man libacsap(3n) library contains the routines used to access the
                     25: database.
                     26: There is one high-level routine, \verb"alias2name"
                     27: which returns the value which corresponds to an alias in the database.
                     28: \begin{quote}\index{alias2name}\small\begin{verbatim}
                     29: char   *alias2name (name)
                     30: char   *name;
                     31: \end{verbatim}\end{quote}
                     32: The parameter to this procedure is:
                     33: \begin{describe}
                     34: \item[\verb"name":] the alias to lookup.
                     35: \end{describe}
                     36: This returns the manifest constant \verb"NULLCP" if the given alias is
                     37: not in the database.
                     38: 
                     39: In order to load specific aliases other than those read in the
                     40: \man isoaliases(5) file, use the routine \verb"add_alias":
                     41: \begin{quote}\index{add\_alias}\small\begin{verbatim}
                     42: int     add_alias (name, value)
                     43: char   *name,
                     44:        *value;
                     45: \end{verbatim}\end{quote}
                     46: The parameters to this procedure are:
                     47: \begin{describe}
                     48: \item[\verb"name":] the alias to enter; and,
                     49: 
                     50: \item[\verb"value":] its value.
                     51: \end{describe}
                     52: This returns the manifest constant \verb"NOTOK" if the given alias can not
                     53: be added.
                     54: 
                     55: \section      {User-Specific Aliases}
                     56: By default a user-specific aliases database is consulted before the
                     57: system-wide aliases file.
                     58: The user-specific file is called \file{\$HOME/.isode\_aliases} in the user's
                     59: home directory.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.