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