1 =head1 NAME

     2 

     3 vadduser - Add a user to a virtual domain

     4 

     5 =head1 SYNOPSIS

     6 

     7 B<vadduser>

     8 [B<-c INT>]

     9 [B<--msgcount=INT>]

    10 [B<-D>]

    11 [B<--no-mailbox>]

    12 [B<-d STR>]

    13 [B<--directory=STR>]

    14 [B<-e INT>]

    15 [B<--expiry=INT>]

    16 [B<-f STR>]

    17 [B<--forward=STR>]

    18 [B<-P>]

    19 [B<--no-password>]

    20 [B<-p STR>]

    21 [B<--personal=STR>]

    22 [B<-Q INT>]

    23 [B<--hardquota=INT>]

    24 [B<-q INT>]

    25 [B<--softquota=INT>]

    26 [B<--quiet>]

    27 [B<-z INT>]

    28 [B<--msgsize=INT>]

    29 I<USERNAME [ALIAS1 ...]\n"

    30 "or vaddalias [-f ADDRESS] USERNAME [ALIAS1 ...]>

    31 

    32 =head1 DESCRIPTION

    33 

    34 This program is used to set up a user within a virtual host.

    35 If this program is reading from a tty,

    36 it will then ask for a password (twice, to make sure you typed it in

    37 correctly), otherwise it will read the password from the input with no

    38 prompting.

    39 It will then

    40 add the user to the virtual password table in the current

    41 directory and create a mail directory for the new user.

    42 It will also add an entry for each of the named aliases.

    43 

    44 

    45 =head1 OPTIONS

    46 

    47 =over 8

    48 

    49 =item B<-c INT>, B<--msgcount=INT>

    50 

    51 Set the user's message count limit.

    52 

    53 =item B<-D>, B<--no-mailbox>

    54 

    55 Do not create a mailbox for this user. Defaults to true for vaddalias.

    56 

    57 =item B<-d STR>, B<--directory=STR>

    58 

    59 Set the path to the user's mailbox. Note that this directory is unconditionally prefixed with "./".

    60 

    61 =item B<-e INT>, B<--expiry=INT>

    62 

    63 Set the account's expiry time (in seconds).

    64 

    65 =item B<-f STR>, B<--forward=STR>

    66 

    67 Add a forwarding address to this user (this may be used multiple times).

    68 

    69 =item B<-P>, B<--no-password>

    70 

    71 Do not ask for a password, and instead set the pass phrase field to an unusable value.

    72 

    73 =item B<-p STR>, B<--personal=STR>

    74 

    75 Set the user's personal information.

    76 

    77 =item B<-Q INT>, B<--hardquota=INT>

    78 

    79 Set the user's hard quota (in bytes).

    80 

    81 =item B<-q INT>, B<--softquota=INT>

    82 

    83 Set the user's soft quota (in bytes).

    84 

    85 =item B<--quiet>

    86 

    87 Suppress all status messages.

    88 

    89 =item B<-z INT>, B<--msgsize=INT>

    90 

    91 Set the user's message size limit (in bytes).

    92 

    93 =back

    94 

    95 =head1 RETURN VALUE

    96 

    97 

    98 0 if all steps were successful, non-zero otherwise.

    99 If any of the steps fail, a diagnostic message is printed.

   100 

   101 

   102 

   103 =head1 SEE ALSO

   104 

   105 

   106 vsetup(1)

   107 

   108 

   109 

   110 =head1 NOTES

   111 

   112 You must have either created the users subdirectory by hand or run the

   113 F<vsetup> program before using this program.

   114 

   115 This program expects the environment variable C<HOME> to be set, and

   116 executes a change directory to the contents of it before starting.  It

   117 is also required that you change user to the domain owner before using

   118 these utilities.

   119 

   120 

   121 

   122 =head1 AUTHORS

   123 

   124 Bruce Guenter <bruceg@em.ca>

   125