usr.bin/cap_mkdb/cap_mkdb.1

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