xref: /netbsd-src/usr.sbin/netgroup_mkdb/netgroup_mkdb.8 (revision 550147bd6a5bef946e7a7f153e49c0d11314e598)
1.\"	$NetBSD: netgroup_mkdb.8,v 1.9 2009/10/21 01:07:47 snj Exp $
2.\"
3.\" Copyright (c) 1994 Christos Zoulas
4.\" 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.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd May 20, 2007
27.Dt NETGROUP_MKDB 8
28.Os
29.Sh NAME
30.Nm netgroup_mkdb
31.Nd generate the netgroup database
32.Sh SYNOPSIS
33.Nm
34.Op Fl o Ar database
35.Op file
36.Sh DESCRIPTION
37.Nm
38creates a
39.Xr db 3
40database for the specified file.
41If no file is specified, then
42.Pa /etc/netgroup
43is used.
44This database is installed into
45.Pa /var/db/netgroup.db .
46The file must be in the correct format (see
47.Xr netgroup 5 ) .
48.Pp
49The options are as follows:
50.Bl -tag -width indent
51.It Fl o Ar database
52Put the output databases in the named file.
53.El
54.Pp
55The databases are used by the C library netgroup routines (see
56.Xr getnetgrent 3 ) .
57.Pp
58.Nm
59exits zero on success, non-zero on failure.
60.Sh FILES
61.Bl -tag -width 24n -compact
62.It Pa /var/db/netgroup.db
63The current netgroup database
64.It Pa /var/db/netgroup.db.tmp
65A temporary file
66.It Pa /etc/netgroup
67The current netgroup file
68.El
69.Sh SEE ALSO
70.Xr db 3 ,
71.Xr getnetgrent 3 ,
72.Xr netgroup 5
73.Sh BUGS
74Because
75.Nm
76guarantees not to install a partial destination file it must
77build a temporary file in the same file system and if successful use
78.Xr rename 2
79to install over the destination file.
80.Pp
81If
82.Nm
83fails it will leave the previous version of the destination file intact.
84