usr.bin/getent/getent.1

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