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