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