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