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