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