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