lib/libutil/logwtmp.3

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