xref: /netbsd/lib/libutil/loginx.3 (revision c4a72b64)
1.\"	$NetBSD: loginx.3,v 1.1 2002/09/27 15:02:27 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 September 26, 2002
38.Dt LOGINX 3
39.Os
40.Sh NAME
41.Nm loginx ,
42.Nm logoutx ,
43.Nm logwtmpx
44.Nd login utility functions
45.Sh LIBRARY
46.Lb libutil
47.Sh SYNOPSIS
48.Fd #include \*[Lt]util.h\*[Gt]
49.Ft void
50.Fn loginx "const struct utmpx *ut"
51.Ft int
52.Fn logoutx "const char *line" "int status" "int type"
53.Ft void
54.Fn logwtmpx "const char *line" "const char *name" "const char *host" "int status" "int type"
55.Sh DESCRIPTION
56The
57.Fn loginx ,
58.Fn logoutx ,
59and
60.Fn logwtmpx
61operate on the
62.Xr utmpx 5
63database of currently logged in users, and the
64.Xr wtmpx 5
65database of logins and logouts.
66.Pp
67The
68.Fn loginx
69function updates the
70.Pa /var/run/utmpx
71and
72.Pa /var/log/wtmpx
73databases with the information from
74.Fa ut .
75.Pp
76.Fn logoutx
77updates the entry corresponding to
78.Fa line
79with the type and status from
80.Fa type
81and
82.Fa status .
83.Pp
84.Fn logwtmpx
85writes an entry filled with data from
86.Fa line ,
87.Fa name ,
88.Fa host ,
89.Fa status ,
90and
91.Fa type
92to the
93.Xr wtmpx 5
94database.
95.Sh RETURN VALUES
96.Fn logoutx
97returns 1 on success, and 0 if no corresponding entry was found.
98.Sh SEE ALSO
99.Xr endutxent 3 ,
100.Xr utmpx 5
101