Document createaccount script.

diff --git a/sync-accounts/sync-accounts b/sync-accounts/sync-accounts
index ea4e79cc089d8e341503061f1c710f6a02c659eb..6acfe4bf7e3625145761a72d63045008fca38c4a 100755 (executable)
--- a/sync-accounts/sync-accounts
+++ b/sync-accounts/sync-accounts
@@ -1,5 +1,5 @@
 #!/usr/bin/perl
-# $Id: sync-accounts,v 1.8 1999-01-03 01:30:46 ian Exp $
+# $Id: sync-accounts,v 1.9 1999-01-03 01:56:57 ian Exp $
 # usage: sync-accounts [-n] [-C<config-file>] [<host> ...]
 # options:
 #   -n     do not really do anything
@@ -72,6 +72,22 @@
 #      the PATH if necessary.  Either sameuid, or both uidmin and
 #      uidmax, must be specified, if accounts are to be created.
 #
+#      The command (which will be run with sh -c) must at least create
+#      the new account's home directory.  The passwd and group entries
+#      will not have been set up.  The following environment variables
+#      will be set, giving details about the account to be created:
+#        SYNCACCOUNT_CREATE_USER
+#        SYNCACCOUNT_CREATE_UID
+#        SYNCACCOUNT_CREATE_GID
+#        SYNCACCOUNT_CREATE_COMMENT
+#        SYNCACCOUNT_CREATE_HOME
+#        SYNCACCOUNT_CREATE_SHELL
+#      If it chooses, the script may modify the password entry which
+#      will be added to the system, by outputting a replacement
+#      password file entry.  (The password field of that is ignored.)
+#      If the script outputs a line which does not contain a : then
+#      the account will not be created after all.
+#
 #  group <glob-pattern>
 #  nogroup <glob-pattern>
 #      Specifies that the membership of the local groups specified