NAME

       sync-accounts-createuser - helper/hook program for sync-accounts

SYNOPSIS

       SYNCUSER_CREATE_var=value... sync-accounts-createuser

DESCRIPTION

       sync-accounts-createuser is invoked by sync-accounts when sync-accounts is creating a local account.

       It  must  perform  all of the tasks involved with local account creation except for the actual changes to
       the password, shadow and group databases.

       At the very minimum, it must create the new account's home directory (with appropriate permissions).  The
       supplied sync-accounts-createuser script does exactly that.

       It may also suggest to sync-accounts modifications to the new account's passwd entry.

INVOCATION

       When sync-accounts-createuser is invoked, the passwd and group entries will not yet have been set up,  so
       it may not rely on them.  sync-accounts-createuser will not be supplied with any arguments.  However, the
       following environment variables will be set, giving details about the account to be created:
         SYNCUSER_CREATE_USER
         SYNCUSER_CREATE_UID
         SYNCUSER_CREATE_GID
         SYNCUSER_CREATE_COMMENT
         SYNCUSER_CREATE_HOME
         SYNCUSER_CREATE_SHELL

RESULTS

       sync-accounts-createuser should usually produce no output.

       It can inhibit the creation of the user by outputting a single line not containing a colon; in this case,
       a diagnostic message will be written to sync-accounts's logfile, and the user will be skipped.

       Alternatively,  it may write out an alternative password file entry, in which case sync-accounts will use
       the supplied data for the local passwd file instead of that from the remote host.  The line should be  in
       Sys-V passwd file format (regardless of localformat or remoteformat settings).  The username field should
       be taken from SYNCUSER_CREATE_USER, and the password field should be x.

EXIT STATUS

       0      All went well, or we wrote a line without a colon to say that the account should not be created.

       any other
              There were serious problems and sync-accounts should bomb out immediately.

FILES

       None.

ENVIRONMENT

       See above.

BUGS

       The  supplied  sync-accounts-createuser  does  not check that it was not supplied with any arguments; nor
       does it check that the SYNCUSER_CREATE_* variables are set, or have sensible values.

AUTHOR

       sync-accounts-createuser and this manpage were written by Ian Jackson <ian@chiark.greenend.org.uk>.  They
       are Copyright 1999-2002 Ian Jackson <ian@davenant.greenend.org.uk>.  This manpage forms part of the sync-
       accounts package.

       sync-accounts-createuser and the sync-accounts package are free software; you can redistribute it  and/or
       modify it under the terms of the GNU General Public License as published by the Free Software Foundation;
       either version 3, or (at your option) any later version.

       This  is  distributed  in  the  hope  that  it will be useful, but WITHOUT ANY WARRANTY; without even the
       implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See  the  GNU  General  Public
       License for more details.

       You  should  have  received  a  copy  of  the GNU General Public License along with this program; if not,
       consult the Free Software Foundation's website at www.fsf.org, or the GNU Project website at www.gnu.org.

SEE ALSO

       sync-accounts(8), sync-accounts(5), passwd(5)

Greenend                                         14th July 2002                      SYNC-ACCOUNTS-CREATEUSER(8)