xref: /netbsd-src/usr.bin/cap_mkdb/cap_mkdb.1 (revision 5aefcfdc06931dd97e76246d2fe0302f7b3fe094)
1.\"	$NetBSD: cap_mkdb.1,v 1.10 2000/09/04 07:35:15 kleink 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.\"	@(#)cap_mkdb.1	8.1 (Berkeley) 6/6/93
35.\"
36.Dd June 6, 1993
37.Dt CAP_MKDB 1
38.Os
39.Sh NAME
40.Nm cap_mkdb
41.Nd create capability database
42.Pp
43.Sh SYNOPSIS
44.Nm
45.Op Fl b | Fl l
46.Op Fl v
47.Op Fl f Ar outfile
48.Ar file1
49.Op Ar file2 ...
50.Pp
51.Sh DESCRIPTION
52.Nm
53builds a hashed database out of the
54.Xr getcap 3
55logical database constructed by the concatenation of the specified
56files .
57.Pp
58The database is named by the basename of the first file argument and
59the string
60.Dq .db .
61The
62.Xr getcap 3
63routines can access the database in this form much more quickly
64than they can the original text file(s).
65.Pp
66The ``tc'' capabilities of the records are expanded before the
67record is stored into the database.
68.Pp
69The options are as follows:
70.Bl -tag -width XXXXXX -indent
71.It Fl b
72Use big-endian byte order for database metadata.
73.It Fl f Ar outfile
74Specify a different database basename.
75.It Fl l
76Use little-endian byte order for database metadata.
77.It Fl v
78Print out the number of capability records in the database.
79.El
80.Pp
81The
82.Fl b
83and the
84.Fl l
85flags are mutually exclusive.  The default byte ordering is
86the current host order.
87.Pp
88.Sh FORMAT
89Each record is stored in the database using two different types of keys.
90.Pp
91The first type is a key which consists of the first capability of
92the record (not including the trailing colon (``:'')) with a data
93field consisting of a special byte followed by the rest of the record.
94The special byte is either a 0 or 1, where a 0 means that the record
95is okay, and a 1 means that there was a ``tc'' capability in the record
96that couldn't be expanded.
97.Pp
98The second type is a key which consists of one of the names from the
99first capability of the record with a data field consisting a special
100byte followed by the first capability of the record.
101The special byte is a 2.
102.Pp
103In normal operation names are looked up in the database, resulting
104in a key/data pair of the second type.
105The data field of this key/data pair is used to look up a key/data
106pair of the first type which has the real data associated with the
107name.
108.Sh EXIT STATUS
109The
110.Nm
111utility exits 0 on success and >0 if an error occurs.
112.Sh SEE ALSO
113.Xr dbopen 3 ,
114.Xr getcap 3 ,
115.Xr termcap 5
116