--- a/commands/vadduser.1 Sun Jan 20 00:12:17 2008 +0100
+++ b/commands/vadduser.1 Sun Jan 20 00:22:09 2008 +0100
@@ -1,9 +1,8 @@
-.rn '' }`
-''' $RCSfile$$Revision$$Date$
-'''
-''' $Log$
-'''
-.de Sh
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
@@ -11,150 +10,98 @@
\fB\\$1\fR
.PP
..
-.de Sp
+.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
-.de Ip
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.de Vb
+.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
-.de Ve
+.de Ve \" End verbatim text
.ft R
-
.fi
..
-'''
-'''
-''' Set up \*(-- to give an unbreakable dash;
-''' string Tr holds user defined translation string.
-''' Bell System Logo is used as a dummy character.
-'''
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. | will give a
+.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
-.ds -- \(*W-
-.ds PI pi
-.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
-.ds L" ""
-.ds R" ""
-''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of
-''' \*(L" and \*(R", except that they are used on ".xx" lines,
-''' such as .IP and .SH, which do another additional levels of
-''' double-quote interpretation
-.ds M" """
-.ds S" """
-.ds N" """""
-.ds T" """""
-.ds L' '
-.ds R' '
-.ds M' '
-.ds S' '
-.ds N' '
-.ds T' '
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
'br\}
.el\{\
-.ds -- \(em\|
-.tr \*(Tr
-.ds L" ``
-.ds R" ''
-.ds M" ``
-.ds S" ''
-.ds N" ``
-.ds T" ''
-.ds L' `
-.ds R' '
-.ds M' `
-.ds S' '
-.ds N' `
-.ds T' '
-.ds PI \(*p
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
'br\}
-.\" If the F register is turned on, we'll generate
-.\" index entries out stderr for the following things:
-.\" TH Title
-.\" SH Header
-.\" Sh Subsection
-.\" Ip Item
-.\" X<> Xref (embedded
-.\" Of course, you have to process the output yourself
-.\" in some meaninful fashion.
-.if \nF \{
-.de IX
-.tm Index:\\$1\t\\n%\t"\\$2"
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
..
-.nr % 0
-.rr F
+. nr % 0
+. rr F
.\}
-.TH VADDUSER 1 "vmailmgr 0.96.9" "2000-09-30" "VMailMgr Tools Documentation"
-.UC
-.if n .hy 0
+.\"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
.if n .na
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
-.de CQ \" put $1 in typewriter font
-.ft CW
-'if n "\c
-'if t \\&\\$1\c
-'if n \\&\\$1\c
-'if n \&"
-\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
-'.ft R
-..
-.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
-. \" AM - accent mark definitions
-.bd B 3
-. \" fudge factors for nroff and troff
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
.if n \{\
-. ds #H 0
-. ds #V .8m
-. ds #F .3m
-. ds #[ \f1
-. ds #] \fP
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
.\}
.if t \{\
-. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-. ds #V .6m
-. ds #F 0
-. ds #[ \&
-. ds #] \&
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
.\}
-. \" simple accents for nroff and troff
+. \" simple accents for nroff and troff
.if n \{\
-. ds ' \&
-. ds ` \&
-. ds ^ \&
-. ds , \&
-. ds ~ ~
-. ds ? ?
-. ds ! !
-. ds /
-. ds q
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
.\}
.if t \{\
-. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
-. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
-. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
-. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
-. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
-. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
-. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
-. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
-. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
-. \" troff and (daisy-wheel) nroff accents
+. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
-.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
-.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
-.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
@@ -162,59 +109,58 @@
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
-.ds oe o\h'-(\w'o'u*4/10)'e
-.ds Oe O\h'-(\w'O'u*4/10)'E
-. \" corrections for vroff
+. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
-. \" for low resolution devices (crt and lpr)
+. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
-. ds : e
-. ds 8 ss
-. ds v \h'-1'\o'\(aa\(ga'
-. ds _ \h'-1'^
-. ds . \h'-1'.
-. ds 3 3
-. ds o a
-. ds d- d\h'-1'\(ga
-. ds D- D\h'-1'\(hy
-. ds th \o'bp'
-. ds Th \o'LP'
-. ds ae ae
-. ds Ae AE
-. ds oe oe
-. ds Oe OE
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
.\}
.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "VADDUSER 1"
+.TH VADDUSER 1 "2005-09-03" "vmailmgr 0.97" "VMailMgr Tools Documentation"
.SH "NAME"
vadduser \- Add a user to a virtual domain
.SH "SYNOPSIS"
-\fBvadduser\fR
-[\fB\-c INT\fR]
-[\fB--msgcount=INT\fR]
+.IX Header "SYNOPSIS"
+\&\fBvadduser\fR
+[\fB\-c \s-1INT\s0\fR]
+[\fB\-\-msgcount=INT\fR]
[\fB\-D\fR]
-[\fB--no-mailbox\fR]
-[\fB\-d STR\fR]
-[\fB--directory=STR\fR]
-[\fB\-e INT\fR]
-[\fB--expiry=INT\fR]
-[\fB\-f STR\fR]
-[\fB--forward=STR\fR]
+[\fB\-\-no\-mailbox\fR]
+[\fB\-d \s-1STR\s0\fR]
+[\fB\-\-directory=STR\fR]
+[\fB\-e \s-1INT\s0\fR]
+[\fB\-\-expiry=INT\fR]
+[\fB\-f \s-1STR\s0\fR]
+[\fB\-\-forward=STR\fR]
+[\fB\-\-password=STR\fR]
[\fB\-P\fR]
-[\fB--no-password\fR]
-[\fB\-p STR\fR]
-[\fB--personal=STR\fR]
-[\fB\-Q INT\fR]
-[\fB--hardquota=INT\fR]
-[\fB\-q INT\fR]
-[\fB--softquota=INT\fR]
-[\fB--quiet\fR]
-[\fB\-z INT\fR]
-[\fB--msgsize=INT\fR]
-\fIUSERNAME [ALIAS1 ...]\en"
-\*(L"or vaddalias [\-f ADDRESS] USERNAME [ALIAS1 ...]\fR
+[\fB\-\-no\-password\fR]
+[\fB\-p \s-1STR\s0\fR]
+[\fB\-\-personal=STR\fR]
+[\fB\-Q \s-1INT\s0\fR]
+[\fB\-\-hardquota=INT\fR]
+[\fB\-q \s-1INT\s0\fR]
+[\fB\-\-softquota=INT\fR]
+[\fB\-\-quiet\fR]
+[\fB\-z \s-1INT\s0\fR]
+[\fB\-\-msgsize=INT\fR]
+\&\fI\s-1USERNAME\s0 [\s-1ALIAS1\s0 ...]\en\*(L"
+\&\*(R"or vaddalias \s-1USERNAME\s0 [\s-1ALIAS1\s0 ...]\fR
.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
This program is used to set up a user within a virtual host.
If this program is reading from a tty,
it will then ask for a password (twice, to make sure you typed it in
@@ -225,83 +171,59 @@
directory and create a mail directory for the new user.
It will also add an entry for each of the named aliases.
.SH "OPTIONS"
-.Ip "\fB\-c \s-1INT\s0\fR, \fB--msgcount=\s-1INT\s0\fR" 8
+.IX Header "OPTIONS"
+.IP "\fB\-c \s-1INT\s0\fR, \fB\-\-msgcount=INT\fR" 8
+.IX Item "-c INT, --msgcount=INT"
Set the user's message count limit.
-.Ip "\fB\-D\fR, \fB--no-mailbox\fR" 8
+.IP "\fB\-D\fR, \fB\-\-no\-mailbox\fR" 8
+.IX Item "-D, --no-mailbox"
Do not create a mailbox for this user. Defaults to true for vaddalias.
-.Ip "\fB\-d \s-1STR\s0\fR, \fB--directory=\s-1STR\s0\fR" 8
+.IP "\fB\-d \s-1STR\s0\fR, \fB\-\-directory=STR\fR" 8
+.IX Item "-d STR, --directory=STR"
Set the path to the user's mailbox. Note that this directory is unconditionally prefixed with \*(L"./\*(R".
-.Ip "\fB\-e \s-1INT\s0\fR, \fB--expiry=\s-1INT\s0\fR" 8
+.IP "\fB\-e \s-1INT\s0\fR, \fB\-\-expiry=INT\fR" 8
+.IX Item "-e INT, --expiry=INT"
Set the account's expiry time (in seconds).
-.Ip "\fB\-f \s-1STR\s0\fR, \fB--forward=\s-1STR\s0\fR" 8
+.IP "\fB\-f \s-1STR\s0\fR, \fB\-\-forward=STR\fR" 8
+.IX Item "-f STR, --forward=STR"
Add a forwarding address to this user (this may be used multiple times).
-.Ip "\fB\-P\fR, \fB--no-password\fR" 8
+.IP "\fB\-\-password=STR\fR" 8
+.IX Item "--password=STR"
+Encrypted password. Defaults to asking for a password.
+.IP "\fB\-P\fR, \fB\-\-no\-password\fR" 8
+.IX Item "-P, --no-password"
Do not ask for a password, and instead set the pass phrase field to an unusable value.
-.Ip "\fB\-p \s-1STR\s0\fR, \fB--personal=\s-1STR\s0\fR" 8
+.IP "\fB\-p \s-1STR\s0\fR, \fB\-\-personal=STR\fR" 8
+.IX Item "-p STR, --personal=STR"
Set the user's personal information.
-.Ip "\fB\-Q \s-1INT\s0\fR, \fB--hardquota=\s-1INT\s0\fR" 8
+.IP "\fB\-Q \s-1INT\s0\fR, \fB\-\-hardquota=INT\fR" 8
+.IX Item "-Q INT, --hardquota=INT"
Set the user's hard quota (in bytes).
-.Ip "\fB\-q \s-1INT\s0\fR, \fB--softquota=\s-1INT\s0\fR" 8
+.IP "\fB\-q \s-1INT\s0\fR, \fB\-\-softquota=INT\fR" 8
+.IX Item "-q INT, --softquota=INT"
Set the user's soft quota (in bytes).
-.Ip "\fB--quiet\fR" 8
+.IP "\fB\-\-quiet\fR" 8
+.IX Item "--quiet"
Suppress all status messages.
-.Ip "\fB\-z \s-1INT\s0\fR, \fB--msgsize=\s-1INT\s0\fR" 8
+.IP "\fB\-z \s-1INT\s0\fR, \fB\-\-msgsize=INT\fR" 8
+.IX Item "-z INT, --msgsize=INT"
Set the user's message size limit (in bytes).
.SH "RETURN VALUE"
+.IX Header "RETURN VALUE"
0 if all steps were successful, non-zero otherwise.
If any of the steps fail, a diagnostic message is printed.
.SH "SEE ALSO"
-\fIvsetup\fR\|(1)
+.IX Header "SEE ALSO"
+\&\fIvsetup\fR\|(1)
.SH "NOTES"
+.IX Header "NOTES"
You must have either created the users subdirectory by hand or run the
-\fIvsetup\fR program before using this program.
+\&\fIvsetup\fR program before using this program.
.PP
-This program expects the environment variable \f(CWHOME\fR to be set, and
+This program expects the environment variable \f(CW\*(C`HOME\*(C'\fR to be set, and
executes a change directory to the contents of it before starting. It
is also required that you change user to the domain owner before using
these utilities.
.SH "AUTHORS"
+.IX Header "AUTHORS"
Bruce Guenter <bruceg@em.ca>
-
-.rn }` ''
-.IX Title "VADDUSER 1"
-.IX Name "vadduser - Add a user to a virtual domain"
-
-.IX Header "NAME"
-
-.IX Header "SYNOPSIS"
-
-.IX Header "DESCRIPTION"
-
-.IX Header "OPTIONS"
-
-.IX Item "\fB\-c \s-1INT\s0\fR, \fB--msgcount=\s-1INT\s0\fR"
-
-.IX Item "\fB\-D\fR, \fB--no-mailbox\fR"
-
-.IX Item "\fB\-d \s-1STR\s0\fR, \fB--directory=\s-1STR\s0\fR"
-
-.IX Item "\fB\-e \s-1INT\s0\fR, \fB--expiry=\s-1INT\s0\fR"
-
-.IX Item "\fB\-f \s-1STR\s0\fR, \fB--forward=\s-1STR\s0\fR"
-
-.IX Item "\fB\-P\fR, \fB--no-password\fR"
-
-.IX Item "\fB\-p \s-1STR\s0\fR, \fB--personal=\s-1STR\s0\fR"
-
-.IX Item "\fB\-Q \s-1INT\s0\fR, \fB--hardquota=\s-1INT\s0\fR"
-
-.IX Item "\fB\-q \s-1INT\s0\fR, \fB--softquota=\s-1INT\s0\fR"
-
-.IX Item "\fB--quiet\fR"
-
-.IX Item "\fB\-z \s-1INT\s0\fR, \fB--msgsize=\s-1INT\s0\fR"
-
-.IX Header "RETURN VALUE"
-
-.IX Header "SEE ALSO"
-
-.IX Header "NOTES"
-
-.IX Header "AUTHORS"
-