1 =head1 NAME

     2 

     3 vrehash - Reorganize users directory\n"

     4 "Renames user directories in a virtual domain to match the current\n"

     5 "partitioning scheme

     6 

     7 =head1 SYNOPSIS

     8 

     9 B<vrehash>

    10 

    11 

    12 =head1 DESCRIPTION

    13 

    14 This program is designed to be run after the sysadmin has changed the

    15 C<user-dir-bits> or C<user-dir-slices> configuration variables.

    16 It creates a new users directory called C<new.users>, where C<users>

    17 is the configured name of the user directory.

    18 It then traverses the password table, creates a new user directory name

    19 for each user, and moves the user's mail directory to the new

    20 directory name, creating any necessary directories as it goes.

    21 Any alias entries in the password table are copied as-is.

    22 

    23 

    24 =head1 RETURN VALUE

    25 

    26 

    27 Returns 1 if any part of the process fails; 0 otherwise.

    28 

    29 

    30 

    31 =head1 NOTES

    32 

    33 

    34 When the process is completed, a the old users directory will have

    35 been moved to C<backup.users>.

    36 If no errors occurred, you should be able to safely delete this

    37 directory and all its subdirectories.

    38 Check this directory first, though, to ensure that no important files

    39 remain.

    40 

    41 

    42 

    43 =head1 WARNINGS

    44 

    45 

    46 This program is not particularly careful to clean up after itself if

    47 an error occurs.

    48 If an error occurs, you will have to check the status of the current

    49 directory, the virtual password file, and all the virtual users

    50 subdirectories in both C<users> and C<new.users>.

    51 

    52 

    53 

    54 =head1 AUTHORS

    55 

    56 Bruce Guenter <bruceg@em.ca>

    57