Annotation of src/usr.bin/mandoc/main.c, Revision 1.253
1.253 ! schwarze 1: /* $OpenBSD: main.c,v 1.252 2020/06/11 16:12:14 otto Exp $ */
1.1 kristaps 2: /*
1.248 schwarze 3: * Copyright (c) 2010-2012, 2014-2020 Ingo Schwarze <schwarze@openbsd.org>
1.95 schwarze 4: * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.86 schwarze 5: * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
1.1 kristaps 6: *
7: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 8: * purpose with or without fee is hereby granted, provided that the above
9: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 10: *
1.134 schwarze 11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.2 schwarze 12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.134 schwarze 13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.2 schwarze 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.
1.248 schwarze 18: *
19: * Main program for mandoc(1), man(1), apropos(1), whatis(1), and help(1).
1.1 kristaps 20: */
1.95 schwarze 21: #include <sys/types.h>
1.207 schwarze 22: #include <sys/ioctl.h>
1.122 schwarze 23: #include <sys/param.h> /* MACHINE */
1.228 schwarze 24: #include <sys/stat.h>
1.129 schwarze 25: #include <sys/wait.h>
1.95 schwarze 26:
1.1 kristaps 27: #include <assert.h>
1.95 schwarze 28: #include <ctype.h>
1.152 schwarze 29: #include <err.h>
1.165 schwarze 30: #include <errno.h>
1.95 schwarze 31: #include <fcntl.h>
1.127 schwarze 32: #include <glob.h>
1.244 schwarze 33: #include <limits.h>
1.131 schwarze 34: #include <signal.h>
1.1 kristaps 35: #include <stdio.h>
1.17 schwarze 36: #include <stdint.h>
1.1 kristaps 37: #include <stdlib.h>
38: #include <string.h>
1.224 schwarze 39: #include <termios.h>
1.172 schwarze 40: #include <time.h>
1.1 kristaps 41: #include <unistd.h>
42:
1.136 schwarze 43: #include "mandoc_aux.h"
1.30 schwarze 44: #include "mandoc.h"
1.197 schwarze 45: #include "mandoc_xr.h"
1.136 schwarze 46: #include "roff.h"
1.1 kristaps 47: #include "mdoc.h"
48: #include "man.h"
1.214 schwarze 49: #include "mandoc_parse.h"
1.251 schwarze 50: #include "tag.h"
1.248 schwarze 51: #include "term_tag.h"
1.136 schwarze 52: #include "main.h"
1.134 schwarze 53: #include "manconf.h"
1.95 schwarze 54: #include "mansearch.h"
55:
1.235 schwarze 56: #define BINM_APROPOS "apropos"
57: #define BINM_MAN "man"
58: #define BINM_MAKEWHATIS "makewhatis"
59: #define BINM_WHATIS "whatis"
60: #define OSENUM MANDOC_OS_OPENBSD
61:
1.95 schwarze 62: enum outmode {
63: OUTMODE_DEF = 0,
64: OUTMODE_FLN,
65: OUTMODE_LST,
66: OUTMODE_ALL,
67: OUTMODE_ONE
68: };
1.1 kristaps 69:
70: enum outt {
1.76 schwarze 71: OUTT_ASCII = 0, /* -Tascii */
1.77 schwarze 72: OUTT_LOCALE, /* -Tlocale */
73: OUTT_UTF8, /* -Tutf8 */
1.76 schwarze 74: OUTT_TREE, /* -Ttree */
1.78 schwarze 75: OUTT_MAN, /* -Tman */
1.76 schwarze 76: OUTT_HTML, /* -Thtml */
1.188 schwarze 77: OUTT_MARKDOWN, /* -Tmarkdown */
1.76 schwarze 78: OUTT_LINT, /* -Tlint */
79: OUTT_PS, /* -Tps */
80: OUTT_PDF /* -Tpdf */
1.1 kristaps 81: };
82:
1.238 schwarze 83: struct outstate {
1.239 schwarze 84: struct tag_files *tag_files; /* Tagging state variables. */
1.196 schwarze 85: void *outdata; /* data for output */
1.239 schwarze 86: int use_pager;
1.75 schwarze 87: int wstop; /* stop after a file with a warning */
1.240 schwarze 88: int had_output; /* Some output was generated. */
1.90 schwarze 89: enum outt outtype; /* which output to use */
1.33 schwarze 90: };
1.174 schwarze 91:
92:
93: int mandocdb(int, char *[]);
1.33 schwarze 94:
1.215 schwarze 95: static void check_xr(void);
1.119 schwarze 96: static int fs_lookup(const struct manpaths *,
97: size_t ipath, const char *,
98: const char *, const char *,
99: struct manpage **, size_t *);
1.198 schwarze 100: static int fs_search(const struct mansearch *,
1.243 schwarze 101: const struct manpaths *, const char *,
1.119 schwarze 102: struct manpage **, size_t *);
1.247 schwarze 103: static void glob_esc(char **, const char *, const char *);
1.238 schwarze 104: static void outdata_alloc(struct outstate *, struct manoutput *);
1.237 schwarze 105: static void parse(struct mparse *, int, const char *,
1.238 schwarze 106: struct outstate *, struct manoutput *);
1.231 schwarze 107: static void passthrough(int, int);
1.240 schwarze 108: static void process_onefile(struct mparse *, struct manpage *,
109: int, struct outstate *, struct manconf *);
1.253 ! schwarze 110: static void run_pager(struct outstate *, char *);
! 111: static pid_t spawn_pager(struct outstate *, char *);
1.184 schwarze 112: static void usage(enum argmode) __attribute__((__noreturn__));
1.237 schwarze 113: static int woptions(char *, enum mandoc_os *, int *);
1.1 kristaps 114:
1.95 schwarze 115: static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
1.110 schwarze 116: static char help_arg[] = "help";
117: static char *help_argv[] = {help_arg, NULL};
1.1 kristaps 118:
1.90 schwarze 119:
1.1 kristaps 120: int
121: main(int argc, char *argv[])
122: {
1.237 schwarze 123: struct manconf conf; /* Manpaths and output options. */
1.238 schwarze 124: struct outstate outst; /* Output state. */
1.237 schwarze 125: struct winsize ws; /* Result of ioctl(TIOCGWINSZ). */
126: struct mansearch search; /* Search options. */
1.241 schwarze 127: struct manpage *res; /* Complete list of search results. */
128: struct manpage *resn; /* Search results for one name. */
1.237 schwarze 129: struct mparse *mp; /* Opaque parser object. */
130: const char *conf_file; /* -C: alternate config file. */
131: const char *os_s; /* -I: Operating system for display. */
1.240 schwarze 132: const char *progname, *sec;
1.237 schwarze 133: char *defpaths; /* -M: override manpaths. */
134: char *auxpaths; /* -m: additional manpaths. */
135: char *oarg; /* -O: output option string. */
136: char *tagarg; /* -O tag: default value. */
1.113 schwarze 137: unsigned char *uc;
1.241 schwarze 138: size_t ressz; /* Number of elements in res[]. */
139: size_t resnsz; /* Number of elements in resn[]. */
140: size_t i, ib, ssz;
1.237 schwarze 141: int options; /* Parser options. */
142: int show_usage; /* Invalid argument: give up. */
1.135 schwarze 143: int prio, best_prio;
1.240 schwarze 144: int startdir;
1.95 schwarze 145: int c;
1.237 schwarze 146: enum mandoc_os os_e; /* Check base system conventions. */
147: enum outmode outmode; /* According to command line. */
1.1 kristaps 148:
1.162 schwarze 149: progname = getprogname();
1.220 schwarze 150: mandoc_msg_setoutfile(stderr);
1.162 schwarze 151: if (strncmp(progname, "mandocdb", 8) == 0 ||
1.235 schwarze 152: strcmp(progname, BINM_MAKEWHATIS) == 0)
1.150 schwarze 153: return mandocdb(argc, argv);
1.19 schwarze 154:
1.231 schwarze 155: if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1) {
156: mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));
157: return mandoc_msg_getrc();
158: }
1.154 schwarze 159:
1.95 schwarze 160: /* Search options. */
161:
1.134 schwarze 162: memset(&conf, 0, sizeof(conf));
1.237 schwarze 163: conf_file = NULL;
164: defpaths = auxpaths = NULL;
1.95 schwarze 165:
166: memset(&search, 0, sizeof(struct mansearch));
167: search.outkey = "Nd";
1.186 schwarze 168: oarg = NULL;
1.95 schwarze 169:
1.235 schwarze 170: if (strcmp(progname, BINM_MAN) == 0)
1.95 schwarze 171: search.argmode = ARG_NAME;
1.235 schwarze 172: else if (strcmp(progname, BINM_APROPOS) == 0)
1.95 schwarze 173: search.argmode = ARG_EXPR;
1.235 schwarze 174: else if (strcmp(progname, BINM_WHATIS) == 0)
1.95 schwarze 175: search.argmode = ARG_WORD;
1.162 schwarze 176: else if (strncmp(progname, "help", 4) == 0)
1.110 schwarze 177: search.argmode = ARG_NAME;
1.95 schwarze 178: else
179: search.argmode = ARG_FILE;
180:
1.238 schwarze 181: /* Parser options. */
1.95 schwarze 182:
1.238 schwarze 183: options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.237 schwarze 184: os_e = MANDOC_OS_OTHER;
185: os_s = NULL;
1.238 schwarze 186:
187: /* Formatter options. */
188:
189: memset(&outst, 0, sizeof(outst));
1.239 schwarze 190: outst.tag_files = NULL;
1.238 schwarze 191: outst.outtype = OUTT_LOCALE;
1.239 schwarze 192: outst.use_pager = 1;
1.1 kristaps 193:
1.95 schwarze 194: show_usage = 0;
195: outmode = OUTMODE_DEF;
196:
1.192 schwarze 197: while ((c = getopt(argc, argv,
198: "aC:cfhI:iK:klM:m:O:S:s:T:VW:w")) != -1) {
199: if (c == 'i' && search.argmode == ARG_EXPR) {
200: optind--;
201: break;
202: }
1.1 kristaps 203: switch (c) {
1.95 schwarze 204: case 'a':
205: outmode = OUTMODE_ALL;
206: break;
207: case 'C':
208: conf_file = optarg;
209: break;
210: case 'c':
1.239 schwarze 211: outst.use_pager = 0;
1.95 schwarze 212: break;
213: case 'f':
214: search.argmode = ARG_WORD;
215: break;
1.98 schwarze 216: case 'h':
1.135 schwarze 217: conf.output.synopsisonly = 1;
1.239 schwarze 218: outst.use_pager = 0;
1.98 schwarze 219: outmode = OUTMODE_ALL;
220: break;
1.90 schwarze 221: case 'I':
1.231 schwarze 222: if (strncmp(optarg, "os=", 3) != 0) {
223: mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
224: "-I %s", optarg);
225: return mandoc_msg_getrc();
1.83 schwarze 226: }
1.237 schwarze 227: if (os_s != NULL) {
1.231 schwarze 228: mandoc_msg(MANDOCERR_BADARG_DUPE, 0, 0,
229: "-I %s", optarg);
230: return mandoc_msg_getrc();
1.83 schwarze 231: }
1.237 schwarze 232: os_s = optarg + 3;
1.95 schwarze 233: break;
1.103 schwarze 234: case 'K':
1.231 schwarze 235: options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
236: if (strcmp(optarg, "utf-8") == 0)
237: options |= MPARSE_UTF8;
238: else if (strcmp(optarg, "iso-8859-1") == 0)
239: options |= MPARSE_LATIN1;
240: else if (strcmp(optarg, "us-ascii") != 0) {
241: mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
242: "-K %s", optarg);
243: return mandoc_msg_getrc();
244: }
1.103 schwarze 245: break;
1.95 schwarze 246: case 'k':
247: search.argmode = ARG_EXPR;
248: break;
1.96 schwarze 249: case 'l':
250: search.argmode = ARG_FILE;
251: outmode = OUTMODE_ALL;
252: break;
1.95 schwarze 253: case 'M':
254: defpaths = optarg;
255: break;
1.90 schwarze 256: case 'm':
1.95 schwarze 257: auxpaths = optarg;
1.1 kristaps 258: break;
1.90 schwarze 259: case 'O':
1.186 schwarze 260: oarg = optarg;
1.17 schwarze 261: break;
1.95 schwarze 262: case 'S':
263: search.arch = optarg;
264: break;
265: case 's':
266: search.sec = optarg;
267: break;
1.90 schwarze 268: case 'T':
1.231 schwarze 269: if (strcmp(optarg, "ascii") == 0)
1.238 schwarze 270: outst.outtype = OUTT_ASCII;
1.231 schwarze 271: else if (strcmp(optarg, "lint") == 0) {
1.238 schwarze 272: outst.outtype = OUTT_LINT;
1.231 schwarze 273: mandoc_msg_setoutfile(stdout);
274: mandoc_msg_setmin(MANDOCERR_BASE);
275: } else if (strcmp(optarg, "tree") == 0)
1.238 schwarze 276: outst.outtype = OUTT_TREE;
1.231 schwarze 277: else if (strcmp(optarg, "man") == 0)
1.238 schwarze 278: outst.outtype = OUTT_MAN;
1.231 schwarze 279: else if (strcmp(optarg, "html") == 0)
1.238 schwarze 280: outst.outtype = OUTT_HTML;
1.231 schwarze 281: else if (strcmp(optarg, "markdown") == 0)
1.238 schwarze 282: outst.outtype = OUTT_MARKDOWN;
1.231 schwarze 283: else if (strcmp(optarg, "utf8") == 0)
1.238 schwarze 284: outst.outtype = OUTT_UTF8;
1.231 schwarze 285: else if (strcmp(optarg, "locale") == 0)
1.238 schwarze 286: outst.outtype = OUTT_LOCALE;
1.231 schwarze 287: else if (strcmp(optarg, "ps") == 0)
1.238 schwarze 288: outst.outtype = OUTT_PS;
1.231 schwarze 289: else if (strcmp(optarg, "pdf") == 0)
1.238 schwarze 290: outst.outtype = OUTT_PDF;
1.231 schwarze 291: else {
292: mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
293: "-T %s", optarg);
294: return mandoc_msg_getrc();
295: }
1.1 kristaps 296: break;
1.90 schwarze 297: case 'W':
1.238 schwarze 298: if (woptions(optarg, &os_e, &outst.wstop) == -1)
1.231 schwarze 299: return mandoc_msg_getrc();
1.1 kristaps 300: break;
1.95 schwarze 301: case 'w':
302: outmode = OUTMODE_FLN;
303: break;
1.1 kristaps 304: default:
1.95 schwarze 305: show_usage = 1;
306: break;
307: }
308: }
309:
310: if (show_usage)
311: usage(search.argmode);
312:
313: /* Postprocess options. */
314:
1.245 schwarze 315: switch (outmode) {
316: case OUTMODE_DEF:
1.95 schwarze 317: switch (search.argmode) {
318: case ARG_FILE:
319: outmode = OUTMODE_ALL;
1.239 schwarze 320: outst.use_pager = 0;
1.95 schwarze 321: break;
322: case ARG_NAME:
323: outmode = OUTMODE_ONE;
324: break;
325: default:
326: outmode = OUTMODE_LST;
327: break;
1.186 schwarze 328: }
1.245 schwarze 329: break;
330: case OUTMODE_FLN:
331: if (search.argmode == ARG_FILE)
332: outmode = OUTMODE_ALL;
333: break;
334: case OUTMODE_ALL:
335: break;
336: case OUTMODE_LST:
337: case OUTMODE_ONE:
338: abort();
1.186 schwarze 339: }
340:
341: if (oarg != NULL) {
342: if (outmode == OUTMODE_LST)
343: search.outkey = oarg;
344: else {
345: while (oarg != NULL) {
346: if (manconf_output(&conf.output,
1.229 schwarze 347: strsep(&oarg, ","), 0) == -1)
1.231 schwarze 348: return mandoc_msg_getrc();
1.186 schwarze 349: }
1.95 schwarze 350: }
351: }
352:
1.238 schwarze 353: if (outst.outtype != OUTT_TREE || conf.output.noval == 0)
1.218 schwarze 354: options |= MPARSE_VALIDATE;
355:
1.151 schwarze 356: if (outmode == OUTMODE_FLN ||
357: outmode == OUTMODE_LST ||
358: !isatty(STDOUT_FILENO))
1.239 schwarze 359: outst.use_pager = 0;
1.207 schwarze 360:
1.239 schwarze 361: if (outst.use_pager &&
1.207 schwarze 362: (conf.output.width == 0 || conf.output.indent == 0) &&
1.209 schwarze 363: ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) != -1 &&
364: ws.ws_col > 1) {
1.207 schwarze 365: if (conf.output.width == 0 && ws.ws_col < 79)
366: conf.output.width = ws.ws_col - 1;
367: if (conf.output.indent == 0 && ws.ws_col < 66)
368: conf.output.indent = 3;
369: }
1.151 schwarze 370:
1.239 schwarze 371: if (outst.use_pager == 0) {
1.231 schwarze 372: if (pledge("stdio rpath", NULL) == -1) {
373: mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
374: "%s", strerror(errno));
375: return mandoc_msg_getrc();
376: }
377: }
1.154 schwarze 378:
1.95 schwarze 379: /* Parse arguments. */
380:
1.124 schwarze 381: if (argc > 0) {
382: argc -= optind;
383: argv += optind;
384: }
1.95 schwarze 385:
1.110 schwarze 386: /*
1.241 schwarze 387: * Quirks for help(1) and man(1),
388: * in particular for a section argument without -s.
1.110 schwarze 389: */
390:
391: if (search.argmode == ARG_NAME) {
1.162 schwarze 392: if (*progname == 'h') {
1.110 schwarze 393: if (argc == 0) {
394: argv = help_argv;
395: argc = 1;
396: }
1.117 schwarze 397: } else if (argc > 1 &&
1.128 schwarze 398: ((uc = (unsigned char *)argv[0]) != NULL) &&
1.113 schwarze 399: ((isdigit(uc[0]) && (uc[1] == '\0' ||
1.226 schwarze 400: isalpha(uc[1]))) ||
1.113 schwarze 401: (uc[0] == 'n' && uc[1] == '\0'))) {
1.128 schwarze 402: search.sec = (char *)uc;
1.110 schwarze 403: argv++;
404: argc--;
405: }
1.122 schwarze 406: if (search.arch == NULL)
407: search.arch = getenv("MACHINE");
408: if (search.arch == NULL)
409: search.arch = MACHINE;
1.241 schwarze 410: if (outmode == OUTMODE_ONE)
411: search.firstmatch = 1;
1.95 schwarze 412: }
413:
1.219 schwarze 414: /*
415: * Use the first argument for -O tag in addition to
416: * using it as a search term for man(1) or apropos(1).
417: */
418:
419: if (conf.output.tag != NULL && *conf.output.tag == '\0') {
420: tagarg = argc > 0 && search.argmode == ARG_EXPR ?
421: strchr(*argv, '=') : NULL;
422: conf.output.tag = tagarg == NULL ? *argv : tagarg + 1;
423: }
424:
1.241 schwarze 425: /* Read the configuration file. */
1.95 schwarze 426:
1.241 schwarze 427: if (search.argmode != ARG_FILE)
428: manconf_parse(&conf, conf_file, defpaths, auxpaths);
1.95 schwarze 429:
1.241 schwarze 430: /* man(1): Resolve each name individually. */
1.95 schwarze 431:
1.241 schwarze 432: if (search.argmode == ARG_NAME) {
1.246 schwarze 433: if (argc < 1) {
434: if (outmode != OUTMODE_FLN)
435: usage(ARG_NAME);
436: if (conf.manpath.sz == 0) {
437: warnx("The manpath is empty.");
438: mandoc_msg_setrc(MANDOCLEVEL_BADARG);
439: } else {
440: for (i = 0; i + 1 < conf.manpath.sz; i++)
441: printf("%s:", conf.manpath.paths[i]);
442: printf("%s\n", conf.manpath.paths[i]);
443: }
444: manconf_free(&conf);
445: return (int)mandoc_msg_getrc();
446: }
1.241 schwarze 447: for (res = NULL, ressz = 0; argc > 0; argc--, argv++) {
448: (void)mansearch(&search, &conf.manpath,
449: 1, argv, &resn, &resnsz);
450: if (resnsz == 0)
451: (void)fs_search(&search, &conf.manpath,
1.243 schwarze 452: *argv, &resn, &resnsz);
453: if (resnsz == 0 && strchr(*argv, '/') == NULL) {
454: if (search.arch != NULL &&
455: arch_valid(search.arch, OSENUM) == 0)
456: warnx("Unknown architecture \"%s\".",
457: search.arch);
458: else if (search.sec != NULL)
459: warnx("No entry for %s in "
460: "section %s of the manual.",
461: *argv, search.sec);
462: else
463: warnx("No entry for %s in "
464: "the manual.", *argv);
465: mandoc_msg_setrc(MANDOCLEVEL_BADARG);
466: continue;
467: }
1.241 schwarze 468: if (resnsz == 0) {
469: if (access(*argv, R_OK) == -1) {
470: mandoc_msg_setinfilename(*argv);
1.231 schwarze 471: mandoc_msg(MANDOCERR_BADARG_BAD,
472: 0, 0, "%s", strerror(errno));
473: mandoc_msg_setinfilename(NULL);
1.208 schwarze 474: continue;
475: }
1.241 schwarze 476: resnsz = 1;
477: resn = mandoc_calloc(resnsz, sizeof(*res));
478: resn->file = mandoc_strdup(*argv);
479: resn->ipath = SIZE_MAX;
480: resn->form = FORM_SRC;
481: }
482: if (outmode != OUTMODE_ONE || resnsz == 1) {
1.208 schwarze 483: res = mandoc_reallocarray(res,
1.241 schwarze 484: ressz + resnsz, sizeof(*res));
485: memcpy(res + ressz, resn,
486: sizeof(*resn) * resnsz);
487: ressz += resnsz;
488: continue;
1.208 schwarze 489: }
1.95 schwarze 490:
1.241 schwarze 491: /* Search for the best section. */
1.95 schwarze 492:
1.227 schwarze 493: best_prio = 40;
1.241 schwarze 494: for (ib = i = 0; i < resnsz; i++) {
495: sec = resn[i].file;
1.171 schwarze 496: sec += strcspn(sec, "123456789");
497: if (sec[0] == '\0')
1.227 schwarze 498: continue; /* No section at all. */
1.171 schwarze 499: prio = sec_prios[sec[0] - '1'];
1.227 schwarze 500: if (search.sec != NULL) {
501: ssz = strlen(search.sec);
502: if (strncmp(sec, search.sec, ssz) == 0)
503: sec += ssz;
504: } else
505: sec++; /* Prefer without suffix. */
506: if (*sec != '/')
507: prio += 10; /* Wrong dir name. */
508: if (search.sec != NULL &&
509: (strlen(sec) <= ssz + 3 ||
510: strcmp(sec + strlen(sec) - ssz,
511: search.sec) != 0))
512: prio += 20; /* Wrong file ext. */
1.95 schwarze 513: if (prio >= best_prio)
514: continue;
515: best_prio = prio;
1.241 schwarze 516: ib = i;
1.95 schwarze 517: }
1.241 schwarze 518: res = mandoc_reallocarray(res, ressz + 1,
519: sizeof(*res));
520: memcpy(res + ressz++, resn + ib, sizeof(*resn));
1.1 kristaps 521: }
522:
1.241 schwarze 523: /* apropos(1), whatis(1): Process the full search expression. */
524:
525: } else if (search.argmode != ARG_FILE) {
526: if (mansearch(&search, &conf.manpath,
527: argc, argv, &res, &ressz) == 0)
528: usage(search.argmode);
1.95 schwarze 529:
1.241 schwarze 530: if (ressz == 0) {
531: warnx("nothing appropriate");
532: mandoc_msg_setrc(MANDOCLEVEL_BADARG);
1.95 schwarze 533: goto out;
1.241 schwarze 534: }
535:
536: /* mandoc(1): Take command line arguments as file names. */
537:
1.240 schwarze 538: } else {
1.241 schwarze 539: ressz = argc > 0 ? argc : 1;
540: res = mandoc_calloc(ressz, sizeof(*res));
541: for (i = 0; i < ressz; i++) {
1.240 schwarze 542: if (argc > 0)
543: res[i].file = mandoc_strdup(argv[i]);
544: res[i].ipath = SIZE_MAX;
545: res[i].form = FORM_SRC;
546: }
1.95 schwarze 547: }
548:
1.241 schwarze 549: switch (outmode) {
550: case OUTMODE_FLN:
551: for (i = 0; i < ressz; i++)
552: puts(res[i].file);
553: goto out;
554: case OUTMODE_LST:
555: for (i = 0; i < ressz; i++)
556: printf("%s - %s\n", res[i].names,
557: res[i].output == NULL ? "" :
558: res[i].output);
559: goto out;
560: default:
561: break;
1.167 schwarze 562: }
1.95 schwarze 563:
1.231 schwarze 564: if (search.argmode == ARG_FILE && auxpaths != NULL) {
565: if (strcmp(auxpaths, "doc") == 0)
566: options |= MPARSE_MDOC;
567: else if (strcmp(auxpaths, "an") == 0)
568: options |= MPARSE_MAN;
569: }
1.146 schwarze 570:
1.155 schwarze 571: mchars_alloc();
1.237 schwarze 572: mp = mparse_alloc(options, os_e, os_s);
1.76 schwarze 573:
1.208 schwarze 574: /*
575: * Remember the original working directory, if possible.
576: * This will be needed if some names on the command line
577: * are page names and some are relative file names.
578: * Do not error out if the current directory is not
579: * readable: Maybe it won't be needed after all.
580: */
581: startdir = open(".", O_RDONLY | O_DIRECTORY);
1.241 schwarze 582: for (i = 0; i < ressz; i++) {
583: process_onefile(mp, res + i, startdir, &outst, &conf);
1.238 schwarze 584: if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
1.27 schwarze 585: break;
1.1 kristaps 586: }
1.208 schwarze 587: if (startdir != -1) {
588: (void)fchdir(startdir);
589: close(startdir);
590: }
1.251 schwarze 591: if (conf.output.tag != NULL && conf.output.tag_found == 0) {
592: mandoc_msg(MANDOCERR_TAG, 0, 0, "%s", conf.output.tag);
593: conf.output.tag = NULL;
594: }
1.238 schwarze 595: if (outst.outdata != NULL) {
596: switch (outst.outtype) {
1.160 schwarze 597: case OUTT_HTML:
1.238 schwarze 598: html_free(outst.outdata);
1.160 schwarze 599: break;
600: case OUTT_UTF8:
601: case OUTT_LOCALE:
602: case OUTT_ASCII:
1.238 schwarze 603: ascii_free(outst.outdata);
1.160 schwarze 604: break;
605: case OUTT_PDF:
606: case OUTT_PS:
1.238 schwarze 607: pspdf_free(outst.outdata);
1.160 schwarze 608: break;
609: default:
610: break;
611: }
1.158 schwarze 612: }
1.197 schwarze 613: mandoc_xr_free();
1.237 schwarze 614: mparse_free(mp);
1.155 schwarze 615: mchars_free();
1.95 schwarze 616:
617: out:
1.241 schwarze 618: mansearch_free(res, ressz);
1.240 schwarze 619: if (search.argmode != ARG_FILE)
1.134 schwarze 620: manconf_free(&conf);
1.1 kristaps 621:
1.239 schwarze 622: if (outst.tag_files != NULL) {
1.251 schwarze 623: if (term_tag_close() != -1)
1.253 ! schwarze 624: run_pager(&outst, conf.output.tag);
1.248 schwarze 625: term_tag_unlink();
1.240 schwarze 626: } else if (outst.had_output && outst.outtype != OUTT_LINT)
1.232 schwarze 627: mandoc_msg_summary();
628:
1.215 schwarze 629: return (int)mandoc_msg_getrc();
1.1 kristaps 630: }
631:
1.20 schwarze 632: static void
1.95 schwarze 633: usage(enum argmode argmode)
1.1 kristaps 634: {
1.95 schwarze 635: switch (argmode) {
636: case ARG_FILE:
1.190 schwarze 637: fputs("usage: mandoc [-ac] [-I os=name] "
638: "[-K encoding] [-mdoc | -man] [-O options]\n"
1.133 schwarze 639: "\t [-T output] [-W level] [file ...]\n", stderr);
1.95 schwarze 640: break;
641: case ARG_NAME:
1.190 schwarze 642: fputs("usage: man [-acfhklw] [-C file] [-M path] "
643: "[-m path] [-S subsection]\n"
644: "\t [[-s] section] name ...\n", stderr);
1.95 schwarze 645: break;
646: case ARG_WORD:
1.190 schwarze 647: fputs("usage: whatis [-afk] [-C file] "
1.96 schwarze 648: "[-M path] [-m path] [-O outkey] [-S arch]\n"
649: "\t [-s section] name ...\n", stderr);
1.95 schwarze 650: break;
651: case ARG_EXPR:
1.190 schwarze 652: fputs("usage: apropos [-afk] [-C file] "
1.96 schwarze 653: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.95 schwarze 654: "\t [-s section] expression ...\n", stderr);
655: break;
656: }
1.47 schwarze 657: exit((int)MANDOCLEVEL_BADARG);
1.119 schwarze 658: }
659:
1.247 schwarze 660: static void
661: glob_esc(char **dst, const char *src, const char *suffix)
662: {
663: while (*src != '\0') {
664: if (strchr("*?[", *src) != NULL)
665: *(*dst)++ = '\\';
666: *(*dst)++ = *src++;
667: }
668: while (*suffix != '\0')
669: *(*dst)++ = *suffix++;
670: }
671:
1.119 schwarze 672: static int
673: fs_lookup(const struct manpaths *paths, size_t ipath,
674: const char *sec, const char *arch, const char *name,
675: struct manpage **res, size_t *ressz)
676: {
1.228 schwarze 677: struct stat sb;
1.127 schwarze 678: glob_t globinfo;
1.119 schwarze 679: struct manpage *page;
1.247 schwarze 680: char *file, *cp;
1.177 schwarze 681: int globres;
682: enum form form;
1.119 schwarze 683:
1.247 schwarze 684: const char *const slman = "/man";
685: const char *const slash = "/";
686: const char *const sglob = ".[01-9]*";
687:
1.127 schwarze 688: form = FORM_SRC;
1.119 schwarze 689: mandoc_asprintf(&file, "%s/man%s/%s.%s",
690: paths->paths[ipath], sec, name, sec);
1.228 schwarze 691: if (stat(file, &sb) != -1)
1.119 schwarze 692: goto found;
693: free(file);
694:
695: mandoc_asprintf(&file, "%s/cat%s/%s.0",
696: paths->paths[ipath], sec, name);
1.228 schwarze 697: if (stat(file, &sb) != -1) {
1.119 schwarze 698: form = FORM_CAT;
699: goto found;
700: }
701: free(file);
702:
703: if (arch != NULL) {
704: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
705: paths->paths[ipath], sec, arch, name, sec);
1.228 schwarze 706: if (stat(file, &sb) != -1)
1.119 schwarze 707: goto found;
708: free(file);
709: }
1.127 schwarze 710:
1.247 schwarze 711: cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
712: strlen(slman) + strlen(sec) * 2 + strlen(slash) +
713: strlen(name) * 2 + strlen(sglob) + 1);
714: glob_esc(&cp, paths->paths[ipath], slman);
715: glob_esc(&cp, sec, slash);
716: glob_esc(&cp, name, sglob);
717: *cp = '\0';
1.127 schwarze 718: globres = glob(file, 0, NULL, &globinfo);
719: if (globres != 0 && globres != GLOB_NOMATCH)
1.231 schwarze 720: mandoc_msg(MANDOCERR_GLOB, 0, 0,
721: "%s: %s", file, strerror(errno));
1.127 schwarze 722: free(file);
723: if (globres == 0)
724: file = mandoc_strdup(*globinfo.gl_pathv);
725: globfree(&globinfo);
1.228 schwarze 726: if (globres == 0) {
727: if (stat(file, &sb) != -1)
728: goto found;
729: free(file);
730: }
1.199 schwarze 731: if (res != NULL || ipath + 1 != paths->sz)
1.231 schwarze 732: return -1;
1.119 schwarze 733:
1.199 schwarze 734: mandoc_asprintf(&file, "%s.%s", name, sec);
1.228 schwarze 735: globres = stat(file, &sb);
1.199 schwarze 736: free(file);
1.231 schwarze 737: return globres;
1.199 schwarze 738:
1.119 schwarze 739: found:
1.235 schwarze 740: warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
741: name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
1.199 schwarze 742: if (res == NULL) {
743: free(file);
1.231 schwarze 744: return 0;
1.199 schwarze 745: }
1.231 schwarze 746: *res = mandoc_reallocarray(*res, ++*ressz, sizeof(**res));
1.119 schwarze 747: page = *res + (*ressz - 1);
748: page->file = file;
749: page->names = NULL;
750: page->output = NULL;
1.225 schwarze 751: page->bits = NAME_FILE & NAME_MASK;
1.119 schwarze 752: page->ipath = ipath;
753: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
754: page->form = form;
1.231 schwarze 755: return 0;
1.119 schwarze 756: }
757:
1.198 schwarze 758: static int
1.119 schwarze 759: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
1.243 schwarze 760: const char *name, struct manpage **res, size_t *ressz)
1.119 schwarze 761: {
762: const char *const sections[] =
1.171 schwarze 763: {"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"};
1.119 schwarze 764: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
765:
1.243 schwarze 766: size_t ipath, isec;
1.119 schwarze 767:
768: assert(cfg->argmode == ARG_NAME);
1.198 schwarze 769: if (res != NULL)
770: *res = NULL;
1.243 schwarze 771: *ressz = 0;
772: for (ipath = 0; ipath < paths->sz; ipath++) {
773: if (cfg->sec != NULL) {
774: if (fs_lookup(paths, ipath, cfg->sec, cfg->arch,
775: name, res, ressz) != -1 && cfg->firstmatch)
776: return 0;
777: } else {
778: for (isec = 0; isec < nsec; isec++)
1.119 schwarze 779: if (fs_lookup(paths, ipath, sections[isec],
1.243 schwarze 780: cfg->arch, name, res, ressz) != -1 &&
1.119 schwarze 781: cfg->firstmatch)
1.231 schwarze 782: return 0;
1.119 schwarze 783: }
784: }
1.231 schwarze 785: return -1;
1.1 kristaps 786: }
787:
1.27 schwarze 788: static void
1.240 schwarze 789: process_onefile(struct mparse *mp, struct manpage *resp, int startdir,
790: struct outstate *outst, struct manconf *conf)
791: {
792: int fd;
793:
794: /*
795: * Changing directories is not needed in ARG_FILE mode.
796: * Do it on a best-effort basis. Even in case of
797: * failure, some functionality may still work.
798: */
799: if (resp->ipath != SIZE_MAX)
800: (void)chdir(conf->manpath.paths[resp->ipath]);
801: else if (startdir != -1)
802: (void)fchdir(startdir);
803:
804: mandoc_msg_setinfilename(resp->file);
805: if (resp->file != NULL) {
806: if ((fd = mparse_open(mp, resp->file)) == -1) {
807: mandoc_msg(resp->ipath == SIZE_MAX ?
808: MANDOCERR_BADARG_BAD : MANDOCERR_OPEN,
809: 0, 0, "%s", strerror(errno));
810: mandoc_msg_setinfilename(NULL);
811: return;
812: }
813: } else
814: fd = STDIN_FILENO;
815:
1.250 schwarze 816: if (outst->use_pager) {
817: outst->use_pager = 0;
1.251 schwarze 818: outst->tag_files = term_tag_init();
1.250 schwarze 819: }
820: if (outst->had_output && outst->outtype <= OUTT_UTF8) {
821: if (outst->outdata == NULL)
822: outdata_alloc(outst, &conf->output);
823: terminal_sepline(outst->outdata);
1.240 schwarze 824: }
825:
826: if (resp->form == FORM_SRC)
827: parse(mp, fd, resp->file, outst, &conf->output);
828: else {
829: passthrough(fd, conf->output.synopsisonly);
830: outst->had_output = 1;
831: }
832:
833: if (ferror(stdout)) {
834: if (outst->tag_files != NULL) {
835: mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s",
836: outst->tag_files->ofn, strerror(errno));
1.248 schwarze 837: term_tag_unlink();
1.240 schwarze 838: outst->tag_files = NULL;
839: } else
840: mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s",
841: strerror(errno));
842: }
843: mandoc_msg_setinfilename(NULL);
844: }
845:
846: static void
1.238 schwarze 847: parse(struct mparse *mp, int fd, const char *file,
848: struct outstate *outst, struct manoutput *outconf)
1.52 schwarze 849: {
1.240 schwarze 850: static int previous;
851: struct roff_meta *meta;
1.52 schwarze 852:
1.240 schwarze 853: assert(fd >= 0);
854: if (file == NULL)
855: file = "<stdin>";
1.52 schwarze 856:
1.240 schwarze 857: if (previous)
858: mparse_reset(mp);
859: else
860: previous = 1;
1.52 schwarze 861:
1.237 schwarze 862: mparse_readfd(mp, fd, file);
1.168 schwarze 863: if (fd != STDIN_FILENO)
864: close(fd);
1.1 kristaps 865:
1.51 schwarze 866: /*
1.76 schwarze 867: * With -Wstop and warnings or errors of at least the requested
868: * level, do not produce output.
1.51 schwarze 869: */
870:
1.238 schwarze 871: if (outst->wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
1.132 schwarze 872: return;
1.51 schwarze 873:
1.238 schwarze 874: if (outst->outdata == NULL)
875: outdata_alloc(outst, outconf);
876: else if (outst->outtype == OUTT_HTML)
1.252 otto 877: html_reset(outst->outdata);
1.51 schwarze 878:
1.218 schwarze 879: mandoc_xr_reset();
1.237 schwarze 880: meta = mparse_result(mp);
1.158 schwarze 881:
882: /* Execute the out device, if it exists. */
883:
1.240 schwarze 884: outst->had_output = 1;
1.218 schwarze 885: if (meta->macroset == MACROSET_MDOC) {
1.238 schwarze 886: switch (outst->outtype) {
1.90 schwarze 887: case OUTT_HTML:
1.238 schwarze 888: html_mdoc(outst->outdata, meta);
1.51 schwarze 889: break;
1.90 schwarze 890: case OUTT_TREE:
1.238 schwarze 891: tree_mdoc(outst->outdata, meta);
1.51 schwarze 892: break;
1.90 schwarze 893: case OUTT_MAN:
1.238 schwarze 894: man_mdoc(outst->outdata, meta);
1.78 schwarze 895: break;
1.90 schwarze 896: case OUTT_PDF:
897: case OUTT_ASCII:
898: case OUTT_UTF8:
899: case OUTT_LOCALE:
900: case OUTT_PS:
1.238 schwarze 901: terminal_mdoc(outst->outdata, meta);
1.158 schwarze 902: break;
1.188 schwarze 903: case OUTT_MARKDOWN:
1.238 schwarze 904: markdown_mdoc(outst->outdata, meta);
1.188 schwarze 905: break;
1.158 schwarze 906: default:
907: break;
908: }
909: }
1.218 schwarze 910: if (meta->macroset == MACROSET_MAN) {
1.238 schwarze 911: switch (outst->outtype) {
1.158 schwarze 912: case OUTT_HTML:
1.238 schwarze 913: html_man(outst->outdata, meta);
1.158 schwarze 914: break;
915: case OUTT_TREE:
1.238 schwarze 916: tree_man(outst->outdata, meta);
1.158 schwarze 917: break;
918: case OUTT_MAN:
1.237 schwarze 919: mparse_copy(mp);
1.158 schwarze 920: break;
921: case OUTT_PDF:
922: case OUTT_ASCII:
923: case OUTT_UTF8:
924: case OUTT_LOCALE:
925: case OUTT_PS:
1.238 schwarze 926: terminal_man(outst->outdata, meta);
1.51 schwarze 927: break;
928: default:
929: break;
930: }
1.179 schwarze 931: }
1.251 schwarze 932: if (outconf->tag != NULL && outconf->tag_found == 0 &&
933: tag_exists(outconf->tag))
934: outconf->tag_found = 1;
1.215 schwarze 935: if (mandoc_msg_getmin() < MANDOCERR_STYLE)
936: check_xr();
1.197 schwarze 937: }
938:
939: static void
1.215 schwarze 940: check_xr(void)
1.197 schwarze 941: {
942: static struct manpaths paths;
943: struct mansearch search;
944: struct mandoc_xr *xr;
945: size_t sz;
946:
947: if (paths.sz == 0)
948: manpath_base(&paths);
949:
950: for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) {
1.200 schwarze 951: if (xr->line == -1)
952: continue;
1.197 schwarze 953: search.arch = NULL;
954: search.sec = xr->sec;
955: search.outkey = NULL;
956: search.argmode = ARG_NAME;
957: search.firstmatch = 1;
958: if (mansearch(&search, &paths, 1, &xr->name, NULL, &sz))
1.198 schwarze 959: continue;
1.243 schwarze 960: if (fs_search(&search, &paths, xr->name, NULL, &sz) != -1)
1.197 schwarze 961: continue;
1.201 schwarze 962: if (xr->count == 1)
1.216 schwarze 963: mandoc_msg(MANDOCERR_XR_BAD, xr->line,
964: xr->pos + 1, "Xr %s %s", xr->name, xr->sec);
1.201 schwarze 965: else
1.216 schwarze 966: mandoc_msg(MANDOCERR_XR_BAD, xr->line,
967: xr->pos + 1, "Xr %s %s (%d times)",
1.201 schwarze 968: xr->name, xr->sec, xr->count);
1.197 schwarze 969: }
1.179 schwarze 970: }
971:
972: static void
1.238 schwarze 973: outdata_alloc(struct outstate *outst, struct manoutput *outconf)
1.179 schwarze 974: {
1.238 schwarze 975: switch (outst->outtype) {
1.179 schwarze 976: case OUTT_HTML:
1.238 schwarze 977: outst->outdata = html_alloc(outconf);
1.179 schwarze 978: break;
979: case OUTT_UTF8:
1.238 schwarze 980: outst->outdata = utf8_alloc(outconf);
1.179 schwarze 981: break;
982: case OUTT_LOCALE:
1.238 schwarze 983: outst->outdata = locale_alloc(outconf);
1.179 schwarze 984: break;
985: case OUTT_ASCII:
1.238 schwarze 986: outst->outdata = ascii_alloc(outconf);
1.179 schwarze 987: break;
988: case OUTT_PDF:
1.238 schwarze 989: outst->outdata = pdf_alloc(outconf);
1.179 schwarze 990: break;
991: case OUTT_PS:
1.238 schwarze 992: outst->outdata = ps_alloc(outconf);
1.179 schwarze 993: break;
994: default:
995: break;
1.51 schwarze 996: }
1.1 kristaps 997: }
998:
1.132 schwarze 999: static void
1.231 schwarze 1000: passthrough(int fd, int synopsis_only)
1.95 schwarze 1001: {
1.105 schwarze 1002: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
1003: const char synr[] = "SYNOPSIS";
1004:
1005: FILE *stream;
1.164 schwarze 1006: char *line, *cp;
1007: size_t linesz;
1.180 schwarze 1008: ssize_t len, written;
1.231 schwarze 1009: int lno, print;
1.116 schwarze 1010:
1.231 schwarze 1011: stream = NULL;
1.164 schwarze 1012: line = NULL;
1013: linesz = 0;
1.105 schwarze 1014:
1.180 schwarze 1015: if (fflush(stdout) == EOF) {
1.231 schwarze 1016: mandoc_msg(MANDOCERR_FFLUSH, 0, 0, "%s", strerror(errno));
1017: goto done;
1.180 schwarze 1018: }
1.105 schwarze 1019: if ((stream = fdopen(fd, "r")) == NULL) {
1020: close(fd);
1.231 schwarze 1021: mandoc_msg(MANDOCERR_FDOPEN, 0, 0, "%s", strerror(errno));
1022: goto done;
1.105 schwarze 1023: }
1.95 schwarze 1024:
1.231 schwarze 1025: lno = print = 0;
1.180 schwarze 1026: while ((len = getline(&line, &linesz, stream)) != -1) {
1.231 schwarze 1027: lno++;
1.164 schwarze 1028: cp = line;
1.105 schwarze 1029: if (synopsis_only) {
1030: if (print) {
1.164 schwarze 1031: if ( ! isspace((unsigned char)*cp))
1.105 schwarze 1032: goto done;
1.180 schwarze 1033: while (isspace((unsigned char)*cp)) {
1.164 schwarze 1034: cp++;
1.180 schwarze 1035: len--;
1036: }
1.105 schwarze 1037: } else {
1.164 schwarze 1038: if (strcmp(cp, synb) == 0 ||
1039: strcmp(cp, synr) == 0)
1.105 schwarze 1040: print = 1;
1041: continue;
1042: }
1043: }
1.180 schwarze 1044: for (; len > 0; len -= written) {
1.231 schwarze 1045: if ((written = write(STDOUT_FILENO, cp, len)) == -1) {
1046: mandoc_msg(MANDOCERR_WRITE, 0, 0,
1047: "%s", strerror(errno));
1048: goto done;
1049: }
1.164 schwarze 1050: }
1.105 schwarze 1051: }
1.231 schwarze 1052: if (ferror(stream))
1053: mandoc_msg(MANDOCERR_GETLINE, lno, 0, "%s", strerror(errno));
1.101 schwarze 1054:
1.105 schwarze 1055: done:
1.164 schwarze 1056: free(line);
1.231 schwarze 1057: if (stream != NULL)
1058: fclose(stream);
1.1 kristaps 1059: }
1060:
1061: static int
1.237 schwarze 1062: woptions(char *arg, enum mandoc_os *os_e, int *wstop)
1.1 kristaps 1063: {
1.10 schwarze 1064: char *v, *o;
1.196 schwarze 1065: const char *toks[11];
1.1 kristaps 1066:
1.45 schwarze 1067: toks[0] = "stop";
1068: toks[1] = "all";
1.196 schwarze 1069: toks[2] = "base";
1070: toks[3] = "style";
1071: toks[4] = "warning";
1072: toks[5] = "error";
1073: toks[6] = "unsupp";
1074: toks[7] = "fatal";
1075: toks[8] = "openbsd";
1076: toks[9] = "netbsd";
1077: toks[10] = NULL;
1.1 kristaps 1078:
1.10 schwarze 1079: while (*arg) {
1080: o = arg;
1.176 schwarze 1081: switch (getsubopt(&arg, (char * const *)toks, &v)) {
1.90 schwarze 1082: case 0:
1.237 schwarze 1083: *wstop = 1;
1.1 kristaps 1084: break;
1.90 schwarze 1085: case 1:
1086: case 2:
1.215 schwarze 1087: mandoc_msg_setmin(MANDOCERR_BASE);
1.193 schwarze 1088: break;
1089: case 3:
1.215 schwarze 1090: mandoc_msg_setmin(MANDOCERR_STYLE);
1.1 kristaps 1091: break;
1.193 schwarze 1092: case 4:
1.215 schwarze 1093: mandoc_msg_setmin(MANDOCERR_WARNING);
1.1 kristaps 1094: break;
1.193 schwarze 1095: case 5:
1.215 schwarze 1096: mandoc_msg_setmin(MANDOCERR_ERROR);
1.123 schwarze 1097: break;
1.193 schwarze 1098: case 6:
1.215 schwarze 1099: mandoc_msg_setmin(MANDOCERR_UNSUPP);
1.196 schwarze 1100: break;
1101: case 7:
1.231 schwarze 1102: mandoc_msg_setmin(MANDOCERR_BADARG);
1.196 schwarze 1103: break;
1104: case 8:
1.215 schwarze 1105: mandoc_msg_setmin(MANDOCERR_BASE);
1.237 schwarze 1106: *os_e = MANDOC_OS_OPENBSD;
1.196 schwarze 1107: break;
1108: case 9:
1.215 schwarze 1109: mandoc_msg_setmin(MANDOCERR_BASE);
1.237 schwarze 1110: *os_e = MANDOC_OS_NETBSD;
1.19 schwarze 1111: break;
1.1 kristaps 1112: default:
1.231 schwarze 1113: mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, "-W %s", o);
1114: return -1;
1.1 kristaps 1115: }
1.10 schwarze 1116: }
1.231 schwarze 1117: return 0;
1.236 schwarze 1118: }
1119:
1120: /*
1121: * Wait until moved to the foreground,
1122: * then fork the pager and wait for the user to close it.
1123: */
1124: static void
1.253 ! schwarze 1125: run_pager(struct outstate *outst, char *tag_target)
1.236 schwarze 1126: {
1127: int signum, status;
1128: pid_t man_pgid, tc_pgid;
1129: pid_t pager_pid, wait_pid;
1130:
1131: man_pgid = getpgid(0);
1.253 ! schwarze 1132: outst->tag_files->tcpgid =
! 1133: man_pgid == getpid() ? getpgid(getppid()) : man_pgid;
1.236 schwarze 1134: pager_pid = 0;
1135: signum = SIGSTOP;
1136:
1137: for (;;) {
1138: /* Stop here until moved to the foreground. */
1139:
1.251 schwarze 1140: tc_pgid = tcgetpgrp(STDOUT_FILENO);
1.236 schwarze 1141: if (tc_pgid != man_pgid) {
1142: if (tc_pgid == pager_pid) {
1.251 schwarze 1143: (void)tcsetpgrp(STDOUT_FILENO, man_pgid);
1.236 schwarze 1144: if (signum == SIGTTIN)
1145: continue;
1146: } else
1.253 ! schwarze 1147: outst->tag_files->tcpgid = tc_pgid;
1.236 schwarze 1148: kill(0, signum);
1149: continue;
1150: }
1151:
1152: /* Once in the foreground, activate the pager. */
1153:
1154: if (pager_pid) {
1.251 schwarze 1155: (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
1.236 schwarze 1156: kill(pager_pid, SIGCONT);
1157: } else
1.253 ! schwarze 1158: pager_pid = spawn_pager(outst, tag_target);
1.236 schwarze 1159:
1160: /* Wait for the pager to stop or exit. */
1161:
1162: while ((wait_pid = waitpid(pager_pid, &status,
1163: WUNTRACED)) == -1 && errno == EINTR)
1164: continue;
1165:
1166: if (wait_pid == -1) {
1167: mandoc_msg(MANDOCERR_WAIT, 0, 0,
1168: "%s", strerror(errno));
1169: break;
1170: }
1171: if (!WIFSTOPPED(status))
1172: break;
1173:
1174: signum = WSTOPSIG(status);
1175: }
1.95 schwarze 1176: }
1177:
1.130 schwarze 1178: static pid_t
1.253 ! schwarze 1179: spawn_pager(struct outstate *outst, char *tag_target)
1.95 schwarze 1180: {
1.172 schwarze 1181: const struct timespec timeout = { 0, 100000000 }; /* 0.1s */
1.95 schwarze 1182: #define MAX_PAGER_ARGS 16
1183: char *argv[MAX_PAGER_ARGS];
1184: const char *pager;
1185: char *cp;
1.144 schwarze 1186: size_t cmdlen;
1.212 schwarze 1187: int argc, use_ofn;
1.130 schwarze 1188: pid_t pager_pid;
1.95 schwarze 1189:
1.253 ! schwarze 1190: assert(outst->tag_files->ofd == -1);
! 1191: assert(outst->tag_files->tfs == NULL);
1.251 schwarze 1192:
1.144 schwarze 1193: pager = getenv("MANPAGER");
1194: if (pager == NULL || *pager == '\0')
1195: pager = getenv("PAGER");
1196: if (pager == NULL || *pager == '\0')
1197: pager = "more -s";
1198: cp = mandoc_strdup(pager);
1199:
1200: /*
1201: * Parse the pager command into words.
1202: * Intentionally do not do anything fancy here.
1203: */
1204:
1205: argc = 0;
1.212 schwarze 1206: while (argc + 5 < MAX_PAGER_ARGS) {
1.144 schwarze 1207: argv[argc++] = cp;
1208: cp = strchr(cp, ' ');
1209: if (cp == NULL)
1210: break;
1211: *cp++ = '\0';
1212: while (*cp == ' ')
1213: cp++;
1214: if (*cp == '\0')
1215: break;
1216: }
1217:
1.149 schwarze 1218: /* For more(1) and less(1), use the tag file. */
1.144 schwarze 1219:
1.212 schwarze 1220: use_ofn = 1;
1.253 ! schwarze 1221: if (*outst->tag_files->tfn != '\0' &&
! 1222: (cmdlen = strlen(argv[0])) >= 4) {
1.144 schwarze 1223: cp = argv[0] + cmdlen - 4;
1.149 schwarze 1224: if (strcmp(cp, "less") == 0 || strcmp(cp, "more") == 0) {
1225: argv[argc++] = mandoc_strdup("-T");
1.253 ! schwarze 1226: argv[argc++] = outst->tag_files->tfn;
1.251 schwarze 1227: if (tag_target != NULL) {
1.212 schwarze 1228: argv[argc++] = mandoc_strdup("-t");
1.251 schwarze 1229: argv[argc++] = tag_target;
1.212 schwarze 1230: use_ofn = 0;
1231: }
1.149 schwarze 1232: }
1.144 schwarze 1233: }
1.253 ! schwarze 1234: if (use_ofn) {
! 1235: if (outst->outtype == OUTT_HTML && tag_target != NULL)
! 1236: mandoc_asprintf(&argv[argc], "file://%s#%s",
! 1237: outst->tag_files->ofn, tag_target);
! 1238: else
! 1239: argv[argc] = outst->tag_files->ofn;
! 1240: argc++;
! 1241: }
1.144 schwarze 1242: argv[argc] = NULL;
1243:
1.130 schwarze 1244: switch (pager_pid = fork()) {
1.95 schwarze 1245: case -1:
1.231 schwarze 1246: mandoc_msg(MANDOCERR_FORK, 0, 0, "%s", strerror(errno));
1247: exit(mandoc_msg_getrc());
1.95 schwarze 1248: case 0:
1.129 schwarze 1249: break;
1250: default:
1.165 schwarze 1251: (void)setpgid(pager_pid, 0);
1.251 schwarze 1252: (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
1.231 schwarze 1253: if (pledge("stdio rpath tmppath tty proc", NULL) == -1) {
1254: mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
1255: "%s", strerror(errno));
1256: exit(mandoc_msg_getrc());
1257: }
1.253 ! schwarze 1258: outst->tag_files->pager_pid = pager_pid;
1.150 schwarze 1259: return pager_pid;
1.95 schwarze 1260: }
1261:
1.251 schwarze 1262: /*
1263: * The child process becomes the pager.
1264: * Do not start it before controlling the terminal.
1265: */
1.172 schwarze 1266:
1.182 schwarze 1267: while (tcgetpgrp(STDOUT_FILENO) != getpid())
1.172 schwarze 1268: nanosleep(&timeout, NULL);
1269:
1.95 schwarze 1270: execvp(argv[0], argv);
1.231 schwarze 1271: mandoc_msg(MANDOCERR_EXEC, 0, 0, "%s: %s", argv[0], strerror(errno));
1272: _exit(mandoc_msg_getrc());
1.30 schwarze 1273: }