gen/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 Dec 26, 2005
  38 .Dt UTMPX 5
  39 .Os
  40 .Sh NAME
  41 .Nm utmpx
  42 .Nd user accounting database
  43 .Sh SYNOPSIS
  44 .In utmpx.h
  45 .Sh DESCRIPTION
  46 The
  47 .Aq Pa utmpx.h
  48 header defines the structures and functions for logging user.
  49 Currently logged in users are tracked in
  50 .Pa /var/run/utmpx .
  51 The interface to the
  52 .Nm utmpx
  53 file is described in
  54 .Xr endutxent 3 .
  55 The file is not automatically created if they do not exist; it
  56 must be created manually.
  57 .Pp
  58 Traditionally, separate files would be used to store the running log of
  59 the logins and logouts
  60 .Pf ( Pa wtmpx ) ,
  61 and the last login of each user
  62 .Pf ( Pa lastlogx ) .
  63 With the availability of the Apple system log facility
  64 .Xr asl 3 ,
  65 these separate files can be replace with log entries, which are automatically
  66 generated when
  67 .Nm utmpx
  68 entries are written.
  69 The API to access the logins and logouts is described in
  70 .Xr endutxent_wtmp 3
  71 while the last login info is accessible with
  72 .Xr getlastlogx 3 .
  73 .Pp
  74 For compatibility, changes to
  75 .Nm utmpx
  76 are reflected in
  77 .Xr utmp 3
  78 (in the
  79 .Pa utmp ,
  80 .Pa wtmp
  81 and
  82 .Pa lastlog
  83 files),
  84 but not the other way around.
  85 .Sh FILES
  86 .Bl -tag -width /var/log/utmpx -compact
  87 .It Pa /var/run/utmpx
  88 The
  89 .Nm utmpx
  90 file.
  91 .El
  92 .Sh SEE ALSO
  93 .Xr asl 3 ,
  94 .Xr endutxent 3 ,
  95 .Xr endutxent_wtmp 3 ,
  96 .Xr getlastlogx 3 ,
  97 .Xr utmp 5