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