|
|
.\" $OpenBSD: login.3,v 1.4 2003/06/02 20:18:42 millert Exp $
|
|
|
.\"
|
|
|
.\" Copyright (c) 1995
|
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
|
.\"
|
|
|
.\" This code is derived from software developed by the Computer Systems
|
|
|
.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract
|
|
|
.\" BG 91-66 and contributed to Berkeley.
|
|
|
.\"
|
|
|
.\" 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. 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.
|
|
|
.\"
|
|
|
.\" 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.
|
|
|
.\"
|
|
|
.Dd December 14, 1995
|
|
|
.Dt LOGIN 3
|
|
|
.Os
|
|
|
.Sh NAME
|
|
|
.Nm login ,
|
|
|
.Nm logout ,
|
|
|
.Nm logwtmp
|
|
|
.Nd login utility functions
|
|
|
.Sh SYNOPSIS
|
|
|
.Fd #include <utmp.h>
|
|
|
.Fd #include <util.h>
|
|
|
.Ft void
|
|
|
.Fn login "struct utmp *ut"
|
|
|
.Ft int
|
|
|
.Fn logout "const char *line"
|
|
|
.Ft void
|
|
|
.Fn logwtmp "const char *line" "const char *name" "const char *host"
|
|
|
.Sh DESCRIPTION
|
|
|
The
|
|
|
.Fn login ,
|
|
|
.Fn logout ,
|
|
|
and
|
|
|
.Fn logwtmp
|
|
|
functions operate on the database of current users in
|
|
|
.Pa /var/run/utmp
|
|
|
and on the logfile
|
|
|
.Pa /var/log/wtmp
|
|
|
of logins and logouts.
|
|
|
.Pp
|
|
|
The
|
|
|
.Fn login
|
|
|
function updates the
|
|
|
.Pa /var/run/utmp
|
|
|
and
|
|
|
.Pa /var/log/wtmp
|
|
|
files with user information contained in
|
|
|
.Fa ut .
|
|
|
.Pp
|
|
|
The
|
|
|
.Fn logout
|
|
|
function removes the entry from
|
|
|
.Pa /var/run/utmp
|
|
|
corresponding to the device
|
|
|
.Fa line .
|
|
|
.Pp
|
|
|
The
|
|
|
.Fn logwtmp
|
|
|
function adds an entry to
|
|
|
.Pa /var/log/wtmp .
|
|
|
Since
|
|
|
.Fn login
|
|
|
will add the appropriate entry for
|
|
|
.Pa /var/log/wtmp
|
|
|
during a login,
|
|
|
.Fn logwtmp
|
|
|
is usually used for logouts.
|
|
|
.Sh RETURN VALUES
|
|
|
.Fn logout
|
|
|
returns non-zero if it was able to find and delete an entry for
|
|
|
.Fa line ,
|
|
|
and zero if there is no entry for
|
|
|
.Fa line
|
|
|
in
|
|
|
.Pa /var/run/utmp .
|
|
|
.Sh FILES
|
|
|
.Bl -tag -width /var/run/wtmp -compact
|
|
|
.It Pa /dev/\(**
|
|
|
.It Pa /etc/ttys
|
|
|
.It Pa /var/run/utmp
|
|
|
.It Pa /var/log/wtmp
|
|
|
.El
|
|
|
.Sh SEE ALSO
|
|
|
.Xr utmp 5
|