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;
283 search.arch = optarg;
289 if (strcmp(optarg, "ascii") == 0)
290 outst.outtype = OUTT_ASCII;
291 else if (strcmp(optarg, "lint") == 0) {
292 outst.outtype = OUTT_LINT;
293 mandoc_msg_setoutfile(stdout);
294 mandoc_msg_setmin(MANDOCERR_BASE);
295 } else if (strcmp(optarg, "tree") == 0)
296 outst.outtype = OUTT_TREE;
297 else if (strcmp(optarg, "man") == 0)
298 outst.outtype = OUTT_MAN;
299 else if (strcmp(optarg, "html") == 0)
300 outst.outtype = OUTT_HTML;
301 else if (strcmp(optarg, "markdown") == 0)
302 outst.outtype = OUTT_MARKDOWN;
303 else if (strcmp(optarg, "utf8") == 0)
304 outst.outtype = OUTT_UTF8;
305 else if (strcmp(optarg, "locale") == 0)
306 outst.outtype = OUTT_LOCALE;
307 else if (strcmp(optarg, "ps") == 0)
308 outst.outtype = OUTT_PS;
309 else if (strcmp(optarg, "pdf") == 0)
310 outst.outtype = OUTT_PDF;
312 mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
314 return mandoc_msg_getrc();
318 if (woptions(optarg, &os_e, &outst.wstop) == -1)
319 return mandoc_msg_getrc();
322 outmode = OUTMODE_FLN;
331 usage(search.argmode);
333 /* Postprocess options. */
337 switch (search.argmode) {
339 outmode = OUTMODE_ALL;
343 outmode = OUTMODE_ONE;
346 outmode = OUTMODE_LST;
351 if (search.argmode == ARG_FILE)
352 outmode = OUTMODE_ALL;
362 if (outmode == OUTMODE_LST)
363 search.outkey = oarg;
365 while (oarg != NULL) {
366 if (manconf_output(&conf.output,
367 strsep(&oarg, ","), 0) == -1)
368 return mandoc_msg_getrc();
373 if (outst.outtype != OUTT_TREE || conf.output.noval == 0)
374 options |= MPARSE_VALIDATE;
376 if (outmode == OUTMODE_FLN ||
377 outmode == OUTMODE_LST ||
378 (conf.output.outfilename == NULL &&
379 conf.output.tagfilename == NULL &&
380 isatty(STDOUT_FILENO) == 0))
383 if (outst.use_pager &&
384 (conf.output.width == 0 || conf.output.indent == 0) &&
385 ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) != -1 &&
387 if (conf.output.width == 0 && ws.ws_col < 79)
388 conf.output.width = ws.ws_col - 1;
389 if (conf.output.indent == 0 && ws.ws_col < 66)
390 conf.output.indent = 3;
394 if (outst.use_pager == 0)
395 c = pledge("stdio rpath", NULL);
396 else if (conf.output.outfilename != NULL ||
397 conf.output.tagfilename != NULL)
398 c = pledge("stdio rpath wpath cpath", NULL);
400 c = pledge("stdio rpath tmppath tty proc exec", NULL);
402 mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));
403 return mandoc_msg_getrc();
407 /* Parse arguments. */
415 * Quirks for help(1) and man(1),
416 * in particular for a section argument without -s.
419 if (search.argmode == ARG_NAME) {
420 if (*progname == 'h') {
425 } else if (argc > 1 &&
426 ((uc = (unsigned char *)argv[0]) != NULL) &&
427 ((isdigit(uc[0]) && (uc[1] == '\0' ||
429 (uc[0] == 'n' && uc[1] == '\0'))) {
430 search.sec = (char *)uc;
434 if (search.arch == NULL)
435 search.arch = getenv("MACHINE");
437 if (search.arch == NULL)
438 search.arch = MACHINE;
440 if (outmode == OUTMODE_ONE)
441 search.firstmatch = 1;
445 * Use the first argument for -O tag in addition to
446 * using it as a search term for man(1) or apropos(1).
449 if (conf.output.tag != NULL && *conf.output.tag == '\0') {
450 tagarg = argc > 0 && search.argmode == ARG_EXPR ?
451 strchr(*argv, '=') : NULL;
452 conf.output.tag = tagarg == NULL ? *argv : tagarg + 1;
455 /* Read the configuration file. */
457 if (search.argmode != ARG_FILE ||
458 mandoc_msg_getmin() == MANDOCERR_STYLE)
459 manconf_parse(&conf, conf_file, defpaths, auxpaths);
461 /* man(1): Resolve each name individually. */
463 if (search.argmode == ARG_NAME) {
465 if (outmode != OUTMODE_FLN)
467 if (conf.manpath.sz == 0) {
468 warnx("The manpath is empty.");
469 mandoc_msg_setrc(MANDOCLEVEL_BADARG);
471 for (i = 0; i + 1 < conf.manpath.sz; i++)
472 printf("%s:", conf.manpath.paths[i]);
473 printf("%s\n", conf.manpath.paths[i]);
476 return (int)mandoc_msg_getrc();
478 for (res = NULL, ressz = 0; argc > 0; argc--, argv++) {
479 (void)mansearch(&search, &conf.manpath,
480 1, argv, &resn, &resnsz);
482 (void)fs_search(&search, &conf.manpath,
483 *argv, &resn, &resnsz);
484 if (resnsz == 0 && strchr(*argv, '/') == NULL) {
485 if (search.arch != NULL &&
486 arch_valid(search.arch, OSENUM) == 0)
487 warnx("Unknown architecture \"%s\".",
489 else if (search.sec != NULL)
490 warnx("No entry for %s in "
491 "section %s of the manual.",
494 warnx("No entry for %s in "
495 "the manual.", *argv);
496 mandoc_msg_setrc(MANDOCLEVEL_BADARG);
500 if (access(*argv, R_OK) == -1) {
501 mandoc_msg_setinfilename(*argv);
502 mandoc_msg(MANDOCERR_BADARG_BAD,
503 0, 0, "%s", strerror(errno));
504 mandoc_msg_setinfilename(NULL);
508 resn = mandoc_calloc(resnsz, sizeof(*res));
509 resn->file = mandoc_strdup(*argv);
510 resn->ipath = SIZE_MAX;
511 resn->form = FORM_SRC;
513 if (outmode != OUTMODE_ONE || resnsz == 1) {
514 res = mandoc_reallocarray(res,
515 ressz + resnsz, sizeof(*res));
516 memcpy(res + ressz, resn,
517 sizeof(*resn) * resnsz);
522 /* Search for the best section. */
525 for (ib = i = 0; i < resnsz; i++) {
527 sec += strcspn(sec, "123456789");
529 continue; /* No section at all. */
530 prio = sec_prios[sec[0] - '1'];
531 if (search.sec != NULL) {
532 ssz = strlen(search.sec);
533 if (strncmp(sec, search.sec, ssz) == 0)
536 sec++; /* Prefer without suffix. */
538 prio += 10; /* Wrong dir name. */
539 if (search.sec != NULL) {
540 ep = strchr(sec, '\0');
542 strncmp(ep - 3, ".gz", 3) == 0)
544 if ((size_t)(ep - sec) < ssz + 3 ||
545 strncmp(ep - ssz, search.sec,
546 ssz) != 0) /* Wrong file */
547 prio += 20; /* extension. */
549 if (prio >= best_prio)
554 res = mandoc_reallocarray(res, ressz + 1,
556 memcpy(res + ressz++, resn + ib, sizeof(*resn));
559 /* apropos(1), whatis(1): Process the full search expression. */
561 } else if (search.argmode != ARG_FILE) {
562 if (mansearch(&search, &conf.manpath,
563 argc, argv, &res, &ressz) == 0)
564 usage(search.argmode);
567 warnx("nothing appropriate");
568 mandoc_msg_setrc(MANDOCLEVEL_BADARG);
572 /* mandoc(1): Take command line arguments as file names. */
575 ressz = argc > 0 ? argc : 1;
576 res = mandoc_calloc(ressz, sizeof(*res));
577 for (i = 0; i < ressz; i++) {
579 res[i].file = mandoc_strdup(argv[i]);
580 res[i].ipath = SIZE_MAX;
581 res[i].form = FORM_SRC;
587 for (i = 0; i < ressz; i++)
591 for (i = 0; i < ressz; i++)
592 printf("%s - %s\n", res[i].names,
593 res[i].output == NULL ? "" :
600 if (search.argmode == ARG_FILE && auxpaths != NULL) {
601 if (strcmp(auxpaths, "doc") == 0)
602 options |= MPARSE_MDOC;
603 else if (strcmp(auxpaths, "an") == 0)
604 options |= MPARSE_MAN;
608 mp = mparse_alloc(options, os_e, os_s);
611 * Remember the original working directory, if possible.
612 * This will be needed if some names on the command line
613 * are page names and some are relative file names.
614 * Do not error out if the current directory is not
615 * readable: Maybe it won't be needed after all.
617 startdir = open(".", O_RDONLY | O_DIRECTORY);
618 for (i = 0; i < ressz; i++) {
619 process_onefile(mp, res + i, startdir, &outst, &conf);
620 if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
623 if (startdir != -1) {
624 (void)fchdir(startdir);
627 if (conf.output.tag != NULL && conf.output.tag_found == 0) {
628 mandoc_msg(MANDOCERR_TAG, 0, 0, "%s", conf.output.tag);
629 conf.output.tag = NULL;
631 if (outst.outdata != NULL) {
632 switch (outst.outtype) {
634 html_free(outst.outdata);
639 ascii_free(outst.outdata);
643 pspdf_free(outst.outdata);
654 mansearch_free(res, ressz);
655 if (search.argmode != ARG_FILE)
658 if (outst.tag_files != NULL) {
659 if (term_tag_close() != -1 &&
660 conf.output.outfilename == NULL &&
661 conf.output.tagfilename == NULL)
662 run_pager(&outst, conf.output.tag);
664 } else if (outst.had_output && outst.outtype != OUTT_LINT)
665 mandoc_msg_summary();
667 return (int)mandoc_msg_getrc();
671 usage(enum argmode argmode)
675 fputs("usage: mandoc [-ac] [-I os=name] "
676 "[-K encoding] [-mdoc | -man] [-O options]\n"
677 "\t [-T output] [-W level] [file ...]\n", stderr);
680 fputs("usage: man [-acfhklw] [-C file] [-M path] "
681 "[-m path] [-S subsection]\n"
682 "\t [[-s] section] name ...\n", stderr);
685 fputs("usage: whatis [-afk] [-C file] "
686 "[-M path] [-m path] [-O outkey] [-S arch]\n"
687 "\t [-s section] name ...\n", stderr);
690 fputs("usage: apropos [-afk] [-C file] "
691 "[-M path] [-m path] [-O outkey] [-S arch]\n"
692 "\t [-s section] expression ...\n", stderr);
695 exit((int)MANDOCLEVEL_BADARG);
699 glob_esc(char **dst, const char *src, const char *suffix)
701 while (*src != '\0') {
702 if (strchr("*?[", *src) != NULL)
706 while (*suffix != '\0')
707 *(*dst)++ = *suffix++;
711 fs_append(char **file, size_t filesz, int copy, size_t ipath,
712 const char *sec, enum form form, struct manpage **res, size_t *ressz)
714 struct manpage *page;
716 *res = mandoc_reallocarray(*res, *ressz + filesz, sizeof(**res));
717 page = *res + *ressz;
720 page->file = copy ? mandoc_strdup(*file) : *file;
723 page->bits = NAME_FILE & NAME_MASK;
725 page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
735 fs_lookup(const struct manpaths *paths, size_t ipath,
736 const char *sec, const char *arch, const char *name,
737 struct manpage **res, size_t *ressz)
741 char *file, *cp, secnum[2];
745 const char *const slman = "/man";
746 const char *const slash = "/";
747 const char *const sglob = ".[01-9]*";
748 const char *const dot = ".";
749 const char *const aster = "*";
751 memset(&globinfo, 0, sizeof(globinfo));
754 mandoc_asprintf(&file, "%s/man%s/%s.%s",
755 paths->paths[ipath], sec, name, sec);
756 if (stat(file, &sb) != -1)
760 mandoc_asprintf(&file, "%s/cat%s/%s.0",
761 paths->paths[ipath], sec, name);
762 if (stat(file, &sb) != -1) {
769 mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
770 paths->paths[ipath], sec, arch, name, sec);
771 if (stat(file, &sb) != -1)
776 cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
777 strlen(slman) + strlen(sec) * 2 + strlen(slash) +
778 strlen(name) * 2 + strlen(sglob) + 1);
779 glob_esc(&cp, paths->paths[ipath], slman);
780 glob_esc(&cp, sec, slash);
781 glob_esc(&cp, name, sglob);
783 globres = glob(file, 0, NULL, &globinfo);
784 if (globres != 0 && globres != GLOB_NOMATCH)
785 mandoc_msg(MANDOCERR_GLOB, 0, 0,
786 "%s: %s", file, strerror(errno));
793 if (sec[1] != '\0' && *ressz == 0) {
796 cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
797 strlen(slman) + strlen(secnum) * 2 + strlen(slash) +
798 strlen(name) * 2 + strlen(dot) +
799 strlen(sec) * 2 + strlen(aster) + 1);
800 glob_esc(&cp, paths->paths[ipath], slman);
801 glob_esc(&cp, secnum, slash);
802 glob_esc(&cp, name, dot);
803 glob_esc(&cp, sec, aster);
805 globres = glob(file, 0, NULL, &globinfo);
806 if (globres != 0 && globres != GLOB_NOMATCH)
807 mandoc_msg(MANDOCERR_GLOB, 0, 0,
808 "%s: %s", file, strerror(errno));
816 if (res != NULL || ipath + 1 != paths->sz)
819 mandoc_asprintf(&file, "%s.%s", name, sec);
820 globres = stat(file, &sb);
825 warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
826 name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
829 else if (file == NULL)
830 fs_append(globinfo.gl_pathv, globinfo.gl_pathc, 1,
831 ipath, sec, form, res, ressz);
833 fs_append(&file, 1, 0, ipath, sec, form, res, ressz);
839 fs_search(const struct mansearch *cfg, const struct manpaths *paths,
840 const char *name, struct manpage **res, size_t *ressz)
842 const char *const sections[] =
843 {"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"};
844 const size_t nsec = sizeof(sections)/sizeof(sections[0]);
848 assert(cfg->argmode == ARG_NAME);
852 for (ipath = 0; ipath < paths->sz; ipath++) {
853 if (cfg->sec != NULL) {
854 if (fs_lookup(paths, ipath, cfg->sec, cfg->arch,
855 name, res, ressz) != -1 && cfg->firstmatch)
858 for (isec = 0; isec < nsec; isec++)
859 if (fs_lookup(paths, ipath, sections[isec],
860 cfg->arch, name, res, ressz) != -1 &&
869 process_onefile(struct mparse *mp, struct manpage *resp, int startdir,
870 struct outstate *outst, struct manconf *conf)
875 * Changing directories is not needed in ARG_FILE mode.
876 * Do it on a best-effort basis. Even in case of
877 * failure, some functionality may still work.
879 if (resp->ipath != SIZE_MAX)
880 (void)chdir(conf->manpath.paths[resp->ipath]);
881 else if (startdir != -1)
882 (void)fchdir(startdir);
884 mandoc_msg_setinfilename(resp->file);
885 if (resp->file != NULL) {
886 if ((fd = mparse_open(mp, resp->file)) == -1) {
887 mandoc_msg(resp->ipath == SIZE_MAX ?
888 MANDOCERR_BADARG_BAD : MANDOCERR_OPEN,
889 0, 0, "%s", strerror(errno));
890 mandoc_msg_setinfilename(NULL);
896 if (outst->use_pager) {
897 outst->use_pager = 0;
898 outst->tag_files = term_tag_init(conf->output.outfilename,
899 outst->outtype == OUTT_HTML ? ".html" : "",
900 conf->output.tagfilename);
902 if ((conf->output.outfilename != NULL ||
903 conf->output.tagfilename != NULL) &&
904 pledge("stdio rpath cpath", NULL) == -1) {
905 mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
906 "%s", strerror(errno));
907 exit(mandoc_msg_getrc());
911 if (outst->had_output && outst->outtype <= OUTT_UTF8) {
912 if (outst->outdata == NULL)
913 outdata_alloc(outst, &conf->output);
914 terminal_sepline(outst->outdata);
917 if (resp->form == FORM_SRC)
918 parse(mp, fd, resp->file, outst, conf);
920 passthrough(fd, conf->output.synopsisonly);
921 outst->had_output = 1;
924 if (ferror(stdout)) {
925 if (outst->tag_files != NULL) {
926 mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s",
927 outst->tag_files->ofn, strerror(errno));
929 outst->tag_files = NULL;
931 mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s",
934 mandoc_msg_setinfilename(NULL);
938 parse(struct mparse *mp, int fd, const char *file,
939 struct outstate *outst, struct manconf *conf)
941 static struct manpaths basepaths;
943 struct roff_meta *meta;
954 mparse_readfd(mp, fd, file);
955 if (fd != STDIN_FILENO)
959 * With -Wstop and warnings or errors of at least the requested
960 * level, do not produce output.
963 if (outst->wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
966 if (outst->outdata == NULL)
967 outdata_alloc(outst, &conf->output);
968 else if (outst->outtype == OUTT_HTML)
969 html_reset(outst->outdata);
972 meta = mparse_result(mp);
974 /* Execute the out device, if it exists. */
976 outst->had_output = 1;
977 if (meta->macroset == MACROSET_MDOC) {
978 switch (outst->outtype) {
980 html_mdoc(outst->outdata, meta);
983 tree_mdoc(outst->outdata, meta);
986 man_mdoc(outst->outdata, meta);
993 terminal_mdoc(outst->outdata, meta);
996 markdown_mdoc(outst->outdata, meta);
1002 if (meta->macroset == MACROSET_MAN) {
1003 switch (outst->outtype) {
1005 html_man(outst->outdata, meta);
1008 tree_man(outst->outdata, meta);
1018 terminal_man(outst->outdata, meta);
1021 mandoc_msg(MANDOCERR_MAN_TMARKDOWN, 0, 0, NULL);
1027 if (conf->output.tag != NULL && conf->output.tag_found == 0 &&
1028 tag_exists(conf->output.tag))
1029 conf->output.tag_found = 1;
1031 if (mandoc_msg_getmin() < MANDOCERR_STYLE) {
1032 if (basepaths.sz == 0)
1033 manpath_base(&basepaths);
1034 check_xr(&basepaths);
1035 } else if (mandoc_msg_getmin() < MANDOCERR_WARNING)
1036 check_xr(&conf->manpath);
1040 check_xr(struct manpaths *paths)
1042 struct mansearch search;
1043 struct mandoc_xr *xr;
1046 for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) {
1050 search.sec = xr->sec;
1051 search.outkey = NULL;
1052 search.argmode = ARG_NAME;
1053 search.firstmatch = 1;
1054 if (mansearch(&search, paths, 1, &xr->name, NULL, &sz))
1056 if (fs_search(&search, paths, xr->name, NULL, &sz) != -1)
1059 mandoc_msg(MANDOCERR_XR_BAD, xr->line,
1060 xr->pos + 1, "Xr %s %s", xr->name, xr->sec);
1062 mandoc_msg(MANDOCERR_XR_BAD, xr->line,
1063 xr->pos + 1, "Xr %s %s (%d times)",
1064 xr->name, xr->sec, xr->count);
1069 outdata_alloc(struct outstate *outst, struct manoutput *outconf)
1071 switch (outst->outtype) {
1073 outst->outdata = html_alloc(outconf);
1076 outst->outdata = utf8_alloc(outconf);
1079 outst->outdata = locale_alloc(outconf);
1082 outst->outdata = ascii_alloc(outconf);
1085 outst->outdata = pdf_alloc(outconf);
1088 outst->outdata = ps_alloc(outconf);
1096 passthrough(int fd, int synopsis_only)
1098 const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
1099 const char synr[] = "SYNOPSIS";
1104 ssize_t len, written;
1111 if (fflush(stdout) == EOF) {
1112 mandoc_msg(MANDOCERR_FFLUSH, 0, 0, "%s", strerror(errno));
1115 if ((stream = fdopen(fd, "r")) == NULL) {
1117 mandoc_msg(MANDOCERR_FDOPEN, 0, 0, "%s", strerror(errno));
1122 while ((len = getline(&line, &linesz, stream)) != -1) {
1125 if (synopsis_only) {
1127 if ( ! isspace((unsigned char)*cp))
1129 while (isspace((unsigned char)*cp)) {
1134 if (strcmp(cp, synb) == 0 ||
1135 strcmp(cp, synr) == 0)
1140 for (; len > 0; len -= written) {
1141 if ((written = write(STDOUT_FILENO, cp, len)) == -1) {
1142 mandoc_msg(MANDOCERR_WRITE, 0, 0,
1143 "%s", strerror(errno));
1149 mandoc_msg(MANDOCERR_GETLINE, lno, 0, "%s", strerror(errno));
1158 woptions(char *arg, enum mandoc_os *os_e, int *wstop)
1161 const char *toks[11];
1167 toks[4] = "warning";
1171 toks[8] = "openbsd";
1177 switch (getsubopt(&arg, (char * const *)toks, &v)) {
1183 mandoc_msg_setmin(MANDOCERR_BASE);
1186 mandoc_msg_setmin(MANDOCERR_STYLE);
1189 mandoc_msg_setmin(MANDOCERR_WARNING);
1192 mandoc_msg_setmin(MANDOCERR_ERROR);
1195 mandoc_msg_setmin(MANDOCERR_UNSUPP);
1198 mandoc_msg_setmin(MANDOCERR_BADARG);
1201 mandoc_msg_setmin(MANDOCERR_BASE);
1202 *os_e = MANDOC_OS_OPENBSD;
1205 mandoc_msg_setmin(MANDOCERR_BASE);
1206 *os_e = MANDOC_OS_NETBSD;
1209 mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, "-W %s", o);
1217 * Wait until moved to the foreground,
1218 * then fork the pager and wait for the user to close it.
1221 run_pager(struct outstate *outst, char *tag_target)
1224 pid_t man_pgid, tc_pgid;
1225 pid_t pager_pid, wait_pid;
1227 man_pgid = getpgid(0);
1228 outst->tag_files->tcpgid =
1229 man_pgid == getpid() ? getpgid(getppid()) : man_pgid;
1234 /* Stop here until moved to the foreground. */
1236 tc_pgid = tcgetpgrp(STDOUT_FILENO);
1237 if (tc_pgid != man_pgid) {
1238 if (tc_pgid == pager_pid) {
1239 (void)tcsetpgrp(STDOUT_FILENO, man_pgid);
1240 if (signum == SIGTTIN)
1243 outst->tag_files->tcpgid = tc_pgid;
1248 /* Once in the foreground, activate the pager. */
1251 (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
1252 kill(pager_pid, SIGCONT);
1254 pager_pid = spawn_pager(outst, tag_target);
1256 /* Wait for the pager to stop or exit. */
1258 while ((wait_pid = waitpid(pager_pid, &status,
1259 WUNTRACED)) == -1 && errno == EINTR)
1262 if (wait_pid == -1) {
1263 mandoc_msg(MANDOCERR_WAIT, 0, 0,
1264 "%s", strerror(errno));
1267 if (!WIFSTOPPED(status))
1270 signum = WSTOPSIG(status);
1275 spawn_pager(struct outstate *outst, char *tag_target)
1277 const struct timespec timeout = { 0, 100000000 }; /* 0.1s */
1278 #define MAX_PAGER_ARGS 16
1279 char *argv[MAX_PAGER_ARGS];
1288 assert(outst->tag_files->ofd == -1);
1289 assert(outst->tag_files->tfs == NULL);
1291 pager = getenv("MANPAGER");
1292 if (pager == NULL || *pager == '\0')
1293 pager = getenv("PAGER");
1294 if (pager == NULL || *pager == '\0')
1296 cp = mandoc_strdup(pager);
1299 * Parse the pager command into words.
1300 * Intentionally do not do anything fancy here.
1304 while (argc + 5 < MAX_PAGER_ARGS) {
1306 cp = strchr(cp, ' ');
1316 /* For less(1), use the tag file. */
1320 if (*outst->tag_files->tfn != '\0' &&
1321 (cmdlen = strlen(argv[0])) >= 4) {
1322 cp = argv[0] + cmdlen - 4;
1323 if (strcmp(cp, "less") == 0) {
1324 argv[argc++] = mandoc_strdup("-T");
1325 argv[argc++] = outst->tag_files->tfn;
1326 if (tag_target != NULL) {
1327 argv[argc++] = mandoc_strdup("-t");
1328 argv[argc++] = tag_target;
1335 if (outst->outtype == OUTT_HTML && tag_target != NULL)
1336 mandoc_asprintf(&argv[argc], "file://%s#%s",
1337 outst->tag_files->ofn, tag_target);
1339 argv[argc] = outst->tag_files->ofn;
1344 switch (pager_pid = fork()) {
1346 mandoc_msg(MANDOCERR_FORK, 0, 0, "%s", strerror(errno));
1347 exit(mandoc_msg_getrc());
1351 (void)setpgid(pager_pid, 0);
1352 (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
1354 if (pledge("stdio rpath tmppath tty proc", NULL) == -1) {
1355 mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
1356 "%s", strerror(errno));
1357 exit(mandoc_msg_getrc());
1360 outst->tag_files->pager_pid = pager_pid;
1365 * The child process becomes the pager.
1366 * Do not start it before controlling the terminal.
1369 while (tcgetpgrp(STDOUT_FILENO) != getpid())
1370 nanosleep(&timeout, NULL);
1372 execvp(argv[0], argv);
1373 mandoc_msg(MANDOCERR_EXEC, 0, 0, "%s: %s", argv[0], strerror(errno));
1374 _exit(mandoc_msg_getrc());