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