commands/vchattr.pod
changeset 0 6f7a81934006
equal deleted inserted replaced
-1:000000000000 0:6f7a81934006
       
     1 =head1 NAME
       
     2 
       
     3 vchattr - Changes the attributes on one or more virtual users
       
     4 
       
     5 =head1 SYNOPSIS
       
     6 
       
     7 B<vchattr>
       
     8 [B<-c>]
       
     9 [B<--msgcount>]
       
    10 [B<-e>]
       
    11 [B<--expiry>]
       
    12 [B<-E>]
       
    13 [B<--enabled>]
       
    14 [B<-p>]
       
    15 [B<--personal>]
       
    16 [B<-q>]
       
    17 [B<--softquota>]
       
    18 [B<-Q>]
       
    19 [B<--hardquota>]
       
    20 [B<--quiet>]
       
    21 [B<-z>]
       
    22 [B<--msgsize>]
       
    23 I<VALUE USERNAME ...>
       
    24 
       
    25 =head1 DESCRIPTION
       
    26 
       
    27 This program changes the value of one attribute on a set of virtual
       
    28 users.  It cannot be used to change the user's password or forwarding
       
    29 addresses -- use B<vpasswd> and B<vchforwards> to accomplish those
       
    30 tasks.
       
    31 
       
    32 
       
    33 =head1 OPTIONS
       
    34 
       
    35 =over 8
       
    36 
       
    37 =item B<-c>, B<--msgcount>
       
    38 
       
    39 Set the user's message count limit.
       
    40 
       
    41 =item B<-e>, B<--expiry>
       
    42 
       
    43 Set the account's expiry time (in seconds).
       
    44 
       
    45 =item B<-E>, B<--enabled>
       
    46 
       
    47 Enable (C<1>) or disable (C<0>) 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.
       
    48 
       
    49 =item B<-p>, B<--personal>
       
    50 
       
    51 Set the user's personal information.
       
    52 
       
    53 =item B<-q>, B<--softquota>
       
    54 
       
    55 Set the user's soft quota (in bytes).
       
    56 
       
    57 =item B<-Q>, B<--hardquota>
       
    58 
       
    59 Set the user's hard quota (in bytes).
       
    60 
       
    61 =item B<--quiet>
       
    62 
       
    63 Suppress all status messages.
       
    64 
       
    65 =item B<-z>, B<--msgsize>
       
    66 
       
    67 Set the user's message size limit (in bytes).
       
    68 
       
    69 =back
       
    70 
       
    71 =head1 RETURN VALUE
       
    72 
       
    73 
       
    74 0 if the given attribute was successfully changed for all users,
       
    75 non-zero otherwise.
       
    76 If any of the steps fail, a diagnostic message is printed.
       
    77 
       
    78 
       
    79 
       
    80 =head1 SEE ALSO
       
    81 
       
    82 
       
    83 vadduser(1)
       
    84 
       
    85 
       
    86 
       
    87 =head1 NOTES
       
    88 
       
    89 
       
    90 This program expects the environment variable C<HOME> to be set, and
       
    91 executes a change directory to the contents of it before starting.  It
       
    92 is also required that you change user to the domain owner before using
       
    93 these utilities.
       
    94 
       
    95 
       
    96 
       
    97 =head1 AUTHORS
       
    98 
       
    99 Bruce Guenter <bruceg@em.ca>
       
   100