lib/libutil/loginx.3

   1 .\"     $NetBSD: loginx.3,v 1.2 2003/04/16 13:35:15 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 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd September 26, 2002
  31 .Dt LOGINX 3
  32 .Os
  33 .Sh NAME
  34 .Nm loginx ,
  35 .Nm logoutx ,
  36 .Nm logwtmpx
  37 .Nd login utility functions
  38 .Sh LIBRARY
  39 .Lb libutil
  40 .Sh SYNOPSIS
  41 .In sys/types.h
  42 .In libutil.h
  43 .Ft void
  44 .Fn loginx "const struct utmpx *ut"
  45 .Ft int
  46 .Fn logoutx "const char *line" "int status" "int type"
  47 .Ft void
  48 .Fn logwtmpx "const char *line" "const char *name" "const char *host" "int status" "int type"
  49 .Sh DESCRIPTION
  50 The
  51 .Fn loginx ,
  52 .Fn logoutx ,
  53 and
  54 .Fn logwtmpx
  55 operate on the
  56 .Xr utmpx 5
  57 database of currently logged in users, and the
  58 .Xr wtmpx 5
  59 database of logins and logouts.
  60 .Pp
  61 The
  62 .Fn loginx
  63 function updates the
  64 .Pa /var/run/utmpx
  65 and
  66 .Pa /var/log/wtmpx
  67 databases with the information from
  68 .Fa ut .
  69 .Pp
  70 .Fn logoutx
  71 updates the entry corresponding to
  72 .Fa line
  73 with the type and status from
  74 .Fa type
  75 and
  76 .Fa status .
  77 .Pp
  78 .Fn logwtmpx
  79 writes an entry filled with data from
  80 .Fa line ,
  81 .Fa name ,
  82 .Fa host ,
  83 .Fa status ,
  84 and
  85 .Fa type
  86 to the
  87 .Xr wtmpx 5
  88 database.
  89 .Sh RETURN VALUES
  90 .Fn logoutx
  91 returns 1 on success, and 0 if no corresponding entry was found.
  92 .Sh SEE ALSO
  93 .Xr endutxent 3 ,
  94 .Xr utmpx 5