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