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