MFS - Use mmap() instead of malloc().
[dragonfly.git] / lib / libutil / logout.3
blob00bf2cc0fb12361f320b6f0731a8e01cfbce2a41
1 .\"
2 .\" Copyright (c) 1996 Joerg Wunsch
3 .\"
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD: src/lib/libutil/logout.3,v 1.6.2.4 2001/12/17 10:08:32 ru Exp $
27 .\" $DragonFly: src/lib/libutil/logout.3,v 1.2 2003/06/17 04:26:52 dillon Exp $
28 .\" "
29 .Dd December 29, 1996
30 .Os
31 .Dt LOGOUT 3
32 .Sh NAME
33 .Nm logout
34 .Nd remove an entry from the utmp file
35 .Sh LIBRARY
36 .Lb libutil
37 .Sh SYNOPSIS
38 .In sys/types.h
39 .In libutil.h
40 .Ft int
41 .Fn logout "const char *line"
42 .Sh DESCRIPTION
43 The function
44 .Fn logout
45 searches the
46 .Xr utmp 5
47 file for the slot described by
48 .Ar line
49 (usually a tty name).  If such a slot could be found, it will be updated
50 with a record where the
51 .Em name
52 and
53 .Em host
54 fields are empty, and the time stamp field is updated to the current time.
55 .Sh RETURN VALUES
56 .Fn Logout
57 returns 1 if the slot described by
58 .Ar line
59 has been found and updated, 0 otherwise.
60 .Sh SEE ALSO
61 .Xr login 3 ,
62 .Xr utmp 5 ,
63 .Xr wtmp 5
64 .Sh BUGS
65 The calling interface of
66 .Fn logout
67 is inconsistent with that of
68 .Xr login 3 .