commands/vadduser.1
author "Tomas Zeman <tzeman@volny.cz>"
Sun, 20 Jan 2008 00:22:09 +0100
changeset 2 b3afb9f1e801
parent 0 6f7a81934006
permissions -rw-r--r--
Imported vmailmgr-0.97

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" 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" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" 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
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    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 / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" 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 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'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.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
.    \" 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)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    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"
.IX Header "SYNOPSIS"
\&\fBvadduser\fR
[\fB\-c \s-1INT\s0\fR]
[\fB\-\-msgcount=INT\fR]
[\fB\-D\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 \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
correctly), otherwise it will read the password from the input with no
prompting.
It will then
add the user to the virtual password table in the current
directory and create a mail directory for the new user.
It will also add an entry for each of the named aliases.
.SH "OPTIONS"
.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
.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=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=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=STR\fR" 8
.IX Item "-f STR, --forward=STR"
Add a forwarding address to this user (this may be used multiple times).
.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=STR\fR" 8
.IX Item "-p STR, --personal=STR"
Set the user's personal information.
.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=INT\fR" 8
.IX Item "-q INT, --softquota=INT"
Set the user's soft quota (in bytes).
.IP "\fB\-\-quiet\fR" 8
.IX Item "--quiet"
Suppress all status messages.
.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"
.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.
.PP
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>