Annotation of src/usr.bin/mandoc/main.c, Revision 1.155
1.155 ! schwarze 1: /* $OpenBSD: main.c,v 1.154 2015/10/12 22:41:18 schwarze Exp $ */
1.1 kristaps 2: /*
1.95 schwarze 3: * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.118 schwarze 4: * Copyright (c) 2010-2012, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
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.1 kristaps 18: */
19:
1.95 schwarze 20: #include <sys/types.h>
1.122 schwarze 21: #include <sys/param.h> /* MACHINE */
1.129 schwarze 22: #include <sys/wait.h>
1.95 schwarze 23:
1.1 kristaps 24: #include <assert.h>
1.95 schwarze 25: #include <ctype.h>
1.152 schwarze 26: #include <err.h>
1.95 schwarze 27: #include <fcntl.h>
1.127 schwarze 28: #include <glob.h>
1.131 schwarze 29: #include <signal.h>
1.1 kristaps 30: #include <stdio.h>
1.17 schwarze 31: #include <stdint.h>
1.1 kristaps 32: #include <stdlib.h>
33: #include <string.h>
34: #include <unistd.h>
35:
1.136 schwarze 36: #include "mandoc_aux.h"
1.30 schwarze 37: #include "mandoc.h"
1.136 schwarze 38: #include "roff.h"
1.1 kristaps 39: #include "mdoc.h"
40: #include "man.h"
1.144 schwarze 41: #include "tag.h"
1.136 schwarze 42: #include "main.h"
1.134 schwarze 43: #include "manconf.h"
1.95 schwarze 44: #include "mansearch.h"
45:
46: enum outmode {
47: OUTMODE_DEF = 0,
48: OUTMODE_FLN,
49: OUTMODE_LST,
50: OUTMODE_ALL,
51: OUTMODE_INT,
52: OUTMODE_ONE
53: };
1.1 kristaps 54:
1.139 schwarze 55: typedef void (*out_mdoc)(void *, const struct roff_man *);
56: typedef void (*out_man)(void *, const struct roff_man *);
1.1 kristaps 57: typedef void (*out_free)(void *);
58:
59: enum outt {
1.76 schwarze 60: OUTT_ASCII = 0, /* -Tascii */
1.77 schwarze 61: OUTT_LOCALE, /* -Tlocale */
62: OUTT_UTF8, /* -Tutf8 */
1.76 schwarze 63: OUTT_TREE, /* -Ttree */
1.78 schwarze 64: OUTT_MAN, /* -Tman */
1.76 schwarze 65: OUTT_HTML, /* -Thtml */
66: OUTT_LINT, /* -Tlint */
67: OUTT_PS, /* -Tps */
68: OUTT_PDF /* -Tpdf */
1.1 kristaps 69: };
70:
71: struct curparse {
1.76 schwarze 72: struct mparse *mp;
1.75 schwarze 73: enum mandoclevel wlevel; /* ignore messages below this */
74: int wstop; /* stop after a file with a warning */
1.90 schwarze 75: enum outt outtype; /* which output to use */
1.33 schwarze 76: out_mdoc outmdoc; /* mdoc output ptr */
1.90 schwarze 77: out_man outman; /* man output ptr */
1.33 schwarze 78: out_free outfree; /* free output ptr */
79: void *outdata; /* data for output */
1.135 schwarze 80: struct manoutput *outopts; /* output options */
1.33 schwarze 81: };
82:
1.119 schwarze 83: static int fs_lookup(const struct manpaths *,
84: size_t ipath, const char *,
85: const char *, const char *,
86: struct manpage **, size_t *);
87: static void fs_search(const struct mansearch *,
88: const struct manpaths *, int, char**,
89: struct manpage **, size_t *);
1.103 schwarze 90: static int koptions(int *, char *);
1.79 schwarze 91: int mandocdb(int, char**);
1.87 schwarze 92: static int moptions(int *, char *);
1.76 schwarze 93: static void mmsg(enum mandocerr, enum mandoclevel,
94: const char *, int, int, const char *);
1.132 schwarze 95: static void parse(struct curparse *, int, const char *);
96: static void passthrough(const char *, int, int);
1.149 schwarze 97: static pid_t spawn_pager(struct tag_files *);
1.27 schwarze 98: static int toptions(struct curparse *, char *);
1.95 schwarze 99: static void usage(enum argmode) __attribute__((noreturn));
1.45 schwarze 100: static int woptions(struct curparse *, char *);
1.1 kristaps 101:
1.152 schwarze 102: extern char *__progname;
103:
1.95 schwarze 104: static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
1.110 schwarze 105: static char help_arg[] = "help";
106: static char *help_argv[] = {help_arg, NULL};
1.131 schwarze 107: static enum mandoclevel rc;
1.1 kristaps 108:
1.90 schwarze 109:
1.1 kristaps 110: int
111: main(int argc, char *argv[])
112: {
1.134 schwarze 113: struct manconf conf;
1.1 kristaps 114: struct curparse curp;
1.95 schwarze 115: struct mansearch search;
1.149 schwarze 116: struct tag_files *tag_files;
1.111 schwarze 117: char *auxpaths;
1.95 schwarze 118: char *defos;
1.113 schwarze 119: unsigned char *uc;
1.95 schwarze 120: struct manpage *res, *resp;
1.111 schwarze 121: char *conf_file, *defpaths;
1.95 schwarze 122: size_t isec, i, sz;
1.135 schwarze 123: int prio, best_prio;
1.95 schwarze 124: char sec;
1.131 schwarze 125: enum mandoclevel rctmp;
1.95 schwarze 126: enum outmode outmode;
1.100 schwarze 127: int fd;
1.95 schwarze 128: int show_usage;
1.87 schwarze 129: int options;
1.149 schwarze 130: int use_pager;
1.95 schwarze 131: int c;
1.1 kristaps 132:
1.152 schwarze 133: if (0 == strncmp(__progname, "mandocdb", 8) ||
134: 0 == strncmp(__progname, "makewhatis", 10))
1.150 schwarze 135: return mandocdb(argc, argv);
1.19 schwarze 136:
1.154 schwarze 137: if (pledge("stdio rpath tmppath proc exec", NULL) == -1)
138: err(1, "pledge");
139:
1.95 schwarze 140: /* Search options. */
141:
1.134 schwarze 142: memset(&conf, 0, sizeof(conf));
1.111 schwarze 143: conf_file = defpaths = NULL;
144: auxpaths = NULL;
1.95 schwarze 145:
146: memset(&search, 0, sizeof(struct mansearch));
147: search.outkey = "Nd";
148:
1.152 schwarze 149: if (strcmp(__progname, "man") == 0)
1.95 schwarze 150: search.argmode = ARG_NAME;
1.152 schwarze 151: else if (strncmp(__progname, "apropos", 7) == 0)
1.95 schwarze 152: search.argmode = ARG_EXPR;
1.152 schwarze 153: else if (strncmp(__progname, "whatis", 6) == 0)
1.95 schwarze 154: search.argmode = ARG_WORD;
1.152 schwarze 155: else if (strncmp(__progname, "help", 4) == 0)
1.110 schwarze 156: search.argmode = ARG_NAME;
1.95 schwarze 157: else
158: search.argmode = ARG_FILE;
159:
160: /* Parser and formatter options. */
161:
1.19 schwarze 162: memset(&curp, 0, sizeof(struct curparse));
1.109 schwarze 163: curp.outtype = OUTT_LOCALE;
1.121 schwarze 164: curp.wlevel = MANDOCLEVEL_BADARG;
1.135 schwarze 165: curp.outopts = &conf.output;
1.103 schwarze 166: options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.83 schwarze 167: defos = NULL;
1.1 kristaps 168:
1.149 schwarze 169: use_pager = 1;
170: tag_files = NULL;
1.95 schwarze 171: show_usage = 0;
172: outmode = OUTMODE_DEF;
173:
1.103 schwarze 174: while (-1 != (c = getopt(argc, argv,
175: "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
1.1 kristaps 176: switch (c) {
1.95 schwarze 177: case 'a':
178: outmode = OUTMODE_ALL;
179: break;
180: case 'C':
181: conf_file = optarg;
182: break;
183: case 'c':
1.149 schwarze 184: use_pager = 0;
1.95 schwarze 185: break;
186: case 'f':
187: search.argmode = ARG_WORD;
188: break;
1.98 schwarze 189: case 'h':
1.135 schwarze 190: conf.output.synopsisonly = 1;
1.149 schwarze 191: use_pager = 0;
1.98 schwarze 192: outmode = OUTMODE_ALL;
193: break;
1.90 schwarze 194: case 'I':
1.83 schwarze 195: if (strncmp(optarg, "os=", 3)) {
1.152 schwarze 196: warnx("-I %s: Bad argument", optarg);
1.150 schwarze 197: return (int)MANDOCLEVEL_BADARG;
1.83 schwarze 198: }
199: if (defos) {
1.152 schwarze 200: warnx("-I %s: Duplicate argument", optarg);
1.150 schwarze 201: return (int)MANDOCLEVEL_BADARG;
1.83 schwarze 202: }
203: defos = mandoc_strdup(optarg + 3);
204: break;
1.95 schwarze 205: case 'i':
206: outmode = OUTMODE_INT;
207: break;
1.103 schwarze 208: case 'K':
209: if ( ! koptions(&options, optarg))
1.150 schwarze 210: return (int)MANDOCLEVEL_BADARG;
1.103 schwarze 211: break;
1.95 schwarze 212: case 'k':
213: search.argmode = ARG_EXPR;
214: break;
1.96 schwarze 215: case 'l':
216: search.argmode = ARG_FILE;
217: outmode = OUTMODE_ALL;
218: break;
1.95 schwarze 219: case 'M':
220: defpaths = optarg;
221: break;
1.90 schwarze 222: case 'm':
1.95 schwarze 223: auxpaths = optarg;
1.1 kristaps 224: break;
1.90 schwarze 225: case 'O':
1.95 schwarze 226: search.outkey = optarg;
1.135 schwarze 227: while (optarg != NULL)
228: manconf_output(&conf.output,
229: strsep(&optarg, ","));
1.17 schwarze 230: break;
1.95 schwarze 231: case 'S':
232: search.arch = optarg;
233: break;
234: case 's':
235: search.sec = optarg;
236: break;
1.90 schwarze 237: case 'T':
1.22 schwarze 238: if ( ! toptions(&curp, optarg))
1.150 schwarze 239: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 240: break;
1.90 schwarze 241: case 'W':
1.45 schwarze 242: if ( ! woptions(&curp, optarg))
1.150 schwarze 243: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 244: break;
1.95 schwarze 245: case 'w':
246: outmode = OUTMODE_FLN;
247: break;
1.1 kristaps 248: default:
1.95 schwarze 249: show_usage = 1;
250: break;
251: }
252: }
253:
254: if (show_usage)
255: usage(search.argmode);
256:
257: /* Postprocess options. */
258:
259: if (outmode == OUTMODE_DEF) {
260: switch (search.argmode) {
261: case ARG_FILE:
262: outmode = OUTMODE_ALL;
1.149 schwarze 263: use_pager = 0;
1.95 schwarze 264: break;
265: case ARG_NAME:
266: outmode = OUTMODE_ONE;
267: break;
268: default:
269: outmode = OUTMODE_LST;
270: break;
271: }
272: }
273:
1.151 schwarze 274: if (outmode == OUTMODE_FLN ||
275: outmode == OUTMODE_LST ||
276: !isatty(STDOUT_FILENO))
277: use_pager = 0;
278:
1.154 schwarze 279: if (!use_pager && pledge("stdio rpath", NULL) == -1)
280: err(1, "pledge");
281:
1.95 schwarze 282: /* Parse arguments. */
283:
1.124 schwarze 284: if (argc > 0) {
285: argc -= optind;
286: argv += optind;
287: }
1.95 schwarze 288: resp = NULL;
289:
1.110 schwarze 290: /*
291: * Quirks for help(1)
292: * and for a man(1) section argument without -s.
293: */
294:
295: if (search.argmode == ARG_NAME) {
1.152 schwarze 296: if (*__progname == 'h') {
1.110 schwarze 297: if (argc == 0) {
298: argv = help_argv;
299: argc = 1;
300: }
1.117 schwarze 301: } else if (argc > 1 &&
1.128 schwarze 302: ((uc = (unsigned char *)argv[0]) != NULL) &&
1.113 schwarze 303: ((isdigit(uc[0]) && (uc[1] == '\0' ||
304: (isalpha(uc[1]) && uc[2] == '\0'))) ||
305: (uc[0] == 'n' && uc[1] == '\0'))) {
1.128 schwarze 306: search.sec = (char *)uc;
1.110 schwarze 307: argv++;
308: argc--;
309: }
1.122 schwarze 310: if (search.arch == NULL)
311: search.arch = getenv("MACHINE");
312: if (search.arch == NULL)
313: search.arch = MACHINE;
1.95 schwarze 314: }
315:
316: rc = MANDOCLEVEL_OK;
317:
318: /* man(1), whatis(1), apropos(1) */
319:
320: if (search.argmode != ARG_FILE) {
321: if (argc == 0)
322: usage(search.argmode);
1.107 schwarze 323:
324: if (search.argmode == ARG_NAME &&
325: outmode == OUTMODE_ONE)
326: search.firstmatch = 1;
1.95 schwarze 327:
328: /* Access the mandoc database. */
329:
1.134 schwarze 330: manconf_parse(&conf, conf_file, defpaths, auxpaths);
1.95 schwarze 331: mansearch_setup(1);
1.134 schwarze 332: if ( ! mansearch(&search, &conf.manpath,
333: argc, argv, &res, &sz))
1.95 schwarze 334: usage(search.argmode);
1.119 schwarze 335:
1.142 schwarze 336: if (sz == 0) {
337: if (search.argmode == ARG_NAME)
338: fs_search(&search, &conf.manpath,
339: argc, argv, &res, &sz);
340: else
1.152 schwarze 341: warnx("nothing appropriate");
1.142 schwarze 342: }
1.95 schwarze 343:
344: if (sz == 0) {
345: rc = MANDOCLEVEL_BADARG;
346: goto out;
347: }
348:
349: /*
350: * For standard man(1) and -a output mode,
351: * prepare for copying filename pointers
352: * into the program parameter array.
353: */
354:
355: if (outmode == OUTMODE_ONE) {
356: argc = 1;
357: best_prio = 10;
358: } else if (outmode == OUTMODE_ALL)
359: argc = (int)sz;
360:
361: /* Iterate all matching manuals. */
362:
1.119 schwarze 363: resp = res;
1.95 schwarze 364: for (i = 0; i < sz; i++) {
365: if (outmode == OUTMODE_FLN)
366: puts(res[i].file);
367: else if (outmode == OUTMODE_LST)
368: printf("%s - %s\n", res[i].names,
369: res[i].output == NULL ? "" :
370: res[i].output);
371: else if (outmode == OUTMODE_ONE) {
372: /* Search for the best section. */
373: isec = strcspn(res[i].file, "123456789");
374: sec = res[i].file[isec];
375: if ('\0' == sec)
376: continue;
377: prio = sec_prios[sec - '1'];
378: if (prio >= best_prio)
379: continue;
380: best_prio = prio;
381: resp = res + i;
382: }
1.1 kristaps 383: }
384:
1.95 schwarze 385: /*
386: * For man(1), -a and -i output mode, fall through
387: * to the main mandoc(1) code iterating files
388: * and running the parsers on each of them.
389: */
390:
391: if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
392: goto out;
393: }
394:
395: /* mandoc(1) */
396:
1.115 schwarze 397: if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths))
1.150 schwarze 398: return (int)MANDOCLEVEL_BADARG;
1.146 schwarze 399:
1.155 ! schwarze 400: mchars_alloc();
! 401: curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos);
1.76 schwarze 402:
1.80 schwarze 403: /*
404: * Conditionally start up the lookaside buffer before parsing.
405: */
406: if (OUTT_MAN == curp.outtype)
407: mparse_keep(curp.mp);
408:
1.124 schwarze 409: if (argc < 1) {
1.149 schwarze 410: if (use_pager)
411: tag_files = tag_init();
1.132 schwarze 412: parse(&curp, STDIN_FILENO, "<stdin>");
1.118 schwarze 413: }
1.27 schwarze 414:
1.124 schwarze 415: while (argc > 0) {
1.120 schwarze 416: rctmp = mparse_open(curp.mp, &fd,
1.118 schwarze 417: resp != NULL ? resp->file : *argv);
1.120 schwarze 418: if (rc < rctmp)
419: rc = rctmp;
1.118 schwarze 420:
421: if (fd != -1) {
1.149 schwarze 422: if (use_pager) {
423: tag_files = tag_init();
424: use_pager = 0;
425: }
1.118 schwarze 426:
427: if (resp == NULL)
1.132 schwarze 428: parse(&curp, fd, *argv);
1.100 schwarze 429: else if (resp->form & FORM_SRC) {
1.97 schwarze 430: /* For .so only; ignore failure. */
1.134 schwarze 431: chdir(conf.manpath.paths[resp->ipath]);
1.132 schwarze 432: parse(&curp, fd, resp->file);
433: } else
1.135 schwarze 434: passthrough(resp->file, fd,
435: conf.output.synopsisonly);
1.118 schwarze 436:
437: if (argc > 1 && curp.outtype <= OUTT_UTF8)
438: ascii_sepline(curp.outdata);
1.100 schwarze 439: }
440:
1.76 schwarze 441: if (MANDOCLEVEL_OK != rc && curp.wstop)
1.27 schwarze 442: break;
1.116 schwarze 443:
1.118 schwarze 444: if (resp != NULL)
445: resp++;
446: else
447: argv++;
448: if (--argc)
449: mparse_reset(curp.mp);
1.1 kristaps 450: }
451:
452: if (curp.outfree)
453: (*curp.outfree)(curp.outdata);
1.102 schwarze 454: mparse_free(curp.mp);
1.155 ! schwarze 455: mchars_free();
1.95 schwarze 456:
457: out:
458: if (search.argmode != ARG_FILE) {
1.134 schwarze 459: manconf_free(&conf);
1.95 schwarze 460: mansearch_free(res, sz);
461: mansearch_setup(0);
462: }
463:
1.83 schwarze 464: free(defos);
1.1 kristaps 465:
1.129 schwarze 466: /*
1.149 schwarze 467: * When using a pager, finish writing both temporary files,
468: * fork it, wait for the user to close it, and clean up.
1.129 schwarze 469: */
470:
1.149 schwarze 471: if (tag_files != NULL) {
1.130 schwarze 472: fclose(stdout);
1.144 schwarze 473: tag_write();
1.149 schwarze 474: waitpid(spawn_pager(tag_files), NULL, 0);
1.144 schwarze 475: tag_unlink();
1.130 schwarze 476: }
1.129 schwarze 477:
1.150 schwarze 478: return (int)rc;
1.1 kristaps 479: }
480:
1.20 schwarze 481: static void
1.95 schwarze 482: usage(enum argmode argmode)
1.1 kristaps 483: {
484:
1.95 schwarze 485: switch (argmode) {
486: case ARG_FILE:
1.133 schwarze 487: fputs("usage: mandoc [-acfhkl] [-I os=name] "
488: "[-K encoding] [-mformat] [-O option]\n"
489: "\t [-T output] [-W level] [file ...]\n", stderr);
1.95 schwarze 490: break;
491: case ARG_NAME:
1.126 schwarze 492: fputs("usage: man [-acfhklw] [-C file] [-I os=name] "
1.114 jmc 493: "[-K encoding] [-M path] [-m path]\n"
494: "\t [-O option=value] [-S subsection] [-s section] "
495: "[-T output] [-W level]\n"
1.95 schwarze 496: "\t [section] name ...\n", stderr);
497: break;
498: case ARG_WORD:
1.126 schwarze 499: fputs("usage: whatis [-acfhklw] [-C file] "
1.96 schwarze 500: "[-M path] [-m path] [-O outkey] [-S arch]\n"
501: "\t [-s section] name ...\n", stderr);
1.95 schwarze 502: break;
503: case ARG_EXPR:
1.126 schwarze 504: fputs("usage: apropos [-acfhklw] [-C file] "
1.96 schwarze 505: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.95 schwarze 506: "\t [-s section] expression ...\n", stderr);
507: break;
508: }
1.47 schwarze 509: exit((int)MANDOCLEVEL_BADARG);
1.119 schwarze 510: }
511:
512: static int
513: fs_lookup(const struct manpaths *paths, size_t ipath,
514: const char *sec, const char *arch, const char *name,
515: struct manpage **res, size_t *ressz)
516: {
1.127 schwarze 517: glob_t globinfo;
1.119 schwarze 518: struct manpage *page;
519: char *file;
1.127 schwarze 520: int form, globres;
1.119 schwarze 521:
1.127 schwarze 522: form = FORM_SRC;
1.119 schwarze 523: mandoc_asprintf(&file, "%s/man%s/%s.%s",
524: paths->paths[ipath], sec, name, sec);
1.127 schwarze 525: if (access(file, R_OK) != -1)
1.119 schwarze 526: goto found;
527: free(file);
528:
529: mandoc_asprintf(&file, "%s/cat%s/%s.0",
530: paths->paths[ipath], sec, name);
531: if (access(file, R_OK) != -1) {
532: form = FORM_CAT;
533: goto found;
534: }
535: free(file);
536:
537: if (arch != NULL) {
538: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
539: paths->paths[ipath], sec, arch, name, sec);
1.127 schwarze 540: if (access(file, R_OK) != -1)
1.119 schwarze 541: goto found;
542: free(file);
543: }
1.127 schwarze 544:
1.145 schwarze 545: mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",
1.127 schwarze 546: paths->paths[ipath], sec, name);
547: globres = glob(file, 0, NULL, &globinfo);
548: if (globres != 0 && globres != GLOB_NOMATCH)
1.152 schwarze 549: warn("%s: glob", file);
1.127 schwarze 550: free(file);
551: if (globres == 0)
552: file = mandoc_strdup(*globinfo.gl_pathv);
553: globfree(&globinfo);
554: if (globres != 0)
1.150 schwarze 555: return 0;
1.119 schwarze 556:
557: found:
1.152 schwarze 558: warnx("outdated mandoc.db lacks %s(%s) entry, run makewhatis %s",
559: name, sec, paths->paths[ipath]);
1.119 schwarze 560: *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
561: page = *res + (*ressz - 1);
562: page->file = file;
563: page->names = NULL;
564: page->output = NULL;
565: page->ipath = ipath;
566: page->bits = NAME_FILE & NAME_MASK;
567: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
568: page->form = form;
1.150 schwarze 569: return 1;
1.119 schwarze 570: }
571:
572: static void
573: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
574: int argc, char **argv, struct manpage **res, size_t *ressz)
575: {
576: const char *const sections[] =
577: {"1", "8", "6", "2", "3", "3p", "5", "7", "4", "9"};
578: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
579:
580: size_t ipath, isec, lastsz;
581:
582: assert(cfg->argmode == ARG_NAME);
583:
584: *res = NULL;
585: *ressz = lastsz = 0;
586: while (argc) {
587: for (ipath = 0; ipath < paths->sz; ipath++) {
588: if (cfg->sec != NULL) {
589: if (fs_lookup(paths, ipath, cfg->sec,
590: cfg->arch, *argv, res, ressz) &&
591: cfg->firstmatch)
592: return;
593: } else for (isec = 0; isec < nsec; isec++)
594: if (fs_lookup(paths, ipath, sections[isec],
595: cfg->arch, *argv, res, ressz) &&
596: cfg->firstmatch)
597: return;
598: }
599: if (*ressz == lastsz)
1.152 schwarze 600: warnx("No entry for %s in the manual.", *argv);
1.119 schwarze 601: lastsz = *ressz;
602: argv++;
603: argc--;
604: }
1.1 kristaps 605: }
606:
1.27 schwarze 607: static void
1.132 schwarze 608: parse(struct curparse *curp, int fd, const char *file)
1.52 schwarze 609: {
1.132 schwarze 610: enum mandoclevel rctmp;
1.139 schwarze 611: struct roff_man *man;
1.52 schwarze 612:
1.76 schwarze 613: /* Begin by parsing the file itself. */
1.52 schwarze 614:
1.76 schwarze 615: assert(file);
616: assert(fd >= -1);
1.52 schwarze 617:
1.132 schwarze 618: rctmp = mparse_readfd(curp->mp, fd, file);
619: if (rc < rctmp)
620: rc = rctmp;
1.1 kristaps 621:
1.51 schwarze 622: /*
1.76 schwarze 623: * With -Wstop and warnings or errors of at least the requested
624: * level, do not produce output.
1.51 schwarze 625: */
626:
1.132 schwarze 627: if (rctmp != MANDOCLEVEL_OK && curp->wstop)
628: return;
1.51 schwarze 629:
630: /* If unset, allocate output dev now (if applicable). */
631:
632: if ( ! (curp->outman && curp->outmdoc)) {
633: switch (curp->outtype) {
1.90 schwarze 634: case OUTT_HTML:
1.155 ! schwarze 635: curp->outdata = html_alloc(curp->outopts);
1.77 schwarze 636: curp->outfree = html_free;
637: break;
1.90 schwarze 638: case OUTT_UTF8:
1.155 ! schwarze 639: curp->outdata = utf8_alloc(curp->outopts);
1.77 schwarze 640: curp->outfree = ascii_free;
641: break;
1.90 schwarze 642: case OUTT_LOCALE:
1.155 ! schwarze 643: curp->outdata = locale_alloc(curp->outopts);
1.77 schwarze 644: curp->outfree = ascii_free;
1.51 schwarze 645: break;
1.90 schwarze 646: case OUTT_ASCII:
1.155 ! schwarze 647: curp->outdata = ascii_alloc(curp->outopts);
1.51 schwarze 648: curp->outfree = ascii_free;
649: break;
1.90 schwarze 650: case OUTT_PDF:
1.155 ! schwarze 651: curp->outdata = pdf_alloc(curp->outopts);
1.51 schwarze 652: curp->outfree = pspdf_free;
653: break;
1.90 schwarze 654: case OUTT_PS:
1.155 ! schwarze 655: curp->outdata = ps_alloc(curp->outopts);
1.51 schwarze 656: curp->outfree = pspdf_free;
657: break;
658: default:
659: break;
660: }
661:
662: switch (curp->outtype) {
1.90 schwarze 663: case OUTT_HTML:
1.51 schwarze 664: curp->outman = html_man;
665: curp->outmdoc = html_mdoc;
666: break;
1.90 schwarze 667: case OUTT_TREE:
1.51 schwarze 668: curp->outman = tree_man;
669: curp->outmdoc = tree_mdoc;
670: break;
1.90 schwarze 671: case OUTT_MAN:
1.78 schwarze 672: curp->outmdoc = man_mdoc;
1.80 schwarze 673: curp->outman = man_man;
1.78 schwarze 674: break;
1.90 schwarze 675: case OUTT_PDF:
676: case OUTT_ASCII:
677: case OUTT_UTF8:
678: case OUTT_LOCALE:
679: case OUTT_PS:
1.51 schwarze 680: curp->outman = terminal_man;
681: curp->outmdoc = terminal_mdoc;
682: break;
683: default:
684: break;
685: }
686: }
687:
1.140 schwarze 688: mparse_result(curp->mp, &man, NULL);
1.76 schwarze 689:
1.51 schwarze 690: /* Execute the out device, if it exists. */
691:
1.140 schwarze 692: if (man == NULL)
693: return;
694: if (curp->outmdoc != NULL && man->macroset == MACROSET_MDOC)
695: (*curp->outmdoc)(curp->outdata, man);
696: if (curp->outman != NULL && man->macroset == MACROSET_MAN)
1.76 schwarze 697: (*curp->outman)(curp->outdata, man);
1.1 kristaps 698: }
699:
1.132 schwarze 700: static void
1.105 schwarze 701: passthrough(const char *file, int fd, int synopsis_only)
1.95 schwarze 702: {
1.105 schwarze 703: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
704: const char synr[] = "SYNOPSIS";
705:
706: FILE *stream;
1.95 schwarze 707: const char *syscall;
1.105 schwarze 708: char *line;
709: size_t len, off;
710: ssize_t nw;
711: int print;
1.116 schwarze 712:
713: fflush(stdout);
1.105 schwarze 714:
715: if ((stream = fdopen(fd, "r")) == NULL) {
716: close(fd);
717: syscall = "fdopen";
718: goto fail;
719: }
1.95 schwarze 720:
1.105 schwarze 721: print = 0;
722: while ((line = fgetln(stream, &len)) != NULL) {
723: if (synopsis_only) {
724: if (print) {
725: if ( ! isspace((unsigned char)*line))
726: goto done;
727: while (len &&
728: isspace((unsigned char)*line)) {
729: line++;
730: len--;
731: }
732: } else {
733: if ((len == sizeof(synb) &&
734: ! strncmp(line, synb, len - 1)) ||
735: (len == sizeof(synr) &&
736: ! strncmp(line, synr, len - 1)))
737: print = 1;
738: continue;
739: }
740: }
741: for (off = 0; off < len; off += nw)
742: if ((nw = write(STDOUT_FILENO, line + off,
743: len - off)) == -1 || nw == 0) {
744: fclose(stream);
1.95 schwarze 745: syscall = "write";
746: goto fail;
747: }
1.105 schwarze 748: }
1.95 schwarze 749:
1.105 schwarze 750: if (ferror(stream)) {
751: fclose(stream);
752: syscall = "fgetln";
753: goto fail;
754: }
1.101 schwarze 755:
1.105 schwarze 756: done:
757: fclose(stream);
1.132 schwarze 758: return;
1.95 schwarze 759:
760: fail:
1.152 schwarze 761: warn("%s: SYSERR: %s", file, syscall);
1.132 schwarze 762: if (rc < MANDOCLEVEL_SYSERR)
763: rc = MANDOCLEVEL_SYSERR;
1.103 schwarze 764: }
765:
766: static int
767: koptions(int *options, char *arg)
768: {
769:
770: if ( ! strcmp(arg, "utf-8")) {
771: *options |= MPARSE_UTF8;
772: *options &= ~MPARSE_LATIN1;
773: } else if ( ! strcmp(arg, "iso-8859-1")) {
774: *options |= MPARSE_LATIN1;
775: *options &= ~MPARSE_UTF8;
776: } else if ( ! strcmp(arg, "us-ascii")) {
777: *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
778: } else {
1.152 schwarze 779: warnx("-K %s: Bad argument", arg);
1.150 schwarze 780: return 0;
1.103 schwarze 781: }
1.150 schwarze 782: return 1;
1.95 schwarze 783: }
784:
1.1 kristaps 785: static int
1.87 schwarze 786: moptions(int *options, char *arg)
1.1 kristaps 787: {
788:
1.95 schwarze 789: if (arg == NULL)
790: /* nothing to do */;
791: else if (0 == strcmp(arg, "doc"))
1.87 schwarze 792: *options |= MPARSE_MDOC;
1.1 kristaps 793: else if (0 == strcmp(arg, "andoc"))
1.87 schwarze 794: /* nothing to do */;
1.1 kristaps 795: else if (0 == strcmp(arg, "an"))
1.87 schwarze 796: *options |= MPARSE_MAN;
1.1 kristaps 797: else {
1.152 schwarze 798: warnx("-m %s: Bad argument", arg);
1.150 schwarze 799: return 0;
1.1 kristaps 800: }
801:
1.150 schwarze 802: return 1;
1.1 kristaps 803: }
804:
805: static int
1.22 schwarze 806: toptions(struct curparse *curp, char *arg)
1.1 kristaps 807: {
808:
809: if (0 == strcmp(arg, "ascii"))
1.22 schwarze 810: curp->outtype = OUTT_ASCII;
811: else if (0 == strcmp(arg, "lint")) {
812: curp->outtype = OUTT_LINT;
1.45 schwarze 813: curp->wlevel = MANDOCLEVEL_WARNING;
1.76 schwarze 814: } else if (0 == strcmp(arg, "tree"))
1.22 schwarze 815: curp->outtype = OUTT_TREE;
1.78 schwarze 816: else if (0 == strcmp(arg, "man"))
817: curp->outtype = OUTT_MAN;
1.17 schwarze 818: else if (0 == strcmp(arg, "html"))
1.22 schwarze 819: curp->outtype = OUTT_HTML;
1.77 schwarze 820: else if (0 == strcmp(arg, "utf8"))
821: curp->outtype = OUTT_UTF8;
822: else if (0 == strcmp(arg, "locale"))
823: curp->outtype = OUTT_LOCALE;
1.21 schwarze 824: else if (0 == strcmp(arg, "xhtml"))
1.102 schwarze 825: curp->outtype = OUTT_HTML;
1.36 schwarze 826: else if (0 == strcmp(arg, "ps"))
827: curp->outtype = OUTT_PS;
1.43 schwarze 828: else if (0 == strcmp(arg, "pdf"))
829: curp->outtype = OUTT_PDF;
1.1 kristaps 830: else {
1.152 schwarze 831: warnx("-T %s: Bad argument", arg);
1.150 schwarze 832: return 0;
1.1 kristaps 833: }
834:
1.150 schwarze 835: return 1;
1.1 kristaps 836: }
837:
838: static int
1.45 schwarze 839: woptions(struct curparse *curp, char *arg)
1.1 kristaps 840: {
1.10 schwarze 841: char *v, *o;
1.123 schwarze 842: const char *toks[7];
1.1 kristaps 843:
1.45 schwarze 844: toks[0] = "stop";
845: toks[1] = "all";
846: toks[2] = "warning";
847: toks[3] = "error";
1.123 schwarze 848: toks[4] = "unsupp";
849: toks[5] = "fatal";
850: toks[6] = NULL;
1.1 kristaps 851:
1.10 schwarze 852: while (*arg) {
853: o = arg;
1.17 schwarze 854: switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.90 schwarze 855: case 0:
1.45 schwarze 856: curp->wstop = 1;
1.1 kristaps 857: break;
1.90 schwarze 858: case 1:
859: case 2:
1.45 schwarze 860: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 861: break;
1.90 schwarze 862: case 3:
1.45 schwarze 863: curp->wlevel = MANDOCLEVEL_ERROR;
1.1 kristaps 864: break;
1.90 schwarze 865: case 4:
1.123 schwarze 866: curp->wlevel = MANDOCLEVEL_UNSUPP;
867: break;
868: case 5:
1.121 schwarze 869: curp->wlevel = MANDOCLEVEL_BADARG;
1.19 schwarze 870: break;
1.1 kristaps 871: default:
1.152 schwarze 872: warnx("-W %s: Bad argument", o);
1.150 schwarze 873: return 0;
1.1 kristaps 874: }
1.10 schwarze 875: }
1.1 kristaps 876:
1.150 schwarze 877: return 1;
1.1 kristaps 878: }
879:
1.75 schwarze 880: static void
1.90 schwarze 881: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.76 schwarze 882: const char *file, int line, int col, const char *msg)
1.30 schwarze 883: {
1.94 schwarze 884: const char *mparse_msg;
1.45 schwarze 885:
1.152 schwarze 886: fprintf(stderr, "%s: %s:", __progname, file);
1.92 schwarze 887:
888: if (line)
889: fprintf(stderr, "%d:%d:", line, col + 1);
890:
1.94 schwarze 891: fprintf(stderr, " %s", mparse_strlevel(lvl));
892:
893: if (NULL != (mparse_msg = mparse_strerror(t)))
894: fprintf(stderr, ": %s", mparse_msg);
1.30 schwarze 895:
896: if (msg)
897: fprintf(stderr, ": %s", msg);
1.76 schwarze 898:
1.30 schwarze 899: fputc('\n', stderr);
1.95 schwarze 900: }
901:
1.130 schwarze 902: static pid_t
1.149 schwarze 903: spawn_pager(struct tag_files *tag_files)
1.95 schwarze 904: {
905: #define MAX_PAGER_ARGS 16
906: char *argv[MAX_PAGER_ARGS];
907: const char *pager;
908: char *cp;
1.144 schwarze 909: size_t cmdlen;
1.95 schwarze 910: int argc;
1.130 schwarze 911: pid_t pager_pid;
1.95 schwarze 912:
1.144 schwarze 913: pager = getenv("MANPAGER");
914: if (pager == NULL || *pager == '\0')
915: pager = getenv("PAGER");
916: if (pager == NULL || *pager == '\0')
917: pager = "more -s";
918: cp = mandoc_strdup(pager);
919:
920: /*
921: * Parse the pager command into words.
922: * Intentionally do not do anything fancy here.
923: */
924:
925: argc = 0;
926: while (argc + 4 < MAX_PAGER_ARGS) {
927: argv[argc++] = cp;
928: cp = strchr(cp, ' ');
929: if (cp == NULL)
930: break;
931: *cp++ = '\0';
932: while (*cp == ' ')
933: cp++;
934: if (*cp == '\0')
935: break;
936: }
937:
1.149 schwarze 938: /* For more(1) and less(1), use the tag file. */
1.144 schwarze 939:
1.149 schwarze 940: if ((cmdlen = strlen(argv[0])) >= 4) {
1.144 schwarze 941: cp = argv[0] + cmdlen - 4;
1.149 schwarze 942: if (strcmp(cp, "less") == 0 || strcmp(cp, "more") == 0) {
943: argv[argc++] = mandoc_strdup("-T");
944: argv[argc++] = tag_files->tfn;
945: }
1.144 schwarze 946: }
1.149 schwarze 947: argv[argc++] = tag_files->ofn;
1.144 schwarze 948: argv[argc] = NULL;
949:
1.130 schwarze 950: switch (pager_pid = fork()) {
1.95 schwarze 951: case -1:
1.152 schwarze 952: err((int)MANDOCLEVEL_SYSERR, "fork");
1.95 schwarze 953: case 0:
1.129 schwarze 954: break;
955: default:
1.154 schwarze 956: if (pledge("stdio rpath tmppath", NULL) == -1)
957: err(1, "pledge");
1.150 schwarze 958: return pager_pid;
1.95 schwarze 959: }
960:
1.129 schwarze 961: /* The child process becomes the pager. */
1.95 schwarze 962:
1.152 schwarze 963: if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
964: err((int)MANDOCLEVEL_SYSERR, "pager stdout");
1.149 schwarze 965: close(tag_files->ofd);
966: close(tag_files->tfd);
1.95 schwarze 967: execvp(argv[0], argv);
1.152 schwarze 968: err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
1.30 schwarze 969: }