usr.sbin/user/userinfo.8

   1 .\" $NetBSD: userinfo.8,v 1.15 2008/02/27 19:12:56 reed Exp $ */
   2 .\"
   3 .\" Copyright (c) 1999 Alistair G. Crooks.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote
  14 .\"    products derived from this software without specific prior written
  15 .\"    permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
  18 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  21 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  25 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26 .\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27 .\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\"
  30 .Dd November 16, 2005
  31 .Dt USERINFO 8
  32 .Os
  33 .Sh NAME
  34 .Nm userinfo
  35 .Nd displays user information
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl e
  39 .Ar user
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 utility retrieves the user information from the system.
  44 The
  45 .Nm
  46 utility is only available if built with
  47 .Dv EXTENSIONS .
  48 See
  49 .Xr user 8
  50 for more information.
  51 .Pp
  52 The following command line option is recognised:
  53 .Bl -tag -width Ds
  54 .It Fl e
  55 Return 0 if the user exists, and non-zero if the
  56 user does not exist, on the system.
  57 No information is displayed.
  58 This form of the command is useful for
  59 scripts which need to check whether a particular user
  60 name or uid is already in use on the system.
  61 .El
  62 .Pp
  63 The
  64 .Ar user
  65 argument may either be a user's name, or a uid.
  66 .Sh EXIT STATUS
  67 .Ex -std userinfo
  68 .Sh SEE ALSO
  69 .Xr passwd 5 ,
  70 .Xr group 8 ,
  71 .Xr user 8 ,
  72 .Xr useradd 8 ,
  73 .Xr userdel 8
  74 .Sh HISTORY
  75 The
  76 .Nm
  77 utility first appeared in
  78 .Nx 1.5 .
  79 It is based on the
  80 .Ar addnerd
  81 package by the same author.
  82 .Sh AUTHORS
  83 The
  84 .Nm
  85 utility was written by
  86 .An Alistair G. Crooks
  87 .Aq agc@NetBSD.org .