xref: /freebsd/usr.bin/cap_mkdb/cap_mkdb.1 (revision e0c4386e)
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.Dd February 22, 2005
29.Dt CAP_MKDB 1
30.Os
31.Sh NAME
32.Nm cap_mkdb
33.Nd create capability database
34.Sh SYNOPSIS
35.Nm
36.Op Fl b | l
37.Op Fl v
38.Op Fl f Ar outfile
39.Ar
40.Sh DESCRIPTION
41The
42.Nm
43utility builds a hashed database out of the
44.Xr getcap 3
45logical database constructed by the concatenation of the specified
46files.
47.Pp
48The database is named by the basename of the first file argument and
49the string
50.Dq .db .
51The
52.Xr getcap 3
53routines can access the database in this form much more quickly
54than they can the original text file(s).
55.Pp
56The ``tc'' capabilities of the records are expanded before the
57record is stored into the database.
58.Pp
59The following options are available:
60.Bl -tag -width indent
61.It Fl b
62Use big-endian byte order for database metadata.
63.It Fl f Ar outfile
64Specify a different database basename.
65.It Fl l
66Use little-endian byte order for database metadata.
67.It Fl v
68Print out the number of capability records in the database.
69.El
70.Pp
71The
72.Fl b
73and
74.Fl l
75flags are mutually exclusive.
76The default byte ordering is the current host order.
77.Sh FORMAT
78Each record is stored in the database using two different types of keys.
79.Pp
80The first type is a key which consists of the first capability of
81the record (not including the trailing colon (``:'')) with a data
82field consisting of a special byte followed by the rest of the record.
83The special byte is either a 0 or 1, where a 0 means that the record
84is okay, and a 1 means that there was a ``tc'' capability in the record
85that could not be expanded.
86.Pp
87The second type is a key which consists of one of the names from the
88first capability of the record with a data field consisting a special
89byte followed by the first capability of the record.
90The special byte is a 2.
91.Pp
92In normal operation names are looked up in the database, resulting
93in a key/data pair of the second type.
94The data field of this key/data pair is used to look up a key/data
95pair of the first type which has the real data associated with the
96name.
97.Sh EXIT STATUS
98.Ex -std
99.Sh SEE ALSO
100.Xr dbopen 3 ,
101.Xr getcap 3 ,
102.Xr termcap 5
103