gen/NetBSD/utmpx.5

   1 .\"     $NetBSD: utmpx.5,v 1.2 2003/04/16 13:35:24 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 26, 2002
  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
  48 The
  49 .Aq Pa utmpx.h
  50 header defines the structures and functions for logging user.
  51 Currently logged in users are tracked in
  52 .Pa /var/run/utmpx ,
  53 a list of all logins and logouts, as well as all shutdowns, reboots
  54 and date changes, is kept in
  55 .Pa /var/log/wtmpx ,
  56 and the last login of each user is noted in
  57 .Pa /var/log/lastlogx .
  58 The files are not automatically created if they do not exist; they
  59 must be created manually.
  60 .Pp
  61 The interface to the
  62 .Nm utmpx
  63 file is described in
  64 .Xr endutxent 3 .
  65 .Pp
  66 The
  67 .Nm wtmpx
  68 file can grow rapidly on busy systems, and is normally rotated with
  69 .Xr newsyslog 8 .
  70 .Pp
  71 In the event of a date change, a shutdown, or a reboot, the following
  72 items are logged in the
  73 .Nm wtmpx
  74 file:
  75 .Bl -tag -width shutdownxx -compact -offset indent
  76 .It Li date
  77 The system time has been manually or automatically updated by
  78 .Xr date 1 .
  79 The command name
  80 .Em date
  81 is recorded in the field
  82 .Fa ut_name .
  83 In the field
  84 .Fa ut_line ,
  85 the character
  86 .Ql \\*(Ba
  87 indicates the time prior to the change, and the character
  88 .Ql \&{
  89 indicates the new time.
  90 .It Li reboot
  91 .It Li shutdown
  92 A system reboot or shutdown has been initiated.
  93 The character
  94 .Ql \&~
  95 is placed in the field
  96 .Fa ut_line ,
  97 and
  98 .Li reboot
  99 or
 100 .Li shutdown
 101 in the field
 102 .Fa ut_name
 103 (see
 104 .Xr shutdown 8
 105 and
 106 .Xr reboot 8 ) ,
 107 using
 108 .Xr logwtmpx 3 .
 109 .Pp
 110 .El
 111 .Sh FILES
 112 .Bl -tag -width /var/log/lastlogx -compact
 113 .It Pa /var/run/utmpx
 114 The
 115 .Nm utmpx
 116 file.
 117 .It Pa /var/log/wtmpx
 118 The
 119 .Nm wtmpx
 120 file.
 121 .It Pa /var/log/lastlogx
 122 The
 123 .Nm lastlogx
 124 file.
 125 .El
 126 .Sh SEE ALSO
 127 .Xr last 1 ,
 128 .Xr login 1 ,
 129 .Xr rwho 1 ,
 130 .Xr w 1 ,
 131 .Xr who 1 ,
 132 .Xr endutxent 3 ,
 133 .Xr logwtmpx 3 ,
 134 .Xr ac 8 ,
 135 .Xr init 8 ,
 136 .Xr newsyslog 8 ,
 137 .Xr reboot 8