xref: /netbsd/share/man/man5/netgroup.5 (revision bf9ec67e)
1.\"	$NetBSD: netgroup.5,v 1.7 2000/11/17 10:14:18 lukem Exp $
2.\"
3.\" Copyright (c) 1992, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)netgroup.5	8.2 (Berkeley) 12/11/93
35.\"
36.Dd January 16, 1999
37.Dt NETGROUP 5
38.Os
39.Sh NAME
40.Nm netgroup
41.Nd defines network groups
42.Sh SYNOPSIS
43.Nm netgroup
44.Sh DESCRIPTION
45The
46.Nm netgroup
47file
48specifies
49.Dq netgroups ,
50which are sets of
51.Sy (host, user, domain)
52tuples that are to be given similar network access.
53.Pp
54Each line in the file
55consists of a netgroup name followed by a list of the members of the
56netgroup.
57Each member can be either the name of another netgroup or a specification
58of a tuple as follows:
59.Bd -literal -offset indent
60(host, user, domain)
61.Ed
62.Pp
63where the
64.Sy host ,
65.Sy user ,
66and
67.Sy domain
68are character string names for the corresponding component.
69Any of the comma separated fields may be empty to specify a
70.Dq wildcard
71value
72or may consist of the string
73.Dq Li -
74to specify
75.Dq no valid value .
76The members of the list may be separated by whitespace;
77the
78.Dq \e
79character may be used at the end of a line to specify
80line continuation.
81The functions specified in
82.Xr getnetgrent 3
83should normally be used to access the
84.Nm netgroup
85database.
86.Pp
87If
88.Sq files
89is specified for the
90.Sq netgroup
91database in
92.Xr nsswitch.conf 5 ,
93(or no
94.Sq netgroup
95entry is specified), then these functions operate on the
96.Xr db 3
97version of the
98.Nm netgroup
99.Nm (netgroup.db)
100file which can be generated using
101.Xr netgroup_mkdb 8 .
102If
103.Sq nis
104is specified then the
105.Tn NIS
106maps
107.Sq netgroup ,
108.Sq netgroup.byhost ,
109and
110.Sq netgroup.byuser
111are used.
112.Pp
113Lines that begin with a # are treated as comments.
114.Sh FILES
115.Bl -tag -width /etc/netgroup.db -compact
116.It Pa /etc/netgroup.db
117the netgroup database.
118.El
119.Sh SEE ALSO
120.Xr getnetgrent 3 ,
121.Xr exports 5 ,
122.Xr nsswitch.conf 5 ,
123.Xr netgroup_mkdb 8
124.Sh COMPATIBILITY
125The file format is compatible with that of various vendors, however it
126appears that not all vendors use an identical format.
127.Sh BUGS
128The interpretation of access restrictions based on the member tuples of a
129netgroup is left up to the various network applications.
130