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