commands/vchattr.1
author "Tomas Zeman <tzeman@volny.cz>"
Sun, 20 Jan 2008 00:22:25 +0100
changeset 3 3d1d327cfa68
parent 2 b3afb9f1e801
permissions -rw-r--r--
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 "VCHATTR 1"
.TH VCHATTR 1 "2005-09-03" "vmailmgr 0.97" "VMailMgr Tools Documentation"
.SH "NAME"
vchattr \- Changes the attributes on one or more virtual users
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBvchattr\fR
[\fB\-c\fR]
[\fB\-\-msgcount\fR]
[\fB\-e\fR]
[\fB\-\-expiry\fR]
[\fB\-E\fR]
[\fB\-\-enabled\fR]
[\fB\-p\fR]
[\fB\-\-personal\fR]
[\fB\-q\fR]
[\fB\-\-softquota\fR]
[\fB\-Q\fR]
[\fB\-\-hardquota\fR]
[\fB\-\-quiet\fR]
[\fB\-z\fR]
[\fB\-\-msgsize\fR]
\&\fI\s-1VALUE\s0 \s-1USERNAME\s0 ...\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This program changes the value of one attribute on a set of virtual
users.  It cannot be used to change the user's password or forwarding
addresses \*(-- use \fBvpasswd\fR and \fBvchforwards\fR to accomplish those
tasks.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-c\fR, \fB\-\-msgcount\fR" 8
.IX Item "-c, --msgcount"
Set the user's message count limit.
.IP "\fB\-e\fR, \fB\-\-expiry\fR" 8
.IX Item "-e, --expiry"
Set the account's expiry time (in seconds).
.IP "\fB\-E\fR, \fB\-\-enabled\fR" 8
.IX Item "-E, --enabled"
Enable (\f(CW1\fR) or disable (\f(CW0\fR) delivery to the virtual user's mailbox directory.  This does not delete the mailbox or any of the messages contained in or, nor prevent the user from logging in.
.IP "\fB\-p\fR, \fB\-\-personal\fR" 8
.IX Item "-p, --personal"
Set the user's personal information.
.IP "\fB\-q\fR, \fB\-\-softquota\fR" 8
.IX Item "-q, --softquota"
Set the user's soft quota (in bytes).
.IP "\fB\-Q\fR, \fB\-\-hardquota\fR" 8
.IX Item "-Q, --hardquota"
Set the user's hard quota (in bytes).
.IP "\fB\-\-quiet\fR" 8
.IX Item "--quiet"
Suppress all status messages.
.IP "\fB\-z\fR, \fB\-\-msgsize\fR" 8
.IX Item "-z, --msgsize"
Set the user's message size limit (in bytes).
.SH "RETURN VALUE"
.IX Header "RETURN VALUE"
0 if the given attribute was successfully changed for all users,
non-zero otherwise.
If any of the steps fail, a diagnostic message is printed.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIvadduser\fR\|(1)
.SH "NOTES"
.IX Header "NOTES"
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>