mandoc/main.c - diff

Return to main.c CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/main.c between version 1.329 and 1.357

version 1.329, 2019/07/10 19:39:01

version 1.357, 2021/09/04 12:52:57

Line 1

/* $Id$ */

* Permission to use, copy, modify, and distribute this software for any

Line 15

* 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.

* Main program for mandoc(1), man(1), apropos(1), whatis(1), and help(1).

#include "config.h"

Line 32

Line 34

#include <errno.h>

#include <fcntl.h>

#include <glob.h>

#include <limits.h>

#if HAVE_SANDBOX_INIT

#include <sandbox.h>

#endif

Line 52

Line 55

#include "man.h"

#include "mandoc_parse.h"

#include "tag.h"

#include "term_tag.h"

#include "main.h"

#include "manconf.h"

#include "mansearch.h"

Line 77 enum outt {

Line 81 enum outt {

OUTT_PDF /* -Tpdf */

};

struct curparse {

struct outstate {

struct mparse *mp;

struct tag_files *tag_files; /* Tagging state variables. */

struct manoutput *outopts; /* output options */

void *outdata; /* data for output */

char *os_s; /* operating system for display */

int use_pager;

int wstop; /* stop after a file with a warning */

enum mandoc_os os_e; /* check base system conventions */

int had_output; /* Some output was generated. */

enum outt outtype; /* which output to use */

};

int mandocdb(int, char *[]);

static void check_xr(void);

static void check_xr(struct manpaths *);

static int fs_lookup(const struct manpaths *,

static void fs_append(char **, size_t, int,

size_t ipath, const char *,

size_t, const char *, enum form,

const char *, const char *,

struct manpage **, size_t *);

static int fs_lookup(const struct manpaths *, size_t,

const char *, const char *, const char *,

struct manpage **, size_t *);

static int fs_search(const struct mansearch *,

const struct manpaths *, int, char**,

const struct manpaths *, const char *,

struct manpage **, size_t *);

static void outdata_alloc(struct curparse *);

static void glob_esc(char **, const char *, const char *);

static void parse(struct curparse *, int, const char *);

static void outdata_alloc(struct outstate *, struct manoutput *);

static void parse(struct mparse *, int, const char *,

struct outstate *, struct manconf *);

static void passthrough(int, int);

static pid_t spawn_pager(struct tag_files *);

static void process_onefile(struct mparse *, struct manpage *,

int, struct outstate *, struct manconf *);

static void run_pager(struct outstate *, char *);

static pid_t spawn_pager(struct outstate *, char *);

static void usage(enum argmode) __attribute__((__noreturn__));

static int woptions(struct curparse *, char *);

static int woptions(char *, enum mandoc_os *, int *);

static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};

static char help_arg[] = "help";

Line 113 static char *help_argv[] = {help_arg, NULL};

Line 123 static char *help_argv[] = {help_arg, NULL};

int

main(int argc, char *argv[])

{

struct manconf conf;

struct manconf conf; /* Manpaths and output options. */

struct mansearch search;

struct outstate outst; /* Output state. */

struct curparse curp;

struct winsize ws; /* Result of ioctl(TIOCGWINSZ). */

struct winsize ws;

struct mansearch search; /* Search options. */

struct tag_files *tag_files;

struct manpage *res; /* Complete list of search results. */

struct manpage *res, *resp;

struct manpage *resn; /* Search results for one name. */

const char *progname, *sec, *thisarg;

struct mparse *mp; /* Opaque parser object. */

char *conf_file, *defpaths, *auxpaths;

const char *conf_file; /* -C: alternate config file. */

char *oarg, *tagarg;

const char *os_s; /* -I: Operating system for display. */

const char *progname, *sec;

char *defpaths; /* -M: override manpaths. */

char *auxpaths; /* -m: additional manpaths. */

char *oarg; /* -O: output option string. */

char *tagarg; /* -O tag: default value. */

unsigned char *uc;

size_t i, sz, ssz;

size_t ressz; /* Number of elements in res[]. */

size_t resnsz; /* Number of elements in resn[]. */

size_t i, ib, ssz;

int options; /* Parser options. */

int show_usage; /* Invalid argument: give up. */

int prio, best_prio;

enum outmode outmode;

int startdir;

int fd, startdir;

int show_usage;

int options;

int use_pager;

int status, signum;

int c;

pid_t pager_pid, tc_pgid, man_pgid, pid;

enum mandoc_os os_e; /* Check base system conventions. */

enum outmode outmode; /* According to command line. */

#if HAVE_PROGNAME

progname = getprogname();

Line 152 main(int argc, char *argv[])

Line 167 main(int argc, char *argv[])

return mandocdb(argc, argv);

#if HAVE_PLEDGE

if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1) {

if (pledge("stdio rpath wpath cpath tmppath tty proc exec", NULL) == -1) {

mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));

return mandoc_msg_getrc();

}

Line 165 main(int argc, char *argv[])

Line 180 main(int argc, char *argv[])

/* Search options. */

memset(&conf, 0, sizeof(conf));

conf_file = defpaths = NULL;

conf_file = NULL;

auxpaths = NULL;

defpaths = auxpaths = NULL;

memset(&search, 0, sizeof(struct mansearch));

search.outkey = "Nd";

Line 183 main(int argc, char *argv[])

Line 198 main(int argc, char *argv[])

else

search.argmode = ARG_FILE;

/* Parser and formatter options. */

/* Parser options. */

memset(&curp, 0, sizeof(struct curparse));

curp.outtype = OUTT_LOCALE;

curp.outopts = &conf.output;

options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;

os_e = MANDOC_OS_OTHER;

os_s = NULL;

use_pager = 1;

/* Formatter options. */

tag_files = NULL;

memset(&outst, 0, sizeof(outst));

outst.tag_files = NULL;

outst.outtype = OUTT_LOCALE;

outst.use_pager = 1;

show_usage = 0;

outmode = OUTMODE_DEF;

Line 209 main(int argc, char *argv[])

Line 228 main(int argc, char *argv[])

conf_file = optarg;

break;

case 'c':

use_pager = 0;

outst.use_pager = 0;

break;

case 'f':

search.argmode = ARG_WORD;

break;

case 'h':

conf.output.synopsisonly = 1;

use_pager = 0;

outst.use_pager = 0;

outmode = OUTMODE_ALL;

break;

case 'I':

Line 225 main(int argc, char *argv[])

Line 244 main(int argc, char *argv[])

"-I %s", optarg);

