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