Annotation of mandoc/apropos_db.h, Revision 1.6
1.6 ! kristaps 1: /* $Id: apropos_db.h,v 1.5 2011/11/18 07:02:19 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.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 */
27: };
28:
29: struct opts {
30: const char *arch; /* restrict to architecture */
31: const char *cat; /* restrict to manual section */
32: };
33:
34: __BEGIN_DECLS
35:
36: struct expr;
37:
1.6 ! kristaps 38: int apropos_search(int, char **, const struct opts *,
1.5 kristaps 39: const struct expr *, size_t, void *,
40: void (*)(struct res *, size_t, void *));
41: struct expr *exprcomp(int, char *[], size_t *);
1.1 schwarze 42: void exprfree(struct expr *);
43:
44: __END_DECLS
45:
46: #endif /*!APROPOS_H*/
CVSweb