diff -r 000000000000 -r 6f7a81934006 commands/vadduser.pod
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/commands/vadduser.pod	Wed Jan 16 22:39:43 2008 +0100
@@ -0,0 +1,125 @@
+=head1 NAME
+
+vadduser - Add a user to a virtual domain
+
+=head1 SYNOPSIS
+
+B<vadduser>
+[B<-c INT>]
+[B<--msgcount=INT>]
+[B<-D>]
+[B<--no-mailbox>]
+[B<-d STR>]
+[B<--directory=STR>]
+[B<-e INT>]
+[B<--expiry=INT>]
+[B<-f STR>]
+[B<--forward=STR>]
+[B<-P>]
+[B<--no-password>]
+[B<-p STR>]
+[B<--personal=STR>]
+[B<-Q INT>]
+[B<--hardquota=INT>]
+[B<-q INT>]
+[B<--softquota=INT>]
+[B<--quiet>]
+[B<-z INT>]
+[B<--msgsize=INT>]
+I<USERNAME [ALIAS1 ...]\n"
+"or vaddalias [-f ADDRESS] USERNAME [ALIAS1 ...]>
+
+=head1 DESCRIPTION
+
+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.
+
+
+=head1 OPTIONS
+
+=over 8
+
+=item B<-c INT>, B<--msgcount=INT>
+
+Set the user's message count limit.
+
+=item B<-D>, B<--no-mailbox>
+
+Do not create a mailbox for this user. Defaults to true for vaddalias.
+
+=item B<-d STR>, B<--directory=STR>
+
+Set the path to the user's mailbox. Note that this directory is unconditionally prefixed with "./".
+
+=item B<-e INT>, B<--expiry=INT>
+
+Set the account's expiry time (in seconds).
+
+=item B<-f STR>, B<--forward=STR>
+
+Add a forwarding address to this user (this may be used multiple times).
+
+=item B<-P>, B<--no-password>
+
+Do not ask for a password, and instead set the pass phrase field to an unusable value.
+
+=item B<-p STR>, B<--personal=STR>
+
+Set the user's personal information.
+
+=item B<-Q INT>, B<--hardquota=INT>
+
+Set the user's hard quota (in bytes).
+
+=item B<-q INT>, B<--softquota=INT>
+
+Set the user's soft quota (in bytes).
+
+=item B<--quiet>
+
+Suppress all status messages.
+
+=item B<-z INT>, B<--msgsize=INT>
+
+Set the user's message size limit (in bytes).
+
+=back
+
+=head1 RETURN VALUE
+
+
+0 if all steps were successful, non-zero otherwise.
+If any of the steps fail, a diagnostic message is printed.
+
+
+
+=head1 SEE ALSO
+
+
+vsetup(1)
+
+
+
+=head1 NOTES
+
+You must have either created the users subdirectory by hand or run the
+F<vsetup> program before using this program.
+
+This program expects the environment variable C<HOME> 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.
+
+
+
+=head1 AUTHORS
+
+Bruce Guenter <bruceg@em.ca>
+