BSD 4_3_Net_2 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 a087dd0..493eb61 100644 (file)
--- a/usr/src/usr.bin/login/login.1
+++ b/usr/src/usr.bin/login/login.1
@@ -1,154 +1,146 @@
 .\" Copyright (c) 1980, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1980, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"

-.\" %sccs.include.proprietary.roff%
+.\" 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.

 .\"
 .\"

-.\"    @(#)login.1     6.10 (Berkeley) %G%
+.\" 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.

 .\"
 .\"

-.Vx
-.Dd 
+.\"    @(#)login.1     6.12 (Berkeley) 6/29/91
+.\"
+.Dd June 29, 1991

 .Dt LOGIN 1
 .Os BSD 4
 .Sh NAME
 .Nm login
 .Dt LOGIN 1
 .Os BSD 4
 .Sh NAME
 .Nm login

-.Nd sign on
+.Nd log into the computer

 .Sh SYNOPSIS
 .Nm login
 .Sh SYNOPSIS
 .Nm login

-.Op Fl p
-.Op Ar username
-.Nm login
-.Op Fl p
+.Op Fl fp

 .Op Fl h Ar hostname
 .Op Fl h Ar hostname

-.Op Fl f
-.Op Ar username
+.Op Ar user

 .Sh DESCRIPTION
 The
 .Nm login
 .Sh DESCRIPTION
 The
 .Nm login

-command
-is used when a user initially
-signs on.
-It may also be used at any time to change
-from one user to another.
-This case is the one summarized first above and described here.
-See
-.Em How to Get Started
-for how to connect initially.
-The invocation of
-.Nm login
-for initial sign-on
-is made by a system program or server using the latter form of the command
-and is described below.
+utility logs users (and pseudo-users) into the computer system.

 .Pp
 .Pp

-If
+If no user is specified, or if a user is specified and authentication
+of the user fails,

 .Nm login
 .Nm 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.
+prompts for a user name.
+Authentication of users is done via passwords.

 .Pp
 .Pp

-After a successful login,
-accounting files are updated and
-the user is informed of the
-existence of mail.
-The message of the day is printed,
-as is the time of his last login.
-Both are suppressed if he has a
-.Dq Pa .hushlogin
-file in his home directory; this
-is mostly used to make life easier for non-human users, such as
-.Xr uucp 1 .
-.Pp
-.Nm Login
-initializes the user and group IDs and the working directory,
-then executes a command interpreter (usually
-.Xr csh  1  )
-according to specifications found in a password file.
-Argument 0 of the command interpreter is
-the name of the command interpreter with
-a leading dash
-.Sq Fl .
-.Pp
-Login also modifies the
-environment (see
-.Xr environ 7 )
-with information specifying home directory, command interpreter, terminal
-type (if available) and user name.
-.Pp
-Options:
-.Pp
-.Tw Ds
-.Tp Fl p
-Causes the remainder of the environment to be preserved,
-otherwise any previous environment is discarded.
-.Tp Fl h
-option is used by
-.Xr telnetd  8
-(at initial login)
-and other servers to list the host from which
-the connection was received.
-.Tp Fl f
-Used with a username on the command line, at initial login,
-to indicate that proper authentication has already been done
-and that no password need be requested.
-This option may be used by the superuser
-or by the user specified on the command line.
-.Tp
+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
+.Fl p
+option disables this behavior.
+.El

 .Pp
 If the file
 .Pa /etc/nologin
 exists,
 .Nm login
 .Pp
 If the file
 .Pa /etc/nologin
 exists,
 .Nm login

-prints its contents on the user's terminal and exits. This is
-used by
+dislays its contents to the user and exits.
+This is used by

 .Xr shutdown  8
 .Xr shutdown  8

-to stop users logging in when the system is about to go down.
+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
+.Xr utmp 5
+files and executes the user's command interpretor.

 .Pp
 .Pp

-Login is recognized by
-.Xr sh  1
+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

-.Xr csh  1
-and executed directly (without forking).
+.Xr sh 1 ,
+do not fork before executing the
+.Nm login
+utility.

 .Sh FILES
 .Sh FILES

-.Dw /var/log/wtmp
-.Di L
-.Dp Pa /var/run/utmp
-accounting
-.Dp Pa /var/log/wtmp
-accounting
-.Dp Pa /var/mail/*
-mail
-.Dp Pa /etc/motd
+.Bl -tag -width /var/mail/userXXX -compact
+.It Pa /etc/motd

 message-of-the-day
 message-of-the-day

-.Dp Pa /etc/passwd
-password file
-.Dp Pa /etc/nologin
-stops logins
-.Dp Pa \&.hushlogin
+.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
 makes login quieter

-.Dp
+.El

 .Sh SEE ALSO
 .Sh SEE ALSO

-.Xr mail 1 ,
+.Xr chpass 1 ,

 .Xr passwd 1 ,
 .Xr rlogin 1 ,
 .Xr getpass 3 ,
 .Xr passwd 1 ,
 .Xr rlogin 1 ,
 .Xr getpass 3 ,

-.Xr passwd 5 ,

 .Xr utmp 5 ,
 .Xr environ 7 ,
 .Xr utmp 5 ,
 .Xr environ 7 ,

-.Xr init 8 ,
-.Xr getty 8 ,
-.Xr shutdown 8 ,

 .Sh HISTORY
 .Sh HISTORY

+A

 .Nm login
 .Nm login

-appeared in Version 6 AT&T Unix.
-.Sh DIAGNOSTICS
-.Dw Fl
-.Di L
-.Dp Li Login incorrect
-if the name or the password is bad.
-.Dp Li No Shell
-.Dp Li cannot open password file
-.Dp Li no directory
-consult a programming counselor.
-.Dp
+appeared in
+.At v6 .