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