lib/libulog/ulog_setutxfile.3

   1 .\" Copyright (c) 2009 Ed Schouten <ed@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd December 5, 2009
  28 .Os
  29 .Dt ULOG_SETUTXFILE 3
  30 .Sh NAME
  31 .Nm ulog_setutxfile ,
  32 .Nm ulog_getutxuser
  33 .Nd additional user login records management
  34 .Sh LIBRARY
  35 .Lb libulog
  36 .Sh SYNOPSIS
  37 .In ulog.h
  38 .Ft int
  39 .Fn ulog_setutxfile "int type" "const char *file"
  40 .Ft struct ulog_utmpx *
  41 .Fn ulog_getutxuser "const char *user"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn ulog_setutxfile
  45 and
  46 .Fn ulog_getutxuser
  47 functions are extensions to the standard
  48 .In ulog.h
  49 interface.
  50 .Pp
  51 The
  52 .Fn ulog_setutxfile
  53 function is similar to
  54 .Fn ulog_setutxent ,
  55 but is capable of returning an error code and also gives access to other
  56 login record files by using one of the following values for
  57 .Fa type :
  58 .Bl -tag -width UTXF_LASTLOG
  59 .It Dv UTXF_UTMP
  60 Open the default
  61 .Nm utmp
  62 file, which is indexed by TTY device.
  63 .It Dv UTXF_WTMP
  64 Open the
  65 .Nm wtmp
  66 file, which is indexed by time.
  67 .It Dv UTXF_LASTLOG
  68 Open the
  69 .Nm lastlog
  70 file, which is indexed by user ID.
  71 .El
  72 .Pp
  73 The
  74 .Fa file
  75 argument determines the file to be opened.
  76 If left null, implementation-defined default file is opened.
  77 .Pp
  78 The
  79 .Fn ulog_getutxuser
  80 searches the currently opened file until an entry is found whose
  81 .Fa ut_user
  82 is equal to the
  83 .Fa user
  84 argument.
  85 .Sh RETURN VALUES
  86 If succesful,
  87 .Fn ulog_setutxfile
  88 returns 0.
  89 It returns -1 on failure.
  90 .Sh SEE ALSO
  91 .Xr ulog_getutxent 3
  92 .Sh HISTORY
  93 These functions appeared in
  94 .Fx 9.0 .