libexec/utmp_update/utmp_update.8

   1 .\"     $NetBSD: utmp_update.8,v 1.1 2002/12/16 22:45:15 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Thomas Klausner.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd December 12, 2002
  31 .Dt UTMP_UPDATE 8
  32 .Os
  33 .Sh NAME
  34 .Nm utmp_update
  35 .Nd update utmpx database
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Ar utmpx_entry
  39 .Sh DESCRIPTION
  40 .Nm
  41 is a helper program to allow a user to update his own
  42 .Xr utmpx 5
  43 entry.
  44 .Nm
  45 does some consistency checks on the
  46 .Xr strvis 3 Ns No -encoded
  47 .Ar utmpx_entry
  48 and then updates the
  49 .Xr utmpx 5
  50 database of currently logged in users.
  51 .Pp
  52 .Nm
  53 should not be called directly, but will normally only be called by
  54 .Xr pututxline 3
  55 if the privileges of the calling user are not sufficient.
  56 .Sh EXIT STATUS
  57 .Nm
  58 returns 0 on success, and 1 if an error occurred.
  59 .Sh SEE ALSO
  60 .Xr pututxline 3 ,
  61 .Xr utmpx 5