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