commands/vchattr.1
changeset 2 b3afb9f1e801
parent 0 6f7a81934006
equal deleted inserted replaced
1:30113bfbe723 2:b3afb9f1e801
     1 .rn '' }`
     1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
     2 ''' $RCSfile$$Revision$$Date$
     2 .\"
     3 '''
     3 .\" Standard preamble:
     4 ''' $Log$
     4 .\" ========================================================================
     5 '''
     5 .de Sh \" Subsection heading
     6 .de Sh
       
     7 .br
     6 .br
     8 .if t .Sp
     7 .if t .Sp
     9 .ne 5
     8 .ne 5
    10 .PP
     9 .PP
    11 \fB\\$1\fR
    10 \fB\\$1\fR
    12 .PP
    11 .PP
    13 ..
    12 ..
    14 .de Sp
    13 .de Sp \" Vertical space (when we can't use .PP)
    15 .if t .sp .5v
    14 .if t .sp .5v
    16 .if n .sp
    15 .if n .sp
    17 ..
    16 ..
    18 .de Ip
    17 .de Vb \" Begin verbatim text
    19 .br
       
    20 .ie \\n(.$>=3 .ne \\$3
       
    21 .el .ne 3
       
    22 .IP "\\$1" \\$2
       
    23 ..
       
    24 .de Vb
       
    25 .ft CW
    18 .ft CW
    26 .nf
    19 .nf
    27 .ne \\$1
    20 .ne \\$1
    28 ..
    21 ..
    29 .de Ve
    22 .de Ve \" End verbatim text
    30 .ft R
    23 .ft R
    31 
       
    32 .fi
    24 .fi
    33 ..
    25 ..
    34 '''
    26 .\" Set up some character translations and predefined strings.  \*(-- will
    35 '''
    27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
    36 '''     Set up \*(-- to give an unbreakable dash;
    28 .\" double quote, and \*(R" will give a right double quote.  | will give a
    37 '''     string Tr holds user defined translation string.
    29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
    38 '''     Bell System Logo is used as a dummy character.
    30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
    39 '''
    31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
    40 .tr \(*W-|\(bv\*(Tr
    32 .tr \(*W-|\(bv\*(Tr
       
    33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
    41 .ie n \{\
    34 .ie n \{\
    42 .ds -- \(*W-
    35 .    ds -- \(*W-
    43 .ds PI pi
    36 .    ds PI pi
    44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
    37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
    45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
    38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
    46 .ds L" ""
    39 .    ds L" ""
    47 .ds R" ""
    40 .    ds R" ""
    48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
    41 .    ds C` ""
    49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
    42 .    ds C' ""
    50 '''   such as .IP and .SH, which do another additional levels of
       
    51 '''   double-quote interpretation
       
    52 .ds M" """
       
    53 .ds S" """
       
    54 .ds N" """""
       
    55 .ds T" """""
       
    56 .ds L' '
       
    57 .ds R' '
       
    58 .ds M' '
       
    59 .ds S' '
       
    60 .ds N' '
       
    61 .ds T' '
       
    62 'br\}
    43 'br\}
    63 .el\{\
    44 .el\{\
    64 .ds -- \(em\|
    45 .    ds -- \|\(em\|
    65 .tr \*(Tr
    46 .    ds PI \(*p
    66 .ds L" ``
    47 .    ds L" ``
    67 .ds R" ''
    48 .    ds R" ''
    68 .ds M" ``
       
    69 .ds S" ''
       
    70 .ds N" ``
       
    71 .ds T" ''
       
    72 .ds L' `
       
    73 .ds R' '
       
    74 .ds M' `
       
    75 .ds S' '
       
    76 .ds N' `
       
    77 .ds T' '
       
    78 .ds PI \(*p
       
    79 'br\}
    49 'br\}
    80 .\"	If the F register is turned on, we'll generate
    50 .\"
    81 .\"	index entries out stderr for the following things:
    51 .\" If the F register is turned on, we'll generate index entries on stderr for
    82 .\"		TH	Title 
    52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
    83 .\"		SH	Header
    53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
    84 .\"		Sh	Subsection 
    54 .\" output yourself in some meaningful fashion.
    85 .\"		Ip	Item
    55 .if \nF \{\
    86 .\"		X<>	Xref  (embedded
    56 .    de IX
    87 .\"	Of course, you have to process the output yourself
    57 .    tm Index:\\$1\t\\n%\t"\\$2"
    88 .\"	in some meaninful fashion.
    58 ..
    89 .if \nF \{
    59 .    nr % 0
    90 .de IX
    60 .    rr F
    91 .tm Index:\\$1\t\\n%\t"\\$2"
    61 .\}
    92 ..
    62 .\"
    93 .nr % 0
    63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
    94 .rr F
    64 .\" way too many mistakes in technical documents.
    95 .\}
    65 .hy 0
    96 .TH VCHATTR 1 "vmailmgr 0.96.9" "2000-09-30" "VMailMgr Tools Documentation"
       
    97 .UC
       
    98 .if n .hy 0
       
    99 .if n .na
    66 .if n .na
   100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
    67 .\"
   101 .de CQ          \" put $1 in typewriter font
    68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
   102 .ft CW
    69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
   103 'if n "\c
    70 .    \" fudge factors for nroff and troff
   104 'if t \\&\\$1\c
       
   105 'if n \\&\\$1\c
       
   106 'if n \&"
       
   107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
       
   108 '.ft R
       
   109 ..
       
   110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
       
   111 .	\" AM - accent mark definitions
       
   112 .bd B 3
       
   113 .	\" fudge factors for nroff and troff
       
   114 .if n \{\
    71 .if n \{\
   115 .	ds #H 0
    72 .    ds #H 0
   116 .	ds #V .8m
    73 .    ds #V .8m
   117 .	ds #F .3m
    74 .    ds #F .3m
   118 .	ds #[ \f1
    75 .    ds #[ \f1
   119 .	ds #] \fP
    76 .    ds #] \fP
   120 .\}
    77 .\}
   121 .if t \{\
    78 .if t \{\
   122 .	ds #H ((1u-(\\\\n(.fu%2u))*.13m)
    79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
   123 .	ds #V .6m
    80 .    ds #V .6m
   124 .	ds #F 0
    81 .    ds #F 0
   125 .	ds #[ \&
    82 .    ds #[ \&
   126 .	ds #] \&
    83 .    ds #] \&
   127 .\}
    84 .\}
   128 .	\" simple accents for nroff and troff
    85 .    \" simple accents for nroff and troff
   129 .if n \{\
    86 .if n \{\
   130 .	ds ' \&
    87 .    ds ' \&
   131 .	ds ` \&
    88 .    ds ` \&
   132 .	ds ^ \&
    89 .    ds ^ \&
   133 .	ds , \&
    90 .    ds , \&
   134 .	ds ~ ~
    91 .    ds ~ ~
   135 .	ds ? ?
    92 .    ds /
   136 .	ds ! !
       
   137 .	ds /
       
   138 .	ds q
       
   139 .\}
    93 .\}
   140 .if t \{\
    94 .if t \{\
   141 .	ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
    95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
   142 .	ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
    96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
   143 .	ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
    97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
   144 .	ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
    98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
   145 .	ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
    99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
   146 .	ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
   100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
   147 .	ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
   101 .\}
   148 .	ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
   102 .    \" troff and (daisy-wheel) nroff accents
   149 .	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'
       
   150 .\}
       
   151 .	\" troff and (daisy-wheel) nroff accents
       
   152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
   103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
   153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
   104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
   154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
       
   155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
       
   156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
       
   157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
       
   158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
   105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
   159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
   106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
   160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
   107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
   161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
   108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
   162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
   109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
   163 .ds ae a\h'-(\w'a'u*4/10)'e
   110 .ds ae a\h'-(\w'a'u*4/10)'e
   164 .ds Ae A\h'-(\w'A'u*4/10)'E
   111 .ds Ae A\h'-(\w'A'u*4/10)'E
   165 .ds oe o\h'-(\w'o'u*4/10)'e
   112 .    \" corrections for vroff
   166 .ds Oe O\h'-(\w'O'u*4/10)'E
       
   167 .	\" corrections for vroff
       
   168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
   113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
   169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
   114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
   170 .	\" for low resolution devices (crt and lpr)
   115 .    \" for low resolution devices (crt and lpr)
   171 .if \n(.H>23 .if \n(.V>19 \
   116 .if \n(.H>23 .if \n(.V>19 \
   172 \{\
   117 \{\
   173 .	ds : e
   118 .    ds : e
   174 .	ds 8 ss
   119 .    ds 8 ss
   175 .	ds v \h'-1'\o'\(aa\(ga'
   120 .    ds o a
   176 .	ds _ \h'-1'^
   121 .    ds d- d\h'-1'\(ga
   177 .	ds . \h'-1'.
   122 .    ds D- D\h'-1'\(hy
   178 .	ds 3 3
   123 .    ds th \o'bp'
   179 .	ds o a
   124 .    ds Th \o'LP'
   180 .	ds d- d\h'-1'\(ga
   125 .    ds ae ae
   181 .	ds D- D\h'-1'\(hy
   126 .    ds Ae AE
   182 .	ds th \o'bp'
       
   183 .	ds Th \o'LP'
       
   184 .	ds ae ae
       
   185 .	ds Ae AE
       
   186 .	ds oe oe
       
   187 .	ds Oe OE
       
   188 .\}
   127 .\}
   189 .rm #[ #] #H #V #F C
   128 .rm #[ #] #H #V #F C
       
   129 .\" ========================================================================
       
   130 .\"
       
   131 .IX Title "VCHATTR 1"
       
   132 .TH VCHATTR 1 "2005-09-03" "vmailmgr 0.97" "VMailMgr Tools Documentation"
   190 .SH "NAME"
   133 .SH "NAME"
   191 vchattr \- Changes the attributes on one or more virtual users
   134 vchattr \- Changes the attributes on one or more virtual users
   192 .SH "SYNOPSIS"
   135 .SH "SYNOPSIS"
   193 \fBvchattr\fR
   136 .IX Header "SYNOPSIS"
       
   137 \&\fBvchattr\fR
   194 [\fB\-c\fR]
   138 [\fB\-c\fR]
   195 [\fB--msgcount\fR]
   139 [\fB\-\-msgcount\fR]
   196 [\fB\-e\fR]
   140 [\fB\-e\fR]
   197 [\fB--expiry\fR]
   141 [\fB\-\-expiry\fR]
   198 [\fB\-E\fR]
   142 [\fB\-E\fR]
   199 [\fB--enabled\fR]
   143 [\fB\-\-enabled\fR]
   200 [\fB\-p\fR]
   144 [\fB\-p\fR]
   201 [\fB--personal\fR]
   145 [\fB\-\-personal\fR]
   202 [\fB\-q\fR]
   146 [\fB\-q\fR]
   203 [\fB--softquota\fR]
   147 [\fB\-\-softquota\fR]
   204 [\fB\-Q\fR]
   148 [\fB\-Q\fR]
   205 [\fB--hardquota\fR]
   149 [\fB\-\-hardquota\fR]
   206 [\fB--quiet\fR]
   150 [\fB\-\-quiet\fR]
   207 [\fB\-z\fR]
   151 [\fB\-z\fR]
   208 [\fB--msgsize\fR]
   152 [\fB\-\-msgsize\fR]
   209 \fIVALUE USERNAME ...\fR
   153 \&\fI\s-1VALUE\s0 \s-1USERNAME\s0 ...\fR
   210 .SH "DESCRIPTION"
   154 .SH "DESCRIPTION"
       
   155 .IX Header "DESCRIPTION"
   211 This program changes the value of one attribute on a set of virtual
   156 This program changes the value of one attribute on a set of virtual
   212 users.  It cannot be used to change the user's password or forwarding
   157 users.  It cannot be used to change the user's password or forwarding
   213 addresses -- use \fBvpasswd\fR and \fBvchforwards\fR to accomplish those
   158 addresses \*(-- use \fBvpasswd\fR and \fBvchforwards\fR to accomplish those
   214 tasks.
   159 tasks.
   215 .SH "OPTIONS"
   160 .SH "OPTIONS"
   216 .Ip "\fB\-c\fR, \fB--msgcount\fR" 8
   161 .IX Header "OPTIONS"
       
   162 .IP "\fB\-c\fR, \fB\-\-msgcount\fR" 8
       
   163 .IX Item "-c, --msgcount"
   217 Set the user's message count limit.
   164 Set the user's message count limit.
   218 .Ip "\fB\-e\fR, \fB--expiry\fR" 8
   165 .IP "\fB\-e\fR, \fB\-\-expiry\fR" 8
       
   166 .IX Item "-e, --expiry"
   219 Set the account's expiry time (in seconds).
   167 Set the account's expiry time (in seconds).
   220 .Ip "\fB\-E\fR, \fB--enabled\fR" 8
   168 .IP "\fB\-E\fR, \fB\-\-enabled\fR" 8
       
   169 .IX Item "-E, --enabled"
   221 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.
   170 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.
   222 .Ip "\fB\-p\fR, \fB--personal\fR" 8
   171 .IP "\fB\-p\fR, \fB\-\-personal\fR" 8
       
   172 .IX Item "-p, --personal"
   223 Set the user's personal information.
   173 Set the user's personal information.
   224 .Ip "\fB\-q\fR, \fB--softquota\fR" 8
   174 .IP "\fB\-q\fR, \fB\-\-softquota\fR" 8
       
   175 .IX Item "-q, --softquota"
   225 Set the user's soft quota (in bytes).
   176 Set the user's soft quota (in bytes).
   226 .Ip "\fB\-Q\fR, \fB--hardquota\fR" 8
   177 .IP "\fB\-Q\fR, \fB\-\-hardquota\fR" 8
       
   178 .IX Item "-Q, --hardquota"
   227 Set the user's hard quota (in bytes).
   179 Set the user's hard quota (in bytes).
   228 .Ip "\fB--quiet\fR" 8
   180 .IP "\fB\-\-quiet\fR" 8
       
   181 .IX Item "--quiet"
   229 Suppress all status messages.
   182 Suppress all status messages.
   230 .Ip "\fB\-z\fR, \fB--msgsize\fR" 8
   183 .IP "\fB\-z\fR, \fB\-\-msgsize\fR" 8
       
   184 .IX Item "-z, --msgsize"
   231 Set the user's message size limit (in bytes).
   185 Set the user's message size limit (in bytes).
   232 .SH "RETURN VALUE"
   186 .SH "RETURN VALUE"
       
   187 .IX Header "RETURN VALUE"
   233 0 if the given attribute was successfully changed for all users,
   188 0 if the given attribute was successfully changed for all users,
   234 non-zero otherwise.
   189 non-zero otherwise.
   235 If any of the steps fail, a diagnostic message is printed.
   190 If any of the steps fail, a diagnostic message is printed.
   236 .SH "SEE ALSO"
   191 .SH "SEE ALSO"
   237 \fIvadduser\fR\|(1)
   192 .IX Header "SEE ALSO"
       
   193 \&\fIvadduser\fR\|(1)
   238 .SH "NOTES"
   194 .SH "NOTES"
   239 This program expects the environment variable \f(CWHOME\fR to be set, and
   195 .IX Header "NOTES"
       
   196 This program expects the environment variable \f(CW\*(C`HOME\*(C'\fR to be set, and
   240 executes a change directory to the contents of it before starting.  It
   197 executes a change directory to the contents of it before starting.  It
   241 is also required that you change user to the domain owner before using
   198 is also required that you change user to the domain owner before using
   242 these utilities.
   199 these utilities.
   243 .SH "AUTHORS"
   200 .SH "AUTHORS"
       
   201 .IX Header "AUTHORS"
   244 Bruce Guenter <bruceg@em.ca>
   202 Bruce Guenter <bruceg@em.ca>
   245 
       
   246 .rn }` ''
       
   247 .IX Title "VCHATTR 1"
       
   248 .IX Name "vchattr - Changes the attributes on one or more virtual users"
       
   249 
       
   250 .IX Header "NAME"
       
   251 
       
   252 .IX Header "SYNOPSIS"
       
   253 
       
   254 .IX Header "DESCRIPTION"
       
   255 
       
   256 .IX Header "OPTIONS"
       
   257 
       
   258 .IX Item "\fB\-c\fR, \fB--msgcount\fR"
       
   259 
       
   260 .IX Item "\fB\-e\fR, \fB--expiry\fR"
       
   261 
       
   262 .IX Item "\fB\-E\fR, \fB--enabled\fR"
       
   263 
       
   264 .IX Item "\fB\-p\fR, \fB--personal\fR"
       
   265 
       
   266 .IX Item "\fB\-q\fR, \fB--softquota\fR"
       
   267 
       
   268 .IX Item "\fB\-Q\fR, \fB--hardquota\fR"
       
   269 
       
   270 .IX Item "\fB--quiet\fR"
       
   271 
       
   272 .IX Item "\fB\-z\fR, \fB--msgsize\fR"
       
   273 
       
   274 .IX Header "RETURN VALUE"
       
   275 
       
   276 .IX Header "SEE ALSO"
       
   277 
       
   278 .IX Header "NOTES"
       
   279 
       
   280 .IX Header "AUTHORS"
       
   281