add tools/chkmoddeps
[dragonfly.git] / usr.bin / getent / getent.1
blobb73648f3a3f81998657d3e5d43230dae300ed4ec
1 .\" Copyright (c) 2004 The NetBSD Foundation, Inc.
2 .\" All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to The NetBSD Foundation
5 .\" by Luke Mewburn.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgement:
17 .\"     This product includes software developed by the NetBSD
18 .\"     Foundation, Inc. and its contributors.
19 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
20 .\"    contributors may be used to endorse or promote products derived
21 .\"    from this software without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
24 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
27 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 .\" POSSIBILITY OF SUCH DAMAGE.
34 .\"
35 .\" $NetBSD: getent.1,v 1.13 2005/09/11 23:16:15 wiz Exp $
36 .\" $FreeBSD: src/usr.bin/getent/getent.1,v 1.2 2006/09/30 17:27:50 ru Exp $
37 .\" $DragonFly: src/usr.bin/getent/getent.1,v 1.1 2007/12/04 18:13:09 dillon Exp $
38 .\"
39 .Dd August 24, 2005
40 .Dt GETENT 1
41 .Os
42 .Sh NAME
43 .Nm getent
44 .Nd get entries from administrative database
45 .Sh SYNOPSIS
46 .Nm
47 .Ar database
48 .Op Ar key ...
49 .Sh DESCRIPTION
50 The
51 .Nm
52 utility retrieves and displays entries from the administrative
53 database specified by
54 .Ar database ,
55 using the lookup order specified in
56 .Xr nsswitch.conf 5 .
57 The display format for a given
58 .Ar database
59 is as per the
60 .Dq traditional
61 file format for that database.
62 .Pp
63 The
64 .Ar database
65 argument may be one of:
66 .Pp
67 .Bl -column ".Li netgroup" -offset indent -compact
68 .Sy Database Ta Sy Display format
69 .It Li ethers Ta address name
70 .It Li group Ta group:passwd:gid:[member[,member]...]
71 .It Li hosts Ta address name [alias ...]
72 .It Li networks Ta name network [alias ...]
73 .It Li passwd Ta user:passwd:uid:gid:gecos:home_dir:shell
74 .It Li protocols Ta name protocol [alias ...]
75 .It Li rpc Ta name number [alias ...]
76 .It Li services Ta name port/protocol [alias ...]
77 .It Li shells Ta /path/to/shell
78 .El
79 .Pp
80 If one or more
81 .Ar key
82 arguments are provided, they will be looked up in
83 .Ar database
84 using the appropriate function.
85 For example,
86 .Dq Li passwd
87 supports a numeric UID or user name;
88 .Dq Li hosts
89 supports an IPv4 address, IPv6 address, or host name;
90 and
91 .Dq Li services
92 supports a service name, service name/protocol name, numeric port, or
93 numeric port/protocol name.
94 .Pp
95 If no
96 .Ar key
97 is provided and
98 .Ar database
99 supports enumeration, all entries for
100 .Ar database
101 will be retrieved using the appropriate enumeration function and printed.
102 .Sh EXIT STATUS
105 utility exits 0 on success,
106 1 if there was an error in the command syntax,
107 2 if one of the specified key names was not found in
108 .Ar database ,
109 or 3 if there is no support for enumeration on
110 .Ar database .
111 .Sh SEE ALSO
112 .Xr ethers 5 ,
113 .Xr group 5 ,
114 .Xr hosts 5 ,
115 .Xr networks 5 ,
116 .Xr nsswitch.conf 5 ,
117 .Xr passwd 5 ,
118 .Xr protocols 5 ,
119 .Xr rpc 5 ,
120 .Xr services 5 ,
121 .Xr shells 5
122 .Sh HISTORY
125 command appeared in
126 .Nx 3.0 ,
127 and was imported into
128 .Fx 7.0 .
129 It was based on the command of the same name in
130 .Tn Solaris
132 .Tn Linux .