Annotation of src/usr.bin/mandoc/main.c, Revision 1.142
1.142 ! schwarze 1: /* $OpenBSD: main.c,v 1.141 2015/04/19 15:10:04 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.139 schwarze 54: typedef void (*out_mdoc)(void *, const struct roff_man *);
55: typedef void (*out_man)(void *, const struct roff_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:
1.142 ! schwarze 334: if (sz == 0) {
! 335: if (search.argmode == ARG_NAME)
! 336: fs_search(&search, &conf.manpath,
! 337: argc, argv, &res, &sz);
! 338: else
! 339: fprintf(stderr,
! 340: "%s: nothing appropriate\n",
! 341: progname);
! 342: }
1.95 schwarze 343:
344: if (sz == 0) {
345: rc = MANDOCLEVEL_BADARG;
346: goto out;
347: }
348:
349: /*
350: * For standard man(1) and -a output mode,
351: * prepare for copying filename pointers
352: * into the program parameter array.
353: */
354:
355: if (outmode == OUTMODE_ONE) {
356: argc = 1;
357: best_prio = 10;
358: } else if (outmode == OUTMODE_ALL)
359: argc = (int)sz;
360:
361: /* Iterate all matching manuals. */
362:
1.119 schwarze 363: resp = res;
1.95 schwarze 364: for (i = 0; i < sz; i++) {
365: if (outmode == OUTMODE_FLN)
366: puts(res[i].file);
367: else if (outmode == OUTMODE_LST)
368: printf("%s - %s\n", res[i].names,
369: res[i].output == NULL ? "" :
370: res[i].output);
371: else if (outmode == OUTMODE_ONE) {
372: /* Search for the best section. */
373: isec = strcspn(res[i].file, "123456789");
374: sec = res[i].file[isec];
375: if ('\0' == sec)
376: continue;
377: prio = sec_prios[sec - '1'];
378: if (prio >= best_prio)
379: continue;
380: best_prio = prio;
381: resp = res + i;
382: }
1.1 kristaps 383: }
384:
1.95 schwarze 385: /*
386: * For man(1), -a and -i output mode, fall through
387: * to the main mandoc(1) code iterating files
388: * and running the parsers on each of them.
389: */
390:
391: if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
392: goto out;
393: }
394:
395: /* mandoc(1) */
396:
1.115 schwarze 397: if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths))
1.95 schwarze 398: return((int)MANDOCLEVEL_BADARG);
399:
1.102 schwarze 400: curp.mchars = mchars_alloc();
401: curp.mp = mparse_alloc(options, curp.wlevel, mmsg,
402: curp.mchars, defos);
1.76 schwarze 403:
1.80 schwarze 404: /*
405: * Conditionally start up the lookaside buffer before parsing.
406: */
407: if (OUTT_MAN == curp.outtype)
408: mparse_keep(curp.mp);
409:
1.124 schwarze 410: if (argc < 1) {
1.130 schwarze 411: if (pager_pid == 1 && isatty(STDOUT_FILENO))
412: pager_pid = spawn_pager();
1.132 schwarze 413: parse(&curp, STDIN_FILENO, "<stdin>");
1.118 schwarze 414: }
1.27 schwarze 415:
1.124 schwarze 416: while (argc > 0) {
1.120 schwarze 417: rctmp = mparse_open(curp.mp, &fd,
1.118 schwarze 418: resp != NULL ? resp->file : *argv);
1.120 schwarze 419: if (rc < rctmp)
420: rc = rctmp;
1.118 schwarze 421:
422: if (fd != -1) {
1.130 schwarze 423: if (pager_pid == 1 && isatty(STDOUT_FILENO))
424: pager_pid = spawn_pager();
1.118 schwarze 425:
426: if (resp == NULL)
1.132 schwarze 427: parse(&curp, fd, *argv);
1.100 schwarze 428: else if (resp->form & FORM_SRC) {
1.97 schwarze 429: /* For .so only; ignore failure. */
1.134 schwarze 430: chdir(conf.manpath.paths[resp->ipath]);
1.132 schwarze 431: parse(&curp, fd, resp->file);
432: } else
1.135 schwarze 433: passthrough(resp->file, fd,
434: conf.output.synopsisonly);
1.118 schwarze 435:
1.120 schwarze 436: rctmp = mparse_wait(curp.mp);
437: if (rc < rctmp)
438: rc = rctmp;
1.118 schwarze 439:
440: if (argc > 1 && curp.outtype <= OUTT_UTF8)
441: ascii_sepline(curp.outdata);
1.100 schwarze 442: }
443:
1.76 schwarze 444: if (MANDOCLEVEL_OK != rc && curp.wstop)
1.27 schwarze 445: break;
1.116 schwarze 446:
1.118 schwarze 447: if (resp != NULL)
448: resp++;
449: else
450: argv++;
451: if (--argc)
452: mparse_reset(curp.mp);
1.1 kristaps 453: }
454:
455: if (curp.outfree)
456: (*curp.outfree)(curp.outdata);
1.102 schwarze 457: mparse_free(curp.mp);
458: mchars_free(curp.mchars);
1.95 schwarze 459:
460: out:
461: if (search.argmode != ARG_FILE) {
1.134 schwarze 462: manconf_free(&conf);
1.95 schwarze 463: mansearch_free(res, sz);
464: mansearch_setup(0);
465: }
466:
1.83 schwarze 467: free(defos);
1.1 kristaps 468:
1.129 schwarze 469: /*
1.130 schwarze 470: * If a pager is attached, flush the pipe leading to it
471: * and signal end of file such that the user can browse
472: * to the end. Then wait for the user to close the pager.
1.129 schwarze 473: */
474:
1.130 schwarze 475: if (pager_pid != 0 && pager_pid != 1) {
476: fclose(stdout);
477: waitpid(pager_pid, NULL, 0);
478: }
1.129 schwarze 479:
1.76 schwarze 480: return((int)rc);
1.1 kristaps 481: }
482:
1.20 schwarze 483: static void
1.95 schwarze 484: usage(enum argmode argmode)
1.1 kristaps 485: {
486:
1.95 schwarze 487: switch (argmode) {
488: case ARG_FILE:
1.133 schwarze 489: fputs("usage: mandoc [-acfhkl] [-I os=name] "
490: "[-K encoding] [-mformat] [-O option]\n"
491: "\t [-T output] [-W level] [file ...]\n", stderr);
1.95 schwarze 492: break;
493: case ARG_NAME:
1.126 schwarze 494: fputs("usage: man [-acfhklw] [-C file] [-I os=name] "
1.114 jmc 495: "[-K encoding] [-M path] [-m path]\n"
496: "\t [-O option=value] [-S subsection] [-s section] "
497: "[-T output] [-W level]\n"
1.95 schwarze 498: "\t [section] name ...\n", stderr);
499: break;
500: case ARG_WORD:
1.126 schwarze 501: fputs("usage: whatis [-acfhklw] [-C file] "
1.96 schwarze 502: "[-M path] [-m path] [-O outkey] [-S arch]\n"
503: "\t [-s section] name ...\n", stderr);
1.95 schwarze 504: break;
505: case ARG_EXPR:
1.126 schwarze 506: fputs("usage: apropos [-acfhklw] [-C file] "
1.96 schwarze 507: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.95 schwarze 508: "\t [-s section] expression ...\n", stderr);
509: break;
510: }
1.47 schwarze 511: exit((int)MANDOCLEVEL_BADARG);
1.119 schwarze 512: }
513:
514: static int
515: fs_lookup(const struct manpaths *paths, size_t ipath,
516: const char *sec, const char *arch, const char *name,
517: struct manpage **res, size_t *ressz)
518: {
1.127 schwarze 519: glob_t globinfo;
1.119 schwarze 520: struct manpage *page;
521: char *file;
1.127 schwarze 522: int form, globres;
1.119 schwarze 523:
1.127 schwarze 524: form = FORM_SRC;
1.119 schwarze 525: mandoc_asprintf(&file, "%s/man%s/%s.%s",
526: paths->paths[ipath], sec, name, sec);
1.127 schwarze 527: if (access(file, R_OK) != -1)
1.119 schwarze 528: goto found;
529: free(file);
530:
531: mandoc_asprintf(&file, "%s/cat%s/%s.0",
532: paths->paths[ipath], sec, name);
533: if (access(file, R_OK) != -1) {
534: form = FORM_CAT;
535: goto found;
536: }
537: free(file);
538:
539: if (arch != NULL) {
540: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
541: paths->paths[ipath], sec, arch, name, sec);
1.127 schwarze 542: if (access(file, R_OK) != -1)
1.119 schwarze 543: goto found;
544: free(file);
545: }
1.127 schwarze 546:
547: mandoc_asprintf(&file, "%s/man%s/%s.*",
548: paths->paths[ipath], sec, name);
549: globres = glob(file, 0, NULL, &globinfo);
550: if (globres != 0 && globres != GLOB_NOMATCH)
551: fprintf(stderr, "%s: %s: glob: %s\n",
552: progname, file, strerror(errno));
553: free(file);
554: if (globres == 0)
555: file = mandoc_strdup(*globinfo.gl_pathv);
556: globfree(&globinfo);
557: if (globres != 0)
558: return(0);
1.119 schwarze 559:
560: found:
1.138 schwarze 561: fprintf(stderr, "%s: outdated mandoc.db lacks %s(%s) entry, run "
562: "makewhatis %s\n", progname, name, sec, paths->paths[ipath]);
1.119 schwarze 563: *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
564: page = *res + (*ressz - 1);
565: page->file = file;
566: page->names = NULL;
567: page->output = NULL;
568: page->ipath = ipath;
569: page->bits = NAME_FILE & NAME_MASK;
570: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
571: page->form = form;
572: return(1);
573: }
574:
575: static void
576: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
577: int argc, char **argv, struct manpage **res, size_t *ressz)
578: {
579: const char *const sections[] =
580: {"1", "8", "6", "2", "3", "3p", "5", "7", "4", "9"};
581: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
582:
583: size_t ipath, isec, lastsz;
584:
585: assert(cfg->argmode == ARG_NAME);
586:
587: *res = NULL;
588: *ressz = lastsz = 0;
589: while (argc) {
590: for (ipath = 0; ipath < paths->sz; ipath++) {
591: if (cfg->sec != NULL) {
592: if (fs_lookup(paths, ipath, cfg->sec,
593: cfg->arch, *argv, res, ressz) &&
594: cfg->firstmatch)
595: return;
596: } else for (isec = 0; isec < nsec; isec++)
597: if (fs_lookup(paths, ipath, sections[isec],
598: cfg->arch, *argv, res, ressz) &&
599: cfg->firstmatch)
600: return;
601: }
602: if (*ressz == lastsz)
603: fprintf(stderr,
604: "%s: No entry for %s in the manual.\n",
605: progname, *argv);
606: lastsz = *ressz;
607: argv++;
608: argc--;
609: }
1.1 kristaps 610: }
611:
1.27 schwarze 612: static void
1.132 schwarze 613: parse(struct curparse *curp, int fd, const char *file)
1.52 schwarze 614: {
1.132 schwarze 615: enum mandoclevel rctmp;
1.139 schwarze 616: struct roff_man *man;
1.52 schwarze 617:
1.76 schwarze 618: /* Begin by parsing the file itself. */
1.52 schwarze 619:
1.76 schwarze 620: assert(file);
621: assert(fd >= -1);
1.52 schwarze 622:
1.132 schwarze 623: rctmp = mparse_readfd(curp->mp, fd, file);
624: if (rc < rctmp)
625: rc = rctmp;
1.1 kristaps 626:
1.51 schwarze 627: /*
1.76 schwarze 628: * With -Wstop and warnings or errors of at least the requested
629: * level, do not produce output.
1.51 schwarze 630: */
631:
1.132 schwarze 632: if (rctmp != MANDOCLEVEL_OK && curp->wstop)
633: return;
1.51 schwarze 634:
635: /* If unset, allocate output dev now (if applicable). */
636:
637: if ( ! (curp->outman && curp->outmdoc)) {
638: switch (curp->outtype) {
1.90 schwarze 639: case OUTT_HTML:
1.102 schwarze 640: curp->outdata = html_alloc(curp->mchars,
641: curp->outopts);
1.77 schwarze 642: curp->outfree = html_free;
643: break;
1.90 schwarze 644: case OUTT_UTF8:
1.102 schwarze 645: curp->outdata = utf8_alloc(curp->mchars,
646: curp->outopts);
1.77 schwarze 647: curp->outfree = ascii_free;
648: break;
1.90 schwarze 649: case OUTT_LOCALE:
1.102 schwarze 650: curp->outdata = locale_alloc(curp->mchars,
651: curp->outopts);
1.77 schwarze 652: curp->outfree = ascii_free;
1.51 schwarze 653: break;
1.90 schwarze 654: case OUTT_ASCII:
1.102 schwarze 655: curp->outdata = ascii_alloc(curp->mchars,
656: curp->outopts);
1.51 schwarze 657: curp->outfree = ascii_free;
658: break;
1.90 schwarze 659: case OUTT_PDF:
1.102 schwarze 660: curp->outdata = pdf_alloc(curp->mchars,
661: curp->outopts);
1.51 schwarze 662: curp->outfree = pspdf_free;
663: break;
1.90 schwarze 664: case OUTT_PS:
1.102 schwarze 665: curp->outdata = ps_alloc(curp->mchars,
666: curp->outopts);
1.51 schwarze 667: curp->outfree = pspdf_free;
668: break;
669: default:
670: break;
671: }
672:
673: switch (curp->outtype) {
1.90 schwarze 674: case OUTT_HTML:
1.51 schwarze 675: curp->outman = html_man;
676: curp->outmdoc = html_mdoc;
677: break;
1.90 schwarze 678: case OUTT_TREE:
1.51 schwarze 679: curp->outman = tree_man;
680: curp->outmdoc = tree_mdoc;
681: break;
1.90 schwarze 682: case OUTT_MAN:
1.78 schwarze 683: curp->outmdoc = man_mdoc;
1.80 schwarze 684: curp->outman = man_man;
1.78 schwarze 685: break;
1.90 schwarze 686: case OUTT_PDF:
1.51 schwarze 687: /* FALLTHROUGH */
1.90 schwarze 688: case OUTT_ASCII:
1.51 schwarze 689: /* FALLTHROUGH */
1.90 schwarze 690: case OUTT_UTF8:
1.77 schwarze 691: /* FALLTHROUGH */
1.90 schwarze 692: case OUTT_LOCALE:
1.77 schwarze 693: /* FALLTHROUGH */
1.90 schwarze 694: case OUTT_PS:
1.51 schwarze 695: curp->outman = terminal_man;
696: curp->outmdoc = terminal_mdoc;
697: break;
698: default:
699: break;
700: }
701: }
702:
1.140 schwarze 703: mparse_result(curp->mp, &man, NULL);
1.76 schwarze 704:
1.51 schwarze 705: /* Execute the out device, if it exists. */
706:
1.140 schwarze 707: if (man == NULL)
708: return;
709: if (curp->outmdoc != NULL && man->macroset == MACROSET_MDOC)
710: (*curp->outmdoc)(curp->outdata, man);
711: if (curp->outman != NULL && man->macroset == MACROSET_MAN)
1.76 schwarze 712: (*curp->outman)(curp->outdata, man);
1.1 kristaps 713: }
714:
1.132 schwarze 715: static void
1.105 schwarze 716: passthrough(const char *file, int fd, int synopsis_only)
1.95 schwarze 717: {
1.105 schwarze 718: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
719: const char synr[] = "SYNOPSIS";
720:
721: FILE *stream;
1.95 schwarze 722: const char *syscall;
1.105 schwarze 723: char *line;
724: size_t len, off;
725: ssize_t nw;
726: int print;
1.116 schwarze 727:
728: fflush(stdout);
1.105 schwarze 729:
730: if ((stream = fdopen(fd, "r")) == NULL) {
731: close(fd);
732: syscall = "fdopen";
733: goto fail;
734: }
1.95 schwarze 735:
1.105 schwarze 736: print = 0;
737: while ((line = fgetln(stream, &len)) != NULL) {
738: if (synopsis_only) {
739: if (print) {
740: if ( ! isspace((unsigned char)*line))
741: goto done;
742: while (len &&
743: isspace((unsigned char)*line)) {
744: line++;
745: len--;
746: }
747: } else {
748: if ((len == sizeof(synb) &&
749: ! strncmp(line, synb, len - 1)) ||
750: (len == sizeof(synr) &&
751: ! strncmp(line, synr, len - 1)))
752: print = 1;
753: continue;
754: }
755: }
756: for (off = 0; off < len; off += nw)
757: if ((nw = write(STDOUT_FILENO, line + off,
758: len - off)) == -1 || nw == 0) {
759: fclose(stream);
1.95 schwarze 760: syscall = "write";
761: goto fail;
762: }
1.105 schwarze 763: }
1.95 schwarze 764:
1.105 schwarze 765: if (ferror(stream)) {
766: fclose(stream);
767: syscall = "fgetln";
768: goto fail;
769: }
1.101 schwarze 770:
1.105 schwarze 771: done:
772: fclose(stream);
1.132 schwarze 773: return;
1.95 schwarze 774:
775: fail:
776: fprintf(stderr, "%s: %s: SYSERR: %s: %s",
777: progname, file, syscall, strerror(errno));
1.132 schwarze 778: if (rc < MANDOCLEVEL_SYSERR)
779: rc = MANDOCLEVEL_SYSERR;
1.103 schwarze 780: }
781:
782: static int
783: koptions(int *options, char *arg)
784: {
785:
786: if ( ! strcmp(arg, "utf-8")) {
787: *options |= MPARSE_UTF8;
788: *options &= ~MPARSE_LATIN1;
789: } else if ( ! strcmp(arg, "iso-8859-1")) {
790: *options |= MPARSE_LATIN1;
791: *options &= ~MPARSE_UTF8;
792: } else if ( ! strcmp(arg, "us-ascii")) {
793: *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
794: } else {
1.115 schwarze 795: fprintf(stderr, "%s: -K %s: Bad argument\n",
1.103 schwarze 796: progname, arg);
797: return(0);
798: }
799: return(1);
1.95 schwarze 800: }
801:
1.1 kristaps 802: static int
1.87 schwarze 803: moptions(int *options, char *arg)
1.1 kristaps 804: {
805:
1.95 schwarze 806: if (arg == NULL)
807: /* nothing to do */;
808: else if (0 == strcmp(arg, "doc"))
1.87 schwarze 809: *options |= MPARSE_MDOC;
1.1 kristaps 810: else if (0 == strcmp(arg, "andoc"))
1.87 schwarze 811: /* nothing to do */;
1.1 kristaps 812: else if (0 == strcmp(arg, "an"))
1.87 schwarze 813: *options |= MPARSE_MAN;
1.1 kristaps 814: else {
1.115 schwarze 815: fprintf(stderr, "%s: -m %s: Bad argument\n",
1.93 schwarze 816: progname, arg);
1.1 kristaps 817: return(0);
818: }
819:
820: return(1);
821: }
822:
823: static int
1.22 schwarze 824: toptions(struct curparse *curp, char *arg)
1.1 kristaps 825: {
826:
827: if (0 == strcmp(arg, "ascii"))
1.22 schwarze 828: curp->outtype = OUTT_ASCII;
829: else if (0 == strcmp(arg, "lint")) {
830: curp->outtype = OUTT_LINT;
1.45 schwarze 831: curp->wlevel = MANDOCLEVEL_WARNING;
1.76 schwarze 832: } else if (0 == strcmp(arg, "tree"))
1.22 schwarze 833: curp->outtype = OUTT_TREE;
1.78 schwarze 834: else if (0 == strcmp(arg, "man"))
835: curp->outtype = OUTT_MAN;
1.17 schwarze 836: else if (0 == strcmp(arg, "html"))
1.22 schwarze 837: curp->outtype = OUTT_HTML;
1.77 schwarze 838: else if (0 == strcmp(arg, "utf8"))
839: curp->outtype = OUTT_UTF8;
840: else if (0 == strcmp(arg, "locale"))
841: curp->outtype = OUTT_LOCALE;
1.21 schwarze 842: else if (0 == strcmp(arg, "xhtml"))
1.102 schwarze 843: curp->outtype = OUTT_HTML;
1.36 schwarze 844: else if (0 == strcmp(arg, "ps"))
845: curp->outtype = OUTT_PS;
1.43 schwarze 846: else if (0 == strcmp(arg, "pdf"))
847: curp->outtype = OUTT_PDF;
1.1 kristaps 848: else {
1.115 schwarze 849: fprintf(stderr, "%s: -T %s: Bad argument\n",
1.93 schwarze 850: progname, arg);
1.1 kristaps 851: return(0);
852: }
853:
854: return(1);
855: }
856:
857: static int
1.45 schwarze 858: woptions(struct curparse *curp, char *arg)
1.1 kristaps 859: {
1.10 schwarze 860: char *v, *o;
1.123 schwarze 861: const char *toks[7];
1.1 kristaps 862:
1.45 schwarze 863: toks[0] = "stop";
864: toks[1] = "all";
865: toks[2] = "warning";
866: toks[3] = "error";
1.123 schwarze 867: toks[4] = "unsupp";
868: toks[5] = "fatal";
869: toks[6] = NULL;
1.1 kristaps 870:
1.10 schwarze 871: while (*arg) {
872: o = arg;
1.17 schwarze 873: switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.90 schwarze 874: case 0:
1.45 schwarze 875: curp->wstop = 1;
1.1 kristaps 876: break;
1.90 schwarze 877: case 1:
1.45 schwarze 878: /* FALLTHROUGH */
1.90 schwarze 879: case 2:
1.45 schwarze 880: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 881: break;
1.90 schwarze 882: case 3:
1.45 schwarze 883: curp->wlevel = MANDOCLEVEL_ERROR;
1.1 kristaps 884: break;
1.90 schwarze 885: case 4:
1.123 schwarze 886: curp->wlevel = MANDOCLEVEL_UNSUPP;
887: break;
888: case 5:
1.121 schwarze 889: curp->wlevel = MANDOCLEVEL_BADARG;
1.19 schwarze 890: break;
1.1 kristaps 891: default:
1.115 schwarze 892: fprintf(stderr, "%s: -W %s: Bad argument\n",
1.93 schwarze 893: progname, o);
1.1 kristaps 894: return(0);
895: }
1.10 schwarze 896: }
1.1 kristaps 897:
898: return(1);
899: }
900:
1.75 schwarze 901: static void
1.90 schwarze 902: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.76 schwarze 903: const char *file, int line, int col, const char *msg)
1.30 schwarze 904: {
1.94 schwarze 905: const char *mparse_msg;
1.45 schwarze 906:
1.92 schwarze 907: fprintf(stderr, "%s: %s:", progname, file);
908:
909: if (line)
910: fprintf(stderr, "%d:%d:", line, col + 1);
911:
1.94 schwarze 912: fprintf(stderr, " %s", mparse_strlevel(lvl));
913:
914: if (NULL != (mparse_msg = mparse_strerror(t)))
915: fprintf(stderr, ": %s", mparse_msg);
1.30 schwarze 916:
917: if (msg)
918: fprintf(stderr, ": %s", msg);
1.76 schwarze 919:
1.30 schwarze 920: fputc('\n', stderr);
1.95 schwarze 921: }
922:
1.131 schwarze 923: static void
924: handle_sigpipe(int signum)
925: {
926:
1.132 schwarze 927: exit((int)rc);
1.131 schwarze 928: }
929:
1.130 schwarze 930: static pid_t
1.95 schwarze 931: spawn_pager(void)
932: {
933: #define MAX_PAGER_ARGS 16
934: char *argv[MAX_PAGER_ARGS];
935: const char *pager;
936: char *cp;
937: int fildes[2];
938: int argc;
1.130 schwarze 939: pid_t pager_pid;
1.95 schwarze 940:
941: if (pipe(fildes) == -1) {
942: fprintf(stderr, "%s: pipe: %s\n",
943: progname, strerror(errno));
1.130 schwarze 944: return(0);
1.95 schwarze 945: }
946:
1.130 schwarze 947: switch (pager_pid = fork()) {
1.95 schwarze 948: case -1:
949: fprintf(stderr, "%s: fork: %s\n",
950: progname, strerror(errno));
951: exit((int)MANDOCLEVEL_SYSERR);
952: case 0:
1.129 schwarze 953: break;
954: default:
1.95 schwarze 955: close(fildes[0]);
956: if (dup2(fildes[1], STDOUT_FILENO) == -1) {
957: fprintf(stderr, "%s: dup output: %s\n",
958: progname, strerror(errno));
959: exit((int)MANDOCLEVEL_SYSERR);
960: }
1.129 schwarze 961: close(fildes[1]);
1.131 schwarze 962: signal(SIGPIPE, handle_sigpipe);
1.130 schwarze 963: return(pager_pid);
1.95 schwarze 964: }
965:
1.129 schwarze 966: /* The child process becomes the pager. */
1.95 schwarze 967:
968: close(fildes[1]);
969: if (dup2(fildes[0], STDIN_FILENO) == -1) {
970: fprintf(stderr, "%s: dup input: %s\n",
971: progname, strerror(errno));
972: exit((int)MANDOCLEVEL_SYSERR);
973: }
1.129 schwarze 974: close(fildes[0]);
1.95 schwarze 975:
976: pager = getenv("MANPAGER");
977: if (pager == NULL || *pager == '\0')
978: pager = getenv("PAGER");
979: if (pager == NULL || *pager == '\0')
1.137 schwarze 980: pager = "more -s";
1.95 schwarze 981: cp = mandoc_strdup(pager);
982:
983: /*
984: * Parse the pager command into words.
985: * Intentionally do not do anything fancy here.
986: */
987:
988: argc = 0;
989: while (argc + 1 < MAX_PAGER_ARGS) {
990: argv[argc++] = cp;
991: cp = strchr(cp, ' ');
992: if (cp == NULL)
993: break;
994: *cp++ = '\0';
995: while (*cp == ' ')
996: cp++;
997: if (*cp == '\0')
998: break;
999: }
1000: argv[argc] = NULL;
1001:
1002: /* Hand over to the pager. */
1003:
1004: execvp(argv[0], argv);
1005: fprintf(stderr, "%s: exec: %s\n",
1006: progname, strerror(errno));
1007: exit((int)MANDOCLEVEL_SYSERR);
1.30 schwarze 1008: }
![[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