X-Git-Url: https://git.hcoop.net/hcoop/debian/courier-authlib.git/blobdiff_plain/d9898ee81388d1eff40cf71e85d9ce9b5c1401fe..8cefd203806dc3406799e37deeed619db0546535:/userdb/userdb.8.in diff --git a/userdb/userdb.8.in b/userdb/userdb.8.in index f0b605d..30a2450 100644 --- a/userdb/userdb.8.in +++ b/userdb/userdb.8.in @@ -1,203 +1,215 @@ -.\" +'\" t .\" .\" .\" Title: userdb -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.72.0 -.\" Date: 04/22/2007 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 06/20/2015 .\" Manual: Double Precision, Inc. .\" Source: Double Precision, Inc. +.\" Language: English .\" -.TH "USERDB" "8" "04/22/2007" "Double Precision, Inc." "Double Precision, Inc." +.TH "USERDB" "8" "06/20/2015" "Double Precision, Inc." "Double Precision, Inc." +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" userdb \- manipulate @userdb@ .SH "SYNOPSIS" -.HP 7 +.HP \w'\fBuserdb\fR\ 'u \fBuserdb\fR {\fIaddr\fR} set {\fIfield\fR=\fIvalue\fR...} -.HP 7 +.HP \w'\fBuserdb\fR\ 'u \fBuserdb\fR {\fIaddr\fR} unset {\fIfield\fR...} -.HP 7 +.HP \w'\fBuserdb\fR\ 'u \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 +.HP \w'\fBuserdb\fR\ 'u +\fBuserdb\fR {\fIpath/addr\fR} [set | unset | del] \&.\&.\&. +.HP \w'\fBuserdb\fR\ 'u +\fBuserdb\fR \-f {\fIfile\fR} {\fIadr\fR} [set | unset | del] \&.\&.\&. +.HP \w'\fBuserdb\fR\ 'u \fBuserdb\fR \-show {\fIpath\fR} -.HP 7 +.HP \w'\fBuserdb\fR\ 'u \fBuserdb\fR \-show {\fIpath\fR} {\fIaddr\fR} -.HP 7 +.HP \w'\fBuserdb\fR\ 'u \fBuserdb\fR \-show \-f {\fIfile\fR} -.HP 7 +.HP \w'\fBuserdb\fR\ 'u \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 +@userdb@\&. See +\m[blue]\fB\fBmakeuserdb\fR(8)\fR\m[]\&\s-2\u[1]\d\s+2 +for a description of its contents\&. +@userdb@ can always be edited using any text editor, but \fBuserdb\fR -is a convenient way to modify this file from another script. +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 +@userdb@ +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 +@userdb@\fI/foo/bar\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. +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). +@userdb@ +must not have any group or world permissions\&. That\*(Aqs 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 +@userdb@ takes following form: -.PP \fIaddr\fR\fIfield\fR=\fIvalue\fR|\fIfield\fR=\fIvalue\fR... -.PP +\fIaddr\fR\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 +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. +pairs, separated by vertical slash characters\&. See +\m[blue]\fB\fBmakeuserdb\fR(8)\fR\m[]\&\s-2\u[1]\d\s+2 +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 +@userdb@\&. Any blank lines or comments are ignored by the \fBuserdb\fR -script. +script\&. .PP The names of the actual fields, and their contents, are defined entirely by applications that use the -\fI@userdb@\fR +@userdb@ database, the \fBuserdb\fR -command just adds or removes arbitrary fields. +command just adds or removes arbitrary fields\&. .PP For example: .sp +.if n \{\ .RS 4 +.\} .nf \fBuserdb default/info set mail=/home/mail/info\fR .fi +.if n \{\ .RE +.\} .PP This command accesses the address "info" in -\fI@userdb@/default\fR. +@userdb@/default\&. .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\&. 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 +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 +stops and prompts for it\&. This is useful if you\*(Aqre 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 +command\&. If \fBuserdb\fR -is being executed by a script, the value can be provided on standard input. +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" +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 @userdb@" .PP If the first argument to userdb is \fI\-show\fR, \fBuserdb\fR displays the contents of -\fI@userdb@\fR. If -\fI@userdb@\fR +@userdb@\&. If +@userdb@ is a subdirectory, \fI\fIpath\fR\fR must refer to a specific file in -\fI@userdb@\fR. The +@userdb@\&. The \fI\-f\fR option can be used instead of \fI\fIpath\fR\fR -in order to specify an arbitrary file. +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 +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 +@userdb@ for this -\fI\fIaddr\fR\fR. -.SS "REBUILDING \fI@userdb@.dat\fR" +\fI\fIaddr\fR\fR\&. +.SS "REBUILDING @userdb@\&.dat" .PP The actual virtual account/address database is -\fI@userdb@.dat\fR. This is a binary database file. +@userdb@\&.dat\&. This is a binary database file\&. \fB@userdb@\fR -is the plain text version. After running +is the plain text version\&. After running \fBuserdb\fR, execute the -\fI\fBmakeuserdb\fR(8)\fR\&[1] +\m[blue]\fB\fBmakeuserdb\fR(8)\fR\m[]\&\s-2\u[1]\d\s+2 command to rebuild -\fI@userdb@.dat\fR -for the changes to take effect. +@userdb@\&.dat +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 +must be unique\&. If +@userdb@ +is a subdirectory, it\*(Aqs 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 +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. +\m[blue]\fB\fBmakeuserdb\fR(8)\fR\m[]\&\s-2\u[1]\d\s+2 +command will fail with an error message\&. .SH "FILES" .PP - -\fI @userdb@\fR +@userdb@ \- plain text file, or directory of plain text files .PP - -\fI .lock.filename\fR +\&.lock\&.filename \- lock file for -\fIfilename\fR +filename .PP - -\fI .tmp.filename\fR +\&.tmp\&.filename \- temporary file used to create new contents of -\fIfilename\fR +filename .SH "SEE ALSO" .PP - -\fI\fBmakeuserdb\fR(8)\fR\&[1], -\fI\fBuserdbpw\fR(8)\fR\&[2] -.SH "REFERENCES" +\m[blue]\fB\fBmakeuserdb\fR(8)\fR\m[]\&\s-2\u[1]\d\s+2, +\m[blue]\fB\fBuserdbpw\fR(8)\fR\m[]\&\s-2\u[2]\d\s+2 +.SH "NOTES" .IP " 1." 4 \fBmakeuserdb\fR(8) .RS 4 -\%makeuserdb.html +\%[set $man.base.url.for.relative.links]/makeuserdb.html .RE .IP " 2." 4 \fBuserdbpw\fR(8) .RS 4 -\%userdbpw.html +\%[set $man.base.url.for.relative.links]/userdbpw.html .RE