commands/vchattr.html
changeset 2 b3afb9f1e801
parent 0 6f7a81934006
equal deleted inserted replaced
1:30113bfbe723 2:b3afb9f1e801
     1 <HTML>
     1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
     2 <HEAD>
     2 <html xmlns="http://www.w3.org/1999/xhtml">
     3 <TITLE>vchattr - Changes the attributes on one or more virtual users</TITLE>
     3 <head>
     4 <LINK REV="made" HREF="mailto:root@porky.devel.redhat.com">
     4 <title>vchattr - Changes the attributes on one or more virtual users</title>
     5 </HEAD>
     5 <link rev="made" href="mailto:Gentoo@lorien.untroubled.org" />
       
     6 </head>
     6 
     7 
     7 <BODY>
     8 <body style="background-color: white">
     8 
     9 
       
    10 <p><a name="__index__"></a></p>
     9 <!-- INDEX BEGIN -->
    11 <!-- INDEX BEGIN -->
    10 <!--
    12 <!--
    11 
    13 
    12 <UL>
    14 <ul>
    13 
    15 
    14 	<LI><A HREF="#NAME">NAME</A>
    16 	<li><a href="#name">NAME</a></li>
    15 	<LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
    17 	<li><a href="#synopsis">SYNOPSIS</a></li>
    16 	<LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
    18 	<li><a href="#description">DESCRIPTION</a></li>
    17 	<LI><A HREF="#OPTIONS">OPTIONS</A>
    19 	<li><a href="#options">OPTIONS</a></li>
    18 	<LI><A HREF="#RETURN_VALUE">RETURN VALUE</A>
    20 	<li><a href="#return_value">RETURN VALUE</a></li>
    19 	<LI><A HREF="#SEE_ALSO">SEE ALSO</A>
    21 	<li><a href="#see_also">SEE ALSO</a></li>
    20 	<LI><A HREF="#NOTES">NOTES</A>
    22 	<li><a href="#notes">NOTES</a></li>
    21 	<LI><A HREF="#AUTHORS">AUTHORS</A>
    23 	<li><a href="#authors">AUTHORS</a></li>
    22 </UL>
    24 </ul>
    23 -->
    25 -->
    24 <!-- INDEX END -->
    26 <!-- INDEX END -->
    25 
    27 
    26 <P>
    28 <p>
    27 <H1><A NAME="NAME">NAME</A></H1>
    29 </p>
    28 <P>
    30 <h1><a name="name">NAME</a></h1>
    29 vchattr - Changes the attributes on one or more virtual users
    31 <p>vchattr - Changes the attributes on one or more virtual users</p>
       
    32 <p>
       
    33 </p>
       
    34 <hr />
       
    35 <h1><a name="synopsis">SYNOPSIS</a></h1>
       
    36 <p><strong>vchattr</strong>
       
    37 [<strong>-c</strong>]
       
    38 [<strong>--msgcount</strong>]
       
    39 [<strong>-e</strong>]
       
    40 [<strong>--expiry</strong>]
       
    41 [<strong>-E</strong>]
       
    42 [<strong>--enabled</strong>]
       
    43 [<strong>-p</strong>]
       
    44 [<strong>--personal</strong>]
       
    45 [<strong>-q</strong>]
       
    46 [<strong>--softquota</strong>]
       
    47 [<strong>-Q</strong>]
       
    48 [<strong>--hardquota</strong>]
       
    49 [<strong>--quiet</strong>]
       
    50 [<strong>-z</strong>]
       
    51 [<strong>--msgsize</strong>]
       
    52 <em>VALUE USERNAME ...</em></p>
       
    53 <p>
       
    54 </p>
       
    55 <hr />
       
    56 <h1><a name="description">DESCRIPTION</a></h1>
       
    57 <p>This program changes the value of one attribute on a set of virtual
       
    58 users.  It cannot be used to change the user's password or forwarding
       
    59 addresses -- use <strong>vpasswd</strong> and <strong>vchforwards</strong> to accomplish those
       
    60 tasks.</p>
       
    61 <p>
       
    62 </p>
       
    63 <hr />
       
    64 <h1><a name="options">OPTIONS</a></h1>
       
    65 <dl>
       
    66 <dt><strong><a name="item__2dc_2c__2d_2dmsgcount"><strong>-c</strong>, <strong>--msgcount</strong></a></strong><br />
       
    67 </dt>
       
    68 <dd>
       
    69 Set the user's message count limit.
       
    70 </dd>
       
    71 <p></p>
       
    72 <dt><strong><a name="item__2de_2c__2d_2dexpiry"><strong>-e</strong>, <strong>--expiry</strong></a></strong><br />
       
    73 </dt>
       
    74 <dd>
       
    75 Set the account's expiry time (in seconds).
       
    76 </dd>
       
    77 <p></p>
       
    78 <dt><strong><a name="item__2de_2c__2d_2denabled"><strong>-E</strong>, <strong>--enabled</strong></a></strong><br />
       
    79 </dt>
       
    80 <dd>
       
    81 Enable (<code>1</code>) or disable (<code>0</code>) 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.
       
    82 </dd>
       
    83 <p></p>
       
    84 <dt><strong><a name="item__2dp_2c__2d_2dpersonal"><strong>-p</strong>, <strong>--personal</strong></a></strong><br />
       
    85 </dt>
       
    86 <dd>
       
    87 Set the user's personal information.
       
    88 </dd>
       
    89 <p></p>
       
    90 <dt><strong><a name="item__2dq_2c__2d_2dsoftquota"><strong>-q</strong>, <strong>--softquota</strong></a></strong><br />
       
    91 </dt>
       
    92 <dd>
       
    93 Set the user's soft quota (in bytes).
       
    94 </dd>
       
    95 <p></p>
       
    96 <dt><strong><a name="item__2dq_2c__2d_2dhardquota"><strong>-Q</strong>, <strong>--hardquota</strong></a></strong><br />
       
    97 </dt>
       
    98 <dd>
       
    99 Set the user's hard quota (in bytes).
       
   100 </dd>
       
   101 <p></p>
       
   102 <dt><strong><a name="item__2d_2dquiet"><strong>--quiet</strong></a></strong><br />
       
   103 </dt>
       
   104 <dd>
       
   105 Suppress all status messages.
       
   106 </dd>
       
   107 <p></p>
       
   108 <dt><strong><a name="item__2dz_2c__2d_2dmsgsize"><strong>-z</strong>, <strong>--msgsize</strong></a></strong><br />
       
   109 </dt>
       
   110 <dd>
       
   111 Set the user's message size limit (in bytes).
       
   112 </dd>
       
   113 <p></p></dl>
       
   114 <p>
       
   115 </p>
       
   116 <hr />
       
   117 <h1><a name="return_value">RETURN VALUE</a></h1>
       
   118 <p>0 if the given attribute was successfully changed for all users,
       
   119 non-zero otherwise.
       
   120 If any of the steps fail, a diagnostic message is printed.</p>
       
   121 <p>
       
   122 </p>
       
   123 <hr />
       
   124 <h1><a name="see_also">SEE ALSO</a></h1>
       
   125 <p><code>vadduser(1)</code></p>
       
   126 <p>
       
   127 </p>
       
   128 <hr />
       
   129 <h1><a name="notes">NOTES</a></h1>
       
   130 <p>This program expects the environment variable <code>HOME</code> to be set, and
       
   131 executes a change directory to the contents of it before starting.  It
       
   132 is also required that you change user to the domain owner before using
       
   133 these utilities.</p>
       
   134 <p>
       
   135 </p>
       
   136 <hr />
       
   137 <h1><a name="authors">AUTHORS</a></h1>
       
   138 <p>Bruce Guenter &lt;<a href="mailto:bruceg@em.ca">bruceg@em.ca</a>&gt;</p>
    30 
   139 
    31 <P>
   140 </body>
    32 <HR>
       
    33 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
       
    34 <P>
       
    35 <STRONG>vchattr</STRONG>
       
    36 [<STRONG>-c</STRONG>] [<STRONG>--msgcount</STRONG>] [<STRONG>-e</STRONG>] [<STRONG>--expiry</STRONG>] [<STRONG>-E</STRONG>] [<STRONG>--enabled</STRONG>] [<STRONG>-p</STRONG>] [<STRONG>--personal</STRONG>] [<STRONG>-q</STRONG>] [<STRONG>--softquota</STRONG>] [<STRONG>-Q</STRONG>] [<STRONG>--hardquota</STRONG>] [<STRONG>--quiet</STRONG>] [<STRONG>-z</STRONG>] [<STRONG>--msgsize</STRONG>]
       
    37 <EM>VALUE USERNAME ...</EM>
       
    38 
   141 
    39 
   142 </html>
    40 
       
    41 <P>
       
    42 <HR>
       
    43 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
       
    44 <P>
       
    45 This program changes the value of one attribute on a set of virtual users.
       
    46 It cannot be used to change the user's password or forwarding addresses --
       
    47 use <STRONG>vpasswd</STRONG> and <STRONG>vchforwards</STRONG> to accomplish those tasks.
       
    48 
       
    49 <P>
       
    50 <HR>
       
    51 <H1><A NAME="OPTIONS">OPTIONS</A></H1>
       
    52 <DL>
       
    53 <DT><STRONG><A NAME="item__c_">-c, --msgcount</A></STRONG><DD>
       
    54 <P>
       
    55 Set the user's message count limit.
       
    56 
       
    57 <DT><STRONG><A NAME="item__e_">-e, --expiry</A></STRONG><DD>
       
    58 <P>
       
    59 Set the account's expiry time (in seconds).
       
    60 
       
    61 <DT><STRONG><A NAME="item__E_">-E, --enabled</A></STRONG><DD>
       
    62 <P>
       
    63 Enable (<CODE>1</CODE>) or disable (<CODE>0</CODE>) delivery to the virtual user's mailbox directory. This does not delete
       
    64 the mailbox or any of the messages contained in or, nor prevent the user
       
    65 from logging in.
       
    66 
       
    67 <DT><STRONG><A NAME="item__p_">-p, --personal</A></STRONG><DD>
       
    68 <P>
       
    69 Set the user's personal information.
       
    70 
       
    71 <DT><STRONG><A NAME="item__q_">-q, --softquota</A></STRONG><DD>
       
    72 <P>
       
    73 Set the user's soft quota (in bytes).
       
    74 
       
    75 <DT><STRONG><A NAME="item__Q_">-Q, --hardquota</A></STRONG><DD>
       
    76 <P>
       
    77 Set the user's hard quota (in bytes).
       
    78 
       
    79 <DT><STRONG><A NAME="item__quiet">--quiet</A></STRONG><DD>
       
    80 <P>
       
    81 Suppress all status messages.
       
    82 
       
    83 <DT><STRONG><A NAME="item__z_">-z, --msgsize</A></STRONG><DD>
       
    84 <P>
       
    85 Set the user's message size limit (in bytes).
       
    86 
       
    87 </DL>
       
    88 <P>
       
    89 <HR>
       
    90 <H1><A NAME="RETURN_VALUE">RETURN VALUE</A></H1>
       
    91 <P>
       
    92 0 if the given attribute was successfully changed for all users, non-zero
       
    93 otherwise. If any of the steps fail, a diagnostic message is printed.
       
    94 
       
    95 <P>
       
    96 <HR>
       
    97 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
       
    98 <P>
       
    99 <CODE>vadduser(1)</CODE>
       
   100 
       
   101 <P>
       
   102 <HR>
       
   103 <H1><A NAME="NOTES">NOTES</A></H1>
       
   104 <P>
       
   105 This program expects the environment variable <CODE>HOME</CODE> to be set, and executes a change directory to the contents of it before
       
   106 starting. It is also required that you change user to the domain owner
       
   107 before using these utilities.
       
   108 
       
   109 <P>
       
   110 <HR>
       
   111 <H1><A NAME="AUTHORS">AUTHORS</A></H1>
       
   112 <P>
       
   113 Bruce Guenter &lt;<A HREF="mailto:bruceg@em.ca">bruceg@em.ca</A>&gt;
       
   114 
       
   115 </BODY>
       
   116 
       
   117 </HTML>