More minor IPI work.
[dragonfly/vkernel-mp.git] / lib / libutil / logwtmp.3
blobb6afa31129097388a2f45a0585dff755618cdccd
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/logwtmp.3,v 1.7.2.4 2001/12/17 10:08:32 ru Exp $
27 .\" $DragonFly: src/lib/libutil/logwtmp.3,v 1.2 2003/06/17 06:26:52 dillon Exp $
28 .\" "
29 .Dd December 29, 1996
30 .Os
31 .Dt LOGWTMP 3
32 .Sh NAME
33 .Nm logwtmp
34 .Nd append a new record to the wtmp file
35 .Sh LIBRARY
36 .Lb libutil
37 .Sh SYNOPSIS
38 .In sys/types.h
39 .In libutil.h
40 .Ft void
41 .Fn logwtmp "const char *line" "const char *name" "const char *host"
42 .Sh DESCRIPTION
43 The function
44 .Fn logwtmp
45 tries to append a new record to the
46 .Xr wtmp 5
47 file, using the provided arguments
48 .Ar line ,
49 .Ar name ,
50 and
51 .Ar host ,
52 and the current time.
53 .Pp
54 If the length of the hostname string
55 .Ar host
56 is longer than what would fit into the hostname field of the
57 .Xr wtmp 5
58 file, it will first be attempted to convert it into a numerical IP
59 address using
60 .Xr gethostbyname 3 .
61 Failing this, the hostname will be recorded as
62 .Qq invalid hostname .
63 .Pp
64 The calling process must have permission to write to the
65 .Xr wtmp 5
66 file.
67 .Sh RETURN VALUES
68 None.
69 .Sh SEE ALSO
70 .Xr gethostbyname 3 ,
71 .Xr login 3 ,
72 .Xr wtmp 5