1 /* $Id: main.c,v 1.358 2021/09/04 22:38:46 schwarze Exp $ */
3 * Copyright (c) 2010-2012, 2014-2021 Ingo Schwarze <schwarze@openbsd.org>
4 * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
5 * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 * Main program for mandoc(1), man(1), apropos(1), whatis(1), and help(1).
23 #include <sys/types.h>
24 #include <sys/ioctl.h>
25 #include <sys/param.h> /* MACHINE */
50 #include "mandoc_aux.h"
52 #include "mandoc_xr.h"
56 #include "mandoc_parse.h"
61 #include "mansearch.h"
72 OUTT_ASCII = 0, /* -Tascii */
73 OUTT_LOCALE, /* -Tlocale */
74 OUTT_UTF8, /* -Tutf8 */
75 OUTT_TREE, /* -Ttree */
77 OUTT_HTML, /* -Thtml */
78 OUTT_MARKDOWN, /* -Tmarkdown */
79 OUTT_LINT, /* -Tlint */
85 struct tag_files *tag_files; /* Tagging state variables. */
86 void *outdata; /* data for output */
88 int wstop; /* stop after a file with a warning */
89 int had_output; /* Some output was generated. */
90 enum outt outtype; /* which output to use */
94 int mandocdb(int, char *[]);
96 static void check_xr(struct manpaths *);
97 static void fs_append(char **, size_t, int,
98 size_t, const char *, enum form,
99 struct manpage **, size_t *);
100 static int fs_lookup(const struct manpaths *, size_t,
101 const char *, const char *, const char *,
102 struct manpage **, size_t *);
103 static int fs_search(const struct mansearch *,
104 const struct manpaths *, const char *,
105 struct manpage **, size_t *);
106 static void glob_esc(char **, const char *, const char *);
107 static void outdata_alloc(struct outstate *, struct manoutput *);
108 static void parse(struct mparse *, int, const char *,
109 struct outstate *, struct manconf *);
110 static void passthrough(int, int);
111 static void process_onefile(struct mparse *, struct manpage *,
112 int, struct outstate *, struct manconf *);
113 static void run_pager(struct outstate *, char *);
114 static pid_t spawn_pager(struct outstate *, char *);
115 static void usage(enum argmode) __attribute__((__noreturn__));
116 static int woptions(char *, enum mandoc_os *, int *);
118 static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
119 static char help_arg[] = "help";
120 static char *help_argv[] = {help_arg, NULL};
124 main(int argc, char *argv[])
126 struct manconf conf; /* Manpaths and output options. */
127 struct outstate outst; /* Output state. */
128 struct winsize ws; /* Result of ioctl(TIOCGWINSZ). */
129 struct mansearch search; /* Search options. */
130 struct manpage *res; /* Complete list of search results. */
131 struct manpage *resn; /* Search results for one name. */
132 struct mparse *mp; /* Opaque parser object. */
133 const char *conf_file; /* -C: alternate config file. */
134 const char *os_s; /* -I: Operating system for display. */
135 const char *progname, *sec, *ep;
136 char *defpaths; /* -M: override manpaths. */
137 char *auxpaths; /* -m: additional manpaths. */
138 char *oarg; /* -O: output option string. */
139 char *tagarg; /* -O tag: default value. */
141 size_t ressz; /* Number of elements in res[]. */
142 size_t resnsz; /* Number of elements in resn[]. */
144 int options; /* Parser options. */
145 int show_usage; /* Invalid argument: give up. */
149 enum mandoc_os os_e; /* Check base system conventions. */
150 enum outmode outmode; /* According to command line. */
153 progname = getprogname();
156 progname = mandoc_strdup("mandoc");
157 else if ((progname = strrchr(argv[0], '/')) == NULL)
161 setprogname(progname);
164 mandoc_msg_setoutfile(stderr);
165 if (strncmp(progname, "mandocdb", 8) == 0 ||
166 strcmp(progname, BINM_MAKEWHATIS) == 0)
167 return mandocdb(argc, argv);
170 if (pledge("stdio rpath wpath cpath tmppath tty proc exec", NULL) == -1) {
171 mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));
172 return mandoc_msg_getrc();
175 #if HAVE_SANDBOX_INIT
176 if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1)
177 errx((int)MANDOCLEVEL_SYSERR, "sandbox_init");
180 /* Search options. */
182 memset(&conf, 0, sizeof(conf));
184 defpaths = auxpaths = NULL;
186 memset(&search, 0, sizeof(struct mansearch));
187 search.outkey = "Nd";
190 if (strcmp(progname, BINM_MAN) == 0)
191 search.argmode = ARG_NAME;
192 else if (strcmp(progname, BINM_APROPOS) == 0)
193 search.argmode = ARG_EXPR;
194 else if (strcmp(progname, BINM_WHATIS) == 0)
195 search.argmode = ARG_WORD;
196 else if (strncmp(progname, "help", 4) == 0)
197 search.argmode = ARG_NAME;
199 search.argmode = ARG_FILE;
201 /* Parser options. */
203 options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
204 os_e = MANDOC_OS_OTHER;
207 /* Formatter options. */
209 memset(&outst, 0, sizeof(outst));
210 outst.tag_files = NULL;
211 outst.outtype = OUTT_LOCALE;
215 outmode = OUTMODE_DEF;
217 while ((c = getopt(argc, argv,
218 "aC:cfhI:iK:klM:m:O:S:s:T:VW:w")) != -1) {
219 if (c == 'i' && search.argmode == ARG_EXPR) {
225 outmode = OUTMODE_ALL;
234 search.argmode = ARG_WORD;
237 conf.output.synopsisonly = 1;
239 outmode = OUTMODE_ALL;
242 if (strncmp(optarg, "os=", 3) != 0) {
243 mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
245 return mandoc_msg_getrc();
248 mandoc_msg(MANDOCERR_BADARG_DUPE, 0, 0,
250 return mandoc_msg_getrc();
255 options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
256 if (strcmp(optarg, "utf-8") == 0)
257 options |= MPARSE_UTF8;
258 else if (strcmp(optarg, "iso-8859-1") == 0)
259 options |= MPARSE_LATIN1;
260 else if (strcmp(optarg, "us-ascii") != 0) {
261 mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
263 return mandoc_msg_getrc();
267 search.argmode = ARG_EXPR;
270 search.argmode = ARG_FILE;
271 outmode = OUTMODE_ALL;
275 defpaths = strdup(optarg);
276 if (defpaths == NULL)
289 search.arch = optarg;
295 if (strcmp(optarg, "ascii") == 0)
296 outst.outtype = OUTT_ASCII;
297 else if (strcmp(optarg, "lint") == 0) {
298 outst.outtype = OUTT_LINT;
299 mandoc_msg_setoutfile(stdout);
300 mandoc_msg_setmin(MANDOCERR_BASE);
301 } else if (strcmp(optarg, "tree") == 0)
302 outst.outtype = OUTT_TREE;
303 else if (strcmp(optarg, "man") == 0)
304 outst.outtype = OUTT_MAN;
305 else if (strcmp(optarg, "html") == 0)
306 outst.outtype = OUTT_HTML;
307 else if (strcmp(optarg, "markdown") == 0)
308 outst.outtype = OUTT_MARKDOWN;
309 else if (strcmp(optarg, "utf8") == 0)
310 outst.outtype = OUTT_UTF8;
311 else if (strcmp(optarg, "locale") == 0)
312 outst.outtype = OUTT_LOCALE;
313 else if (strcmp(optarg, "ps") == 0)
314 outst.outtype = OUTT_PS;
315 else if (strcmp(optarg, "pdf") == 0)
316 outst.outtype = OUTT_PDF;
318 mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
320 return mandoc_msg_getrc();
324 if (woptions(optarg, &os_e, &outst.wstop) == -1)
325 return mandoc_msg_getrc();
328 outmode = OUTMODE_FLN;
337 usage(search.argmode);
339 /* Postprocess options. */
343 switch (search.argmode) {
345 outmode = OUTMODE_ALL;
349 outmode = OUTMODE_ONE;
352 outmode = OUTMODE_LST;
357 if (search.argmode == ARG_FILE)
358 outmode = OUTMODE_ALL;
368 if (outmode == OUTMODE_LST)
369 search.outkey = oarg;
371 while (oarg != NULL) {
372 if (manconf_output(&conf.output,
373 strsep(&oarg, ","), 0) == -1)
374 return mandoc_msg_getrc();
379 if (outst.outtype != OUTT_TREE || conf.output.noval == 0)
380 options |= MPARSE_VALIDATE;
382 if (outmode == OUTMODE_FLN ||
383 outmode == OUTMODE_LST ||
384 (conf.output.outfilename == NULL &&
385 conf.output.tagfilename == NULL &&
386 isatty(STDOUT_FILENO) == 0))
389 if (outst.use_pager &&
390 (conf.output.width == 0 || conf.output.indent == 0) &&
391 ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) != -1 &&
393 if (conf.output.width == 0 && ws.ws_col < 79)
394 conf.output.width = ws.ws_col - 1;
395 if (conf.output.indent == 0 && ws.ws_col < 66)
396 conf.output.indent = 3;
400 if (outst.use_pager == 0)
401 c = pledge("stdio rpath", NULL);
402 else if (conf.output.outfilename != NULL ||
403 conf.output.tagfilename != NULL)
404 c = pledge("stdio rpath wpath cpath", NULL);
406 c = pledge("stdio rpath tmppath tty proc exec", NULL);
408 mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));
409 return mandoc_msg_getrc();
413 /* Parse arguments. */
421 * Quirks for help(1) and man(1),
422 * in particular for a section argument without -s.
425 if (search.argmode == ARG_NAME) {
426 if (*progname == 'h') {
431 } else if (argc > 1 &&
432 ((uc = (unsigned char *)argv[0]) != NULL) &&
433 ((isdigit(uc[0]) && (uc[1] == '\0' ||
435 (uc[0] == 'n' && uc[1] == '\0'))) {
436 search.sec = (char *)uc;
440 if (search.arch == NULL)
441 search.arch = getenv("MACHINE");
443 if (search.arch == NULL)
444 search.arch = MACHINE;
446 if (outmode == OUTMODE_ONE)
447 search.firstmatch = 1;
451 * Use the first argument for -O tag in addition to
452 * using it as a search term for man(1) or apropos(1).
455 if (conf.output.tag != NULL && *conf.output.tag == '\0') {
456 tagarg = argc > 0 && search.argmode == ARG_EXPR ?
457 strchr(*argv, '=') : NULL;
458 conf.output.tag = tagarg == NULL ? *argv : tagarg + 1;
461 if (search.argmode != ARG_FILE ||
462 mandoc_msg_getmin() == MANDOCERR_STYLE)
466 * Use manpath(1) to populate defpaths if -M is not specified.
467 * Don't treat any failures as fatal.
469 if (defpaths == NULL) {
474 if ((fp = popen("/usr/bin/manpath -q", "r")) != NULL) {
475 if ((linelen = getline(&defpaths,
476 &linecap, fp)) > 0) {
477 /* Strip trailing newline */
478 defpaths[linelen - 1] = '\0';
484 /* Read the configuration file. */
485 manconf_parse(&conf, conf_file, defpaths, auxpaths);
491 /* man(1): Resolve each name individually. */
493 if (search.argmode == ARG_NAME) {
495 if (outmode != OUTMODE_FLN)
497 if (conf.manpath.sz == 0) {
498 warnx("The manpath is empty.");
499 mandoc_msg_setrc(MANDOCLEVEL_BADARG);
501 for (i = 0; i + 1 < conf.manpath.sz; i++)
502 printf("%s:", conf.manpath.paths[i]);
503 printf("%s\n", conf.manpath.paths[i]);
506 return (int)mandoc_msg_getrc();
508 for (res = NULL, ressz = 0; argc > 0; argc--, argv++) {
509 (void)mansearch(&search, &conf.manpath,
510 1, argv, &resn, &resnsz);
512 (void)fs_search(&search, &conf.manpath,
513 *argv, &resn, &resnsz);
514 if (resnsz == 0 && strchr(*argv, '/') == NULL) {
515 if (search.arch != NULL &&
516 arch_valid(search.arch, OSENUM) == 0)
517 warnx("Unknown architecture \"%s\".",
519 else if (search.sec != NULL)
520 warnx("No entry for %s in "
521 "section %s of the manual.",
524 warnx("No entry for %s in "
525 "the manual.", *argv);
526 mandoc_msg_setrc(MANDOCLEVEL_BADARG);
530 if (access(*argv, R_OK) == -1) {
531 mandoc_msg_setinfilename(*argv);
532 mandoc_msg(MANDOCERR_BADARG_BAD,
533 0, 0, "%s", strerror(errno));
534 mandoc_msg_setinfilename(NULL);
538 resn = mandoc_calloc(resnsz, sizeof(*res));
539 resn->file = mandoc_strdup(*argv);
540 resn->ipath = SIZE_MAX;
541 resn->form = FORM_SRC;
543 if (outmode != OUTMODE_ONE || resnsz == 1) {
544 res = mandoc_reallocarray(res,
545 ressz + resnsz, sizeof(*res));
546 memcpy(res + ressz, resn,
547 sizeof(*resn) * resnsz);
552 /* Search for the best section. */
555 for (ib = i = 0; i < resnsz; i++) {
557 sec += strcspn(sec, "123456789");
559 continue; /* No section at all. */
560 prio = sec_prios[sec[0] - '1'];
561 if (search.sec != NULL) {
562 ssz = strlen(search.sec);
563 if (strncmp(sec, search.sec, ssz) == 0)
566 sec++; /* Prefer without suffix. */
568 prio += 10; /* Wrong dir name. */
569 if (search.sec != NULL) {
570 ep = strchr(sec, '\0');
572 strncmp(ep - 3, ".gz", 3) == 0)
574 if ((size_t)(ep - sec) < ssz + 3 ||
575 strncmp(ep - ssz, search.sec,
576 ssz) != 0) /* Wrong file */
577 prio += 20; /* extension. */
579 if (prio >= best_prio)
584 res = mandoc_reallocarray(res, ressz + 1,
586 memcpy(res + ressz++, resn + ib, sizeof(*resn));
589 /* apropos(1), whatis(1): Process the full search expression. */
591 } else if (search.argmode != ARG_FILE) {
592 if (mansearch(&search, &conf.manpath,
593 argc, argv, &res, &ressz) == 0)
594 usage(search.argmode);
597 warnx("nothing appropriate");
598 mandoc_msg_setrc(MANDOCLEVEL_BADARG);
602 /* mandoc(1): Take command line arguments as file names. */
605 ressz = argc > 0 ? argc : 1;
606 res = mandoc_calloc(ressz, sizeof(*res));
607 for (i = 0; i < ressz; i++) {
609 res[i].file = mandoc_strdup(argv[i]);
610 res[i].ipath = SIZE_MAX;
611 res[i].form = FORM_SRC;
617 for (i = 0; i < ressz; i++)
621 for (i = 0; i < ressz; i++)
622 printf("%s - %s\n", res[i].names,
623 res[i].output == NULL ? "" :
630 if (search.argmode == ARG_FILE && auxpaths != NULL) {
631 if (strcmp(auxpaths, "doc") == 0)
632 options |= MPARSE_MDOC;
633 else if (strcmp(auxpaths, "an") == 0)
634 options |= MPARSE_MAN;
638 mp = mparse_alloc(options, os_e, os_s);
641 * Remember the original working directory, if possible.
642 * This will be needed if some names on the command line
643 * are page names and some are relative file names.
644 * Do not error out if the current directory is not
645 * readable: Maybe it won't be needed after all.
647 startdir = open(".", O_RDONLY | O_DIRECTORY);
648 for (i = 0; i < ressz; i++) {
649 process_onefile(mp, res + i, startdir, &outst, &conf);
650 if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
653 if (startdir != -1) {
654 (void)fchdir(startdir);
657 if (conf.output.tag != NULL && conf.output.tag_found == 0) {
658 mandoc_msg(MANDOCERR_TAG, 0, 0, "%s", conf.output.tag);
659 conf.output.tag = NULL;
661 if (outst.outdata != NULL) {
662 switch (outst.outtype) {
664 html_free(outst.outdata);
669 ascii_free(outst.outdata);
673 pspdf_free(outst.outdata);
684 mansearch_free(res, ressz);
685 if (search.argmode != ARG_FILE)
688 if (outst.tag_files != NULL) {
689 if (term_tag_close() != -1 &&
690 conf.output.outfilename == NULL &&
691 conf.output.tagfilename == NULL)
692 run_pager(&outst, conf.output.tag);
694 } else if (outst.had_output && outst.outtype != OUTT_LINT)
695 mandoc_msg_summary();
697 return (int)mandoc_msg_getrc();
701 usage(enum argmode argmode)
705 fputs("usage: mandoc [-ac] [-I os=name] "
706 "[-K encoding] [-mdoc | -man] [-O options]\n"
707 "\t [-T output] [-W level] [file ...]\n", stderr);
710 fputs("usage: man [-acfhklw] [-C file] [-M path] "
711 "[-m path] [-S subsection]\n"
712 "\t [[-s] section] name ...\n", stderr);
715 fputs("usage: whatis [-afk] [-C file] "
716 "[-M path] [-m path] [-O outkey] [-S arch]\n"
717 "\t [-s section] name ...\n", stderr);
720 fputs("usage: apropos [-afk] [-C file] "
721 "[-M path] [-m path] [-O outkey] [-S arch]\n"
722 "\t [-s section] expression ...\n", stderr);
725 exit((int)MANDOCLEVEL_BADARG);
729 glob_esc(char **dst, const char *src, const char *suffix)
731 while (*src != '\0') {
732 if (strchr("*?[", *src) != NULL)
736 while (*suffix != '\0')
737 *(*dst)++ = *suffix++;
741 fs_append(char **file, size_t filesz, int copy, size_t ipath,
742 const char *sec, enum form form, struct manpage **res, size_t *ressz)
744 struct manpage *page;
746 *res = mandoc_reallocarray(*res, *ressz + filesz, sizeof(**res));
747 page = *res + *ressz;
750 page->file = copy ? mandoc_strdup(*file) : *file;
753 page->bits = NAME_FILE & NAME_MASK;
755 page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
765 fs_lookup(const struct manpaths *paths, size_t ipath,
766 const char *sec, const char *arch, const char *name,
767 struct manpage **res, size_t *ressz)
771 char *file, *cp, secnum[2];
775 const char *const slman = "/man";
776 const char *const slash = "/";
777 const char *const sglob = ".[01-9]*";
778 const char *const dot = ".";
779 const char *const aster = "*";
781 memset(&globinfo, 0, sizeof(globinfo));
784 mandoc_asprintf(&file, "%s/man%s/%s.%s",
785 paths->paths[ipath], sec, name, sec);
786 if (stat(file, &sb) != -1)
790 mandoc_asprintf(&file, "%s/cat%s/%s.0",
791 paths->paths[ipath], sec, name);
792 if (stat(file, &sb) != -1) {
799 mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
800 paths->paths[ipath], sec, arch, name, sec);
801 if (stat(file, &sb) != -1)
806 cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
807 strlen(slman) + strlen(sec) * 2 + strlen(slash) +
808 strlen(name) * 2 + strlen(sglob) + 1);
809 glob_esc(&cp, paths->paths[ipath], slman);
810 glob_esc(&cp, sec, slash);
811 glob_esc(&cp, name, sglob);
813 globres = glob(file, 0, NULL, &globinfo);
814 if (globres != 0 && globres != GLOB_NOMATCH)
815 mandoc_msg(MANDOCERR_GLOB, 0, 0,
816 "%s: %s", file, strerror(errno));
823 if (sec[1] != '\0' && *ressz == 0) {
826 cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
827 strlen(slman) + strlen(secnum) * 2 + strlen(slash) +
828 strlen(name) * 2 + strlen(dot) +
829 strlen(sec) * 2 + strlen(aster) + 1);
830 glob_esc(&cp, paths->paths[ipath], slman);
831 glob_esc(&cp, secnum, slash);
832 glob_esc(&cp, name, dot);
833 glob_esc(&cp, sec, aster);
835 globres = glob(file, 0, NULL, &globinfo);
836 if (globres != 0 && globres != GLOB_NOMATCH)
837 mandoc_msg(MANDOCERR_GLOB, 0, 0,
838 "%s: %s", file, strerror(errno));
846 if (res != NULL || ipath + 1 != paths->sz)
849 mandoc_asprintf(&file, "%s.%s", name, sec);
850 globres = stat(file, &sb);
855 warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
856 name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
859 else if (file == NULL)
860 fs_append(globinfo.gl_pathv, globinfo.gl_pathc, 1,
861 ipath, sec, form, res, ressz);
863 fs_append(&file, 1, 0, ipath, sec, form, res, ressz);
869 fs_search(const struct mansearch *cfg, const struct manpaths *paths,
870 const char *name, struct manpage **res, size_t *ressz)
872 const char *const sections[] =
873 {"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"};
874 const size_t nsec = sizeof(sections)/sizeof(sections[0]);
878 assert(cfg->argmode == ARG_NAME);
882 for (ipath = 0; ipath < paths->sz; ipath++) {
883 if (cfg->sec != NULL) {
884 if (fs_lookup(paths, ipath, cfg->sec, cfg->arch,
885 name, res, ressz) != -1 && cfg->firstmatch)
888 for (isec = 0; isec < nsec; isec++)
889 if (fs_lookup(paths, ipath, sections[isec],
890 cfg->arch, name, res, ressz) != -1 &&
899 process_onefile(struct mparse *mp, struct manpage *resp, int startdir,
900 struct outstate *outst, struct manconf *conf)
905 * Changing directories is not needed in ARG_FILE mode.
906 * Do it on a best-effort basis. Even in case of
907 * failure, some functionality may still work.
909 if (resp->ipath != SIZE_MAX)
910 (void)chdir(conf->manpath.paths[resp->ipath]);
911 else if (startdir != -1)
912 (void)fchdir(startdir);
914 mandoc_msg_setinfilename(resp->file);
915 if (resp->file != NULL) {
916 if ((fd = mparse_open(mp, resp->file)) == -1) {
917 mandoc_msg(resp->ipath == SIZE_MAX ?
918 MANDOCERR_BADARG_BAD : MANDOCERR_OPEN,
919 0, 0, "%s", strerror(errno));
920 mandoc_msg_setinfilename(NULL);
926 if (outst->use_pager) {
927 outst->use_pager = 0;
928 outst->tag_files = term_tag_init(conf->output.outfilename,
929 outst->outtype == OUTT_HTML ? ".html" : "",
930 conf->output.tagfilename);
932 if ((conf->output.outfilename != NULL ||
933 conf->output.tagfilename != NULL) &&
934 pledge("stdio rpath cpath", NULL) == -1) {
935 mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
936 "%s", strerror(errno));
937 exit(mandoc_msg_getrc());
941 if (outst->had_output && outst->outtype <= OUTT_UTF8) {
942 if (outst->outdata == NULL)
943 outdata_alloc(outst, &conf->output);
944 terminal_sepline(outst->outdata);
947 if (resp->form == FORM_SRC)
948 parse(mp, fd, resp->file, outst, conf);
950 passthrough(fd, conf->output.synopsisonly);
951 outst->had_output = 1;
954 if (ferror(stdout)) {
955 if (outst->tag_files != NULL) {
956 mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s",
957 outst->tag_files->ofn, strerror(errno));
959 outst->tag_files = NULL;
961 mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s",
964 mandoc_msg_setinfilename(NULL);
968 parse(struct mparse *mp, int fd, const char *file,
969 struct outstate *outst, struct manconf *conf)
971 static struct manpaths basepaths;
973 struct roff_meta *meta;
984 mparse_readfd(mp, fd, file);
985 if (fd != STDIN_FILENO)
989 * With -Wstop and warnings or errors of at least the requested
990 * level, do not produce output.
993 if (outst->wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
996 if (outst->outdata == NULL)
997 outdata_alloc(outst, &conf->output);
998 else if (outst->outtype == OUTT_HTML)
999 html_reset(outst->outdata);
1002 meta = mparse_result(mp);
1004 /* Execute the out device, if it exists. */
1006 outst->had_output = 1;
1007 if (meta->macroset == MACROSET_MDOC) {
1008 switch (outst->outtype) {
1010 html_mdoc(outst->outdata, meta);
1013 tree_mdoc(outst->outdata, meta);
1016 man_mdoc(outst->outdata, meta);
1023 terminal_mdoc(outst->outdata, meta);
1026 markdown_mdoc(outst->outdata, meta);
1032 if (meta->macroset == MACROSET_MAN) {
1033 switch (outst->outtype) {
1035 html_man(outst->outdata, meta);
1038 tree_man(outst->outdata, meta);
1048 terminal_man(outst->outdata, meta);
1051 mandoc_msg(MANDOCERR_MAN_TMARKDOWN, 0, 0, NULL);
1057 if (conf->output.tag != NULL && conf->output.tag_found == 0 &&
1058 tag_exists(conf->output.tag))
1059 conf->output.tag_found = 1;
1061 if (mandoc_msg_getmin() < MANDOCERR_STYLE) {
1062 if (basepaths.sz == 0)
1063 manpath_base(&basepaths);
1064 check_xr(&basepaths);
1065 } else if (mandoc_msg_getmin() < MANDOCERR_WARNING)
1066 check_xr(&conf->manpath);
1070 check_xr(struct manpaths *paths)
1072 struct mansearch search;
1073 struct mandoc_xr *xr;
1076 for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) {
1080 search.sec = xr->sec;
1081 search.outkey = NULL;
1082 search.argmode = ARG_NAME;
1083 search.firstmatch = 1;
1084 if (mansearch(&search, paths, 1, &xr->name, NULL, &sz))
1086 if (fs_search(&search, paths, xr->name, NULL, &sz) != -1)
1089 mandoc_msg(MANDOCERR_XR_BAD, xr->line,
1090 xr->pos + 1, "Xr %s %s", xr->name, xr->sec);
1092 mandoc_msg(MANDOCERR_XR_BAD, xr->line,
1093 xr->pos + 1, "Xr %s %s (%d times)",
1094 xr->name, xr->sec, xr->count);
1099 outdata_alloc(struct outstate *outst, struct manoutput *outconf)
1101 switch (outst->outtype) {
1103 outst->outdata = html_alloc(outconf);
1106 outst->outdata = utf8_alloc(outconf);
1109 outst->outdata = locale_alloc(outconf);
1112 outst->outdata = ascii_alloc(outconf);
1115 outst->outdata = pdf_alloc(outconf);
1118 outst->outdata = ps_alloc(outconf);
1126 passthrough(int fd, int synopsis_only)
1128 const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
1129 const char synr[] = "SYNOPSIS";
1134 ssize_t len, written;
1141 if (fflush(stdout) == EOF) {
1142 mandoc_msg(MANDOCERR_FFLUSH, 0, 0, "%s", strerror(errno));
1145 if ((stream = fdopen(fd, "r")) == NULL) {
1147 mandoc_msg(MANDOCERR_FDOPEN, 0, 0, "%s", strerror(errno));
1152 while ((len = getline(&line, &linesz, stream)) != -1) {
1155 if (synopsis_only) {
1157 if ( ! isspace((unsigned char)*cp))
1159 while (isspace((unsigned char)*cp)) {
1164 if (strcmp(cp, synb) == 0 ||
1165 strcmp(cp, synr) == 0)
1170 for (; len > 0; len -= written) {
1171 if ((written = write(STDOUT_FILENO, cp, len)) == -1) {
1172 mandoc_msg(MANDOCERR_WRITE, 0, 0,
1173 "%s", strerror(errno));
1179 mandoc_msg(MANDOCERR_GETLINE, lno, 0, "%s", strerror(errno));
1188 woptions(char *arg, enum mandoc_os *os_e, int *wstop)
1191 const char *toks[11];
1197 toks[4] = "warning";
1201 toks[8] = "openbsd";
1207 switch (getsubopt(&arg, (char * const *)toks, &v)) {
1213 mandoc_msg_setmin(MANDOCERR_BASE);
1216 mandoc_msg_setmin(MANDOCERR_STYLE);
1219 mandoc_msg_setmin(MANDOCERR_WARNING);
1222 mandoc_msg_setmin(MANDOCERR_ERROR);
1225 mandoc_msg_setmin(MANDOCERR_UNSUPP);
1228 mandoc_msg_setmin(MANDOCERR_BADARG);
1231 mandoc_msg_setmin(MANDOCERR_BASE);
1232 *os_e = MANDOC_OS_OPENBSD;
1235 mandoc_msg_setmin(MANDOCERR_BASE);
1236 *os_e = MANDOC_OS_NETBSD;
1239 mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, "-W %s", o);
1247 * Wait until moved to the foreground,
1248 * then fork the pager and wait for the user to close it.
1251 run_pager(struct outstate *outst, char *tag_target)
1254 pid_t man_pgid, tc_pgid;
1255 pid_t pager_pid, wait_pid;
1257 man_pgid = getpgid(0);
1258 outst->tag_files->tcpgid =
1259 man_pgid == getpid() ? getpgid(getppid()) : man_pgid;
1264 /* Stop here until moved to the foreground. */
1266 tc_pgid = tcgetpgrp(STDOUT_FILENO);
1267 if (tc_pgid != man_pgid) {
1268 if (tc_pgid == pager_pid) {
1269 (void)tcsetpgrp(STDOUT_FILENO, man_pgid);
1270 if (signum == SIGTTIN)
1273 outst->tag_files->tcpgid = tc_pgid;
1278 /* Once in the foreground, activate the pager. */
1281 (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
1282 kill(pager_pid, SIGCONT);
1284 pager_pid = spawn_pager(outst, tag_target);
1286 /* Wait for the pager to stop or exit. */
1288 while ((wait_pid = waitpid(pager_pid, &status,
1289 WUNTRACED)) == -1 && errno == EINTR)
1292 if (wait_pid == -1) {
1293 mandoc_msg(MANDOCERR_WAIT, 0, 0,
1294 "%s", strerror(errno));
1297 if (!WIFSTOPPED(status))
1300 signum = WSTOPSIG(status);
1305 spawn_pager(struct outstate *outst, char *tag_target)
1307 const struct timespec timeout = { 0, 100000000 }; /* 0.1s */
1308 #define MAX_PAGER_ARGS 16
1309 char *argv[MAX_PAGER_ARGS];
1318 assert(outst->tag_files->ofd == -1);
1319 assert(outst->tag_files->tfs == NULL);
1321 pager = getenv("MANPAGER");
1322 if (pager == NULL || *pager == '\0')
1323 pager = getenv("PAGER");
1324 if (pager == NULL || *pager == '\0')
1326 cp = mandoc_strdup(pager);
1329 * Parse the pager command into words.
1330 * Intentionally do not do anything fancy here.
1334 while (argc + 5 < MAX_PAGER_ARGS) {
1336 cp = strchr(cp, ' ');
1346 /* For less(1), use the tag file. */
1350 if (*outst->tag_files->tfn != '\0' &&
1351 (cmdlen = strlen(argv[0])) >= 4) {
1352 cp = argv[0] + cmdlen - 4;
1353 if (strcmp(cp, "less") == 0) {
1354 argv[argc++] = mandoc_strdup("-T");
1355 argv[argc++] = outst->tag_files->tfn;
1356 if (tag_target != NULL) {
1357 argv[argc++] = mandoc_strdup("-t");
1358 argv[argc++] = tag_target;
1365 if (outst->outtype == OUTT_HTML && tag_target != NULL)
1366 mandoc_asprintf(&argv[argc], "file://%s#%s",
1367 outst->tag_files->ofn, tag_target);
1369 argv[argc] = outst->tag_files->ofn;
1374 switch (pager_pid = fork()) {
1376 mandoc_msg(MANDOCERR_FORK, 0, 0, "%s", strerror(errno));
1377 exit(mandoc_msg_getrc());
1381 (void)setpgid(pager_pid, 0);
1382 (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
1384 if (pledge("stdio rpath tmppath tty proc", NULL) == -1) {
1385 mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
1386 "%s", strerror(errno));
1387 exit(mandoc_msg_getrc());
1390 outst->tag_files->pager_pid = pager_pid;
1395 * The child process becomes the pager.
1396 * Do not start it before controlling the terminal.
1399 while (tcgetpgrp(STDOUT_FILENO) != getpid())
1400 nanosleep(&timeout, NULL);
1402 execvp(argv[0], argv);
1403 mandoc_msg(MANDOCERR_EXEC, 0, 0, "%s: %s", argv[0], strerror(errno));
1404 _exit(mandoc_msg_getrc());