xref: /freebsd/usr.bin/getent/getent.1 (revision 4f8f43b06ed07e96a250855488cc531799d5b78f)
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.Dd October 24, 2020
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
43utility 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
54The
55.Ar database
56argument may be one of:
57.Pp
58.Bl -column ".Li netgroup" -offset indent -compact
59.Sy Database Ta Sy Display format
60.It Li ethers Ta address name
61.It Li group Ta group:passwd:gid:[member[,member]...]
62.It Li hosts Ta address name [alias ...]
63.It Li netgroup Ta (host,user,domain) [...]
64.It Li networks Ta name network [alias ...]
65.It Li passwd Ta user:passwd:uid:gid:gecos:home_dir:shell
66.It Li protocols Ta name protocol [alias ...]
67.It Li rpc Ta name number [alias ...]
68.It Li services Ta name port/protocol [alias ...]
69.It Li shells Ta /path/to/shell
70.It Li utmpx Ta [time] type: properties
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.Dq Li passwd
80supports a numeric UID or user name;
81.Dq Li hosts
82supports an IPv4 address, IPv6 address, or host name;
83and
84.Dq Li 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.Sh EXIT STATUS
96The
97.Nm
98utility exits 0 on success,
991 if there was an error in the command syntax,
1002 if one of the specified key names was not found in
101.Ar database ,
102or 3 if there is no support for enumeration on
103.Ar database .
104.Sh EXAMPLES
105Show entry for user sshd from the passwd database:
106.Bd -literal -offset indent
107$ getent passwd sshd
108sshd:*:22:22:Secure Shell Daemon:/var/empty:/usr/sbin/nologin
109.Ed
110.Pp
111Show entry for TCP from the protocols database:
112.Bd -literal -offset indent
113$ getent protocols tcp
114tcp                   6  TCP
115.Ed
116.Pp
117Show entry for the localhost IPv6 address ::1 from the hosts database:
118.Bd -literal -offset indent
119$ getent hosts ::1
120::1               localhost  localhost.my.domain
121.Ed
122.Sh SEE ALSO
123.Xr getutxent 3 ,
124.Xr ethers 5 ,
125.Xr group 5 ,
126.Xr hosts 5 ,
127.Xr netgroup 5 ,
128.Xr networks 5 ,
129.Xr nsswitch.conf 5 ,
130.Xr passwd 5 ,
131.Xr protocols 5 ,
132.Xr rpc 5 ,
133.Xr services 5 ,
134.Xr shells 5
135.Sh HISTORY
136A
137.Nm
138command appeared in
139.Nx 3.0 ,
140and was imported into
141.Fx 7.0 .
142It was based on the command of the same name in Solaris and Linux.
143