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