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
26 .Dt UTEMPTER_ADD_RECORD 3
29 .Nm utempter_add_record ,
30 .Nm utempter_remove_added_record ,
31 .Nm utempter_remove_record ,
34 .Nm removeLineFromUtmp
35 .Nd utempter compatibility interface
41 .Fn utempter_add_record "int fd" "const char *host"
43 .Fn utempter_remove_added_record "void"
45 .Fn utempter_remove_record "int fd"
47 .Fn addToUtmp "const char *pty" "const char *host" "int fd"
49 .Fn removeFromUtmp "void"
51 .Fn removeLineFromUtmp "const char *pty" "int fd"
54 .Fn utempter_add_record
57 functions add a login record to the database for the TTY belonging to
58 the pseudo-terminal master file descriptor
60 using the username corresponding with the real user ID of the calling
61 process and the optional hostname
63 These functions are equivalent to
64 .Xr ulog_login_pseudo 3 .
67 .Fn utempter_remove_record
69 .Fn removeLineFromUtmp
70 functions mark the login session as being closed for the TTY belonging
71 to the pseudo-terminal master file descriptor
73 These functions are equivalent to
74 .Xr ulog_logout_pseudo 3 .
77 .Fn utempter_remove_added_record
80 functions have the same properties as the previously mentioned
81 functions, except that they use an internally cached value of the file
82 descriptor passed to the login functions.
89 .Fn removeLineFromUtmp
92 In this implementation, the
93 .Fn utempter_add_record ,
94 .Fn utempter_remove_added_record
96 .Fn utempter_remove_record
97 always return a value of 0.
100 .Xr ulog_login_pseudo 3
102 These functions appeared in