freebsd-skq/lib/libulog/ulog_setutxfile.3
Ed Schouten 444999a314 Several refinements to libulog's API.
- Only set the fields in the ulog_utmpx structure that are valid for the
  command in question. This means that strings like "shutdown" or "~"
  are not visible to the user anymore.
- Rename UTXF_* to UTXI_*, indicating the indexation, instead of using
  the `antique' filename. If we ever get rid of utmp, it makes little
  sense calling it by its old name.
2009-12-26 22:36:05 +00:00

95 lines
2.7 KiB
Groff

.\" Copyright (c) 2009 Ed Schouten <ed@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd December 5, 2009
.Os
.Dt ULOG_SETUTXFILE 3
.Sh NAME
.Nm ulog_setutxfile ,
.Nm ulog_getutxuser
.Nd additional user login records management
.Sh LIBRARY
.Lb libulog
.Sh SYNOPSIS
.In ulog.h
.Ft int
.Fn ulog_setutxfile "int index" "const char *file"
.Ft struct ulog_utmpx *
.Fn ulog_getutxuser "const char *user"
.Sh DESCRIPTION
The
.Fn ulog_setutxfile
and
.Fn ulog_getutxuser
functions are extensions to the standard
.In ulog.h
interface.
.Pp
The
.Fn ulog_setutxfile
function is similar to
.Fn ulog_setutxent ,
but is capable of returning an error code and also gives access to other
login record files by using one of the following values for
.Fa index :
.Bl -tag -width UTXI_TIME
.It Dv UTXI_TTY
Open the default
.Nm utmp
file, which is indexed by TTY device.
.It Dv UTXI_TIME
Open the
.Nm wtmp
file, which is indexed by time.
.It Dv UTXI_USER
Open the
.Nm lastlog
file, which is indexed by user ID.
.El
.Pp
The
.Fa file
argument determines the file to be opened.
If left null, an implementation-defined default file is opened.
.Pp
The
.Fn ulog_getutxuser
searches the currently opened file until an entry is found whose
.Fa ut_user
is equal to the
.Fa user
argument.
.Sh RETURN VALUES
If succesful,
.Fn ulog_setutxfile
returns 0.
It returns -1 on failure.
.Sh SEE ALSO
.Xr ulog_getutxent 3
.Sh HISTORY
These functions appeared in
.Fx 9.0 .