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