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