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