return mandoc_msg_getrc();

}

if (curp.os_s != NULL) {

if (os_s != NULL) {

mandoc_msg(MANDOCERR_BADARG_DUPE, 0, 0,

"-I %s", optarg);

return mandoc_msg_getrc();

}

curp.os_s = mandoc_strdup(optarg + 3);

os_s = optarg + 3;

break;

case 'K':

options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);

Line 268 main(int argc, char *argv[])

Line 287 main(int argc, char *argv[])

break;

case 'T':

if (strcmp(optarg, "ascii") == 0)

curp.outtype = OUTT_ASCII;

outst.outtype = OUTT_ASCII;

else if (strcmp(optarg, "lint") == 0) {

curp.outtype = OUTT_LINT;

outst.outtype = OUTT_LINT;

mandoc_msg_setoutfile(stdout);

mandoc_msg_setmin(MANDOCERR_BASE);

} else if (strcmp(optarg, "tree") == 0)

curp.outtype = OUTT_TREE;

outst.outtype = OUTT_TREE;

else if (strcmp(optarg, "man") == 0)

curp.outtype = OUTT_MAN;

outst.outtype = OUTT_MAN;

else if (strcmp(optarg, "html") == 0)

curp.outtype = OUTT_HTML;

outst.outtype = OUTT_HTML;

else if (strcmp(optarg, "markdown") == 0)

curp.outtype = OUTT_MARKDOWN;

outst.outtype = OUTT_MARKDOWN;

else if (strcmp(optarg, "utf8") == 0)

curp.outtype = OUTT_UTF8;

outst.outtype = OUTT_UTF8;

else if (strcmp(optarg, "locale") == 0)

curp.outtype = OUTT_LOCALE;

outst.outtype = OUTT_LOCALE;

else if (strcmp(optarg, "ps") == 0)

curp.outtype = OUTT_PS;

outst.outtype = OUTT_PS;

else if (strcmp(optarg, "pdf") == 0)

curp.outtype = OUTT_PDF;

outst.outtype = OUTT_PDF;

else {

mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,

"-T %s", optarg);

Line 296 main(int argc, char *argv[])

Line 315 main(int argc, char *argv[])

}

break;

case 'W':

if (woptions(&curp, optarg) == -1)

if (woptions(optarg, &os_e, &outst.wstop) == -1)

return mandoc_msg_getrc();

break;

case 'w':

Line 313 main(int argc, char *argv[])

Line 332 main(int argc, char *argv[])

/* Postprocess options. */

if (outmode == OUTMODE_DEF) {

switch (outmode) {

case OUTMODE_DEF:

switch (search.argmode) {

case ARG_FILE:

outmode = OUTMODE_ALL;

use_pager = 0;

outst.use_pager = 0;

break;

case ARG_NAME:

outmode = OUTMODE_ONE;

Line 326 main(int argc, char *argv[])

Line 346 main(int argc, char *argv[])

outmode = OUTMODE_LST;

break;

}

break;

case OUTMODE_FLN:

if (search.argmode == ARG_FILE)

outmode = OUTMODE_ALL;

break;

case OUTMODE_ALL:

break;

case OUTMODE_LST:

case OUTMODE_ONE:

abort();

}

if (oarg != NULL) {

Line 340 main(int argc, char *argv[])

Line 370 main(int argc, char *argv[])

}

if (curp.outtype != OUTT_TREE || !curp.outopts->noval)

if (outst.outtype != OUTT_TREE || conf.output.noval == 0)

options |= MPARSE_VALIDATE;

if (outmode == OUTMODE_FLN ||

outmode == OUTMODE_LST ||

!isatty(STDOUT_FILENO))

(conf.output.outfilename == NULL &&

use_pager = 0;

conf.output.tagfilename == NULL &&

isatty(STDOUT_FILENO) == 0))

outst.use_pager = 0;

if (use_pager &&

if (outst.use_pager &&

(conf.output.width == 0 || conf.output.indent == 0) &&

ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) != -1 &&

ws.ws_col > 1) {

Line 359 main(int argc, char *argv[])

Line 391 main(int argc, char *argv[])

}

#if HAVE_PLEDGE

