version 1.15, 2014/07/24 20:30:45 |
version 1.23, 2014/12/01 08:05:52 |
|
|
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
*/ |
*/ |
#ifndef MANSEARCH_H |
|
#define MANSEARCH_H |
|
|
|
#define MANDOC_DB "mandoc.db" |
#define MANDOC_DB "mandoc.db" |
|
|
|
|
#define TYPE_Nd 0x0000008000000000ULL |
#define TYPE_Nd 0x0000008000000000ULL |
|
|
#define NAME_SYN 0x0000004000000001ULL |
#define NAME_SYN 0x0000004000000001ULL |
#define NAME_FILE 0x0000004000000002ULL |
#define NAME_FIRST 0x0000004000000004ULL |
#define NAME_TITLE 0x000000400000000cULL |
#define NAME_TITLE 0x0000004000000006ULL |
#define NAME_FIRST 0x0000004000000008ULL |
#define NAME_HEAD 0x0000004000000008ULL |
#define NAME_HEAD 0x0000004000000010ULL |
#define NAME_FILE 0x0000004000000010ULL |
#define NAME_MASK 0x000000000000001fULL |
#define NAME_MASK 0x000000000000001fULL |
|
|
__BEGIN_DECLS |
#define FORM_CAT 0 /* manual page is preformatted */ |
|
#define FORM_SRC 1 /* format is mdoc(7) or man(7) */ |
|
#define FORM_NONE 4 /* format is unknown */ |
|
|
|
enum argmode { |
|
ARG_FILE = 0, |
|
ARG_NAME, |
|
ARG_WORD, |
|
ARG_EXPR |
|
}; |
|
|
struct manpage { |
struct manpage { |
char *file; /* to be prefixed by manpath */ |
char *file; /* to be prefixed by manpath */ |
char *names; /* a list of names with sections */ |
char *names; /* a list of names with sections */ |
char *output; /* user-defined additional output */ |
char *output; /* user-defined additional output */ |
|
size_t ipath; /* number of the manpath */ |
|
uint64_t bits; /* name type mask */ |
int sec; /* section number, 10 means invalid */ |
int sec; /* section number, 10 means invalid */ |
int form; /* 0 == catpage */ |
int form; /* 0 == catpage */ |
}; |
}; |
|
|
struct mansearch { |
struct mansearch { |
const char *arch; /* architecture/NULL */ |
const char *arch; /* architecture/NULL */ |
const char *sec; /* mansection/NULL */ |
const char *sec; /* mansection/NULL */ |
uint64_t deftype; /* type if no key */ |
const char *outkey; /* show content of this macro */ |
int flags; |
enum argmode argmode; /* interpretation of arguments */ |
#define MANSEARCH_WHATIS 0x01 /* whatis(1) mode: whole words, no keys */ |
int firstmatch; /* first matching database only */ |
#define MANSEARCH_MAN 0x02 /* man(1) mode: string equality, no keys */ |
|
}; |
}; |
|
|
|
__BEGIN_DECLS |
|
|
|
struct manpaths; |
|
|
int mansearch_setup(int); |
int mansearch_setup(int); |
int mansearch(const struct mansearch *cfg, /* options */ |
int mansearch(const struct mansearch *cfg, /* options */ |
const struct manpaths *paths, /* manpaths */ |
const struct manpaths *paths, /* manpaths */ |
int argc, /* size of argv */ |
int argc, /* size of argv */ |
char *argv[], /* search terms */ |
char *argv[], /* search terms */ |
const char *outkey, /* name of additional output key */ |
|
struct manpage **res, /* results */ |
struct manpage **res, /* results */ |
size_t *ressz); /* results returned */ |
size_t *ressz); /* results returned */ |
|
void mansearch_free(struct manpage *, size_t); |
|
|
__END_DECLS |
__END_DECLS |
|
|
#endif /*!MANSEARCH_H*/ |
|