Annotation of mandoc/main.c, Revision 1.357
1.357 ! schwarze 1: /* $Id: main.c,v 1.356 2021/08/14 13:53:08 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.337 schwarze 135: const char *progname, *sec;
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;
519: continue;
1.305 schwarze 520: }
1.187 schwarze 521:
1.338 schwarze 522: /* Search for the best section. */
1.182 schwarze 523:
1.325 schwarze 524: best_prio = 40;
1.338 schwarze 525: for (ib = i = 0; i < resnsz; i++) {
526: sec = resn[i].file;
1.264 schwarze 527: sec += strcspn(sec, "123456789");
528: if (sec[0] == '\0')
1.325 schwarze 529: continue; /* No section at all. */
1.264 schwarze 530: prio = sec_prios[sec[0] - '1'];
1.325 schwarze 531: if (search.sec != NULL) {
532: ssz = strlen(search.sec);
533: if (strncmp(sec, search.sec, ssz) == 0)
534: sec += ssz;
535: } else
536: sec++; /* Prefer without suffix. */
537: if (*sec != '/')
538: prio += 10; /* Wrong dir name. */
539: if (search.sec != NULL &&
540: (strlen(sec) <= ssz + 3 ||
541: strcmp(sec + strlen(sec) - ssz,
542: search.sec) != 0))
543: prio += 20; /* Wrong file ext. */
1.182 schwarze 544: if (prio >= best_prio)
545: continue;
546: best_prio = prio;
1.338 schwarze 547: ib = i;
1.182 schwarze 548: }
1.338 schwarze 549: res = mandoc_reallocarray(res, ressz + 1,
550: sizeof(*res));
551: memcpy(res + ressz++, resn + ib, sizeof(*resn));
1.181 schwarze 552: }
1.182 schwarze 553:
1.338 schwarze 554: /* apropos(1), whatis(1): Process the full search expression. */
555:
556: } else if (search.argmode != ARG_FILE) {
557: if (mansearch(&search, &conf.manpath,
558: argc, argv, &res, &ressz) == 0)
559: usage(search.argmode);
1.182 schwarze 560:
1.338 schwarze 561: if (ressz == 0) {
562: warnx("nothing appropriate");
563: mandoc_msg_setrc(MANDOCLEVEL_BADARG);
1.182 schwarze 564: goto out;
1.338 schwarze 565: }
566:
567: /* mandoc(1): Take command line arguments as file names. */
568:
1.337 schwarze 569: } else {
1.338 schwarze 570: ressz = argc > 0 ? argc : 1;
571: res = mandoc_calloc(ressz, sizeof(*res));
572: for (i = 0; i < ressz; i++) {
1.337 schwarze 573: if (argc > 0)
574: res[i].file = mandoc_strdup(argv[i]);
575: res[i].ipath = SIZE_MAX;
576: res[i].form = FORM_SRC;
577: }
1.180 schwarze 578: }
579:
1.338 schwarze 580: switch (outmode) {
581: case OUTMODE_FLN:
582: for (i = 0; i < ressz; i++)
583: puts(res[i].file);
584: goto out;
585: case OUTMODE_LST:
586: for (i = 0; i < ressz; i++)
587: printf("%s - %s\n", res[i].names,
588: res[i].output == NULL ? "" :
589: res[i].output);
590: goto out;
591: default:
592: break;
593: }
1.255 schwarze 594:
1.329 schwarze 595: if (search.argmode == ARG_FILE && auxpaths != NULL) {
596: if (strcmp(auxpaths, "doc") == 0)
597: options |= MPARSE_MDOC;
598: else if (strcmp(auxpaths, "an") == 0)
599: options |= MPARSE_MAN;
600: }
1.241 schwarze 601:
1.249 schwarze 602: mchars_alloc();
1.334 schwarze 603: mp = mparse_alloc(options, os_e, os_s);
1.154 kristaps 604:
1.305 schwarze 605: /*
606: * Remember the original working directory, if possible.
607: * This will be needed if some names on the command line
608: * are page names and some are relative file names.
609: * Do not error out if the current directory is not
610: * readable: Maybe it won't be needed after all.
611: */
612: startdir = open(".", O_RDONLY | O_DIRECTORY);
1.338 schwarze 613: for (i = 0; i < ressz; i++) {
614: process_onefile(mp, res + i, startdir, &outst, &conf);
1.335 schwarze 615: if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
1.64 kristaps 616: break;
1.1 kristaps 617: }
1.305 schwarze 618: if (startdir != -1) {
619: (void)fchdir(startdir);
620: close(startdir);
621: }
1.348 schwarze 622: if (conf.output.tag != NULL && conf.output.tag_found == 0) {
623: mandoc_msg(MANDOCERR_TAG, 0, 0, "%s", conf.output.tag);
624: conf.output.tag = NULL;
625: }
1.335 schwarze 626: if (outst.outdata != NULL) {
627: switch (outst.outtype) {
1.252 schwarze 628: case OUTT_HTML:
1.335 schwarze 629: html_free(outst.outdata);
1.252 schwarze 630: break;
631: case OUTT_UTF8:
632: case OUTT_LOCALE:
633: case OUTT_ASCII:
1.335 schwarze 634: ascii_free(outst.outdata);
1.252 schwarze 635: break;
636: case OUTT_PDF:
637: case OUTT_PS:
1.335 schwarze 638: pspdf_free(outst.outdata);
1.252 schwarze 639: break;
640: default:
641: break;
642: }
1.250 schwarze 643: }
1.294 schwarze 644: mandoc_xr_free();
1.334 schwarze 645: mparse_free(mp);
1.249 schwarze 646: mchars_free();
1.182 schwarze 647:
648: out:
1.338 schwarze 649: mansearch_free(res, ressz);
1.337 schwarze 650: if (search.argmode != ARG_FILE)
1.229 schwarze 651: manconf_free(&conf);
1.1 kristaps 652:
1.336 schwarze 653: if (outst.tag_files != NULL) {
1.352 schwarze 654: if (term_tag_close() != -1 &&
655: conf.output.outfilename == NULL &&
656: conf.output.tagfilename == NULL)
1.350 schwarze 657: run_pager(&outst, conf.output.tag);
1.345 schwarze 658: term_tag_unlink();
1.337 schwarze 659: } else if (outst.had_output && outst.outtype != OUTT_LINT)
1.330 schwarze 660: mandoc_msg_summary();
661:
1.312 schwarze 662: return (int)mandoc_msg_getrc();
1.1 kristaps 663: }
664:
1.55 kristaps 665: static void
1.180 schwarze 666: usage(enum argmode argmode)
1.1 kristaps 667: {
1.180 schwarze 668: switch (argmode) {
669: case ARG_FILE:
1.287 schwarze 670: fputs("usage: mandoc [-ac] [-I os=name] "
671: "[-K encoding] [-mdoc | -man] [-O options]\n"
1.228 schwarze 672: "\t [-T output] [-W level] [file ...]\n", stderr);
1.180 schwarze 673: break;
674: case ARG_NAME:
1.287 schwarze 675: fputs("usage: man [-acfhklw] [-C file] [-M path] "
676: "[-m path] [-S subsection]\n"
677: "\t [[-s] section] name ...\n", stderr);
1.180 schwarze 678: break;
679: case ARG_WORD:
1.287 schwarze 680: fputs("usage: whatis [-afk] [-C file] "
1.188 schwarze 681: "[-M path] [-m path] [-O outkey] [-S arch]\n"
682: "\t [-s section] name ...\n", stderr);
1.180 schwarze 683: break;
684: case ARG_EXPR:
1.287 schwarze 685: fputs("usage: apropos [-afk] [-C file] "
1.188 schwarze 686: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.180 schwarze 687: "\t [-s section] expression ...\n", stderr);
688: break;
689: }
1.105 kristaps 690: exit((int)MANDOCLEVEL_BADARG);
1.68 joerg 691: }
1.213 schwarze 692:
1.344 schwarze 693: static void
694: glob_esc(char **dst, const char *src, const char *suffix)
695: {
696: while (*src != '\0') {
697: if (strchr("*?[", *src) != NULL)
698: *(*dst)++ = '\\';
699: *(*dst)++ = *src++;
700: }
701: while (*suffix != '\0')
702: *(*dst)++ = *suffix++;
703: }
704:
1.357 ! schwarze 705: static void
! 706: fs_append(char **file, size_t filesz, int copy, size_t ipath,
! 707: const char *sec, enum form form, struct manpage **res, size_t *ressz)
! 708: {
! 709: struct manpage *page;
! 710:
! 711: *res = mandoc_reallocarray(*res, *ressz + filesz, sizeof(**res));
! 712: page = *res + *ressz;
! 713: *ressz += filesz;
! 714: for (;;) {
! 715: page->file = copy ? mandoc_strdup(*file) : *file;
! 716: page->names = NULL;
! 717: page->output = NULL;
! 718: page->bits = NAME_FILE & NAME_MASK;
! 719: page->ipath = ipath;
! 720: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
! 721: page->form = form;
! 722: if (--filesz == 0)
! 723: break;
! 724: file++;
! 725: page++;
! 726: }
! 727: }
! 728:
1.213 schwarze 729: static int
730: fs_lookup(const struct manpaths *paths, size_t ipath,
731: const char *sec, const char *arch, const char *name,
732: struct manpage **res, size_t *ressz)
733: {
1.326 schwarze 734: struct stat sb;
1.222 schwarze 735: glob_t globinfo;
1.357 ! schwarze 736: char *file, *cp, secnum[2];
1.274 schwarze 737: int globres;
738: enum form form;
1.213 schwarze 739:
1.344 schwarze 740: const char *const slman = "/man";
741: const char *const slash = "/";
742: const char *const sglob = ".[01-9]*";
1.357 ! schwarze 743: const char *const dot = ".";
! 744: const char *const aster = "*";
1.344 schwarze 745:
1.357 ! schwarze 746: memset(&globinfo, 0, sizeof(globinfo));
1.222 schwarze 747: form = FORM_SRC;
1.357 ! schwarze 748:
1.213 schwarze 749: mandoc_asprintf(&file, "%s/man%s/%s.%s",
750: paths->paths[ipath], sec, name, sec);
1.326 schwarze 751: if (stat(file, &sb) != -1)
1.213 schwarze 752: goto found;
753: free(file);
754:
755: mandoc_asprintf(&file, "%s/cat%s/%s.0",
756: paths->paths[ipath], sec, name);
1.326 schwarze 757: if (stat(file, &sb) != -1) {
1.213 schwarze 758: form = FORM_CAT;
759: goto found;
760: }
761: free(file);
762:
763: if (arch != NULL) {
764: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
765: paths->paths[ipath], sec, arch, name, sec);
1.326 schwarze 766: if (stat(file, &sb) != -1)
1.213 schwarze 767: goto found;
768: free(file);
769: }
1.222 schwarze 770:
1.344 schwarze 771: cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
772: strlen(slman) + strlen(sec) * 2 + strlen(slash) +
773: strlen(name) * 2 + strlen(sglob) + 1);
774: glob_esc(&cp, paths->paths[ipath], slman);
775: glob_esc(&cp, sec, slash);
776: glob_esc(&cp, name, sglob);
777: *cp = '\0';
1.222 schwarze 778: globres = glob(file, 0, NULL, &globinfo);
779: if (globres != 0 && globres != GLOB_NOMATCH)
1.329 schwarze 780: mandoc_msg(MANDOCERR_GLOB, 0, 0,
781: "%s: %s", file, strerror(errno));
1.222 schwarze 782: free(file);
1.357 ! schwarze 783: file = NULL;
1.222 schwarze 784: if (globres == 0)
1.357 ! schwarze 785: goto found;
1.222 schwarze 786: globfree(&globinfo);
1.357 ! schwarze 787:
! 788: if (sec[1] != '\0' && *ressz == 0) {
! 789: secnum[0] = sec[0];
! 790: secnum[1] = '\0';
! 791: cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
! 792: strlen(slman) + strlen(secnum) * 2 + strlen(slash) +
! 793: strlen(name) * 2 + strlen(dot) +
! 794: strlen(sec) * 2 + strlen(aster) + 1);
! 795: glob_esc(&cp, paths->paths[ipath], slman);
! 796: glob_esc(&cp, secnum, slash);
! 797: glob_esc(&cp, name, dot);
! 798: glob_esc(&cp, sec, aster);
! 799: *cp = '\0';
! 800: globres = glob(file, 0, NULL, &globinfo);
! 801: if (globres != 0 && globres != GLOB_NOMATCH)
! 802: mandoc_msg(MANDOCERR_GLOB, 0, 0,
! 803: "%s: %s", file, strerror(errno));
! 804: free(file);
! 805: file = NULL;
! 806: if (globres == 0)
1.326 schwarze 807: goto found;
1.357 ! schwarze 808: globfree(&globinfo);
1.326 schwarze 809: }
1.357 ! schwarze 810:
1.296 schwarze 811: if (res != NULL || ipath + 1 != paths->sz)
1.329 schwarze 812: return -1;
1.213 schwarze 813:
1.296 schwarze 814: mandoc_asprintf(&file, "%s.%s", name, sec);
1.326 schwarze 815: globres = stat(file, &sb);
1.296 schwarze 816: free(file);
1.329 schwarze 817: return globres;
1.296 schwarze 818:
1.213 schwarze 819: found:
1.266 schwarze 820: warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
821: name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
1.357 ! schwarze 822: if (res == NULL)
1.296 schwarze 823: free(file);
1.357 ! schwarze 824: else if (file == NULL)
! 825: fs_append(globinfo.gl_pathv, globinfo.gl_pathc, 1,
! 826: ipath, sec, form, res, ressz);
! 827: else
! 828: fs_append(&file, 1, 0, ipath, sec, form, res, ressz);
! 829: globfree(&globinfo);
1.329 schwarze 830: return 0;
1.213 schwarze 831: }
832:
1.295 schwarze 833: static int
1.213 schwarze 834: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
1.340 schwarze 835: const char *name, struct manpage **res, size_t *ressz)
1.213 schwarze 836: {
837: const char *const sections[] =
1.264 schwarze 838: {"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"};
1.213 schwarze 839: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
840:
1.340 schwarze 841: size_t ipath, isec;
1.213 schwarze 842:
843: assert(cfg->argmode == ARG_NAME);
1.295 schwarze 844: if (res != NULL)
845: *res = NULL;
1.340 schwarze 846: *ressz = 0;
847: for (ipath = 0; ipath < paths->sz; ipath++) {
848: if (cfg->sec != NULL) {
849: if (fs_lookup(paths, ipath, cfg->sec, cfg->arch,
850: name, res, ressz) != -1 && cfg->firstmatch)
851: return 0;
852: } else {
853: for (isec = 0; isec < nsec; isec++)
1.213 schwarze 854: if (fs_lookup(paths, ipath, sections[isec],
1.340 schwarze 855: cfg->arch, name, res, ressz) != -1 &&
1.213 schwarze 856: cfg->firstmatch)
1.329 schwarze 857: return 0;
1.213 schwarze 858: }
859: }
1.329 schwarze 860: return -1;
1.213 schwarze 861: }
1.68 joerg 862:
1.64 kristaps 863: static void
1.337 schwarze 864: process_onefile(struct mparse *mp, struct manpage *resp, int startdir,
865: struct outstate *outst, struct manconf *conf)
866: {
867: int fd;
868:
869: /*
870: * Changing directories is not needed in ARG_FILE mode.
871: * Do it on a best-effort basis. Even in case of
872: * failure, some functionality may still work.
873: */
874: if (resp->ipath != SIZE_MAX)
875: (void)chdir(conf->manpath.paths[resp->ipath]);
876: else if (startdir != -1)
877: (void)fchdir(startdir);
878:
879: mandoc_msg_setinfilename(resp->file);
880: if (resp->file != NULL) {
881: if ((fd = mparse_open(mp, resp->file)) == -1) {
882: mandoc_msg(resp->ipath == SIZE_MAX ?
883: MANDOCERR_BADARG_BAD : MANDOCERR_OPEN,
884: 0, 0, "%s", strerror(errno));
885: mandoc_msg_setinfilename(NULL);
886: return;
887: }
888: } else
889: fd = STDIN_FILENO;
890:
1.347 schwarze 891: if (outst->use_pager) {
892: outst->use_pager = 0;
1.352 schwarze 893: outst->tag_files = term_tag_init(conf->output.outfilename,
1.354 schwarze 894: outst->outtype == OUTT_HTML ? ".html" : "",
1.352 schwarze 895: conf->output.tagfilename);
1.353 schwarze 896: #if HAVE_PLEDGE
1.352 schwarze 897: if ((conf->output.outfilename != NULL ||
898: conf->output.tagfilename != NULL) &&
899: pledge("stdio rpath cpath", NULL) == -1) {
900: mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
901: "%s", strerror(errno));
902: exit(mandoc_msg_getrc());
903: }
1.353 schwarze 904: #endif
1.347 schwarze 905: }
906: if (outst->had_output && outst->outtype <= OUTT_UTF8) {
907: if (outst->outdata == NULL)
908: outdata_alloc(outst, &conf->output);
909: terminal_sepline(outst->outdata);
1.337 schwarze 910: }
911:
912: if (resp->form == FORM_SRC)
1.355 schwarze 913: parse(mp, fd, resp->file, outst, conf);
1.337 schwarze 914: else {
915: passthrough(fd, conf->output.synopsisonly);
916: outst->had_output = 1;
917: }
918:
919: if (ferror(stdout)) {
920: if (outst->tag_files != NULL) {
921: mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s",
922: outst->tag_files->ofn, strerror(errno));
1.345 schwarze 923: term_tag_unlink();
1.337 schwarze 924: outst->tag_files = NULL;
925: } else
926: mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s",
927: strerror(errno));
928: }
929: mandoc_msg_setinfilename(NULL);
930: }
931:
932: static void
1.335 schwarze 933: parse(struct mparse *mp, int fd, const char *file,
1.355 schwarze 934: struct outstate *outst, struct manconf *conf)
1.1 kristaps 935: {
1.355 schwarze 936: static struct manpaths basepaths;
1.337 schwarze 937: static int previous;
938: struct roff_meta *meta;
1.112 kristaps 939:
1.337 schwarze 940: assert(fd >= 0);
941: if (file == NULL)
942: file = "<stdin>";
1.112 kristaps 943:
1.337 schwarze 944: if (previous)
945: mparse_reset(mp);
946: else
947: previous = 1;
1.112 kristaps 948:
1.334 schwarze 949: mparse_readfd(mp, fd, file);
1.261 schwarze 950: if (fd != STDIN_FILENO)
951: close(fd);
1.112 kristaps 952:
1.1 kristaps 953: /*
1.154 kristaps 954: * With -Wstop and warnings or errors of at least the requested
955: * level, do not produce output.
1.1 kristaps 956: */
957:
1.335 schwarze 958: if (outst->wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
1.227 schwarze 959: return;
1.111 kristaps 960:
1.335 schwarze 961: if (outst->outdata == NULL)
1.355 schwarze 962: outdata_alloc(outst, &conf->output);
1.335 schwarze 963: else if (outst->outtype == OUTT_HTML)
1.349 schwarze 964: html_reset(outst->outdata);
1.111 kristaps 965:
1.315 schwarze 966: mandoc_xr_reset();
1.334 schwarze 967: meta = mparse_result(mp);
1.250 schwarze 968:
969: /* Execute the out device, if it exists. */
970:
1.337 schwarze 971: outst->had_output = 1;
1.315 schwarze 972: if (meta->macroset == MACROSET_MDOC) {
1.335 schwarze 973: switch (outst->outtype) {
1.173 schwarze 974: case OUTT_HTML:
1.335 schwarze 975: html_mdoc(outst->outdata, meta);
1.111 kristaps 976: break;
1.173 schwarze 977: case OUTT_TREE:
1.335 schwarze 978: tree_mdoc(outst->outdata, meta);
1.111 kristaps 979: break;
1.173 schwarze 980: case OUTT_MAN:
1.335 schwarze 981: man_mdoc(outst->outdata, meta);
1.164 schwarze 982: break;
1.173 schwarze 983: case OUTT_PDF:
984: case OUTT_ASCII:
985: case OUTT_UTF8:
986: case OUTT_LOCALE:
987: case OUTT_PS:
1.335 schwarze 988: terminal_mdoc(outst->outdata, meta);
1.250 schwarze 989: break;
1.285 schwarze 990: case OUTT_MARKDOWN:
1.335 schwarze 991: markdown_mdoc(outst->outdata, meta);
1.285 schwarze 992: break;
1.250 schwarze 993: default:
994: break;
995: }
996: }
1.315 schwarze 997: if (meta->macroset == MACROSET_MAN) {
1.335 schwarze 998: switch (outst->outtype) {
1.250 schwarze 999: case OUTT_HTML:
1.335 schwarze 1000: html_man(outst->outdata, meta);
1.250 schwarze 1001: break;
1002: case OUTT_TREE:
1.335 schwarze 1003: tree_man(outst->outdata, meta);
1.250 schwarze 1004: break;
1005: case OUTT_MAN:
1.334 schwarze 1006: mparse_copy(mp);
1.250 schwarze 1007: break;
1008: case OUTT_PDF:
1009: case OUTT_ASCII:
1010: case OUTT_UTF8:
1011: case OUTT_LOCALE:
1012: case OUTT_PS:
1.335 schwarze 1013: terminal_man(outst->outdata, meta);
1.356 schwarze 1014: break;
1015: case OUTT_MARKDOWN:
1016: mandoc_msg(MANDOCERR_MAN_TMARKDOWN, 0, 0, NULL);
1.111 kristaps 1017: break;
1018: default:
1019: break;
1020: }
1.276 schwarze 1021: }
1.355 schwarze 1022: if (conf->output.tag != NULL && conf->output.tag_found == 0 &&
1023: tag_exists(conf->output.tag))
1024: conf->output.tag_found = 1;
1025:
1026: if (mandoc_msg_getmin() < MANDOCERR_STYLE) {
1027: if (basepaths.sz == 0)
1028: manpath_base(&basepaths);
1029: check_xr(&basepaths);
1030: } else if (mandoc_msg_getmin() < MANDOCERR_WARNING)
1031: check_xr(&conf->manpath);
1.294 schwarze 1032: }
1033:
1034: static void
1.355 schwarze 1035: check_xr(struct manpaths *paths)
1.294 schwarze 1036: {
1037: struct mansearch search;
1038: struct mandoc_xr *xr;
1039: size_t sz;
1040:
1041: for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) {
1.297 schwarze 1042: if (xr->line == -1)
1043: continue;
1.294 schwarze 1044: search.arch = NULL;
1045: search.sec = xr->sec;
1046: search.outkey = NULL;
1047: search.argmode = ARG_NAME;
1048: search.firstmatch = 1;
1.355 schwarze 1049: if (mansearch(&search, paths, 1, &xr->name, NULL, &sz))
1.295 schwarze 1050: continue;
1.355 schwarze 1051: if (fs_search(&search, paths, xr->name, NULL, &sz) != -1)
1.294 schwarze 1052: continue;
1.298 schwarze 1053: if (xr->count == 1)
1.313 schwarze 1054: mandoc_msg(MANDOCERR_XR_BAD, xr->line,
1055: xr->pos + 1, "Xr %s %s", xr->name, xr->sec);
1.298 schwarze 1056: else
1.313 schwarze 1057: mandoc_msg(MANDOCERR_XR_BAD, xr->line,
1058: xr->pos + 1, "Xr %s %s (%d times)",
1.298 schwarze 1059: xr->name, xr->sec, xr->count);
1.294 schwarze 1060: }
1.276 schwarze 1061: }
1062:
1063: static void
1.335 schwarze 1064: outdata_alloc(struct outstate *outst, struct manoutput *outconf)
1.276 schwarze 1065: {
1.335 schwarze 1066: switch (outst->outtype) {
1.276 schwarze 1067: case OUTT_HTML:
1.335 schwarze 1068: outst->outdata = html_alloc(outconf);
1.276 schwarze 1069: break;
1070: case OUTT_UTF8:
1.335 schwarze 1071: outst->outdata = utf8_alloc(outconf);
1.276 schwarze 1072: break;
1073: case OUTT_LOCALE:
1.335 schwarze 1074: outst->outdata = locale_alloc(outconf);
1.276 schwarze 1075: break;
1076: case OUTT_ASCII:
1.335 schwarze 1077: outst->outdata = ascii_alloc(outconf);
1.276 schwarze 1078: break;
1079: case OUTT_PDF:
1.335 schwarze 1080: outst->outdata = pdf_alloc(outconf);
1.276 schwarze 1081: break;
1082: case OUTT_PS:
1.335 schwarze 1083: outst->outdata = ps_alloc(outconf);
1.276 schwarze 1084: break;
1085: default:
1086: break;
1.111 kristaps 1087: }
1.186 schwarze 1088: }
1089:
1.227 schwarze 1090: static void
1.329 schwarze 1091: passthrough(int fd, int synopsis_only)
1.186 schwarze 1092: {
1.197 schwarze 1093: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
1094: const char synr[] = "SYNOPSIS";
1095:
1096: FILE *stream;
1.257 schwarze 1097: char *line, *cp;
1098: size_t linesz;
1.277 schwarze 1099: ssize_t len, written;
1.329 schwarze 1100: int lno, print;
1.210 schwarze 1101:
1.329 schwarze 1102: stream = NULL;
1.257 schwarze 1103: line = NULL;
1104: linesz = 0;
1.197 schwarze 1105:
1.277 schwarze 1106: if (fflush(stdout) == EOF) {
1.329 schwarze 1107: mandoc_msg(MANDOCERR_FFLUSH, 0, 0, "%s", strerror(errno));
1108: goto done;
1.277 schwarze 1109: }
1.197 schwarze 1110: if ((stream = fdopen(fd, "r")) == NULL) {
1111: close(fd);
1.329 schwarze 1112: mandoc_msg(MANDOCERR_FDOPEN, 0, 0, "%s", strerror(errno));
1113: goto done;
1.197 schwarze 1114: }
1.186 schwarze 1115:
1.329 schwarze 1116: lno = print = 0;
1.277 schwarze 1117: while ((len = getline(&line, &linesz, stream)) != -1) {
1.329 schwarze 1118: lno++;
1.257 schwarze 1119: cp = line;
1.197 schwarze 1120: if (synopsis_only) {
1121: if (print) {
1.257 schwarze 1122: if ( ! isspace((unsigned char)*cp))
1.197 schwarze 1123: goto done;
1.277 schwarze 1124: while (isspace((unsigned char)*cp)) {
1.257 schwarze 1125: cp++;
1.277 schwarze 1126: len--;
1127: }
1.197 schwarze 1128: } else {
1.257 schwarze 1129: if (strcmp(cp, synb) == 0 ||
1130: strcmp(cp, synr) == 0)
1.197 schwarze 1131: print = 1;
1132: continue;
1133: }
1134: }
1.277 schwarze 1135: for (; len > 0; len -= written) {
1.329 schwarze 1136: if ((written = write(STDOUT_FILENO, cp, len)) == -1) {
1137: mandoc_msg(MANDOCERR_WRITE, 0, 0,
1138: "%s", strerror(errno));
1139: goto done;
1140: }
1.257 schwarze 1141: }
1.197 schwarze 1142: }
1.329 schwarze 1143: if (ferror(stream))
1144: mandoc_msg(MANDOCERR_GETLINE, lno, 0, "%s", strerror(errno));
1.193 schwarze 1145:
1.197 schwarze 1146: done:
1.257 schwarze 1147: free(line);
1.329 schwarze 1148: if (stream != NULL)
1149: fclose(stream);
1.1 kristaps 1150: }
1151:
1152: static int
1.334 schwarze 1153: woptions(char *arg, enum mandoc_os *os_e, int *wstop)
1.1 kristaps 1154: {
1.34 kristaps 1155: char *v, *o;
1.293 schwarze 1156: const char *toks[11];
1.1 kristaps 1157:
1.103 schwarze 1158: toks[0] = "stop";
1159: toks[1] = "all";
1.293 schwarze 1160: toks[2] = "base";
1161: toks[3] = "style";
1162: toks[4] = "warning";
1163: toks[5] = "error";
1164: toks[6] = "unsupp";
1165: toks[7] = "fatal";
1166: toks[8] = "openbsd";
1167: toks[9] = "netbsd";
1168: toks[10] = NULL;
1.1 kristaps 1169:
1.34 kristaps 1170: while (*arg) {
1171: o = arg;
1.272 schwarze 1172: switch (getsubopt(&arg, (char * const *)toks, &v)) {
1.173 schwarze 1173: case 0:
1.334 schwarze 1174: *wstop = 1;
1.1 kristaps 1175: break;
1.173 schwarze 1176: case 1:
1177: case 2:
1.312 schwarze 1178: mandoc_msg_setmin(MANDOCERR_BASE);
1.290 schwarze 1179: break;
1180: case 3:
1.312 schwarze 1181: mandoc_msg_setmin(MANDOCERR_STYLE);
1.1 kristaps 1182: break;
1.290 schwarze 1183: case 4:
1.312 schwarze 1184: mandoc_msg_setmin(MANDOCERR_WARNING);
1.24 kristaps 1185: break;
1.290 schwarze 1186: case 5:
1.312 schwarze 1187: mandoc_msg_setmin(MANDOCERR_ERROR);
1.217 schwarze 1188: break;
1.290 schwarze 1189: case 6:
1.312 schwarze 1190: mandoc_msg_setmin(MANDOCERR_UNSUPP);
1.293 schwarze 1191: break;
1192: case 7:
1.329 schwarze 1193: mandoc_msg_setmin(MANDOCERR_BADARG);
1.293 schwarze 1194: break;
1195: case 8:
1.312 schwarze 1196: mandoc_msg_setmin(MANDOCERR_BASE);
1.334 schwarze 1197: *os_e = MANDOC_OS_OPENBSD;
1.293 schwarze 1198: break;
1199: case 9:
1.312 schwarze 1200: mandoc_msg_setmin(MANDOCERR_BASE);
1.334 schwarze 1201: *os_e = MANDOC_OS_NETBSD;
1.50 kristaps 1202: break;
1.1 kristaps 1203: default:
1.329 schwarze 1204: mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, "-W %s", o);
1205: return -1;
1.1 kristaps 1206: }
1.34 kristaps 1207: }
1.329 schwarze 1208: return 0;
1.333 schwarze 1209: }
1210:
1211: /*
1212: * Wait until moved to the foreground,
1213: * then fork the pager and wait for the user to close it.
1214: */
1215: static void
1.350 schwarze 1216: run_pager(struct outstate *outst, char *tag_target)
1.333 schwarze 1217: {
1218: int signum, status;
1219: pid_t man_pgid, tc_pgid;
1220: pid_t pager_pid, wait_pid;
1221:
1222: man_pgid = getpgid(0);
1.350 schwarze 1223: outst->tag_files->tcpgid =
1224: man_pgid == getpid() ? getpgid(getppid()) : man_pgid;
1.333 schwarze 1225: pager_pid = 0;
1226: signum = SIGSTOP;
1227:
1228: for (;;) {
1229: /* Stop here until moved to the foreground. */
1230:
1.348 schwarze 1231: tc_pgid = tcgetpgrp(STDOUT_FILENO);
1.333 schwarze 1232: if (tc_pgid != man_pgid) {
1233: if (tc_pgid == pager_pid) {
1.348 schwarze 1234: (void)tcsetpgrp(STDOUT_FILENO, man_pgid);
1.333 schwarze 1235: if (signum == SIGTTIN)
1236: continue;
1237: } else
1.350 schwarze 1238: outst->tag_files->tcpgid = tc_pgid;
1.333 schwarze 1239: kill(0, signum);
1240: continue;
1241: }
1242:
1243: /* Once in the foreground, activate the pager. */
1244:
1245: if (pager_pid) {
1.348 schwarze 1246: (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
1.333 schwarze 1247: kill(pager_pid, SIGCONT);
1248: } else
1.350 schwarze 1249: pager_pid = spawn_pager(outst, tag_target);
1.333 schwarze 1250:
1251: /* Wait for the pager to stop or exit. */
1252:
1253: while ((wait_pid = waitpid(pager_pid, &status,
1254: WUNTRACED)) == -1 && errno == EINTR)
1255: continue;
1256:
1257: if (wait_pid == -1) {
1258: mandoc_msg(MANDOCERR_WAIT, 0, 0,
1259: "%s", strerror(errno));
1260: break;
1261: }
1262: if (!WIFSTOPPED(status))
1263: break;
1264:
1265: signum = WSTOPSIG(status);
1266: }
1.183 schwarze 1267: }
1268:
1.225 schwarze 1269: static pid_t
1.350 schwarze 1270: spawn_pager(struct outstate *outst, char *tag_target)
1.183 schwarze 1271: {
1.265 schwarze 1272: const struct timespec timeout = { 0, 100000000 }; /* 0.1s */
1.184 schwarze 1273: #define MAX_PAGER_ARGS 16
1274: char *argv[MAX_PAGER_ARGS];
1275: const char *pager;
1276: char *cp;
1.322 schwarze 1277: #if HAVE_LESS_T
1.239 schwarze 1278: size_t cmdlen;
1.322 schwarze 1279: #endif
1.309 schwarze 1280: int argc, use_ofn;
1.225 schwarze 1281: pid_t pager_pid;
1.183 schwarze 1282:
1.350 schwarze 1283: assert(outst->tag_files->ofd == -1);
1284: assert(outst->tag_files->tfs == NULL);
1.348 schwarze 1285:
1.239 schwarze 1286: pager = getenv("MANPAGER");
1287: if (pager == NULL || *pager == '\0')
1288: pager = getenv("PAGER");
1289: if (pager == NULL || *pager == '\0')
1.351 schwarze 1290: pager = BINM_PAGER;
1.239 schwarze 1291: cp = mandoc_strdup(pager);
1292:
1293: /*
1294: * Parse the pager command into words.
1295: * Intentionally do not do anything fancy here.
1296: */
1297:
1298: argc = 0;
1.309 schwarze 1299: while (argc + 5 < MAX_PAGER_ARGS) {
1.239 schwarze 1300: argv[argc++] = cp;
1301: cp = strchr(cp, ' ');
1302: if (cp == NULL)
1303: break;
1304: *cp++ = '\0';
1305: while (*cp == ' ')
1306: cp++;
1307: if (*cp == '\0')
1308: break;
1309: }
1310:
1.268 schwarze 1311: /* For less(1), use the tag file. */
1.239 schwarze 1312:
1.309 schwarze 1313: use_ofn = 1;
1.322 schwarze 1314: #if HAVE_LESS_T
1.350 schwarze 1315: if (*outst->tag_files->tfn != '\0' &&
1316: (cmdlen = strlen(argv[0])) >= 4) {
1.239 schwarze 1317: cp = argv[0] + cmdlen - 4;
1.268 schwarze 1318: if (strcmp(cp, "less") == 0) {
1.244 schwarze 1319: argv[argc++] = mandoc_strdup("-T");
1.350 schwarze 1320: argv[argc++] = outst->tag_files->tfn;
1.348 schwarze 1321: if (tag_target != NULL) {
1.309 schwarze 1322: argv[argc++] = mandoc_strdup("-t");
1.348 schwarze 1323: argv[argc++] = tag_target;
1.309 schwarze 1324: use_ofn = 0;
1325: }
1.244 schwarze 1326: }
1.239 schwarze 1327: }
1.322 schwarze 1328: #endif
1.350 schwarze 1329: if (use_ofn) {
1330: if (outst->outtype == OUTT_HTML && tag_target != NULL)
1331: mandoc_asprintf(&argv[argc], "file://%s#%s",
1332: outst->tag_files->ofn, tag_target);
1333: else
1334: argv[argc] = outst->tag_files->ofn;
1335: argc++;
1336: }
1.239 schwarze 1337: argv[argc] = NULL;
1338:
1.225 schwarze 1339: switch (pager_pid = fork()) {
1.183 schwarze 1340: case -1:
1.329 schwarze 1341: mandoc_msg(MANDOCERR_FORK, 0, 0, "%s", strerror(errno));
1342: exit(mandoc_msg_getrc());
1.183 schwarze 1343: case 0:
1.224 schwarze 1344: break;
1345: default:
1.258 schwarze 1346: (void)setpgid(pager_pid, 0);
1.348 schwarze 1347: (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
1.255 schwarze 1348: #if HAVE_PLEDGE
1.329 schwarze 1349: if (pledge("stdio rpath tmppath tty proc", NULL) == -1) {
1350: mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
1351: "%s", strerror(errno));
1352: exit(mandoc_msg_getrc());
1353: }
1.255 schwarze 1354: #endif
1.350 schwarze 1355: outst->tag_files->pager_pid = pager_pid;
1.245 schwarze 1356: return pager_pid;
1.184 schwarze 1357: }
1358:
1.348 schwarze 1359: /*
1360: * The child process becomes the pager.
1361: * Do not start it before controlling the terminal.
1362: */
1.265 schwarze 1363:
1.279 schwarze 1364: while (tcgetpgrp(STDOUT_FILENO) != getpid())
1.265 schwarze 1365: nanosleep(&timeout, NULL);
1366:
1.184 schwarze 1367: execvp(argv[0], argv);
1.329 schwarze 1368: mandoc_msg(MANDOCERR_EXEC, 0, 0, "%s: %s", argv[0], strerror(errno));
1369: _exit(mandoc_msg_getrc());
1.71 kristaps 1370: }
CVSweb