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