if (use_pager == 0) {

if (outst.use_pager == 0)

if (pledge("stdio rpath", NULL) == -1) {

c = pledge("stdio rpath", NULL);

mandoc_msg(MANDOCERR_PLEDGE, 0, 0,

else if (conf.output.outfilename != NULL ||

"%s", strerror(errno));

conf.output.tagfilename != NULL)

return mandoc_msg_getrc();

c = pledge("stdio rpath wpath cpath", NULL);

}

else

c = pledge("stdio rpath tmppath tty proc exec", NULL);

if (c == -1) {

mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));

return mandoc_msg_getrc();

}

#endif

Line 374 main(int argc, char *argv[])

Line 410 main(int argc, char *argv[])

argc -= optind;

argv += optind;

}

resp = NULL;

* Quirks for help(1)

* Quirks for help(1) and man(1),

* and for a man(1) section argument without -s.

* in particular for a section argument without -s.

if (search.argmode == ARG_NAME) {

Line 402 main(int argc, char *argv[])

Line 437 main(int argc, char *argv[])

if (search.arch == NULL)

search.arch = MACHINE;

#endif

if (outmode == OUTMODE_ONE)

search.firstmatch = 1;

}

Line 415 main(int argc, char *argv[])

Line 452 main(int argc, char *argv[])

conf.output.tag = tagarg == NULL ? *argv : tagarg + 1;

}

/* man(1), whatis(1), apropos(1) */

/* Read the configuration file. */

