lib/libutil/login.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$
  27 .\" "
  28 .Dd December 29, 1996
  29 .Os
  30 .Dt LOGIN 3
  31 .Sh NAME
  32 .Nm login
  33 .Nd "log a new login record to the utmp and wtmp files"
  34 .Sh SYNOPSIS
  35 .Fd #include <sys/types.h>
  36 .Fd #include <utmp.h>
  37 .Fd #include <libutil.h>
  38 .Ft void
  39 .Fn login "struct utmp *ut"
  40 .Pp
  41 Link with
  42 .Va -lutil
  43 on the
  44 .Xr cc 1
  45 command line.
  46 .Sh DESCRIPTION
  47 The function
  48 .Fn login
  49 records the
  50 .Ar ut
  51 entry being passed into the appropriate slot of the
  52 .Xr utmp 5
  53 file (according to the controlling terminal of the calling process),
  54 and appends it to the
  55 .Xr wtmp 5
  56 file.  The calling process must have permission to write to both files.
  57 .Sh RETURN VALUES
  58 None.
  59 .Sh SEE ALSO
  60 .Xr logout 3 ,
  61 .Xr ttyslot 3 ,
  62 .Xr utmp 5 ,
  63 .Xr wtmp 5
  64 .Sh BUGS
  65 The interface provided by
  66 .Fn login
  67 is rather crude.  The caller must know about the details of a
  68 .Va struct utmp .
  69 Some better abstraction needs to be worked out.