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