Annotation of mandoc/main.c, Revision 1.268
1.268 ! schwarze 1: /* $Id: main.c,v 1.267 2016/07/08 22:29:05 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>
1.265 schwarze 38: #include <time.h>
1.1 kristaps 39: #include <unistd.h>
40:
1.231 schwarze 41: #include "mandoc_aux.h"
1.71 kristaps 42: #include "mandoc.h"
1.231 schwarze 43: #include "roff.h"
1.1 kristaps 44: #include "mdoc.h"
1.10 kristaps 45: #include "man.h"
1.239 schwarze 46: #include "tag.h"
1.231 schwarze 47: #include "main.h"
1.229 schwarze 48: #include "manconf.h"
1.180 schwarze 49: #include "mansearch.h"
1.101 joerg 50:
1.55 kristaps 51: #if !defined(__GNUC__) || (__GNUC__ < 2)
1.56 kristaps 52: # if !defined(lint)
53: # define __attribute__(x)
54: # endif
1.55 kristaps 55: #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */
1.16 kristaps 56:
1.181 schwarze 57: enum outmode {
58: OUTMODE_DEF = 0,
59: OUTMODE_FLN,
60: OUTMODE_LST,
61: OUTMODE_ALL,
62: OUTMODE_INT,
63: OUTMODE_ONE
64: };
65:
1.19 kristaps 66: enum outt {
1.154 kristaps 67: OUTT_ASCII = 0, /* -Tascii */
1.162 kristaps 68: OUTT_LOCALE, /* -Tlocale */
1.163 kristaps 69: OUTT_UTF8, /* -Tutf8 */
1.154 kristaps 70: OUTT_TREE, /* -Ttree */
1.164 schwarze 71: OUTT_MAN, /* -Tman */
1.154 kristaps 72: OUTT_HTML, /* -Thtml */
73: OUTT_LINT, /* -Tlint */
74: OUTT_PS, /* -Tps */
75: OUTT_PDF /* -Tpdf */
1.19 kristaps 76: };
77:
1.5 kristaps 78: struct curparse {
1.154 kristaps 79: struct mparse *mp;
1.148 kristaps 80: enum mandoclevel wlevel; /* ignore messages below this */
81: int wstop; /* stop after a file with a warning */
1.173 schwarze 82: enum outt outtype; /* which output to use */
1.79 kristaps 83: void *outdata; /* data for output */
1.230 schwarze 84: struct manoutput *outopts; /* output options */
1.79 kristaps 85: };
86:
1.213 schwarze 87: static int fs_lookup(const struct manpaths *,
88: size_t ipath, const char *,
89: const char *, const char *,
90: struct manpage **, size_t *);
91: static void fs_search(const struct mansearch *,
92: const struct manpaths *, int, char**,
93: struct manpage **, size_t *);
1.194 schwarze 94: static int koptions(int *, char *);
1.203 schwarze 95: #if HAVE_SQLITE3
96: int mandocdb(int, char**);
97: #endif
1.170 schwarze 98: static int moptions(int *, char *);
1.155 kristaps 99: static void mmsg(enum mandocerr, enum mandoclevel,
100: const char *, int, int, const char *);
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");
160: #endif
161:
1.180 schwarze 162: /* Search options. */
163:
1.229 schwarze 164: memset(&conf, 0, sizeof(conf));
1.205 schwarze 165: conf_file = defpaths = NULL;
166: auxpaths = NULL;
1.180 schwarze 167:
168: memset(&search, 0, sizeof(struct mansearch));
169: search.outkey = "Nd";
170:
1.254 schwarze 171: if (strcmp(progname, BINM_MAN) == 0)
1.180 schwarze 172: search.argmode = ARG_NAME;
1.254 schwarze 173: else if (strcmp(progname, BINM_APROPOS) == 0)
1.180 schwarze 174: search.argmode = ARG_EXPR;
1.254 schwarze 175: else if (strcmp(progname, BINM_WHATIS) == 0)
1.180 schwarze 176: search.argmode = ARG_WORD;
1.254 schwarze 177: else if (strncmp(progname, "help", 4) == 0)
1.202 schwarze 178: search.argmode = ARG_NAME;
1.180 schwarze 179: else
180: search.argmode = ARG_FILE;
181:
182: /* Parser and formatter options. */
1.54 kristaps 183:
1.51 kristaps 184: memset(&curp, 0, sizeof(struct curparse));
1.201 schwarze 185: curp.outtype = OUTT_LOCALE;
1.215 schwarze 186: curp.wlevel = MANDOCLEVEL_BADARG;
1.230 schwarze 187: curp.outopts = &conf.output;
1.194 schwarze 188: options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.166 schwarze 189: defos = NULL;
1.19 kristaps 190:
1.244 schwarze 191: use_pager = 1;
192: tag_files = NULL;
1.180 schwarze 193: show_usage = 0;
1.181 schwarze 194: outmode = OUTMODE_DEF;
1.183 schwarze 195:
1.194 schwarze 196: while (-1 != (c = getopt(argc, argv,
197: "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
1.1 kristaps 198: switch (c) {
1.181 schwarze 199: case 'a':
200: outmode = OUTMODE_ALL;
201: break;
1.180 schwarze 202: case 'C':
203: conf_file = optarg;
204: break;
1.183 schwarze 205: case 'c':
1.244 schwarze 206: use_pager = 0;
1.183 schwarze 207: break;
1.180 schwarze 208: case 'f':
209: search.argmode = ARG_WORD;
210: break;
1.190 schwarze 211: case 'h':
1.230 schwarze 212: conf.output.synopsisonly = 1;
1.244 schwarze 213: use_pager = 0;
1.190 schwarze 214: outmode = OUTMODE_ALL;
215: break;
1.173 schwarze 216: case 'I':
1.166 schwarze 217: if (strncmp(optarg, "os=", 3)) {
1.247 schwarze 218: warnx("-I %s: Bad argument", optarg);
1.245 schwarze 219: return (int)MANDOCLEVEL_BADARG;
1.166 schwarze 220: }
221: if (defos) {
1.247 schwarze 222: warnx("-I %s: Duplicate argument", optarg);
1.245 schwarze 223: return (int)MANDOCLEVEL_BADARG;
1.166 schwarze 224: }
225: defos = mandoc_strdup(optarg + 3);
226: break;
1.181 schwarze 227: case 'i':
228: outmode = OUTMODE_INT;
229: break;
1.194 schwarze 230: case 'K':
231: if ( ! koptions(&options, optarg))
1.245 schwarze 232: return (int)MANDOCLEVEL_BADARG;
1.194 schwarze 233: break;
1.180 schwarze 234: case 'k':
235: search.argmode = ARG_EXPR;
236: break;
1.188 schwarze 237: case 'l':
238: search.argmode = ARG_FILE;
239: outmode = OUTMODE_ALL;
240: break;
1.180 schwarze 241: case 'M':
242: defpaths = optarg;
243: break;
1.173 schwarze 244: case 'm':
1.180 schwarze 245: auxpaths = optarg;
1.10 kristaps 246: break;
1.173 schwarze 247: case 'O':
1.180 schwarze 248: search.outkey = optarg;
1.230 schwarze 249: while (optarg != NULL)
250: manconf_output(&conf.output,
251: strsep(&optarg, ","));
1.44 kristaps 252: break;
1.180 schwarze 253: case 'S':
254: search.arch = optarg;
255: break;
256: case 's':
257: search.sec = optarg;
258: break;
1.173 schwarze 259: case 'T':
1.60 kristaps 260: if ( ! toptions(&curp, optarg))
1.245 schwarze 261: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 262: break;
1.173 schwarze 263: case 'W':
1.103 schwarze 264: if ( ! woptions(&curp, optarg))
1.245 schwarze 265: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 266: break;
1.181 schwarze 267: case 'w':
268: outmode = OUTMODE_FLN;
269: break;
1.1 kristaps 270: default:
1.180 schwarze 271: show_usage = 1;
272: break;
1.1 kristaps 273: }
1.180 schwarze 274: }
275:
276: if (show_usage)
277: usage(search.argmode);
278:
1.185 schwarze 279: /* Postprocess options. */
280:
1.181 schwarze 281: if (outmode == OUTMODE_DEF) {
282: switch (search.argmode) {
283: case ARG_FILE:
284: outmode = OUTMODE_ALL;
1.244 schwarze 285: use_pager = 0;
1.181 schwarze 286: break;
287: case ARG_NAME:
288: outmode = OUTMODE_ONE;
289: break;
290: default:
291: outmode = OUTMODE_LST;
292: break;
293: }
294: }
295:
1.246 schwarze 296: if (outmode == OUTMODE_FLN ||
297: outmode == OUTMODE_LST ||
298: !isatty(STDOUT_FILENO))
299: use_pager = 0;
300:
1.255 schwarze 301: #if HAVE_PLEDGE
1.260 schwarze 302: if (!use_pager)
303: if (pledge("stdio rpath flock", NULL) == -1)
304: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.255 schwarze 305: #endif
306:
1.185 schwarze 307: /* Parse arguments. */
308:
1.219 schwarze 309: if (argc > 0) {
310: argc -= optind;
311: argv += optind;
312: }
1.186 schwarze 313: resp = NULL;
1.185 schwarze 314:
1.202 schwarze 315: /*
316: * Quirks for help(1)
317: * and for a man(1) section argument without -s.
318: */
319:
320: if (search.argmode == ARG_NAME) {
1.254 schwarze 321: if (*progname == 'h') {
1.202 schwarze 322: if (argc == 0) {
323: argv = help_argv;
324: argc = 1;
325: }
1.211 schwarze 326: } else if (argc > 1 &&
1.223 kristaps 327: ((uc = (unsigned char *)argv[0]) != NULL) &&
1.207 schwarze 328: ((isdigit(uc[0]) && (uc[1] == '\0' ||
329: (isalpha(uc[1]) && uc[2] == '\0'))) ||
330: (uc[0] == 'n' && uc[1] == '\0'))) {
1.223 kristaps 331: search.sec = (char *)uc;
1.202 schwarze 332: argv++;
333: argc--;
334: }
1.216 schwarze 335: if (search.arch == NULL)
336: search.arch = getenv("MACHINE");
1.223 kristaps 337: #ifdef MACHINE
1.216 schwarze 338: if (search.arch == NULL)
339: search.arch = MACHINE;
1.223 kristaps 340: #endif
1.185 schwarze 341: }
1.182 schwarze 342:
343: rc = MANDOCLEVEL_OK;
1.180 schwarze 344:
345: /* man(1), whatis(1), apropos(1) */
346:
347: if (search.argmode != ARG_FILE) {
348: if (argc == 0)
349: usage(search.argmode);
1.199 schwarze 350:
351: if (search.argmode == ARG_NAME &&
352: outmode == OUTMODE_ONE)
353: search.firstmatch = 1;
1.182 schwarze 354:
355: /* Access the mandoc database. */
356:
1.229 schwarze 357: manconf_parse(&conf, conf_file, defpaths, auxpaths);
1.218 schwarze 358: #if HAVE_SQLITE3
1.180 schwarze 359: mansearch_setup(1);
1.229 schwarze 360: if ( ! mansearch(&search, &conf.manpath,
361: argc, argv, &res, &sz))
1.180 schwarze 362: usage(search.argmode);
1.218 schwarze 363: #else
364: if (search.argmode != ARG_NAME) {
365: fputs("mandoc: database support not compiled in\n",
366: stderr);
1.245 schwarze 367: return (int)MANDOCLEVEL_BADARG;
1.218 schwarze 368: }
369: sz = 0;
370: #endif
1.213 schwarze 371:
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:
481: if (argc > 1 && curp.outtype <= OUTT_UTF8)
1.267 schwarze 482: terminal_sepline(curp.outdata);
1.262 schwarze 483: } else if (rc < MANDOCLEVEL_ERROR)
484: rc = MANDOCLEVEL_ERROR;
1.192 schwarze 485:
1.154 kristaps 486: if (MANDOCLEVEL_OK != rc && curp.wstop)
1.64 kristaps 487: break;
1.210 schwarze 488:
1.212 schwarze 489: if (resp != NULL)
490: resp++;
491: else
492: argv++;
493: if (--argc)
494: mparse_reset(curp.mp);
1.1 kristaps 495: }
496:
1.252 schwarze 497: if (curp.outdata != NULL) {
498: switch (curp.outtype) {
499: case OUTT_HTML:
500: html_free(curp.outdata);
501: break;
502: case OUTT_UTF8:
503: case OUTT_LOCALE:
504: case OUTT_ASCII:
505: ascii_free(curp.outdata);
506: break;
507: case OUTT_PDF:
508: case OUTT_PS:
509: pspdf_free(curp.outdata);
510: break;
511: default:
512: break;
513: }
1.250 schwarze 514: }
1.195 schwarze 515: mparse_free(curp.mp);
1.249 schwarze 516: mchars_free();
1.182 schwarze 517:
518: out:
519: if (search.argmode != ARG_FILE) {
1.229 schwarze 520: manconf_free(&conf);
1.218 schwarze 521: #if HAVE_SQLITE3
1.182 schwarze 522: mansearch_free(res, sz);
523: mansearch_setup(0);
1.218 schwarze 524: #endif
1.182 schwarze 525: }
526:
1.166 schwarze 527: free(defos);
1.1 kristaps 528:
1.224 schwarze 529: /*
1.244 schwarze 530: * When using a pager, finish writing both temporary files,
531: * fork it, wait for the user to close it, and clean up.
1.224 schwarze 532: */
533:
1.244 schwarze 534: if (tag_files != NULL) {
1.225 schwarze 535: fclose(stdout);
1.239 schwarze 536: tag_write();
1.259 schwarze 537: man_pgid = getpgid(0);
538: tag_files->tcpgid = man_pgid == getpid() ?
539: getpgid(getppid()) : man_pgid;
540: pager_pid = 0;
541: signum = SIGSTOP;
1.258 schwarze 542: for (;;) {
1.259 schwarze 543:
544: /* Stop here until moved to the foreground. */
545:
546: tc_pgid = tcgetpgrp(STDIN_FILENO);
547: if (tc_pgid != man_pgid) {
548: if (tc_pgid == pager_pid) {
549: (void)tcsetpgrp(STDIN_FILENO,
550: man_pgid);
551: if (signum == SIGTTIN)
552: continue;
553: } else
554: tag_files->tcpgid = tc_pgid;
555: kill(0, signum);
556: continue;
557: }
558:
559: /* Once in the foreground, activate the pager. */
560:
561: if (pager_pid) {
562: (void)tcsetpgrp(STDIN_FILENO, pager_pid);
563: kill(pager_pid, SIGCONT);
564: } else
565: pager_pid = spawn_pager(tag_files);
566:
567: /* Wait for the pager to stop or exit. */
568:
569: while ((pid = waitpid(pager_pid, &status,
570: WUNTRACED)) == -1 && errno == EINTR)
571: continue;
572:
573: if (pid == -1) {
1.258 schwarze 574: warn("wait");
575: rc = MANDOCLEVEL_SYSERR;
576: break;
577: }
578: if (!WIFSTOPPED(status))
579: break;
580:
1.259 schwarze 581: signum = WSTOPSIG(status);
1.258 schwarze 582: }
1.239 schwarze 583: tag_unlink();
1.225 schwarze 584: }
1.224 schwarze 585:
1.245 schwarze 586: return (int)rc;
1.1 kristaps 587: }
588:
1.55 kristaps 589: static void
1.180 schwarze 590: usage(enum argmode argmode)
1.1 kristaps 591: {
592:
1.180 schwarze 593: switch (argmode) {
594: case ARG_FILE:
1.228 schwarze 595: fputs("usage: mandoc [-acfhkl] [-I os=name] "
596: "[-K encoding] [-mformat] [-O option]\n"
597: "\t [-T output] [-W level] [file ...]\n", stderr);
1.180 schwarze 598: break;
599: case ARG_NAME:
1.221 schwarze 600: fputs("usage: man [-acfhklw] [-C file] [-I os=name] "
1.208 schwarze 601: "[-K encoding] [-M path] [-m path]\n"
602: "\t [-O option=value] [-S subsection] [-s section] "
603: "[-T output] [-W level]\n"
1.180 schwarze 604: "\t [section] name ...\n", stderr);
605: break;
606: case ARG_WORD:
1.221 schwarze 607: fputs("usage: whatis [-acfhklw] [-C file] "
1.188 schwarze 608: "[-M path] [-m path] [-O outkey] [-S arch]\n"
609: "\t [-s section] name ...\n", stderr);
1.180 schwarze 610: break;
611: case ARG_EXPR:
1.221 schwarze 612: fputs("usage: apropos [-acfhklw] [-C file] "
1.188 schwarze 613: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.180 schwarze 614: "\t [-s section] expression ...\n", stderr);
615: break;
616: }
1.105 kristaps 617: exit((int)MANDOCLEVEL_BADARG);
1.68 joerg 618: }
1.213 schwarze 619:
620: static int
621: fs_lookup(const struct manpaths *paths, size_t ipath,
622: const char *sec, const char *arch, const char *name,
623: struct manpage **res, size_t *ressz)
624: {
1.222 schwarze 625: glob_t globinfo;
1.213 schwarze 626: struct manpage *page;
627: char *file;
1.222 schwarze 628: int form, globres;
1.213 schwarze 629:
1.222 schwarze 630: form = FORM_SRC;
1.213 schwarze 631: mandoc_asprintf(&file, "%s/man%s/%s.%s",
632: paths->paths[ipath], sec, name, sec);
1.222 schwarze 633: if (access(file, R_OK) != -1)
1.213 schwarze 634: goto found;
635: free(file);
636:
637: mandoc_asprintf(&file, "%s/cat%s/%s.0",
638: paths->paths[ipath], sec, name);
639: if (access(file, R_OK) != -1) {
640: form = FORM_CAT;
641: goto found;
642: }
643: free(file);
644:
645: if (arch != NULL) {
646: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
647: paths->paths[ipath], sec, arch, name, sec);
1.222 schwarze 648: if (access(file, R_OK) != -1)
1.213 schwarze 649: goto found;
650: free(file);
651: }
1.222 schwarze 652:
1.240 schwarze 653: mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",
1.222 schwarze 654: paths->paths[ipath], sec, name);
655: globres = glob(file, 0, NULL, &globinfo);
656: if (globres != 0 && globres != GLOB_NOMATCH)
1.247 schwarze 657: warn("%s: glob", file);
1.222 schwarze 658: free(file);
659: if (globres == 0)
660: file = mandoc_strdup(*globinfo.gl_pathv);
661: globfree(&globinfo);
662: if (globres != 0)
1.245 schwarze 663: return 0;
1.213 schwarze 664:
665: found:
1.218 schwarze 666: #if HAVE_SQLITE3
1.266 schwarze 667: warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
668: name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
1.218 schwarze 669: #endif
1.213 schwarze 670: *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
671: page = *res + (*ressz - 1);
672: page->file = file;
673: page->names = NULL;
674: page->output = NULL;
675: page->ipath = ipath;
676: page->bits = NAME_FILE & NAME_MASK;
677: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
678: page->form = form;
1.245 schwarze 679: return 1;
1.213 schwarze 680: }
681:
682: static void
683: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
684: int argc, char **argv, struct manpage **res, size_t *ressz)
685: {
686: const char *const sections[] =
1.264 schwarze 687: {"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"};
1.213 schwarze 688: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
689:
690: size_t ipath, isec, lastsz;
691:
692: assert(cfg->argmode == ARG_NAME);
693:
694: *res = NULL;
695: *ressz = lastsz = 0;
696: while (argc) {
697: for (ipath = 0; ipath < paths->sz; ipath++) {
698: if (cfg->sec != NULL) {
699: if (fs_lookup(paths, ipath, cfg->sec,
700: cfg->arch, *argv, res, ressz) &&
701: cfg->firstmatch)
702: return;
703: } else for (isec = 0; isec < nsec; isec++)
704: if (fs_lookup(paths, ipath, sections[isec],
705: cfg->arch, *argv, res, ressz) &&
706: cfg->firstmatch)
707: return;
708: }
709: if (*ressz == lastsz)
1.247 schwarze 710: warnx("No entry for %s in the manual.", *argv);
1.213 schwarze 711: lastsz = *ressz;
712: argv++;
713: argc--;
714: }
715: }
1.68 joerg 716:
1.64 kristaps 717: static void
1.227 schwarze 718: parse(struct curparse *curp, int fd, const char *file)
1.1 kristaps 719: {
1.227 schwarze 720: enum mandoclevel rctmp;
1.234 schwarze 721: struct roff_man *man;
1.112 kristaps 722:
1.154 kristaps 723: /* Begin by parsing the file itself. */
1.112 kristaps 724:
1.154 kristaps 725: assert(file);
1.263 schwarze 726: assert(fd >= 0);
1.112 kristaps 727:
1.227 schwarze 728: rctmp = mparse_readfd(curp->mp, fd, file);
1.261 schwarze 729: if (fd != STDIN_FILENO)
730: close(fd);
1.227 schwarze 731: if (rc < rctmp)
732: rc = rctmp;
1.112 kristaps 733:
1.1 kristaps 734: /*
1.154 kristaps 735: * With -Wstop and warnings or errors of at least the requested
736: * level, do not produce output.
1.1 kristaps 737: */
738:
1.227 schwarze 739: if (rctmp != MANDOCLEVEL_OK && curp->wstop)
740: return;
1.111 kristaps 741:
742: /* If unset, allocate output dev now (if applicable). */
743:
1.250 schwarze 744: if (curp->outdata == NULL) {
1.111 kristaps 745: switch (curp->outtype) {
1.173 schwarze 746: case OUTT_HTML:
1.249 schwarze 747: curp->outdata = html_alloc(curp->outopts);
1.162 kristaps 748: break;
1.173 schwarze 749: case OUTT_UTF8:
1.249 schwarze 750: curp->outdata = utf8_alloc(curp->outopts);
1.163 kristaps 751: break;
1.173 schwarze 752: case OUTT_LOCALE:
1.249 schwarze 753: curp->outdata = locale_alloc(curp->outopts);
1.111 kristaps 754: break;
1.173 schwarze 755: case OUTT_ASCII:
1.249 schwarze 756: curp->outdata = ascii_alloc(curp->outopts);
1.111 kristaps 757: break;
1.173 schwarze 758: case OUTT_PDF:
1.249 schwarze 759: curp->outdata = pdf_alloc(curp->outopts);
1.111 kristaps 760: break;
1.173 schwarze 761: case OUTT_PS:
1.249 schwarze 762: curp->outdata = ps_alloc(curp->outopts);
1.111 kristaps 763: break;
764: default:
765: break;
766: }
1.250 schwarze 767: }
1.111 kristaps 768:
1.250 schwarze 769: mparse_result(curp->mp, &man, NULL);
770:
771: /* Execute the out device, if it exists. */
772:
773: if (man == NULL)
774: return;
775: if (man->macroset == MACROSET_MDOC) {
1.251 schwarze 776: mdoc_validate(man);
1.111 kristaps 777: switch (curp->outtype) {
1.173 schwarze 778: case OUTT_HTML:
1.250 schwarze 779: html_mdoc(curp->outdata, man);
1.111 kristaps 780: break;
1.173 schwarze 781: case OUTT_TREE:
1.250 schwarze 782: tree_mdoc(curp->outdata, man);
1.111 kristaps 783: break;
1.173 schwarze 784: case OUTT_MAN:
1.250 schwarze 785: man_mdoc(curp->outdata, man);
1.164 schwarze 786: break;
1.173 schwarze 787: case OUTT_PDF:
788: case OUTT_ASCII:
789: case OUTT_UTF8:
790: case OUTT_LOCALE:
791: case OUTT_PS:
1.250 schwarze 792: terminal_mdoc(curp->outdata, man);
793: break;
794: default:
795: break;
796: }
797: }
798: if (man->macroset == MACROSET_MAN) {
1.253 schwarze 799: man_validate(man);
1.250 schwarze 800: switch (curp->outtype) {
801: case OUTT_HTML:
802: html_man(curp->outdata, man);
803: break;
804: case OUTT_TREE:
805: tree_man(curp->outdata, man);
806: break;
807: case OUTT_MAN:
808: man_man(curp->outdata, man);
809: break;
810: case OUTT_PDF:
811: case OUTT_ASCII:
812: case OUTT_UTF8:
813: case OUTT_LOCALE:
814: case OUTT_PS:
815: terminal_man(curp->outdata, man);
1.111 kristaps 816: break;
817: default:
818: break;
819: }
820: }
1.186 schwarze 821: }
822:
1.227 schwarze 823: static void
1.197 schwarze 824: passthrough(const char *file, int fd, int synopsis_only)
1.186 schwarze 825: {
1.197 schwarze 826: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
827: const char synr[] = "SYNOPSIS";
828:
829: FILE *stream;
1.186 schwarze 830: const char *syscall;
1.257 schwarze 831: char *line, *cp;
832: size_t linesz;
1.197 schwarze 833: int print;
1.210 schwarze 834:
1.257 schwarze 835: line = NULL;
836: linesz = 0;
1.197 schwarze 837:
838: if ((stream = fdopen(fd, "r")) == NULL) {
839: close(fd);
840: syscall = "fdopen";
841: goto fail;
842: }
1.186 schwarze 843:
1.197 schwarze 844: print = 0;
1.257 schwarze 845: while (getline(&line, &linesz, stream) != -1) {
846: cp = line;
1.197 schwarze 847: if (synopsis_only) {
848: if (print) {
1.257 schwarze 849: if ( ! isspace((unsigned char)*cp))
1.197 schwarze 850: goto done;
1.257 schwarze 851: while (isspace((unsigned char)*cp))
852: cp++;
1.197 schwarze 853: } else {
1.257 schwarze 854: if (strcmp(cp, synb) == 0 ||
855: strcmp(cp, synr) == 0)
1.197 schwarze 856: print = 1;
857: continue;
858: }
859: }
1.257 schwarze 860: if (fputs(cp, stdout)) {
861: fclose(stream);
862: syscall = "fputs";
863: goto fail;
864: }
1.197 schwarze 865: }
1.186 schwarze 866:
1.197 schwarze 867: if (ferror(stream)) {
868: fclose(stream);
1.257 schwarze 869: syscall = "getline";
1.197 schwarze 870: goto fail;
871: }
1.193 schwarze 872:
1.197 schwarze 873: done:
1.257 schwarze 874: free(line);
1.197 schwarze 875: fclose(stream);
1.227 schwarze 876: return;
1.186 schwarze 877:
878: fail:
1.257 schwarze 879: free(line);
1.247 schwarze 880: warn("%s: SYSERR: %s", file, syscall);
1.227 schwarze 881: if (rc < MANDOCLEVEL_SYSERR)
882: rc = MANDOCLEVEL_SYSERR;
1.194 schwarze 883: }
884:
885: static int
886: koptions(int *options, char *arg)
887: {
888:
889: if ( ! strcmp(arg, "utf-8")) {
890: *options |= MPARSE_UTF8;
891: *options &= ~MPARSE_LATIN1;
892: } else if ( ! strcmp(arg, "iso-8859-1")) {
893: *options |= MPARSE_LATIN1;
894: *options &= ~MPARSE_UTF8;
895: } else if ( ! strcmp(arg, "us-ascii")) {
896: *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
897: } else {
1.247 schwarze 898: warnx("-K %s: Bad argument", arg);
1.245 schwarze 899: return 0;
1.194 schwarze 900: }
1.245 schwarze 901: return 1;
1.10 kristaps 902: }
903:
904: static int
1.170 schwarze 905: moptions(int *options, char *arg)
1.10 kristaps 906: {
907:
1.180 schwarze 908: if (arg == NULL)
909: /* nothing to do */;
910: else if (0 == strcmp(arg, "doc"))
1.170 schwarze 911: *options |= MPARSE_MDOC;
1.19 kristaps 912: else if (0 == strcmp(arg, "andoc"))
1.170 schwarze 913: /* nothing to do */;
1.17 kristaps 914: else if (0 == strcmp(arg, "an"))
1.170 schwarze 915: *options |= MPARSE_MAN;
1.10 kristaps 916: else {
1.247 schwarze 917: warnx("-m %s: Bad argument", arg);
1.245 schwarze 918: return 0;
1.10 kristaps 919: }
920:
1.245 schwarze 921: return 1;
1.1 kristaps 922: }
923:
924: static int
1.60 kristaps 925: toptions(struct curparse *curp, char *arg)
1.1 kristaps 926: {
927:
928: if (0 == strcmp(arg, "ascii"))
1.60 kristaps 929: curp->outtype = OUTT_ASCII;
930: else if (0 == strcmp(arg, "lint")) {
931: curp->outtype = OUTT_LINT;
1.103 schwarze 932: curp->wlevel = MANDOCLEVEL_WARNING;
1.154 kristaps 933: } else if (0 == strcmp(arg, "tree"))
1.60 kristaps 934: curp->outtype = OUTT_TREE;
1.164 schwarze 935: else if (0 == strcmp(arg, "man"))
936: curp->outtype = OUTT_MAN;
1.43 kristaps 937: else if (0 == strcmp(arg, "html"))
1.60 kristaps 938: curp->outtype = OUTT_HTML;
1.163 kristaps 939: else if (0 == strcmp(arg, "utf8"))
940: curp->outtype = OUTT_UTF8;
1.162 kristaps 941: else if (0 == strcmp(arg, "locale"))
942: curp->outtype = OUTT_LOCALE;
1.59 kristaps 943: else if (0 == strcmp(arg, "xhtml"))
1.195 schwarze 944: curp->outtype = OUTT_HTML;
1.85 kristaps 945: else if (0 == strcmp(arg, "ps"))
946: curp->outtype = OUTT_PS;
1.100 kristaps 947: else if (0 == strcmp(arg, "pdf"))
948: curp->outtype = OUTT_PDF;
1.1 kristaps 949: else {
1.247 schwarze 950: warnx("-T %s: Bad argument", arg);
1.245 schwarze 951: return 0;
1.1 kristaps 952: }
953:
1.245 schwarze 954: return 1;
1.1 kristaps 955: }
956:
957: static int
1.103 schwarze 958: woptions(struct curparse *curp, char *arg)
1.1 kristaps 959: {
1.34 kristaps 960: char *v, *o;
1.217 schwarze 961: const char *toks[7];
1.1 kristaps 962:
1.103 schwarze 963: toks[0] = "stop";
964: toks[1] = "all";
965: toks[2] = "warning";
966: toks[3] = "error";
1.217 schwarze 967: toks[4] = "unsupp";
968: toks[5] = "fatal";
969: toks[6] = NULL;
1.1 kristaps 970:
1.34 kristaps 971: while (*arg) {
972: o = arg;
1.45 kristaps 973: switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.173 schwarze 974: case 0:
1.103 schwarze 975: curp->wstop = 1;
1.1 kristaps 976: break;
1.173 schwarze 977: case 1:
978: case 2:
1.103 schwarze 979: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 980: break;
1.173 schwarze 981: case 3:
1.103 schwarze 982: curp->wlevel = MANDOCLEVEL_ERROR;
1.24 kristaps 983: break;
1.173 schwarze 984: case 4:
1.217 schwarze 985: curp->wlevel = MANDOCLEVEL_UNSUPP;
986: break;
987: case 5:
1.215 schwarze 988: curp->wlevel = MANDOCLEVEL_BADARG;
1.50 kristaps 989: break;
1.1 kristaps 990: default:
1.247 schwarze 991: warnx("-W %s: Bad argument", o);
1.245 schwarze 992: return 0;
1.1 kristaps 993: }
1.34 kristaps 994: }
1.1 kristaps 995:
1.245 schwarze 996: return 1;
1.1 kristaps 997: }
998:
1.153 kristaps 999: static void
1.173 schwarze 1000: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.155 kristaps 1001: const char *file, int line, int col, const char *msg)
1.71 kristaps 1002: {
1.177 schwarze 1003: const char *mparse_msg;
1.103 schwarze 1004:
1.254 schwarze 1005: fprintf(stderr, "%s: %s:", getprogname(), file);
1.175 schwarze 1006:
1007: if (line)
1008: fprintf(stderr, "%d:%d:", line, col + 1);
1009:
1.177 schwarze 1010: fprintf(stderr, " %s", mparse_strlevel(lvl));
1011:
1012: if (NULL != (mparse_msg = mparse_strerror(t)))
1013: fprintf(stderr, ": %s", mparse_msg);
1.154 kristaps 1014:
1.73 kristaps 1015: if (msg)
1016: fprintf(stderr, ": %s", msg);
1.154 kristaps 1017:
1.73 kristaps 1018: fputc('\n', stderr);
1.183 schwarze 1019: }
1020:
1.225 schwarze 1021: static pid_t
1.244 schwarze 1022: spawn_pager(struct tag_files *tag_files)
1.183 schwarze 1023: {
1.265 schwarze 1024: const struct timespec timeout = { 0, 100000000 }; /* 0.1s */
1.184 schwarze 1025: #define MAX_PAGER_ARGS 16
1026: char *argv[MAX_PAGER_ARGS];
1027: const char *pager;
1028: char *cp;
1.239 schwarze 1029: size_t cmdlen;
1.184 schwarze 1030: int argc;
1.225 schwarze 1031: pid_t pager_pid;
1.183 schwarze 1032:
1.239 schwarze 1033: pager = getenv("MANPAGER");
1034: if (pager == NULL || *pager == '\0')
1035: pager = getenv("PAGER");
1036: if (pager == NULL || *pager == '\0')
1037: pager = "more -s";
1038: cp = mandoc_strdup(pager);
1039:
1040: /*
1041: * Parse the pager command into words.
1042: * Intentionally do not do anything fancy here.
1043: */
1044:
1045: argc = 0;
1046: while (argc + 4 < MAX_PAGER_ARGS) {
1047: argv[argc++] = cp;
1048: cp = strchr(cp, ' ');
1049: if (cp == NULL)
1050: break;
1051: *cp++ = '\0';
1052: while (*cp == ' ')
1053: cp++;
1054: if (*cp == '\0')
1055: break;
1056: }
1057:
1.268 ! schwarze 1058: /* For less(1), use the tag file. */
1.239 schwarze 1059:
1.244 schwarze 1060: if ((cmdlen = strlen(argv[0])) >= 4) {
1.239 schwarze 1061: cp = argv[0] + cmdlen - 4;
1.268 ! schwarze 1062: if (strcmp(cp, "less") == 0) {
1.244 schwarze 1063: argv[argc++] = mandoc_strdup("-T");
1064: argv[argc++] = tag_files->tfn;
1065: }
1.239 schwarze 1066: }
1.244 schwarze 1067: argv[argc++] = tag_files->ofn;
1.239 schwarze 1068: argv[argc] = NULL;
1069:
1.225 schwarze 1070: switch (pager_pid = fork()) {
1.183 schwarze 1071: case -1:
1.247 schwarze 1072: err((int)MANDOCLEVEL_SYSERR, "fork");
1.183 schwarze 1073: case 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.265 schwarze 1092:
1093: /* Do not start the pager before controlling the terminal. */
1094:
1095: while (tcgetpgrp(STDIN_FILENO) != getpid())
1096: nanosleep(&timeout, NULL);
1097:
1.184 schwarze 1098: execvp(argv[0], argv);
1.247 schwarze 1099: err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
1.71 kristaps 1100: }
CVSweb