commands/vadduser.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>vadduser - Add a user to a virtual domain</TITLE>
     3 <head>
     4 <LINK REV="made" HREF="mailto:root@porky.devel.redhat.com">
     4 <title>vadduser - Add a user to a virtual domain</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 vadduser - Add a user to a virtual domain
    31 <p>vadduser - Add a user to a virtual domain</p>
       
    32 <p>
       
    33 </p>
       
    34 <hr />
       
    35 <h1><a name="synopsis">SYNOPSIS</a></h1>
       
    36 <p><strong>vadduser</strong>
       
    37 [<strong>-c INT</strong>]
       
    38 [<strong>--msgcount=INT</strong>]
       
    39 [<strong>-D</strong>]
       
    40 [<strong>--no-mailbox</strong>]
       
    41 [<strong>-d STR</strong>]
       
    42 [<strong>--directory=STR</strong>]
       
    43 [<strong>-e INT</strong>]
       
    44 [<strong>--expiry=INT</strong>]
       
    45 [<strong>-f STR</strong>]
       
    46 [<strong>--forward=STR</strong>]
       
    47 [<strong>--password=STR</strong>]
       
    48 [<strong>-P</strong>]
       
    49 [<strong>--no-password</strong>]
       
    50 [<strong>-p STR</strong>]
       
    51 [<strong>--personal=STR</strong>]
       
    52 [<strong>-Q INT</strong>]
       
    53 [<strong>--hardquota=INT</strong>]
       
    54 [<strong>-q INT</strong>]
       
    55 [<strong>--softquota=INT</strong>]
       
    56 [<strong>--quiet</strong>]
       
    57 [<strong>-z INT</strong>]
       
    58 [<strong>--msgsize=INT</strong>]
       
    59 <em>USERNAME [ALIAS1 ...]\n``
       
    60 ''or vaddalias USERNAME [ALIAS1 ...]</em></p>
       
    61 <p>
       
    62 </p>
       
    63 <hr />
       
    64 <h1><a name="description">DESCRIPTION</a></h1>
       
    65 <p>This program is used to set up a user within a virtual host.
       
    66 If this program is reading from a tty,
       
    67 it will then ask for a password (twice, to make sure you typed it in
       
    68 correctly), otherwise it will read the password from the input with no
       
    69 prompting.
       
    70 It will then
       
    71 add the user to the virtual password table in the current
       
    72 directory and create a mail directory for the new user.
       
    73 It will also add an entry for each of the named aliases.</p>
       
    74 <p>
       
    75 </p>
       
    76 <hr />
       
    77 <h1><a name="options">OPTIONS</a></h1>
       
    78 <dl>
       
    79 <dt><strong><a name="item__2dc_int_2c__2d_2dmsgcount_3dint"><strong>-c INT</strong>, <strong>--msgcount=INT</strong></a></strong><br />
       
    80 </dt>
       
    81 <dd>
       
    82 Set the user's message count limit.
       
    83 </dd>
       
    84 <p></p>
       
    85 <dt><strong><a name="item__2dd_2c__2d_2dno_2dmailbox"><strong>-D</strong>, <strong>--no-mailbox</strong></a></strong><br />
       
    86 </dt>
       
    87 <dd>
       
    88 Do not create a mailbox for this user. Defaults to true for vaddalias.
       
    89 </dd>
       
    90 <p></p>
       
    91 <dt><strong><a name="item__2dd_str_2c__2d_2ddirectory_3dstr"><strong>-d STR</strong>, <strong>--directory=STR</strong></a></strong><br />
       
    92 </dt>
       
    93 <dd>
       
    94 Set the path to the user's mailbox. Note that this directory is unconditionally prefixed with ``./''.
       
    95 </dd>
       
    96 <p></p>
       
    97 <dt><strong><a name="item__2de_int_2c__2d_2dexpiry_3dint"><strong>-e INT</strong>, <strong>--expiry=INT</strong></a></strong><br />
       
    98 </dt>
       
    99 <dd>
       
   100 Set the account's expiry time (in seconds).
       
   101 </dd>
       
   102 <p></p>
       
   103 <dt><strong><a name="item__2df_str_2c__2d_2dforward_3dstr"><strong>-f STR</strong>, <strong>--forward=STR</strong></a></strong><br />
       
   104 </dt>
       
   105 <dd>
       
   106 Add a forwarding address to this user (this may be used multiple times).
       
   107 </dd>
       
   108 <p></p>
       
   109 <dt><strong><a name="item__2d_2dpassword_3dstr"><strong>--password=STR</strong></a></strong><br />
       
   110 </dt>
       
   111 <dd>
       
   112 Encrypted password. Defaults to asking for a password.
       
   113 </dd>
       
   114 <p></p>
       
   115 <dt><strong><a name="item__2dp_2c__2d_2dno_2dpassword"><strong>-P</strong>, <strong>--no-password</strong></a></strong><br />
       
   116 </dt>
       
   117 <dd>
       
   118 Do not ask for a password, and instead set the pass phrase field to an unusable value.
       
   119 </dd>
       
   120 <p></p>
       
   121 <dt><strong><a name="item__2dp_str_2c__2d_2dpersonal_3dstr"><strong>-p STR</strong>, <strong>--personal=STR</strong></a></strong><br />
       
   122 </dt>
       
   123 <dd>
       
   124 Set the user's personal information.
       
   125 </dd>
       
   126 <p></p>
       
   127 <dt><strong><a name="item__2dq_int_2c__2d_2dhardquota_3dint"><strong>-Q INT</strong>, <strong>--hardquota=INT</strong></a></strong><br />
       
   128 </dt>
       
   129 <dd>
       
   130 Set the user's hard quota (in bytes).
       
   131 </dd>
       
   132 <p></p>
       
   133 <dt><strong><a name="item__2dq_int_2c__2d_2dsoftquota_3dint"><strong>-q INT</strong>, <strong>--softquota=INT</strong></a></strong><br />
       
   134 </dt>
       
   135 <dd>
       
   136 Set the user's soft quota (in bytes).
       
   137 </dd>
       
   138 <p></p>
       
   139 <dt><strong><a name="item__2d_2dquiet"><strong>--quiet</strong></a></strong><br />
       
   140 </dt>
       
   141 <dd>
       
   142 Suppress all status messages.
       
   143 </dd>
       
   144 <p></p>
       
   145 <dt><strong><a name="item__2dz_int_2c__2d_2dmsgsize_3dint"><strong>-z INT</strong>, <strong>--msgsize=INT</strong></a></strong><br />
       
   146 </dt>
       
   147 <dd>
       
   148 Set the user's message size limit (in bytes).
       
   149 </dd>
       
   150 <p></p></dl>
       
   151 <p>
       
   152 </p>
       
   153 <hr />
       
   154 <h1><a name="return_value">RETURN VALUE</a></h1>
       
   155 <p>0 if all steps were successful, non-zero otherwise.
       
   156 If any of the steps fail, a diagnostic message is printed.</p>
       
   157 <p>
       
   158 </p>
       
   159 <hr />
       
   160 <h1><a name="see_also">SEE ALSO</a></h1>
       
   161 <p><code>vsetup(1)</code></p>
       
   162 <p>
       
   163 </p>
       
   164 <hr />
       
   165 <h1><a name="notes">NOTES</a></h1>
       
   166 <p>You must have either created the users subdirectory by hand or run the
       
   167 <em>vsetup</em> program before using this program.</p>
       
   168 <p>This program expects the environment variable <code>HOME</code> to be set, and
       
   169 executes a change directory to the contents of it before starting.  It
       
   170 is also required that you change user to the domain owner before using
       
   171 these utilities.</p>
       
   172 <p>
       
   173 </p>
       
   174 <hr />
       
   175 <h1><a name="authors">AUTHORS</a></h1>
       
   176 <p>Bruce Guenter &lt;<a href="mailto:bruceg@em.ca">bruceg@em.ca</a>&gt;</p>
    30 
   177 
    31 <P>
   178 </body>
    32 <HR>
       
    33 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
       
    34 <P>
       
    35 <STRONG>vadduser</STRONG>
       
    36 [<STRONG>-c INT</STRONG>] [<STRONG>--msgcount=INT</STRONG>] [<STRONG>-D</STRONG>] [<STRONG>--no-mailbox</STRONG>] [<STRONG>-d STR</STRONG>] [<STRONG>--directory=STR</STRONG>] [<STRONG>-e INT</STRONG>] [<STRONG>--expiry=INT</STRONG>] [<STRONG>-f STR</STRONG>] [<STRONG>--forward=STR</STRONG>] [<STRONG>-P</STRONG>] [<STRONG>--no-password</STRONG>] [<STRONG>-p STR</STRONG>] [<STRONG>--personal=STR</STRONG>] [<STRONG>-Q INT</STRONG>] [<STRONG>--hardquota=INT</STRONG>] [<STRONG>-q INT</STRONG>] [<STRONG>--softquota=INT</STRONG>] [<STRONG>--quiet</STRONG>] [<STRONG>-z INT</STRONG>] [<STRONG>--msgsize=INT</STRONG>]
       
    37 <EM>USERNAME [ALIAS1 ...]\n"
       
    38 "or vaddalias [-f ADDRESS] USERNAME [ALIAS1 ...]</EM>
       
    39 
   179 
    40 
   180 </html>
    41 
       
    42 <P>
       
    43 <HR>
       
    44 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
       
    45 <P>
       
    46 This program is used to set up a user within a virtual host. If this
       
    47 program is reading from a tty, it will then ask for a password (twice, to
       
    48 make sure you typed it in correctly), otherwise it will read the password
       
    49 from the input with no prompting. It will then add the user to the virtual
       
    50 password table in the current directory and create a mail directory for the
       
    51 new user. It will also add an entry for each of the named aliases.
       
    52 
       
    53 <P>
       
    54 <HR>
       
    55 <H1><A NAME="OPTIONS">OPTIONS</A></H1>
       
    56 <DL>
       
    57 <DT><STRONG><A NAME="item__c">-c INT, --msgcount=INT</A></STRONG><DD>
       
    58 <P>
       
    59 Set the user's message count limit.
       
    60 
       
    61 <DT><STRONG><A NAME="item__D_">-D, --no-mailbox</A></STRONG><DD>
       
    62 <P>
       
    63 Do not create a mailbox for this user. Defaults to true for vaddalias.
       
    64 
       
    65 <DT><STRONG><A NAME="item__d">-d STR, --directory=STR</A></STRONG><DD>
       
    66 <P>
       
    67 Set the path to the user's mailbox. Note that this directory is
       
    68 unconditionally prefixed with ``./''.
       
    69 
       
    70 <DT><STRONG><A NAME="item__e">-e INT, --expiry=INT</A></STRONG><DD>
       
    71 <P>
       
    72 Set the account's expiry time (in seconds).
       
    73 
       
    74 <DT><STRONG><A NAME="item__f">-f STR, --forward=STR</A></STRONG><DD>
       
    75 <P>
       
    76 Add a forwarding address to this user (this may be used multiple times).
       
    77 
       
    78 <DT><STRONG><A NAME="item__P_">-P, --no-password</A></STRONG><DD>
       
    79 <P>
       
    80 Do not ask for a password, and instead set the pass phrase field to an
       
    81 unusable value.
       
    82 
       
    83 <DT><STRONG><A NAME="item__p">-p STR, --personal=STR</A></STRONG><DD>
       
    84 <P>
       
    85 Set the user's personal information.
       
    86 
       
    87 <DT><STRONG><A NAME="item__Q">-Q INT, --hardquota=INT</A></STRONG><DD>
       
    88 <P>
       
    89 Set the user's hard quota (in bytes).
       
    90 
       
    91 <DT><STRONG><A NAME="item__q">-q INT, --softquota=INT</A></STRONG><DD>
       
    92 <P>
       
    93 Set the user's soft quota (in bytes).
       
    94 
       
    95 <DT><STRONG><A NAME="item__quiet">--quiet</A></STRONG><DD>
       
    96 <P>
       
    97 Suppress all status messages.
       
    98 
       
    99 <DT><STRONG><A NAME="item__z">-z INT, --msgsize=INT</A></STRONG><DD>
       
   100 <P>
       
   101 Set the user's message size limit (in bytes).
       
   102 
       
   103 </DL>
       
   104 <P>
       
   105 <HR>
       
   106 <H1><A NAME="RETURN_VALUE">RETURN VALUE</A></H1>
       
   107 <P>
       
   108 0 if all steps were successful, non-zero otherwise. If any of the steps
       
   109 fail, a diagnostic message is printed.
       
   110 
       
   111 <P>
       
   112 <HR>
       
   113 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
       
   114 <P>
       
   115 <CODE>vsetup(1)</CODE>
       
   116 
       
   117 <P>
       
   118 <HR>
       
   119 <H1><A NAME="NOTES">NOTES</A></H1>
       
   120 <P>
       
   121 You must have either created the users subdirectory by hand or run the
       
   122 <EM>vsetup</EM> program before using this program.
       
   123 
       
   124 <P>
       
   125 This program expects the environment variable <CODE>HOME</CODE> to be set, and executes a change directory to the contents of it before
       
   126 starting. It is also required that you change user to the domain owner
       
   127 before using these utilities.
       
   128 
       
   129 <P>
       
   130 <HR>
       
   131 <H1><A NAME="AUTHORS">AUTHORS</A></H1>
       
   132 <P>
       
   133 Bruce Guenter &lt;<A HREF="mailto:bruceg@em.ca">bruceg@em.ca</A>&gt;
       
   134 
       
   135 </BODY>
       
   136 
       
   137 </HTML>