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