.\" Copyright (c) 1980, 1990 Regents of the University of California.
.\" All rights reserved.  The Berkeley software License Agreement
.\" specifies the terms and conditions for redistribution.
.\"
.\"     @(#)login.1	6.9 (Berkeley) 03/14/91
.\"
.Vx
.Vx
.Dd 
.Dt LOGIN 1
.Os BSD 4
.Sh NAME
.Nm login
.Nd sign on
.Sh SYNOPSIS
.Nm login
.Op Fl p
.Op Ar username
.Nm login
.Op Fl p
.Op Fl h Ar hostname
.Op Fl f
.Op Ar username
.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.
.Pp
If
.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.
.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
.Pp
If the file
.Pa /etc/nologin
exists,
.Nm login
prints its contents on the user's terminal and exits. This is
used by
.Xr shutdown  8
to stop users logging in when the system is about to go down.
.Pp
Login is recognized by
.Xr sh  1
and
.Xr csh  1
and executed directly (without forking).
.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
message-of-the-day
.Dp Pa /etc/passwd
password file
.Dp Pa /etc/nologin
stops logins
.Dp Pa \&.hushlogin
makes login quieter
.Dp
.Sh SEE ALSO
.Xr mail 1 ,
.Xr passwd 1 ,
.Xr rlogin 1 ,
.Xr getpass 3 ,
.Xr passwd 5 ,
.Xr utmp 5 ,
.Xr environ 7 ,
.Xr init 8 ,
.Xr getty 8 ,
.Xr shutdown 8 ,
.Sh HISTORY
.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