commands/vdeluser.pod
changeset 0 6f7a81934006
equal deleted inserted replaced
-1:000000000000 0:6f7a81934006
       
     1 =head1 NAME
       
     2 
       
     3 vdeluser - Delete users from a virtual domain
       
     4 
       
     5 =head1 SYNOPSIS
       
     6 
       
     7 B<vdeluser>
       
     8 [B<-D>]
       
     9 [B<--no-mailbox>]
       
    10 [B<--quiet>]
       
    11 I<USER1 [USER2 ...]>
       
    12 
       
    13 =head1 DESCRIPTION
       
    14 
       
    15 This program will take the steps necessary to
       
    16 remove a user from a virtual domain.
       
    17 
       
    18 For each user listed on the command line, it does the following:
       
    19 
       
    20 1. It removes the named user's entry from the local password file.
       
    21 
       
    22 2. It removes any qmail delivery files that point to the named user's
       
    23 mail directory.
       
    24 
       
    25 3. It removes the user's mail directory and all of its contents
       
    26 (recursively).
       
    27 
       
    28 If any of the above steps fail, a warning is issued and processing
       
    29 continues.
       
    30 
       
    31 
       
    32 =head1 OPTIONS
       
    33 
       
    34 =over 8
       
    35 
       
    36 =item B<-D>, B<--no-mailbox>
       
    37 
       
    38 Do not delete users that have a mailbox.
       
    39 
       
    40 =item B<--quiet>
       
    41 
       
    42 Suppress all status messages.
       
    43 
       
    44 =back
       
    45 
       
    46 =head1 NOTES
       
    47 
       
    48 
       
    49 You must have either created the users subdirectory by hand or run the
       
    50 F<vsetup> program before using this program.
       
    51 
       
    52 This program expects the environment variable C<HOME> to be set, and
       
    53 executes a change directory to the contents of it before starting.  It
       
    54 is also required that you change user to the domain owner before using
       
    55 these utilities.
       
    56 
       
    57 
       
    58 
       
    59 =head1 AUTHORS
       
    60 
       
    61 Bruce Guenter <bruceg@em.ca>
       
    62