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