BSD 4_4 release

[unix-history] / usr / src / usr.bin / login / login.1

diff --git a/usr/src/usr.bin/login/login.1 b/usr/src/usr.bin/login/login.1
index ffcaac7..db59c1a 100644 (file)
--- a/usr/src/usr.bin/login/login.1
+++ b/usr/src/usr.bin/login/login.1
@@ -1,106 +1,146 @@
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1980, 1990, 1993
+.\"    The Regents of the University of California.  All rights reserved.

 .\"
 .\"

-.\"    @(#)login.1     5.1 (Berkeley) %G%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.TH LOGIN 1 "1 April 1983"
-.UC 4
-.SH NAME
-login \- sign on
-.SH SYNOPSIS
-.B login
-[ username ]
-.SH DESCRIPTION
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"    @(#)login.1     8.1 (Berkeley) 6/9/93
+.\"
+.Dd June 9, 1993
+.Dt LOGIN 1
+.Os BSD 4
+.Sh NAME
+.Nm login
+.Nd log into the computer
+.Sh SYNOPSIS
+.Nm login
+.Op Fl fp
+.Op Fl h Ar hostname
+.Op Ar user
+.Sh DESCRIPTION
+The
+.Nm login
+utility logs users (and pseudo-users) into the computer system.
+.Pp
+If no user is specified, or if a user is specified and authentication
+of the user fails,
+.Nm login
+prompts for a user name.
+Authentication of users is done via passwords.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl f
+The
+.Fl f
+option is used when a user name is specified to indicate that proper
+authentication has already been done and that no password need be
+requested.
+This option may only be used by the super-user or when an already
+logged in user is logging in as themselves.
+.It Fl h
+The
+.Fl h
+option specifies the host from which the connection was received.
+It is used by various daemons such as
+.Xr telnetd  8 .
+This option may only be used by the super-user.
+.It Fl p
+By default,
+.Nm login
+discards any previous environment.

 The
 The

-.I login
-command
-is used when a user initially
-signs on, or it may be used at any time to change
-from one user to another.
-The latter case is the one summarized above and
-described here.
-See \*(lqHow to Get Started\*(rq for how to dial up initially.
-.PP
-If
-.I login
-is invoked without an argument,
-it asks for a user name, and, if
-appropriate, a password.
-Echoing is turned off (if possible) during the typing of the password,
-so it will not appear on the written record of the
-session.
-.PP
-After a successful login,
-accounting files are updated and
-the user is informed of the
-existence of mail,
+.Fl p
+option disables this behavior.
+.El
+.Pp
+If the file
+.Pa /etc/nologin
+exists,
+.Nm login
+dislays its contents to the user and exits.
+This is used by
+.Xr shutdown  8
+to prevent users from logging in when the system is about to go down.
+.Pp
+Immediately after logging a user in,
+.Nm login
+displays the system copyright notice, the date and time the user last
+logged in, the message of the day as well as other information.
+If the file
+.Dq Pa .hushlogin
+exists in the user's home directory, all of these messages are suppressed.
+This is to simplify logins for non-human users, such as
+.Xr uucp 1 .
+.Nm Login
+then records an entry in the
+.Xr wtmp 5

 and
 and

-the message of the day is printed,
-as is the time he last logged in (unless he has a \*(lq.hushlogin\*(rq
-file in his home directory \- this
-is mostly used to make life easier for non-human users, such as
-.IR uucp ).
-.PP
-.I Login
-initializes the user and group IDs and the working directory,
-then executes a command interpreter (usually
-.IR  sh (1))
-according to specifications found in a password file.
-Argument 0 of the command interpreter is \*(lq\-sh\*(rq, or
-more generally the name of the command interpreter with
-a leading dash (\*(lq\-\*(rq) prepended.
-.PP
-Login also initializes the
-environment
-.IR environ (7)
-with information specifying home directory, command interpreter, terminal
-type (if available) and user name.
-.PP
-If the file /etc/nologin exists
-.I login
-prints its contents on the user's terminal and exits. This is
-used by
-.IR shutdown (8)
-to stop users logging in when the system is about to go down.
-.PP
-Login is recognized by
-.IR sh (1)
+.Xr utmp 5
+files and executes the user's command interpretor.
+.Pp
+Login enters information into the environment (see
+.Xr environ 7 )
+specifying the user's home directory (HOME), command interpreter (SHELL),
+search path (PATH), terminal type (TERM) and user name (both LOGNAME and
+USER).
+.Pp
+The standard shells,
+.Xr csh 1

 and
 and

-.IR csh (1)
-and executed directly (without forking).
-.SH FILES
-.ta \w'/usr/spool/mail/*\ \ 'u
-/etc/utmp      accounting
-.br
-/usr/adm/wtmp  accounting
-.br
-/usr/spool/mail/*      mail
-.br
-/etc/motd      message-of-the-day
-.br
-/etc/passwd    password file
-.br
-/etc/nologin   stops logins
-.br
-\&.hushlogin   makes login quieter
-.br
-/etc/securetty lists ttys that root may log in on
-.SH "SEE ALSO"
-init(8), getty(8), mail(1), passwd(1), passwd(5), environ(7),
-shutdown(8)
-.SH DIAGNOSTICS
-\*(lqLogin incorrect,\*(rq
-if the name or the password is bad.
-.br
-\*(lqNo Shell\*(rq, \*(lqcannot open password file\*(rq,
-\*(lqno directory\*(rq:
-consult a programming counselor.
-.SH BUGS
-An undocumented option,
-.B \-r
-is used by the remote login server,
-.IR rlogind (8C)
-to force
-.I login
-to enter into an initial connection protocol.
+.Xr sh 1 ,
+do not fork before executing the
+.Nm login
+utility.
+.Sh FILES
+.Bl -tag -width /var/mail/userXXX -compact
+.It Pa /etc/motd
+message-of-the-day
+.It Pa /etc/nologin
+disallows logins
+.It Pa /var/run/utmp
+current logins
+.It Pa /var/log/wtmp
+login account records
+.It Pa /var/mail/user
+system mailboxes
+.It Pa \&.hushlogin
+makes login quieter
+.El
+.Sh SEE ALSO
+.Xr chpass 1 ,
+.Xr passwd 1 ,
+.Xr rlogin 1 ,
+.Xr getpass 3 ,
+.Xr utmp 5 ,
+.Xr environ 7 ,
+.Sh HISTORY
+A
+.Nm login
+appeared in
+.At v6 .