diff options
Diffstat (limited to 'lib/libulog/ulog_setutxfile.3')
-rw-r--r-- | lib/libulog/ulog_setutxfile.3 | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/lib/libulog/ulog_setutxfile.3 b/lib/libulog/ulog_setutxfile.3 new file mode 100644 index 0000000..9760a16 --- /dev/null +++ b/lib/libulog/ulog_setutxfile.3 @@ -0,0 +1,94 @@ +.\" 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 type" "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 type : +.Bl -tag -width UTXF_LASTLOG +.It Dv UTXF_UTMP +Open the default +.Nm utmp +file, which is indexed by TTY device. +.It Dv UTXF_WTMP +Open the +.Nm wtmp +file, which is indexed by time. +.It Dv UTXF_LASTLOG +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, 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 . |