version 1.177, 2014/06/21 22:24:01 |
version 1.192, 2014/09/03 23:21:47 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2010, 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2010, 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org> |
* Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org> |
* |
* |
|
|
* 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. |
*/ |
*/ |
#ifdef HAVE_CONFIG_H |
|
#include "config.h" |
#include "config.h" |
#endif |
|
|
|
|
#include <sys/types.h> |
|
|
#include <assert.h> |
#include <assert.h> |
|
#include <ctype.h> |
|
#include <errno.h> |
|
#include <fcntl.h> |
#include <stdio.h> |
#include <stdio.h> |
#include <stdint.h> |
#include <stdint.h> |
#include <stdlib.h> |
#include <stdlib.h> |
|
|
#include "main.h" |
#include "main.h" |
#include "mdoc.h" |
#include "mdoc.h" |
#include "man.h" |
#include "man.h" |
|
#include "manpath.h" |
|
#include "mansearch.h" |
|
|
#if !defined(__GNUC__) || (__GNUC__ < 2) |
#if !defined(__GNUC__) || (__GNUC__ < 2) |
# if !defined(lint) |
# if !defined(lint) |
|
|
# endif |
# endif |
#endif /* !defined(__GNUC__) || (__GNUC__ < 2) */ |
#endif /* !defined(__GNUC__) || (__GNUC__ < 2) */ |
|
|
|
enum outmode { |
|
OUTMODE_DEF = 0, |
|
OUTMODE_FLN, |
|
OUTMODE_LST, |
|
OUTMODE_ALL, |
|
OUTMODE_INT, |
|
OUTMODE_ONE |
|
}; |
|
|
typedef void (*out_mdoc)(void *, const struct mdoc *); |
typedef void (*out_mdoc)(void *, const struct mdoc *); |
typedef void (*out_man)(void *, const struct man *); |
typedef void (*out_man)(void *, const struct man *); |
typedef void (*out_free)(void *); |
typedef void (*out_free)(void *); |
Line 73 static void mmsg(enum mandocerr, enum mandoclevel, |
|
Line 87 static void mmsg(enum mandocerr, enum mandoclevel, |
|
const char *, int, int, const char *); |
const char *, int, int, const char *); |
static void parse(struct curparse *, int, |
static void parse(struct curparse *, int, |
const char *, enum mandoclevel *); |
const char *, enum mandoclevel *); |
|
static enum mandoclevel passthrough(const char *, int); |
|
static void spawn_pager(void); |
static int toptions(struct curparse *, char *); |
static int toptions(struct curparse *, char *); |
static void usage(void) __attribute__((noreturn)); |
static void usage(enum argmode) __attribute__((noreturn)); |
static void version(void) __attribute__((noreturn)); |
static void version(void) __attribute__((noreturn)); |
static int woptions(struct curparse *, char *); |
static int woptions(struct curparse *, char *); |
|
|
|
static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9}; |
static const char *progname; |
static const char *progname; |
|
|
|
|
int |
int |
main(int argc, char *argv[]) |
main(int argc, char *argv[]) |
{ |
{ |
int c; |
|
struct curparse curp; |
struct curparse curp; |
int options; |
struct mansearch search; |
enum mandoclevel rc; |
struct manpaths paths; |
|
char *conf_file, *defpaths, *auxpaths; |
char *defos; |
char *defos; |
|
#if HAVE_SQLITE3 |
|
struct manpage *res, *resp; |
|
size_t isec, i, sz; |
|
int prio, best_prio; |
|
char sec; |
|
#endif |
|
enum mandoclevel rc; |
|
enum outmode outmode; |
|
pid_t child_pid; |
|
int fd; |
|
int show_usage; |
|
int use_pager; |
|
int options; |
|
int c; |
|
|
progname = strrchr(argv[0], '/'); |
progname = strrchr(argv[0], '/'); |
if (progname == NULL) |
if (progname == NULL) |
Line 96 main(int argc, char *argv[]) |
|
Line 127 main(int argc, char *argv[]) |
|
else |
else |
++progname; |
++progname; |
|
|
memset(&curp, 0, sizeof(struct curparse)); |
/* Search options. */ |
|
|
options = MPARSE_SO; |
memset(&paths, 0, sizeof(struct manpaths)); |
|
conf_file = defpaths = auxpaths = NULL; |
|
|
|
memset(&search, 0, sizeof(struct mansearch)); |
|
search.outkey = "Nd"; |
|
|
|
if (strcmp(progname, "man") == 0) |
|
search.argmode = ARG_NAME; |
|
else if (strncmp(progname, "apropos", 7) == 0) |
|
search.argmode = ARG_EXPR; |
|
else if (strncmp(progname, "whatis", 6) == 0) |
|
search.argmode = ARG_WORD; |
|
else |
|
search.argmode = ARG_FILE; |
|
|
|
/* Parser and formatter options. */ |
|
|
|
memset(&curp, 0, sizeof(struct curparse)); |
curp.outtype = OUTT_ASCII; |
curp.outtype = OUTT_ASCII; |
curp.wlevel = MANDOCLEVEL_FATAL; |
curp.wlevel = MANDOCLEVEL_FATAL; |
|
options = MPARSE_SO; |
defos = NULL; |
defos = NULL; |
|
|
while (-1 != (c = getopt(argc, argv, "I:m:O:T:VW:"))) |
use_pager = 1; |
|
show_usage = 0; |
|
outmode = OUTMODE_DEF; |
|
|
|
while (-1 != (c = getopt(argc, argv, "aC:cfhI:iklM:m:O:S:s:T:VW:w"))) { |
switch (c) { |
switch (c) { |
|
case 'a': |
|
outmode = OUTMODE_ALL; |
|
break; |
|
case 'C': |
|
conf_file = optarg; |
|
break; |
|
case 'c': |
|
use_pager = 0; |
|
break; |
|
case 'f': |
|
search.argmode = ARG_WORD; |
|
break; |
|
case 'h': |
|
(void)strlcat(curp.outopts, "synopsis,", BUFSIZ); |
|
outmode = OUTMODE_ALL; |
|
break; |
case 'I': |
case 'I': |
if (strncmp(optarg, "os=", 3)) { |
if (strncmp(optarg, "os=", 3)) { |
fprintf(stderr, |
fprintf(stderr, |
Line 120 main(int argc, char *argv[]) |
|
Line 189 main(int argc, char *argv[]) |
|
} |
} |
defos = mandoc_strdup(optarg + 3); |
defos = mandoc_strdup(optarg + 3); |
break; |
break; |
|
case 'i': |
|
outmode = OUTMODE_INT; |
|
break; |
|
case 'k': |
|
search.argmode = ARG_EXPR; |
|
break; |
|
case 'l': |
|
search.argmode = ARG_FILE; |
|
outmode = OUTMODE_ALL; |
|
break; |
|
case 'M': |
|
defpaths = optarg; |
|
break; |
case 'm': |
case 'm': |
if ( ! moptions(&options, optarg)) |
auxpaths = optarg; |
return((int)MANDOCLEVEL_BADARG); |
|
break; |
break; |
case 'O': |
case 'O': |
|
search.outkey = optarg; |
(void)strlcat(curp.outopts, optarg, BUFSIZ); |
(void)strlcat(curp.outopts, optarg, BUFSIZ); |
(void)strlcat(curp.outopts, ",", BUFSIZ); |
(void)strlcat(curp.outopts, ",", BUFSIZ); |
break; |
break; |
|
case 'S': |
|
search.arch = optarg; |
|
break; |
|
case 's': |
|
search.sec = optarg; |
|
break; |
case 'T': |
case 'T': |
if ( ! toptions(&curp, optarg)) |
if ( ! toptions(&curp, optarg)) |
return((int)MANDOCLEVEL_BADARG); |
return((int)MANDOCLEVEL_BADARG); |
Line 136 main(int argc, char *argv[]) |
|
Line 224 main(int argc, char *argv[]) |
|
if ( ! woptions(&curp, optarg)) |
if ( ! woptions(&curp, optarg)) |
return((int)MANDOCLEVEL_BADARG); |
return((int)MANDOCLEVEL_BADARG); |
break; |
break; |
|
case 'w': |
|
outmode = OUTMODE_FLN; |
|
break; |
case 'V': |
case 'V': |
version(); |
version(); |
/* NOTREACHED */ |
/* NOTREACHED */ |
default: |
default: |
usage(); |
show_usage = 1; |
/* NOTREACHED */ |
break; |
} |
} |
|
} |
|
|
|
if (show_usage) |
|
usage(search.argmode); |
|
|
|
/* Postprocess options. */ |
|
|
|
if (outmode == OUTMODE_DEF) { |
|
switch (search.argmode) { |
|
case ARG_FILE: |
|
outmode = OUTMODE_ALL; |
|
use_pager = 0; |
|
break; |
|
case ARG_NAME: |
|
outmode = OUTMODE_ONE; |
|
break; |
|
default: |
|
outmode = OUTMODE_LST; |
|
break; |
|
} |
|
} |
|
|
|
/* Parse arguments. */ |
|
|
|
argc -= optind; |
|
argv += optind; |
|
#if HAVE_SQLITE3 |
|
resp = NULL; |
|
#endif |
|
|
|
/* Quirk for a man(1) section argument without -s. */ |
|
|
|
if (search.argmode == ARG_NAME && |
|
argv[0] != NULL && |
|
isdigit((unsigned char)argv[0][0]) && |
|
(argv[0][1] == '\0' || !strcmp(argv[0], "3p"))) { |
|
search.sec = argv[0]; |
|
argv++; |
|
argc--; |
|
} |
|
|
|
rc = MANDOCLEVEL_OK; |
|
|
|
/* man(1), whatis(1), apropos(1) */ |
|
|
|
if (search.argmode != ARG_FILE) { |
|
#if HAVE_SQLITE3 |
|
if (argc == 0) |
|
usage(search.argmode); |
|
|
|
/* Access the mandoc database. */ |
|
|
|
manpath_parse(&paths, conf_file, defpaths, auxpaths); |
|
mansearch_setup(1); |
|
if( ! mansearch(&search, &paths, argc, argv, &res, &sz)) |
|
usage(search.argmode); |
|
resp = res; |
|
|
|
if (sz == 0) { |
|
if (search.argmode == ARG_NAME) |
|
fprintf(stderr, "%s: No entry for %s " |
|
"in the manual.\n", progname, argv[0]); |
|
rc = MANDOCLEVEL_BADARG; |
|
goto out; |
|
} |
|
|
|
/* |
|
* For standard man(1) and -a output mode, |
|
* prepare for copying filename pointers |
|
* into the program parameter array. |
|
*/ |
|
|
|
if (outmode == OUTMODE_ONE) { |
|
argc = 1; |
|
best_prio = 10; |
|
} else if (outmode == OUTMODE_ALL) |
|
argc = (int)sz; |
|
|
|
/* Iterate all matching manuals. */ |
|
|
|
for (i = 0; i < sz; i++) { |
|
if (outmode == OUTMODE_FLN) |
|
puts(res[i].file); |
|
else if (outmode == OUTMODE_LST) |
|
printf("%s - %s\n", res[i].names, |
|
res[i].output == NULL ? "" : |
|
res[i].output); |
|
else if (outmode == OUTMODE_ONE) { |
|
/* Search for the best section. */ |
|
isec = strcspn(res[i].file, "123456789"); |
|
sec = res[i].file[isec]; |
|
if ('\0' == sec) |
|
continue; |
|
prio = sec_prios[sec - '1']; |
|
if (prio >= best_prio) |
|
continue; |
|
best_prio = prio; |
|
resp = res + i; |
|
} |
|
} |
|
|
|
/* |
|
* For man(1), -a and -i output mode, fall through |
|
* to the main mandoc(1) code iterating files |
|
* and running the parsers on each of them. |
|
*/ |
|
|
|
if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST) |
|
goto out; |
|
#else |
|
fputs("mandoc: database support not compiled in\n", |
|
stderr); |
|
return((int)MANDOCLEVEL_BADARG); |
|
#endif |
|
} |
|
|
|
/* mandoc(1) */ |
|
|
|
if ( ! moptions(&options, auxpaths)) |
|
return((int)MANDOCLEVEL_BADARG); |
|
|
|
if (use_pager && isatty(STDOUT_FILENO)) |
|
spawn_pager(); |
|
|
curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos); |
curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos); |
|
|
/* |
/* |
Line 152 main(int argc, char *argv[]) |
|
Line 366 main(int argc, char *argv[]) |
|
if (OUTT_MAN == curp.outtype) |
if (OUTT_MAN == curp.outtype) |
mparse_keep(curp.mp); |
mparse_keep(curp.mp); |
|
|
argc -= optind; |
if (argc == 0) |
argv += optind; |
parse(&curp, STDIN_FILENO, "<stdin>", &rc); |
|
|
rc = MANDOCLEVEL_OK; |
while (argc) { |
|
#if HAVE_SQLITE3 |
|
if (resp != NULL) { |
|
rc = mparse_open(curp.mp, &fd, resp->file, |
|
&child_pid); |
|
if (fd == -1) |
|
/* nothing */; |
|
else if (resp->form & FORM_SRC) { |
|
/* For .so only; ignore failure. */ |
|
chdir(paths.paths[resp->ipath]); |
|
parse(&curp, fd, resp->file, &rc); |
|
} else |
|
rc = passthrough(resp->file, fd); |
|
resp++; |
|
} else |
|
#endif |
|
{ |
|
rc = mparse_open(curp.mp, &fd, *argv++, |
|
&child_pid); |
|
if (fd != -1) |
|
parse(&curp, fd, argv[-1], &rc); |
|
} |
|
|
if (NULL == *argv) |
if (child_pid && |
parse(&curp, STDIN_FILENO, "<stdin>", &rc); |
mparse_wait(curp.mp, child_pid) != MANDOCLEVEL_OK) |
|
rc = MANDOCLEVEL_SYSERR; |
|
|
while (*argv) { |
|
parse(&curp, -1, *argv, &rc); |
|
if (MANDOCLEVEL_OK != rc && curp.wstop) |
if (MANDOCLEVEL_OK != rc && curp.wstop) |
break; |
break; |
++argv; |
argc--; |
} |
} |
|
|
if (curp.outfree) |
if (curp.outfree) |
(*curp.outfree)(curp.outdata); |
(*curp.outfree)(curp.outdata); |
if (curp.mp) |
if (curp.mp) |
mparse_free(curp.mp); |
mparse_free(curp.mp); |
|
|
|
#if HAVE_SQLITE3 |
|
out: |
|
if (search.argmode != ARG_FILE) { |
|
manpath_free(&paths); |
|
mansearch_free(res, sz); |
|
mansearch_setup(0); |
|
} |
|
#endif |
|
|
free(defos); |
free(defos); |
|
|
return((int)rc); |
return((int)rc); |
|
|
version(void) |
version(void) |
{ |
{ |
|
|
printf("%s %s\n", progname, VERSION); |
printf("mandoc %s\n", VERSION); |
exit((int)MANDOCLEVEL_OK); |
exit((int)MANDOCLEVEL_OK); |
} |
} |
|
|
static void |
static void |
usage(void) |
usage(enum argmode argmode) |
{ |
{ |
|
|
fprintf(stderr, "usage: %s " |
switch (argmode) { |
"[-V] " |
case ARG_FILE: |
"[-Ios=name] " |
fputs("usage: mandoc [-acfhklV] [-Ios=name] " |
"[-mformat] " |
"[-mformat] [-Ooption] [-Toutput] [-Wlevel]\n" |
"[-Ooption] " |
"\t [file ...]\n", stderr); |
"[-Toutput] " |
break; |
"[-Wlevel]\n" |
case ARG_NAME: |
"\t [file ...]\n", |
fputs("usage: man [-acfhklVw] [-C file] " |
progname); |
"[-M path] [-m path] [-S arch] [-s section]\n" |
|
"\t [section] name ...\n", stderr); |
|
break; |
|
case ARG_WORD: |
|
fputs("usage: whatis [-acfhklVw] [-C file] " |
|
"[-M path] [-m path] [-O outkey] [-S arch]\n" |
|
"\t [-s section] name ...\n", stderr); |
|
break; |
|
case ARG_EXPR: |
|
fputs("usage: apropos [-acfhklVw] [-C file] " |
|
"[-M path] [-m path] [-O outkey] [-S arch]\n" |
|
"\t [-s section] expression ...\n", stderr); |
|
break; |
|
} |
exit((int)MANDOCLEVEL_BADARG); |
exit((int)MANDOCLEVEL_BADARG); |
} |
} |
|
|
Line 314 parse(struct curparse *curp, int fd, const char *file, |
|
Line 570 parse(struct curparse *curp, int fd, const char *file, |
|
*level = rc; |
*level = rc; |
} |
} |
|
|
|
static enum mandoclevel |
|
passthrough(const char *file, int fd) |
|
{ |
|
char buf[BUFSIZ]; |
|
const char *syscall; |
|
ssize_t nr, nw, off; |
|
|
|
while ((nr = read(fd, buf, BUFSIZ)) != -1 && nr != 0) |
|
for (off = 0; off < nr; off += nw) |
|
if ((nw = write(STDOUT_FILENO, buf + off, |
|
(size_t)(nr - off))) == -1 || nw == 0) { |
|
syscall = "write"; |
|
goto fail; |
|
} |
|
|
|
if (nr == 0) { |
|
close(fd); |
|
return(MANDOCLEVEL_OK); |
|
} |
|
|
|
syscall = "read"; |
|
fail: |
|
fprintf(stderr, "%s: %s: SYSERR: %s: %s", |
|
progname, file, syscall, strerror(errno)); |
|
return(MANDOCLEVEL_SYSERR); |
|
} |
|
|
static int |
static int |
moptions(int *options, char *arg) |
moptions(int *options, char *arg) |
{ |
{ |
|
|
if (0 == strcmp(arg, "doc")) |
if (arg == NULL) |
|
/* nothing to do */; |
|
else if (0 == strcmp(arg, "doc")) |
*options |= MPARSE_MDOC; |
*options |= MPARSE_MDOC; |
else if (0 == strcmp(arg, "andoc")) |
else if (0 == strcmp(arg, "andoc")) |
/* nothing to do */; |
/* nothing to do */; |
Line 427 mmsg(enum mandocerr t, enum mandoclevel lvl, |
|
Line 712 mmsg(enum mandocerr t, enum mandoclevel lvl, |
|
fprintf(stderr, ": %s", msg); |
fprintf(stderr, ": %s", msg); |
|
|
fputc('\n', stderr); |
fputc('\n', stderr); |
|
} |
|
|
|
static void |
|
spawn_pager(void) |
|
{ |
|
#define MAX_PAGER_ARGS 16 |
|
char *argv[MAX_PAGER_ARGS]; |
|
const char *pager; |
|
char *cp; |
|
int fildes[2]; |
|
int argc; |
|
|
|
if (pipe(fildes) == -1) { |
|
fprintf(stderr, "%s: pipe: %s\n", |
|
progname, strerror(errno)); |
|
return; |
|
} |
|
|
|
switch (fork()) { |
|
case -1: |
|
fprintf(stderr, "%s: fork: %s\n", |
|
progname, strerror(errno)); |
|
exit((int)MANDOCLEVEL_SYSERR); |
|
case 0: |
|
close(fildes[0]); |
|
if (dup2(fildes[1], STDOUT_FILENO) == -1) { |
|
fprintf(stderr, "%s: dup output: %s\n", |
|
progname, strerror(errno)); |
|
exit((int)MANDOCLEVEL_SYSERR); |
|
} |
|
return; |
|
default: |
|
break; |
|
} |
|
|
|
/* The original process becomes the pager. */ |
|
|
|
close(fildes[1]); |
|
if (dup2(fildes[0], STDIN_FILENO) == -1) { |
|
fprintf(stderr, "%s: dup input: %s\n", |
|
progname, strerror(errno)); |
|
exit((int)MANDOCLEVEL_SYSERR); |
|
} |
|
|
|
pager = getenv("MANPAGER"); |
|
if (pager == NULL || *pager == '\0') |
|
pager = getenv("PAGER"); |
|
if (pager == NULL || *pager == '\0') |
|
pager = "/usr/bin/more -s"; |
|
cp = mandoc_strdup(pager); |
|
|
|
/* |
|
* Parse the pager command into words. |
|
* Intentionally do not do anything fancy here. |
|
*/ |
|
|
|
argc = 0; |
|
while (argc + 1 < MAX_PAGER_ARGS) { |
|
argv[argc++] = cp; |
|
cp = strchr(cp, ' '); |
|
if (cp == NULL) |
|
break; |
|
*cp++ = '\0'; |
|
while (*cp == ' ') |
|
cp++; |
|
if (*cp == '\0') |
|
break; |
|
} |
|
argv[argc] = NULL; |
|
|
|
/* Hand over to the pager. */ |
|
|
|
execvp(argv[0], argv); |
|
fprintf(stderr, "%s: exec: %s\n", |
|
progname, strerror(errno)); |
|
exit((int)MANDOCLEVEL_SYSERR); |
} |
} |