Return to mansearch.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/mansearch.h, Revision 1.9

1.9     ! schwarze    1: /*     $Id: mansearch.h,v 1.8 2014/01/06 03:02:46 schwarze Exp $ */
1.1       kristaps    2: /*
                      3:  * Copyright (c) 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.6       schwarze    4:  * Copyright (c) 2013 Ingo Schwarze <schwarze@openbsd.org>
1.1       kristaps    5:  *
                      6:  * Permission to use, copy, modify, and distribute this software for any
                      7:  * purpose with or without fee is hereby granted, provided that the above
                      8:  * copyright notice and this permission notice appear in all copies.
                      9:  *
                     10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     13:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     17:  */
                     18: #ifndef MANSEARCH_H
                     19: #define MANSEARCH_H
                     20:
1.4       schwarze   21: #define        MANDOC_DB        "mandoc.db"
1.2       kristaps   22:
1.9     ! schwarze   23: #define        TYPE_Nm          0x0000000000000001ULL
        !            24: #define        TYPE_Nd          0x0000000000000002ULL
        !            25: #define        TYPE_arch        0x0000000000000004ULL
        !            26: #define        TYPE_sec         0x0000000000000008ULL
        !            27: #define        TYPE_Xr          0x0000000000000010ULL
        !            28: #define        TYPE_Ar          0x0000000000000020ULL
        !            29: #define        TYPE_Fa          0x0000000000000040ULL
        !            30: #define        TYPE_Fl          0x0000000000000080ULL
        !            31: #define        TYPE_Dv          0x0000000000000100ULL
        !            32: #define        TYPE_Fn          0x0000000000000200ULL
        !            33: #define        TYPE_Ic          0x0000000000000400ULL
        !            34: #define        TYPE_Pa          0x0000000000000800ULL
        !            35: #define        TYPE_Cm          0x0000000000001000ULL
        !            36: #define        TYPE_Li          0x0000000000002000ULL
        !            37: #define        TYPE_Em          0x0000000000004000ULL
        !            38: #define        TYPE_Cd          0x0000000000008000ULL
        !            39: #define        TYPE_Va          0x0000000000010000ULL
        !            40: #define        TYPE_Ft          0x0000000000020000ULL
        !            41: #define        TYPE_Tn          0x0000000000040000ULL
        !            42: #define        TYPE_Er          0x0000000000080000ULL
        !            43: #define        TYPE_Ev          0x0000000000100000ULL
        !            44: #define        TYPE_Sy          0x0000000000200000ULL
        !            45: #define        TYPE_Sh          0x0000000000400000ULL
        !            46: #define        TYPE_In          0x0000000000800000ULL
        !            47: #define        TYPE_Ss          0x0000000001000000ULL
        !            48: #define        TYPE_Ox          0x0000000002000000ULL
        !            49: #define        TYPE_An          0x0000000004000000ULL
        !            50: #define        TYPE_Mt          0x0000000008000000ULL
        !            51: #define        TYPE_St          0x0000000010000000ULL
        !            52: #define        TYPE_Bx          0x0000000020000000ULL
        !            53: #define        TYPE_At          0x0000000040000000ULL
        !            54: #define        TYPE_Nx          0x0000000080000000ULL
        !            55: #define        TYPE_Fx          0x0000000100000000ULL
        !            56: #define        TYPE_Lk          0x0000000200000000ULL
        !            57: #define        TYPE_Ms          0x0000000400000000ULL
        !            58: #define        TYPE_Bsx         0x0000000800000000ULL
        !            59: #define        TYPE_Dx          0x0000001000000000ULL
        !            60: #define        TYPE_Rs          0x0000002000000000ULL
        !            61: #define        TYPE_Vt          0x0000004000000000ULL
        !            62: #define        TYPE_Lb          0x0000008000000000ULL
1.2       kristaps   63:
                     64: __BEGIN_DECLS
                     65:
1.1       kristaps   66: struct manpage {
1.5       schwarze   67:        char            *file; /* to be prefixed by manpath */
                     68:        char            *names; /* a list of names with sections */
1.6       schwarze   69:        char            *output; /* user-defined additional output */
1.1       kristaps   70:        int              form; /* 0 == catpage */
                     71: };
                     72:
1.2       kristaps   73: struct mansearch {
                     74:        const char      *arch; /* architecture/NULL */
                     75:        const char      *sec; /* mansection/NULL */
                     76:        uint64_t         deftype; /* type if no key  */
                     77:        int              flags;
                     78: #define        MANSEARCH_WHATIS 0x01 /* whatis mode: equality, no key */
                     79: };
1.1       kristaps   80:
1.2       kristaps   81: int    mansearch(const struct mansearch *cfg, /* options */
                     82:                const struct manpaths *paths, /* manpaths */
1.1       kristaps   83:                int argc, /* size of argv */
                     84:                char *argv[],  /* search terms */
1.6       schwarze   85:                const char *outkey, /* name of additional output key */
1.1       kristaps   86:                struct manpage **res, /* results */
                     87:                size_t *ressz); /* results returned */
                     88:
                     89: __END_DECLS
                     90:
                     91: #endif /*!MANSEARCH_H*/