Return to cap_mkdb.1 CVS log

Up to [local] / src / usr.bin / cap_mkdb

Annotation of src/usr.bin/cap_mkdb/cap_mkdb.1, Revision 1.2

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