Annotation of src/usr.bin/mandoc/main.c, Revision 1.264
1.264 ! millert 1: /* $OpenBSD: main.c,v 1.263 2023/09/04 13:08:11 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.264 ! millert 393:
! 394: /* Avoid repeated TZ lookups, especially for makewhatis. */
! 395: tzset();
1.95 schwarze 396:
1.110 schwarze 397: /*
1.241 schwarze 398: * Quirks for help(1) and man(1),
399: * in particular for a section argument without -s.
1.110 schwarze 400: */
401:
402: if (search.argmode == ARG_NAME) {
1.162 schwarze 403: if (*progname == 'h') {
1.110 schwarze 404: if (argc == 0) {
405: argv = help_argv;
406: argc = 1;
407: }
1.117 schwarze 408: } else if (argc > 1 &&
1.128 schwarze 409: ((uc = (unsigned char *)argv[0]) != NULL) &&
1.113 schwarze 410: ((isdigit(uc[0]) && (uc[1] == '\0' ||
1.226 schwarze 411: isalpha(uc[1]))) ||
1.113 schwarze 412: (uc[0] == 'n' && uc[1] == '\0'))) {
1.128 schwarze 413: search.sec = (char *)uc;
1.110 schwarze 414: argv++;
415: argc--;
416: }
1.122 schwarze 417: if (search.arch == NULL)
418: search.arch = getenv("MACHINE");
419: if (search.arch == NULL)
420: search.arch = MACHINE;
1.241 schwarze 421: if (outmode == OUTMODE_ONE)
422: search.firstmatch = 1;
1.95 schwarze 423: }
424:
1.219 schwarze 425: /*
426: * Use the first argument for -O tag in addition to
427: * using it as a search term for man(1) or apropos(1).
428: */
429:
430: if (conf.output.tag != NULL && *conf.output.tag == '\0') {
431: tagarg = argc > 0 && search.argmode == ARG_EXPR ?
432: strchr(*argv, '=') : NULL;
433: conf.output.tag = tagarg == NULL ? *argv : tagarg + 1;
434: }
435:
1.241 schwarze 436: /* Read the configuration file. */
1.95 schwarze 437:
1.257 schwarze 438: if (search.argmode != ARG_FILE ||
439: mandoc_msg_getmin() == MANDOCERR_STYLE)
1.241 schwarze 440: manconf_parse(&conf, conf_file, defpaths, auxpaths);
1.95 schwarze 441:
1.241 schwarze 442: /* man(1): Resolve each name individually. */
1.95 schwarze 443:
1.241 schwarze 444: if (search.argmode == ARG_NAME) {
1.246 schwarze 445: if (argc < 1) {
446: if (outmode != OUTMODE_FLN)
447: usage(ARG_NAME);
448: if (conf.manpath.sz == 0) {
449: warnx("The manpath is empty.");
450: mandoc_msg_setrc(MANDOCLEVEL_BADARG);
451: } else {
452: for (i = 0; i + 1 < conf.manpath.sz; i++)
453: printf("%s:", conf.manpath.paths[i]);
454: printf("%s\n", conf.manpath.paths[i]);
455: }
456: manconf_free(&conf);
457: return (int)mandoc_msg_getrc();
458: }
1.241 schwarze 459: for (res = NULL, ressz = 0; argc > 0; argc--, argv++) {
460: (void)mansearch(&search, &conf.manpath,
461: 1, argv, &resn, &resnsz);
462: if (resnsz == 0)
463: (void)fs_search(&search, &conf.manpath,
1.243 schwarze 464: *argv, &resn, &resnsz);
465: if (resnsz == 0 && strchr(*argv, '/') == NULL) {
466: if (search.arch != NULL &&
467: arch_valid(search.arch, OSENUM) == 0)
468: warnx("Unknown architecture \"%s\".",
469: search.arch);
470: else if (search.sec != NULL)
471: warnx("No entry for %s in "
472: "section %s of the manual.",
473: *argv, search.sec);
474: else
475: warnx("No entry for %s in "
476: "the manual.", *argv);
477: mandoc_msg_setrc(MANDOCLEVEL_BADARG);
478: continue;
479: }
1.241 schwarze 480: if (resnsz == 0) {
481: if (access(*argv, R_OK) == -1) {
482: mandoc_msg_setinfilename(*argv);
1.231 schwarze 483: mandoc_msg(MANDOCERR_BADARG_BAD,
484: 0, 0, "%s", strerror(errno));
485: mandoc_msg_setinfilename(NULL);
1.208 schwarze 486: continue;
487: }
1.241 schwarze 488: resnsz = 1;
489: resn = mandoc_calloc(resnsz, sizeof(*res));
490: resn->file = mandoc_strdup(*argv);
491: resn->ipath = SIZE_MAX;
492: resn->form = FORM_SRC;
493: }
494: if (outmode != OUTMODE_ONE || resnsz == 1) {
1.208 schwarze 495: res = mandoc_reallocarray(res,
1.241 schwarze 496: ressz + resnsz, sizeof(*res));
497: memcpy(res + ressz, resn,
498: sizeof(*resn) * resnsz);
499: ressz += resnsz;
1.261 schwarze 500: free(resn);
501: resn = NULL;
502: resnsz = 0;
1.241 schwarze 503: continue;
1.208 schwarze 504: }
1.95 schwarze 505:
1.241 schwarze 506: /* Search for the best section. */
1.95 schwarze 507:
1.227 schwarze 508: best_prio = 40;
1.241 schwarze 509: for (ib = i = 0; i < resnsz; i++) {
1.263 schwarze 510: sec = resn[i].file +
511: strlen(conf.manpath.paths[resn[i].ipath]);
1.171 schwarze 512: sec += strcspn(sec, "123456789");
513: if (sec[0] == '\0')
1.227 schwarze 514: continue; /* No section at all. */
1.171 schwarze 515: prio = sec_prios[sec[0] - '1'];
1.227 schwarze 516: if (search.sec != NULL) {
517: ssz = strlen(search.sec);
518: if (strncmp(sec, search.sec, ssz) == 0)
519: sec += ssz;
520: } else
521: sec++; /* Prefer without suffix. */
522: if (*sec != '/')
523: prio += 10; /* Wrong dir name. */
1.260 schwarze 524: if (search.sec != NULL) {
525: ep = strchr(sec, '\0');
526: if (ep - sec > 3 &&
527: strncmp(ep - 3, ".gz", 3) == 0)
528: ep -= 3;
529: if ((size_t)(ep - sec) < ssz + 3 ||
530: strncmp(ep - ssz, search.sec,
531: ssz) != 0) /* Wrong file */
532: prio += 20; /* extension. */
533: }
1.95 schwarze 534: if (prio >= best_prio)
535: continue;
536: best_prio = prio;
1.241 schwarze 537: ib = i;
1.95 schwarze 538: }
1.241 schwarze 539: res = mandoc_reallocarray(res, ressz + 1,
540: sizeof(*res));
541: memcpy(res + ressz++, resn + ib, sizeof(*resn));
1.261 schwarze 542: memset(resn + ib, 0, sizeof(*resn));
543: mansearch_free(resn, resnsz);
544: resn = NULL;
545: resnsz = 0;
1.1 kristaps 546: }
547:
1.241 schwarze 548: /* apropos(1), whatis(1): Process the full search expression. */
549:
550: } else if (search.argmode != ARG_FILE) {
551: if (mansearch(&search, &conf.manpath,
552: argc, argv, &res, &ressz) == 0)
553: usage(search.argmode);
1.95 schwarze 554:
1.241 schwarze 555: if (ressz == 0) {
556: warnx("nothing appropriate");
557: mandoc_msg_setrc(MANDOCLEVEL_BADARG);
1.95 schwarze 558: goto out;
1.241 schwarze 559: }
560:
561: /* mandoc(1): Take command line arguments as file names. */
562:
1.240 schwarze 563: } else {
1.241 schwarze 564: ressz = argc > 0 ? argc : 1;
565: res = mandoc_calloc(ressz, sizeof(*res));
566: for (i = 0; i < ressz; i++) {
1.240 schwarze 567: if (argc > 0)
568: res[i].file = mandoc_strdup(argv[i]);
569: res[i].ipath = SIZE_MAX;
570: res[i].form = FORM_SRC;
571: }
1.95 schwarze 572: }
573:
1.241 schwarze 574: switch (outmode) {
575: case OUTMODE_FLN:
576: for (i = 0; i < ressz; i++)
577: puts(res[i].file);
578: goto out;
579: case OUTMODE_LST:
580: for (i = 0; i < ressz; i++)
581: printf("%s - %s\n", res[i].names,
582: res[i].output == NULL ? "" :
583: res[i].output);
584: goto out;
585: default:
586: break;
1.167 schwarze 587: }
1.95 schwarze 588:
1.231 schwarze 589: if (search.argmode == ARG_FILE && auxpaths != NULL) {
590: if (strcmp(auxpaths, "doc") == 0)
591: options |= MPARSE_MDOC;
592: else if (strcmp(auxpaths, "an") == 0)
593: options |= MPARSE_MAN;
594: }
1.146 schwarze 595:
1.155 schwarze 596: mchars_alloc();
1.237 schwarze 597: mp = mparse_alloc(options, os_e, os_s);
1.76 schwarze 598:
1.208 schwarze 599: /*
600: * Remember the original working directory, if possible.
601: * This will be needed if some names on the command line
602: * are page names and some are relative file names.
603: * Do not error out if the current directory is not
604: * readable: Maybe it won't be needed after all.
605: */
606: startdir = open(".", O_RDONLY | O_DIRECTORY);
1.241 schwarze 607: for (i = 0; i < ressz; i++) {
608: process_onefile(mp, res + i, startdir, &outst, &conf);
1.238 schwarze 609: if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
1.27 schwarze 610: break;
1.1 kristaps 611: }
1.208 schwarze 612: if (startdir != -1) {
613: (void)fchdir(startdir);
614: close(startdir);
615: }
1.251 schwarze 616: if (conf.output.tag != NULL && conf.output.tag_found == 0) {
617: mandoc_msg(MANDOCERR_TAG, 0, 0, "%s", conf.output.tag);
618: conf.output.tag = NULL;
619: }
1.238 schwarze 620: if (outst.outdata != NULL) {
621: switch (outst.outtype) {
1.160 schwarze 622: case OUTT_HTML:
1.238 schwarze 623: html_free(outst.outdata);
1.160 schwarze 624: break;
625: case OUTT_UTF8:
626: case OUTT_LOCALE:
627: case OUTT_ASCII:
1.238 schwarze 628: ascii_free(outst.outdata);
1.160 schwarze 629: break;
630: case OUTT_PDF:
631: case OUTT_PS:
1.238 schwarze 632: pspdf_free(outst.outdata);
1.160 schwarze 633: break;
634: default:
635: break;
636: }
1.158 schwarze 637: }
1.197 schwarze 638: mandoc_xr_free();
1.237 schwarze 639: mparse_free(mp);
1.155 schwarze 640: mchars_free();
1.95 schwarze 641:
642: out:
1.241 schwarze 643: mansearch_free(res, ressz);
1.240 schwarze 644: if (search.argmode != ARG_FILE)
1.134 schwarze 645: manconf_free(&conf);
1.1 kristaps 646:
1.239 schwarze 647: if (outst.tag_files != NULL) {
1.255 schwarze 648: if (term_tag_close() != -1 &&
649: conf.output.outfilename == NULL &&
650: conf.output.tagfilename == NULL)
1.253 schwarze 651: run_pager(&outst, conf.output.tag);
1.248 schwarze 652: term_tag_unlink();
1.240 schwarze 653: } else if (outst.had_output && outst.outtype != OUTT_LINT)
1.232 schwarze 654: mandoc_msg_summary();
655:
1.215 schwarze 656: return (int)mandoc_msg_getrc();
1.1 kristaps 657: }
658:
1.20 schwarze 659: static void
1.95 schwarze 660: usage(enum argmode argmode)
1.1 kristaps 661: {
1.95 schwarze 662: switch (argmode) {
663: case ARG_FILE:
1.190 schwarze 664: fputs("usage: mandoc [-ac] [-I os=name] "
665: "[-K encoding] [-mdoc | -man] [-O options]\n"
1.133 schwarze 666: "\t [-T output] [-W level] [file ...]\n", stderr);
1.95 schwarze 667: break;
668: case ARG_NAME:
1.190 schwarze 669: fputs("usage: man [-acfhklw] [-C file] [-M path] "
670: "[-m path] [-S subsection]\n"
671: "\t [[-s] section] name ...\n", stderr);
1.95 schwarze 672: break;
673: case ARG_WORD:
1.190 schwarze 674: fputs("usage: whatis [-afk] [-C file] "
1.96 schwarze 675: "[-M path] [-m path] [-O outkey] [-S arch]\n"
676: "\t [-s section] name ...\n", stderr);
1.95 schwarze 677: break;
678: case ARG_EXPR:
1.190 schwarze 679: fputs("usage: apropos [-afk] [-C file] "
1.96 schwarze 680: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.95 schwarze 681: "\t [-s section] expression ...\n", stderr);
682: break;
683: }
1.47 schwarze 684: exit((int)MANDOCLEVEL_BADARG);
1.119 schwarze 685: }
686:
1.247 schwarze 687: static void
688: glob_esc(char **dst, const char *src, const char *suffix)
689: {
690: while (*src != '\0') {
691: if (strchr("*?[", *src) != NULL)
692: *(*dst)++ = '\\';
693: *(*dst)++ = *src++;
694: }
695: while (*suffix != '\0')
696: *(*dst)++ = *suffix++;
697: }
698:
1.259 schwarze 699: static void
700: fs_append(char **file, size_t filesz, int copy, size_t ipath,
701: const char *sec, enum form form, struct manpage **res, size_t *ressz)
702: {
703: struct manpage *page;
704:
705: *res = mandoc_reallocarray(*res, *ressz + filesz, sizeof(**res));
706: page = *res + *ressz;
707: *ressz += filesz;
708: for (;;) {
709: page->file = copy ? mandoc_strdup(*file) : *file;
710: page->names = NULL;
711: page->output = NULL;
712: page->bits = NAME_FILE & NAME_MASK;
713: page->ipath = ipath;
714: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
715: page->form = form;
716: if (--filesz == 0)
717: break;
718: file++;
719: page++;
720: }
721: }
722:
1.119 schwarze 723: static int
724: fs_lookup(const struct manpaths *paths, size_t ipath,
725: const char *sec, const char *arch, const char *name,
726: struct manpage **res, size_t *ressz)
727: {
1.228 schwarze 728: struct stat sb;
1.127 schwarze 729: glob_t globinfo;
1.259 schwarze 730: char *file, *cp, secnum[2];
1.177 schwarze 731: int globres;
732: enum form form;
1.119 schwarze 733:
1.247 schwarze 734: const char *const slman = "/man";
735: const char *const slash = "/";
736: const char *const sglob = ".[01-9]*";
1.259 schwarze 737: const char *const dot = ".";
738: const char *const aster = "*";
1.247 schwarze 739:
1.259 schwarze 740: memset(&globinfo, 0, sizeof(globinfo));
1.127 schwarze 741: form = FORM_SRC;
1.259 schwarze 742:
1.119 schwarze 743: mandoc_asprintf(&file, "%s/man%s/%s.%s",
744: paths->paths[ipath], sec, name, sec);
1.228 schwarze 745: if (stat(file, &sb) != -1)
1.119 schwarze 746: goto found;
747: free(file);
748:
749: mandoc_asprintf(&file, "%s/cat%s/%s.0",
750: paths->paths[ipath], sec, name);
1.228 schwarze 751: if (stat(file, &sb) != -1) {
1.119 schwarze 752: form = FORM_CAT;
753: goto found;
754: }
755: free(file);
756:
757: if (arch != NULL) {
758: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
759: paths->paths[ipath], sec, arch, name, sec);
1.228 schwarze 760: if (stat(file, &sb) != -1)
1.119 schwarze 761: goto found;
762: free(file);
763: }
1.127 schwarze 764:
1.247 schwarze 765: cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
766: strlen(slman) + strlen(sec) * 2 + strlen(slash) +
767: strlen(name) * 2 + strlen(sglob) + 1);
768: glob_esc(&cp, paths->paths[ipath], slman);
769: glob_esc(&cp, sec, slash);
770: glob_esc(&cp, name, sglob);
771: *cp = '\0';
1.127 schwarze 772: globres = glob(file, 0, NULL, &globinfo);
773: if (globres != 0 && globres != GLOB_NOMATCH)
1.231 schwarze 774: mandoc_msg(MANDOCERR_GLOB, 0, 0,
775: "%s: %s", file, strerror(errno));
1.127 schwarze 776: free(file);
1.259 schwarze 777: file = NULL;
1.127 schwarze 778: if (globres == 0)
1.259 schwarze 779: goto found;
1.127 schwarze 780: globfree(&globinfo);
1.259 schwarze 781:
782: if (sec[1] != '\0' && *ressz == 0) {
783: secnum[0] = sec[0];
784: secnum[1] = '\0';
785: cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
786: strlen(slman) + strlen(secnum) * 2 + strlen(slash) +
787: strlen(name) * 2 + strlen(dot) +
788: strlen(sec) * 2 + strlen(aster) + 1);
789: glob_esc(&cp, paths->paths[ipath], slman);
790: glob_esc(&cp, secnum, slash);
791: glob_esc(&cp, name, dot);
792: glob_esc(&cp, sec, aster);
793: *cp = '\0';
794: globres = glob(file, 0, NULL, &globinfo);
795: if (globres != 0 && globres != GLOB_NOMATCH)
796: mandoc_msg(MANDOCERR_GLOB, 0, 0,
797: "%s: %s", file, strerror(errno));
798: free(file);
799: file = NULL;
800: if (globres == 0)
1.228 schwarze 801: goto found;
1.259 schwarze 802: globfree(&globinfo);
1.228 schwarze 803: }
1.259 schwarze 804:
1.199 schwarze 805: if (res != NULL || ipath + 1 != paths->sz)
1.231 schwarze 806: return -1;
1.119 schwarze 807:
1.199 schwarze 808: mandoc_asprintf(&file, "%s.%s", name, sec);
1.228 schwarze 809: globres = stat(file, &sb);
1.199 schwarze 810: free(file);
1.231 schwarze 811: return globres;
1.199 schwarze 812:
1.119 schwarze 813: found:
1.235 schwarze 814: warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
815: name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
1.259 schwarze 816: if (res == NULL)
1.199 schwarze 817: free(file);
1.259 schwarze 818: else if (file == NULL)
819: fs_append(globinfo.gl_pathv, globinfo.gl_pathc, 1,
820: ipath, sec, form, res, ressz);
821: else
822: fs_append(&file, 1, 0, ipath, sec, form, res, ressz);
823: globfree(&globinfo);
1.231 schwarze 824: return 0;
1.119 schwarze 825: }
826:
1.198 schwarze 827: static int
1.119 schwarze 828: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
1.243 schwarze 829: const char *name, struct manpage **res, size_t *ressz)
1.119 schwarze 830: {
831: const char *const sections[] =
1.171 schwarze 832: {"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"};
1.119 schwarze 833: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
834:
1.243 schwarze 835: size_t ipath, isec;
1.119 schwarze 836:
837: assert(cfg->argmode == ARG_NAME);
1.198 schwarze 838: if (res != NULL)
839: *res = NULL;
1.243 schwarze 840: *ressz = 0;
841: for (ipath = 0; ipath < paths->sz; ipath++) {
842: if (cfg->sec != NULL) {
843: if (fs_lookup(paths, ipath, cfg->sec, cfg->arch,
844: name, res, ressz) != -1 && cfg->firstmatch)
845: return 0;
846: } else {
847: for (isec = 0; isec < nsec; isec++)
1.119 schwarze 848: if (fs_lookup(paths, ipath, sections[isec],
1.243 schwarze 849: cfg->arch, name, res, ressz) != -1 &&
1.119 schwarze 850: cfg->firstmatch)
1.231 schwarze 851: return 0;
1.119 schwarze 852: }
853: }
1.231 schwarze 854: return -1;
1.1 kristaps 855: }
856:
1.27 schwarze 857: static void
1.240 schwarze 858: process_onefile(struct mparse *mp, struct manpage *resp, int startdir,
859: struct outstate *outst, struct manconf *conf)
860: {
861: int fd;
862:
863: /*
864: * Changing directories is not needed in ARG_FILE mode.
865: * Do it on a best-effort basis. Even in case of
866: * failure, some functionality may still work.
867: */
868: if (resp->ipath != SIZE_MAX)
869: (void)chdir(conf->manpath.paths[resp->ipath]);
870: else if (startdir != -1)
871: (void)fchdir(startdir);
872:
873: mandoc_msg_setinfilename(resp->file);
874: if (resp->file != NULL) {
875: if ((fd = mparse_open(mp, resp->file)) == -1) {
876: mandoc_msg(resp->ipath == SIZE_MAX ?
877: MANDOCERR_BADARG_BAD : MANDOCERR_OPEN,
878: 0, 0, "%s", strerror(errno));
879: mandoc_msg_setinfilename(NULL);
880: return;
881: }
882: } else
883: fd = STDIN_FILENO;
884:
1.250 schwarze 885: if (outst->use_pager) {
886: outst->use_pager = 0;
1.255 schwarze 887: outst->tag_files = term_tag_init(conf->output.outfilename,
1.256 kn 888: outst->outtype == OUTT_HTML ? ".html" : "",
1.255 schwarze 889: conf->output.tagfilename);
890: if ((conf->output.outfilename != NULL ||
891: conf->output.tagfilename != NULL) &&
892: pledge("stdio rpath cpath", NULL) == -1) {
893: mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
894: "%s", strerror(errno));
895: exit(mandoc_msg_getrc());
896: }
1.250 schwarze 897: }
898: if (outst->had_output && outst->outtype <= OUTT_UTF8) {
899: if (outst->outdata == NULL)
900: outdata_alloc(outst, &conf->output);
901: terminal_sepline(outst->outdata);
1.240 schwarze 902: }
903:
904: if (resp->form == FORM_SRC)
1.257 schwarze 905: parse(mp, fd, resp->file, outst, conf);
1.240 schwarze 906: else {
907: passthrough(fd, conf->output.synopsisonly);
908: outst->had_output = 1;
909: }
910:
911: if (ferror(stdout)) {
912: if (outst->tag_files != NULL) {
913: mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s",
914: outst->tag_files->ofn, strerror(errno));
1.248 schwarze 915: term_tag_unlink();
1.240 schwarze 916: outst->tag_files = NULL;
917: } else
918: mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s",
919: strerror(errno));
920: }
921: mandoc_msg_setinfilename(NULL);
922: }
923:
924: static void
1.238 schwarze 925: parse(struct mparse *mp, int fd, const char *file,
1.257 schwarze 926: struct outstate *outst, struct manconf *conf)
1.52 schwarze 927: {
1.257 schwarze 928: static struct manpaths basepaths;
1.240 schwarze 929: static int previous;
930: struct roff_meta *meta;
1.52 schwarze 931:
1.240 schwarze 932: assert(fd >= 0);
933: if (file == NULL)
934: file = "<stdin>";
1.52 schwarze 935:
1.240 schwarze 936: if (previous)
937: mparse_reset(mp);
938: else
939: previous = 1;
1.52 schwarze 940:
1.237 schwarze 941: mparse_readfd(mp, fd, file);
1.168 schwarze 942: if (fd != STDIN_FILENO)
943: close(fd);
1.1 kristaps 944:
1.51 schwarze 945: /*
1.76 schwarze 946: * With -Wstop and warnings or errors of at least the requested
947: * level, do not produce output.
1.51 schwarze 948: */
949:
1.238 schwarze 950: if (outst->wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
1.132 schwarze 951: return;
1.51 schwarze 952:
1.238 schwarze 953: if (outst->outdata == NULL)
1.257 schwarze 954: outdata_alloc(outst, &conf->output);
1.238 schwarze 955: else if (outst->outtype == OUTT_HTML)
1.252 otto 956: html_reset(outst->outdata);
1.51 schwarze 957:
1.218 schwarze 958: mandoc_xr_reset();
1.237 schwarze 959: meta = mparse_result(mp);
1.158 schwarze 960:
961: /* Execute the out device, if it exists. */
962:
1.240 schwarze 963: outst->had_output = 1;
1.218 schwarze 964: if (meta->macroset == MACROSET_MDOC) {
1.238 schwarze 965: switch (outst->outtype) {
1.90 schwarze 966: case OUTT_HTML:
1.238 schwarze 967: html_mdoc(outst->outdata, meta);
1.51 schwarze 968: break;
1.90 schwarze 969: case OUTT_TREE:
1.238 schwarze 970: tree_mdoc(outst->outdata, meta);
1.51 schwarze 971: break;
1.90 schwarze 972: case OUTT_MAN:
1.238 schwarze 973: man_mdoc(outst->outdata, meta);
1.78 schwarze 974: break;
1.90 schwarze 975: case OUTT_PDF:
976: case OUTT_ASCII:
977: case OUTT_UTF8:
978: case OUTT_LOCALE:
979: case OUTT_PS:
1.238 schwarze 980: terminal_mdoc(outst->outdata, meta);
1.158 schwarze 981: break;
1.188 schwarze 982: case OUTT_MARKDOWN:
1.238 schwarze 983: markdown_mdoc(outst->outdata, meta);
1.188 schwarze 984: break;
1.158 schwarze 985: default:
986: break;
987: }
988: }
1.218 schwarze 989: if (meta->macroset == MACROSET_MAN) {
1.238 schwarze 990: switch (outst->outtype) {
1.158 schwarze 991: case OUTT_HTML:
1.238 schwarze 992: html_man(outst->outdata, meta);
1.158 schwarze 993: break;
994: case OUTT_TREE:
1.238 schwarze 995: tree_man(outst->outdata, meta);
1.158 schwarze 996: break;
997: case OUTT_MAN:
1.237 schwarze 998: mparse_copy(mp);
1.158 schwarze 999: break;
1000: case OUTT_PDF:
1001: case OUTT_ASCII:
1002: case OUTT_UTF8:
1003: case OUTT_LOCALE:
1004: case OUTT_PS:
1.238 schwarze 1005: terminal_man(outst->outdata, meta);
1.258 schwarze 1006: break;
1007: case OUTT_MARKDOWN:
1008: mandoc_msg(MANDOCERR_MAN_TMARKDOWN, 0, 0, NULL);
1.51 schwarze 1009: break;
1010: default:
1011: break;
1012: }
1.179 schwarze 1013: }
1.257 schwarze 1014: if (conf->output.tag != NULL && conf->output.tag_found == 0 &&
1015: tag_exists(conf->output.tag))
1016: conf->output.tag_found = 1;
1017:
1018: if (mandoc_msg_getmin() < MANDOCERR_STYLE) {
1019: if (basepaths.sz == 0)
1020: manpath_base(&basepaths);
1021: check_xr(&basepaths);
1022: } else if (mandoc_msg_getmin() < MANDOCERR_WARNING)
1023: check_xr(&conf->manpath);
1.197 schwarze 1024: }
1025:
1026: static void
1.257 schwarze 1027: check_xr(struct manpaths *paths)
1.197 schwarze 1028: {
1029: struct mansearch search;
1030: struct mandoc_xr *xr;
1031: size_t sz;
1032:
1033: for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) {
1.200 schwarze 1034: if (xr->line == -1)
1035: continue;
1.197 schwarze 1036: search.arch = NULL;
1037: search.sec = xr->sec;
1038: search.outkey = NULL;
1039: search.argmode = ARG_NAME;
1040: search.firstmatch = 1;
1.257 schwarze 1041: if (mansearch(&search, paths, 1, &xr->name, NULL, &sz))
1.198 schwarze 1042: continue;
1.257 schwarze 1043: if (fs_search(&search, paths, xr->name, NULL, &sz) != -1)
1.197 schwarze 1044: continue;
1.201 schwarze 1045: if (xr->count == 1)
1.216 schwarze 1046: mandoc_msg(MANDOCERR_XR_BAD, xr->line,
1047: xr->pos + 1, "Xr %s %s", xr->name, xr->sec);
1.201 schwarze 1048: else
1.216 schwarze 1049: mandoc_msg(MANDOCERR_XR_BAD, xr->line,
1050: xr->pos + 1, "Xr %s %s (%d times)",
1.201 schwarze 1051: xr->name, xr->sec, xr->count);
1.197 schwarze 1052: }
1.179 schwarze 1053: }
1054:
1055: static void
1.238 schwarze 1056: outdata_alloc(struct outstate *outst, struct manoutput *outconf)
1.179 schwarze 1057: {
1.238 schwarze 1058: switch (outst->outtype) {
1.179 schwarze 1059: case OUTT_HTML:
1.238 schwarze 1060: outst->outdata = html_alloc(outconf);
1.179 schwarze 1061: break;
1062: case OUTT_UTF8:
1.238 schwarze 1063: outst->outdata = utf8_alloc(outconf);
1.179 schwarze 1064: break;
1065: case OUTT_LOCALE:
1.238 schwarze 1066: outst->outdata = locale_alloc(outconf);
1.179 schwarze 1067: break;
1068: case OUTT_ASCII:
1.238 schwarze 1069: outst->outdata = ascii_alloc(outconf);
1.179 schwarze 1070: break;
1071: case OUTT_PDF:
1.238 schwarze 1072: outst->outdata = pdf_alloc(outconf);
1.179 schwarze 1073: break;
1074: case OUTT_PS:
1.238 schwarze 1075: outst->outdata = ps_alloc(outconf);
1.179 schwarze 1076: break;
1077: default:
1078: break;
1.51 schwarze 1079: }
1.1 kristaps 1080: }
1081:
1.132 schwarze 1082: static void
1.231 schwarze 1083: passthrough(int fd, int synopsis_only)
1.95 schwarze 1084: {
1.105 schwarze 1085: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
1086: const char synr[] = "SYNOPSIS";
1087:
1088: FILE *stream;
1.164 schwarze 1089: char *line, *cp;
1090: size_t linesz;
1.180 schwarze 1091: ssize_t len, written;
1.231 schwarze 1092: int lno, print;
1.116 schwarze 1093:
1.231 schwarze 1094: stream = NULL;
1.164 schwarze 1095: line = NULL;
1096: linesz = 0;
1.105 schwarze 1097:
1.180 schwarze 1098: if (fflush(stdout) == EOF) {
1.231 schwarze 1099: mandoc_msg(MANDOCERR_FFLUSH, 0, 0, "%s", strerror(errno));
1100: goto done;
1.180 schwarze 1101: }
1.105 schwarze 1102: if ((stream = fdopen(fd, "r")) == NULL) {
1103: close(fd);
1.231 schwarze 1104: mandoc_msg(MANDOCERR_FDOPEN, 0, 0, "%s", strerror(errno));
1105: goto done;
1.105 schwarze 1106: }
1.95 schwarze 1107:
1.231 schwarze 1108: lno = print = 0;
1.180 schwarze 1109: while ((len = getline(&line, &linesz, stream)) != -1) {
1.231 schwarze 1110: lno++;
1.164 schwarze 1111: cp = line;
1.105 schwarze 1112: if (synopsis_only) {
1113: if (print) {
1.164 schwarze 1114: if ( ! isspace((unsigned char)*cp))
1.105 schwarze 1115: goto done;
1.180 schwarze 1116: while (isspace((unsigned char)*cp)) {
1.164 schwarze 1117: cp++;
1.180 schwarze 1118: len--;
1119: }
1.105 schwarze 1120: } else {
1.164 schwarze 1121: if (strcmp(cp, synb) == 0 ||
1122: strcmp(cp, synr) == 0)
1.105 schwarze 1123: print = 1;
1124: continue;
1125: }
1126: }
1.180 schwarze 1127: for (; len > 0; len -= written) {
1.231 schwarze 1128: if ((written = write(STDOUT_FILENO, cp, len)) == -1) {
1129: mandoc_msg(MANDOCERR_WRITE, 0, 0,
1130: "%s", strerror(errno));
1131: goto done;
1132: }
1.164 schwarze 1133: }
1.105 schwarze 1134: }
1.231 schwarze 1135: if (ferror(stream))
1136: mandoc_msg(MANDOCERR_GETLINE, lno, 0, "%s", strerror(errno));
1.101 schwarze 1137:
1.105 schwarze 1138: done:
1.164 schwarze 1139: free(line);
1.231 schwarze 1140: if (stream != NULL)
1141: fclose(stream);
1.1 kristaps 1142: }
1143:
1144: static int
1.237 schwarze 1145: woptions(char *arg, enum mandoc_os *os_e, int *wstop)
1.1 kristaps 1146: {
1.10 schwarze 1147: char *v, *o;
1.196 schwarze 1148: const char *toks[11];
1.1 kristaps 1149:
1.45 schwarze 1150: toks[0] = "stop";
1151: toks[1] = "all";
1.196 schwarze 1152: toks[2] = "base";
1153: toks[3] = "style";
1154: toks[4] = "warning";
1155: toks[5] = "error";
1156: toks[6] = "unsupp";
1157: toks[7] = "fatal";
1158: toks[8] = "openbsd";
1159: toks[9] = "netbsd";
1160: toks[10] = NULL;
1.1 kristaps 1161:
1.10 schwarze 1162: while (*arg) {
1163: o = arg;
1.176 schwarze 1164: switch (getsubopt(&arg, (char * const *)toks, &v)) {
1.90 schwarze 1165: case 0:
1.237 schwarze 1166: *wstop = 1;
1.1 kristaps 1167: break;
1.90 schwarze 1168: case 1:
1169: case 2:
1.215 schwarze 1170: mandoc_msg_setmin(MANDOCERR_BASE);
1.193 schwarze 1171: break;
1172: case 3:
1.215 schwarze 1173: mandoc_msg_setmin(MANDOCERR_STYLE);
1.1 kristaps 1174: break;
1.193 schwarze 1175: case 4:
1.215 schwarze 1176: mandoc_msg_setmin(MANDOCERR_WARNING);
1.1 kristaps 1177: break;
1.193 schwarze 1178: case 5:
1.215 schwarze 1179: mandoc_msg_setmin(MANDOCERR_ERROR);
1.123 schwarze 1180: break;
1.193 schwarze 1181: case 6:
1.215 schwarze 1182: mandoc_msg_setmin(MANDOCERR_UNSUPP);
1.196 schwarze 1183: break;
1184: case 7:
1.231 schwarze 1185: mandoc_msg_setmin(MANDOCERR_BADARG);
1.196 schwarze 1186: break;
1187: case 8:
1.215 schwarze 1188: mandoc_msg_setmin(MANDOCERR_BASE);
1.237 schwarze 1189: *os_e = MANDOC_OS_OPENBSD;
1.196 schwarze 1190: break;
1191: case 9:
1.215 schwarze 1192: mandoc_msg_setmin(MANDOCERR_BASE);
1.237 schwarze 1193: *os_e = MANDOC_OS_NETBSD;
1.19 schwarze 1194: break;
1.1 kristaps 1195: default:
1.231 schwarze 1196: mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, "-W %s", o);
1197: return -1;
1.1 kristaps 1198: }
1.10 schwarze 1199: }
1.231 schwarze 1200: return 0;
1.236 schwarze 1201: }
1202:
1203: /*
1204: * Wait until moved to the foreground,
1205: * then fork the pager and wait for the user to close it.
1206: */
1207: static void
1.253 schwarze 1208: run_pager(struct outstate *outst, char *tag_target)
1.236 schwarze 1209: {
1210: int signum, status;
1211: pid_t man_pgid, tc_pgid;
1212: pid_t pager_pid, wait_pid;
1213:
1214: man_pgid = getpgid(0);
1.253 schwarze 1215: outst->tag_files->tcpgid =
1216: man_pgid == getpid() ? getpgid(getppid()) : man_pgid;
1.236 schwarze 1217: pager_pid = 0;
1218: signum = SIGSTOP;
1219:
1220: for (;;) {
1221: /* Stop here until moved to the foreground. */
1222:
1.251 schwarze 1223: tc_pgid = tcgetpgrp(STDOUT_FILENO);
1.236 schwarze 1224: if (tc_pgid != man_pgid) {
1225: if (tc_pgid == pager_pid) {
1.251 schwarze 1226: (void)tcsetpgrp(STDOUT_FILENO, man_pgid);
1.236 schwarze 1227: if (signum == SIGTTIN)
1228: continue;
1229: } else
1.253 schwarze 1230: outst->tag_files->tcpgid = tc_pgid;
1.236 schwarze 1231: kill(0, signum);
1232: continue;
1233: }
1234:
1235: /* Once in the foreground, activate the pager. */
1236:
1237: if (pager_pid) {
1.251 schwarze 1238: (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
1.236 schwarze 1239: kill(pager_pid, SIGCONT);
1240: } else
1.253 schwarze 1241: pager_pid = spawn_pager(outst, tag_target);
1.236 schwarze 1242:
1243: /* Wait for the pager to stop or exit. */
1244:
1245: while ((wait_pid = waitpid(pager_pid, &status,
1246: WUNTRACED)) == -1 && errno == EINTR)
1247: continue;
1248:
1249: if (wait_pid == -1) {
1250: mandoc_msg(MANDOCERR_WAIT, 0, 0,
1251: "%s", strerror(errno));
1252: break;
1253: }
1254: if (!WIFSTOPPED(status))
1255: break;
1256:
1257: signum = WSTOPSIG(status);
1258: }
1.95 schwarze 1259: }
1260:
1.130 schwarze 1261: static pid_t
1.253 schwarze 1262: spawn_pager(struct outstate *outst, char *tag_target)
1.95 schwarze 1263: {
1.172 schwarze 1264: const struct timespec timeout = { 0, 100000000 }; /* 0.1s */
1.95 schwarze 1265: #define MAX_PAGER_ARGS 16
1266: char *argv[MAX_PAGER_ARGS];
1267: const char *pager;
1268: char *cp;
1.262 schwarze 1269: size_t wordlen;
1.144 schwarze 1270: size_t cmdlen;
1.212 schwarze 1271: int argc, use_ofn;
1.130 schwarze 1272: pid_t pager_pid;
1.95 schwarze 1273:
1.253 schwarze 1274: assert(outst->tag_files->ofd == -1);
1275: assert(outst->tag_files->tfs == NULL);
1.251 schwarze 1276:
1.144 schwarze 1277: pager = getenv("MANPAGER");
1278: if (pager == NULL || *pager == '\0')
1279: pager = getenv("PAGER");
1280: if (pager == NULL || *pager == '\0')
1.254 schwarze 1281: pager = "less";
1.144 schwarze 1282:
1283: /*
1284: * Parse the pager command into words.
1285: * Intentionally do not do anything fancy here.
1286: */
1287:
1288: argc = 0;
1.262 schwarze 1289: while (*pager != '\0' && argc + 5 < MAX_PAGER_ARGS) {
1290: wordlen = strcspn(pager, " ");
1291: argv[argc++] = mandoc_strndup(pager, wordlen);
1292: pager += wordlen;
1293: while (*pager == ' ')
1294: pager++;
1.144 schwarze 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.262 schwarze 1305: argv[argc++] = mandoc_strdup(outst->tag_files->tfn);
1.251 schwarze 1306: if (tag_target != NULL) {
1.212 schwarze 1307: argv[argc++] = mandoc_strdup("-t");
1.262 schwarze 1308: argv[argc++] = mandoc_strdup(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
1.262 schwarze 1318: argv[argc] = mandoc_strdup(outst->tag_files->ofn);
1.253 schwarze 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.262 schwarze 1330: while (argc > 0)
1331: free(argv[--argc]);
1.165 schwarze 1332: (void)setpgid(pager_pid, 0);
1.251 schwarze 1333: (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
1.231 schwarze 1334: if (pledge("stdio rpath tmppath tty proc", NULL) == -1) {
1335: mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
1336: "%s", strerror(errno));
1337: exit(mandoc_msg_getrc());
1338: }
1.253 schwarze 1339: outst->tag_files->pager_pid = pager_pid;
1.150 schwarze 1340: return pager_pid;
1.95 schwarze 1341: }
1342:
1.251 schwarze 1343: /*
1344: * The child process becomes the pager.
1345: * Do not start it before controlling the terminal.
1346: */
1.172 schwarze 1347:
1.182 schwarze 1348: while (tcgetpgrp(STDOUT_FILENO) != getpid())
1.172 schwarze 1349: nanosleep(&timeout, NULL);
1350:
1.95 schwarze 1351: execvp(argv[0], argv);
1.231 schwarze 1352: mandoc_msg(MANDOCERR_EXEC, 0, 0, "%s: %s", argv[0], strerror(errno));
1353: _exit(mandoc_msg_getrc());
1.30 schwarze 1354: }
![[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