Imported upstream version 0.61.0

[hcoop/debian/courier-authlib.git] / userdb / userdb.8.in

.\"  <!-- $Id: userdb.sgml,v 1.5 2007/04/22 15:05:16 mrsam Exp $ -->
.\"  <!-- Copyright 1998 - 2007 Double Precision, Inc.  See COPYING for -->
.\"  <!-- distribution information. -->
.\"     Title: userdb
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
.\"      Date: 04/22/2007
.\"    Manual: Double Precision, Inc.
.\"    Source: Double Precision, Inc.
.\"
.TH "USERDB" "8" "04/22/2007" "Double Precision, Inc." "Double Precision, Inc."
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
userdb \- manipulate @userdb@
.SH "SYNOPSIS"
.HP 7
\fBuserdb\fR {\fIaddr\fR} set {\fIfield\fR=\fIvalue\fR...}
.HP 7
\fBuserdb\fR {\fIaddr\fR} unset {\fIfield\fR...}
.HP 7
\fBuserdb\fR {\fIaddr\fR} del
.HP 7
\fBuserdb\fR {\fIpath/addr\fR} [set | unset | del] ...
.HP 7
\fBuserdb\fR \-f {\fIfile\fR} {\fIadr\fR} [set | unset | del] ...
.HP 7
\fBuserdb\fR \-show {\fIpath\fR}
.HP 7
\fBuserdb\fR \-show {\fIpath\fR} {\fIaddr\fR}
.HP 7
\fBuserdb\fR \-show \-f {\fIfile\fR}
.HP 7
\fBuserdb\fR \-show \-f {\fIfile\fR} {\fIaddr\fR}
.SH "DESCRIPTION"
.PP

\fBuserdb\fR
is a convenient script to individually manipulate entries in
\fI@userdb@\fR. See
\fI\fBmakeuserdb\fR(8)\fR\&[1]
for a description of its contents.
\fI@userdb@\fR
can always be edited using any text editor, but
\fBuserdb\fR
is a convenient way to modify this file from another script.
.PP

\fI@userdb@\fR
can also be a subdirectory, instead of a file. Specify
\fB\fIfoo/bar/addr\fR\fR
to manipulate
\fB\fIaddr\fR\fR
in the file
\fI@userdb@\fR\fI\fI/foo/bar\fR\fR. You can also use the
\fB\-f\fR
flag:
\fB\-f \fR\fB\fI@userdb@/foo/bar\fR\fR
is equivalent. Use whatever form makes the most sense to you.
.PP

\fI@userdb@\fR
must not have any group or world permissions. That's because its contents may include system passwords (depending upon the application which uses this virtual user account database).
.PP
Each line in
\fI@userdb@\fR
takes following form:
.PP \fIaddr\fR<TAB>\fIfield\fR=\fIvalue\fR|\fIfield\fR=\fIvalue\fR...
.PP

\fIaddr\fR
specifies a unique virtual address. It is followed by a single tab character, then a list of
\fIfield\fR=\fIvalue\fR
pairs, separated by vertical slash characters. See
\fI\fBmakeuserdb\fR(8)\fR\&[1]
for field definitions.
.PP
A text editor can be used to add blank lines or comments in
\fI@userdb@\fR. Any blank lines or comments are ignored by the
\fBuserdb\fR
script.
.PP
The names of the actual fields, and their contents, are defined entirely by applications that use the
\fI@userdb@\fR
database, the
\fBuserdb\fR
command just adds or removes arbitrary fields.
.PP
For example:
.sp
.RS 4
.nf
\fBuserdb default/info set mail=/home/mail/info\fR
.fi
.RE
.PP
This command accesses the address "info" in
\fI@userdb@/default\fR.
.PP
If the second argument to
\fBuserdb\fR
is "\fIset\fR", the remaining arguments are taken as
\fI\fIfield\fR\fR\fI=\fR\fI\fIvalue\fR\fR
pairs, which are added to the record for
\fIaddr\fR. If there is no record for
\fIaddr\fR, a new record will be appended to the file. If
\fIaddr\fR
exists, any existing values of any specified fields are removed. If
\fI=\fR\fI\fIvalue\fR\fR
is missing,
\fBuserdb\fR
stops and prompts for it. This is useful if you're setting a password field, where you do not want to specify the password on the command line, which can be seen by the
\fBps\fR(1)
command. If
\fBuserdb\fR
is being executed by a script, the value can be provided on standard input.
.PP
Use "\fIunset\fR" to delete fields from an existing record. Use "\fIdel\fR" to delete all fields in the existing record, plus the record itself.
.SS "DISPLAYING \fI@userdb@\fR"
.PP
If the first argument to userdb is
\fI\-show\fR,
\fBuserdb\fR
displays the contents of
\fI@userdb@\fR. If
\fI@userdb@\fR
is a subdirectory,
\fI\fIpath\fR\fR
must refer to a specific file in
\fI@userdb@\fR. The
\fI\-f\fR
option can be used instead of
\fI\fIpath\fR\fR
in order to specify an arbitrary file.
.PP
If
\fI\fIaddr\fR\fR
is not specified,
\fBuserdb\fR
produces a list, on standard output, containing all addresses found in the file, on per line. If
\fI\fIaddr\fR\fR
is specified,
\fBuserdb\fR
produces a list, on standard output, of all the fields in
\fI@userdb@\fR
for this
\fI\fIaddr\fR\fR.
.SS "REBUILDING \fI@userdb@.dat\fR"
.PP
The actual virtual account/address database is
\fI@userdb@.dat\fR. This is a binary database file.
\fB@userdb@\fR
is the plain text version. After running
\fBuserdb\fR, execute the
\fI\fBmakeuserdb\fR(8)\fR\&[1]
command to rebuild
\fI@userdb@.dat\fR
for the changes to take effect.
.SH "BUGS"
.PP

\fI\fIaddr\fR\fR
must be unique. If
\fI@userdb@\fR
is a subdirectory, it's possible to create the same
\fI\fIaddr\fR\fR
in different files in the subdirectory. This is an error that is not currently detected by
\fBuserdb\fR, however the subsequent
\fI\fBmakeuserdb\fR(8)\fR\&[1]
command will fail with an error message.
.SH "FILES"
.PP

\fI @userdb@\fR
\- plain text file, or directory of plain text files
.PP

\fI .lock.filename\fR
\- lock file for
\fIfilename\fR
.PP

\fI .tmp.filename\fR
\- temporary file used to create new contents of
\fIfilename\fR
.SH "SEE ALSO"
.PP

\fI\fBmakeuserdb\fR(8)\fR\&[1],
\fI\fBuserdbpw\fR(8)\fR\&[2]
.SH "REFERENCES"
.IP " 1." 4
\fBmakeuserdb\fR(8)
.RS 4
\%makeuserdb.html
.RE
.IP " 2." 4
\fBuserdbpw\fR(8)
.RS 4
\%userdbpw.html
.RE