Annotation of mandoc/main.c, Revision 1.246
1.246 ! schwarze 1: /* $Id: main.c,v 1.245 2015/10/06 18:32:19 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.229 schwarze 11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.25 kristaps 12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.229 schwarze 13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.25 kristaps 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.224 schwarze 23: #include <sys/wait.h>
1.58 kristaps 24:
1.1 kristaps 25: #include <assert.h>
1.185 schwarze 26: #include <ctype.h>
1.183 schwarze 27: #include <errno.h>
1.186 schwarze 28: #include <fcntl.h>
1.222 schwarze 29: #include <glob.h>
1.226 schwarze 30: #include <signal.h>
1.1 kristaps 31: #include <stdio.h>
1.45 kristaps 32: #include <stdint.h>
1.1 kristaps 33: #include <stdlib.h>
34: #include <string.h>
35: #include <unistd.h>
36:
1.231 schwarze 37: #include "mandoc_aux.h"
1.71 kristaps 38: #include "mandoc.h"
1.231 schwarze 39: #include "roff.h"
1.1 kristaps 40: #include "mdoc.h"
1.10 kristaps 41: #include "man.h"
1.239 schwarze 42: #include "tag.h"
1.231 schwarze 43: #include "main.h"
1.229 schwarze 44: #include "manconf.h"
1.180 schwarze 45: #include "mansearch.h"
1.101 joerg 46:
1.55 kristaps 47: #if !defined(__GNUC__) || (__GNUC__ < 2)
1.56 kristaps 48: # if !defined(lint)
49: # define __attribute__(x)
50: # endif
1.55 kristaps 51: #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */
1.16 kristaps 52:
1.181 schwarze 53: enum outmode {
54: OUTMODE_DEF = 0,
55: OUTMODE_FLN,
56: OUTMODE_LST,
57: OUTMODE_ALL,
58: OUTMODE_INT,
59: OUTMODE_ONE
60: };
61:
1.234 schwarze 62: typedef void (*out_mdoc)(void *, const struct roff_man *);
63: typedef void (*out_man)(void *, const struct roff_man *);
1.22 kristaps 64: typedef void (*out_free)(void *);
65:
1.19 kristaps 66: enum outt {
1.154 kristaps 67: OUTT_ASCII = 0, /* -Tascii */
1.162 kristaps 68: OUTT_LOCALE, /* -Tlocale */
1.163 kristaps 69: OUTT_UTF8, /* -Tutf8 */
1.154 kristaps 70: OUTT_TREE, /* -Ttree */
1.164 schwarze 71: OUTT_MAN, /* -Tman */
1.154 kristaps 72: OUTT_HTML, /* -Thtml */
73: OUTT_LINT, /* -Tlint */
74: OUTT_PS, /* -Tps */
75: OUTT_PDF /* -Tpdf */
1.19 kristaps 76: };
77:
1.5 kristaps 78: struct curparse {
1.154 kristaps 79: struct mparse *mp;
1.195 schwarze 80: struct mchars *mchars; /* character table */
1.148 kristaps 81: enum mandoclevel wlevel; /* ignore messages below this */
82: int wstop; /* stop after a file with a warning */
1.173 schwarze 83: enum outt outtype; /* which output to use */
1.79 kristaps 84: out_mdoc outmdoc; /* mdoc output ptr */
1.173 schwarze 85: out_man outman; /* man output ptr */
1.79 kristaps 86: out_free outfree; /* free output ptr */
87: void *outdata; /* data for output */
1.230 schwarze 88: struct manoutput *outopts; /* output options */
1.79 kristaps 89: };
90:
1.213 schwarze 91: static int fs_lookup(const struct manpaths *,
92: size_t ipath, const char *,
93: const char *, const char *,
94: struct manpage **, size_t *);
95: static void fs_search(const struct mansearch *,
96: const struct manpaths *, int, char**,
97: struct manpage **, size_t *);
1.194 schwarze 98: static int koptions(int *, char *);
1.203 schwarze 99: #if HAVE_SQLITE3
100: int mandocdb(int, char**);
101: #endif
1.170 schwarze 102: static int moptions(int *, char *);
1.155 kristaps 103: static void mmsg(enum mandocerr, enum mandoclevel,
104: const char *, int, int, const char *);
1.227 schwarze 105: static void parse(struct curparse *, int, const char *);
106: static void passthrough(const char *, int, int);
1.244 schwarze 107: static pid_t spawn_pager(struct tag_files *);
1.66 kristaps 108: static int toptions(struct curparse *, char *);
1.180 schwarze 109: static void usage(enum argmode) __attribute__((noreturn));
1.103 schwarze 110: static int woptions(struct curparse *, char *);
1.1 kristaps 111:
1.182 schwarze 112: static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
1.202 schwarze 113: static char help_arg[] = "help";
114: static char *help_argv[] = {help_arg, NULL};
1.54 kristaps 115: static const char *progname;
1.226 schwarze 116: static enum mandoclevel rc;
1.1 kristaps 117:
1.173 schwarze 118:
1.1 kristaps 119: int
120: main(int argc, char *argv[])
121: {
1.229 schwarze 122: struct manconf conf;
1.5 kristaps 123: struct curparse curp;
1.180 schwarze 124: struct mansearch search;
1.244 schwarze 125: struct tag_files *tag_files;
1.205 schwarze 126: char *auxpaths;
1.180 schwarze 127: char *defos;
1.207 schwarze 128: unsigned char *uc;
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.230 schwarze 132: int prio, best_prio;
1.182 schwarze 133: char sec;
1.226 schwarze 134: enum mandoclevel rctmp;
1.181 schwarze 135: enum outmode outmode;
1.192 schwarze 136: int fd;
1.180 schwarze 137: int show_usage;
1.170 schwarze 138: int options;
1.244 schwarze 139: int use_pager;
1.180 schwarze 140: int c;
1.1 kristaps 141:
1.219 schwarze 142: if (argc < 1)
143: progname = "mandoc";
144: else if ((progname = strrchr(argv[0], '/')) == NULL)
1.54 kristaps 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.245 schwarze 151: return mandocdb(argc, argv);
1.203 schwarze 152: #endif
1.179 schwarze 153:
1.180 schwarze 154: /* Search options. */
155:
1.229 schwarze 156: memset(&conf, 0, sizeof(conf));
1.205 schwarze 157: conf_file = defpaths = NULL;
158: auxpaths = NULL;
1.180 schwarze 159:
160: memset(&search, 0, sizeof(struct mansearch));
161: search.outkey = "Nd";
162:
1.204 schwarze 163: if (strcmp(progname, BINM_MAN) == 0)
1.180 schwarze 164: search.argmode = ARG_NAME;
1.204 schwarze 165: else if (strcmp(progname, BINM_APROPOS) == 0)
1.180 schwarze 166: search.argmode = ARG_EXPR;
1.204 schwarze 167: else if (strcmp(progname, BINM_WHATIS) == 0)
1.180 schwarze 168: search.argmode = ARG_WORD;
1.202 schwarze 169: else if (strncmp(progname, "help", 4) == 0)
170: search.argmode = ARG_NAME;
1.180 schwarze 171: else
172: search.argmode = ARG_FILE;
173:
174: /* Parser and formatter options. */
1.54 kristaps 175:
1.51 kristaps 176: memset(&curp, 0, sizeof(struct curparse));
1.201 schwarze 177: curp.outtype = OUTT_LOCALE;
1.215 schwarze 178: curp.wlevel = MANDOCLEVEL_BADARG;
1.230 schwarze 179: curp.outopts = &conf.output;
1.194 schwarze 180: options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.166 schwarze 181: defos = NULL;
1.19 kristaps 182:
1.244 schwarze 183: use_pager = 1;
184: tag_files = NULL;
1.180 schwarze 185: show_usage = 0;
1.181 schwarze 186: outmode = OUTMODE_DEF;
1.183 schwarze 187:
1.194 schwarze 188: while (-1 != (c = getopt(argc, argv,
189: "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
1.1 kristaps 190: switch (c) {
1.181 schwarze 191: case 'a':
192: outmode = OUTMODE_ALL;
193: break;
1.180 schwarze 194: case 'C':
195: conf_file = optarg;
196: break;
1.183 schwarze 197: case 'c':
1.244 schwarze 198: use_pager = 0;
1.183 schwarze 199: break;
1.180 schwarze 200: case 'f':
201: search.argmode = ARG_WORD;
202: break;
1.190 schwarze 203: case 'h':
1.230 schwarze 204: conf.output.synopsisonly = 1;
1.244 schwarze 205: use_pager = 0;
1.190 schwarze 206: outmode = OUTMODE_ALL;
207: break;
1.173 schwarze 208: case 'I':
1.166 schwarze 209: if (strncmp(optarg, "os=", 3)) {
1.173 schwarze 210: fprintf(stderr,
1.209 schwarze 211: "%s: -I %s: Bad argument\n",
1.176 schwarze 212: progname, optarg);
1.245 schwarze 213: return (int)MANDOCLEVEL_BADARG;
1.166 schwarze 214: }
215: if (defos) {
1.173 schwarze 216: fprintf(stderr,
1.209 schwarze 217: "%s: -I %s: Duplicate argument\n",
1.176 schwarze 218: progname, optarg);
1.245 schwarze 219: return (int)MANDOCLEVEL_BADARG;
1.166 schwarze 220: }
221: defos = mandoc_strdup(optarg + 3);
222: break;
1.181 schwarze 223: case 'i':
224: outmode = OUTMODE_INT;
225: break;
1.194 schwarze 226: case 'K':
227: if ( ! koptions(&options, optarg))
1.245 schwarze 228: return (int)MANDOCLEVEL_BADARG;
1.194 schwarze 229: break;
1.180 schwarze 230: case 'k':
231: search.argmode = ARG_EXPR;
232: break;
1.188 schwarze 233: case 'l':
234: search.argmode = ARG_FILE;
235: outmode = OUTMODE_ALL;
236: break;
1.180 schwarze 237: case 'M':
238: defpaths = optarg;
239: break;
1.173 schwarze 240: case 'm':
1.180 schwarze 241: auxpaths = optarg;
1.10 kristaps 242: break;
1.173 schwarze 243: case 'O':
1.180 schwarze 244: search.outkey = optarg;
1.230 schwarze 245: while (optarg != NULL)
246: manconf_output(&conf.output,
247: strsep(&optarg, ","));
1.44 kristaps 248: break;
1.180 schwarze 249: case 'S':
250: search.arch = optarg;
251: break;
252: case 's':
253: search.sec = optarg;
254: break;
1.173 schwarze 255: case 'T':
1.60 kristaps 256: if ( ! toptions(&curp, optarg))
1.245 schwarze 257: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 258: break;
1.173 schwarze 259: case 'W':
1.103 schwarze 260: if ( ! woptions(&curp, optarg))
1.245 schwarze 261: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 262: break;
1.181 schwarze 263: case 'w':
264: outmode = OUTMODE_FLN;
265: break;
1.1 kristaps 266: default:
1.180 schwarze 267: show_usage = 1;
268: break;
1.1 kristaps 269: }
1.180 schwarze 270: }
271:
272: if (show_usage)
273: usage(search.argmode);
274:
1.185 schwarze 275: /* Postprocess options. */
276:
1.181 schwarze 277: if (outmode == OUTMODE_DEF) {
278: switch (search.argmode) {
279: case ARG_FILE:
280: outmode = OUTMODE_ALL;
1.244 schwarze 281: use_pager = 0;
1.181 schwarze 282: break;
283: case ARG_NAME:
284: outmode = OUTMODE_ONE;
285: break;
286: default:
287: outmode = OUTMODE_LST;
288: break;
289: }
290: }
291:
1.246 ! schwarze 292: if (outmode == OUTMODE_FLN ||
! 293: outmode == OUTMODE_LST ||
! 294: !isatty(STDOUT_FILENO))
! 295: use_pager = 0;
! 296:
1.185 schwarze 297: /* Parse arguments. */
298:
1.219 schwarze 299: if (argc > 0) {
300: argc -= optind;
301: argv += optind;
302: }
1.186 schwarze 303: resp = NULL;
1.185 schwarze 304:
1.202 schwarze 305: /*
306: * Quirks for help(1)
307: * and for a man(1) section argument without -s.
308: */
309:
310: if (search.argmode == ARG_NAME) {
311: if (*progname == 'h') {
312: if (argc == 0) {
313: argv = help_argv;
314: argc = 1;
315: }
1.211 schwarze 316: } else if (argc > 1 &&
1.223 kristaps 317: ((uc = (unsigned char *)argv[0]) != NULL) &&
1.207 schwarze 318: ((isdigit(uc[0]) && (uc[1] == '\0' ||
319: (isalpha(uc[1]) && uc[2] == '\0'))) ||
320: (uc[0] == 'n' && uc[1] == '\0'))) {
1.223 kristaps 321: search.sec = (char *)uc;
1.202 schwarze 322: argv++;
323: argc--;
324: }
1.216 schwarze 325: if (search.arch == NULL)
326: search.arch = getenv("MACHINE");
1.223 kristaps 327: #ifdef MACHINE
1.216 schwarze 328: if (search.arch == NULL)
329: search.arch = MACHINE;
1.223 kristaps 330: #endif
1.185 schwarze 331: }
1.182 schwarze 332:
333: rc = MANDOCLEVEL_OK;
1.180 schwarze 334:
335: /* man(1), whatis(1), apropos(1) */
336:
337: if (search.argmode != ARG_FILE) {
338: if (argc == 0)
339: usage(search.argmode);
1.199 schwarze 340:
341: if (search.argmode == ARG_NAME &&
342: outmode == OUTMODE_ONE)
343: search.firstmatch = 1;
1.182 schwarze 344:
345: /* Access the mandoc database. */
346:
1.229 schwarze 347: manconf_parse(&conf, conf_file, defpaths, auxpaths);
1.218 schwarze 348: #if HAVE_SQLITE3
1.180 schwarze 349: mansearch_setup(1);
1.229 schwarze 350: if ( ! mansearch(&search, &conf.manpath,
351: argc, argv, &res, &sz))
1.180 schwarze 352: usage(search.argmode);
1.218 schwarze 353: #else
354: if (search.argmode != ARG_NAME) {
355: fputs("mandoc: database support not compiled in\n",
356: stderr);
1.245 schwarze 357: return (int)MANDOCLEVEL_BADARG;
1.218 schwarze 358: }
359: sz = 0;
360: #endif
1.213 schwarze 361:
1.237 schwarze 362: if (sz == 0) {
363: if (search.argmode == ARG_NAME)
364: fs_search(&search, &conf.manpath,
365: argc, argv, &res, &sz);
366: else
367: fprintf(stderr,
368: "%s: nothing appropriate\n",
369: progname);
370: }
1.187 schwarze 371:
372: if (sz == 0) {
373: rc = MANDOCLEVEL_BADARG;
374: goto out;
375: }
1.182 schwarze 376:
377: /*
378: * For standard man(1) and -a output mode,
379: * prepare for copying filename pointers
380: * into the program parameter array.
381: */
382:
383: if (outmode == OUTMODE_ONE) {
384: argc = 1;
385: best_prio = 10;
1.186 schwarze 386: } else if (outmode == OUTMODE_ALL)
1.182 schwarze 387: argc = (int)sz;
388:
389: /* Iterate all matching manuals. */
390:
1.213 schwarze 391: resp = res;
1.181 schwarze 392: for (i = 0; i < sz; i++) {
393: if (outmode == OUTMODE_FLN)
394: puts(res[i].file);
1.182 schwarze 395: else if (outmode == OUTMODE_LST)
1.181 schwarze 396: printf("%s - %s\n", res[i].names,
397: res[i].output == NULL ? "" :
398: res[i].output);
1.186 schwarze 399: else if (outmode == OUTMODE_ONE) {
1.182 schwarze 400: /* Search for the best section. */
401: isec = strcspn(res[i].file, "123456789");
402: sec = res[i].file[isec];
403: if ('\0' == sec)
404: continue;
405: prio = sec_prios[sec - '1'];
406: if (prio >= best_prio)
407: continue;
408: best_prio = prio;
1.186 schwarze 409: resp = res + i;
1.182 schwarze 410: }
1.181 schwarze 411: }
1.182 schwarze 412:
413: /*
414: * For man(1), -a and -i output mode, fall through
415: * to the main mandoc(1) code iterating files
416: * and running the parsers on each of them.
417: */
418:
419: if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
420: goto out;
1.180 schwarze 421: }
422:
423: /* mandoc(1) */
424:
1.209 schwarze 425: if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths))
1.245 schwarze 426: return (int)MANDOCLEVEL_BADARG;
1.241 schwarze 427:
1.195 schwarze 428: curp.mchars = mchars_alloc();
429: curp.mp = mparse_alloc(options, curp.wlevel, mmsg,
430: curp.mchars, defos);
1.154 kristaps 431:
1.165 kristaps 432: /*
433: * Conditionally start up the lookaside buffer before parsing.
434: */
435: if (OUTT_MAN == curp.outtype)
436: mparse_keep(curp.mp);
437:
1.219 schwarze 438: if (argc < 1) {
1.244 schwarze 439: if (use_pager)
440: tag_files = tag_init();
1.227 schwarze 441: parse(&curp, STDIN_FILENO, "<stdin>");
1.212 schwarze 442: }
1.64 kristaps 443:
1.219 schwarze 444: while (argc > 0) {
1.214 schwarze 445: rctmp = mparse_open(curp.mp, &fd,
1.218 schwarze 446: resp != NULL ? resp->file : *argv);
1.214 schwarze 447: if (rc < rctmp)
448: rc = rctmp;
1.212 schwarze 449:
450: if (fd != -1) {
1.244 schwarze 451: if (use_pager) {
452: tag_files = tag_init();
453: use_pager = 0;
454: }
1.212 schwarze 455:
456: if (resp == NULL)
1.227 schwarze 457: parse(&curp, fd, *argv);
1.192 schwarze 458: else if (resp->form & FORM_SRC) {
1.189 schwarze 459: /* For .so only; ignore failure. */
1.229 schwarze 460: chdir(conf.manpath.paths[resp->ipath]);
1.227 schwarze 461: parse(&curp, fd, resp->file);
462: } else
1.230 schwarze 463: passthrough(resp->file, fd,
464: conf.output.synopsisonly);
1.212 schwarze 465:
466: if (argc > 1 && curp.outtype <= OUTT_UTF8)
467: ascii_sepline(curp.outdata);
1.192 schwarze 468: }
469:
1.154 kristaps 470: if (MANDOCLEVEL_OK != rc && curp.wstop)
1.64 kristaps 471: break;
1.210 schwarze 472:
1.212 schwarze 473: if (resp != NULL)
474: resp++;
475: else
476: argv++;
477: if (--argc)
478: mparse_reset(curp.mp);
1.1 kristaps 479: }
480:
1.22 kristaps 481: if (curp.outfree)
482: (*curp.outfree)(curp.outdata);
1.195 schwarze 483: mparse_free(curp.mp);
484: mchars_free(curp.mchars);
1.182 schwarze 485:
486: out:
487: if (search.argmode != ARG_FILE) {
1.229 schwarze 488: manconf_free(&conf);
1.218 schwarze 489: #if HAVE_SQLITE3
1.182 schwarze 490: mansearch_free(res, sz);
491: mansearch_setup(0);
1.218 schwarze 492: #endif
1.182 schwarze 493: }
494:
1.166 schwarze 495: free(defos);
1.1 kristaps 496:
1.224 schwarze 497: /*
1.244 schwarze 498: * When using a pager, finish writing both temporary files,
499: * fork it, wait for the user to close it, and clean up.
1.224 schwarze 500: */
501:
1.244 schwarze 502: if (tag_files != NULL) {
1.225 schwarze 503: fclose(stdout);
1.239 schwarze 504: tag_write();
1.244 schwarze 505: waitpid(spawn_pager(tag_files), NULL, 0);
1.239 schwarze 506: tag_unlink();
1.225 schwarze 507: }
1.224 schwarze 508:
1.245 schwarze 509: return (int)rc;
1.1 kristaps 510: }
511:
1.55 kristaps 512: static void
1.180 schwarze 513: usage(enum argmode argmode)
1.1 kristaps 514: {
515:
1.180 schwarze 516: switch (argmode) {
517: case ARG_FILE:
1.228 schwarze 518: fputs("usage: mandoc [-acfhkl] [-I os=name] "
519: "[-K encoding] [-mformat] [-O option]\n"
520: "\t [-T output] [-W level] [file ...]\n", stderr);
1.180 schwarze 521: break;
522: case ARG_NAME:
1.221 schwarze 523: fputs("usage: man [-acfhklw] [-C file] [-I os=name] "
1.208 schwarze 524: "[-K encoding] [-M path] [-m path]\n"
525: "\t [-O option=value] [-S subsection] [-s section] "
526: "[-T output] [-W level]\n"
1.180 schwarze 527: "\t [section] name ...\n", stderr);
528: break;
529: case ARG_WORD:
1.221 schwarze 530: fputs("usage: whatis [-acfhklw] [-C file] "
1.188 schwarze 531: "[-M path] [-m path] [-O outkey] [-S arch]\n"
532: "\t [-s section] name ...\n", stderr);
1.180 schwarze 533: break;
534: case ARG_EXPR:
1.221 schwarze 535: fputs("usage: apropos [-acfhklw] [-C file] "
1.188 schwarze 536: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.180 schwarze 537: "\t [-s section] expression ...\n", stderr);
538: break;
539: }
1.105 kristaps 540: exit((int)MANDOCLEVEL_BADARG);
1.68 joerg 541: }
1.213 schwarze 542:
543: static int
544: fs_lookup(const struct manpaths *paths, size_t ipath,
545: const char *sec, const char *arch, const char *name,
546: struct manpage **res, size_t *ressz)
547: {
1.222 schwarze 548: glob_t globinfo;
1.213 schwarze 549: struct manpage *page;
550: char *file;
1.222 schwarze 551: int form, globres;
1.213 schwarze 552:
1.222 schwarze 553: form = FORM_SRC;
1.213 schwarze 554: mandoc_asprintf(&file, "%s/man%s/%s.%s",
555: paths->paths[ipath], sec, name, sec);
1.222 schwarze 556: if (access(file, R_OK) != -1)
1.213 schwarze 557: goto found;
558: free(file);
559:
560: mandoc_asprintf(&file, "%s/cat%s/%s.0",
561: paths->paths[ipath], sec, name);
562: if (access(file, R_OK) != -1) {
563: form = FORM_CAT;
564: goto found;
565: }
566: free(file);
567:
568: if (arch != NULL) {
569: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
570: paths->paths[ipath], sec, arch, name, sec);
1.222 schwarze 571: if (access(file, R_OK) != -1)
1.213 schwarze 572: goto found;
573: free(file);
574: }
1.222 schwarze 575:
1.240 schwarze 576: mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",
1.222 schwarze 577: paths->paths[ipath], sec, name);
578: globres = glob(file, 0, NULL, &globinfo);
579: if (globres != 0 && globres != GLOB_NOMATCH)
580: fprintf(stderr, "%s: %s: glob: %s\n",
581: progname, file, strerror(errno));
582: free(file);
583: if (globres == 0)
584: file = mandoc_strdup(*globinfo.gl_pathv);
585: globfree(&globinfo);
586: if (globres != 0)
1.245 schwarze 587: return 0;
1.213 schwarze 588:
589: found:
1.218 schwarze 590: #if HAVE_SQLITE3
1.233 schwarze 591: fprintf(stderr, "%s: outdated mandoc.db lacks %s(%s) entry, run "
592: "makewhatis %s\n", progname, name, sec, paths->paths[ipath]);
1.218 schwarze 593: #endif
1.213 schwarze 594: *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
595: page = *res + (*ressz - 1);
596: page->file = file;
597: page->names = NULL;
598: page->output = NULL;
599: page->ipath = ipath;
600: page->bits = NAME_FILE & NAME_MASK;
601: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
602: page->form = form;
1.245 schwarze 603: return 1;
1.213 schwarze 604: }
605:
606: static void
607: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
608: int argc, char **argv, struct manpage **res, size_t *ressz)
609: {
610: const char *const sections[] =
611: {"1", "8", "6", "2", "3", "3p", "5", "7", "4", "9"};
612: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
613:
614: size_t ipath, isec, lastsz;
615:
616: assert(cfg->argmode == ARG_NAME);
617:
618: *res = NULL;
619: *ressz = lastsz = 0;
620: while (argc) {
621: for (ipath = 0; ipath < paths->sz; ipath++) {
622: if (cfg->sec != NULL) {
623: if (fs_lookup(paths, ipath, cfg->sec,
624: cfg->arch, *argv, res, ressz) &&
625: cfg->firstmatch)
626: return;
627: } else for (isec = 0; isec < nsec; isec++)
628: if (fs_lookup(paths, ipath, sections[isec],
629: cfg->arch, *argv, res, ressz) &&
630: cfg->firstmatch)
631: return;
632: }
633: if (*ressz == lastsz)
634: fprintf(stderr,
635: "%s: No entry for %s in the manual.\n",
636: progname, *argv);
637: lastsz = *ressz;
638: argv++;
639: argc--;
640: }
641: }
1.68 joerg 642:
1.64 kristaps 643: static void
1.227 schwarze 644: parse(struct curparse *curp, int fd, const char *file)
1.1 kristaps 645: {
1.227 schwarze 646: enum mandoclevel rctmp;
1.234 schwarze 647: struct roff_man *man;
1.112 kristaps 648:
1.154 kristaps 649: /* Begin by parsing the file itself. */
1.112 kristaps 650:
1.154 kristaps 651: assert(file);
652: assert(fd >= -1);
1.112 kristaps 653:
1.227 schwarze 654: rctmp = mparse_readfd(curp->mp, fd, file);
655: if (rc < rctmp)
656: rc = rctmp;
1.112 kristaps 657:
1.1 kristaps 658: /*
1.154 kristaps 659: * With -Wstop and warnings or errors of at least the requested
660: * level, do not produce output.
1.1 kristaps 661: */
662:
1.227 schwarze 663: if (rctmp != MANDOCLEVEL_OK && curp->wstop)
664: return;
1.111 kristaps 665:
666: /* If unset, allocate output dev now (if applicable). */
667:
668: if ( ! (curp->outman && curp->outmdoc)) {
669: switch (curp->outtype) {
1.173 schwarze 670: case OUTT_HTML:
1.195 schwarze 671: curp->outdata = html_alloc(curp->mchars,
672: curp->outopts);
1.162 kristaps 673: curp->outfree = html_free;
674: break;
1.173 schwarze 675: case OUTT_UTF8:
1.195 schwarze 676: curp->outdata = utf8_alloc(curp->mchars,
677: curp->outopts);
1.163 kristaps 678: curp->outfree = ascii_free;
679: break;
1.173 schwarze 680: case OUTT_LOCALE:
1.195 schwarze 681: curp->outdata = locale_alloc(curp->mchars,
682: curp->outopts);
1.162 kristaps 683: curp->outfree = ascii_free;
1.111 kristaps 684: break;
1.173 schwarze 685: case OUTT_ASCII:
1.195 schwarze 686: curp->outdata = ascii_alloc(curp->mchars,
687: curp->outopts);
1.111 kristaps 688: curp->outfree = ascii_free;
689: break;
1.173 schwarze 690: case OUTT_PDF:
1.195 schwarze 691: curp->outdata = pdf_alloc(curp->mchars,
692: curp->outopts);
1.111 kristaps 693: curp->outfree = pspdf_free;
694: break;
1.173 schwarze 695: case OUTT_PS:
1.195 schwarze 696: curp->outdata = ps_alloc(curp->mchars,
697: curp->outopts);
1.111 kristaps 698: curp->outfree = pspdf_free;
699: break;
700: default:
701: break;
702: }
703:
704: switch (curp->outtype) {
1.173 schwarze 705: case OUTT_HTML:
1.111 kristaps 706: curp->outman = html_man;
707: curp->outmdoc = html_mdoc;
708: break;
1.173 schwarze 709: case OUTT_TREE:
1.111 kristaps 710: curp->outman = tree_man;
711: curp->outmdoc = tree_mdoc;
712: break;
1.173 schwarze 713: case OUTT_MAN:
1.164 schwarze 714: curp->outmdoc = man_mdoc;
1.165 kristaps 715: curp->outman = man_man;
1.164 schwarze 716: break;
1.173 schwarze 717: case OUTT_PDF:
1.111 kristaps 718: /* FALLTHROUGH */
1.173 schwarze 719: case OUTT_ASCII:
1.111 kristaps 720: /* FALLTHROUGH */
1.173 schwarze 721: case OUTT_UTF8:
1.163 kristaps 722: /* FALLTHROUGH */
1.173 schwarze 723: case OUTT_LOCALE:
1.162 kristaps 724: /* FALLTHROUGH */
1.173 schwarze 725: case OUTT_PS:
1.111 kristaps 726: curp->outman = terminal_man;
727: curp->outmdoc = terminal_mdoc;
728: break;
729: default:
730: break;
731: }
732: }
733:
1.235 schwarze 734: mparse_result(curp->mp, &man, NULL);
1.154 kristaps 735:
1.111 kristaps 736: /* Execute the out device, if it exists. */
737:
1.235 schwarze 738: if (man == NULL)
739: return;
740: if (curp->outmdoc != NULL && man->macroset == MACROSET_MDOC)
741: (*curp->outmdoc)(curp->outdata, man);
742: if (curp->outman != NULL && man->macroset == MACROSET_MAN)
1.154 kristaps 743: (*curp->outman)(curp->outdata, man);
1.186 schwarze 744: }
745:
1.227 schwarze 746: static void
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);
1.227 schwarze 804: return;
1.186 schwarze 805:
806: fail:
807: fprintf(stderr, "%s: %s: SYSERR: %s: %s",
808: progname, file, syscall, strerror(errno));
1.227 schwarze 809: if (rc < MANDOCLEVEL_SYSERR)
810: rc = MANDOCLEVEL_SYSERR;
1.194 schwarze 811: }
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);
1.245 schwarze 828: return 0;
1.194 schwarze 829: }
1.245 schwarze 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.245 schwarze 848: return 0;
1.10 kristaps 849: }
850:
1.245 schwarze 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.245 schwarze 882: return 0;
1.1 kristaps 883: }
884:
1.245 schwarze 885: return 1;
1.1 kristaps 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.245 schwarze 925: return 0;
1.1 kristaps 926: }
1.34 kristaps 927: }
1.1 kristaps 928:
1.245 schwarze 929: return 1;
1.1 kristaps 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:
1.225 schwarze 954: static pid_t
1.244 schwarze 955: spawn_pager(struct tag_files *tag_files)
1.183 schwarze 956: {
1.184 schwarze 957: #define MAX_PAGER_ARGS 16
958: char *argv[MAX_PAGER_ARGS];
959: const char *pager;
960: char *cp;
1.239 schwarze 961: size_t cmdlen;
1.184 schwarze 962: int argc;
1.225 schwarze 963: pid_t pager_pid;
1.183 schwarze 964:
1.239 schwarze 965: pager = getenv("MANPAGER");
966: if (pager == NULL || *pager == '\0')
967: pager = getenv("PAGER");
968: if (pager == NULL || *pager == '\0')
969: pager = "more -s";
970: cp = mandoc_strdup(pager);
971:
972: /*
973: * Parse the pager command into words.
974: * Intentionally do not do anything fancy here.
975: */
976:
977: argc = 0;
978: while (argc + 4 < MAX_PAGER_ARGS) {
979: argv[argc++] = cp;
980: cp = strchr(cp, ' ');
981: if (cp == NULL)
982: break;
983: *cp++ = '\0';
984: while (*cp == ' ')
985: cp++;
986: if (*cp == '\0')
987: break;
988: }
989:
1.244 schwarze 990: /* For more(1) and less(1), use the tag file. */
1.239 schwarze 991:
1.244 schwarze 992: if ((cmdlen = strlen(argv[0])) >= 4) {
1.239 schwarze 993: cp = argv[0] + cmdlen - 4;
1.244 schwarze 994: if (strcmp(cp, "less") == 0 || strcmp(cp, "more") == 0) {
995: argv[argc++] = mandoc_strdup("-T");
996: argv[argc++] = tag_files->tfn;
997: }
1.239 schwarze 998: }
1.244 schwarze 999: argv[argc++] = tag_files->ofn;
1.239 schwarze 1000: argv[argc] = NULL;
1001:
1.225 schwarze 1002: switch (pager_pid = fork()) {
1.183 schwarze 1003: case -1:
1004: fprintf(stderr, "%s: fork: %s\n",
1005: progname, strerror(errno));
1006: exit((int)MANDOCLEVEL_SYSERR);
1007: case 0:
1.224 schwarze 1008: break;
1009: default:
1.245 schwarze 1010: return pager_pid;
1.184 schwarze 1011: }
1012:
1.224 schwarze 1013: /* The child process becomes the pager. */
1.184 schwarze 1014:
1.244 schwarze 1015: if (dup2(tag_files->ofd, STDOUT_FILENO) == -1) {
1016: fprintf(stderr, "pager: stdout: %s\n", strerror(errno));
1.183 schwarze 1017: exit((int)MANDOCLEVEL_SYSERR);
1018: }
1.244 schwarze 1019: close(tag_files->ofd);
1020: close(tag_files->tfd);
1.184 schwarze 1021: execvp(argv[0], argv);
1.238 schwarze 1022: fprintf(stderr, "%s: exec %s: %s\n",
1023: progname, argv[0], strerror(errno));
1.184 schwarze 1024: exit((int)MANDOCLEVEL_SYSERR);
1.71 kristaps 1025: }
CVSweb