Return to info_mkdb.1 CVS log

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

Annotation of src/usr.bin/info_mkdb/info_mkdb.1, Revision 1.1

1.1     ! tholo       1: .\"    $OpenBSD$
        !             2: .\"
        !             3: .\" Copyright (c) 1996 SigmaSoft, Th. Lockert
        !             4: .\" 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 SigmaSoft, Th. Lockert.
        !            17: .\" 4. The name of the author may not be used to endorse or promote products
        !            18: .\"    derived from this software without specific prior written permission
        !            19: .\"
        !            20: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
        !            21: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
        !            22: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
        !            23: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
        !            24: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
        !            25: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
        !            26: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
        !            27: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        !            28: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
        !            29: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        !            30: .\"
        !            31: .Dd "July 21, 1996"
        !            32: .Dt INFO_MKDB 1
        !            33: .Os
        !            34: .Sh NAME
        !            35: .Nm info_mkdb
        !            36: .Nd create capability database
        !            37: .Pp
        !            38: .Sh SYNOPSIS
        !            39: .Nm info_mkdb
        !            40: .Op Fl v
        !            41: .Op Fl f Ar outfile
        !            42: .Ar file1
        !            43: .Op Ar file2 ...
        !            44: .Pp
        !            45: .Sh DESCRIPTION
        !            46: .Nm info_mkdb
        !            47: builds a hashed database out of the
        !            48: .Xr terminfo 5
        !            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 as as follows:
        !            64: .Bl -tag -width XXXXXX -indent
        !            65: .It Fl f Ar outfile
        !            66: Specify a different database basename.
        !            67: .It Fl v
        !            68: Print out the number of capability records in the database.
        !            69: .El
        !            70: .Pp
        !            71: .Sh FORMAT
        !            72: Each record is stored in the database using two different types of keys.
        !            73: .Pp
        !            74: The first type is a key which consists of the first capability of
        !            75: the record (not including the trailing colon (``:'')) with a data
        !            76: field consisting of a special byte followed by the rest of the record.
        !            77: The special byte is either a 0 or 1, where a 0 means that the record
        !            78: is okay, and a 1 means that there was a ``tc'' capability in the record
        !            79: that couldn't be expanded.
        !            80: .Pp
        !            81: The second type is a key which consists of one of the names from the
        !            82: first capability of the record with a data field consisting a special
        !            83: byte followed by the the first capability of the record.
        !            84: The special byte is a 2.
        !            85: .Pp
        !            86: In normal operation names are looked up in the database, resulting
        !            87: in a key/data pair of the second type.
        !            88: The data field of this key/data pair is used to look up a key/data
        !            89: pair of the first type which has the real data associated with the
        !            90: name.
        !            91: .Sh RETURN VALUE
        !            92: The
        !            93: .Nm info_mkdb
        !            94: utility exits 0 on success and >0 if an error occurs.
        !            95: .Sh SEE ALSO
        !            96: .Xr dbopen 3 ,
        !            97: .Xr getcap 3 ,
        !            98: .Xr terminfo 5