usr.bin/getent/getent.1

   1 .\"     $NetBSD: getent.1,v 1.18 2009/03/11 13:53:09 joerg Exp $
   2 .\"
   3 .\" Copyright (c) 2004 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Luke Mewburn.
   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 May 14, 2008
  31 .Dt GETENT 1
  32 .Os
  33 .Sh NAME
  34 .Nm getent
  35 .Nd get entries from administrative database
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Ar database
  39 .Op Ar key ...
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 program retrieves and displays entries from the administrative
  44 database specified by
  45 .Ar database ,
  46 using the lookup order specified in
  47 .Xr nsswitch.conf 5 .
  48 The display format for a given
  49 .Ar database
  50 is as per the
  51 .Dq traditional
  52 file format for that database.
  53 .Pp
  54 .Ar database
  55 may be one of:
  56 .Bl -column "protocols" "user:passwd:uid:gid:gecos:home_dir:shell" -offset indent -compact
  57 .It Sy Database Ta Sy Display format
  58 .It disktab Ta entry
  59 .It ethers Ta address name
  60 .It gettytab Ta entry
  61 .It group Ta group:passwd:gid:[member[,member]...]
  62 .It hosts Ta address name [alias ...]
  63 .It netgroup Ta (host,user,domain) [...]
  64 .It networks Ta name network [alias ...]
  65 .It passwd Ta user:passwd:uid:gid:gecos:home_dir:shell
  66 .It printcap Ta entry
  67 .It protocols Ta name protocol [alias ...]
  68 .It rpc Ta name number [alias ...]
  69 .It services Ta name port/protocol [alias ...]
  70 .It shells Ta /path/to/shell
  71 .It termcap Ta entry
  72 .El
  73 .Pp
  74 If one or more
  75 .Ar key
  76 arguments are provided, they will be looked up in
  77 .Ar database
  78 using the appropriate function.
  79 For example,
  80 .Sy passwd
  81 supports a numeric UID or user name;
  82 .Sy hosts
  83 supports an IPv4 address, IPv6 address, or host name;
  84 and
  85 .Sy services
  86 supports a service name, service name/protocol name, numeric port, or
  87 numeric port/protocol name.
  88 .Pp
  89 If no
  90 .Ar key
  91 is provided and
  92 .Ar database
  93 supports enumeration, all entries for
  94 .Ar database
  95 will be retrieved using the appropriate enumeration function and printed.
  96 .Pp
  97 For
  98 .Xr cgetcap 3
  99 style databases (
 100 .Sy disktab ,
 101 .Sy printcap ,
 102 .Sy termcap )
 103 specifying a key, lists the entry for that key, and specifying more arguments
 104 after the key are used as fields in that key, and only the values of the keys
 105 are returned.
 106 For boolean keys
 107 .Dv true
 108 is returned if the key is found. If a key is not found, then
 109 .Dv false
 110 is always
 111 returned.
 112 .Sh DIAGNOSTICS
 113 .Nm
 114 exits 0 on success,
 115 1 if there was an error in the command syntax,
 116 2 if one of the specified key names was not found in
 117 .Ar database ,
 118 or 3 if there is no support for enumeration on
 119 .Ar database .
 120 .Sh SEE ALSO
 121 .Xr cgetcap 3 ,
 122 .Xr disktab 5 ,
 123 .Xr ethers 5 ,
 124 .Xr gettytab 5 ,
 125 .Xr group 5 ,
 126 .Xr hosts 5 ,
 127 .Xr networks 5 ,
 128 .Xr nsswitch.conf 5 ,
 129 .Xr passwd 5 ,
 130 .Xr protocols 5 ,
 131 .Xr printcap 5 ,
 132 .Xr rpc 5 ,
 133 .Xr services 5 ,
 134 .Xr shells 5 ,
 135 .Xr termcap 5
 136 .Sh HISTORY
 137 A
 138 .Nm
 139 command appeared in
 140 .Nx 3.0 .
 141 It was based on the command of the same name in
 142 .Tn Solaris
 143 and
 144 .Tn Linux .