Annotation of mandoc/main.c, Revision 1.273.2.3
1.273.2.3! schwarze 1: /* $Id: main.c,v 1.278 2017/01/09 01:37:03 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;
128: size_t i, sz;
1.230 schwarze 129: int prio, best_prio;
1.181 schwarze 130: enum outmode outmode;
1.192 schwarze 131: int fd;
1.180 schwarze 132: int show_usage;
1.170 schwarze 133: int options;
1.244 schwarze 134: int use_pager;
1.259 schwarze 135: int status, signum;
1.180 schwarze 136: int c;
1.259 schwarze 137: pid_t pager_pid, tc_pgid, man_pgid, pid;
1.1 kristaps 138:
1.254 schwarze 139: #if HAVE_PROGNAME
140: progname = getprogname();
141: #else
1.219 schwarze 142: if (argc < 1)
1.254 schwarze 143: progname = mandoc_strdup("mandoc");
144: else if ((progname = strrchr(argv[0], '/')) == NULL)
145: progname = argv[0];
1.54 kristaps 146: else
1.254 schwarze 147: ++progname;
148: setprogname(progname);
1.247 schwarze 149: #endif
1.203 schwarze 150:
151: #if HAVE_SQLITE3
1.254 schwarze 152: if (strncmp(progname, "mandocdb", 8) == 0 ||
153: strcmp(progname, BINM_MAKEWHATIS) == 0)
1.245 schwarze 154: return mandocdb(argc, argv);
1.203 schwarze 155: #endif
1.179 schwarze 156:
1.255 schwarze 157: #if HAVE_PLEDGE
1.258 schwarze 158: if (pledge("stdio rpath tmppath tty proc exec flock", NULL) == -1)
1.255 schwarze 159: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.269 kristaps 160: #endif
161:
162: #if HAVE_SANDBOX_INIT
163: if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1)
164: errx((int)MANDOCLEVEL_SYSERR, "sandbox_init");
1.255 schwarze 165: #endif
166:
1.180 schwarze 167: /* Search options. */
168:
1.229 schwarze 169: memset(&conf, 0, sizeof(conf));
1.205 schwarze 170: conf_file = defpaths = NULL;
171: auxpaths = NULL;
1.180 schwarze 172:
173: memset(&search, 0, sizeof(struct mansearch));
174: search.outkey = "Nd";
175:
1.254 schwarze 176: if (strcmp(progname, BINM_MAN) == 0)
1.180 schwarze 177: search.argmode = ARG_NAME;
1.254 schwarze 178: else if (strcmp(progname, BINM_APROPOS) == 0)
1.180 schwarze 179: search.argmode = ARG_EXPR;
1.254 schwarze 180: else if (strcmp(progname, BINM_WHATIS) == 0)
1.180 schwarze 181: search.argmode = ARG_WORD;
1.254 schwarze 182: else if (strncmp(progname, "help", 4) == 0)
1.202 schwarze 183: search.argmode = ARG_NAME;
1.180 schwarze 184: else
185: search.argmode = ARG_FILE;
186:
187: /* Parser and formatter options. */
1.54 kristaps 188:
1.51 kristaps 189: memset(&curp, 0, sizeof(struct curparse));
1.201 schwarze 190: curp.outtype = OUTT_LOCALE;
1.215 schwarze 191: curp.wlevel = MANDOCLEVEL_BADARG;
1.230 schwarze 192: curp.outopts = &conf.output;
1.194 schwarze 193: options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.166 schwarze 194: defos = NULL;
1.19 kristaps 195:
1.244 schwarze 196: use_pager = 1;
197: tag_files = NULL;
1.180 schwarze 198: show_usage = 0;
1.181 schwarze 199: outmode = OUTMODE_DEF;
1.183 schwarze 200:
1.194 schwarze 201: while (-1 != (c = getopt(argc, argv,
202: "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
1.1 kristaps 203: switch (c) {
1.181 schwarze 204: case 'a':
205: outmode = OUTMODE_ALL;
206: break;
1.180 schwarze 207: case 'C':
208: conf_file = optarg;
209: break;
1.183 schwarze 210: case 'c':
1.244 schwarze 211: use_pager = 0;
1.183 schwarze 212: break;
1.180 schwarze 213: case 'f':
214: search.argmode = ARG_WORD;
215: break;
1.190 schwarze 216: case 'h':
1.230 schwarze 217: conf.output.synopsisonly = 1;
1.244 schwarze 218: use_pager = 0;
1.190 schwarze 219: outmode = OUTMODE_ALL;
220: break;
1.173 schwarze 221: case 'I':
1.166 schwarze 222: if (strncmp(optarg, "os=", 3)) {
1.247 schwarze 223: warnx("-I %s: Bad argument", optarg);
1.245 schwarze 224: return (int)MANDOCLEVEL_BADARG;
1.166 schwarze 225: }
226: if (defos) {
1.247 schwarze 227: warnx("-I %s: Duplicate argument", optarg);
1.245 schwarze 228: return (int)MANDOCLEVEL_BADARG;
1.166 schwarze 229: }
230: defos = mandoc_strdup(optarg + 3);
231: break;
1.181 schwarze 232: case 'i':
233: outmode = OUTMODE_INT;
234: break;
1.194 schwarze 235: case 'K':
236: if ( ! koptions(&options, optarg))
1.245 schwarze 237: return (int)MANDOCLEVEL_BADARG;
1.194 schwarze 238: break;
1.180 schwarze 239: case 'k':
240: search.argmode = ARG_EXPR;
241: break;
1.188 schwarze 242: case 'l':
243: search.argmode = ARG_FILE;
244: outmode = OUTMODE_ALL;
245: break;
1.180 schwarze 246: case 'M':
247: defpaths = optarg;
248: break;
1.173 schwarze 249: case 'm':
1.180 schwarze 250: auxpaths = optarg;
1.10 kristaps 251: break;
1.173 schwarze 252: case 'O':
1.180 schwarze 253: search.outkey = optarg;
1.230 schwarze 254: while (optarg != NULL)
255: manconf_output(&conf.output,
256: strsep(&optarg, ","));
1.44 kristaps 257: break;
1.180 schwarze 258: case 'S':
259: search.arch = optarg;
260: break;
261: case 's':
262: search.sec = optarg;
263: break;
1.173 schwarze 264: case 'T':
1.60 kristaps 265: if ( ! toptions(&curp, optarg))
1.245 schwarze 266: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 267: break;
1.173 schwarze 268: case 'W':
1.103 schwarze 269: if ( ! woptions(&curp, optarg))
1.245 schwarze 270: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 271: break;
1.181 schwarze 272: case 'w':
273: outmode = OUTMODE_FLN;
274: break;
1.1 kristaps 275: default:
1.180 schwarze 276: show_usage = 1;
277: break;
1.1 kristaps 278: }
1.180 schwarze 279: }
280:
281: if (show_usage)
282: usage(search.argmode);
283:
1.185 schwarze 284: /* Postprocess options. */
285:
1.181 schwarze 286: if (outmode == OUTMODE_DEF) {
287: switch (search.argmode) {
288: case ARG_FILE:
289: outmode = OUTMODE_ALL;
1.244 schwarze 290: use_pager = 0;
1.181 schwarze 291: break;
292: case ARG_NAME:
293: outmode = OUTMODE_ONE;
294: break;
295: default:
296: outmode = OUTMODE_LST;
297: break;
298: }
299: }
300:
1.246 schwarze 301: if (outmode == OUTMODE_FLN ||
302: outmode == OUTMODE_LST ||
303: !isatty(STDOUT_FILENO))
304: use_pager = 0;
305:
1.255 schwarze 306: #if HAVE_PLEDGE
1.260 schwarze 307: if (!use_pager)
308: if (pledge("stdio rpath flock", NULL) == -1)
309: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.255 schwarze 310: #endif
311:
1.185 schwarze 312: /* Parse arguments. */
313:
1.219 schwarze 314: if (argc > 0) {
315: argc -= optind;
316: argv += optind;
317: }
1.186 schwarze 318: resp = NULL;
1.185 schwarze 319:
1.202 schwarze 320: /*
321: * Quirks for help(1)
322: * and for a man(1) section argument without -s.
323: */
324:
325: if (search.argmode == ARG_NAME) {
1.254 schwarze 326: if (*progname == 'h') {
1.202 schwarze 327: if (argc == 0) {
328: argv = help_argv;
329: argc = 1;
330: }
1.211 schwarze 331: } else if (argc > 1 &&
1.223 kristaps 332: ((uc = (unsigned char *)argv[0]) != NULL) &&
1.207 schwarze 333: ((isdigit(uc[0]) && (uc[1] == '\0' ||
334: (isalpha(uc[1]) && uc[2] == '\0'))) ||
335: (uc[0] == 'n' && uc[1] == '\0'))) {
1.223 kristaps 336: search.sec = (char *)uc;
1.202 schwarze 337: argv++;
338: argc--;
339: }
1.216 schwarze 340: if (search.arch == NULL)
341: search.arch = getenv("MACHINE");
1.223 kristaps 342: #ifdef MACHINE
1.216 schwarze 343: if (search.arch == NULL)
344: search.arch = MACHINE;
1.223 kristaps 345: #endif
1.185 schwarze 346: }
1.182 schwarze 347:
348: rc = MANDOCLEVEL_OK;
1.180 schwarze 349:
350: /* man(1), whatis(1), apropos(1) */
351:
352: if (search.argmode != ARG_FILE) {
353: if (argc == 0)
354: usage(search.argmode);
1.199 schwarze 355:
356: if (search.argmode == ARG_NAME &&
357: outmode == OUTMODE_ONE)
358: search.firstmatch = 1;
1.182 schwarze 359:
360: /* Access the mandoc database. */
361:
1.229 schwarze 362: manconf_parse(&conf, conf_file, defpaths, auxpaths);
1.218 schwarze 363: #if HAVE_SQLITE3
1.180 schwarze 364: mansearch_setup(1);
1.229 schwarze 365: if ( ! mansearch(&search, &conf.manpath,
366: argc, argv, &res, &sz))
1.180 schwarze 367: usage(search.argmode);
1.218 schwarze 368: #else
369: if (search.argmode != ARG_NAME) {
370: fputs("mandoc: database support not compiled in\n",
371: stderr);
1.245 schwarze 372: return (int)MANDOCLEVEL_BADARG;
1.218 schwarze 373: }
374: sz = 0;
375: #endif
1.213 schwarze 376:
1.237 schwarze 377: if (sz == 0) {
378: if (search.argmode == ARG_NAME)
379: fs_search(&search, &conf.manpath,
380: argc, argv, &res, &sz);
381: else
1.247 schwarze 382: warnx("nothing appropriate");
1.237 schwarze 383: }
1.187 schwarze 384:
385: if (sz == 0) {
386: rc = MANDOCLEVEL_BADARG;
387: goto out;
388: }
1.182 schwarze 389:
390: /*
391: * For standard man(1) and -a output mode,
392: * prepare for copying filename pointers
393: * into the program parameter array.
394: */
395:
396: if (outmode == OUTMODE_ONE) {
397: argc = 1;
1.264 schwarze 398: best_prio = 20;
1.186 schwarze 399: } else if (outmode == OUTMODE_ALL)
1.182 schwarze 400: argc = (int)sz;
401:
402: /* Iterate all matching manuals. */
403:
1.213 schwarze 404: resp = res;
1.181 schwarze 405: for (i = 0; i < sz; i++) {
406: if (outmode == OUTMODE_FLN)
407: puts(res[i].file);
1.182 schwarze 408: else if (outmode == OUTMODE_LST)
1.181 schwarze 409: printf("%s - %s\n", res[i].names,
410: res[i].output == NULL ? "" :
411: res[i].output);
1.186 schwarze 412: else if (outmode == OUTMODE_ONE) {
1.182 schwarze 413: /* Search for the best section. */
1.264 schwarze 414: sec = res[i].file;
415: sec += strcspn(sec, "123456789");
416: if (sec[0] == '\0')
1.182 schwarze 417: continue;
1.264 schwarze 418: prio = sec_prios[sec[0] - '1'];
419: if (sec[1] != '/')
420: prio += 10;
1.182 schwarze 421: if (prio >= best_prio)
422: continue;
423: best_prio = prio;
1.186 schwarze 424: resp = res + i;
1.182 schwarze 425: }
1.181 schwarze 426: }
1.182 schwarze 427:
428: /*
429: * For man(1), -a and -i output mode, fall through
430: * to the main mandoc(1) code iterating files
431: * and running the parsers on each of them.
432: */
433:
434: if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
435: goto out;
1.180 schwarze 436: }
437:
438: /* mandoc(1) */
439:
1.255 schwarze 440: #if HAVE_PLEDGE
1.260 schwarze 441: if (use_pager) {
442: if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1)
443: err((int)MANDOCLEVEL_SYSERR, "pledge");
444: } else {
445: if (pledge("stdio rpath", NULL) == -1)
446: err((int)MANDOCLEVEL_SYSERR, "pledge");
447: }
1.255 schwarze 448: #endif
449:
1.209 schwarze 450: if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths))
1.245 schwarze 451: return (int)MANDOCLEVEL_BADARG;
1.241 schwarze 452:
1.249 schwarze 453: mchars_alloc();
454: curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos);
1.154 kristaps 455:
1.165 kristaps 456: /*
457: * Conditionally start up the lookaside buffer before parsing.
458: */
459: if (OUTT_MAN == curp.outtype)
460: mparse_keep(curp.mp);
461:
1.219 schwarze 462: if (argc < 1) {
1.244 schwarze 463: if (use_pager)
464: tag_files = tag_init();
1.227 schwarze 465: parse(&curp, STDIN_FILENO, "<stdin>");
1.212 schwarze 466: }
1.64 kristaps 467:
1.219 schwarze 468: while (argc > 0) {
1.262 schwarze 469: fd = mparse_open(curp.mp, resp != NULL ? resp->file : *argv);
1.212 schwarze 470: if (fd != -1) {
1.244 schwarze 471: if (use_pager) {
472: tag_files = tag_init();
473: use_pager = 0;
474: }
1.212 schwarze 475:
476: if (resp == NULL)
1.227 schwarze 477: parse(&curp, fd, *argv);
1.192 schwarze 478: else if (resp->form & FORM_SRC) {
1.189 schwarze 479: /* For .so only; ignore failure. */
1.229 schwarze 480: chdir(conf.manpath.paths[resp->ipath]);
1.227 schwarze 481: parse(&curp, fd, resp->file);
482: } else
1.230 schwarze 483: passthrough(resp->file, fd,
484: conf.output.synopsisonly);
1.212 schwarze 485:
1.273.2.2 schwarze 486: if (argc > 1 && curp.outtype <= OUTT_UTF8) {
487: if (curp.outdata == NULL)
488: outdata_alloc(&curp);
1.267 schwarze 489: terminal_sepline(curp.outdata);
1.273.2.2 schwarze 490: }
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:
1.273.2.2 schwarze 750: if (curp->outdata == NULL)
751: outdata_alloc(curp);
1.111 kristaps 752:
1.250 schwarze 753: mparse_result(curp->mp, &man, NULL);
754:
755: /* Execute the out device, if it exists. */
756:
757: if (man == NULL)
758: return;
759: if (man->macroset == MACROSET_MDOC) {
1.251 schwarze 760: mdoc_validate(man);
1.111 kristaps 761: switch (curp->outtype) {
1.173 schwarze 762: case OUTT_HTML:
1.250 schwarze 763: html_mdoc(curp->outdata, man);
1.111 kristaps 764: break;
1.173 schwarze 765: case OUTT_TREE:
1.250 schwarze 766: tree_mdoc(curp->outdata, man);
1.111 kristaps 767: break;
1.173 schwarze 768: case OUTT_MAN:
1.250 schwarze 769: man_mdoc(curp->outdata, man);
1.164 schwarze 770: break;
1.173 schwarze 771: case OUTT_PDF:
772: case OUTT_ASCII:
773: case OUTT_UTF8:
774: case OUTT_LOCALE:
775: case OUTT_PS:
1.250 schwarze 776: terminal_mdoc(curp->outdata, man);
777: break;
778: default:
779: break;
780: }
781: }
782: if (man->macroset == MACROSET_MAN) {
1.253 schwarze 783: man_validate(man);
1.250 schwarze 784: switch (curp->outtype) {
785: case OUTT_HTML:
786: html_man(curp->outdata, man);
787: break;
788: case OUTT_TREE:
789: tree_man(curp->outdata, man);
790: break;
791: case OUTT_MAN:
792: man_man(curp->outdata, man);
793: break;
794: case OUTT_PDF:
795: case OUTT_ASCII:
796: case OUTT_UTF8:
797: case OUTT_LOCALE:
798: case OUTT_PS:
799: terminal_man(curp->outdata, man);
1.111 kristaps 800: break;
801: default:
802: break;
803: }
804: }
1.273.2.3! schwarze 805: mparse_updaterc(curp->mp, &rc);
1.186 schwarze 806: }
807:
1.227 schwarze 808: static void
1.273.2.2 schwarze 809: outdata_alloc(struct curparse *curp)
810: {
811: switch (curp->outtype) {
812: case OUTT_HTML:
813: curp->outdata = html_alloc(curp->outopts);
814: break;
815: case OUTT_UTF8:
816: curp->outdata = utf8_alloc(curp->outopts);
817: break;
818: case OUTT_LOCALE:
819: curp->outdata = locale_alloc(curp->outopts);
820: break;
821: case OUTT_ASCII:
822: curp->outdata = ascii_alloc(curp->outopts);
823: break;
824: case OUTT_PDF:
825: curp->outdata = pdf_alloc(curp->outopts);
826: break;
827: case OUTT_PS:
828: curp->outdata = ps_alloc(curp->outopts);
829: break;
830: default:
831: break;
832: }
833: }
834:
835: static void
1.197 schwarze 836: passthrough(const char *file, int fd, int synopsis_only)
1.186 schwarze 837: {
1.197 schwarze 838: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
839: const char synr[] = "SYNOPSIS";
840:
841: FILE *stream;
1.186 schwarze 842: const char *syscall;
1.257 schwarze 843: char *line, *cp;
844: size_t linesz;
1.273.2.2 schwarze 845: ssize_t len, written;
1.197 schwarze 846: int print;
1.210 schwarze 847:
1.257 schwarze 848: line = NULL;
849: linesz = 0;
1.197 schwarze 850:
1.273.2.2 schwarze 851: if (fflush(stdout) == EOF) {
852: syscall = "fflush";
853: goto fail;
854: }
855:
1.197 schwarze 856: if ((stream = fdopen(fd, "r")) == NULL) {
857: close(fd);
858: syscall = "fdopen";
859: goto fail;
860: }
1.186 schwarze 861:
1.197 schwarze 862: print = 0;
1.273.2.2 schwarze 863: while ((len = getline(&line, &linesz, stream)) != -1) {
1.257 schwarze 864: cp = line;
1.197 schwarze 865: if (synopsis_only) {
866: if (print) {
1.257 schwarze 867: if ( ! isspace((unsigned char)*cp))
1.197 schwarze 868: goto done;
1.273.2.2 schwarze 869: while (isspace((unsigned char)*cp)) {
1.257 schwarze 870: cp++;
1.273.2.2 schwarze 871: len--;
872: }
1.197 schwarze 873: } else {
1.257 schwarze 874: if (strcmp(cp, synb) == 0 ||
875: strcmp(cp, synr) == 0)
1.197 schwarze 876: print = 1;
877: continue;
878: }
879: }
1.273.2.2 schwarze 880: for (; len > 0; len -= written) {
881: if ((written = write(STDOUT_FILENO, cp, len)) != -1)
882: continue;
1.257 schwarze 883: fclose(stream);
1.273.2.2 schwarze 884: syscall = "write";
1.257 schwarze 885: goto fail;
886: }
1.197 schwarze 887: }
1.186 schwarze 888:
1.197 schwarze 889: if (ferror(stream)) {
890: fclose(stream);
1.257 schwarze 891: syscall = "getline";
1.197 schwarze 892: goto fail;
893: }
1.193 schwarze 894:
1.197 schwarze 895: done:
1.257 schwarze 896: free(line);
1.197 schwarze 897: fclose(stream);
1.227 schwarze 898: return;
1.186 schwarze 899:
900: fail:
1.257 schwarze 901: free(line);
1.247 schwarze 902: warn("%s: SYSERR: %s", file, syscall);
1.227 schwarze 903: if (rc < MANDOCLEVEL_SYSERR)
904: rc = MANDOCLEVEL_SYSERR;
1.194 schwarze 905: }
906:
907: static int
908: koptions(int *options, char *arg)
909: {
910:
911: if ( ! strcmp(arg, "utf-8")) {
912: *options |= MPARSE_UTF8;
913: *options &= ~MPARSE_LATIN1;
914: } else if ( ! strcmp(arg, "iso-8859-1")) {
915: *options |= MPARSE_LATIN1;
916: *options &= ~MPARSE_UTF8;
917: } else if ( ! strcmp(arg, "us-ascii")) {
918: *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
919: } else {
1.247 schwarze 920: warnx("-K %s: Bad argument", arg);
1.245 schwarze 921: return 0;
1.194 schwarze 922: }
1.245 schwarze 923: return 1;
1.10 kristaps 924: }
925:
926: static int
1.170 schwarze 927: moptions(int *options, char *arg)
1.10 kristaps 928: {
929:
1.180 schwarze 930: if (arg == NULL)
931: /* nothing to do */;
932: else if (0 == strcmp(arg, "doc"))
1.170 schwarze 933: *options |= MPARSE_MDOC;
1.19 kristaps 934: else if (0 == strcmp(arg, "andoc"))
1.170 schwarze 935: /* nothing to do */;
1.17 kristaps 936: else if (0 == strcmp(arg, "an"))
1.170 schwarze 937: *options |= MPARSE_MAN;
1.10 kristaps 938: else {
1.247 schwarze 939: warnx("-m %s: Bad argument", arg);
1.245 schwarze 940: return 0;
1.10 kristaps 941: }
942:
1.245 schwarze 943: return 1;
1.1 kristaps 944: }
945:
946: static int
1.60 kristaps 947: toptions(struct curparse *curp, char *arg)
1.1 kristaps 948: {
949:
950: if (0 == strcmp(arg, "ascii"))
1.60 kristaps 951: curp->outtype = OUTT_ASCII;
952: else if (0 == strcmp(arg, "lint")) {
953: curp->outtype = OUTT_LINT;
1.103 schwarze 954: curp->wlevel = MANDOCLEVEL_WARNING;
1.154 kristaps 955: } else if (0 == strcmp(arg, "tree"))
1.60 kristaps 956: curp->outtype = OUTT_TREE;
1.164 schwarze 957: else if (0 == strcmp(arg, "man"))
958: curp->outtype = OUTT_MAN;
1.43 kristaps 959: else if (0 == strcmp(arg, "html"))
1.60 kristaps 960: curp->outtype = OUTT_HTML;
1.163 kristaps 961: else if (0 == strcmp(arg, "utf8"))
962: curp->outtype = OUTT_UTF8;
1.162 kristaps 963: else if (0 == strcmp(arg, "locale"))
964: curp->outtype = OUTT_LOCALE;
1.59 kristaps 965: else if (0 == strcmp(arg, "xhtml"))
1.195 schwarze 966: curp->outtype = OUTT_HTML;
1.85 kristaps 967: else if (0 == strcmp(arg, "ps"))
968: curp->outtype = OUTT_PS;
1.100 kristaps 969: else if (0 == strcmp(arg, "pdf"))
970: curp->outtype = OUTT_PDF;
1.1 kristaps 971: else {
1.247 schwarze 972: warnx("-T %s: Bad argument", arg);
1.245 schwarze 973: return 0;
1.1 kristaps 974: }
975:
1.245 schwarze 976: return 1;
1.1 kristaps 977: }
978:
979: static int
1.103 schwarze 980: woptions(struct curparse *curp, char *arg)
1.1 kristaps 981: {
1.34 kristaps 982: char *v, *o;
1.217 schwarze 983: const char *toks[7];
1.1 kristaps 984:
1.103 schwarze 985: toks[0] = "stop";
986: toks[1] = "all";
987: toks[2] = "warning";
988: toks[3] = "error";
1.217 schwarze 989: toks[4] = "unsupp";
990: toks[5] = "fatal";
991: toks[6] = NULL;
1.1 kristaps 992:
1.34 kristaps 993: while (*arg) {
994: o = arg;
1.272 schwarze 995: switch (getsubopt(&arg, (char * const *)toks, &v)) {
1.173 schwarze 996: case 0:
1.103 schwarze 997: curp->wstop = 1;
1.1 kristaps 998: break;
1.173 schwarze 999: case 1:
1000: case 2:
1.103 schwarze 1001: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 1002: break;
1.173 schwarze 1003: case 3:
1.103 schwarze 1004: curp->wlevel = MANDOCLEVEL_ERROR;
1.24 kristaps 1005: break;
1.173 schwarze 1006: case 4:
1.217 schwarze 1007: curp->wlevel = MANDOCLEVEL_UNSUPP;
1008: break;
1009: case 5:
1.215 schwarze 1010: curp->wlevel = MANDOCLEVEL_BADARG;
1.50 kristaps 1011: break;
1.1 kristaps 1012: default:
1.247 schwarze 1013: warnx("-W %s: Bad argument", o);
1.245 schwarze 1014: return 0;
1.1 kristaps 1015: }
1.34 kristaps 1016: }
1.1 kristaps 1017:
1.245 schwarze 1018: return 1;
1.1 kristaps 1019: }
1020:
1.153 kristaps 1021: static void
1.173 schwarze 1022: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.155 kristaps 1023: const char *file, int line, int col, const char *msg)
1.71 kristaps 1024: {
1.177 schwarze 1025: const char *mparse_msg;
1.103 schwarze 1026:
1.273.2.1 schwarze 1027: fprintf(stderr, "%s: %s:", getprogname(),
1028: file == NULL ? "<stdin>" : file);
1.175 schwarze 1029:
1030: if (line)
1031: fprintf(stderr, "%d:%d:", line, col + 1);
1032:
1.177 schwarze 1033: fprintf(stderr, " %s", mparse_strlevel(lvl));
1034:
1035: if (NULL != (mparse_msg = mparse_strerror(t)))
1036: fprintf(stderr, ": %s", mparse_msg);
1.154 kristaps 1037:
1.73 kristaps 1038: if (msg)
1039: fprintf(stderr, ": %s", msg);
1.154 kristaps 1040:
1.73 kristaps 1041: fputc('\n', stderr);
1.183 schwarze 1042: }
1043:
1.225 schwarze 1044: static pid_t
1.244 schwarze 1045: spawn_pager(struct tag_files *tag_files)
1.183 schwarze 1046: {
1.265 schwarze 1047: const struct timespec timeout = { 0, 100000000 }; /* 0.1s */
1.184 schwarze 1048: #define MAX_PAGER_ARGS 16
1049: char *argv[MAX_PAGER_ARGS];
1050: const char *pager;
1051: char *cp;
1.239 schwarze 1052: size_t cmdlen;
1.184 schwarze 1053: int argc;
1.225 schwarze 1054: pid_t pager_pid;
1.183 schwarze 1055:
1.239 schwarze 1056: pager = getenv("MANPAGER");
1057: if (pager == NULL || *pager == '\0')
1058: pager = getenv("PAGER");
1059: if (pager == NULL || *pager == '\0')
1060: pager = "more -s";
1061: cp = mandoc_strdup(pager);
1062:
1063: /*
1064: * Parse the pager command into words.
1065: * Intentionally do not do anything fancy here.
1066: */
1067:
1068: argc = 0;
1069: while (argc + 4 < MAX_PAGER_ARGS) {
1070: argv[argc++] = cp;
1071: cp = strchr(cp, ' ');
1072: if (cp == NULL)
1073: break;
1074: *cp++ = '\0';
1075: while (*cp == ' ')
1076: cp++;
1077: if (*cp == '\0')
1078: break;
1079: }
1080:
1.268 schwarze 1081: /* For less(1), use the tag file. */
1.239 schwarze 1082:
1.244 schwarze 1083: if ((cmdlen = strlen(argv[0])) >= 4) {
1.239 schwarze 1084: cp = argv[0] + cmdlen - 4;
1.268 schwarze 1085: if (strcmp(cp, "less") == 0) {
1.244 schwarze 1086: argv[argc++] = mandoc_strdup("-T");
1087: argv[argc++] = tag_files->tfn;
1088: }
1.239 schwarze 1089: }
1.244 schwarze 1090: argv[argc++] = tag_files->ofn;
1.239 schwarze 1091: argv[argc] = NULL;
1092:
1.225 schwarze 1093: switch (pager_pid = fork()) {
1.183 schwarze 1094: case -1:
1.247 schwarze 1095: err((int)MANDOCLEVEL_SYSERR, "fork");
1.183 schwarze 1096: case 0:
1.224 schwarze 1097: break;
1098: default:
1.258 schwarze 1099: (void)setpgid(pager_pid, 0);
1.259 schwarze 1100: (void)tcsetpgrp(STDIN_FILENO, pager_pid);
1.255 schwarze 1101: #if HAVE_PLEDGE
1.258 schwarze 1102: if (pledge("stdio rpath tmppath tty proc", NULL) == -1)
1.255 schwarze 1103: err((int)MANDOCLEVEL_SYSERR, "pledge");
1104: #endif
1.259 schwarze 1105: tag_files->pager_pid = pager_pid;
1.245 schwarze 1106: return pager_pid;
1.184 schwarze 1107: }
1108:
1.224 schwarze 1109: /* The child process becomes the pager. */
1.184 schwarze 1110:
1.247 schwarze 1111: if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
1112: err((int)MANDOCLEVEL_SYSERR, "pager stdout");
1.244 schwarze 1113: close(tag_files->ofd);
1114: close(tag_files->tfd);
1.265 schwarze 1115:
1116: /* Do not start the pager before controlling the terminal. */
1117:
1118: while (tcgetpgrp(STDIN_FILENO) != getpid())
1119: nanosleep(&timeout, NULL);
1120:
1.184 schwarze 1121: execvp(argv[0], argv);
1.247 schwarze 1122: err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
1.71 kristaps 1123: }
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