util/login.3

   1 .\" Copyright (c) 1995
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software developed by the Computer Systems
   5 .\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract
   6 .\" BG 91-66 and contributed to Berkeley.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .Dd December 14, 1995
  37 .Dt LOGIN 3
  38 .Os
  39 .Sh NAME
  40 .Nm login ,
  41 .Nm logout ,
  42 .Nm logwtmp
  43 .Nd login utility functions (DEPRECATED)
  44 .Sh SYNOPSIS
  45 .Fd #include <util.h>
  46 .Ft void
  47 .Fn login "struct utmp *ut"
  48 .Ft int
  49 .Fn logout "const char *line"
  50 .Ft void
  51 .Fn logwtmp "const char *line" "const char *name" "const char *host"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn login ,
  55 .Fn logout ,
  56 and
  57 .Fn logwtmp
  58 functions are
  59 .Sy DEPRECATED ;
  60 use
  61 .Xr pututxline 3
  62 instead.
  63 .Pp
  64 These functions operate on the database of current users in
  65 .Pa /var/run/utmpx
  66 and the system log file.
  67 Superuser permission is required.
  68 .Pp
  69 The
  70 .Fn login
  71 function updates the
  72 .Pa /var/run/utmpx
  73 files with user information contained in
  74 .Fa ut
  75 (after converting to a struct utmpx, as described in
  76 .Xr pututxline 3 ) .
  77 .Pp
  78 The
  79 .Fn logout
  80 function removes the entry from
  81 .Pa /var/run/utmpx
  82 corresponding to the device
  83 .Fa line .
  84 .Pp
  85 The
  86 .Fn logwtmp
  87 function adds an entry to
  88 the system log file.
  89 Since
  90 .Fn login
  91 will add the appropriate entry
  92 during a login,
  93 .Fn logwtmp
  94 is usually used for logouts.
  95 .Sh RETURN VALUES
  96 .Fn logout
  97 returns non-zero if it was able to find and delete an entry for
  98 .Fa line ,
  99 and zero if there is no entry for
 100 .Fa line
 101 in
 102 .Pa /var/run/utmpx .
 103 However, there is no error indication due to lack of permissions.
 104 .Sh FILES
 105 .Bl -tag -width /var/run/wtmp -compact
 106 .It Pa /dev/\(**
 107 .It Pa /var/run/utmpx
 108 .El
 109 .Sh SEE ALSO
 110 .Xr pututxline 3 ,
 111 .Xr utmp 5 ,
 112 .Xr utmpx 5