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