Annotation of mandoc/apropos_db.h, Revision 1.10
1.10 ! schwarze 1: /* $Id: apropos_db.h,v 1.9 2011/11/27 18:54:01 kristaps 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.10 ! schwarze 21: char *type; /* file type: mdoc, man or cat */
1.1 schwarze 22: char *file; /* file in file-system */
23: char *cat; /* category (3p, 3, etc.) */
24: char *title; /* title (FOO, etc.) */
25: char *arch; /* arch (or empty string) */
26: char *desc; /* description (from Nd) */
27: unsigned int rec; /* record in index */
1.8 schwarze 28: /*
1.7 kristaps 29: * The index volume. This indexes into the array of directories
30: * searched for manual page databases.
31: */
1.8 schwarze 32: unsigned int volume;
1.1 schwarze 33: };
34:
35: struct opts {
36: const char *arch; /* restrict to architecture */
37: const char *cat; /* restrict to manual section */
38: };
39:
40: __BEGIN_DECLS
41:
42: struct expr;
43:
1.8 schwarze 44: int apropos_search(int, char **, const struct opts *,
45: const struct expr *, size_t, void *,
1.5 kristaps 46: void (*)(struct res *, size_t, void *));
47: struct expr *exprcomp(int, char *[], size_t *);
1.1 schwarze 48: void exprfree(struct expr *);
1.9 kristaps 49: struct expr *termcomp(int, char *[], size_t *);
1.1 schwarze 50:
51: __END_DECLS
52:
53: #endif /*!APROPOS_H*/
CVSweb