xref: /freebsd/usr.bin/getent/getent.1 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1c912a3f7SMaxim Konovalov.\"	$NetBSD: getent.1,v 1.13 2005/09/11 23:16:15 wiz Exp $
2c912a3f7SMaxim Konovalov.\"
3c912a3f7SMaxim Konovalov.\" Copyright (c) 2004 The NetBSD Foundation, Inc.
4c912a3f7SMaxim Konovalov.\" All rights reserved.
5c912a3f7SMaxim Konovalov.\"
6c912a3f7SMaxim Konovalov.\" This code is derived from software contributed to The NetBSD Foundation
7c912a3f7SMaxim Konovalov.\" by Luke Mewburn.
8c912a3f7SMaxim Konovalov.\"
9c912a3f7SMaxim Konovalov.\" Redistribution and use in source and binary forms, with or without
10c912a3f7SMaxim Konovalov.\" modification, are permitted provided that the following conditions
11c912a3f7SMaxim Konovalov.\" are met:
12c912a3f7SMaxim Konovalov.\" 1. Redistributions of source code must retain the above copyright
13c912a3f7SMaxim Konovalov.\"    notice, this list of conditions and the following disclaimer.
14c912a3f7SMaxim Konovalov.\" 2. Redistributions in binary form must reproduce the above copyright
15c912a3f7SMaxim Konovalov.\"    notice, this list of conditions and the following disclaimer in the
16c912a3f7SMaxim Konovalov.\"    documentation and/or other materials provided with the distribution.
17c912a3f7SMaxim Konovalov.\"
18c912a3f7SMaxim Konovalov.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19c912a3f7SMaxim Konovalov.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20c912a3f7SMaxim Konovalov.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21c912a3f7SMaxim Konovalov.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22c912a3f7SMaxim Konovalov.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23c912a3f7SMaxim Konovalov.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24c912a3f7SMaxim Konovalov.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25c912a3f7SMaxim Konovalov.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26c912a3f7SMaxim Konovalov.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27c912a3f7SMaxim Konovalov.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28c912a3f7SMaxim Konovalov.\" POSSIBILITY OF SUCH DAMAGE.
29c912a3f7SMaxim Konovalov.\"
30*f7585b28SFernando Apesteguía.Dd October 24, 2020
31c912a3f7SMaxim Konovalov.Dt GETENT 1
32c912a3f7SMaxim Konovalov.Os
33c912a3f7SMaxim Konovalov.Sh NAME
34c912a3f7SMaxim Konovalov.Nm getent
35c912a3f7SMaxim Konovalov.Nd get entries from administrative database
36c912a3f7SMaxim Konovalov.Sh SYNOPSIS
37c912a3f7SMaxim Konovalov.Nm
38c912a3f7SMaxim Konovalov.Ar database
39c912a3f7SMaxim Konovalov.Op Ar key ...
40c912a3f7SMaxim Konovalov.Sh DESCRIPTION
41c912a3f7SMaxim KonovalovThe
42c912a3f7SMaxim Konovalov.Nm
43e9aa046bSRuslan Ermilovutility retrieves and displays entries from the administrative
44c912a3f7SMaxim Konovalovdatabase specified by
45c912a3f7SMaxim Konovalov.Ar database ,
46c912a3f7SMaxim Konovalovusing the lookup order specified in
47c912a3f7SMaxim Konovalov.Xr nsswitch.conf 5 .
48c912a3f7SMaxim KonovalovThe display format for a given
49c912a3f7SMaxim Konovalov.Ar database
50c912a3f7SMaxim Konovalovis as per the
51c912a3f7SMaxim Konovalov.Dq traditional
52c912a3f7SMaxim Konovalovfile format for that database.
53c912a3f7SMaxim Konovalov.Pp
54e9aa046bSRuslan ErmilovThe
55c912a3f7SMaxim Konovalov.Ar database
56e9aa046bSRuslan Ermilovargument may be one of:
57e9aa046bSRuslan Ermilov.Pp
58e9aa046bSRuslan Ermilov.Bl -column ".Li netgroup" -offset indent -compact
59c912a3f7SMaxim Konovalov.Sy Database Ta Sy Display format
60e9aa046bSRuslan Ermilov.It Li ethers Ta address name
61e9aa046bSRuslan Ermilov.It Li group Ta group:passwd:gid:[member[,member]...]
62e9aa046bSRuslan Ermilov.It Li hosts Ta address name [alias ...]
630f1c6d28SMark Johnston.It Li netgroup Ta (host,user,domain) [...]
64e9aa046bSRuslan Ermilov.It Li networks Ta name network [alias ...]
65e9aa046bSRuslan Ermilov.It Li passwd Ta user:passwd:uid:gid:gecos:home_dir:shell
66e9aa046bSRuslan Ermilov.It Li protocols Ta name protocol [alias ...]
67e9aa046bSRuslan Ermilov.It Li rpc Ta name number [alias ...]
68e9aa046bSRuslan Ermilov.It Li services Ta name port/protocol [alias ...]
69e9aa046bSRuslan Ermilov.It Li shells Ta /path/to/shell
7086586473SEd Schouten.It Li utmpx Ta [time] type: properties
71c912a3f7SMaxim Konovalov.El
72c912a3f7SMaxim Konovalov.Pp
73c912a3f7SMaxim KonovalovIf one or more
74c912a3f7SMaxim Konovalov.Ar key
75c912a3f7SMaxim Konovalovarguments are provided, they will be looked up in
76c912a3f7SMaxim Konovalov.Ar database
77c912a3f7SMaxim Konovalovusing the appropriate function.
78c912a3f7SMaxim KonovalovFor example,
79e9aa046bSRuslan Ermilov.Dq Li passwd
80c912a3f7SMaxim Konovalovsupports a numeric UID or user name;
81e9aa046bSRuslan Ermilov.Dq Li hosts
82c912a3f7SMaxim Konovalovsupports an IPv4 address, IPv6 address, or host name;
83c912a3f7SMaxim Konovalovand
84e9aa046bSRuslan Ermilov.Dq Li services
85c912a3f7SMaxim Konovalovsupports a service name, service name/protocol name, numeric port, or
86c912a3f7SMaxim Konovalovnumeric port/protocol name.
87c912a3f7SMaxim Konovalov.Pp
88c912a3f7SMaxim KonovalovIf no
89c912a3f7SMaxim Konovalov.Ar key
90c912a3f7SMaxim Konovalovis provided and
91c912a3f7SMaxim Konovalov.Ar database
92c912a3f7SMaxim Konovalovsupports enumeration, all entries for
93c912a3f7SMaxim Konovalov.Ar database
94c912a3f7SMaxim Konovalovwill be retrieved using the appropriate enumeration function and printed.
95e9aa046bSRuslan Ermilov.Sh EXIT STATUS
96e9aa046bSRuslan ErmilovThe
97c912a3f7SMaxim Konovalov.Nm
98e9aa046bSRuslan Ermilovutility exits 0 on success,
99c912a3f7SMaxim Konovalov1 if there was an error in the command syntax,
100c912a3f7SMaxim Konovalov2 if one of the specified key names was not found in
101c912a3f7SMaxim Konovalov.Ar database ,
102c912a3f7SMaxim Konovalovor 3 if there is no support for enumeration on
103c912a3f7SMaxim Konovalov.Ar database .
104*f7585b28SFernando Apesteguía.Sh EXAMPLES
105*f7585b28SFernando ApesteguíaShow entry for user sshd from the passwd database:
106*f7585b28SFernando Apesteguía.Bd -literal -offset indent
107*f7585b28SFernando Apesteguía$ getent passwd sshd
108*f7585b28SFernando Apesteguíasshd:*:22:22:Secure Shell Daemon:/var/empty:/usr/sbin/nologin
109*f7585b28SFernando Apesteguía.Ed
110*f7585b28SFernando Apesteguía.Pp
111*f7585b28SFernando ApesteguíaShow entry for TCP from the protocols database:
112*f7585b28SFernando Apesteguía.Bd -literal -offset indent
113*f7585b28SFernando Apesteguía$ getent protocols tcp
114*f7585b28SFernando Apesteguíatcp                   6  TCP
115*f7585b28SFernando Apesteguía.Ed
116*f7585b28SFernando Apesteguía.Pp
117*f7585b28SFernando ApesteguíaShow entry for the localhost IPv6 address ::1 from the hosts database:
118*f7585b28SFernando Apesteguía.Bd -literal -offset indent
119*f7585b28SFernando Apesteguía$ getent hosts ::1
120*f7585b28SFernando Apesteguía::1               localhost  localhost.my.domain
121*f7585b28SFernando Apesteguía.Ed
122c912a3f7SMaxim Konovalov.Sh SEE ALSO
12386586473SEd Schouten.Xr getutxent 3 ,
124c912a3f7SMaxim Konovalov.Xr ethers 5 ,
125c912a3f7SMaxim Konovalov.Xr group 5 ,
126c912a3f7SMaxim Konovalov.Xr hosts 5 ,
1270f1c6d28SMark Johnston.Xr netgroup 5 ,
128c912a3f7SMaxim Konovalov.Xr networks 5 ,
129c912a3f7SMaxim Konovalov.Xr nsswitch.conf 5 ,
130c912a3f7SMaxim Konovalov.Xr passwd 5 ,
131c912a3f7SMaxim Konovalov.Xr protocols 5 ,
132c912a3f7SMaxim Konovalov.Xr rpc 5 ,
133c912a3f7SMaxim Konovalov.Xr services 5 ,
134c912a3f7SMaxim Konovalov.Xr shells 5
135c912a3f7SMaxim Konovalov.Sh HISTORY
136c912a3f7SMaxim KonovalovA
137c912a3f7SMaxim Konovalov.Nm
138c912a3f7SMaxim Konovalovcommand appeared in
139c912a3f7SMaxim Konovalov.Nx 3.0 ,
140c912a3f7SMaxim Konovalovand was imported into
141c912a3f7SMaxim Konovalov.Fx 7.0 .
142*f7585b28SFernando ApesteguíaIt was based on the command of the same name in Solaris and Linux.
143