xref: /freebsd/usr.bin/getent/getent.1 (revision aa24f48b361effe51163877d84f1b70d32b77e04)
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.\"
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.\" $FreeBSD$
31.\"
32.Dd June 4, 2016
33.Dt GETENT 1
34.Os
35.Sh NAME
36.Nm getent
37.Nd get entries from administrative database
38.Sh SYNOPSIS
39.Nm
40.Ar database
41.Op Ar key ...
42.Sh DESCRIPTION
43The
44.Nm
45utility retrieves and displays entries from the administrative
46database specified by
47.Ar database ,
48using the lookup order specified in
49.Xr nsswitch.conf 5 .
50The display format for a given
51.Ar database
52is as per the
53.Dq traditional
54file format for that database.
55.Pp
56The
57.Ar database
58argument may be one of:
59.Pp
60.Bl -column ".Li netgroup" -offset indent -compact
61.Sy Database Ta Sy Display format
62.It Li ethers Ta address name
63.It Li group Ta group:passwd:gid:[member[,member]...]
64.It Li hosts Ta address name [alias ...]
65.It Li netgroup Ta (host,user,domain) [...]
66.It Li networks Ta name network [alias ...]
67.It Li passwd Ta user:passwd:uid:gid:gecos:home_dir:shell
68.It Li protocols Ta name protocol [alias ...]
69.It Li rpc Ta name number [alias ...]
70.It Li services Ta name port/protocol [alias ...]
71.It Li shells Ta /path/to/shell
72.It Li utmpx Ta [time] type: properties
73.El
74.Pp
75If one or more
76.Ar key
77arguments are provided, they will be looked up in
78.Ar database
79using the appropriate function.
80For example,
81.Dq Li passwd
82supports a numeric UID or user name;
83.Dq Li hosts
84supports an IPv4 address, IPv6 address, or host name;
85and
86.Dq Li services
87supports a service name, service name/protocol name, numeric port, or
88numeric port/protocol name.
89.Pp
90If no
91.Ar key
92is provided and
93.Ar database
94supports enumeration, all entries for
95.Ar database
96will be retrieved using the appropriate enumeration function and printed.
97.Sh EXIT STATUS
98The
99.Nm
100utility exits 0 on success,
1011 if there was an error in the command syntax,
1022 if one of the specified key names was not found in
103.Ar database ,
104or 3 if there is no support for enumeration on
105.Ar database .
106.Sh SEE ALSO
107.Xr getutxent 3 ,
108.Xr ethers 5 ,
109.Xr group 5 ,
110.Xr hosts 5 ,
111.Xr netgroup 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
120A
121.Nm
122command appeared in
123.Nx 3.0 ,
124and was imported into
125.Fx 7.0 .
126It was based on the command of the same name in
127.Tn Solaris
128and
129.Tn Linux .
130