Return to apropos_db.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/apropos_db.h, Revision 1.9

1.9     ! kristaps    1: /*     $Id: apropos_db.h,v 1.8 2011/11/26 22:38:11 schwarze Exp $ */
1.1       schwarze    2: /*
                      3:  * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
                      4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
                      6:  * purpose with or without fee is hereby granted, provided that the above
                      7:  * copyright notice and this permission notice appear in all copies.
                      8:  *
                      9:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     16:  */
                     17: #ifndef APROPOS_H
                     18: #define APROPOS_H
                     19:
1.5       kristaps   20: struct res {
1.1       schwarze   21:        char            *file; /* file in file-system */
                     22:        char            *cat; /* category (3p, 3, etc.) */
                     23:        char            *title; /* title (FOO, etc.) */
                     24:        char            *arch; /* arch (or empty string) */
                     25:        char            *desc; /* description (from Nd) */
                     26:        unsigned int     rec; /* record in index */
1.8       schwarze   27:        /*
1.7       kristaps   28:         * The index volume.  This indexes into the array of directories
                     29:         * searched for manual page databases.
                     30:         */
1.8       schwarze   31:        unsigned int     volume;
1.1       schwarze   32: };
                     33:
                     34: struct opts {
                     35:        const char      *arch; /* restrict to architecture */
                     36:        const char      *cat; /* restrict to manual section */
                     37: };
                     38:
                     39: __BEGIN_DECLS
                     40:
                     41: struct expr;
                     42:
1.8       schwarze   43: int             apropos_search(int, char **, const struct opts *,
                     44:                        const struct expr *, size_t, void *,
1.5       kristaps   45:                        void (*)(struct res *, size_t, void *));
                     46: struct expr    *exprcomp(int, char *[], size_t *);
1.1       schwarze   47: void            exprfree(struct expr *);
1.9     ! kristaps   48: struct expr    *termcomp(int, char *[], size_t *);
1.1       schwarze   49:
                     50: __END_DECLS
                     51:
                     52: #endif /*!APROPOS_H*/