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