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