commands/vadduser.html
changeset 0 6f7a81934006
child 2 b3afb9f1e801
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/commands/vadduser.html	Wed Jan 16 22:39:43 2008 +0100
@@ -0,0 +1,137 @@
+<HTML>
+<HEAD>
+<TITLE>vadduser - Add a user to a virtual domain</TITLE>
+<LINK REV="made" HREF="mailto:root@porky.devel.redhat.com">
+</HEAD>
+
+<BODY>
+
+<!-- INDEX BEGIN -->
+<!--
+
+<UL>
+
+	<LI><A HREF="#NAME">NAME</A>
+	<LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
+	<LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
+	<LI><A HREF="#OPTIONS">OPTIONS</A>
+	<LI><A HREF="#RETURN_VALUE">RETURN VALUE</A>
+	<LI><A HREF="#SEE_ALSO">SEE ALSO</A>
+	<LI><A HREF="#NOTES">NOTES</A>
+	<LI><A HREF="#AUTHORS">AUTHORS</A>
+</UL>
+-->
+<!-- INDEX END -->
+
+<P>
+<H1><A NAME="NAME">NAME</A></H1>
+<P>
+vadduser - Add a user to a virtual domain
+
+<P>
+<HR>
+<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
+<P>
+<STRONG>vadduser</STRONG>
+[<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>]
+<EM>USERNAME [ALIAS1 ...]\n"
+"or vaddalias [-f ADDRESS] USERNAME [ALIAS1 ...]</EM>
+
+
+
+<P>
+<HR>
+<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
+<P>
+This program is used to set up a user within a virtual host. If this
+program is reading from a tty, it will then ask for a password (twice, to
+make sure you typed it in correctly), otherwise it will read the password
+from the input with no prompting. It will then add the user to the virtual
+password table in the current directory and create a mail directory for the
+new user. It will also add an entry for each of the named aliases.
+
+<P>
+<HR>
+<H1><A NAME="OPTIONS">OPTIONS</A></H1>
+<DL>
+<DT><STRONG><A NAME="item__c">-c INT, --msgcount=INT</A></STRONG><DD>
+<P>
+Set the user's message count limit.
+
+<DT><STRONG><A NAME="item__D_">-D, --no-mailbox</A></STRONG><DD>
+<P>
+Do not create a mailbox for this user. Defaults to true for vaddalias.
+
+<DT><STRONG><A NAME="item__d">-d STR, --directory=STR</A></STRONG><DD>
+<P>
+Set the path to the user's mailbox. Note that this directory is
+unconditionally prefixed with ``./''.
+
+<DT><STRONG><A NAME="item__e">-e INT, --expiry=INT</A></STRONG><DD>
+<P>
+Set the account's expiry time (in seconds).
+
+<DT><STRONG><A NAME="item__f">-f STR, --forward=STR</A></STRONG><DD>
+<P>
+Add a forwarding address to this user (this may be used multiple times).
+
+<DT><STRONG><A NAME="item__P_">-P, --no-password</A></STRONG><DD>
+<P>
+Do not ask for a password, and instead set the pass phrase field to an
+unusable value.
+
+<DT><STRONG><A NAME="item__p">-p STR, --personal=STR</A></STRONG><DD>
+<P>
+Set the user's personal information.
+
+<DT><STRONG><A NAME="item__Q">-Q INT, --hardquota=INT</A></STRONG><DD>
+<P>
+Set the user's hard quota (in bytes).
+
+<DT><STRONG><A NAME="item__q">-q INT, --softquota=INT</A></STRONG><DD>
+<P>
+Set the user's soft quota (in bytes).
+
+<DT><STRONG><A NAME="item__quiet">--quiet</A></STRONG><DD>
+<P>
+Suppress all status messages.
+
+<DT><STRONG><A NAME="item__z">-z INT, --msgsize=INT</A></STRONG><DD>
+<P>
+Set the user's message size limit (in bytes).
+
+</DL>
+<P>
+<HR>
+<H1><A NAME="RETURN_VALUE">RETURN VALUE</A></H1>
+<P>
+0 if all steps were successful, non-zero otherwise. If any of the steps
+fail, a diagnostic message is printed.
+
+<P>
+<HR>
+<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
+<P>
+<CODE>vsetup(1)</CODE>
+
+<P>
+<HR>
+<H1><A NAME="NOTES">NOTES</A></H1>
+<P>
+You must have either created the users subdirectory by hand or run the
+<EM>vsetup</EM> program before using this program.
+
+<P>
+This program expects the environment variable <CODE>HOME</CODE> 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.
+
+<P>
+<HR>
+<H1><A NAME="AUTHORS">AUTHORS</A></H1>
+<P>
+Bruce Guenter &lt;<A HREF="mailto:bruceg@em.ca">bruceg@em.ca</A>&gt;
+
+</BODY>
+
+</HTML>