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