Annotation of mandoc/main.c, Revision 1.288
1.288 ! schwarze 1: /* $Id: main.c,v 1.287 2017/03/27 18:51:36 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_ONE
60: };
61:
1.19 kristaps 62: enum outt {
1.154 kristaps 63: OUTT_ASCII = 0, /* -Tascii */
1.162 kristaps 64: OUTT_LOCALE, /* -Tlocale */
1.163 kristaps 65: OUTT_UTF8, /* -Tutf8 */
1.154 kristaps 66: OUTT_TREE, /* -Ttree */
1.164 schwarze 67: OUTT_MAN, /* -Tman */
1.154 kristaps 68: OUTT_HTML, /* -Thtml */
1.285 schwarze 69: OUTT_MARKDOWN, /* -Tmarkdown */
1.154 kristaps 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.286 schwarze 95: static void 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.283 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.282 schwarze 116: struct mansearch search;
1.5 kristaps 117: struct curparse curp;
1.244 schwarze 118: struct tag_files *tag_files;
1.282 schwarze 119: struct manpage *res, *resp;
120: const char *progname, *sec, *thisarg;
121: char *conf_file, *defpaths, *auxpaths;
122: char *defos, *oarg;
1.207 schwarze 123: unsigned char *uc;
1.264 schwarze 124: size_t i, sz;
1.230 schwarze 125: int prio, best_prio;
1.181 schwarze 126: enum outmode outmode;
1.192 schwarze 127: int fd;
1.180 schwarze 128: int show_usage;
1.170 schwarze 129: int options;
1.244 schwarze 130: int use_pager;
1.259 schwarze 131: int status, signum;
1.180 schwarze 132: int c;
1.259 schwarze 133: pid_t pager_pid, tc_pgid, man_pgid, pid;
1.1 kristaps 134:
1.254 schwarze 135: #if HAVE_PROGNAME
136: progname = getprogname();
137: #else
1.219 schwarze 138: if (argc < 1)
1.254 schwarze 139: progname = mandoc_strdup("mandoc");
140: else if ((progname = strrchr(argv[0], '/')) == NULL)
141: progname = argv[0];
1.54 kristaps 142: else
1.254 schwarze 143: ++progname;
144: setprogname(progname);
1.247 schwarze 145: #endif
1.203 schwarze 146:
1.254 schwarze 147: if (strncmp(progname, "mandocdb", 8) == 0 ||
148: strcmp(progname, BINM_MAKEWHATIS) == 0)
1.245 schwarze 149: return mandocdb(argc, argv);
1.179 schwarze 150:
1.255 schwarze 151: #if HAVE_PLEDGE
1.284 schwarze 152: if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1)
1.255 schwarze 153: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.269 kristaps 154: #endif
155:
156: #if HAVE_SANDBOX_INIT
157: if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1)
158: errx((int)MANDOCLEVEL_SYSERR, "sandbox_init");
1.255 schwarze 159: #endif
160:
1.180 schwarze 161: /* Search options. */
162:
1.229 schwarze 163: memset(&conf, 0, sizeof(conf));
1.205 schwarze 164: conf_file = defpaths = NULL;
165: auxpaths = NULL;
1.180 schwarze 166:
167: memset(&search, 0, sizeof(struct mansearch));
168: search.outkey = "Nd";
1.282 schwarze 169: oarg = NULL;
1.180 schwarze 170:
1.254 schwarze 171: if (strcmp(progname, BINM_MAN) == 0)
1.180 schwarze 172: search.argmode = ARG_NAME;
1.254 schwarze 173: else if (strcmp(progname, BINM_APROPOS) == 0)
1.180 schwarze 174: search.argmode = ARG_EXPR;
1.254 schwarze 175: else if (strcmp(progname, BINM_WHATIS) == 0)
1.180 schwarze 176: search.argmode = ARG_WORD;
1.254 schwarze 177: else if (strncmp(progname, "help", 4) == 0)
1.202 schwarze 178: search.argmode = ARG_NAME;
1.180 schwarze 179: else
180: search.argmode = ARG_FILE;
181:
182: /* Parser and formatter options. */
1.54 kristaps 183:
1.51 kristaps 184: memset(&curp, 0, sizeof(struct curparse));
1.201 schwarze 185: curp.outtype = OUTT_LOCALE;
1.215 schwarze 186: curp.wlevel = MANDOCLEVEL_BADARG;
1.230 schwarze 187: curp.outopts = &conf.output;
1.194 schwarze 188: options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.166 schwarze 189: defos = NULL;
1.19 kristaps 190:
1.244 schwarze 191: use_pager = 1;
192: tag_files = NULL;
1.180 schwarze 193: show_usage = 0;
1.181 schwarze 194: outmode = OUTMODE_DEF;
1.183 schwarze 195:
1.194 schwarze 196: while (-1 != (c = getopt(argc, argv,
197: "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
1.1 kristaps 198: switch (c) {
1.181 schwarze 199: case 'a':
200: outmode = OUTMODE_ALL;
201: break;
1.180 schwarze 202: case 'C':
203: conf_file = optarg;
204: break;
1.183 schwarze 205: case 'c':
1.244 schwarze 206: use_pager = 0;
1.183 schwarze 207: break;
1.180 schwarze 208: case 'f':
209: search.argmode = ARG_WORD;
210: break;
1.190 schwarze 211: case 'h':
1.230 schwarze 212: conf.output.synopsisonly = 1;
1.244 schwarze 213: use_pager = 0;
1.190 schwarze 214: outmode = OUTMODE_ALL;
215: break;
1.173 schwarze 216: case 'I':
1.166 schwarze 217: if (strncmp(optarg, "os=", 3)) {
1.247 schwarze 218: warnx("-I %s: Bad argument", optarg);
1.245 schwarze 219: return (int)MANDOCLEVEL_BADARG;
1.166 schwarze 220: }
221: if (defos) {
1.247 schwarze 222: warnx("-I %s: Duplicate argument", optarg);
1.245 schwarze 223: return (int)MANDOCLEVEL_BADARG;
1.166 schwarze 224: }
225: defos = mandoc_strdup(optarg + 3);
1.181 schwarze 226: break;
1.194 schwarze 227: case 'K':
228: if ( ! koptions(&options, optarg))
1.245 schwarze 229: return (int)MANDOCLEVEL_BADARG;
1.194 schwarze 230: break;
1.180 schwarze 231: case 'k':
232: search.argmode = ARG_EXPR;
233: break;
1.188 schwarze 234: case 'l':
235: search.argmode = ARG_FILE;
236: outmode = OUTMODE_ALL;
237: break;
1.180 schwarze 238: case 'M':
239: defpaths = optarg;
240: break;
1.173 schwarze 241: case 'm':
1.180 schwarze 242: auxpaths = optarg;
1.10 kristaps 243: break;
1.173 schwarze 244: case 'O':
1.282 schwarze 245: oarg = optarg;
1.44 kristaps 246: break;
1.180 schwarze 247: case 'S':
248: search.arch = optarg;
249: break;
250: case 's':
251: search.sec = optarg;
252: break;
1.173 schwarze 253: case 'T':
1.60 kristaps 254: if ( ! toptions(&curp, optarg))
1.245 schwarze 255: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 256: break;
1.173 schwarze 257: case 'W':
1.103 schwarze 258: if ( ! woptions(&curp, optarg))
1.245 schwarze 259: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 260: break;
1.181 schwarze 261: case 'w':
262: outmode = OUTMODE_FLN;
263: break;
1.1 kristaps 264: default:
1.180 schwarze 265: show_usage = 1;
266: break;
1.1 kristaps 267: }
1.180 schwarze 268: }
269:
270: if (show_usage)
271: usage(search.argmode);
272:
1.185 schwarze 273: /* Postprocess options. */
274:
1.181 schwarze 275: if (outmode == OUTMODE_DEF) {
276: switch (search.argmode) {
277: case ARG_FILE:
278: outmode = OUTMODE_ALL;
1.244 schwarze 279: use_pager = 0;
1.181 schwarze 280: break;
281: case ARG_NAME:
282: outmode = OUTMODE_ONE;
283: break;
284: default:
285: outmode = OUTMODE_LST;
286: break;
1.282 schwarze 287: }
288: }
289:
290: if (oarg != NULL) {
291: if (outmode == OUTMODE_LST)
292: search.outkey = oarg;
293: else {
294: while (oarg != NULL) {
295: thisarg = oarg;
296: if (manconf_output(&conf.output,
297: strsep(&oarg, ","), 0) == 0)
298: continue;
299: warnx("-O %s: Bad argument", thisarg);
300: return (int)MANDOCLEVEL_BADARG;
301: }
1.181 schwarze 302: }
303: }
304:
1.246 schwarze 305: if (outmode == OUTMODE_FLN ||
306: outmode == OUTMODE_LST ||
307: !isatty(STDOUT_FILENO))
308: use_pager = 0;
309:
1.255 schwarze 310: #if HAVE_PLEDGE
1.260 schwarze 311: if (!use_pager)
1.284 schwarze 312: if (pledge("stdio rpath", NULL) == -1)
1.260 schwarze 313: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.255 schwarze 314: #endif
315:
1.185 schwarze 316: /* Parse arguments. */
317:
1.219 schwarze 318: if (argc > 0) {
319: argc -= optind;
320: argv += optind;
321: }
1.186 schwarze 322: resp = NULL;
1.185 schwarze 323:
1.202 schwarze 324: /*
325: * Quirks for help(1)
326: * and for a man(1) section argument without -s.
327: */
328:
329: if (search.argmode == ARG_NAME) {
1.254 schwarze 330: if (*progname == 'h') {
1.202 schwarze 331: if (argc == 0) {
332: argv = help_argv;
333: argc = 1;
334: }
1.211 schwarze 335: } else if (argc > 1 &&
1.223 kristaps 336: ((uc = (unsigned char *)argv[0]) != NULL) &&
1.207 schwarze 337: ((isdigit(uc[0]) && (uc[1] == '\0' ||
338: (isalpha(uc[1]) && uc[2] == '\0'))) ||
339: (uc[0] == 'n' && uc[1] == '\0'))) {
1.223 kristaps 340: search.sec = (char *)uc;
1.202 schwarze 341: argv++;
342: argc--;
343: }
1.216 schwarze 344: if (search.arch == NULL)
345: search.arch = getenv("MACHINE");
1.223 kristaps 346: #ifdef MACHINE
1.216 schwarze 347: if (search.arch == NULL)
348: search.arch = MACHINE;
1.223 kristaps 349: #endif
1.185 schwarze 350: }
1.182 schwarze 351:
352: rc = MANDOCLEVEL_OK;
1.180 schwarze 353:
354: /* man(1), whatis(1), apropos(1) */
355:
356: if (search.argmode != ARG_FILE) {
1.199 schwarze 357: if (search.argmode == ARG_NAME &&
358: outmode == OUTMODE_ONE)
359: search.firstmatch = 1;
1.182 schwarze 360:
361: /* Access the mandoc database. */
362:
1.229 schwarze 363: manconf_parse(&conf, conf_file, defpaths, auxpaths);
364: if ( ! mansearch(&search, &conf.manpath,
365: argc, argv, &res, &sz))
1.180 schwarze 366: usage(search.argmode);
1.213 schwarze 367:
1.237 schwarze 368: if (sz == 0) {
369: if (search.argmode == ARG_NAME)
370: fs_search(&search, &conf.manpath,
371: argc, argv, &res, &sz);
372: else
1.247 schwarze 373: warnx("nothing appropriate");
1.237 schwarze 374: }
1.187 schwarze 375:
376: if (sz == 0) {
377: rc = MANDOCLEVEL_BADARG;
378: goto out;
379: }
1.182 schwarze 380:
381: /*
382: * For standard man(1) and -a output mode,
383: * prepare for copying filename pointers
384: * into the program parameter array.
385: */
386:
387: if (outmode == OUTMODE_ONE) {
388: argc = 1;
1.264 schwarze 389: best_prio = 20;
1.186 schwarze 390: } else if (outmode == OUTMODE_ALL)
1.182 schwarze 391: argc = (int)sz;
392:
393: /* Iterate all matching manuals. */
394:
1.213 schwarze 395: resp = res;
1.181 schwarze 396: for (i = 0; i < sz; i++) {
397: if (outmode == OUTMODE_FLN)
398: puts(res[i].file);
1.182 schwarze 399: else if (outmode == OUTMODE_LST)
1.181 schwarze 400: printf("%s - %s\n", res[i].names,
401: res[i].output == NULL ? "" :
402: res[i].output);
1.186 schwarze 403: else if (outmode == OUTMODE_ONE) {
1.182 schwarze 404: /* Search for the best section. */
1.264 schwarze 405: sec = res[i].file;
406: sec += strcspn(sec, "123456789");
407: if (sec[0] == '\0')
1.182 schwarze 408: continue;
1.264 schwarze 409: prio = sec_prios[sec[0] - '1'];
410: if (sec[1] != '/')
411: prio += 10;
1.182 schwarze 412: if (prio >= best_prio)
413: continue;
414: best_prio = prio;
1.186 schwarze 415: resp = res + i;
1.182 schwarze 416: }
1.181 schwarze 417: }
1.182 schwarze 418:
419: /*
420: * For man(1), -a and -i output mode, fall through
421: * to the main mandoc(1) code iterating files
422: * and running the parsers on each of them.
423: */
424:
425: if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
426: goto out;
1.180 schwarze 427: }
428:
429: /* mandoc(1) */
430:
1.255 schwarze 431: #if HAVE_PLEDGE
1.260 schwarze 432: if (use_pager) {
433: if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1)
434: err((int)MANDOCLEVEL_SYSERR, "pledge");
435: } else {
436: if (pledge("stdio rpath", NULL) == -1)
437: err((int)MANDOCLEVEL_SYSERR, "pledge");
438: }
1.255 schwarze 439: #endif
440:
1.286 schwarze 441: if (search.argmode == ARG_FILE)
442: moptions(&options, auxpaths);
1.241 schwarze 443:
1.249 schwarze 444: mchars_alloc();
445: curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos);
1.154 kristaps 446:
1.165 kristaps 447: /*
448: * Conditionally start up the lookaside buffer before parsing.
449: */
450: if (OUTT_MAN == curp.outtype)
451: mparse_keep(curp.mp);
452:
1.219 schwarze 453: if (argc < 1) {
1.244 schwarze 454: if (use_pager)
455: tag_files = tag_init();
1.227 schwarze 456: parse(&curp, STDIN_FILENO, "<stdin>");
1.212 schwarze 457: }
1.64 kristaps 458:
1.219 schwarze 459: while (argc > 0) {
1.262 schwarze 460: fd = mparse_open(curp.mp, resp != NULL ? resp->file : *argv);
1.212 schwarze 461: if (fd != -1) {
1.244 schwarze 462: if (use_pager) {
463: tag_files = tag_init();
464: use_pager = 0;
465: }
1.212 schwarze 466:
467: if (resp == NULL)
1.227 schwarze 468: parse(&curp, fd, *argv);
1.274 schwarze 469: else if (resp->form == FORM_SRC) {
1.189 schwarze 470: /* For .so only; ignore failure. */
1.229 schwarze 471: chdir(conf.manpath.paths[resp->ipath]);
1.227 schwarze 472: parse(&curp, fd, resp->file);
473: } else
1.230 schwarze 474: passthrough(resp->file, fd,
475: conf.output.synopsisonly);
1.212 schwarze 476:
1.276 schwarze 477: if (argc > 1 && curp.outtype <= OUTT_UTF8) {
478: if (curp.outdata == NULL)
479: outdata_alloc(&curp);
1.267 schwarze 480: terminal_sepline(curp.outdata);
1.276 schwarze 481: }
1.262 schwarze 482: } else if (rc < MANDOCLEVEL_ERROR)
483: rc = MANDOCLEVEL_ERROR;
1.192 schwarze 484:
1.154 kristaps 485: if (MANDOCLEVEL_OK != rc && curp.wstop)
1.64 kristaps 486: break;
1.210 schwarze 487:
1.212 schwarze 488: if (resp != NULL)
489: resp++;
490: else
491: argv++;
492: if (--argc)
493: mparse_reset(curp.mp);
1.1 kristaps 494: }
495:
1.252 schwarze 496: if (curp.outdata != NULL) {
497: switch (curp.outtype) {
498: case OUTT_HTML:
499: html_free(curp.outdata);
500: break;
501: case OUTT_UTF8:
502: case OUTT_LOCALE:
503: case OUTT_ASCII:
504: ascii_free(curp.outdata);
505: break;
506: case OUTT_PDF:
507: case OUTT_PS:
508: pspdf_free(curp.outdata);
509: break;
510: default:
511: break;
512: }
1.250 schwarze 513: }
1.195 schwarze 514: mparse_free(curp.mp);
1.249 schwarze 515: mchars_free();
1.182 schwarze 516:
517: out:
518: if (search.argmode != ARG_FILE) {
1.229 schwarze 519: manconf_free(&conf);
1.182 schwarze 520: mansearch_free(res, sz);
521: }
522:
1.166 schwarze 523: free(defos);
1.1 kristaps 524:
1.224 schwarze 525: /*
1.244 schwarze 526: * When using a pager, finish writing both temporary files,
527: * fork it, wait for the user to close it, and clean up.
1.224 schwarze 528: */
529:
1.244 schwarze 530: if (tag_files != NULL) {
1.225 schwarze 531: fclose(stdout);
1.239 schwarze 532: tag_write();
1.259 schwarze 533: man_pgid = getpgid(0);
534: tag_files->tcpgid = man_pgid == getpid() ?
535: getpgid(getppid()) : man_pgid;
536: pager_pid = 0;
537: signum = SIGSTOP;
1.258 schwarze 538: for (;;) {
1.259 schwarze 539:
540: /* Stop here until moved to the foreground. */
541:
1.279 schwarze 542: tc_pgid = tcgetpgrp(tag_files->ofd);
1.259 schwarze 543: if (tc_pgid != man_pgid) {
544: if (tc_pgid == pager_pid) {
1.279 schwarze 545: (void)tcsetpgrp(tag_files->ofd,
1.259 schwarze 546: man_pgid);
547: if (signum == SIGTTIN)
548: continue;
549: } else
550: tag_files->tcpgid = tc_pgid;
551: kill(0, signum);
552: continue;
553: }
554:
555: /* Once in the foreground, activate the pager. */
556:
557: if (pager_pid) {
1.279 schwarze 558: (void)tcsetpgrp(tag_files->ofd, pager_pid);
1.259 schwarze 559: kill(pager_pid, SIGCONT);
560: } else
561: pager_pid = spawn_pager(tag_files);
562:
563: /* Wait for the pager to stop or exit. */
564:
565: while ((pid = waitpid(pager_pid, &status,
566: WUNTRACED)) == -1 && errno == EINTR)
567: continue;
568:
569: if (pid == -1) {
1.258 schwarze 570: warn("wait");
571: rc = MANDOCLEVEL_SYSERR;
572: break;
573: }
574: if (!WIFSTOPPED(status))
575: break;
576:
1.259 schwarze 577: signum = WSTOPSIG(status);
1.258 schwarze 578: }
1.239 schwarze 579: tag_unlink();
1.225 schwarze 580: }
1.224 schwarze 581:
1.245 schwarze 582: return (int)rc;
1.1 kristaps 583: }
584:
1.55 kristaps 585: static void
1.180 schwarze 586: usage(enum argmode argmode)
1.1 kristaps 587: {
588:
1.180 schwarze 589: switch (argmode) {
590: case ARG_FILE:
1.287 schwarze 591: fputs("usage: mandoc [-ac] [-I os=name] "
592: "[-K encoding] [-mdoc | -man] [-O options]\n"
1.228 schwarze 593: "\t [-T output] [-W level] [file ...]\n", stderr);
1.180 schwarze 594: break;
595: case ARG_NAME:
1.287 schwarze 596: fputs("usage: man [-acfhklw] [-C file] [-M path] "
597: "[-m path] [-S subsection]\n"
598: "\t [[-s] section] name ...\n", stderr);
1.180 schwarze 599: break;
600: case ARG_WORD:
1.287 schwarze 601: fputs("usage: whatis [-afk] [-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.287 schwarze 606: fputs("usage: apropos [-afk] [-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.281 schwarze 745: if (curp->outtype != OUTT_TREE || !curp->outopts->noval)
746: mdoc_validate(man);
1.111 kristaps 747: switch (curp->outtype) {
1.173 schwarze 748: case OUTT_HTML:
1.250 schwarze 749: html_mdoc(curp->outdata, man);
1.111 kristaps 750: break;
1.173 schwarze 751: case OUTT_TREE:
1.250 schwarze 752: tree_mdoc(curp->outdata, man);
1.111 kristaps 753: break;
1.173 schwarze 754: case OUTT_MAN:
1.250 schwarze 755: man_mdoc(curp->outdata, man);
1.164 schwarze 756: break;
1.173 schwarze 757: case OUTT_PDF:
758: case OUTT_ASCII:
759: case OUTT_UTF8:
760: case OUTT_LOCALE:
761: case OUTT_PS:
1.250 schwarze 762: terminal_mdoc(curp->outdata, man);
763: break;
1.285 schwarze 764: case OUTT_MARKDOWN:
765: markdown_mdoc(curp->outdata, man);
766: break;
1.250 schwarze 767: default:
768: break;
769: }
770: }
771: if (man->macroset == MACROSET_MAN) {
1.281 schwarze 772: if (curp->outtype != OUTT_TREE || !curp->outopts->noval)
773: man_validate(man);
1.250 schwarze 774: switch (curp->outtype) {
775: case OUTT_HTML:
776: html_man(curp->outdata, man);
777: break;
778: case OUTT_TREE:
779: tree_man(curp->outdata, man);
780: break;
781: case OUTT_MAN:
782: man_man(curp->outdata, man);
783: break;
784: case OUTT_PDF:
785: case OUTT_ASCII:
786: case OUTT_UTF8:
787: case OUTT_LOCALE:
788: case OUTT_PS:
789: terminal_man(curp->outdata, man);
1.111 kristaps 790: break;
791: default:
792: break;
793: }
1.276 schwarze 794: }
1.278 schwarze 795: mparse_updaterc(curp->mp, &rc);
1.276 schwarze 796: }
797:
798: static void
799: outdata_alloc(struct curparse *curp)
800: {
801: switch (curp->outtype) {
802: case OUTT_HTML:
803: curp->outdata = html_alloc(curp->outopts);
804: break;
805: case OUTT_UTF8:
806: curp->outdata = utf8_alloc(curp->outopts);
807: break;
808: case OUTT_LOCALE:
809: curp->outdata = locale_alloc(curp->outopts);
810: break;
811: case OUTT_ASCII:
812: curp->outdata = ascii_alloc(curp->outopts);
813: break;
814: case OUTT_PDF:
815: curp->outdata = pdf_alloc(curp->outopts);
816: break;
817: case OUTT_PS:
818: curp->outdata = ps_alloc(curp->outopts);
819: break;
820: default:
821: break;
1.111 kristaps 822: }
1.186 schwarze 823: }
824:
1.227 schwarze 825: static void
1.197 schwarze 826: passthrough(const char *file, int fd, int synopsis_only)
1.186 schwarze 827: {
1.197 schwarze 828: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
829: const char synr[] = "SYNOPSIS";
830:
831: FILE *stream;
1.186 schwarze 832: const char *syscall;
1.257 schwarze 833: char *line, *cp;
834: size_t linesz;
1.277 schwarze 835: ssize_t len, written;
1.197 schwarze 836: int print;
1.210 schwarze 837:
1.257 schwarze 838: line = NULL;
839: linesz = 0;
1.197 schwarze 840:
1.277 schwarze 841: if (fflush(stdout) == EOF) {
842: syscall = "fflush";
843: goto fail;
844: }
845:
1.197 schwarze 846: if ((stream = fdopen(fd, "r")) == NULL) {
847: close(fd);
848: syscall = "fdopen";
849: goto fail;
850: }
1.186 schwarze 851:
1.197 schwarze 852: print = 0;
1.277 schwarze 853: while ((len = getline(&line, &linesz, stream)) != -1) {
1.257 schwarze 854: cp = line;
1.197 schwarze 855: if (synopsis_only) {
856: if (print) {
1.257 schwarze 857: if ( ! isspace((unsigned char)*cp))
1.197 schwarze 858: goto done;
1.277 schwarze 859: while (isspace((unsigned char)*cp)) {
1.257 schwarze 860: cp++;
1.277 schwarze 861: len--;
862: }
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.277 schwarze 870: for (; len > 0; len -= written) {
871: if ((written = write(STDOUT_FILENO, cp, len)) != -1)
872: continue;
1.257 schwarze 873: fclose(stream);
1.277 schwarze 874: syscall = "write";
1.257 schwarze 875: goto fail;
876: }
1.197 schwarze 877: }
1.186 schwarze 878:
1.197 schwarze 879: if (ferror(stream)) {
880: fclose(stream);
1.257 schwarze 881: syscall = "getline";
1.197 schwarze 882: goto fail;
883: }
1.193 schwarze 884:
1.197 schwarze 885: done:
1.257 schwarze 886: free(line);
1.197 schwarze 887: fclose(stream);
1.227 schwarze 888: return;
1.186 schwarze 889:
890: fail:
1.257 schwarze 891: free(line);
1.247 schwarze 892: warn("%s: SYSERR: %s", file, syscall);
1.227 schwarze 893: if (rc < MANDOCLEVEL_SYSERR)
894: rc = MANDOCLEVEL_SYSERR;
1.194 schwarze 895: }
896:
897: static int
898: koptions(int *options, char *arg)
899: {
900:
901: if ( ! strcmp(arg, "utf-8")) {
902: *options |= MPARSE_UTF8;
903: *options &= ~MPARSE_LATIN1;
904: } else if ( ! strcmp(arg, "iso-8859-1")) {
905: *options |= MPARSE_LATIN1;
906: *options &= ~MPARSE_UTF8;
907: } else if ( ! strcmp(arg, "us-ascii")) {
908: *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
909: } else {
1.247 schwarze 910: warnx("-K %s: Bad argument", arg);
1.245 schwarze 911: return 0;
1.194 schwarze 912: }
1.245 schwarze 913: return 1;
1.10 kristaps 914: }
915:
1.286 schwarze 916: static void
1.170 schwarze 917: moptions(int *options, char *arg)
1.10 kristaps 918: {
919:
1.180 schwarze 920: if (arg == NULL)
1.286 schwarze 921: return;
922: if (strcmp(arg, "doc") == 0)
1.170 schwarze 923: *options |= MPARSE_MDOC;
1.286 schwarze 924: else if (strcmp(arg, "an") == 0)
1.170 schwarze 925: *options |= MPARSE_MAN;
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.285 schwarze 943: else if (0 == strcmp(arg, "markdown"))
944: curp->outtype = OUTT_MARKDOWN;
1.163 kristaps 945: else if (0 == strcmp(arg, "utf8"))
946: curp->outtype = OUTT_UTF8;
1.162 kristaps 947: else if (0 == strcmp(arg, "locale"))
948: curp->outtype = OUTT_LOCALE;
1.59 kristaps 949: else if (0 == strcmp(arg, "xhtml"))
1.195 schwarze 950: curp->outtype = OUTT_HTML;
1.85 kristaps 951: else if (0 == strcmp(arg, "ps"))
952: curp->outtype = OUTT_PS;
1.100 kristaps 953: else if (0 == strcmp(arg, "pdf"))
954: curp->outtype = OUTT_PDF;
1.1 kristaps 955: else {
1.247 schwarze 956: warnx("-T %s: Bad argument", arg);
1.245 schwarze 957: return 0;
1.1 kristaps 958: }
959:
1.245 schwarze 960: return 1;
1.1 kristaps 961: }
962:
963: static int
1.103 schwarze 964: woptions(struct curparse *curp, char *arg)
1.1 kristaps 965: {
1.34 kristaps 966: char *v, *o;
1.217 schwarze 967: const char *toks[7];
1.1 kristaps 968:
1.103 schwarze 969: toks[0] = "stop";
970: toks[1] = "all";
971: toks[2] = "warning";
972: toks[3] = "error";
1.217 schwarze 973: toks[4] = "unsupp";
974: toks[5] = "fatal";
975: toks[6] = NULL;
1.1 kristaps 976:
1.34 kristaps 977: while (*arg) {
978: o = arg;
1.272 schwarze 979: switch (getsubopt(&arg, (char * const *)toks, &v)) {
1.173 schwarze 980: case 0:
1.103 schwarze 981: curp->wstop = 1;
1.1 kristaps 982: break;
1.173 schwarze 983: case 1:
984: case 2:
1.103 schwarze 985: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 986: break;
1.173 schwarze 987: case 3:
1.103 schwarze 988: curp->wlevel = MANDOCLEVEL_ERROR;
1.24 kristaps 989: break;
1.173 schwarze 990: case 4:
1.217 schwarze 991: curp->wlevel = MANDOCLEVEL_UNSUPP;
992: break;
993: case 5:
1.215 schwarze 994: curp->wlevel = MANDOCLEVEL_BADARG;
1.50 kristaps 995: break;
1.1 kristaps 996: default:
1.247 schwarze 997: warnx("-W %s: Bad argument", o);
1.245 schwarze 998: return 0;
1.1 kristaps 999: }
1.34 kristaps 1000: }
1.1 kristaps 1001:
1.245 schwarze 1002: return 1;
1.1 kristaps 1003: }
1004:
1.153 kristaps 1005: static void
1.173 schwarze 1006: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.155 kristaps 1007: const char *file, int line, int col, const char *msg)
1.71 kristaps 1008: {
1.177 schwarze 1009: const char *mparse_msg;
1.103 schwarze 1010:
1.275 schwarze 1011: fprintf(stderr, "%s: %s:", getprogname(),
1012: file == NULL ? "<stdin>" : file);
1.175 schwarze 1013:
1014: if (line)
1015: fprintf(stderr, "%d:%d:", line, col + 1);
1016:
1.177 schwarze 1017: fprintf(stderr, " %s", mparse_strlevel(lvl));
1018:
1019: if (NULL != (mparse_msg = mparse_strerror(t)))
1020: fprintf(stderr, ": %s", mparse_msg);
1.154 kristaps 1021:
1.73 kristaps 1022: if (msg)
1023: fprintf(stderr, ": %s", msg);
1.154 kristaps 1024:
1.73 kristaps 1025: fputc('\n', stderr);
1.183 schwarze 1026: }
1027:
1.225 schwarze 1028: static pid_t
1.244 schwarze 1029: spawn_pager(struct tag_files *tag_files)
1.183 schwarze 1030: {
1.265 schwarze 1031: const struct timespec timeout = { 0, 100000000 }; /* 0.1s */
1.184 schwarze 1032: #define MAX_PAGER_ARGS 16
1033: char *argv[MAX_PAGER_ARGS];
1034: const char *pager;
1035: char *cp;
1.239 schwarze 1036: size_t cmdlen;
1.184 schwarze 1037: int argc;
1.225 schwarze 1038: pid_t pager_pid;
1.183 schwarze 1039:
1.239 schwarze 1040: pager = getenv("MANPAGER");
1041: if (pager == NULL || *pager == '\0')
1042: pager = getenv("PAGER");
1043: if (pager == NULL || *pager == '\0')
1044: pager = "more -s";
1045: cp = mandoc_strdup(pager);
1046:
1047: /*
1048: * Parse the pager command into words.
1049: * Intentionally do not do anything fancy here.
1050: */
1051:
1052: argc = 0;
1053: while (argc + 4 < MAX_PAGER_ARGS) {
1054: argv[argc++] = cp;
1055: cp = strchr(cp, ' ');
1056: if (cp == NULL)
1057: break;
1058: *cp++ = '\0';
1059: while (*cp == ' ')
1060: cp++;
1061: if (*cp == '\0')
1062: break;
1063: }
1064:
1.268 schwarze 1065: /* For less(1), use the tag file. */
1.239 schwarze 1066:
1.244 schwarze 1067: if ((cmdlen = strlen(argv[0])) >= 4) {
1.239 schwarze 1068: cp = argv[0] + cmdlen - 4;
1.268 schwarze 1069: if (strcmp(cp, "less") == 0) {
1.244 schwarze 1070: argv[argc++] = mandoc_strdup("-T");
1071: argv[argc++] = tag_files->tfn;
1072: }
1.239 schwarze 1073: }
1.244 schwarze 1074: argv[argc++] = tag_files->ofn;
1.239 schwarze 1075: argv[argc] = NULL;
1076:
1.225 schwarze 1077: switch (pager_pid = fork()) {
1.183 schwarze 1078: case -1:
1.247 schwarze 1079: err((int)MANDOCLEVEL_SYSERR, "fork");
1.183 schwarze 1080: case 0:
1.224 schwarze 1081: break;
1082: default:
1.258 schwarze 1083: (void)setpgid(pager_pid, 0);
1.279 schwarze 1084: (void)tcsetpgrp(tag_files->ofd, pager_pid);
1.255 schwarze 1085: #if HAVE_PLEDGE
1.258 schwarze 1086: if (pledge("stdio rpath tmppath tty proc", NULL) == -1)
1.255 schwarze 1087: err((int)MANDOCLEVEL_SYSERR, "pledge");
1088: #endif
1.259 schwarze 1089: tag_files->pager_pid = pager_pid;
1.245 schwarze 1090: return pager_pid;
1.184 schwarze 1091: }
1092:
1.224 schwarze 1093: /* The child process becomes the pager. */
1.184 schwarze 1094:
1.247 schwarze 1095: if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
1096: err((int)MANDOCLEVEL_SYSERR, "pager stdout");
1.244 schwarze 1097: close(tag_files->ofd);
1098: close(tag_files->tfd);
1.265 schwarze 1099:
1100: /* Do not start the pager before controlling the terminal. */
1101:
1.279 schwarze 1102: while (tcgetpgrp(STDOUT_FILENO) != getpid())
1.265 schwarze 1103: nanosleep(&timeout, NULL);
1104:
1.184 schwarze 1105: execvp(argv[0], argv);
1.247 schwarze 1106: err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
1.71 kristaps 1107: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to main.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc