Annotation of src/usr.bin/mandoc/main.c, Revision 1.161
1.161 ! schwarze 1: /* $OpenBSD: main.c,v 1.160 2015/10/22 21:02:55 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.160 schwarze 449: if (curp.outdata != NULL) {
450: switch (curp.outtype) {
451: case OUTT_HTML:
452: html_free(curp.outdata);
453: break;
454: case OUTT_UTF8:
455: case OUTT_LOCALE:
456: case OUTT_ASCII:
457: ascii_free(curp.outdata);
458: break;
459: case OUTT_PDF:
460: case OUTT_PS:
461: pspdf_free(curp.outdata);
462: break;
463: default:
464: break;
465: }
1.158 schwarze 466: }
1.102 schwarze 467: mparse_free(curp.mp);
1.155 schwarze 468: mchars_free();
1.95 schwarze 469:
470: out:
471: if (search.argmode != ARG_FILE) {
1.134 schwarze 472: manconf_free(&conf);
1.95 schwarze 473: mansearch_free(res, sz);
474: mansearch_setup(0);
475: }
476:
1.83 schwarze 477: free(defos);
1.1 kristaps 478:
1.129 schwarze 479: /*
1.149 schwarze 480: * When using a pager, finish writing both temporary files,
481: * fork it, wait for the user to close it, and clean up.
1.129 schwarze 482: */
483:
1.149 schwarze 484: if (tag_files != NULL) {
1.130 schwarze 485: fclose(stdout);
1.144 schwarze 486: tag_write();
1.149 schwarze 487: waitpid(spawn_pager(tag_files), NULL, 0);
1.144 schwarze 488: tag_unlink();
1.130 schwarze 489: }
1.129 schwarze 490:
1.150 schwarze 491: return (int)rc;
1.1 kristaps 492: }
493:
1.20 schwarze 494: static void
1.95 schwarze 495: usage(enum argmode argmode)
1.1 kristaps 496: {
497:
1.95 schwarze 498: switch (argmode) {
499: case ARG_FILE:
1.133 schwarze 500: fputs("usage: mandoc [-acfhkl] [-I os=name] "
501: "[-K encoding] [-mformat] [-O option]\n"
502: "\t [-T output] [-W level] [file ...]\n", stderr);
1.95 schwarze 503: break;
504: case ARG_NAME:
1.126 schwarze 505: fputs("usage: man [-acfhklw] [-C file] [-I os=name] "
1.114 jmc 506: "[-K encoding] [-M path] [-m path]\n"
507: "\t [-O option=value] [-S subsection] [-s section] "
508: "[-T output] [-W level]\n"
1.95 schwarze 509: "\t [section] name ...\n", stderr);
510: break;
511: case ARG_WORD:
1.126 schwarze 512: fputs("usage: whatis [-acfhklw] [-C file] "
1.96 schwarze 513: "[-M path] [-m path] [-O outkey] [-S arch]\n"
514: "\t [-s section] name ...\n", stderr);
1.95 schwarze 515: break;
516: case ARG_EXPR:
1.126 schwarze 517: fputs("usage: apropos [-acfhklw] [-C file] "
1.96 schwarze 518: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.95 schwarze 519: "\t [-s section] expression ...\n", stderr);
520: break;
521: }
1.47 schwarze 522: exit((int)MANDOCLEVEL_BADARG);
1.119 schwarze 523: }
524:
525: static int
526: fs_lookup(const struct manpaths *paths, size_t ipath,
527: const char *sec, const char *arch, const char *name,
528: struct manpage **res, size_t *ressz)
529: {
1.127 schwarze 530: glob_t globinfo;
1.119 schwarze 531: struct manpage *page;
532: char *file;
1.127 schwarze 533: int form, globres;
1.119 schwarze 534:
1.127 schwarze 535: form = FORM_SRC;
1.119 schwarze 536: mandoc_asprintf(&file, "%s/man%s/%s.%s",
537: paths->paths[ipath], sec, name, sec);
1.127 schwarze 538: if (access(file, R_OK) != -1)
1.119 schwarze 539: goto found;
540: free(file);
541:
542: mandoc_asprintf(&file, "%s/cat%s/%s.0",
543: paths->paths[ipath], sec, name);
544: if (access(file, R_OK) != -1) {
545: form = FORM_CAT;
546: goto found;
547: }
548: free(file);
549:
550: if (arch != NULL) {
551: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
552: paths->paths[ipath], sec, arch, name, sec);
1.127 schwarze 553: if (access(file, R_OK) != -1)
1.119 schwarze 554: goto found;
555: free(file);
556: }
1.127 schwarze 557:
1.145 schwarze 558: mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",
1.127 schwarze 559: paths->paths[ipath], sec, name);
560: globres = glob(file, 0, NULL, &globinfo);
561: if (globres != 0 && globres != GLOB_NOMATCH)
1.152 schwarze 562: warn("%s: glob", file);
1.127 schwarze 563: free(file);
564: if (globres == 0)
565: file = mandoc_strdup(*globinfo.gl_pathv);
566: globfree(&globinfo);
567: if (globres != 0)
1.150 schwarze 568: return 0;
1.119 schwarze 569:
570: found:
1.152 schwarze 571: warnx("outdated mandoc.db lacks %s(%s) entry, run makewhatis %s",
572: name, sec, paths->paths[ipath]);
1.119 schwarze 573: *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
574: page = *res + (*ressz - 1);
575: page->file = file;
576: page->names = NULL;
577: page->output = NULL;
578: page->ipath = ipath;
579: page->bits = NAME_FILE & NAME_MASK;
580: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
581: page->form = form;
1.150 schwarze 582: return 1;
1.119 schwarze 583: }
584:
585: static void
586: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
587: int argc, char **argv, struct manpage **res, size_t *ressz)
588: {
589: const char *const sections[] =
590: {"1", "8", "6", "2", "3", "3p", "5", "7", "4", "9"};
591: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
592:
593: size_t ipath, isec, lastsz;
594:
595: assert(cfg->argmode == ARG_NAME);
596:
597: *res = NULL;
598: *ressz = lastsz = 0;
599: while (argc) {
600: for (ipath = 0; ipath < paths->sz; ipath++) {
601: if (cfg->sec != NULL) {
602: if (fs_lookup(paths, ipath, cfg->sec,
603: cfg->arch, *argv, res, ressz) &&
604: cfg->firstmatch)
605: return;
606: } else for (isec = 0; isec < nsec; isec++)
607: if (fs_lookup(paths, ipath, sections[isec],
608: cfg->arch, *argv, res, ressz) &&
609: cfg->firstmatch)
610: return;
611: }
612: if (*ressz == lastsz)
1.152 schwarze 613: warnx("No entry for %s in the manual.", *argv);
1.119 schwarze 614: lastsz = *ressz;
615: argv++;
616: argc--;
617: }
1.1 kristaps 618: }
619:
1.27 schwarze 620: static void
1.132 schwarze 621: parse(struct curparse *curp, int fd, const char *file)
1.52 schwarze 622: {
1.132 schwarze 623: enum mandoclevel rctmp;
1.139 schwarze 624: struct roff_man *man;
1.52 schwarze 625:
1.76 schwarze 626: /* Begin by parsing the file itself. */
1.52 schwarze 627:
1.76 schwarze 628: assert(file);
629: assert(fd >= -1);
1.52 schwarze 630:
1.132 schwarze 631: rctmp = mparse_readfd(curp->mp, fd, file);
632: if (rc < rctmp)
633: rc = rctmp;
1.1 kristaps 634:
1.51 schwarze 635: /*
1.76 schwarze 636: * With -Wstop and warnings or errors of at least the requested
637: * level, do not produce output.
1.51 schwarze 638: */
639:
1.132 schwarze 640: if (rctmp != MANDOCLEVEL_OK && curp->wstop)
641: return;
1.51 schwarze 642:
643: /* If unset, allocate output dev now (if applicable). */
644:
1.158 schwarze 645: if (curp->outdata == NULL) {
1.51 schwarze 646: switch (curp->outtype) {
1.90 schwarze 647: case OUTT_HTML:
1.155 schwarze 648: curp->outdata = html_alloc(curp->outopts);
1.77 schwarze 649: break;
1.90 schwarze 650: case OUTT_UTF8:
1.155 schwarze 651: curp->outdata = utf8_alloc(curp->outopts);
1.77 schwarze 652: break;
1.90 schwarze 653: case OUTT_LOCALE:
1.155 schwarze 654: curp->outdata = locale_alloc(curp->outopts);
1.51 schwarze 655: break;
1.90 schwarze 656: case OUTT_ASCII:
1.155 schwarze 657: curp->outdata = ascii_alloc(curp->outopts);
1.51 schwarze 658: break;
1.90 schwarze 659: case OUTT_PDF:
1.155 schwarze 660: curp->outdata = pdf_alloc(curp->outopts);
1.51 schwarze 661: break;
1.90 schwarze 662: case OUTT_PS:
1.155 schwarze 663: curp->outdata = ps_alloc(curp->outopts);
1.51 schwarze 664: break;
665: default:
666: break;
667: }
1.158 schwarze 668: }
1.51 schwarze 669:
1.158 schwarze 670: mparse_result(curp->mp, &man, NULL);
671:
672: /* Execute the out device, if it exists. */
673:
674: if (man == NULL)
675: return;
676: if (man->macroset == MACROSET_MDOC) {
1.159 schwarze 677: mdoc_validate(man);
1.51 schwarze 678: switch (curp->outtype) {
1.90 schwarze 679: case OUTT_HTML:
1.158 schwarze 680: html_mdoc(curp->outdata, man);
1.51 schwarze 681: break;
1.90 schwarze 682: case OUTT_TREE:
1.158 schwarze 683: tree_mdoc(curp->outdata, man);
1.51 schwarze 684: break;
1.90 schwarze 685: case OUTT_MAN:
1.158 schwarze 686: man_mdoc(curp->outdata, man);
1.78 schwarze 687: break;
1.90 schwarze 688: case OUTT_PDF:
689: case OUTT_ASCII:
690: case OUTT_UTF8:
691: case OUTT_LOCALE:
692: case OUTT_PS:
1.158 schwarze 693: terminal_mdoc(curp->outdata, man);
694: break;
695: default:
696: break;
697: }
698: }
699: if (man->macroset == MACROSET_MAN) {
1.161 ! schwarze 700: man_validate(man);
1.158 schwarze 701: switch (curp->outtype) {
702: case OUTT_HTML:
703: html_man(curp->outdata, man);
704: break;
705: case OUTT_TREE:
706: tree_man(curp->outdata, man);
707: break;
708: case OUTT_MAN:
709: man_man(curp->outdata, man);
710: break;
711: case OUTT_PDF:
712: case OUTT_ASCII:
713: case OUTT_UTF8:
714: case OUTT_LOCALE:
715: case OUTT_PS:
716: terminal_man(curp->outdata, man);
1.51 schwarze 717: break;
718: default:
719: break;
720: }
721: }
1.1 kristaps 722: }
723:
1.132 schwarze 724: static void
1.105 schwarze 725: passthrough(const char *file, int fd, int synopsis_only)
1.95 schwarze 726: {
1.105 schwarze 727: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
728: const char synr[] = "SYNOPSIS";
729:
730: FILE *stream;
1.95 schwarze 731: const char *syscall;
1.105 schwarze 732: char *line;
733: size_t len, off;
734: ssize_t nw;
735: int print;
1.116 schwarze 736:
737: fflush(stdout);
1.105 schwarze 738:
739: if ((stream = fdopen(fd, "r")) == NULL) {
740: close(fd);
741: syscall = "fdopen";
742: goto fail;
743: }
1.95 schwarze 744:
1.105 schwarze 745: print = 0;
746: while ((line = fgetln(stream, &len)) != NULL) {
747: if (synopsis_only) {
748: if (print) {
749: if ( ! isspace((unsigned char)*line))
750: goto done;
751: while (len &&
752: isspace((unsigned char)*line)) {
753: line++;
754: len--;
755: }
756: } else {
757: if ((len == sizeof(synb) &&
758: ! strncmp(line, synb, len - 1)) ||
759: (len == sizeof(synr) &&
760: ! strncmp(line, synr, len - 1)))
761: print = 1;
762: continue;
763: }
764: }
765: for (off = 0; off < len; off += nw)
766: if ((nw = write(STDOUT_FILENO, line + off,
767: len - off)) == -1 || nw == 0) {
768: fclose(stream);
1.95 schwarze 769: syscall = "write";
770: goto fail;
771: }
1.105 schwarze 772: }
1.95 schwarze 773:
1.105 schwarze 774: if (ferror(stream)) {
775: fclose(stream);
776: syscall = "fgetln";
777: goto fail;
778: }
1.101 schwarze 779:
1.105 schwarze 780: done:
781: fclose(stream);
1.132 schwarze 782: return;
1.95 schwarze 783:
784: fail:
1.152 schwarze 785: warn("%s: SYSERR: %s", file, syscall);
1.132 schwarze 786: if (rc < MANDOCLEVEL_SYSERR)
787: rc = MANDOCLEVEL_SYSERR;
1.103 schwarze 788: }
789:
790: static int
791: koptions(int *options, char *arg)
792: {
793:
794: if ( ! strcmp(arg, "utf-8")) {
795: *options |= MPARSE_UTF8;
796: *options &= ~MPARSE_LATIN1;
797: } else if ( ! strcmp(arg, "iso-8859-1")) {
798: *options |= MPARSE_LATIN1;
799: *options &= ~MPARSE_UTF8;
800: } else if ( ! strcmp(arg, "us-ascii")) {
801: *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
802: } else {
1.152 schwarze 803: warnx("-K %s: Bad argument", arg);
1.150 schwarze 804: return 0;
1.103 schwarze 805: }
1.150 schwarze 806: return 1;
1.95 schwarze 807: }
808:
1.1 kristaps 809: static int
1.87 schwarze 810: moptions(int *options, char *arg)
1.1 kristaps 811: {
812:
1.95 schwarze 813: if (arg == NULL)
814: /* nothing to do */;
815: else if (0 == strcmp(arg, "doc"))
1.87 schwarze 816: *options |= MPARSE_MDOC;
1.1 kristaps 817: else if (0 == strcmp(arg, "andoc"))
1.87 schwarze 818: /* nothing to do */;
1.1 kristaps 819: else if (0 == strcmp(arg, "an"))
1.87 schwarze 820: *options |= MPARSE_MAN;
1.1 kristaps 821: else {
1.152 schwarze 822: warnx("-m %s: Bad argument", arg);
1.150 schwarze 823: return 0;
1.1 kristaps 824: }
825:
1.150 schwarze 826: return 1;
1.1 kristaps 827: }
828:
829: static int
1.22 schwarze 830: toptions(struct curparse *curp, char *arg)
1.1 kristaps 831: {
832:
833: if (0 == strcmp(arg, "ascii"))
1.22 schwarze 834: curp->outtype = OUTT_ASCII;
835: else if (0 == strcmp(arg, "lint")) {
836: curp->outtype = OUTT_LINT;
1.45 schwarze 837: curp->wlevel = MANDOCLEVEL_WARNING;
1.76 schwarze 838: } else if (0 == strcmp(arg, "tree"))
1.22 schwarze 839: curp->outtype = OUTT_TREE;
1.78 schwarze 840: else if (0 == strcmp(arg, "man"))
841: curp->outtype = OUTT_MAN;
1.17 schwarze 842: else if (0 == strcmp(arg, "html"))
1.22 schwarze 843: curp->outtype = OUTT_HTML;
1.77 schwarze 844: else if (0 == strcmp(arg, "utf8"))
845: curp->outtype = OUTT_UTF8;
846: else if (0 == strcmp(arg, "locale"))
847: curp->outtype = OUTT_LOCALE;
1.21 schwarze 848: else if (0 == strcmp(arg, "xhtml"))
1.102 schwarze 849: curp->outtype = OUTT_HTML;
1.36 schwarze 850: else if (0 == strcmp(arg, "ps"))
851: curp->outtype = OUTT_PS;
1.43 schwarze 852: else if (0 == strcmp(arg, "pdf"))
853: curp->outtype = OUTT_PDF;
1.1 kristaps 854: else {
1.152 schwarze 855: warnx("-T %s: Bad argument", arg);
1.150 schwarze 856: return 0;
1.1 kristaps 857: }
858:
1.150 schwarze 859: return 1;
1.1 kristaps 860: }
861:
862: static int
1.45 schwarze 863: woptions(struct curparse *curp, char *arg)
1.1 kristaps 864: {
1.10 schwarze 865: char *v, *o;
1.123 schwarze 866: const char *toks[7];
1.1 kristaps 867:
1.45 schwarze 868: toks[0] = "stop";
869: toks[1] = "all";
870: toks[2] = "warning";
871: toks[3] = "error";
1.123 schwarze 872: toks[4] = "unsupp";
873: toks[5] = "fatal";
874: toks[6] = NULL;
1.1 kristaps 875:
1.10 schwarze 876: while (*arg) {
877: o = arg;
1.17 schwarze 878: switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.90 schwarze 879: case 0:
1.45 schwarze 880: curp->wstop = 1;
1.1 kristaps 881: break;
1.90 schwarze 882: case 1:
883: case 2:
1.45 schwarze 884: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 885: break;
1.90 schwarze 886: case 3:
1.45 schwarze 887: curp->wlevel = MANDOCLEVEL_ERROR;
1.1 kristaps 888: break;
1.90 schwarze 889: case 4:
1.123 schwarze 890: curp->wlevel = MANDOCLEVEL_UNSUPP;
891: break;
892: case 5:
1.121 schwarze 893: curp->wlevel = MANDOCLEVEL_BADARG;
1.19 schwarze 894: break;
1.1 kristaps 895: default:
1.152 schwarze 896: warnx("-W %s: Bad argument", o);
1.150 schwarze 897: return 0;
1.1 kristaps 898: }
1.10 schwarze 899: }
1.1 kristaps 900:
1.150 schwarze 901: return 1;
1.1 kristaps 902: }
903:
1.75 schwarze 904: static void
1.90 schwarze 905: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.76 schwarze 906: const char *file, int line, int col, const char *msg)
1.30 schwarze 907: {
1.94 schwarze 908: const char *mparse_msg;
1.45 schwarze 909:
1.152 schwarze 910: fprintf(stderr, "%s: %s:", __progname, file);
1.92 schwarze 911:
912: if (line)
913: fprintf(stderr, "%d:%d:", line, col + 1);
914:
1.94 schwarze 915: fprintf(stderr, " %s", mparse_strlevel(lvl));
916:
917: if (NULL != (mparse_msg = mparse_strerror(t)))
918: fprintf(stderr, ": %s", mparse_msg);
1.30 schwarze 919:
920: if (msg)
921: fprintf(stderr, ": %s", msg);
1.76 schwarze 922:
1.30 schwarze 923: fputc('\n', stderr);
1.95 schwarze 924: }
925:
1.130 schwarze 926: static pid_t
1.149 schwarze 927: spawn_pager(struct tag_files *tag_files)
1.95 schwarze 928: {
929: #define MAX_PAGER_ARGS 16
930: char *argv[MAX_PAGER_ARGS];
931: const char *pager;
932: char *cp;
1.144 schwarze 933: size_t cmdlen;
1.95 schwarze 934: int argc;
1.130 schwarze 935: pid_t pager_pid;
1.95 schwarze 936:
1.144 schwarze 937: pager = getenv("MANPAGER");
938: if (pager == NULL || *pager == '\0')
939: pager = getenv("PAGER");
940: if (pager == NULL || *pager == '\0')
941: pager = "more -s";
942: cp = mandoc_strdup(pager);
943:
944: /*
945: * Parse the pager command into words.
946: * Intentionally do not do anything fancy here.
947: */
948:
949: argc = 0;
950: while (argc + 4 < MAX_PAGER_ARGS) {
951: argv[argc++] = cp;
952: cp = strchr(cp, ' ');
953: if (cp == NULL)
954: break;
955: *cp++ = '\0';
956: while (*cp == ' ')
957: cp++;
958: if (*cp == '\0')
959: break;
960: }
961:
1.149 schwarze 962: /* For more(1) and less(1), use the tag file. */
1.144 schwarze 963:
1.149 schwarze 964: if ((cmdlen = strlen(argv[0])) >= 4) {
1.144 schwarze 965: cp = argv[0] + cmdlen - 4;
1.149 schwarze 966: if (strcmp(cp, "less") == 0 || strcmp(cp, "more") == 0) {
967: argv[argc++] = mandoc_strdup("-T");
968: argv[argc++] = tag_files->tfn;
969: }
1.144 schwarze 970: }
1.149 schwarze 971: argv[argc++] = tag_files->ofn;
1.144 schwarze 972: argv[argc] = NULL;
973:
1.130 schwarze 974: switch (pager_pid = fork()) {
1.95 schwarze 975: case -1:
1.152 schwarze 976: err((int)MANDOCLEVEL_SYSERR, "fork");
1.95 schwarze 977: case 0:
1.129 schwarze 978: break;
979: default:
1.154 schwarze 980: if (pledge("stdio rpath tmppath", NULL) == -1)
981: err(1, "pledge");
1.150 schwarze 982: return pager_pid;
1.95 schwarze 983: }
984:
1.129 schwarze 985: /* The child process becomes the pager. */
1.95 schwarze 986:
1.152 schwarze 987: if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
988: err((int)MANDOCLEVEL_SYSERR, "pager stdout");
1.149 schwarze 989: close(tag_files->ofd);
990: close(tag_files->tfd);
1.95 schwarze 991: execvp(argv[0], argv);
1.152 schwarze 992: err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
1.30 schwarze 993: }
![[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