diff -r 000000000000 -r 6f7a81934006 commands/vrehash.pod
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/commands/vrehash.pod	Wed Jan 16 22:39:43 2008 +0100
@@ -0,0 +1,57 @@
+=head1 NAME
+
+vrehash - Reorganize users directory\n"
+"Renames user directories in a virtual domain to match the current\n"
+"partitioning scheme
+
+=head1 SYNOPSIS
+
+B<vrehash>
+
+
+=head1 DESCRIPTION
+
+This program is designed to be run after the sysadmin has changed the
+C<user-dir-bits> or C<user-dir-slices> configuration variables.
+It creates a new users directory called C<new.users>, where C<users>
+is the configured name of the user directory.
+It then traverses the password table, creates a new user directory name
+for each user, and moves the user's mail directory to the new
+directory name, creating any necessary directories as it goes.
+Any alias entries in the password table are copied as-is.
+
+
+=head1 RETURN VALUE
+
+
+Returns 1 if any part of the process fails; 0 otherwise.
+
+
+
+=head1 NOTES
+
+
+When the process is completed, a the old users directory will have
+been moved to C<backup.users>.
+If no errors occurred, you should be able to safely delete this
+directory and all its subdirectories.
+Check this directory first, though, to ensure that no important files
+remain.
+
+
+
+=head1 WARNINGS
+
+
+This program is not particularly careful to clean up after itself if
+an error occurs.
+If an error occurs, you will have to check the status of the current
+directory, the virtual password file, and all the virtual users
+subdirectories in both C<users> and C<new.users>.
+
+
+
+=head1 AUTHORS
+
+Bruce Guenter <bruceg@em.ca>
+