xref: /freebsd/usr.bin/getent/getent.1 (revision b1f9167f94059fd55c630891d359bcff987bd7eb)
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 August 24, 2005
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 networks Ta name network [alias ...]
66.It Li passwd Ta user:passwd:uid:gid:gecos:home_dir:shell
67.It Li protocols Ta name protocol [alias ...]
68.It Li rpc Ta name number [alias ...]
69.It Li services Ta name port/protocol [alias ...]
70.It Li shells Ta /path/to/shell
71.It Li utmpx Ta [time] type: properties
72.El
73.Pp
74If one or more
75.Ar key
76arguments are provided, they will be looked up in
77.Ar database
78using the appropriate function.
79For example,
80.Dq Li passwd
81supports a numeric UID or user name;
82.Dq Li hosts
83supports an IPv4 address, IPv6 address, or host name;
84and
85.Dq Li services
86supports a service name, service name/protocol name, numeric port, or
87numeric port/protocol name.
88.Pp
89If no
90.Ar key
91is provided and
92.Ar database
93supports enumeration, all entries for
94.Ar database
95will be retrieved using the appropriate enumeration function and printed.
96.Sh EXIT STATUS
97The
98.Nm
99utility exits 0 on success,
1001 if there was an error in the command syntax,
1012 if one of the specified key names was not found in
102.Ar database ,
103or 3 if there is no support for enumeration on
104.Ar database .
105.Sh SEE ALSO
106.Xr getutxent 3 ,
107.Xr ethers 5 ,
108.Xr group 5 ,
109.Xr hosts 5 ,
110.Xr networks 5 ,
111.Xr nsswitch.conf 5 ,
112.Xr passwd 5 ,
113.Xr protocols 5 ,
114.Xr rpc 5 ,
115.Xr services 5 ,
116.Xr shells 5
117.Sh HISTORY
118A
119.Nm
120command appeared in
121.Nx 3.0 ,
122and was imported into
123.Fx 7.0 .
124It was based on the command of the same name in
125.Tn Solaris
126and
127.Tn Linux .
128