usr.bin/login/login.1

   1 .\" Copyright (c) 1980, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)login.1     8.2 (Berkeley) 5/5/94
  33 .\" $FreeBSD: src/usr.bin/login/login.1,v 1.33 2007/11/30 11:02:36 philip Exp $
  34 .\" $DragonFly: src/usr.bin/login/login.1,v 1.2 2003/06/17 04:29:28 dillon Exp $
  35 .\"
  36 .Dd September 13, 2006
  37 .Dt LOGIN 1
  38 .Os
  39 .Sh NAME
  40 .Nm login
  41 .Nd log into the computer
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl fp
  45 .Op Fl h Ar hostname
  46 .Op Ar user
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility logs users (and pseudo-users) into the computer system.
  51 .Pp
  52 If no user is specified, or if a user is specified and authentication
  53 of the user fails,
  54 .Nm
  55 prompts for a user name.
  56 Authentication of users is configurable via
  57 .Xr pam 8 .
  58 Password authentication is the default.
  59 .Pp
  60 The following options are available:
  61 .Bl -tag -width indent
  62 .It Fl f
  63 When a user name is specified, this option indicates that proper
  64 authentication has already been done and that no password need be
  65 requested.
  66 This option may only be used by the super-user or when an already
  67 logged in user is logging in as themselves.
  68 .It Fl h
  69 Specify the host from which the connection was received.
  70 It is used by various daemons such as
  71 .Xr telnetd 8 .
  72 This option may only be used by the super-user.
  73 .It Fl p
  74 By default,
  75 .Nm
  76 discards any previous environment.
  77 The
  78 .Fl p
  79 option disables this behavior.
  80 .El
  81 .Pp
  82 Login access can be controlled via
  83 .Xr login.access 5
  84 or the login class in
  85 .Xr login.conf 5 ,
  86 which provides
  87 allow and deny records based on time, tty and remote host name.
  88 .Pp
  89 If the file
  90 .Pa /etc/fbtab
  91 exists,
  92 .Nm
  93 changes the protection and ownership of certain devices specified in this
  94 file.
  95 .Pp
  96 Immediately after logging a user in,
  97 .Nm
  98 displays the system copyright notice, the date and time the user last
  99 logged in, the message of the day as well as other information.
 100 If the file
 101 .Pa .hushlogin
 102 exists in the user's home directory, all of these messages are suppressed.
 103 This is to simplify logins for non-human users, such as
 104 .Xr uucp 1 .
 105 .Pp
 106 The
 107 .Nm
 108 utility enters information into the environment (see
 109 .Xr environ 7 )
 110 specifying the user's home directory (HOME), command interpreter (SHELL),
 111 search path (PATH), terminal type (TERM) and user name (both LOGNAME and
 112 USER).
 113 Other environment variables may be set due to entries in the login
 114 class capabilities database, for the login class assigned in the
 115 user's system passwd record.
 116 The login class also controls the maximum and current process resource
 117 limits granted to a login, process priorities and many other aspects of
 118 a user's login environment.
 119 .Pp
 120 Some shells may provide a builtin
 121 .Nm
 122 command which is similar or identical to this utility.
 123 Consult the
 124 .Xr builtin 1
 125 manual page.
 126 .Sh FILES
 127 .Bl -tag -width ".Pa /etc/pam.d/login" -compact
 128 .It Pa /etc/fbtab
 129 changes device protections
 130 .It Pa /etc/login.conf
 131 login class capabilities database
 132 .It Pa /etc/motd
 133 message-of-the-day
 134 .It Pa /var/mail/user
 135 system mailboxes
 136 .It Pa \&.hushlogin
 137 makes login quieter
 138 .It Pa /etc/auth.conf
 139 configure authentication services
 140 .It Pa /etc/pam.d/login
 141 .Xr pam 8
 142 configuration file
 143 .El
 144 .Sh SEE ALSO
 145 .Xr builtin 1 ,
 146 .Xr chpass 1 ,
 147 .Xr csh 1 ,
 148 .Xr newgrp 1 ,
 149 .Xr passwd 1 ,
 150 .Xr rlogin 1 ,
 151 .Xr getpass 3 ,
 152 .Xr fbtab 5 ,
 153 .Xr login.access 5 ,
 154 .Xr login.conf 5 ,
 155 .Xr environ 7
 156 .Sh HISTORY
 157 A
 158 .Nm
 159 utility appeared in
 160 .At v6 .