version 1.13, 2014/04/11 15:46:52 |
version 1.26, 2016/07/20 00:23:14 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2013, 2014, 2016 Ingo Schwarze <schwarze@openbsd.org> |
* |
* |
* Permission to use, copy, modify, and distribute this software for any |
* Permission to use, copy, modify, and distribute this software for any |
* purpose with or without fee is hereby granted, provided that the above |
* purpose with or without fee is hereby granted, provided that the above |
|
|
* 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.new.db" |
|
#define MANDOCDB_MAGIC 0x3a7d0cdb |
|
#define MANDOCDB_VERSION 0 /* XXX Start counting in production. */ |
|
|
|
#define MACRO_MAX 36 |
|
#define KEY_Nd 39 |
|
#define KEY_MAX 40 |
|
|
#define TYPE_arch 0x0000000000000001ULL |
#define TYPE_arch 0x0000000000000001ULL |
#define TYPE_sec 0x0000000000000002ULL |
#define TYPE_sec 0x0000000000000002ULL |
#define TYPE_Xr 0x0000000000000004ULL |
#define TYPE_Xr 0x0000000000000004ULL |
|
|
#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 |
enum form { |
|
FORM_SRC = 1, /* Format is mdoc(7) or man(7). */ |
|
FORM_CAT, /* Manual page is preformatted. */ |
|
FORM_NONE /* 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 */ |
int form; /* 0 == catpage */ |
size_t ipath; /* number of the manpath */ |
|
uint64_t bits; /* name type mask */ |
|
int sec; /* section number, 10 means invalid */ |
|
enum form form; |
}; |
}; |
|
|
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 mode: equality, no key */ |
int firstmatch; /* first matching database only */ |
}; |
}; |
|
|
int mansearch_setup(int); |
|
|
struct manpaths; |
|
|
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 |
|
|
|
#endif /*!MANSEARCH_H*/ |
|