1.\" $NetBSD: login.3,v 1.6 2003/08/07 16:44:58 agc Exp $ 2.\" 3.\" Copyright (c) 1995 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" This code is derived from software developed by the Computer Systems 7.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract 8.\" BG 91-66 and contributed to Berkeley. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 3. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.Dd December 14, 1995 35.Dt LOGIN 3 36.Os 37.Sh NAME 38.Nm login , 39.Nm logout , 40.Nm logwtmp 41.Nd login utility functions 42.Sh LIBRARY 43.Lb libutil 44.Sh SYNOPSIS 45.In util.h 46.Ft void 47.Fn login "struct utmp *ut" 48.Ft int 49.Fn logout "const char *line" 50.Ft void 51.Fn logwtmp "const char *line" "const char *name" "const char *host" 52.Sh DESCRIPTION 53The 54.Fn login , 55.Fn logout , 56and 57.Fn logwtmp 58functions operate on the database of current users in 59.Pa /var/run/utmp 60and on the logfile 61.Pa /var/log/wtmp 62of logins and logouts. 63.Pp 64The 65.Fn login 66function updates the 67.Pa /var/run/utmp 68and 69.Pa /var/log/wtmp 70files with user information contained in 71.Fa ut . 72.Pp 73The 74.Fn logout 75function removes the entry from 76.Pa /var/run/utmp 77corresponding to the device 78.Fa line . 79.Pp 80The 81.Fn logwtmp 82function adds an entry to 83.Pa /var/log/wtmp . 84Since 85.Fn login 86will add the appropriate entry for 87.Pa /var/log/wtmp 88during a login, 89.Fn logwtmp 90is usually used for logouts. 91.Sh RETURN VALUES 92.Fn logout 93returns non-zero if it was able to find and delete an entry for 94.Fa line , 95and zero if there is no entry for 96.Fa line 97in 98.Pa /var/run/utmp . 99.Sh FILES 100.Bl -tag -width /var/run/wtmp -compact 101.It Pa /dev/\(** 102.It Pa /etc/ttys 103.It Pa /var/run/utmp 104.It Pa /var/log/wtmp 105.El 106.Sh SEE ALSO 107.Xr utmp 5 108