Annotation of mandoc/main.c, Revision 1.217
1.217 ! schwarze 1: /* $Id: main.c,v 1.216 2015/01/16 21:15:05 schwarze Exp $ */
1.1 kristaps 2: /*
1.183 schwarze 3: * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.212 schwarze 4: * Copyright (c) 2010-2012, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
1.169 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.25 kristaps 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.25 kristaps 11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
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: */
1.58 kristaps 19: #include "config.h"
1.178 schwarze 20:
21: #include <sys/types.h>
1.216 schwarze 22: #include <sys/param.h> /* MACHINE */
1.58 kristaps 23:
1.1 kristaps 24: #include <assert.h>
1.185 schwarze 25: #include <ctype.h>
1.183 schwarze 26: #include <errno.h>
1.186 schwarze 27: #include <fcntl.h>
1.1 kristaps 28: #include <stdio.h>
1.45 kristaps 29: #include <stdint.h>
1.1 kristaps 30: #include <stdlib.h>
31: #include <string.h>
32: #include <unistd.h>
33:
1.71 kristaps 34: #include "mandoc.h"
1.172 schwarze 35: #include "mandoc_aux.h"
1.90 kristaps 36: #include "main.h"
1.1 kristaps 37: #include "mdoc.h"
1.10 kristaps 38: #include "man.h"
1.180 schwarze 39: #include "manpath.h"
40: #include "mansearch.h"
1.101 joerg 41:
1.55 kristaps 42: #if !defined(__GNUC__) || (__GNUC__ < 2)
1.56 kristaps 43: # if !defined(lint)
44: # define __attribute__(x)
45: # endif
1.55 kristaps 46: #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */
1.16 kristaps 47:
1.181 schwarze 48: enum outmode {
49: OUTMODE_DEF = 0,
50: OUTMODE_FLN,
51: OUTMODE_LST,
52: OUTMODE_ALL,
53: OUTMODE_INT,
54: OUTMODE_ONE
55: };
56:
1.42 kristaps 57: typedef void (*out_mdoc)(void *, const struct mdoc *);
58: typedef void (*out_man)(void *, const struct man *);
1.22 kristaps 59: typedef void (*out_free)(void *);
60:
1.19 kristaps 61: enum outt {
1.154 kristaps 62: OUTT_ASCII = 0, /* -Tascii */
1.162 kristaps 63: OUTT_LOCALE, /* -Tlocale */
1.163 kristaps 64: OUTT_UTF8, /* -Tutf8 */
1.154 kristaps 65: OUTT_TREE, /* -Ttree */
1.164 schwarze 66: OUTT_MAN, /* -Tman */
1.154 kristaps 67: OUTT_HTML, /* -Thtml */
68: OUTT_LINT, /* -Tlint */
69: OUTT_PS, /* -Tps */
70: OUTT_PDF /* -Tpdf */
1.19 kristaps 71: };
72:
1.5 kristaps 73: struct curparse {
1.154 kristaps 74: struct mparse *mp;
1.195 schwarze 75: struct mchars *mchars; /* character table */
1.148 kristaps 76: enum mandoclevel wlevel; /* ignore messages below this */
77: int wstop; /* stop after a file with a warning */
1.173 schwarze 78: enum outt outtype; /* which output to use */
1.79 kristaps 79: out_mdoc outmdoc; /* mdoc output ptr */
1.173 schwarze 80: out_man outman; /* man output ptr */
1.79 kristaps 81: out_free outfree; /* free output ptr */
82: void *outdata; /* data for output */
83: char outopts[BUFSIZ]; /* buf of output opts */
84: };
85:
1.213 schwarze 86: #if HAVE_SQLITE3
87: static int fs_lookup(const struct manpaths *,
88: size_t ipath, const char *,
89: const char *, const char *,
90: struct manpage **, size_t *);
91: static void fs_search(const struct mansearch *,
92: const struct manpaths *, int, char**,
93: struct manpage **, size_t *);
94: #endif
1.194 schwarze 95: static int koptions(int *, char *);
1.203 schwarze 96: #if HAVE_SQLITE3
97: int mandocdb(int, char**);
98: #endif
1.170 schwarze 99: static int moptions(int *, char *);
1.155 kristaps 100: static void mmsg(enum mandocerr, enum mandoclevel,
101: const char *, int, int, const char *);
1.173 schwarze 102: static void parse(struct curparse *, int,
1.154 kristaps 103: const char *, enum mandoclevel *);
1.205 schwarze 104: #if HAVE_SQLITE3
1.197 schwarze 105: static enum mandoclevel passthrough(const char *, int, int);
1.205 schwarze 106: #endif
1.183 schwarze 107: static void spawn_pager(void);
1.66 kristaps 108: static int toptions(struct curparse *, char *);
1.180 schwarze 109: static void usage(enum argmode) __attribute__((noreturn));
1.55 kristaps 110: static void version(void) __attribute__((noreturn));
1.103 schwarze 111: static int woptions(struct curparse *, char *);
1.1 kristaps 112:
1.182 schwarze 113: static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
1.202 schwarze 114: static char help_arg[] = "help";
115: static char *help_argv[] = {help_arg, NULL};
1.54 kristaps 116: static const char *progname;
1.1 kristaps 117:
1.173 schwarze 118:
1.1 kristaps 119: int
120: main(int argc, char *argv[])
121: {
1.5 kristaps 122: struct curparse curp;
1.180 schwarze 123: struct mansearch search;
124: struct manpaths paths;
1.205 schwarze 125: char *auxpaths;
1.180 schwarze 126: char *defos;
1.207 schwarze 127: unsigned char *uc;
1.180 schwarze 128: #if HAVE_SQLITE3
1.186 schwarze 129: struct manpage *res, *resp;
1.205 schwarze 130: char *conf_file, *defpaths;
1.182 schwarze 131: size_t isec, i, sz;
1.205 schwarze 132: int prio, best_prio, synopsis_only;
1.182 schwarze 133: char sec;
1.180 schwarze 134: #endif
1.214 schwarze 135: enum mandoclevel rc, rctmp;
1.181 schwarze 136: enum outmode outmode;
1.192 schwarze 137: int fd;
1.180 schwarze 138: int show_usage;
1.183 schwarze 139: int use_pager;
1.170 schwarze 140: int options;
1.180 schwarze 141: int c;
1.1 kristaps 142:
1.54 kristaps 143: progname = strrchr(argv[0], '/');
144: if (progname == NULL)
145: progname = argv[0];
146: else
147: ++progname;
1.203 schwarze 148:
149: #if HAVE_SQLITE3
1.204 schwarze 150: if (strcmp(progname, BINM_MAKEWHATIS) == 0)
1.203 schwarze 151: return(mandocdb(argc, argv));
152: #endif
1.179 schwarze 153:
1.180 schwarze 154: /* Search options. */
155:
156: memset(&paths, 0, sizeof(struct manpaths));
1.205 schwarze 157: #if HAVE_SQLITE3
158: conf_file = defpaths = NULL;
159: #endif
160: auxpaths = NULL;
1.180 schwarze 161:
162: memset(&search, 0, sizeof(struct mansearch));
163: search.outkey = "Nd";
164:
1.204 schwarze 165: if (strcmp(progname, BINM_MAN) == 0)
1.180 schwarze 166: search.argmode = ARG_NAME;
1.204 schwarze 167: else if (strcmp(progname, BINM_APROPOS) == 0)
1.180 schwarze 168: search.argmode = ARG_EXPR;
1.204 schwarze 169: else if (strcmp(progname, BINM_WHATIS) == 0)
1.180 schwarze 170: search.argmode = ARG_WORD;
1.202 schwarze 171: else if (strncmp(progname, "help", 4) == 0)
172: search.argmode = ARG_NAME;
1.180 schwarze 173: else
174: search.argmode = ARG_FILE;
175:
176: /* Parser and formatter options. */
1.54 kristaps 177:
1.51 kristaps 178: memset(&curp, 0, sizeof(struct curparse));
1.201 schwarze 179: curp.outtype = OUTT_LOCALE;
1.215 schwarze 180: curp.wlevel = MANDOCLEVEL_BADARG;
1.194 schwarze 181: options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.166 schwarze 182: defos = NULL;
1.19 kristaps 183:
1.183 schwarze 184: use_pager = 1;
1.180 schwarze 185: show_usage = 0;
1.205 schwarze 186: #if HAVE_SQLITE3
1.197 schwarze 187: synopsis_only = 0;
1.205 schwarze 188: #endif
1.181 schwarze 189: outmode = OUTMODE_DEF;
1.183 schwarze 190:
1.194 schwarze 191: while (-1 != (c = getopt(argc, argv,
192: "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
1.1 kristaps 193: switch (c) {
1.181 schwarze 194: case 'a':
195: outmode = OUTMODE_ALL;
196: break;
1.180 schwarze 197: case 'C':
1.205 schwarze 198: #if HAVE_SQLITE3
1.180 schwarze 199: conf_file = optarg;
1.205 schwarze 200: #endif
1.180 schwarze 201: break;
1.183 schwarze 202: case 'c':
203: use_pager = 0;
204: break;
1.180 schwarze 205: case 'f':
206: search.argmode = ARG_WORD;
207: break;
1.190 schwarze 208: case 'h':
209: (void)strlcat(curp.outopts, "synopsis,", BUFSIZ);
1.205 schwarze 210: #if HAVE_SQLITE3
1.197 schwarze 211: synopsis_only = 1;
1.205 schwarze 212: #endif
1.198 schwarze 213: use_pager = 0;
1.190 schwarze 214: outmode = OUTMODE_ALL;
215: break;
1.173 schwarze 216: case 'I':
1.166 schwarze 217: if (strncmp(optarg, "os=", 3)) {
1.173 schwarze 218: fprintf(stderr,
1.209 schwarze 219: "%s: -I %s: Bad argument\n",
1.176 schwarze 220: progname, optarg);
1.166 schwarze 221: return((int)MANDOCLEVEL_BADARG);
222: }
223: if (defos) {
1.173 schwarze 224: fprintf(stderr,
1.209 schwarze 225: "%s: -I %s: Duplicate argument\n",
1.176 schwarze 226: progname, optarg);
1.166 schwarze 227: return((int)MANDOCLEVEL_BADARG);
228: }
229: defos = mandoc_strdup(optarg + 3);
230: break;
1.181 schwarze 231: case 'i':
232: outmode = OUTMODE_INT;
233: break;
1.194 schwarze 234: case 'K':
235: if ( ! koptions(&options, optarg))
236: return((int)MANDOCLEVEL_BADARG);
237: break;
1.180 schwarze 238: case 'k':
239: search.argmode = ARG_EXPR;
240: break;
1.188 schwarze 241: case 'l':
242: search.argmode = ARG_FILE;
243: outmode = OUTMODE_ALL;
244: break;
1.180 schwarze 245: case 'M':
1.205 schwarze 246: #if HAVE_SQLITE3
1.180 schwarze 247: defpaths = optarg;
1.205 schwarze 248: #endif
1.180 schwarze 249: break;
1.173 schwarze 250: case 'm':
1.180 schwarze 251: auxpaths = optarg;
1.10 kristaps 252: break;
1.173 schwarze 253: case 'O':
1.180 schwarze 254: search.outkey = optarg;
1.49 kristaps 255: (void)strlcat(curp.outopts, optarg, BUFSIZ);
256: (void)strlcat(curp.outopts, ",", BUFSIZ);
1.44 kristaps 257: break;
1.180 schwarze 258: case 'S':
259: search.arch = optarg;
260: break;
261: case 's':
262: search.sec = optarg;
263: break;
1.173 schwarze 264: case 'T':
1.60 kristaps 265: if ( ! toptions(&curp, optarg))
1.105 kristaps 266: return((int)MANDOCLEVEL_BADARG);
1.1 kristaps 267: break;
1.173 schwarze 268: case 'W':
1.103 schwarze 269: if ( ! woptions(&curp, optarg))
1.105 kristaps 270: return((int)MANDOCLEVEL_BADARG);
1.1 kristaps 271: break;
1.181 schwarze 272: case 'w':
273: outmode = OUTMODE_FLN;
274: break;
1.173 schwarze 275: case 'V':
1.1 kristaps 276: version();
277: /* NOTREACHED */
278: default:
1.180 schwarze 279: show_usage = 1;
280: break;
1.1 kristaps 281: }
1.180 schwarze 282: }
283:
284: if (show_usage)
285: usage(search.argmode);
286:
1.185 schwarze 287: /* Postprocess options. */
288:
1.181 schwarze 289: if (outmode == OUTMODE_DEF) {
290: switch (search.argmode) {
291: case ARG_FILE:
292: outmode = OUTMODE_ALL;
1.183 schwarze 293: use_pager = 0;
1.181 schwarze 294: break;
295: case ARG_NAME:
296: outmode = OUTMODE_ONE;
297: break;
298: default:
299: outmode = OUTMODE_LST;
300: break;
301: }
302: }
303:
1.185 schwarze 304: /* Parse arguments. */
305:
1.180 schwarze 306: argc -= optind;
307: argv += optind;
1.182 schwarze 308: #if HAVE_SQLITE3
1.186 schwarze 309: resp = NULL;
1.182 schwarze 310: #endif
1.185 schwarze 311:
1.202 schwarze 312: /*
313: * Quirks for help(1)
314: * and for a man(1) section argument without -s.
315: */
316:
317: if (search.argmode == ARG_NAME) {
318: if (*progname == 'h') {
319: if (argc == 0) {
320: argv = help_argv;
321: argc = 1;
322: }
1.211 schwarze 323: } else if (argc > 1 &&
324: ((uc = argv[0]) != NULL) &&
1.207 schwarze 325: ((isdigit(uc[0]) && (uc[1] == '\0' ||
326: (isalpha(uc[1]) && uc[2] == '\0'))) ||
327: (uc[0] == 'n' && uc[1] == '\0'))) {
328: search.sec = uc;
1.202 schwarze 329: argv++;
330: argc--;
331: }
1.216 schwarze 332: if (search.arch == NULL)
333: search.arch = getenv("MACHINE");
334: if (search.arch == NULL)
335: search.arch = MACHINE;
1.185 schwarze 336: }
1.182 schwarze 337:
338: rc = MANDOCLEVEL_OK;
1.180 schwarze 339:
340: /* man(1), whatis(1), apropos(1) */
341:
342: if (search.argmode != ARG_FILE) {
343: #if HAVE_SQLITE3
344: if (argc == 0)
345: usage(search.argmode);
1.199 schwarze 346:
347: if (search.argmode == ARG_NAME &&
348: outmode == OUTMODE_ONE)
349: search.firstmatch = 1;
1.182 schwarze 350:
351: /* Access the mandoc database. */
352:
1.180 schwarze 353: manpath_parse(&paths, conf_file, defpaths, auxpaths);
354: mansearch_setup(1);
355: if( ! mansearch(&search, &paths, argc, argv, &res, &sz))
356: usage(search.argmode);
1.213 schwarze 357:
358: if (sz == 0 && search.argmode == ARG_NAME)
359: fs_search(&search, &paths, argc, argv, &res, &sz);
1.187 schwarze 360:
361: if (sz == 0) {
362: rc = MANDOCLEVEL_BADARG;
363: goto out;
364: }
1.182 schwarze 365:
366: /*
367: * For standard man(1) and -a output mode,
368: * prepare for copying filename pointers
369: * into the program parameter array.
370: */
371:
372: if (outmode == OUTMODE_ONE) {
373: argc = 1;
374: best_prio = 10;
1.186 schwarze 375: } else if (outmode == OUTMODE_ALL)
1.182 schwarze 376: argc = (int)sz;
377:
378: /* Iterate all matching manuals. */
379:
1.213 schwarze 380: resp = res;
1.181 schwarze 381: for (i = 0; i < sz; i++) {
382: if (outmode == OUTMODE_FLN)
383: puts(res[i].file);
1.182 schwarze 384: else if (outmode == OUTMODE_LST)
1.181 schwarze 385: printf("%s - %s\n", res[i].names,
386: res[i].output == NULL ? "" :
387: res[i].output);
1.186 schwarze 388: else if (outmode == OUTMODE_ONE) {
1.182 schwarze 389: /* Search for the best section. */
390: isec = strcspn(res[i].file, "123456789");
391: sec = res[i].file[isec];
392: if ('\0' == sec)
393: continue;
394: prio = sec_prios[sec - '1'];
395: if (prio >= best_prio)
396: continue;
397: best_prio = prio;
1.186 schwarze 398: resp = res + i;
1.182 schwarze 399: }
1.181 schwarze 400: }
1.182 schwarze 401:
402: /*
403: * For man(1), -a and -i output mode, fall through
404: * to the main mandoc(1) code iterating files
405: * and running the parsers on each of them.
406: */
407:
408: if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
409: goto out;
1.180 schwarze 410: #else
411: fputs("mandoc: database support not compiled in\n",
412: stderr);
413: return((int)MANDOCLEVEL_BADARG);
414: #endif
415: }
416:
417: /* mandoc(1) */
418:
1.209 schwarze 419: if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths))
1.180 schwarze 420: return((int)MANDOCLEVEL_BADARG);
1.1 kristaps 421:
1.195 schwarze 422: curp.mchars = mchars_alloc();
423: curp.mp = mparse_alloc(options, curp.wlevel, mmsg,
424: curp.mchars, defos);
1.154 kristaps 425:
1.165 kristaps 426: /*
427: * Conditionally start up the lookaside buffer before parsing.
428: */
429: if (OUTT_MAN == curp.outtype)
430: mparse_keep(curp.mp);
431:
1.212 schwarze 432: if (argc == 0) {
433: if (use_pager && isatty(STDOUT_FILENO))
434: spawn_pager();
1.154 kristaps 435: parse(&curp, STDIN_FILENO, "<stdin>", &rc);
1.212 schwarze 436: }
1.64 kristaps 437:
1.186 schwarze 438: while (argc) {
1.214 schwarze 439: rctmp = mparse_open(curp.mp, &fd,
1.212 schwarze 440: #if HAVE_SQLITE3
441: resp != NULL ? resp->file :
442: #endif
443: *argv);
1.214 schwarze 444: if (rc < rctmp)
445: rc = rctmp;
1.212 schwarze 446:
447: if (fd != -1) {
448: if (use_pager && isatty(STDOUT_FILENO))
449: spawn_pager();
450: use_pager = 0;
451:
452: #if HAVE_SQLITE3
453: if (resp == NULL)
454: #endif
455: parse(&curp, fd, *argv, &rc);
1.186 schwarze 456: #if HAVE_SQLITE3
1.192 schwarze 457: else if (resp->form & FORM_SRC) {
1.189 schwarze 458: /* For .so only; ignore failure. */
459: chdir(paths.paths[resp->ipath]);
1.192 schwarze 460: parse(&curp, fd, resp->file, &rc);
1.214 schwarze 461: } else {
462: rctmp = passthrough(resp->file, fd,
1.197 schwarze 463: synopsis_only);
1.214 schwarze 464: if (rc < rctmp)
465: rc = rctmp;
466: }
1.186 schwarze 467: #endif
1.212 schwarze 468:
1.214 schwarze 469: rctmp = mparse_wait(curp.mp);
470: if (rc < rctmp)
471: rc = rctmp;
1.212 schwarze 472:
473: if (argc > 1 && curp.outtype <= OUTT_UTF8)
474: ascii_sepline(curp.outdata);
1.192 schwarze 475: }
476:
1.154 kristaps 477: if (MANDOCLEVEL_OK != rc && curp.wstop)
1.64 kristaps 478: break;
1.210 schwarze 479:
1.212 schwarze 480: #if HAVE_SQLITE3
481: if (resp != NULL)
482: resp++;
483: else
484: #endif
485: argv++;
486: if (--argc)
487: mparse_reset(curp.mp);
1.1 kristaps 488: }
489:
1.22 kristaps 490: if (curp.outfree)
491: (*curp.outfree)(curp.outdata);
1.195 schwarze 492: mparse_free(curp.mp);
493: mchars_free(curp.mchars);
1.182 schwarze 494:
495: #if HAVE_SQLITE3
496: out:
497: if (search.argmode != ARG_FILE) {
1.189 schwarze 498: manpath_free(&paths);
1.182 schwarze 499: mansearch_free(res, sz);
500: mansearch_setup(0);
501: }
502: #endif
503:
1.166 schwarze 504: free(defos);
1.1 kristaps 505:
1.154 kristaps 506: return((int)rc);
1.1 kristaps 507: }
508:
1.55 kristaps 509: static void
1.1 kristaps 510: version(void)
511: {
512:
1.180 schwarze 513: printf("mandoc %s\n", VERSION);
1.105 kristaps 514: exit((int)MANDOCLEVEL_OK);
1.1 kristaps 515: }
516:
1.55 kristaps 517: static void
1.180 schwarze 518: usage(enum argmode argmode)
1.1 kristaps 519: {
520:
1.180 schwarze 521: switch (argmode) {
522: case ARG_FILE:
1.190 schwarze 523: fputs("usage: mandoc [-acfhklV] [-Ios=name] "
1.196 schwarze 524: "[-Kencoding] [-mformat] [-Ooption]\n"
525: "\t [-Toutput] [-Wlevel] [file ...]\n", stderr);
1.180 schwarze 526: break;
527: case ARG_NAME:
1.208 schwarze 528: fputs("usage: man [-acfhklVw] [-C file] [-I os=name] "
529: "[-K encoding] [-M path] [-m path]\n"
530: "\t [-O option=value] [-S subsection] [-s section] "
531: "[-T output] [-W level]\n"
1.180 schwarze 532: "\t [section] name ...\n", stderr);
533: break;
534: case ARG_WORD:
1.190 schwarze 535: fputs("usage: whatis [-acfhklVw] [-C file] "
1.188 schwarze 536: "[-M path] [-m path] [-O outkey] [-S arch]\n"
537: "\t [-s section] name ...\n", stderr);
1.180 schwarze 538: break;
539: case ARG_EXPR:
1.190 schwarze 540: fputs("usage: apropos [-acfhklVw] [-C file] "
1.188 schwarze 541: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.180 schwarze 542: "\t [-s section] expression ...\n", stderr);
543: break;
544: }
1.105 kristaps 545: exit((int)MANDOCLEVEL_BADARG);
1.68 joerg 546: }
1.213 schwarze 547:
548: #if HAVE_SQLITE3
549: static int
550: fs_lookup(const struct manpaths *paths, size_t ipath,
551: const char *sec, const char *arch, const char *name,
552: struct manpage **res, size_t *ressz)
553: {
554: struct manpage *page;
555: char *file;
556: int form;
557:
558: mandoc_asprintf(&file, "%s/man%s/%s.%s",
559: paths->paths[ipath], sec, name, sec);
560: if (access(file, R_OK) != -1) {
561: form = FORM_SRC;
562: goto found;
563: }
564: free(file);
565:
566: mandoc_asprintf(&file, "%s/cat%s/%s.0",
567: paths->paths[ipath], sec, name);
568: if (access(file, R_OK) != -1) {
569: form = FORM_CAT;
570: goto found;
571: }
572: free(file);
573:
574: if (arch != NULL) {
575: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
576: paths->paths[ipath], sec, arch, name, sec);
577: if (access(file, R_OK) != -1) {
578: form = FORM_SRC;
579: goto found;
580: }
581: free(file);
582: }
583: return(0);
584:
585: found:
586: fprintf(stderr, "%s: outdated mandoc.db lacks %s(%s) entry,\n"
587: " consider running # makewhatis %s\n",
588: progname, name, sec, paths->paths[ipath]);
589:
590: *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
591: page = *res + (*ressz - 1);
592: page->file = file;
593: page->names = NULL;
594: page->output = NULL;
595: page->ipath = ipath;
596: page->bits = NAME_FILE & NAME_MASK;
597: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
598: page->form = form;
599: return(1);
600: }
601:
602: static void
603: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
604: int argc, char **argv, struct manpage **res, size_t *ressz)
605: {
606: const char *const sections[] =
607: {"1", "8", "6", "2", "3", "3p", "5", "7", "4", "9"};
608: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
609:
610: size_t ipath, isec, lastsz;
611:
612: assert(cfg->argmode == ARG_NAME);
613:
614: *res = NULL;
615: *ressz = lastsz = 0;
616: while (argc) {
617: for (ipath = 0; ipath < paths->sz; ipath++) {
618: if (cfg->sec != NULL) {
619: if (fs_lookup(paths, ipath, cfg->sec,
620: cfg->arch, *argv, res, ressz) &&
621: cfg->firstmatch)
622: return;
623: } else for (isec = 0; isec < nsec; isec++)
624: if (fs_lookup(paths, ipath, sections[isec],
625: cfg->arch, *argv, res, ressz) &&
626: cfg->firstmatch)
627: return;
628: }
629: if (*ressz == lastsz)
630: fprintf(stderr,
631: "%s: No entry for %s in the manual.\n",
632: progname, *argv);
633: lastsz = *ressz;
634: argv++;
635: argc--;
636: }
637: }
638: #endif
1.68 joerg 639:
1.64 kristaps 640: static void
1.173 schwarze 641: parse(struct curparse *curp, int fd, const char *file,
642: enum mandoclevel *level)
1.1 kristaps 643: {
1.154 kristaps 644: enum mandoclevel rc;
645: struct mdoc *mdoc;
646: struct man *man;
1.112 kristaps 647:
1.154 kristaps 648: /* Begin by parsing the file itself. */
1.112 kristaps 649:
1.154 kristaps 650: assert(file);
651: assert(fd >= -1);
1.112 kristaps 652:
1.154 kristaps 653: rc = mparse_readfd(curp->mp, fd, file);
1.112 kristaps 654:
1.1 kristaps 655: /*
1.154 kristaps 656: * With -Wstop and warnings or errors of at least the requested
657: * level, do not produce output.
1.1 kristaps 658: */
659:
1.154 kristaps 660: if (MANDOCLEVEL_OK != rc && curp->wstop)
1.111 kristaps 661: goto cleanup;
662:
663: /* If unset, allocate output dev now (if applicable). */
664:
665: if ( ! (curp->outman && curp->outmdoc)) {
666: switch (curp->outtype) {
1.173 schwarze 667: case OUTT_HTML:
1.195 schwarze 668: curp->outdata = html_alloc(curp->mchars,
669: curp->outopts);
1.162 kristaps 670: curp->outfree = html_free;
671: break;
1.173 schwarze 672: case OUTT_UTF8:
1.195 schwarze 673: curp->outdata = utf8_alloc(curp->mchars,
674: curp->outopts);
1.163 kristaps 675: curp->outfree = ascii_free;
676: break;
1.173 schwarze 677: case OUTT_LOCALE:
1.195 schwarze 678: curp->outdata = locale_alloc(curp->mchars,
679: curp->outopts);
1.162 kristaps 680: curp->outfree = ascii_free;
1.111 kristaps 681: break;
1.173 schwarze 682: case OUTT_ASCII:
1.195 schwarze 683: curp->outdata = ascii_alloc(curp->mchars,
684: curp->outopts);
1.111 kristaps 685: curp->outfree = ascii_free;
686: break;
1.173 schwarze 687: case OUTT_PDF:
1.195 schwarze 688: curp->outdata = pdf_alloc(curp->mchars,
689: curp->outopts);
1.111 kristaps 690: curp->outfree = pspdf_free;
691: break;
1.173 schwarze 692: case OUTT_PS:
1.195 schwarze 693: curp->outdata = ps_alloc(curp->mchars,
694: curp->outopts);
1.111 kristaps 695: curp->outfree = pspdf_free;
696: break;
697: default:
698: break;
699: }
700:
701: switch (curp->outtype) {
1.173 schwarze 702: case OUTT_HTML:
1.111 kristaps 703: curp->outman = html_man;
704: curp->outmdoc = html_mdoc;
705: break;
1.173 schwarze 706: case OUTT_TREE:
1.111 kristaps 707: curp->outman = tree_man;
708: curp->outmdoc = tree_mdoc;
709: break;
1.173 schwarze 710: case OUTT_MAN:
1.164 schwarze 711: curp->outmdoc = man_mdoc;
1.165 kristaps 712: curp->outman = man_man;
1.164 schwarze 713: break;
1.173 schwarze 714: case OUTT_PDF:
1.111 kristaps 715: /* FALLTHROUGH */
1.173 schwarze 716: case OUTT_ASCII:
1.111 kristaps 717: /* FALLTHROUGH */
1.173 schwarze 718: case OUTT_UTF8:
1.163 kristaps 719: /* FALLTHROUGH */
1.173 schwarze 720: case OUTT_LOCALE:
1.162 kristaps 721: /* FALLTHROUGH */
1.173 schwarze 722: case OUTT_PS:
1.111 kristaps 723: curp->outman = terminal_man;
724: curp->outmdoc = terminal_mdoc;
725: break;
726: default:
727: break;
728: }
729: }
730:
1.171 schwarze 731: mparse_result(curp->mp, &mdoc, &man, NULL);
1.154 kristaps 732:
1.111 kristaps 733: /* Execute the out device, if it exists. */
734:
1.154 kristaps 735: if (man && curp->outman)
736: (*curp->outman)(curp->outdata, man);
737: if (mdoc && curp->outmdoc)
738: (*curp->outmdoc)(curp->outdata, mdoc);
1.111 kristaps 739:
1.212 schwarze 740: cleanup:
1.154 kristaps 741: if (*level < rc)
742: *level = rc;
1.186 schwarze 743: }
744:
1.205 schwarze 745: #if HAVE_SQLITE3
1.186 schwarze 746: static enum mandoclevel
1.197 schwarze 747: passthrough(const char *file, int fd, int synopsis_only)
1.186 schwarze 748: {
1.197 schwarze 749: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
750: const char synr[] = "SYNOPSIS";
751:
752: FILE *stream;
1.186 schwarze 753: const char *syscall;
1.197 schwarze 754: char *line;
755: size_t len, off;
756: ssize_t nw;
757: int print;
1.210 schwarze 758:
759: fflush(stdout);
1.197 schwarze 760:
761: if ((stream = fdopen(fd, "r")) == NULL) {
762: close(fd);
763: syscall = "fdopen";
764: goto fail;
765: }
1.186 schwarze 766:
1.197 schwarze 767: print = 0;
768: while ((line = fgetln(stream, &len)) != NULL) {
769: if (synopsis_only) {
770: if (print) {
771: if ( ! isspace((unsigned char)*line))
772: goto done;
773: while (len &&
774: isspace((unsigned char)*line)) {
775: line++;
776: len--;
777: }
778: } else {
779: if ((len == sizeof(synb) &&
780: ! strncmp(line, synb, len - 1)) ||
781: (len == sizeof(synr) &&
782: ! strncmp(line, synr, len - 1)))
783: print = 1;
784: continue;
785: }
786: }
787: for (off = 0; off < len; off += nw)
788: if ((nw = write(STDOUT_FILENO, line + off,
789: len - off)) == -1 || nw == 0) {
790: fclose(stream);
1.186 schwarze 791: syscall = "write";
792: goto fail;
793: }
1.197 schwarze 794: }
1.186 schwarze 795:
1.197 schwarze 796: if (ferror(stream)) {
797: fclose(stream);
798: syscall = "fgetln";
799: goto fail;
800: }
1.193 schwarze 801:
1.197 schwarze 802: done:
803: fclose(stream);
804: return(MANDOCLEVEL_OK);
1.186 schwarze 805:
806: fail:
807: fprintf(stderr, "%s: %s: SYSERR: %s: %s",
808: progname, file, syscall, strerror(errno));
809: return(MANDOCLEVEL_SYSERR);
1.194 schwarze 810: }
1.205 schwarze 811: #endif
1.194 schwarze 812:
813: static int
814: koptions(int *options, char *arg)
815: {
816:
817: if ( ! strcmp(arg, "utf-8")) {
818: *options |= MPARSE_UTF8;
819: *options &= ~MPARSE_LATIN1;
820: } else if ( ! strcmp(arg, "iso-8859-1")) {
821: *options |= MPARSE_LATIN1;
822: *options &= ~MPARSE_UTF8;
823: } else if ( ! strcmp(arg, "us-ascii")) {
824: *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
825: } else {
1.209 schwarze 826: fprintf(stderr, "%s: -K %s: Bad argument\n",
1.194 schwarze 827: progname, arg);
828: return(0);
829: }
830: return(1);
1.10 kristaps 831: }
832:
833: static int
1.170 schwarze 834: moptions(int *options, char *arg)
1.10 kristaps 835: {
836:
1.180 schwarze 837: if (arg == NULL)
838: /* nothing to do */;
839: else if (0 == strcmp(arg, "doc"))
1.170 schwarze 840: *options |= MPARSE_MDOC;
1.19 kristaps 841: else if (0 == strcmp(arg, "andoc"))
1.170 schwarze 842: /* nothing to do */;
1.17 kristaps 843: else if (0 == strcmp(arg, "an"))
1.170 schwarze 844: *options |= MPARSE_MAN;
1.10 kristaps 845: else {
1.209 schwarze 846: fprintf(stderr, "%s: -m %s: Bad argument\n",
1.176 schwarze 847: progname, arg);
1.10 kristaps 848: return(0);
849: }
850:
851: return(1);
1.1 kristaps 852: }
853:
854: static int
1.60 kristaps 855: toptions(struct curparse *curp, char *arg)
1.1 kristaps 856: {
857:
858: if (0 == strcmp(arg, "ascii"))
1.60 kristaps 859: curp->outtype = OUTT_ASCII;
860: else if (0 == strcmp(arg, "lint")) {
861: curp->outtype = OUTT_LINT;
1.103 schwarze 862: curp->wlevel = MANDOCLEVEL_WARNING;
1.154 kristaps 863: } else if (0 == strcmp(arg, "tree"))
1.60 kristaps 864: curp->outtype = OUTT_TREE;
1.164 schwarze 865: else if (0 == strcmp(arg, "man"))
866: curp->outtype = OUTT_MAN;
1.43 kristaps 867: else if (0 == strcmp(arg, "html"))
1.60 kristaps 868: curp->outtype = OUTT_HTML;
1.163 kristaps 869: else if (0 == strcmp(arg, "utf8"))
870: curp->outtype = OUTT_UTF8;
1.162 kristaps 871: else if (0 == strcmp(arg, "locale"))
872: curp->outtype = OUTT_LOCALE;
1.59 kristaps 873: else if (0 == strcmp(arg, "xhtml"))
1.195 schwarze 874: curp->outtype = OUTT_HTML;
1.85 kristaps 875: else if (0 == strcmp(arg, "ps"))
876: curp->outtype = OUTT_PS;
1.100 kristaps 877: else if (0 == strcmp(arg, "pdf"))
878: curp->outtype = OUTT_PDF;
1.1 kristaps 879: else {
1.209 schwarze 880: fprintf(stderr, "%s: -T %s: Bad argument\n",
1.176 schwarze 881: progname, arg);
1.1 kristaps 882: return(0);
883: }
884:
885: return(1);
886: }
887:
888: static int
1.103 schwarze 889: woptions(struct curparse *curp, char *arg)
1.1 kristaps 890: {
1.34 kristaps 891: char *v, *o;
1.217 ! schwarze 892: const char *toks[7];
1.1 kristaps 893:
1.103 schwarze 894: toks[0] = "stop";
895: toks[1] = "all";
896: toks[2] = "warning";
897: toks[3] = "error";
1.217 ! schwarze 898: toks[4] = "unsupp";
! 899: toks[5] = "fatal";
! 900: toks[6] = NULL;
1.1 kristaps 901:
1.34 kristaps 902: while (*arg) {
903: o = arg;
1.45 kristaps 904: switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.173 schwarze 905: case 0:
1.103 schwarze 906: curp->wstop = 1;
1.1 kristaps 907: break;
1.173 schwarze 908: case 1:
1.103 schwarze 909: /* FALLTHROUGH */
1.173 schwarze 910: case 2:
1.103 schwarze 911: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 912: break;
1.173 schwarze 913: case 3:
1.103 schwarze 914: curp->wlevel = MANDOCLEVEL_ERROR;
1.24 kristaps 915: break;
1.173 schwarze 916: case 4:
1.217 ! schwarze 917: curp->wlevel = MANDOCLEVEL_UNSUPP;
! 918: break;
! 919: case 5:
1.215 schwarze 920: curp->wlevel = MANDOCLEVEL_BADARG;
1.50 kristaps 921: break;
1.1 kristaps 922: default:
1.209 schwarze 923: fprintf(stderr, "%s: -W %s: Bad argument\n",
1.176 schwarze 924: progname, o);
1.1 kristaps 925: return(0);
926: }
1.34 kristaps 927: }
1.1 kristaps 928:
929: return(1);
930: }
931:
1.153 kristaps 932: static void
1.173 schwarze 933: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.155 kristaps 934: const char *file, int line, int col, const char *msg)
1.71 kristaps 935: {
1.177 schwarze 936: const char *mparse_msg;
1.103 schwarze 937:
1.175 schwarze 938: fprintf(stderr, "%s: %s:", progname, file);
939:
940: if (line)
941: fprintf(stderr, "%d:%d:", line, col + 1);
942:
1.177 schwarze 943: fprintf(stderr, " %s", mparse_strlevel(lvl));
944:
945: if (NULL != (mparse_msg = mparse_strerror(t)))
946: fprintf(stderr, ": %s", mparse_msg);
1.154 kristaps 947:
1.73 kristaps 948: if (msg)
949: fprintf(stderr, ": %s", msg);
1.154 kristaps 950:
1.73 kristaps 951: fputc('\n', stderr);
1.183 schwarze 952: }
953:
954: static void
955: spawn_pager(void)
956: {
1.184 schwarze 957: #define MAX_PAGER_ARGS 16
958: char *argv[MAX_PAGER_ARGS];
959: const char *pager;
960: char *cp;
961: int fildes[2];
962: int argc;
1.183 schwarze 963:
964: if (pipe(fildes) == -1) {
965: fprintf(stderr, "%s: pipe: %s\n",
966: progname, strerror(errno));
967: return;
968: }
969:
970: switch (fork()) {
971: case -1:
972: fprintf(stderr, "%s: fork: %s\n",
973: progname, strerror(errno));
974: exit((int)MANDOCLEVEL_SYSERR);
975: case 0:
976: close(fildes[0]);
977: if (dup2(fildes[1], STDOUT_FILENO) == -1) {
978: fprintf(stderr, "%s: dup output: %s\n",
979: progname, strerror(errno));
980: exit((int)MANDOCLEVEL_SYSERR);
981: }
982: return;
983: default:
1.184 schwarze 984: break;
985: }
986:
987: /* The original process becomes the pager. */
988:
989: close(fildes[1]);
990: if (dup2(fildes[0], STDIN_FILENO) == -1) {
991: fprintf(stderr, "%s: dup input: %s\n",
992: progname, strerror(errno));
1.183 schwarze 993: exit((int)MANDOCLEVEL_SYSERR);
994: }
1.184 schwarze 995:
996: pager = getenv("MANPAGER");
997: if (pager == NULL || *pager == '\0')
998: pager = getenv("PAGER");
999: if (pager == NULL || *pager == '\0')
1000: pager = "/usr/bin/more -s";
1001: cp = mandoc_strdup(pager);
1002:
1003: /*
1004: * Parse the pager command into words.
1005: * Intentionally do not do anything fancy here.
1006: */
1007:
1008: argc = 0;
1009: while (argc + 1 < MAX_PAGER_ARGS) {
1010: argv[argc++] = cp;
1011: cp = strchr(cp, ' ');
1012: if (cp == NULL)
1013: break;
1014: *cp++ = '\0';
1015: while (*cp == ' ')
1016: cp++;
1017: if (*cp == '\0')
1018: break;
1019: }
1020: argv[argc] = NULL;
1021:
1022: /* Hand over to the pager. */
1023:
1024: execvp(argv[0], argv);
1025: fprintf(stderr, "%s: exec: %s\n",
1026: progname, strerror(errno));
1027: exit((int)MANDOCLEVEL_SYSERR);
1.71 kristaps 1028: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to main.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc