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