1 .\" Copyright (c) 2009 Ed Schouten <ed@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
28 .Dt UTEMPTER_ADD_RECORD 3
31 .Nm utempter_add_record ,
32 .Nm utempter_remove_added_record ,
33 .Nm utempter_remove_record ,
36 .Nm removeLineFromUtmp
37 .Nd utempter compatibility interface
43 .Fn utempter_add_record "int fd" "const char *host"
45 .Fn utempter_remove_added_record "void"
47 .Fn utempter_remove_record "int fd"
49 .Fn addToUtmp "const char *pty" "const char *host" "int fd"
51 .Fn removeFromUtmp "void"
53 .Fn removeLineFromUtmp "const char *pty" "int fd"
56 .Fn utempter_add_record
59 functions add a login record to the database for the TTY belonging to
60 the pseudo-terminal master file descriptor
62 using the username corresponding with the real user ID of the calling
63 process and the optional hostname
65 These functions are equivalent to
66 .Xr ulog_login_pseudo 3 .
69 .Fn utempter_remove_record
71 .Fn removeLineFromUtmp
72 functions mark the login session as being closed for the TTY belonging
73 to the pseudo-terminal master file descriptor
75 These functions are equivalent to
76 .Xr ulog_logout_pseudo 3 .
79 .Fn utempter_remove_added_record
82 functions have the same properties as the previously mentioned
83 functions, except that they use an internally cached value of the file
84 descriptor passed to the login functions.
91 .Fn removeLineFromUtmp
94 In this implementation, the
95 .Fn utempter_add_record ,
96 .Fn utempter_remove_added_record
98 .Fn utempter_remove_record
99 always return a value of 0.
102 .Xr ulog_login_pseudo 3
104 These functions appeared in