getent.1

   1 .\"     $NetBSD: getent.1,v 1.13 2005/09/11 23:16:15 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 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgement:
  19 .\"     This product includes software developed by the NetBSD
  20 .\"     Foundation, Inc. and its contributors.
  21 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  22 .\"    contributors may be used to endorse or promote products derived
  23 .\"    from this software without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  26 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  27 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  28 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  29 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35 .\" POSSIBILITY OF SUCH DAMAGE.
  36 .\"
  37 .\" $FreeBSD$
  38 .\"
  39 .Dd August 24, 2005
  40 .Dt GETENT 1
  41 .Os
  42 .Sh NAME
  43 .Nm getent
  44 .Nd get entries from administrative database
  45 .Sh SYNOPSIS
  46 .Nm
  47 .Ar database
  48 .Op Ar key ...
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 program retrieves and displays entries from the administrative
  53 database specified by
  54 .Ar database ,
  55 using the lookup order specified in
  56 .Xr nsswitch.conf 5 .
  57 The display format for a given
  58 .Ar database
  59 is as per the
  60 .Dq traditional
  61 file format for that database.
  62 .Pp
  63 .Ar database
  64 may be one of:
  65 .Bl -column "netgroup" -offset indent -compact
  66 .Sy Database Ta Sy Display format
  67 .It ethers Ta address name
  68 .It group Ta group:passwd:gid:[member[,member]...]
  69 .It hosts Ta address name [alias ...]
  70 .It networks Ta name network [alias ...]
  71 .It passwd Ta user:passwd:uid:gid:gecos:home_dir:shell
  72 .It protocols Ta name protocol [alias ...]
  73 .It rpc Ta name number [alias ...]
  74 .It services Ta name port/protocol [alias ...]
  75 .It shells Ta /path/to/shell
  76 .El
  77 .Pp
  78 If one or more
  79 .Ar key
  80 arguments are provided, they will be looked up in
  81 .Ar database
  82 using the appropriate function.
  83 For example,
  84 .Sy passwd
  85 supports a numeric UID or user name;
  86 .Sy hosts
  87 supports an IPv4 address, IPv6 address, or host name;
  88 and
  89 .Sy services
  90 supports a service name, service name/protocol name, numeric port, or
  91 numeric port/protocol name.
  92 .Pp
  93 If no
  94 .Ar key
  95 is provided and
  96 .Ar database
  97 supports enumeration, all entries for
  98 .Ar database
  99 will be retrieved using the appropriate enumeration function and printed.
 100 .Sh DIAGNOSTICS
 101 .Nm
 102 exits 0 on success,
 103 1 if there was an error in the command syntax,
 104 2 if one of the specified key names was not found in
 105 .Ar database ,
 106 or 3 if there is no support for enumeration on
 107 .Ar database .
 108 .Sh SEE ALSO
 109 .Xr ethers 5 ,
 110 .Xr group 5 ,
 111 .Xr hosts 5 ,
 112 .Xr networks 5 ,
 113 .Xr nsswitch.conf 5 ,
 114 .Xr passwd 5 ,
 115 .Xr protocols 5 ,
 116 .Xr rpc 5 ,
 117 .Xr services 5 ,
 118 .Xr shells 5
 119 .Sh HISTORY
 120 A
 121 .Nm
 122 command appeared in
 123 .Nx 3.0 ,
 124 and was imported into
 125 .Fx 7.0 .
 126 It was based on the command of the same name in
 127 .Tn Solaris
 128 and
 129 .Tn Linux .