xref: /freebsd/usr.bin/cap_mkdb/cap_mkdb.1 (revision fbbd9655e5107c68e4e0146ff22b73d7350475bc)
19b50d902SRodney W. Grimes.\" Copyright (c) 1992, 1993
29b50d902SRodney W. Grimes.\"	The Regents of the University of California.  All rights reserved.
39b50d902SRodney W. Grimes.\"
49b50d902SRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without
59b50d902SRodney W. Grimes.\" modification, are permitted provided that the following conditions
69b50d902SRodney W. Grimes.\" are met:
79b50d902SRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright
89b50d902SRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer.
99b50d902SRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright
109b50d902SRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer in the
119b50d902SRodney W. Grimes.\"    documentation and/or other materials provided with the distribution.
12*fbbd9655SWarner Losh.\" 3. Neither the name of the University nor the names of its contributors
139b50d902SRodney W. Grimes.\"    may be used to endorse or promote products derived from this software
149b50d902SRodney W. Grimes.\"    without specific prior written permission.
159b50d902SRodney W. Grimes.\"
169b50d902SRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
179b50d902SRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
189b50d902SRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
199b50d902SRodney W. Grimes.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
209b50d902SRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
219b50d902SRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
229b50d902SRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
239b50d902SRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
249b50d902SRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
259b50d902SRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
269b50d902SRodney W. Grimes.\" SUCH DAMAGE.
279b50d902SRodney W. Grimes.\"
289b50d902SRodney W. Grimes.\"	@(#)cap_mkdb.1	8.1 (Berkeley) 6/6/93
29c3aac50fSPeter Wemm.\" $FreeBSD$
309b50d902SRodney W. Grimes.\"
316fe37d13SRuslan Ermilov.Dd February 22, 2005
329b50d902SRodney W. Grimes.Dt CAP_MKDB 1
339b50d902SRodney W. Grimes.Os
349b50d902SRodney W. Grimes.Sh NAME
359b50d902SRodney W. Grimes.Nm cap_mkdb
369b50d902SRodney W. Grimes.Nd create capability database
379b50d902SRodney W. Grimes.Sh SYNOPSIS
388fe908efSRuslan Ermilov.Nm
396fe37d13SRuslan Ermilov.Op Fl b | l
409b50d902SRodney W. Grimes.Op Fl v
419b50d902SRodney W. Grimes.Op Fl f Ar outfile
426fe37d13SRuslan Ermilov.Ar
439b50d902SRodney W. Grimes.Sh DESCRIPTION
443898680cSPhilippe CharnierThe
453898680cSPhilippe Charnier.Nm
463898680cSPhilippe Charnierutility builds a hashed database out of the
479b50d902SRodney W. Grimes.Xr getcap 3
489b50d902SRodney W. Grimeslogical database constructed by the concatenation of the specified
499b50d902SRodney W. Grimesfiles.
509b50d902SRodney W. Grimes.Pp
519b50d902SRodney W. GrimesThe database is named by the basename of the first file argument and
529b50d902SRodney W. Grimesthe string
539b50d902SRodney W. Grimes.Dq .db .
549b50d902SRodney W. GrimesThe
559b50d902SRodney W. Grimes.Xr getcap 3
569b50d902SRodney W. Grimesroutines can access the database in this form much more quickly
579b50d902SRodney W. Grimesthan they can the original text file(s).
589b50d902SRodney W. Grimes.Pp
599b50d902SRodney W. GrimesThe ``tc'' capabilities of the records are expanded before the
609b50d902SRodney W. Grimesrecord is stored into the database.
619b50d902SRodney W. Grimes.Pp
6293d6b9b6SPhilippe CharnierThe following options are available:
6393d6b9b6SPhilippe Charnier.Bl -tag -width indent
646fe37d13SRuslan Ermilov.It Fl b
656fe37d13SRuslan ErmilovUse big-endian byte order for database metadata.
669b50d902SRodney W. Grimes.It Fl f Ar outfile
679b50d902SRodney W. GrimesSpecify a different database basename.
686fe37d13SRuslan Ermilov.It Fl l
696fe37d13SRuslan ErmilovUse little-endian byte order for database metadata.
709b50d902SRodney W. Grimes.It Fl v
719b50d902SRodney W. GrimesPrint out the number of capability records in the database.
729b50d902SRodney W. Grimes.El
736fe37d13SRuslan Ermilov.Pp
746fe37d13SRuslan ErmilovThe
756fe37d13SRuslan Ermilov.Fl b
766fe37d13SRuslan Ermilovand
776fe37d13SRuslan Ermilov.Fl l
786fe37d13SRuslan Ermilovflags are mutually exclusive.
796fe37d13SRuslan ErmilovThe default byte ordering is the current host order.
809b50d902SRodney W. Grimes.Sh FORMAT
819b50d902SRodney W. GrimesEach record is stored in the database using two different types of keys.
829b50d902SRodney W. Grimes.Pp
839b50d902SRodney W. GrimesThe first type is a key which consists of the first capability of
849b50d902SRodney W. Grimesthe record (not including the trailing colon (``:'')) with a data
859b50d902SRodney W. Grimesfield consisting of a special byte followed by the rest of the record.
869b50d902SRodney W. GrimesThe special byte is either a 0 or 1, where a 0 means that the record
879b50d902SRodney W. Grimesis okay, and a 1 means that there was a ``tc'' capability in the record
880227791bSRuslan Ermilovthat could not be expanded.
899b50d902SRodney W. Grimes.Pp
909b50d902SRodney W. GrimesThe second type is a key which consists of one of the names from the
919b50d902SRodney W. Grimesfirst capability of the record with a data field consisting a special
92e83201b4SWolfram Schneiderbyte followed by the first capability of the record.
939b50d902SRodney W. GrimesThe special byte is a 2.
949b50d902SRodney W. Grimes.Pp
959b50d902SRodney W. GrimesIn normal operation names are looked up in the database, resulting
969b50d902SRodney W. Grimesin a key/data pair of the second type.
979b50d902SRodney W. GrimesThe data field of this key/data pair is used to look up a key/data
989b50d902SRodney W. Grimespair of the first type which has the real data associated with the
999b50d902SRodney W. Grimesname.
100a866e170SRuslan Ermilov.Sh EXIT STATUS
101d628d776SRuslan Ermilov.Ex -std
1029b50d902SRodney W. Grimes.Sh SEE ALSO
1039b50d902SRodney W. Grimes.Xr dbopen 3 ,
1049b50d902SRodney W. Grimes.Xr getcap 3 ,
1059b50d902SRodney W. Grimes.Xr termcap 5
106