freebsd-skq/contrib/mdocml/main.c

1186 lines
26 KiB
C
Raw Normal View History

2017-07-31 19:17:54 +00:00
/* $Id: main.c,v 1.301 2017/07/26 10:21:55 schwarze Exp $ */
/*
* Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
* Copyright (c) 2010-2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
2014-11-22 18:08:25 +00:00
* Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
2016-01-15 23:08:59 +00:00
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
2016-01-15 23:08:59 +00:00
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include "config.h"
#include <sys/types.h>
#include <sys/param.h> /* MACHINE */
2015-03-15 11:28:48 +00:00
#include <sys/wait.h>
#include <assert.h>
#include <ctype.h>
2016-01-15 23:08:59 +00:00
#if HAVE_ERR
#include <err.h>
#endif
#include <errno.h>
#include <fcntl.h>
#include <glob.h>
2016-07-23 11:45:42 +00:00
#if HAVE_SANDBOX_INIT
#include <sandbox.h>
#endif
2016-01-15 23:08:59 +00:00
#include <signal.h>
#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
2016-07-23 11:45:42 +00:00
#include <time.h>
#include <unistd.h>
2014-11-22 18:08:25 +00:00
#include "mandoc_aux.h"
2016-01-15 23:08:59 +00:00
#include "mandoc.h"
2017-07-31 19:17:54 +00:00
#include "mandoc_xr.h"
2016-01-15 23:08:59 +00:00
#include "roff.h"
#include "mdoc.h"
#include "man.h"
2016-01-15 23:08:59 +00:00
#include "tag.h"
#include "main.h"
#include "manconf.h"
#include "mansearch.h"
enum outmode {
OUTMODE_DEF = 0,
OUTMODE_FLN,
OUTMODE_LST,
OUTMODE_ALL,
OUTMODE_ONE
};
enum outt {
OUTT_ASCII = 0, /* -Tascii */
OUTT_LOCALE, /* -Tlocale */
OUTT_UTF8, /* -Tutf8 */
OUTT_TREE, /* -Ttree */
OUTT_MAN, /* -Tman */
OUTT_HTML, /* -Thtml */
2017-06-08 19:29:07 +00:00
OUTT_MARKDOWN, /* -Tmarkdown */
OUTT_LINT, /* -Tlint */
OUTT_PS, /* -Tps */
OUTT_PDF /* -Tpdf */
};
struct curparse {
struct mparse *mp;
2017-07-31 19:17:54 +00:00
struct manoutput *outopts; /* output options */
void *outdata; /* data for output */
char *os_s; /* operating system for display */
int wstop; /* stop after a file with a warning */
2017-07-31 19:17:54 +00:00
enum mandocerr mmin; /* ignore messages below this */
enum mandoc_os os_e; /* check base system conventions */
2014-11-22 18:08:25 +00:00
enum outt outtype; /* which output to use */
};
int mandocdb(int, char *[]);
2017-07-31 19:17:54 +00:00
static void check_xr(const char *);
static int fs_lookup(const struct manpaths *,
size_t ipath, const char *,
const char *, const char *,
struct manpage **, size_t *);
2017-07-31 19:17:54 +00:00
static int fs_search(const struct mansearch *,
const struct manpaths *, int, char**,
struct manpage **, size_t *);
static int koptions(int *, char *);
2017-06-08 19:29:07 +00:00
static void moptions(int *, char *);
static void mmsg(enum mandocerr, enum mandoclevel,
const char *, int, int, const char *);
static void outdata_alloc(struct curparse *);
2016-01-15 23:08:59 +00:00
static void parse(struct curparse *, int, const char *);
static void passthrough(const char *, int, int);
static pid_t spawn_pager(struct tag_files *);
static int toptions(struct curparse *, char *);
2017-02-19 17:41:20 +00:00
static void usage(enum argmode) __attribute__((__noreturn__));
static int woptions(struct curparse *, char *);
static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
2014-12-25 21:33:25 +00:00
static char help_arg[] = "help";
static char *help_argv[] = {help_arg, NULL};
2016-01-15 23:08:59 +00:00
static enum mandoclevel rc;
2017-07-31 19:17:54 +00:00
static FILE *mmsg_stream;
2014-11-22 18:08:25 +00:00
int
main(int argc, char *argv[])
{
2016-01-15 23:08:59 +00:00
struct manconf conf;
struct mansearch search;
2017-02-19 17:41:20 +00:00
struct curparse curp;
2016-01-15 23:08:59 +00:00
struct tag_files *tag_files;
struct manpage *res, *resp;
2017-02-19 17:41:20 +00:00
const char *progname, *sec, *thisarg;
char *conf_file, *defpaths, *auxpaths;
2017-07-31 19:17:54 +00:00
char *oarg;
2017-02-19 17:41:20 +00:00
unsigned char *uc;
2016-07-23 11:45:42 +00:00
size_t i, sz;
2016-01-15 23:08:59 +00:00
int prio, best_prio;
enum outmode outmode;
int fd;
int show_usage;
int options;
2016-01-15 23:08:59 +00:00
int use_pager;
int status, signum;
int c;
2016-01-15 23:08:59 +00:00
pid_t pager_pid, tc_pgid, man_pgid, pid;
2016-01-15 23:08:59 +00:00
#if HAVE_PROGNAME
progname = getprogname();
#else
if (argc < 1)
2016-01-15 23:08:59 +00:00
progname = mandoc_strdup("mandoc");
else if ((progname = strrchr(argv[0], '/')) == NULL)
progname = argv[0];
else
++progname;
2016-01-15 23:08:59 +00:00
setprogname(progname);
#endif
2016-01-15 23:08:59 +00:00
if (strncmp(progname, "mandocdb", 8) == 0 ||
strcmp(progname, BINM_MAKEWHATIS) == 0)
return mandocdb(argc, argv);
#if HAVE_PLEDGE
2017-06-08 19:29:07 +00:00
if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1)
2016-01-15 23:08:59 +00:00
err((int)MANDOCLEVEL_SYSERR, "pledge");
2014-12-25 21:33:25 +00:00
#endif
2016-07-23 11:45:42 +00:00
#if HAVE_SANDBOX_INIT
if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1)
errx((int)MANDOCLEVEL_SYSERR, "sandbox_init");
#endif
/* Search options. */
2016-01-15 23:08:59 +00:00
memset(&conf, 0, sizeof(conf));
2014-12-25 21:33:25 +00:00
conf_file = defpaths = NULL;
auxpaths = NULL;
memset(&search, 0, sizeof(struct mansearch));
search.outkey = "Nd";
2017-02-19 17:41:20 +00:00
oarg = NULL;
2014-12-25 21:33:25 +00:00
if (strcmp(progname, BINM_MAN) == 0)
search.argmode = ARG_NAME;
2014-12-25 21:33:25 +00:00
else if (strcmp(progname, BINM_APROPOS) == 0)
search.argmode = ARG_EXPR;
2014-12-25 21:33:25 +00:00
else if (strcmp(progname, BINM_WHATIS) == 0)
search.argmode = ARG_WORD;
2014-12-25 21:33:25 +00:00
else if (strncmp(progname, "help", 4) == 0)
search.argmode = ARG_NAME;
else
search.argmode = ARG_FILE;
/* Parser and formatter options. */
memset(&curp, 0, sizeof(struct curparse));
2014-12-25 21:33:25 +00:00
curp.outtype = OUTT_LOCALE;
2017-07-31 19:17:54 +00:00
curp.mmin = MANDOCERR_MAX;
2016-01-15 23:08:59 +00:00
curp.outopts = &conf.output;
options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
2017-07-31 19:17:54 +00:00
mmsg_stream = stderr;
2016-01-15 23:08:59 +00:00
use_pager = 1;
tag_files = NULL;
show_usage = 0;
outmode = OUTMODE_DEF;
2017-06-08 19:29:07 +00:00
while ((c = getopt(argc, argv,
"aC:cfhI:iK:klM:m:O:S:s:T:VW:w")) != -1) {
if (c == 'i' && search.argmode == ARG_EXPR) {
optind--;
break;
}
switch (c) {
case 'a':
outmode = OUTMODE_ALL;
break;
case 'C':
conf_file = optarg;
break;
case 'c':
2016-01-15 23:08:59 +00:00
use_pager = 0;
break;
case 'f':
search.argmode = ARG_WORD;
break;
case 'h':
2016-01-15 23:08:59 +00:00
conf.output.synopsisonly = 1;
use_pager = 0;
outmode = OUTMODE_ALL;
break;
2014-11-22 18:08:25 +00:00
case 'I':
2014-01-31 19:59:03 +00:00
if (strncmp(optarg, "os=", 3)) {
2016-01-15 23:08:59 +00:00
warnx("-I %s: Bad argument", optarg);
return (int)MANDOCLEVEL_BADARG;
2014-01-31 19:59:03 +00:00
}
2017-07-31 19:17:54 +00:00
if (curp.os_s != NULL) {
2016-01-15 23:08:59 +00:00
warnx("-I %s: Duplicate argument", optarg);
return (int)MANDOCLEVEL_BADARG;
2014-01-31 19:59:03 +00:00
}
2017-07-31 19:17:54 +00:00
curp.os_s = mandoc_strdup(optarg + 3);
2014-01-31 19:59:03 +00:00
break;
case 'K':
if ( ! koptions(&options, optarg))
2016-01-15 23:08:59 +00:00
return (int)MANDOCLEVEL_BADARG;
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':
auxpaths = optarg;
break;
2014-11-22 18:08:25 +00:00
case 'O':
2017-02-19 17:41:20 +00:00
oarg = optarg;
break;
case 'S':
search.arch = optarg;
break;
case 's':
search.sec = optarg;
break;
2014-11-22 18:08:25 +00:00
case 'T':
if ( ! toptions(&curp, optarg))
2016-01-15 23:08:59 +00:00
return (int)MANDOCLEVEL_BADARG;
break;
2014-11-22 18:08:25 +00:00
case 'W':
if ( ! woptions(&curp, optarg))
2016-01-15 23:08:59 +00:00
return (int)MANDOCLEVEL_BADARG;
break;
case 'w':
outmode = OUTMODE_FLN;
break;
default:
show_usage = 1;
break;
}
}
if (show_usage)
usage(search.argmode);
/* Postprocess options. */
if (outmode == OUTMODE_DEF) {
switch (search.argmode) {
case ARG_FILE:
outmode = OUTMODE_ALL;
2016-01-15 23:08:59 +00:00
use_pager = 0;
break;
case ARG_NAME:
outmode = OUTMODE_ONE;
break;
default:
outmode = OUTMODE_LST;
break;
}
}
2017-02-19 17:41:20 +00:00
if (oarg != NULL) {
if (outmode == OUTMODE_LST)
search.outkey = oarg;
else {
while (oarg != NULL) {
thisarg = oarg;
if (manconf_output(&conf.output,
strsep(&oarg, ","), 0) == 0)
continue;
warnx("-O %s: Bad argument", thisarg);
return (int)MANDOCLEVEL_BADARG;
}
}
}
2016-01-15 23:08:59 +00:00
if (outmode == OUTMODE_FLN ||
outmode == OUTMODE_LST ||
!isatty(STDOUT_FILENO))
use_pager = 0;
#if HAVE_PLEDGE
if (!use_pager)
2017-06-08 19:29:07 +00:00
if (pledge("stdio rpath", NULL) == -1)
2016-01-15 23:08:59 +00:00
err((int)MANDOCLEVEL_SYSERR, "pledge");
#endif
/* Parse arguments. */
if (argc > 0) {
argc -= optind;
argv += optind;
}
resp = NULL;
2014-12-25 21:33:25 +00:00
/*
* Quirks for help(1)
* and for a man(1) section argument without -s.
*/
2014-12-25 21:33:25 +00:00
if (search.argmode == ARG_NAME) {
if (*progname == 'h') {
if (argc == 0) {
argv = help_argv;
argc = 1;
}
} else if (argc > 1 &&
2015-03-15 11:28:48 +00:00
((uc = (unsigned char *)argv[0]) != NULL) &&
((isdigit(uc[0]) && (uc[1] == '\0' ||
(isalpha(uc[1]) && uc[2] == '\0'))) ||
(uc[0] == 'n' && uc[1] == '\0'))) {
2015-03-15 11:28:48 +00:00
search.sec = (char *)uc;
2014-12-25 21:33:25 +00:00
argv++;
argc--;
}
if (search.arch == NULL)
search.arch = getenv("MACHINE");
2015-03-15 11:28:48 +00:00
#ifdef MACHINE
if (search.arch == NULL)
search.arch = MACHINE;
2015-03-15 11:28:48 +00:00
#endif
}
rc = MANDOCLEVEL_OK;
/* man(1), whatis(1), apropos(1) */
if (search.argmode != ARG_FILE) {
if (search.argmode == ARG_NAME &&
outmode == OUTMODE_ONE)
search.firstmatch = 1;
/* Access the mandoc database. */
2016-01-15 23:08:59 +00:00
manconf_parse(&conf, conf_file, defpaths, auxpaths);
if ( ! mansearch(&search, &conf.manpath,
argc, argv, &res, &sz))
usage(search.argmode);
2016-01-15 23:08:59 +00:00
if (sz == 0) {
if (search.argmode == ARG_NAME)
fs_search(&search, &conf.manpath,
argc, argv, &res, &sz);
else
warnx("nothing appropriate");
}
if (sz == 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;
2016-07-23 11:45:42 +00:00
best_prio = 20;
} else if (outmode == OUTMODE_ALL)
argc = (int)sz;
/* Iterate all matching manuals. */
resp = res;
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. */
2016-07-23 11:45:42 +00:00
sec = res[i].file;
sec += strcspn(sec, "123456789");
if (sec[0] == '\0')
continue;
2016-07-23 11:45:42 +00:00
prio = sec_prios[sec[0] - '1'];
if (sec[1] != '/')
prio += 10;
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;
}
/* mandoc(1) */
2016-01-15 23:08:59 +00:00
#if HAVE_PLEDGE
if (use_pager) {
if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1)
err((int)MANDOCLEVEL_SYSERR, "pledge");
} else {
if (pledge("stdio rpath", NULL) == -1)
err((int)MANDOCLEVEL_SYSERR, "pledge");
}
#endif
2017-06-08 19:29:07 +00:00
if (search.argmode == ARG_FILE)
moptions(&options, auxpaths);
2016-01-15 23:08:59 +00:00
mchars_alloc();
2017-07-31 19:17:54 +00:00
curp.mp = mparse_alloc(options, curp.mmin, mmsg,
curp.os_e, curp.os_s);
/*
* Conditionally start up the lookaside buffer before parsing.
*/
if (OUTT_MAN == curp.outtype)
mparse_keep(curp.mp);
if (argc < 1) {
2016-01-15 23:08:59 +00:00
if (use_pager)
tag_files = tag_init();
parse(&curp, STDIN_FILENO, "<stdin>");
}
while (argc > 0) {
2016-01-15 23:08:59 +00:00
fd = mparse_open(curp.mp, resp != NULL ? resp->file : *argv);
if (fd != -1) {
2016-01-15 23:08:59 +00:00
if (use_pager) {
tag_files = tag_init();
use_pager = 0;
}
if (resp == NULL)
2016-01-15 23:08:59 +00:00
parse(&curp, fd, *argv);
else if (resp->form == FORM_SRC) {
/* For .so only; ignore failure. */
2017-07-31 19:17:54 +00:00
(void)chdir(conf.manpath.paths[resp->ipath]);
2016-01-15 23:08:59 +00:00
parse(&curp, fd, resp->file);
} else
passthrough(resp->file, fd,
conf.output.synopsisonly);
if (argc > 1 && curp.outtype <= OUTT_UTF8) {
if (curp.outdata == NULL)
outdata_alloc(&curp);
2016-07-23 11:45:42 +00:00
terminal_sepline(curp.outdata);
}
2016-01-15 23:08:59 +00:00
} else if (rc < MANDOCLEVEL_ERROR)
rc = MANDOCLEVEL_ERROR;
if (MANDOCLEVEL_OK != rc && curp.wstop)
break;
if (resp != NULL)
resp++;
else
argv++;
if (--argc)
mparse_reset(curp.mp);
}
2016-01-15 23:08:59 +00:00
if (curp.outdata != NULL) {
switch (curp.outtype) {
case OUTT_HTML:
html_free(curp.outdata);
break;
case OUTT_UTF8:
case OUTT_LOCALE:
case OUTT_ASCII:
ascii_free(curp.outdata);
break;
case OUTT_PDF:
case OUTT_PS:
pspdf_free(curp.outdata);
break;
default:
break;
}
}
2017-07-31 19:17:54 +00:00
mandoc_xr_free();
mparse_free(curp.mp);
2016-01-15 23:08:59 +00:00
mchars_free();
out:
if (search.argmode != ARG_FILE) {
2016-01-15 23:08:59 +00:00
manconf_free(&conf);
mansearch_free(res, sz);
}
2017-07-31 19:17:54 +00:00
free(curp.os_s);
2015-03-15 11:28:48 +00:00
/*
2016-01-15 23:08:59 +00:00
* When using a pager, finish writing both temporary files,
* fork it, wait for the user to close it, and clean up.
2015-03-15 11:28:48 +00:00
*/
2016-01-15 23:08:59 +00:00
if (tag_files != NULL) {
2015-03-15 11:28:48 +00:00
fclose(stdout);
2016-01-15 23:08:59 +00:00
tag_write();
man_pgid = getpgid(0);
tag_files->tcpgid = man_pgid == getpid() ?
getpgid(getppid()) : man_pgid;
pager_pid = 0;
signum = SIGSTOP;
for (;;) {
/* Stop here until moved to the foreground. */
tc_pgid = tcgetpgrp(tag_files->ofd);
2016-01-15 23:08:59 +00:00
if (tc_pgid != man_pgid) {
if (tc_pgid == pager_pid) {
(void)tcsetpgrp(tag_files->ofd,
2016-01-15 23:08:59 +00:00
man_pgid);
if (signum == SIGTTIN)
continue;
} else
tag_files->tcpgid = tc_pgid;
kill(0, signum);
continue;
}
/* Once in the foreground, activate the pager. */
if (pager_pid) {
(void)tcsetpgrp(tag_files->ofd, pager_pid);
2016-01-15 23:08:59 +00:00
kill(pager_pid, SIGCONT);
} else
pager_pid = spawn_pager(tag_files);
/* Wait for the pager to stop or exit. */
while ((pid = waitpid(pager_pid, &status,
WUNTRACED)) == -1 && errno == EINTR)
continue;
if (pid == -1) {
warn("wait");
rc = MANDOCLEVEL_SYSERR;
break;
}
if (!WIFSTOPPED(status))
break;
signum = WSTOPSIG(status);
}
tag_unlink();
2015-03-15 11:28:48 +00:00
}
2016-01-15 23:08:59 +00:00
return (int)rc;
}
static void
usage(enum argmode argmode)
{
switch (argmode) {
case ARG_FILE:
2017-06-08 19:29:07 +00:00
fputs("usage: mandoc [-ac] [-I os=name] "
"[-K encoding] [-mdoc | -man] [-O options]\n"
2016-01-15 23:08:59 +00:00
"\t [-T output] [-W level] [file ...]\n", stderr);
break;
case ARG_NAME:
2017-06-08 19:29:07 +00:00
fputs("usage: man [-acfhklw] [-C file] [-M path] "
"[-m path] [-S subsection]\n"
"\t [[-s] section] name ...\n", stderr);
break;
case ARG_WORD:
2017-06-08 19:29:07 +00:00
fputs("usage: whatis [-afk] [-C file] "
"[-M path] [-m path] [-O outkey] [-S arch]\n"
"\t [-s section] name ...\n", stderr);
break;
case ARG_EXPR:
2017-06-08 19:29:07 +00:00
fputs("usage: apropos [-afk] [-C file] "
"[-M path] [-m path] [-O outkey] [-S arch]\n"
"\t [-s section] expression ...\n", stderr);
break;
}
exit((int)MANDOCLEVEL_BADARG);
}
static int
fs_lookup(const struct manpaths *paths, size_t ipath,
const char *sec, const char *arch, const char *name,
struct manpage **res, size_t *ressz)
{
glob_t globinfo;
struct manpage *page;
char *file;
int globres;
enum form form;
form = FORM_SRC;
mandoc_asprintf(&file, "%s/man%s/%s.%s",
paths->paths[ipath], sec, name, sec);
if (access(file, R_OK) != -1)
goto found;
free(file);
mandoc_asprintf(&file, "%s/cat%s/%s.0",
paths->paths[ipath], sec, name);
if (access(file, R_OK) != -1) {
form = FORM_CAT;
goto found;
}
free(file);
if (arch != NULL) {
mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
paths->paths[ipath], sec, arch, name, sec);
if (access(file, R_OK) != -1)
goto found;
free(file);
}
2016-01-15 23:08:59 +00:00
mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",
paths->paths[ipath], sec, name);
globres = glob(file, 0, NULL, &globinfo);
if (globres != 0 && globres != GLOB_NOMATCH)
2016-01-15 23:08:59 +00:00
warn("%s: glob", file);
free(file);
if (globres == 0)
file = mandoc_strdup(*globinfo.gl_pathv);
globfree(&globinfo);
2017-07-31 19:17:54 +00:00
if (globres == 0)
goto found;
if (res != NULL || ipath + 1 != paths->sz)
2016-01-15 23:08:59 +00:00
return 0;
2017-07-31 19:17:54 +00:00
mandoc_asprintf(&file, "%s.%s", name, sec);
globres = access(file, R_OK);
free(file);
return globres != -1;
found:
2016-07-23 11:45:42 +00:00
warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
2017-07-31 19:17:54 +00:00
if (res == NULL) {
free(file);
return 1;
}
*res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
page = *res + (*ressz - 1);
page->file = file;
page->names = NULL;
page->output = NULL;
page->ipath = ipath;
page->bits = NAME_FILE & NAME_MASK;
page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
page->form = form;
2016-01-15 23:08:59 +00:00
return 1;
}
2017-07-31 19:17:54 +00:00
static int
fs_search(const struct mansearch *cfg, const struct manpaths *paths,
int argc, char **argv, struct manpage **res, size_t *ressz)
{
const char *const sections[] =
2016-07-23 11:45:42 +00:00
{"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"};
const size_t nsec = sizeof(sections)/sizeof(sections[0]);
size_t ipath, isec, lastsz;
assert(cfg->argmode == ARG_NAME);
2017-07-31 19:17:54 +00:00
if (res != NULL)
*res = NULL;
*ressz = lastsz = 0;
while (argc) {
for (ipath = 0; ipath < paths->sz; ipath++) {
if (cfg->sec != NULL) {
if (fs_lookup(paths, ipath, cfg->sec,
cfg->arch, *argv, res, ressz) &&
cfg->firstmatch)
2017-07-31 19:17:54 +00:00
return 1;
} else for (isec = 0; isec < nsec; isec++)
if (fs_lookup(paths, ipath, sections[isec],
cfg->arch, *argv, res, ressz) &&
cfg->firstmatch)
2017-07-31 19:17:54 +00:00
return 1;
}
2017-07-31 19:17:54 +00:00
if (res != NULL && *ressz == lastsz)
2016-01-15 23:08:59 +00:00
warnx("No entry for %s in the manual.", *argv);
lastsz = *ressz;
argv++;
argc--;
}
2017-07-31 19:17:54 +00:00
return 0;
}
static void
2016-01-15 23:08:59 +00:00
parse(struct curparse *curp, int fd, const char *file)
{
2016-01-15 23:08:59 +00:00
enum mandoclevel rctmp;
struct roff_man *man;
/* Begin by parsing the file itself. */
assert(file);
assert(fd >= 0);
2016-01-15 23:08:59 +00:00
rctmp = mparse_readfd(curp->mp, fd, file);
if (fd != STDIN_FILENO)
close(fd);
if (rc < rctmp)
rc = rctmp;
/*
* With -Wstop and warnings or errors of at least the requested
* level, do not produce output.
*/
2016-01-15 23:08:59 +00:00
if (rctmp != MANDOCLEVEL_OK && curp->wstop)
return;
if (curp->outdata == NULL)
outdata_alloc(curp);
2016-01-15 23:08:59 +00:00
mparse_result(curp->mp, &man, NULL);
2016-01-15 23:08:59 +00:00
/* Execute the out device, if it exists. */
if (man == NULL)
return;
2017-07-31 19:17:54 +00:00
mandoc_xr_reset();
2016-01-15 23:08:59 +00:00
if (man->macroset == MACROSET_MDOC) {
2017-02-19 17:41:20 +00:00
if (curp->outtype != OUTT_TREE || !curp->outopts->noval)
mdoc_validate(man);
switch (curp->outtype) {
2014-11-22 18:08:25 +00:00
case OUTT_HTML:
2016-01-15 23:08:59 +00:00
html_mdoc(curp->outdata, man);
break;
2014-11-22 18:08:25 +00:00
case OUTT_TREE:
2016-01-15 23:08:59 +00:00
tree_mdoc(curp->outdata, man);
break;
2014-11-22 18:08:25 +00:00
case OUTT_MAN:
2016-01-15 23:08:59 +00:00
man_mdoc(curp->outdata, man);
break;
2014-11-22 18:08:25 +00:00
case OUTT_PDF:
case OUTT_ASCII:
case OUTT_UTF8:
case OUTT_LOCALE:
case OUTT_PS:
2016-01-15 23:08:59 +00:00
terminal_mdoc(curp->outdata, man);
break;
2017-06-08 19:29:07 +00:00
case OUTT_MARKDOWN:
markdown_mdoc(curp->outdata, man);
break;
2016-01-15 23:08:59 +00:00
default:
break;
}
}
if (man->macroset == MACROSET_MAN) {
2017-02-19 17:41:20 +00:00
if (curp->outtype != OUTT_TREE || !curp->outopts->noval)
man_validate(man);
2016-01-15 23:08:59 +00:00
switch (curp->outtype) {
case OUTT_HTML:
html_man(curp->outdata, man);
break;
case OUTT_TREE:
tree_man(curp->outdata, man);
break;
case OUTT_MAN:
man_man(curp->outdata, man);
break;
case OUTT_PDF:
case OUTT_ASCII:
case OUTT_UTF8:
case OUTT_LOCALE:
case OUTT_PS:
terminal_man(curp->outdata, man);
break;
default:
break;
}
}
2017-07-31 19:17:54 +00:00
if (curp->mmin < MANDOCERR_STYLE)
check_xr(file);
mparse_updaterc(curp->mp, &rc);
}
2017-07-31 19:17:54 +00:00
static void
check_xr(const char *file)
{
static struct manpaths paths;
struct mansearch search;
struct mandoc_xr *xr;
char *cp;
size_t sz;
if (paths.sz == 0)
manpath_base(&paths);
for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) {
if (xr->line == -1)
continue;
search.arch = NULL;
search.sec = xr->sec;
search.outkey = NULL;
search.argmode = ARG_NAME;
search.firstmatch = 1;
if (mansearch(&search, &paths, 1, &xr->name, NULL, &sz))
continue;
if (fs_search(&search, &paths, 1, &xr->name, NULL, &sz))
continue;
if (xr->count == 1)
mandoc_asprintf(&cp, "Xr %s %s", xr->name, xr->sec);
else
mandoc_asprintf(&cp, "Xr %s %s (%d times)",
xr->name, xr->sec, xr->count);
mmsg(MANDOCERR_XR_BAD, MANDOCLEVEL_STYLE,
file, xr->line, xr->pos + 1, cp);
free(cp);
}
}
static void
outdata_alloc(struct curparse *curp)
{
switch (curp->outtype) {
case OUTT_HTML:
curp->outdata = html_alloc(curp->outopts);
break;
case OUTT_UTF8:
curp->outdata = utf8_alloc(curp->outopts);
break;
case OUTT_LOCALE:
curp->outdata = locale_alloc(curp->outopts);
break;
case OUTT_ASCII:
curp->outdata = ascii_alloc(curp->outopts);
break;
case OUTT_PDF:
curp->outdata = pdf_alloc(curp->outopts);
break;
case OUTT_PS:
curp->outdata = ps_alloc(curp->outopts);
break;
default:
break;
}
}
2016-01-15 23:08:59 +00:00
static void
passthrough(const char *file, int fd, int synopsis_only)
{
const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
const char synr[] = "SYNOPSIS";
FILE *stream;
const char *syscall;
2016-01-15 23:08:59 +00:00
char *line, *cp;
size_t linesz;
ssize_t len, written;
int print;
2016-01-15 23:08:59 +00:00
line = NULL;
linesz = 0;
if (fflush(stdout) == EOF) {
syscall = "fflush";
goto fail;
}
if ((stream = fdopen(fd, "r")) == NULL) {
close(fd);
syscall = "fdopen";
goto fail;
}
print = 0;
while ((len = getline(&line, &linesz, stream)) != -1) {
2016-01-15 23:08:59 +00:00
cp = line;
if (synopsis_only) {
if (print) {
2016-01-15 23:08:59 +00:00
if ( ! isspace((unsigned char)*cp))
goto done;
while (isspace((unsigned char)*cp)) {
2016-01-15 23:08:59 +00:00
cp++;
len--;
}
} else {
2016-01-15 23:08:59 +00:00
if (strcmp(cp, synb) == 0 ||
strcmp(cp, synr) == 0)
print = 1;
continue;
}
}
for (; len > 0; len -= written) {
if ((written = write(STDOUT_FILENO, cp, len)) != -1)
continue;
2016-01-15 23:08:59 +00:00
fclose(stream);
syscall = "write";
2016-01-15 23:08:59 +00:00
goto fail;
}
}
if (ferror(stream)) {
fclose(stream);
2016-01-15 23:08:59 +00:00
syscall = "getline";
goto fail;
}
done:
2016-01-15 23:08:59 +00:00
free(line);
fclose(stream);
2016-01-15 23:08:59 +00:00
return;
fail:
2016-01-15 23:08:59 +00:00
free(line);
warn("%s: SYSERR: %s", file, syscall);
if (rc < MANDOCLEVEL_SYSERR)
rc = MANDOCLEVEL_SYSERR;
}
static int
koptions(int *options, char *arg)
{
if ( ! strcmp(arg, "utf-8")) {
*options |= MPARSE_UTF8;
*options &= ~MPARSE_LATIN1;
} else if ( ! strcmp(arg, "iso-8859-1")) {
*options |= MPARSE_LATIN1;
*options &= ~MPARSE_UTF8;
} else if ( ! strcmp(arg, "us-ascii")) {
*options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
} else {
2016-01-15 23:08:59 +00:00
warnx("-K %s: Bad argument", arg);
return 0;
}
2016-01-15 23:08:59 +00:00
return 1;
}
2017-06-08 19:29:07 +00:00
static void
2014-11-22 18:08:25 +00:00
moptions(int *options, char *arg)
{
if (arg == NULL)
2017-06-08 19:29:07 +00:00
return;
if (strcmp(arg, "doc") == 0)
2014-11-22 18:08:25 +00:00
*options |= MPARSE_MDOC;
2017-06-08 19:29:07 +00:00
else if (strcmp(arg, "an") == 0)
2014-11-22 18:08:25 +00:00
*options |= MPARSE_MAN;
}
static int
toptions(struct curparse *curp, char *arg)
{
if (0 == strcmp(arg, "ascii"))
curp->outtype = OUTT_ASCII;
else if (0 == strcmp(arg, "lint")) {
curp->outtype = OUTT_LINT;
2017-07-31 19:17:54 +00:00
curp->mmin = MANDOCERR_BASE;
mmsg_stream = stdout;
} else if (0 == strcmp(arg, "tree"))
curp->outtype = OUTT_TREE;
else if (0 == strcmp(arg, "man"))
curp->outtype = OUTT_MAN;
else if (0 == strcmp(arg, "html"))
curp->outtype = OUTT_HTML;
2017-06-08 19:29:07 +00:00
else if (0 == strcmp(arg, "markdown"))
curp->outtype = OUTT_MARKDOWN;
else if (0 == strcmp(arg, "utf8"))
curp->outtype = OUTT_UTF8;
else if (0 == strcmp(arg, "locale"))
curp->outtype = OUTT_LOCALE;
else if (0 == strcmp(arg, "ps"))
curp->outtype = OUTT_PS;
else if (0 == strcmp(arg, "pdf"))
curp->outtype = OUTT_PDF;
else {
2016-01-15 23:08:59 +00:00
warnx("-T %s: Bad argument", arg);
return 0;
}
2016-01-15 23:08:59 +00:00
return 1;
}
static int
woptions(struct curparse *curp, char *arg)
{
char *v, *o;
2017-07-31 19:17:54 +00:00
const char *toks[11];
toks[0] = "stop";
toks[1] = "all";
2017-07-31 19:17:54 +00:00
toks[2] = "base";
toks[3] = "style";
toks[4] = "warning";
toks[5] = "error";
toks[6] = "unsupp";
toks[7] = "fatal";
toks[8] = "openbsd";
toks[9] = "netbsd";
toks[10] = NULL;
while (*arg) {
o = arg;
switch (getsubopt(&arg, (char * const *)toks, &v)) {
2014-11-22 18:08:25 +00:00
case 0:
curp->wstop = 1;
break;
2014-11-22 18:08:25 +00:00
case 1:
case 2:
2017-07-31 19:17:54 +00:00
curp->mmin = MANDOCERR_BASE;
break;
2014-11-22 18:08:25 +00:00
case 3:
2017-07-31 19:17:54 +00:00
curp->mmin = MANDOCERR_STYLE;
break;
2014-11-22 18:08:25 +00:00
case 4:
2017-07-31 19:17:54 +00:00
curp->mmin = MANDOCERR_WARNING;
break;
case 5:
2017-07-31 19:17:54 +00:00
curp->mmin = MANDOCERR_ERROR;
2017-06-08 19:29:07 +00:00
break;
case 6:
2017-07-31 19:17:54 +00:00
curp->mmin = MANDOCERR_UNSUPP;
break;
case 7:
curp->mmin = MANDOCERR_MAX;
break;
case 8:
curp->mmin = MANDOCERR_BASE;
curp->os_e = MANDOC_OS_OPENBSD;
break;
case 9:
curp->mmin = MANDOCERR_BASE;
curp->os_e = MANDOC_OS_NETBSD;
break;
default:
2016-01-15 23:08:59 +00:00
warnx("-W %s: Bad argument", o);
return 0;
}
}
2016-01-15 23:08:59 +00:00
return 1;
}
static void
2014-11-22 18:08:25 +00:00
mmsg(enum mandocerr t, enum mandoclevel lvl,
const char *file, int line, int col, const char *msg)
{
2014-11-22 18:08:25 +00:00
const char *mparse_msg;
2017-07-31 19:17:54 +00:00
fprintf(mmsg_stream, "%s: %s:", getprogname(),
file == NULL ? "<stdin>" : file);
2014-11-22 18:08:25 +00:00
if (line)
2017-07-31 19:17:54 +00:00
fprintf(mmsg_stream, "%d:%d:", line, col + 1);
2014-11-22 18:08:25 +00:00
2017-07-31 19:17:54 +00:00
fprintf(mmsg_stream, " %s", mparse_strlevel(lvl));
2017-07-31 19:17:54 +00:00
if ((mparse_msg = mparse_strerror(t)) != NULL)
fprintf(mmsg_stream, ": %s", mparse_msg);
if (msg)
2017-07-31 19:17:54 +00:00
fprintf(mmsg_stream, ": %s", msg);
2017-07-31 19:17:54 +00:00
fputc('\n', mmsg_stream);
}
2015-03-15 11:28:48 +00:00
static pid_t
2016-01-15 23:08:59 +00:00
spawn_pager(struct tag_files *tag_files)
{
2016-07-23 11:45:42 +00:00
const struct timespec timeout = { 0, 100000000 }; /* 0.1s */
#define MAX_PAGER_ARGS 16
char *argv[MAX_PAGER_ARGS];
const char *pager;
char *cp;
2016-01-15 23:08:59 +00:00
size_t cmdlen;
int argc;
2015-03-15 11:28:48 +00:00
pid_t pager_pid;
pager = getenv("MANPAGER");
if (pager == NULL || *pager == '\0')
pager = getenv("PAGER");
if (pager == NULL || *pager == '\0')
2016-01-15 23:08:59 +00:00
pager = "more -s";
cp = mandoc_strdup(pager);
/*
* Parse the pager command into words.
* Intentionally do not do anything fancy here.
*/
argc = 0;
2016-01-15 23:08:59 +00:00
while (argc + 4 < MAX_PAGER_ARGS) {
argv[argc++] = cp;
cp = strchr(cp, ' ');
if (cp == NULL)
break;
*cp++ = '\0';
while (*cp == ' ')
cp++;
if (*cp == '\0')
break;
}
2016-01-15 23:08:59 +00:00
2016-07-23 11:45:42 +00:00
/* For less(1), use the tag file. */
2016-01-15 23:08:59 +00:00
if ((cmdlen = strlen(argv[0])) >= 4) {
cp = argv[0] + cmdlen - 4;
2016-07-23 11:45:42 +00:00
if (strcmp(cp, "less") == 0) {
2016-01-15 23:08:59 +00:00
argv[argc++] = mandoc_strdup("-T");
argv[argc++] = tag_files->tfn;
}
}
argv[argc++] = tag_files->ofn;
argv[argc] = NULL;
2016-01-15 23:08:59 +00:00
switch (pager_pid = fork()) {
case -1:
err((int)MANDOCLEVEL_SYSERR, "fork");
case 0:
break;
default:
(void)setpgid(pager_pid, 0);
(void)tcsetpgrp(tag_files->ofd, pager_pid);
2016-01-15 23:08:59 +00:00
#if HAVE_PLEDGE
if (pledge("stdio rpath tmppath tty proc", NULL) == -1)
err((int)MANDOCLEVEL_SYSERR, "pledge");
#endif
tag_files->pager_pid = pager_pid;
return pager_pid;
}
/* The child process becomes the pager. */
2016-01-15 23:08:59 +00:00
if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
err((int)MANDOCLEVEL_SYSERR, "pager stdout");
close(tag_files->ofd);
close(tag_files->tfd);
2016-07-23 11:45:42 +00:00
/* Do not start the pager before controlling the terminal. */
while (tcgetpgrp(STDOUT_FILENO) != getpid())
2016-07-23 11:45:42 +00:00
nanosleep(&timeout, NULL);
execvp(argv[0], argv);
2016-01-15 23:08:59 +00:00
err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
}