xref: /freebsd/usr.bin/cap_mkdb/cap_mkdb.1 (revision 22cf89c938886d14f5796fc49f9f020c23ea8eaf)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"	@(#)cap_mkdb.1	8.1 (Berkeley) 6/6/93
29.\"
30.Dd February 22, 2005
31.Dt CAP_MKDB 1
32.Os
33.Sh NAME
34.Nm cap_mkdb
35.Nd create capability database
36.Sh SYNOPSIS
37.Nm
38.Op Fl b | l
39.Op Fl v
40.Op Fl f Ar outfile
41.Ar
42.Sh DESCRIPTION
43The
44.Nm
45utility builds a hashed database out of the
46.Xr getcap 3
47logical database constructed by the concatenation of the specified
48files.
49.Pp
50The database is named by the basename of the first file argument and
51the string
52.Dq .db .
53The
54.Xr getcap 3
55routines can access the database in this form much more quickly
56than they can the original text file(s).
57.Pp
58The ``tc'' capabilities of the records are expanded before the
59record is stored into the database.
60.Pp
61The following options are available:
62.Bl -tag -width indent
63.It Fl b
64Use big-endian byte order for database metadata.
65.It Fl f Ar outfile
66Specify a different database basename.
67.It Fl l
68Use little-endian byte order for database metadata.
69.It Fl v
70Print out the number of capability records in the database.
71.El
72.Pp
73The
74.Fl b
75and
76.Fl l
77flags are mutually exclusive.
78The default byte ordering is the current host order.
79.Sh FORMAT
80Each record is stored in the database using two different types of keys.
81.Pp
82The first type is a key which consists of the first capability of
83the record (not including the trailing colon (``:'')) with a data
84field consisting of a special byte followed by the rest of the record.
85The special byte is either a 0 or 1, where a 0 means that the record
86is okay, and a 1 means that there was a ``tc'' capability in the record
87that could not be expanded.
88.Pp
89The second type is a key which consists of one of the names from the
90first capability of the record with a data field consisting a special
91byte followed by the first capability of the record.
92The special byte is a 2.
93.Pp
94In normal operation names are looked up in the database, resulting
95in a key/data pair of the second type.
96The data field of this key/data pair is used to look up a key/data
97pair of the first type which has the real data associated with the
98name.
99.Sh EXIT STATUS
100.Ex -std
101.Sh SEE ALSO
102.Xr dbopen 3 ,
103.Xr getcap 3 ,
104.Xr termcap 5
105