usr.bin/cap_mkdb/cap_mkdb.1

   1 .\"     $NetBSD: cap_mkdb.1,v 1.15 2004/09/26 21:19:47 jmmv Exp $
   2 .\"
   3 .\" Copyright (c) 1992, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)cap_mkdb.1  8.1 (Berkeley) 6/6/93
  31 .\"
  32 .Dd June 6, 1993
  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 | Fl l
  41 .Op Fl v
  42 .Op Fl f Ar outfile
  43 .Ar file1
  44 .Op Ar file2 ...
  45 .Sh DESCRIPTION
  46 .Nm
  47 builds a hashed database out of the
  48 .Xr getcap 3
  49 logical database constructed by the concatenation of the specified
  50 files.
  51 .Pp
  52 The database is named by the basename of the first file argument and
  53 the string
  54 .Dq .db .
  55 The
  56 .Xr getcap 3
  57 routines can access the database in this form much more quickly
  58 than they can the original text file(s).
  59 .Pp
  60 The ``tc'' capabilities of the records are expanded before the
  61 record is stored into the database.
  62 .Pp
  63 The options are as follows:
  64 .Bl -tag -width XXXXXX -offset indent
  65 .It Fl b
  66 Use big-endian byte order for database metadata.
  67 .It Fl f Ar outfile
  68 Specify a different database basename.
  69 .It Fl l
  70 Use little-endian byte order for database metadata.
  71 .It Fl v
  72 Print out the number of capability records in the database.
  73 .El
  74 .Pp
  75 The
  76 .Fl b
  77 and the
  78 .Fl l
  79 flags are mutually exclusive.
  80 The default byte ordering is the current host order.
  81 .Sh FORMAT
  82 The following is a description of the hashed database created by
  83 .Nm .
  84 For a description of the format of the input files see
  85 .Xr termcap 5 .
  86 .Pp
  87 Each record is stored in the database using two different types of keys.
  88 .Pp
  89 The first type is a key which consists of the first capability of
  90 the record (not including the trailing colon (``:'')) with a data
  91 field consisting of a special byte followed by the rest of the record.
  92 The special byte is either a 0 or 1, where a 0 means that the record
  93 is okay, and a 1 means that there was a ``tc'' capability in the record
  94 that couldn't be expanded.
  95 .Pp
  96 The second type is a key which consists of one of the names from the
  97 first capability of the record with a data field consisting a special
  98 byte followed by the first capability of the record.
  99 The special byte is a 2.
 100 .Pp
 101 In normal operation names are looked up in the database, resulting
 102 in a key/data pair of the second type.
 103 The data field of this key/data pair is used to look up a key/data
 104 pair of the first type which has the real data associated with the
 105 name.
 106 .Sh EXIT STATUS
 107 The
 108 .Nm
 109 utility exits 0 on success and \*[Gt]0 if an error occurs.
 110 .Sh SEE ALSO
 111 .Xr dbopen 3 ,
 112 .Xr getcap 3 ,
 113 .Xr termcap 5