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