1.\" $NetBSD: getent.1,v 1.21 2010/02/04 09:48:35 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 February 3, 2010 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 41The 42.Nm 43program retrieves and displays entries from the administrative 44database specified by 45.Ar database , 46using the lookup order specified in 47.Xr nsswitch.conf 5 . 48The display format for a given 49.Ar database 50is as per the 51.Dq traditional 52file format for that database. 53.Pp 54.Ar database 55may 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.El 72.Pp 73If one or more 74.Ar key 75arguments are provided, they will be looked up in 76.Ar database 77using the appropriate function. 78For example, 79.Sy passwd 80supports a numeric UID or user name; 81.Sy hosts 82supports an IPv4 address, IPv6 address, or host name; 83and 84.Sy services 85supports a service name, service name/protocol name, numeric port, or 86numeric port/protocol name. 87.Pp 88If no 89.Ar key 90is provided and 91.Ar database 92supports enumeration, all entries for 93.Ar database 94will be retrieved using the appropriate enumeration function and printed. 95.Pp 96For 97.Xr cgetcap 3 98style databases 99.Sy ( disktab , 100.Sy printcap ) 101specifying a key, lists the entry for that key, and specifying more arguments 102after the key are used as fields in that key, and only the values of the keys 103are returned. 104For boolean keys 105.Dv true 106is returned if the key is found. 107If a key is not found, then 108.Dv false 109is always 110returned. 111.Sh DIAGNOSTICS 112.Nm 113exits 0 on success, 1141 if there was an error in the command syntax, 1152 if one of the specified key names was not found in 116.Ar database , 117or 3 if there is no support for enumeration on 118.Ar database . 119.Sh SEE ALSO 120.Xr cgetcap 3 , 121.Xr disktab 5 , 122.Xr ethers 5 , 123.Xr gettytab 5 , 124.Xr group 5 , 125.Xr hosts 5 , 126.Xr networks 5 , 127.Xr nsswitch.conf 5 , 128.Xr passwd 5 , 129.Xr printcap 5 , 130.Xr protocols 5 , 131.Xr rpc 5 , 132.Xr services 5 , 133.Xr shells 5 134.Sh HISTORY 135A 136.Nm 137command appeared in 138.Nx 3.0 . 139It was based on the command of the same name in 140.Tn Solaris 141and 142.Tn Linux . 143