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