1.\" Copyright (c) 2009 Ed Schouten <ed@FreeBSD.org> 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 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. 12.\" 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 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd December 6, 2009 28.Dt UTEMPTER_ADD_RECORD 3 29.Os 30.Sh NAME 31.Nm utempter_add_record , 32.Nm utempter_remove_added_record , 33.Nm utempter_remove_record , 34.Nm addToUtmp , 35.Nm removeFromUtmp , 36.Nm removeLineFromUtmp 37.Nd utempter compatibility interface 38.Sh LIBRARY 39.Lb libulog 40.Sh SYNOPSIS 41.In utempter.h 42.Ft int 43.Fn utempter_add_record "int fd" "const char *host" 44.Ft int 45.Fn utempter_remove_added_record "void" 46.Ft int 47.Fn utempter_remove_record "int fd" 48.Ft void 49.Fn addToUtmp "const char *pty" "const char *host" "int fd" 50.Ft void 51.Fn removeFromUtmp "void" 52.Ft void 53.Fn removeLineFromUtmp "const char *pty" "int fd" 54.Sh DESCRIPTION 55The 56.Fn utempter_add_record 57and 58.Fn addToUtmp 59functions add a login record to the database for the TTY belonging to 60the pseudo-terminal master file descriptor 61.Fa fd , 62using the username corresponding with the real user ID of the calling 63process and the optional hostname 64.Fa host . 65These functions are equivalent to 66.Xr ulog_login_pseudo 3 . 67.Pp 68The 69.Fn utempter_remove_record 70and 71.Fn removeLineFromUtmp 72functions mark the login session as being closed for the TTY belonging 73to the pseudo-terminal master file descriptor 74.Fa fd . 75These functions are equivalent to 76.Xr ulog_logout_pseudo 3 . 77.Pp 78The 79.Fn utempter_remove_added_record 80and 81.Fn removeFromUtmp 82functions have the same properties as the previously mentioned 83functions, except that they use an internally cached value of the file 84descriptor passed to the login functions. 85.Pp 86The 87.Fa pty 88arguments of 89.Fn addToUtmp 90and 91.Fn removeLineFromUtmp 92are unused. 93.Sh RETURN VALUES 94In this implementation, the 95.Fn utempter_add_record , 96.Fn utempter_remove_added_record 97and 98.Fn utempter_remove_record 99always return a value of 0. 100.Sh SEE ALSO 101.Xr pututxline 3 , 102.Xr ulog_login_pseudo 3 103.Sh HISTORY 104These functions appeared in 105.Fx 9.0 . 106