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