loginwindow - allow user to log in on console

SYNOPSIS

       /System/Library/CoreServices/loginwindow.app/loginwindow
        [ -LoginHook progname ] [ -LogoutHook progname ] [ -Host-
       Name hostname ] [ -ImageFile filename  ]  [  -PowerOffDis-
       abled YES ]

       Note:  Like  other  AppKit-based applications, loginwindow
       may accept these options on the command line or  from  the
       defaults  database  of  the  user running the program. For
       loginwindow this is usually root.

DESCRIPTION

       loginwindow is the login front end for the console of  the
       Mac  OS X environment.  It allows the user to enter his or
       her login name and password, verifies  those  against  the
       passwd  database,  and  executes  the Workspace program as
       that user.

       When starting up, loginwindow checks the  machine's  local
       netinfo(5) database for a property named 'username' in the
       directory /localconfig/autologin.  If the  value  of  this
       property is a valid user name, that user will be logged in
       automatically.  This automatic login can  be  disabled  by
       holding  down  the  left mouse button while loginwindow is
       starting. Note that this user will not be logged in  auto-
       matically after logging out.

       If there is an entry for the 'Workspace' parameter for the
       program 'loginwindow' in the user's defaults(1)  database,
       that program will be executed instead of Workspace.  (This
       entry should specify the full  executable  path,  not  the
       application's  wrapper  directory).  The workspace program
       is invoked with the command line

              Workspace -LoginProgram YES

       If the user name of 'exit' is  given,  with  no  password,
       then  loginwindow immediately exits with status 0.  If the
       user name of 'console' is given, then loginwindow  immedi-
       ately  exits  with status 1.  This may be used in conjunc-
       tion with the onerror feature of the ttys file.

       Before executing the Workspace program, loginwindow  looks
       up  the  following  user parameter and places it in effect
       for the duration of the user's login session:

            NSUMask

       It also clears the Pasteboard.

              gives an  integer  indicating  the  user's  desired
              default  umask.   See  the  umask(2)  call for more
              information.

       After the user has  logged  out,  loginwindow  clears  the
       Pasteboard  again  and  resets  these  parameters to their
       default values before logging in another user.

       The Preferences application can be used to  reset  all  of
       the above parameters.

OPTIONS

       -LoginHook <progname>
              provides  a  program for loginwindow to call before
              allowing a user to log in.  This program, if speci-
              fied,  will  be  called  after  the user's name and
              password  have  been  verified  aginst  the  passwd
              database.   The  intention of this hook is to allow
              system administrators to do logging of the user and
              necessary  bookkeeping with the Unix databases such
              as wtmp if desired.  By default,  loginwindow  does
              handle the utmp database, but not the other activi-
              ties performed by the terminal oriented login  pro-
              gram  (e.g.,  maintaining  the wtmp database).  The
              program is called with its first  argument  as  the
              user  name  of  the person logging in.  If the hook
              program exits with return code 0, the user will  be
              logged  in;  otherwise the login will be prevented.
              The LoginHook program should be specified as a full
              pathname.

       loginwindow  is  usally  run as the program on the console
       tty from the /etc/ttys file.

       -LogoutHook <progname>
              provides a program for loginwindow to call after  a
              user  has  logged out.  The program is invoked with
              the name of the user who just  logged  out  as  its
              first argument.

       -HostName <hostname>
              provides  a host name to be displayed in the login-
              window.  If such a name is provided,  it  is  drawn
              right  justified  in the window, 158 pixels up from
              the bottom edge. The right edges  of  the  username
              and  password  fields  and  the  hostname field are
              aligned. If the host name  provided  is  localhost,
              then the default host name is obtained from a geth-
              ostname call and that name is used instead.

              provides an alternate file to use as the background
              of  the  window  used by loginwindow.  Normally, it
              loads the resource LoginPanel.tiff  from  its  main
              bundle  and  displays  that  as  the background for
              loginwindow.  The file used should contain an image
              400  pixels  wide  by 320 pixels high.  Text fields
              for the user name and password  will  be  drawn  by
              loginwindow  at  coordinates  (112,  135) and (112,
              106); both text fields are 221 pixels wide  and  22
              pixels  high.   Subject  to these restrictions, the
              image may contain whatever is desired.   Note  that
              though  the image will be centered on the screen if
              it is larger than the default size,  the  name  and
              password  fields  are  still  drawn relative to the
              bottom left of the image itself.

       -PowerOffDisabled YES
              allows the System Administrator  to  prevent  users
              from  casually  powering  down the system.  If this
              option is supplied, then
               the 'Shut down' or 'Restart' buttons in the  login
              panel  will be disabled.  Additionally, if the user
              specifies  'Power  off'  when  exiting   from   the
              Workspace,  then  the  Workspace  will exit but the
              system will not be powered down.  This may be  used
              to  make it less likely for users to casually power
              down a system that is providing  some  shared  ser-
              vice, e.g., a file or print server.

       If  this  is done, system administrators may wish to allow
       the system to be powered down under password  control.   A
       quick  way  to  do this is to create a user named 'power',
       assign a suitable password  to  that  user,  and  set  the
       user's   loginwindow   Workspace   default   value  to  be
       /sbin/halt.

FILES

       /var/run/utmp    user/terminal database
       /etc/ttys        terminal configuration file
       /sbin/halt       program used to shut down system

       /System/Library/CoreServices/Workspace.app/Workspace
                        Default location of Workspace

       [loginwindow.app]/Resources/<language>.lproj/LoginPanel.tiff
                        Default image file

SEE ALSO

       defaults(1), utmp(5), login(8), ttys(5),  passwd(5),  net-
       info(5)

BUGS