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$
  34 .\"
  35 .Dd October 16, 2004
  36 .Dt LOGIN 1
  37 .Os
  38 .Sh NAME
  39 .Nm login
  40 .Nd log into the computer
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl fp
  44 .Op Fl h Ar hostname
  45 .Op Ar user
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility logs users (and pseudo-users) into the computer system.
  50 .Pp
  51 If no user is specified, or if a user is specified and authentication
  52 of the user fails,
  53 .Nm
  54 prompts for a user name.
  55 Authentication of users is configurable via
  56 .Xr pam 8 .
  57 Password authentication is the default.
  58 .Pp
  59 The following options are available:
  60 .Bl -tag -width indent
  61 .It Fl f
  62 When a user name is specified, this option indicates that proper
  63 authentication has already been done and that no password need be
  64 requested.
  65 This option may only be used by the super-user or when an already
  66 logged in user is logging in as themselves.
  67 .It Fl h
  68 Specify the host from which the connection was received.
  69 It is used by various daemons such as
  70 .Xr telnetd 8 .
  71 This option may only be used by the super-user.
  72 .It Fl p
  73 By default,
  74 .Nm
  75 discards any previous environment.
  76 The
  77 .Fl p
  78 option disables this behavior.
  79 .El
  80 .Pp
  81 If the file
  82 .Pa /etc/login.access
  83 exists,
  84 .Nm
  85 checks to see if the user and host pair are specifically allowed or denied
  86 access.
  87 Login access may also be controlled via the login class, which provides
  88 allow and deny records based on time, tty and remote host name.
  89 .Pp
  90 If the file
  91 .Pa /etc/fbtab
  92 exists,
  93 .Nm
  94 changes the protection and ownership of certain devices specified in this
  95 file.
  96 .Pp
  97 Immediately after logging a user in,
  98 .Nm
  99 displays the system copyright notice, the date and time the user last
 100 logged in, the message of the day as well as other information.
 101 If the file
 102 .Pa .hushlogin
 103 exists in the user's home directory, all of these messages are suppressed.
 104 This is to simplify logins for non-human users, such as
 105 .Xr uucp 1 .
 106 .Pp
 107 The
 108 .Nm
 109 utility enters information into the environment (see
 110 .Xr environ 7 )
 111 specifying the user's home directory (HOME), command interpreter (SHELL),
 112 search path (PATH), terminal type (TERM) and user name (both LOGNAME and
 113 USER).
 114 Other environment variables may be set due to entries in the login
 115 class capabilities database, for the login class assigned in the
 116 user's system passwd record.
 117 The login class also controls the maximum and current process resource
 118 limits granted to a login, process priorities and many other aspects of
 119 a user's login environment.
 120 .Pp
 121 Some shells may provide a builtin
 122 .Nm
 123 command which is similar or identical to this utility.
 124 Consult the
 125 .Xr builtin 1
 126 manual page.
 127 .Sh FILES
 128 .Bl -tag -width ".Pa /etc/login.access" -compact
 129 .It Pa /etc/fbtab
 130 changes device protections
 131 .It Pa /etc/login.access
 132 login access control table
 133 .It Pa /etc/login.conf
 134 login class capabilities database
 135 .It Pa /etc/motd
 136 message-of-the-day
 137 .It Pa /var/mail/user
 138 system mailboxes
 139 .It Pa \&.hushlogin
 140 makes login quieter
 141 .It Pa /etc/auth.conf
 142 configure authentication services
 143 .It Pa /etc/pam.d/login
 144 .Xr pam 8
 145 configuration file
 146 .El
 147 .Sh SEE ALSO
 148 .Xr builtin 1 ,
 149 .Xr chpass 1 ,
 150 .Xr csh 1 ,
 151 .Xr passwd 1 ,
 152 .Xr rlogin 1 ,
 153 .Xr getpass 3 ,
 154 .Xr fbtab 5 ,
 155 .Xr login.access 5 ,
 156 .Xr login.conf 5 ,
 157 .Xr environ 7 ,
 158 .Xr pam 8
 159 .Sh HISTORY
 160 A
 161 .Nm
 162 utility appeared in
 163 .At v6 .