xref: /netbsd-src/share/man/man5/netgroup.5 (revision 2a399c6883d870daece976daec6ffa7bb7f934ce)
1.\"	$NetBSD: netgroup.5,v 1.4 1997/11/26 17:42:55 tv 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 December 11, 1993
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 ``netgroups'', which are sets of
49.Sy (host, user, domain)
50tuples that are to be given similar network access.
51.Pp
52Each line in the file
53consists of a netgroup name followed by a list of the members of the
54netgroup.
55Each member can be either the name of another netgroup or a specification
56of a tuple as follows:
57.Bd -literal -offset indent
58(host, user, domain)
59.Ed
60.Pp
61where the
62.Sy host ,
63.Sy user ,
64and
65.Sy domain
66are character string names for the corresponding component.
67Any of the comma separated fields may be empty to specify a ``wildcard'' value
68or may consist of the string ``-'' to specify ``no valid value''.
69The members of the list may be separated by whitespace;
70the ``\e'' character may be used at the end of a line to specify
71line continuation.
72The functions specified in
73.Xr getnetgrent 3
74should normally be used to access the
75.Nm netgroup
76database.
77.Pp
78These functions operate on the
79.Xr db
80version of the
81.Nm netgroup
82.Nm (netgroup.db)
83file which can be generated using
84.Xr netgroup_mkdb .
85If that file is not present, and the system supports
86.Sy NIS,
87then the
88.Nm netgroup
89.Sy NIS
90maps are used. The
91.Sy NIS
92maps are also used if the
93.Nm netgroup
94file contains a
95.Sy +
96entry.
97.Pp
98Lines that begin with a # are treated as comments.
99.Sh FILES
100.Bl -tag -width /etc/netgroup.db -compact
101.It Pa /etc/netgroup.db
102the netgroup database.
103.El
104.Sh SEE ALSO
105.Xr netgroup_mkdb 8 ,
106.Xr getnetgrent 3 ,
107.Xr exports 5
108.Sh COMPATIBILITY
109The file format is compatible with that of various vendors, however it
110appears that not all vendors use an identical format.
111.Sh BUGS
112The interpretation of access restrictions based on the member tuples of a
113netgroup is left up to the various network applications.
114