lib/libutil/logout.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 LOGOUT 3
  31 .Sh NAME
  32 .Nm logout
  33 .Nd remove an entry from the utmp file
  34 .Sh LIBRARY
  35 .Lb libutil
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In libutil.h
  39 .Ft int
  40 .Fn logout "const char *line"
  41 .Sh DESCRIPTION
  42 The function
  43 .Fn logout
  44 searches the
  45 .Xr utmp 5
  46 file for the slot described by
  47 .Ar line
  48 (usually a tty name).
  49 If such a slot could be found, it will be updated
  50 with a record where the
  51 .Em name
  52 and
  53 .Em host
  54 fields are empty, and the time stamp field is updated to the current time.
  55 .Sh RETURN VALUES
  56 The
  57 .Fn logout
  58 function returns 1 if the slot described by
  59 .Ar line
  60 has been found and updated, 0 otherwise.
  61 .Sh SEE ALSO
  62 .Xr login 3 ,
  63 .Xr utmp 5 ,
  64 .Xr wtmp 5
  65 .Sh BUGS
  66 The calling interface of
  67 .Fn logout
  68 is inconsistent with that of
  69 .Xr login 3 .