xref: /netbsd-src/share/man/man5/utmpx.5 (revision 1ad9454efb13a65cd7535ccf867508cb14d9d30e)
1.\"	$NetBSD: utmpx.5,v 1.5 2006/09/19 18:55:36 wiz Exp $
2.\"
3.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Thomas Klausner.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd September 18, 2006
38.Dt UTMPX 5
39.Os
40.Sh NAME
41.Nm utmpx ,
42.Nm wtmpx ,
43.Nm lastlogx
44.Nd user accounting database
45.Sh SYNOPSIS
46.In utmpx.h
47.Sh DESCRIPTION
48In contrast to
49.Pa utmp
50and
51.Pa wtmp ,
52the extended databases in
53.Pa utmpx
54and
55.Pa wtmpx
56reserve more space for logging hostnames, and also
57information on a process' ID, termination signal and exit status.
58.Pp
59The
60.Aq Pa utmpx.h
61header defines the structures and functions for logging user.
62Currently logged in users are tracked in
63.Pa /var/run/utmpx ,
64a list of all logins and logouts, as well as all shutdowns, reboots
65and date changes, is kept in
66.Pa /var/log/wtmpx ,
67and the last login of each user is noted in
68.Pa /var/log/lastlogx .
69The files are not automatically created if they do not exist; they
70must be created manually.
71.Pp
72The interface to the
73.Nm utmpx
74file is described in
75.Xr getutxent 3 .
76.Pp
77The
78.Nm wtmpx
79file can grow rapidly on busy systems, and is normally rotated with
80.Xr newsyslog 8 .
81.Pp
82In the event of a date change, a shutdown, or a reboot, the following
83items are logged in the
84.Nm wtmpx
85file:
86.Bl -tag -width shutdownxx -compact -offset indent
87.It Li date
88The system time has been manually or automatically updated by
89.Xr date 1 .
90The command name
91.Em date
92is recorded in the field
93.Fa ut_name .
94In the field
95.Fa ut_line ,
96the character
97.Ql \\*(Ba
98indicates the time prior to the change, and the character
99.Ql \&{
100indicates the new time.
101.It Li reboot
102.It Li shutdown
103A system reboot or shutdown has been initiated.
104The character
105.Ql \&~
106is placed in the field
107.Fa ut_line ,
108and
109.Li reboot
110or
111.Li shutdown
112in the field
113.Fa ut_name
114(see
115.Xr shutdown 8
116and
117.Xr reboot 8 ) ,
118using
119.Xr logwtmpx 3 .
120.Pp
121.El
122.Sh FILES
123.Bl -tag -width /var/log/lastlogx -compact
124.It Pa /var/run/utmpx
125The
126.Nm utmpx
127file.
128.It Pa /var/log/wtmpx
129The
130.Nm wtmpx
131file.
132.It Pa /var/log/lastlogx
133The
134.Nm lastlogx
135file.
136.El
137.Sh SEE ALSO
138.Xr last 1 ,
139.Xr login 1 ,
140.Xr rwho 1 ,
141.Xr w 1 ,
142.Xr who 1 ,
143.Xr endutxent 3 ,
144.Xr logwtmpx 3 ,
145.Xr utmp 5 ,
146.Xr ac 8 ,
147.Xr init 8 ,
148.Xr newsyslog 8 ,
149.Xr reboot 8
150