if (search.argmode != ARG_FILE) {

if (search.argmode != ARG_FILE ||

if (search.argmode == ARG_NAME &&

mandoc_msg_getmin() == MANDOCERR_STYLE)

outmode == OUTMODE_ONE)

search.firstmatch = 1;

/* Access the mandoc database. */

manconf_parse(&conf, conf_file, defpaths, auxpaths);

if ( ! mansearch(&search, &conf.manpath,

argc, argv, &res, &sz))

usage(search.argmode);

if (sz == 0 && search.argmode == ARG_NAME)

/* man(1): Resolve each name individually. */

(void)fs_search(&search, &conf.manpath,

argc, argv, &res, &sz);

if (search.argmode == ARG_NAME) {

for (c = 0; c < argc; c++) {

if (argc < 1) {

if (strchr(argv[c], '/') == NULL)

if (outmode != OUTMODE_FLN)

continue;

usage(ARG_NAME);

if (access(argv[c], R_OK) == -1) {

if (conf.manpath.sz == 0) {

mandoc_msg_setinfilename(argv[c]);

warnx("The manpath is empty.");

mandoc_msg_setrc(MANDOCLEVEL_BADARG);

} else {

for (i = 0; i + 1 < conf.manpath.sz; i++)

printf("%s:", conf.manpath.paths[i]);

printf("%s\n", conf.manpath.paths[i]);

}

manconf_free(&conf);

return (int)mandoc_msg_getrc();

}

for (res = NULL, ressz = 0; argc > 0; argc--, argv++) {

(void)mansearch(&search, &conf.manpath,

1, argv, &resn, &resnsz);

if (resnsz == 0)

(void)fs_search(&search, &conf.manpath,

*argv, &resn, &resnsz);

if (resnsz == 0 && strchr(*argv, '/') == NULL) {

if (search.arch != NULL &&

arch_valid(search.arch, OSENUM) == 0)

warnx("Unknown architecture \"%s\".",

search.arch);

else if (search.sec != NULL)

warnx("No entry for %s in "

"section %s of the manual.",

*argv, search.sec);

else

warnx("No entry for %s in "

"the manual.", *argv);

mandoc_msg_setrc(MANDOCLEVEL_BADARG);

continue;

}

if (resnsz == 0) {

if (access(*argv, R_OK) == -1) {

mandoc_msg_setinfilename(*argv);

mandoc_msg(MANDOCERR_BADARG_BAD,

0, 0, "%s", strerror(errno));

mandoc_msg_setinfilename(NULL);

continue;

}

resnsz = 1;

resn = mandoc_calloc(resnsz, sizeof(*res));

resn->file = mandoc_strdup(*argv);

resn->ipath = SIZE_MAX;

resn->form = FORM_SRC;

}

if (outmode != OUTMODE_ONE || resnsz == 1) {

res = mandoc_reallocarray(res,

sz + 1, sizeof(*res));

ressz + resnsz, sizeof(*res));

res[sz].file = mandoc_strdup(argv[c]);

memcpy(res + ressz, resn,

res[sz].names = NULL;

sizeof(*resn) * resnsz);

res[sz].output = NULL;

ressz += resnsz;

res[sz].bits = 0;

continue;

res[sz].ipath = SIZE_MAX;

res[sz].sec = 10;

res[sz].form = FORM_SRC;

sz++;

}

if (sz == 0) {

/* Search for the best section. */

if (search.argmode != ARG_NAME)

warnx("nothing appropriate");

mandoc_msg_setrc(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 = 40;

} else if (outmode == OUTMODE_ALL)

for (ib = i = 0; i < resnsz; i++) {

argc = (int)sz;

sec = resn[i].file;

/* 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. */

sec = res[i].file;

sec += strcspn(sec, "123456789");

if (sec[0] == '\0')

continue; /* No section at all. */

Line 509 main(int argc, char *argv[])

Line 544 main(int argc, char *argv[])

if (prio >= best_prio)

continue;

best_prio = prio;

resp = res + i;

ib = i;

}

res = mandoc_reallocarray(res, ressz + 1,

sizeof(*res));

memcpy(res + ressz++, resn + ib, sizeof(*resn));

}

/* apropos(1), whatis(1): Process the full search expression. */

* 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)

} else if (search.argmode != ARG_FILE) {

if (mansearch(&search, &conf.manpath,

argc, argv, &res, &ressz) == 0)

usage(search.argmode);

if (ressz == 0) {

warnx("nothing appropriate");

mandoc_msg_setrc(MANDOCLEVEL_BADARG);

goto out;

}

/* mandoc(1) */

/* mandoc(1): Take command line arguments as file names. */

#if HAVE_PLEDGE

if (use_pager) {

if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1) {

mandoc_msg(MANDOCERR_PLEDGE, 0, 0,

"%s", strerror(errno));

return mandoc_msg_getrc();

}

} else {

if (pledge("stdio rpath", NULL) == -1) {

ressz = argc > 0 ? argc : 1;

mandoc_msg(MANDOCERR_PLEDGE, 0, 0,

res = mandoc_calloc(ressz, sizeof(*res));

"%s", strerror(errno));

for (i = 0; i < ressz; i++) {

return mandoc_msg_getrc();

if (argc > 0)

res[i].file = mandoc_strdup(argv[i]);

res[i].ipath = SIZE_MAX;

res[i].form = FORM_SRC;

}

#endif

switch (outmode) {

case OUTMODE_FLN:

for (i = 0; i < ressz; i++)

puts(res[i].file);

goto out;

case OUTMODE_LST:

for (i = 0; i < ressz; i++)

printf("%s - %s\n", res[i].names,

res[i].output == NULL ? "" :

res[i].output);

goto out;

default:

break;

}

if (search.argmode == ARG_FILE && auxpaths != NULL) {

if (strcmp(auxpaths, "doc") == 0)

options |= MPARSE_MDOC;

Line 549 main(int argc, char *argv[])

Line 600 main(int argc, char *argv[])

}

mchars_alloc();

curp.mp = mparse_alloc(options, curp.os_e, curp.os_s);

mp = mparse_alloc(options, os_e, os_s);

if (argc < 1) {

if (use_pager) {

tag_files = tag_init();

if (tag_files != NULL)

tag_files->tagname = conf.output.tag;

}

thisarg = "<stdin>";

mandoc_msg_setinfilename(thisarg);

parse(&curp, STDIN_FILENO, thisarg);

mandoc_msg_setinfilename(NULL);

}

* Remember the original working directory, if possible.

* This will be needed if some names on the command line

Line 571 main(int argc, char *argv[])

Line 610 main(int argc, char *argv[])

* readable: Maybe it won't be needed after all.

startdir = open(".", O_RDONLY | O_DIRECTORY);

for (i = 0; i < ressz; i++) {

while (argc > 0) {

process_onefile(mp, res + i, startdir, &outst, &conf);

if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)

* Changing directories is not needed in ARG_FILE mode.

* Do it on a best-effort basis. Even in case of

* failure, some functionality may still work.

if (resp != NULL) {

if (resp->ipath != SIZE_MAX)

(void)chdir(conf.manpath.paths[resp->ipath]);

else if (startdir != -1)

(void)fchdir(startdir);

thisarg = resp->file;

} else

thisarg = *argv;

mandoc_msg_setinfilename(thisarg);

fd = mparse_open(curp.mp, thisarg);

if (fd != -1) {

if (use_pager) {

use_pager = 0;

tag_files = tag_init();

if (tag_files != NULL)

tag_files->tagname = conf.output.tag;

}

if (resp == NULL || resp->form == FORM_SRC)

parse(&curp, fd, thisarg);

else

passthrough(fd, conf.output.synopsisonly);

if (ferror(stdout)) {

if (tag_files != NULL) {

mandoc_msg(MANDOCERR_WRITE, 0, 0,

"%s: %s", tag_files->ofn,

strerror(errno));

tag_unlink();

tag_files = NULL;

} else

mandoc_msg(MANDOCERR_WRITE, 0, 0,

"%s", strerror(errno));

break;

}

if (argc > 1 && curp.outtype <= OUTT_UTF8) {

if (curp.outdata == NULL)

outdata_alloc(&curp);

terminal_sepline(curp.outdata);

}

} else

mandoc_msg(resp == NULL ? MANDOCERR_BADARG_BAD :

MANDOCERR_OPEN, 0, 0, "%s", strerror(errno));

mandoc_msg_setinfilename(NULL);

if (curp.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)

break;

if (resp != NULL)

resp++;

else

argv++;

if (--argc)

mparse_reset(curp.mp);

}

if (startdir != -1) {

(void)fchdir(startdir);

close(startdir);

}

if (conf.output.tag != NULL && conf.output.tag_found == 0) {

if (curp.outdata != NULL) {

mandoc_msg(MANDOCERR_TAG, 0, 0, "%s", conf.output.tag);

switch (curp.outtype) {

conf.output.tag = NULL;

}

if (outst.outdata != NULL) {

switch (outst.outtype) {

case OUTT_HTML:

html_free(curp.outdata);

html_free(outst.outdata);

break;

case OUTT_UTF8:

case OUTT_LOCALE:

case OUTT_ASCII:

ascii_free(curp.outdata);

ascii_free(outst.outdata);

break;

case OUTT_PDF:

case OUTT_PS:

pspdf_free(curp.outdata);

pspdf_free(outst.outdata);

break;

default:

break;

}

mandoc_xr_free();

mparse_free(curp.mp);

mparse_free(mp);

mchars_free();

out:

if (search.argmode != ARG_FILE) {

mansearch_free(res, ressz);

if (search.argmode != ARG_FILE)

manconf_free(&conf);

mansearch_free(res, sz);

}

free(curp.os_s);

if (outst.tag_files != NULL) {

if (term_tag_close() != -1 &&

conf.output.outfilename == NULL &&

conf.output.tagfilename == NULL)

run_pager(&outst, conf.output.tag);

term_tag_unlink();

} else if (outst.had_output && outst.outtype != OUTT_LINT)

mandoc_msg_summary();

* When using a pager, finish writing both temporary files,

* fork it, wait for the user to close it, and clean up.

if (tag_files != NULL) {

fclose(stdout);

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);

if (tc_pgid != man_pgid) {

if (tc_pgid == pager_pid) {

(void)tcsetpgrp(tag_files->ofd,

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);

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) {

mandoc_msg(MANDOCERR_WAIT, 0, 0,

"%s", strerror(errno));

break;

}

if (!WIFSTOPPED(status))

break;

signum = WSTOPSIG(status);

}

tag_unlink();

}

return (int)mandoc_msg_getrc();

}

Line 759 usage(enum argmode argmode)

Line 690 usage(enum argmode argmode)

exit((int)MANDOCLEVEL_BADARG);

}

static void

glob_esc(char **dst, const char *src, const char *suffix)

{

while (*src != '\0') {

if (strchr("*?[", *src) != NULL)

*(*dst)++ = '\\';

*(*dst)++ = *src++;

}

while (*suffix != '\0')

*(*dst)++ = *suffix++;

}

static void

fs_append(char **file, size_t filesz, int copy, size_t ipath,

const char *sec, enum form form, struct manpage **res, size_t *ressz)

{

struct manpage *page;

*res = mandoc_reallocarray(*res, *ressz + filesz, sizeof(**res));

page = *res + *ressz;

*ressz += filesz;

for (;;) {

page->file = copy ? mandoc_strdup(*file) : *file;

page->names = NULL;

page->output = NULL;

page->bits = NAME_FILE & NAME_MASK;

page->ipath = ipath;

page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;

page->form = form;

if (--filesz == 0)

break;

file++;

page++;

}

static int

fs_lookup(const struct manpaths *paths, size_t ipath,

const char *sec, const char *arch, const char *name,

Line 766 fs_lookup(const struct manpaths *paths, size_t ipath,

Line 733 fs_lookup(const struct manpaths *paths, size_t ipath,

{

struct stat sb;

glob_t globinfo;

struct manpage *page;

char *file, *cp, secnum[2];

char *file;

int globres;

enum form form;

const char *const slman = "/man";

const char *const slash = "/";

const char *const sglob = ".[01-9]*";

const char *const dot = ".";

const char *const aster = "*";

memset(&globinfo, 0, sizeof(globinfo));

form = FORM_SRC;

mandoc_asprintf(&file, "%s/man%s/%s.%s",

paths->paths[ipath], sec, name, sec);

if (stat(file, &sb) != -1)

Line 794 fs_lookup(const struct manpaths *paths, size_t ipath,

Line 768 fs_lookup(const struct manpaths *paths, size_t ipath,

free(file);

}

mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",

cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +

paths->paths[ipath], sec, name);

strlen(slman) + strlen(sec) * 2 + strlen(slash) +

strlen(name) * 2 + strlen(sglob) + 1);

glob_esc(&cp, paths->paths[ipath], slman);

glob_esc(&cp, sec, slash);

glob_esc(&cp, name, sglob);

*cp = '\0';

globres = glob(file, 0, NULL, &globinfo);

if (globres != 0 && globres != GLOB_NOMATCH)

mandoc_msg(MANDOCERR_GLOB, 0, 0,

"%s: %s", file, strerror(errno));

free(file);

file = NULL;

if (globres == 0)

file = mandoc_strdup(*globinfo.gl_pathv);

goto found;

globfree(&globinfo);

if (globres == 0) {

if (stat(file, &sb) != -1)

if (sec[1] != '\0' && *ressz == 0) {

goto found;

secnum[0] = sec[0];

secnum[1] = '\0';

cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +

strlen(slman) + strlen(secnum) * 2 + strlen(slash) +

strlen(name) * 2 + strlen(dot) +

strlen(sec) * 2 + strlen(aster) + 1);

glob_esc(&cp, paths->paths[ipath], slman);

glob_esc(&cp, secnum, slash);

glob_esc(&cp, name, dot);

glob_esc(&cp, sec, aster);

*cp = '\0';

globres = glob(file, 0, NULL, &globinfo);

if (globres != 0 && globres != GLOB_NOMATCH)

mandoc_msg(MANDOCERR_GLOB, 0, 0,

"%s: %s", file, strerror(errno));

free(file);

file = NULL;

if (globres == 0)

goto found;

globfree(&globinfo);

}

if (res != NULL || ipath + 1 != paths->sz)

return -1;

Line 820 fs_lookup(const struct manpaths *paths, size_t ipath,

Line 819 fs_lookup(const struct manpaths *paths, size_t ipath,

found:

warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",

name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);

if (res == NULL) {

if (res == NULL)

free(file);

return 0;

else if (file == NULL)

}

fs_append(globinfo.gl_pathv, globinfo.gl_pathc, 1,

*res = mandoc_reallocarray(*res, ++*ressz, sizeof(**res));

ipath, sec, form, res, ressz);

page = *res + (*ressz - 1);

else

page->file = file;

fs_append(&file, 1, 0, ipath, sec, form, res, ressz);

page->names = NULL;

globfree(&globinfo);

page->output = NULL;

page->bits = NAME_FILE & NAME_MASK;

page->ipath = ipath;

page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;

page->form = form;

return 0;

}

static int

fs_search(const struct mansearch *cfg, const struct manpaths *paths,

int argc, char **argv, struct manpage **res, size_t *ressz)

const char *name, struct manpage **res, size_t *ressz)

{

const char *const sections[] =

{"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"};

const size_t nsec = sizeof(sections)/sizeof(sections[0]);

size_t ipath, isec, lastsz;

size_t ipath, isec;

assert(cfg->argmode == ARG_NAME);

if (res != NULL)

*res = NULL;

*ressz = lastsz = 0;

*ressz = 0;

while (argc) {

for (ipath = 0; ipath < paths->sz; ipath++) {

if (cfg->sec != NULL) {

if (fs_lookup(paths, ipath, cfg->sec, cfg->arch,

if (fs_lookup(paths, ipath, cfg->sec,

name, res, ressz) != -1 && cfg->firstmatch)

cfg->arch, *argv, res, ressz) != -1 &&

return 0;

cfg->firstmatch)

} else {

return 0;

for (isec = 0; isec < nsec; isec++)

} else for (isec = 0; isec < nsec; isec++)

if (fs_lookup(paths, ipath, sections[isec],

cfg->arch, *argv, res, ressz) != -1 &&

cfg->arch, name, res, ressz) != -1 &&

cfg->firstmatch)

return 0;

}

if (res != NULL && *ressz == lastsz &&

strchr(*argv, '/') == NULL) {

if (cfg->arch != NULL &&

arch_valid(cfg->arch, OSENUM) == 0)

warnx("Unknown architecture \"%s\".",

cfg->arch);

else if (cfg->sec == NULL)

warnx("No entry for %s in the manual.",

*argv);

else

warnx("No entry for %s in section %s "

"of the manual.", *argv, cfg->sec);

}

lastsz = *ressz;

argv++;

argc--;

}

return -1;

}

static void

parse(struct curparse *curp, int fd, const char *file)

process_onefile(struct mparse *mp, struct manpage *resp, int startdir,

struct outstate *outst, struct manconf *conf)

{

struct roff_meta *meta;

int fd;

/* Begin by parsing the file itself. */

* Changing directories is not needed in ARG_FILE mode.

* Do it on a best-effort basis. Even in case of

* failure, some functionality may still work.

if (resp->ipath != SIZE_MAX)

(void)chdir(conf->manpath.paths[resp->ipath]);

else if (startdir != -1)

(void)fchdir(startdir);

assert(file);

mandoc_msg_setinfilename(resp->file);

if (resp->file != NULL) {

if ((fd = mparse_open(mp, resp->file)) == -1) {

mandoc_msg(resp->ipath == SIZE_MAX ?

MANDOCERR_BADARG_BAD : MANDOCERR_OPEN,

0, 0, "%s", strerror(errno));

mandoc_msg_setinfilename(NULL);

return;

}

} else

fd = STDIN_FILENO;

if (outst->use_pager) {

outst->use_pager = 0;

outst->tag_files = term_tag_init(conf->output.outfilename,

outst->outtype == OUTT_HTML ? ".html" : "",

conf->output.tagfilename);

#if HAVE_PLEDGE

if ((conf->output.outfilename != NULL ||

conf->output.tagfilename != NULL) &&

pledge("stdio rpath cpath", NULL) == -1) {

mandoc_msg(MANDOCERR_PLEDGE, 0, 0,

"%s", strerror(errno));

exit(mandoc_msg_getrc());

}

#endif

}

if (outst->had_output && outst->outtype <= OUTT_UTF8) {

if (outst->outdata == NULL)

outdata_alloc(outst, &conf->output);

terminal_sepline(outst->outdata);

}

if (resp->form == FORM_SRC)

parse(mp, fd, resp->file, outst, conf);

else {

passthrough(fd, conf->output.synopsisonly);

outst->had_output = 1;

}

if (ferror(stdout)) {

if (outst->tag_files != NULL) {

mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s",

outst->tag_files->ofn, strerror(errno));

term_tag_unlink();

outst->tag_files = NULL;

} else

mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s",

strerror(errno));

}

mandoc_msg_setinfilename(NULL);

}

static void

parse(struct mparse *mp, int fd, const char *file,

struct outstate *outst, struct manconf *conf)

{

static struct manpaths basepaths;

static int previous;

struct roff_meta *meta;

assert(fd >= 0);

if (file == NULL)

file = "<stdin>";

mparse_readfd(curp->mp, fd, file);

if (previous)

mparse_reset(mp);

else

previous = 1;

mparse_readfd(mp, fd, file);

if (fd != STDIN_FILENO)

close(fd);

Line 903 parse(struct curparse *curp, int fd, const char *file)

Line 955 parse(struct curparse *curp, int fd, const char *file)

* level, do not produce output.

if (curp->wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)

if (outst->wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)

return;

if (curp->outdata == NULL)

if (outst->outdata == NULL)

outdata_alloc(curp);

outdata_alloc(outst, &conf->output);

else if (curp->outtype == OUTT_HTML)

else if (outst->outtype == OUTT_HTML)

html_reset(curp);

html_reset(outst->outdata);

mandoc_xr_reset();

meta = mparse_result(curp->mp);

meta = mparse_result(mp);

/* Execute the out device, if it exists. */

outst->had_output = 1;

if (meta->macroset == MACROSET_MDOC) {

switch (curp->outtype) {

switch (outst->outtype) {

case OUTT_HTML:

html_mdoc(curp->outdata, meta);

html_mdoc(outst->outdata, meta);

break;

case OUTT_TREE:

tree_mdoc(curp->outdata, meta);

tree_mdoc(outst->outdata, meta);

break;

case OUTT_MAN:

man_mdoc(curp->outdata, meta);

man_mdoc(outst->outdata, meta);

break;

case OUTT_PDF:

case OUTT_ASCII:

case OUTT_UTF8:

case OUTT_LOCALE:

case OUTT_PS:

terminal_mdoc(curp->outdata, meta);

terminal_mdoc(outst->outdata, meta);

break;

case OUTT_MARKDOWN:

markdown_mdoc(curp->outdata, meta);

markdown_mdoc(outst->outdata, meta);

break;

default:

break;

}

if (meta->macroset == MACROSET_MAN) {

switch (curp->outtype) {

switch (outst->outtype) {

case OUTT_HTML:

html_man(curp->outdata, meta);

html_man(outst->outdata, meta);

break;

case OUTT_TREE:

tree_man(curp->outdata, meta);

tree_man(outst->outdata, meta);

break;

case OUTT_MAN:

mparse_copy(curp->mp);

mparse_copy(mp);

break;

case OUTT_PDF:

case OUTT_ASCII:

case OUTT_UTF8:

case OUTT_LOCALE:

case OUTT_PS:

terminal_man(curp->outdata, meta);

terminal_man(outst->outdata, meta);

break;

case OUTT_MARKDOWN:

mandoc_msg(MANDOCERR_MAN_TMARKDOWN, 0, 0, NULL);

break;

default:

break;

}

if (mandoc_msg_getmin() < MANDOCERR_STYLE)

if (conf->output.tag != NULL && conf->output.tag_found == 0 &&

check_xr();

tag_exists(conf->output.tag))

conf->output.tag_found = 1;

if (mandoc_msg_getmin() < MANDOCERR_STYLE) {

if (basepaths.sz == 0)

manpath_base(&basepaths);

check_xr(&basepaths);

} else if (mandoc_msg_getmin() < MANDOCERR_WARNING)

check_xr(&conf->manpath);

}

static void

check_xr(void)

check_xr(struct manpaths *paths)

{

static struct manpaths paths;

struct mansearch search;

struct mandoc_xr *xr;

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;

Line 986 check_xr(void)

Line 1046 check_xr(void)

search.outkey = NULL;

search.argmode = ARG_NAME;

search.firstmatch = 1;

if (mansearch(&search, &paths, 1, &xr->name, NULL, &sz))

if (mansearch(&search, paths, 1, &xr->name, NULL, &sz))

continue;

if (fs_search(&search, &paths, 1, &xr->name, NULL, &sz) != -1)

if (fs_search(&search, paths, xr->name, NULL, &sz) != -1)

continue;

if (xr->count == 1)

mandoc_msg(MANDOCERR_XR_BAD, xr->line,

Line 1001 check_xr(void)

Line 1061 check_xr(void)

}

static void

outdata_alloc(struct curparse *curp)

outdata_alloc(struct outstate *outst, struct manoutput *outconf)

{

switch (curp->outtype) {

switch (outst->outtype) {

case OUTT_HTML:

curp->outdata = html_alloc(curp->outopts);

outst->outdata = html_alloc(outconf);

break;

case OUTT_UTF8:

curp->outdata = utf8_alloc(curp->outopts);

outst->outdata = utf8_alloc(outconf);

break;

case OUTT_LOCALE:

curp->outdata = locale_alloc(curp->outopts);

outst->outdata = locale_alloc(outconf);

break;

case OUTT_ASCII:

curp->outdata = ascii_alloc(curp->outopts);

outst->outdata = ascii_alloc(outconf);

break;

case OUTT_PDF:

curp->outdata = pdf_alloc(curp->outopts);

outst->outdata = pdf_alloc(outconf);

break;

case OUTT_PS:

curp->outdata = ps_alloc(curp->outopts);

outst->outdata = ps_alloc(outconf);

break;

default:

break;

Line 1090 done:

Line 1150 done:

}

static int

woptions(struct curparse *curp, char *arg)

woptions(char *arg, enum mandoc_os *os_e, int *wstop)

{

char *v, *o;

const char *toks[11];

Line 1111 woptions(struct curparse *curp, char *arg)

Line 1171 woptions(struct curparse *curp, char *arg)

o = arg;

switch (getsubopt(&arg, (char * const *)toks, &v)) {

case 0:

curp->wstop = 1;

*wstop = 1;

break;

case 1:

case 2:

Line 1134 woptions(struct curparse *curp, char *arg)

Line 1194 woptions(struct curparse *curp, char *arg)

break;

case 8:

mandoc_msg_setmin(MANDOCERR_BASE);

curp->os_e = MANDOC_OS_OPENBSD;

*os_e = MANDOC_OS_OPENBSD;

break;

case 9:

mandoc_msg_setmin(MANDOCERR_BASE);

curp->os_e = MANDOC_OS_NETBSD;

*os_e = MANDOC_OS_NETBSD;

break;

default:

mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, "-W %s", o);

Line 1148 woptions(struct curparse *curp, char *arg)

Line 1208 woptions(struct curparse *curp, char *arg)

return 0;

}

* Wait until moved to the foreground,

* then fork the pager and wait for the user to close it.

static void

run_pager(struct outstate *outst, char *tag_target)

{

int signum, status;

pid_t man_pgid, tc_pgid;

pid_t pager_pid, wait_pid;

man_pgid = getpgid(0);

outst->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(STDOUT_FILENO);

if (tc_pgid != man_pgid) {

if (tc_pgid == pager_pid) {

(void)tcsetpgrp(STDOUT_FILENO, man_pgid);

if (signum == SIGTTIN)

continue;

} else

outst->tag_files->tcpgid = tc_pgid;

kill(0, signum);

continue;

}

/* Once in the foreground, activate the pager. */

if (pager_pid) {

(void)tcsetpgrp(STDOUT_FILENO, pager_pid);

kill(pager_pid, SIGCONT);

} else

pager_pid = spawn_pager(outst, tag_target);

/* Wait for the pager to stop or exit. */

while ((wait_pid = waitpid(pager_pid, &status,

WUNTRACED)) == -1 && errno == EINTR)

continue;

if (wait_pid == -1) {

mandoc_msg(MANDOCERR_WAIT, 0, 0,

"%s", strerror(errno));

break;

}

if (!WIFSTOPPED(status))

break;

signum = WSTOPSIG(status);

}

static pid_t

spawn_pager(struct tag_files *tag_files)

spawn_pager(struct outstate *outst, char *tag_target)

{

const struct timespec timeout = { 0, 100000000 }; /* 0.1s */

#define MAX_PAGER_ARGS 16

Line 1162 spawn_pager(struct tag_files *tag_files)

Line 1280 spawn_pager(struct tag_files *tag_files)

int argc, use_ofn;

pid_t pager_pid;

assert(outst->tag_files->ofd == -1);

assert(outst->tag_files->tfs == NULL);

pager = getenv("MANPAGER");

if (pager == NULL || *pager == '\0')

pager = getenv("PAGER");

if (pager == NULL || *pager == '\0')

pager = "more -s";

pager = BINM_PAGER;

cp = mandoc_strdup(pager);

Line 1191 spawn_pager(struct tag_files *tag_files)

Line 1312 spawn_pager(struct tag_files *tag_files)

use_ofn = 1;

#if HAVE_LESS_T

if ((cmdlen = strlen(argv[0])) >= 4) {

if (*outst->tag_files->tfn != '\0' &&

(cmdlen = strlen(argv[0])) >= 4) {

cp = argv[0] + cmdlen - 4;

if (strcmp(cp, "less") == 0) {

argv[argc++] = mandoc_strdup("-T");

argv[argc++] = tag_files->tfn;

argv[argc++] = outst->tag_files->tfn;

if (tag_files->tagname != NULL) {

if (tag_target != NULL) {

argv[argc++] = mandoc_strdup("-t");

argv[argc++] = tag_files->tagname;

argv[argc++] = tag_target;

use_ofn = 0;

}

#endif

if (use_ofn)

if (use_ofn) {

argv[argc++] = tag_files->ofn;

if (outst->outtype == OUTT_HTML && tag_target != NULL)

mandoc_asprintf(&argv[argc], "file://%s#%s",

outst->tag_files->ofn, tag_target);

else

argv[argc] = outst->tag_files->ofn;

argc++;

}

argv[argc] = NULL;

switch (pager_pid = fork()) {

Line 1216 spawn_pager(struct tag_files *tag_files)

Line 1344 spawn_pager(struct tag_files *tag_files)

break;

default:

(void)setpgid(pager_pid, 0);

(void)tcsetpgrp(tag_files->ofd, pager_pid);

(void)tcsetpgrp(STDOUT_FILENO, pager_pid);

#if HAVE_PLEDGE

if (pledge("stdio rpath tmppath tty proc", NULL) == -1) {

mandoc_msg(MANDOCERR_PLEDGE, 0, 0,

Line 1224 spawn_pager(struct tag_files *tag_files)

Line 1352 spawn_pager(struct tag_files *tag_files)

exit(mandoc_msg_getrc());

}

#endif

tag_files->pager_pid = pager_pid;

outst->tag_files->pager_pid = pager_pid;

return pager_pid;

}

/* The child process becomes the pager. */

* The child process becomes the pager.

if (dup2(tag_files->ofd, STDOUT_FILENO) == -1) {

* Do not start it before controlling the terminal.

mandoc_msg(MANDOCERR_DUP, 0, 0, "%s", strerror(errno));

_exit(mandoc_msg_getrc());

}

close(tag_files->ofd);

assert(tag_files->tfd == -1);

/* Do not start the pager before controlling the terminal. */

while (tcgetpgrp(STDOUT_FILENO) != getpid())

nanosleep(&timeout, NULL);

CVSweb