Annotation of mandoc/main.c, Revision 1.293
1.293 ! schwarze 1: /* $Id: main.c,v 1.292 2017/06/03 12:17:25 schwarze Exp $ */
1.1 kristaps 2: /*
1.183 schwarze 3: * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.278 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_ONE
60: };
61:
1.19 kristaps 62: enum outt {
1.154 kristaps 63: OUTT_ASCII = 0, /* -Tascii */
1.162 kristaps 64: OUTT_LOCALE, /* -Tlocale */
1.163 kristaps 65: OUTT_UTF8, /* -Tutf8 */
1.154 kristaps 66: OUTT_TREE, /* -Ttree */
1.164 schwarze 67: OUTT_MAN, /* -Tman */
1.154 kristaps 68: OUTT_HTML, /* -Thtml */
1.285 schwarze 69: OUTT_MARKDOWN, /* -Tmarkdown */
1.154 kristaps 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.293 ! schwarze 77: struct manoutput *outopts; /* output options */
! 78: void *outdata; /* data for output */
! 79: char *os_s; /* operating system for display */
1.148 kristaps 80: int wstop; /* stop after a file with a warning */
1.293 ! schwarze 81: enum mandocerr mmin; /* ignore messages below this */
! 82: enum mandoc_os os_e; /* check base system conventions */
1.173 schwarze 83: enum outt outtype; /* which output to use */
1.79 kristaps 84: };
1.270 schwarze 85:
86:
87: int mandocdb(int, char *[]);
1.79 kristaps 88:
1.213 schwarze 89: static int fs_lookup(const struct manpaths *,
90: size_t ipath, const char *,
91: const char *, const char *,
92: struct manpage **, size_t *);
93: static void fs_search(const struct mansearch *,
94: const struct manpaths *, int, char**,
95: struct manpage **, size_t *);
1.194 schwarze 96: static int koptions(int *, char *);
1.286 schwarze 97: static void moptions(int *, char *);
1.155 kristaps 98: static void mmsg(enum mandocerr, enum mandoclevel,
99: const char *, int, int, const char *);
1.276 schwarze 100: static void outdata_alloc(struct curparse *);
1.227 schwarze 101: static void parse(struct curparse *, int, const char *);
102: static void passthrough(const char *, int, int);
1.244 schwarze 103: static pid_t spawn_pager(struct tag_files *);
1.66 kristaps 104: static int toptions(struct curparse *, char *);
1.283 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.282 schwarze 118: struct mansearch search;
1.5 kristaps 119: struct curparse curp;
1.244 schwarze 120: struct tag_files *tag_files;
1.282 schwarze 121: struct manpage *res, *resp;
122: const char *progname, *sec, *thisarg;
123: char *conf_file, *defpaths, *auxpaths;
1.293 ! schwarze 124: char *oarg;
1.207 schwarze 125: unsigned char *uc;
1.264 schwarze 126: size_t i, sz;
1.230 schwarze 127: int prio, best_prio;
1.181 schwarze 128: enum outmode outmode;
1.192 schwarze 129: int fd;
1.180 schwarze 130: int show_usage;
1.170 schwarze 131: int options;
1.244 schwarze 132: int use_pager;
1.259 schwarze 133: int status, signum;
1.180 schwarze 134: int c;
1.259 schwarze 135: pid_t pager_pid, tc_pgid, man_pgid, pid;
1.1 kristaps 136:
1.254 schwarze 137: #if HAVE_PROGNAME
138: progname = getprogname();
139: #else
1.219 schwarze 140: if (argc < 1)
1.254 schwarze 141: progname = mandoc_strdup("mandoc");
142: else if ((progname = strrchr(argv[0], '/')) == NULL)
143: progname = argv[0];
1.54 kristaps 144: else
1.254 schwarze 145: ++progname;
146: setprogname(progname);
1.247 schwarze 147: #endif
1.203 schwarze 148:
1.254 schwarze 149: if (strncmp(progname, "mandocdb", 8) == 0 ||
150: strcmp(progname, BINM_MAKEWHATIS) == 0)
1.245 schwarze 151: return mandocdb(argc, argv);
1.179 schwarze 152:
1.255 schwarze 153: #if HAVE_PLEDGE
1.284 schwarze 154: if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1)
1.255 schwarze 155: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.269 kristaps 156: #endif
157:
158: #if HAVE_SANDBOX_INIT
159: if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1)
160: errx((int)MANDOCLEVEL_SYSERR, "sandbox_init");
1.255 schwarze 161: #endif
162:
1.180 schwarze 163: /* Search options. */
164:
1.229 schwarze 165: memset(&conf, 0, sizeof(conf));
1.205 schwarze 166: conf_file = defpaths = NULL;
167: auxpaths = NULL;
1.180 schwarze 168:
169: memset(&search, 0, sizeof(struct mansearch));
170: search.outkey = "Nd";
1.282 schwarze 171: oarg = NULL;
1.180 schwarze 172:
1.254 schwarze 173: if (strcmp(progname, BINM_MAN) == 0)
1.180 schwarze 174: search.argmode = ARG_NAME;
1.254 schwarze 175: else if (strcmp(progname, BINM_APROPOS) == 0)
1.180 schwarze 176: search.argmode = ARG_EXPR;
1.254 schwarze 177: else if (strcmp(progname, BINM_WHATIS) == 0)
1.180 schwarze 178: search.argmode = ARG_WORD;
1.254 schwarze 179: else if (strncmp(progname, "help", 4) == 0)
1.202 schwarze 180: search.argmode = ARG_NAME;
1.180 schwarze 181: else
182: search.argmode = ARG_FILE;
183:
184: /* Parser and formatter options. */
1.54 kristaps 185:
1.51 kristaps 186: memset(&curp, 0, sizeof(struct curparse));
1.201 schwarze 187: curp.outtype = OUTT_LOCALE;
1.293 ! schwarze 188: curp.mmin = MANDOCERR_MAX;
1.230 schwarze 189: curp.outopts = &conf.output;
1.194 schwarze 190: options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.19 kristaps 191:
1.244 schwarze 192: use_pager = 1;
193: tag_files = NULL;
1.180 schwarze 194: show_usage = 0;
1.181 schwarze 195: outmode = OUTMODE_DEF;
1.183 schwarze 196:
1.289 schwarze 197: while ((c = getopt(argc, argv,
198: "aC:cfhI:iK:klM:m:O:S:s:T:VW:w")) != -1) {
199: if (c == 'i' && search.argmode == ARG_EXPR) {
200: optind--;
201: break;
202: }
1.1 kristaps 203: switch (c) {
1.181 schwarze 204: case 'a':
205: outmode = OUTMODE_ALL;
206: break;
1.180 schwarze 207: case 'C':
208: conf_file = optarg;
209: break;
1.183 schwarze 210: case 'c':
1.244 schwarze 211: use_pager = 0;
1.183 schwarze 212: break;
1.180 schwarze 213: case 'f':
214: search.argmode = ARG_WORD;
215: break;
1.190 schwarze 216: case 'h':
1.230 schwarze 217: conf.output.synopsisonly = 1;
1.244 schwarze 218: use_pager = 0;
1.190 schwarze 219: outmode = OUTMODE_ALL;
220: break;
1.173 schwarze 221: case 'I':
1.166 schwarze 222: if (strncmp(optarg, "os=", 3)) {
1.247 schwarze 223: warnx("-I %s: Bad argument", optarg);
1.245 schwarze 224: return (int)MANDOCLEVEL_BADARG;
1.166 schwarze 225: }
1.293 ! schwarze 226: if (curp.os_s != NULL) {
1.247 schwarze 227: warnx("-I %s: Duplicate argument", optarg);
1.245 schwarze 228: return (int)MANDOCLEVEL_BADARG;
1.166 schwarze 229: }
1.293 ! schwarze 230: curp.os_s = mandoc_strdup(optarg + 3);
1.181 schwarze 231: break;
1.194 schwarze 232: case 'K':
233: if ( ! koptions(&options, optarg))
1.245 schwarze 234: return (int)MANDOCLEVEL_BADARG;
1.194 schwarze 235: break;
1.180 schwarze 236: case 'k':
237: search.argmode = ARG_EXPR;
238: break;
1.188 schwarze 239: case 'l':
240: search.argmode = ARG_FILE;
241: outmode = OUTMODE_ALL;
242: break;
1.180 schwarze 243: case 'M':
244: defpaths = optarg;
245: break;
1.173 schwarze 246: case 'm':
1.180 schwarze 247: auxpaths = optarg;
1.10 kristaps 248: break;
1.173 schwarze 249: case 'O':
1.282 schwarze 250: oarg = 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;
1.282 schwarze 292: }
293: }
294:
295: if (oarg != NULL) {
296: if (outmode == OUTMODE_LST)
297: search.outkey = oarg;
298: else {
299: while (oarg != NULL) {
300: thisarg = oarg;
301: if (manconf_output(&conf.output,
302: strsep(&oarg, ","), 0) == 0)
303: continue;
304: warnx("-O %s: Bad argument", thisarg);
305: return (int)MANDOCLEVEL_BADARG;
306: }
1.181 schwarze 307: }
308: }
309:
1.246 schwarze 310: if (outmode == OUTMODE_FLN ||
311: outmode == OUTMODE_LST ||
312: !isatty(STDOUT_FILENO))
313: use_pager = 0;
314:
1.255 schwarze 315: #if HAVE_PLEDGE
1.260 schwarze 316: if (!use_pager)
1.284 schwarze 317: if (pledge("stdio rpath", NULL) == -1)
1.260 schwarze 318: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.255 schwarze 319: #endif
320:
1.185 schwarze 321: /* Parse arguments. */
322:
1.219 schwarze 323: if (argc > 0) {
324: argc -= optind;
325: argv += optind;
326: }
1.186 schwarze 327: resp = NULL;
1.185 schwarze 328:
1.202 schwarze 329: /*
330: * Quirks for help(1)
331: * and for a man(1) section argument without -s.
332: */
333:
334: if (search.argmode == ARG_NAME) {
1.254 schwarze 335: if (*progname == 'h') {
1.202 schwarze 336: if (argc == 0) {
337: argv = help_argv;
338: argc = 1;
339: }
1.211 schwarze 340: } else if (argc > 1 &&
1.223 kristaps 341: ((uc = (unsigned char *)argv[0]) != NULL) &&
1.207 schwarze 342: ((isdigit(uc[0]) && (uc[1] == '\0' ||
343: (isalpha(uc[1]) && uc[2] == '\0'))) ||
344: (uc[0] == 'n' && uc[1] == '\0'))) {
1.223 kristaps 345: search.sec = (char *)uc;
1.202 schwarze 346: argv++;
347: argc--;
348: }
1.216 schwarze 349: if (search.arch == NULL)
350: search.arch = getenv("MACHINE");
1.223 kristaps 351: #ifdef MACHINE
1.216 schwarze 352: if (search.arch == NULL)
353: search.arch = MACHINE;
1.223 kristaps 354: #endif
1.185 schwarze 355: }
1.182 schwarze 356:
357: rc = MANDOCLEVEL_OK;
1.180 schwarze 358:
359: /* man(1), whatis(1), apropos(1) */
360:
361: if (search.argmode != ARG_FILE) {
1.199 schwarze 362: if (search.argmode == ARG_NAME &&
363: outmode == OUTMODE_ONE)
364: search.firstmatch = 1;
1.182 schwarze 365:
366: /* Access the mandoc database. */
367:
1.229 schwarze 368: manconf_parse(&conf, conf_file, defpaths, auxpaths);
369: if ( ! mansearch(&search, &conf.manpath,
370: argc, argv, &res, &sz))
1.180 schwarze 371: usage(search.argmode);
1.213 schwarze 372:
1.237 schwarze 373: if (sz == 0) {
374: if (search.argmode == ARG_NAME)
375: fs_search(&search, &conf.manpath,
376: argc, argv, &res, &sz);
377: else
1.247 schwarze 378: warnx("nothing appropriate");
1.237 schwarze 379: }
1.187 schwarze 380:
381: if (sz == 0) {
382: rc = MANDOCLEVEL_BADARG;
383: goto out;
384: }
1.182 schwarze 385:
386: /*
387: * For standard man(1) and -a output mode,
388: * prepare for copying filename pointers
389: * into the program parameter array.
390: */
391:
392: if (outmode == OUTMODE_ONE) {
393: argc = 1;
1.264 schwarze 394: best_prio = 20;
1.186 schwarze 395: } else if (outmode == OUTMODE_ALL)
1.182 schwarze 396: argc = (int)sz;
397:
398: /* Iterate all matching manuals. */
399:
1.213 schwarze 400: resp = res;
1.181 schwarze 401: for (i = 0; i < sz; i++) {
402: if (outmode == OUTMODE_FLN)
403: puts(res[i].file);
1.182 schwarze 404: else if (outmode == OUTMODE_LST)
1.181 schwarze 405: printf("%s - %s\n", res[i].names,
406: res[i].output == NULL ? "" :
407: res[i].output);
1.186 schwarze 408: else if (outmode == OUTMODE_ONE) {
1.182 schwarze 409: /* Search for the best section. */
1.264 schwarze 410: sec = res[i].file;
411: sec += strcspn(sec, "123456789");
412: if (sec[0] == '\0')
1.182 schwarze 413: continue;
1.264 schwarze 414: prio = sec_prios[sec[0] - '1'];
415: if (sec[1] != '/')
416: prio += 10;
1.182 schwarze 417: if (prio >= best_prio)
418: continue;
419: best_prio = prio;
1.186 schwarze 420: resp = res + i;
1.182 schwarze 421: }
1.181 schwarze 422: }
1.182 schwarze 423:
424: /*
425: * For man(1), -a and -i output mode, fall through
426: * to the main mandoc(1) code iterating files
427: * and running the parsers on each of them.
428: */
429:
430: if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
431: goto out;
1.180 schwarze 432: }
433:
434: /* mandoc(1) */
435:
1.255 schwarze 436: #if HAVE_PLEDGE
1.260 schwarze 437: if (use_pager) {
438: if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1)
439: err((int)MANDOCLEVEL_SYSERR, "pledge");
440: } else {
441: if (pledge("stdio rpath", NULL) == -1)
442: err((int)MANDOCLEVEL_SYSERR, "pledge");
443: }
1.255 schwarze 444: #endif
445:
1.286 schwarze 446: if (search.argmode == ARG_FILE)
447: moptions(&options, auxpaths);
1.241 schwarze 448:
1.249 schwarze 449: mchars_alloc();
1.293 ! schwarze 450: curp.mp = mparse_alloc(options, curp.mmin, mmsg,
! 451: curp.os_e, curp.os_s);
1.154 kristaps 452:
1.165 kristaps 453: /*
454: * Conditionally start up the lookaside buffer before parsing.
455: */
456: if (OUTT_MAN == curp.outtype)
457: mparse_keep(curp.mp);
458:
1.219 schwarze 459: if (argc < 1) {
1.244 schwarze 460: if (use_pager)
461: tag_files = tag_init();
1.227 schwarze 462: parse(&curp, STDIN_FILENO, "<stdin>");
1.212 schwarze 463: }
1.64 kristaps 464:
1.219 schwarze 465: while (argc > 0) {
1.262 schwarze 466: fd = mparse_open(curp.mp, resp != NULL ? resp->file : *argv);
1.212 schwarze 467: if (fd != -1) {
1.244 schwarze 468: if (use_pager) {
469: tag_files = tag_init();
470: use_pager = 0;
471: }
1.212 schwarze 472:
473: if (resp == NULL)
1.227 schwarze 474: parse(&curp, fd, *argv);
1.274 schwarze 475: else if (resp->form == FORM_SRC) {
1.189 schwarze 476: /* For .so only; ignore failure. */
1.229 schwarze 477: chdir(conf.manpath.paths[resp->ipath]);
1.227 schwarze 478: parse(&curp, fd, resp->file);
479: } else
1.230 schwarze 480: passthrough(resp->file, fd,
481: conf.output.synopsisonly);
1.212 schwarze 482:
1.276 schwarze 483: if (argc > 1 && curp.outtype <= OUTT_UTF8) {
484: if (curp.outdata == NULL)
485: outdata_alloc(&curp);
1.267 schwarze 486: terminal_sepline(curp.outdata);
1.276 schwarze 487: }
1.262 schwarze 488: } else if (rc < MANDOCLEVEL_ERROR)
489: rc = MANDOCLEVEL_ERROR;
1.192 schwarze 490:
1.154 kristaps 491: if (MANDOCLEVEL_OK != rc && curp.wstop)
1.64 kristaps 492: break;
1.210 schwarze 493:
1.212 schwarze 494: if (resp != NULL)
495: resp++;
496: else
497: argv++;
498: if (--argc)
499: mparse_reset(curp.mp);
1.1 kristaps 500: }
501:
1.252 schwarze 502: if (curp.outdata != NULL) {
503: switch (curp.outtype) {
504: case OUTT_HTML:
505: html_free(curp.outdata);
506: break;
507: case OUTT_UTF8:
508: case OUTT_LOCALE:
509: case OUTT_ASCII:
510: ascii_free(curp.outdata);
511: break;
512: case OUTT_PDF:
513: case OUTT_PS:
514: pspdf_free(curp.outdata);
515: break;
516: default:
517: break;
518: }
1.250 schwarze 519: }
1.195 schwarze 520: mparse_free(curp.mp);
1.249 schwarze 521: mchars_free();
1.182 schwarze 522:
523: out:
524: if (search.argmode != ARG_FILE) {
1.229 schwarze 525: manconf_free(&conf);
1.182 schwarze 526: mansearch_free(res, sz);
527: }
528:
1.293 ! schwarze 529: free(curp.os_s);
1.1 kristaps 530:
1.224 schwarze 531: /*
1.244 schwarze 532: * When using a pager, finish writing both temporary files,
533: * fork it, wait for the user to close it, and clean up.
1.224 schwarze 534: */
535:
1.244 schwarze 536: if (tag_files != NULL) {
1.225 schwarze 537: fclose(stdout);
1.239 schwarze 538: tag_write();
1.259 schwarze 539: man_pgid = getpgid(0);
540: tag_files->tcpgid = man_pgid == getpid() ?
541: getpgid(getppid()) : man_pgid;
542: pager_pid = 0;
543: signum = SIGSTOP;
1.258 schwarze 544: for (;;) {
1.259 schwarze 545:
546: /* Stop here until moved to the foreground. */
547:
1.279 schwarze 548: tc_pgid = tcgetpgrp(tag_files->ofd);
1.259 schwarze 549: if (tc_pgid != man_pgid) {
550: if (tc_pgid == pager_pid) {
1.279 schwarze 551: (void)tcsetpgrp(tag_files->ofd,
1.259 schwarze 552: man_pgid);
553: if (signum == SIGTTIN)
554: continue;
555: } else
556: tag_files->tcpgid = tc_pgid;
557: kill(0, signum);
558: continue;
559: }
560:
561: /* Once in the foreground, activate the pager. */
562:
563: if (pager_pid) {
1.279 schwarze 564: (void)tcsetpgrp(tag_files->ofd, pager_pid);
1.259 schwarze 565: kill(pager_pid, SIGCONT);
566: } else
567: pager_pid = spawn_pager(tag_files);
568:
569: /* Wait for the pager to stop or exit. */
570:
571: while ((pid = waitpid(pager_pid, &status,
572: WUNTRACED)) == -1 && errno == EINTR)
573: continue;
574:
575: if (pid == -1) {
1.258 schwarze 576: warn("wait");
577: rc = MANDOCLEVEL_SYSERR;
578: break;
579: }
580: if (!WIFSTOPPED(status))
581: break;
582:
1.259 schwarze 583: signum = WSTOPSIG(status);
1.258 schwarze 584: }
1.239 schwarze 585: tag_unlink();
1.225 schwarze 586: }
1.224 schwarze 587:
1.245 schwarze 588: return (int)rc;
1.1 kristaps 589: }
590:
1.55 kristaps 591: static void
1.180 schwarze 592: usage(enum argmode argmode)
1.1 kristaps 593: {
594:
1.180 schwarze 595: switch (argmode) {
596: case ARG_FILE:
1.287 schwarze 597: fputs("usage: mandoc [-ac] [-I os=name] "
598: "[-K encoding] [-mdoc | -man] [-O options]\n"
1.228 schwarze 599: "\t [-T output] [-W level] [file ...]\n", stderr);
1.180 schwarze 600: break;
601: case ARG_NAME:
1.287 schwarze 602: fputs("usage: man [-acfhklw] [-C file] [-M path] "
603: "[-m path] [-S subsection]\n"
604: "\t [[-s] section] name ...\n", stderr);
1.180 schwarze 605: break;
606: case ARG_WORD:
1.287 schwarze 607: fputs("usage: whatis [-afk] [-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.287 schwarze 612: fputs("usage: apropos [-afk] [-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.274 schwarze 628: int globres;
629: enum form form;
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.276 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.281 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;
1.285 schwarze 770: case OUTT_MARKDOWN:
771: markdown_mdoc(curp->outdata, man);
772: break;
1.250 schwarze 773: default:
774: break;
775: }
776: }
777: if (man->macroset == MACROSET_MAN) {
1.281 schwarze 778: if (curp->outtype != OUTT_TREE || !curp->outopts->noval)
779: man_validate(man);
1.250 schwarze 780: switch (curp->outtype) {
781: case OUTT_HTML:
782: html_man(curp->outdata, man);
783: break;
784: case OUTT_TREE:
785: tree_man(curp->outdata, man);
786: break;
787: case OUTT_MAN:
788: man_man(curp->outdata, man);
789: break;
790: case OUTT_PDF:
791: case OUTT_ASCII:
792: case OUTT_UTF8:
793: case OUTT_LOCALE:
794: case OUTT_PS:
795: terminal_man(curp->outdata, man);
1.111 kristaps 796: break;
797: default:
798: break;
799: }
1.276 schwarze 800: }
1.278 schwarze 801: mparse_updaterc(curp->mp, &rc);
1.276 schwarze 802: }
803:
804: static void
805: outdata_alloc(struct curparse *curp)
806: {
807: switch (curp->outtype) {
808: case OUTT_HTML:
809: curp->outdata = html_alloc(curp->outopts);
810: break;
811: case OUTT_UTF8:
812: curp->outdata = utf8_alloc(curp->outopts);
813: break;
814: case OUTT_LOCALE:
815: curp->outdata = locale_alloc(curp->outopts);
816: break;
817: case OUTT_ASCII:
818: curp->outdata = ascii_alloc(curp->outopts);
819: break;
820: case OUTT_PDF:
821: curp->outdata = pdf_alloc(curp->outopts);
822: break;
823: case OUTT_PS:
824: curp->outdata = ps_alloc(curp->outopts);
825: break;
826: default:
827: break;
1.111 kristaps 828: }
1.186 schwarze 829: }
830:
1.227 schwarze 831: static void
1.197 schwarze 832: passthrough(const char *file, int fd, int synopsis_only)
1.186 schwarze 833: {
1.197 schwarze 834: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
835: const char synr[] = "SYNOPSIS";
836:
837: FILE *stream;
1.186 schwarze 838: const char *syscall;
1.257 schwarze 839: char *line, *cp;
840: size_t linesz;
1.277 schwarze 841: ssize_t len, written;
1.197 schwarze 842: int print;
1.210 schwarze 843:
1.257 schwarze 844: line = NULL;
845: linesz = 0;
1.197 schwarze 846:
1.277 schwarze 847: if (fflush(stdout) == EOF) {
848: syscall = "fflush";
849: goto fail;
850: }
851:
1.197 schwarze 852: if ((stream = fdopen(fd, "r")) == NULL) {
853: close(fd);
854: syscall = "fdopen";
855: goto fail;
856: }
1.186 schwarze 857:
1.197 schwarze 858: print = 0;
1.277 schwarze 859: while ((len = getline(&line, &linesz, stream)) != -1) {
1.257 schwarze 860: cp = line;
1.197 schwarze 861: if (synopsis_only) {
862: if (print) {
1.257 schwarze 863: if ( ! isspace((unsigned char)*cp))
1.197 schwarze 864: goto done;
1.277 schwarze 865: while (isspace((unsigned char)*cp)) {
1.257 schwarze 866: cp++;
1.277 schwarze 867: len--;
868: }
1.197 schwarze 869: } else {
1.257 schwarze 870: if (strcmp(cp, synb) == 0 ||
871: strcmp(cp, synr) == 0)
1.197 schwarze 872: print = 1;
873: continue;
874: }
875: }
1.277 schwarze 876: for (; len > 0; len -= written) {
877: if ((written = write(STDOUT_FILENO, cp, len)) != -1)
878: continue;
1.257 schwarze 879: fclose(stream);
1.277 schwarze 880: syscall = "write";
1.257 schwarze 881: goto fail;
882: }
1.197 schwarze 883: }
1.186 schwarze 884:
1.197 schwarze 885: if (ferror(stream)) {
886: fclose(stream);
1.257 schwarze 887: syscall = "getline";
1.197 schwarze 888: goto fail;
889: }
1.193 schwarze 890:
1.197 schwarze 891: done:
1.257 schwarze 892: free(line);
1.197 schwarze 893: fclose(stream);
1.227 schwarze 894: return;
1.186 schwarze 895:
896: fail:
1.257 schwarze 897: free(line);
1.247 schwarze 898: warn("%s: SYSERR: %s", file, syscall);
1.227 schwarze 899: if (rc < MANDOCLEVEL_SYSERR)
900: rc = MANDOCLEVEL_SYSERR;
1.194 schwarze 901: }
902:
903: static int
904: koptions(int *options, char *arg)
905: {
906:
907: if ( ! strcmp(arg, "utf-8")) {
908: *options |= MPARSE_UTF8;
909: *options &= ~MPARSE_LATIN1;
910: } else if ( ! strcmp(arg, "iso-8859-1")) {
911: *options |= MPARSE_LATIN1;
912: *options &= ~MPARSE_UTF8;
913: } else if ( ! strcmp(arg, "us-ascii")) {
914: *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
915: } else {
1.247 schwarze 916: warnx("-K %s: Bad argument", arg);
1.245 schwarze 917: return 0;
1.194 schwarze 918: }
1.245 schwarze 919: return 1;
1.10 kristaps 920: }
921:
1.286 schwarze 922: static void
1.170 schwarze 923: moptions(int *options, char *arg)
1.10 kristaps 924: {
925:
1.180 schwarze 926: if (arg == NULL)
1.286 schwarze 927: return;
928: if (strcmp(arg, "doc") == 0)
1.170 schwarze 929: *options |= MPARSE_MDOC;
1.286 schwarze 930: else if (strcmp(arg, "an") == 0)
1.170 schwarze 931: *options |= MPARSE_MAN;
1.1 kristaps 932: }
933:
934: static int
1.60 kristaps 935: toptions(struct curparse *curp, char *arg)
1.1 kristaps 936: {
937:
938: if (0 == strcmp(arg, "ascii"))
1.60 kristaps 939: curp->outtype = OUTT_ASCII;
940: else if (0 == strcmp(arg, "lint")) {
941: curp->outtype = OUTT_LINT;
1.293 ! schwarze 942: curp->mmin = MANDOCERR_BASE;
1.154 kristaps 943: } else if (0 == strcmp(arg, "tree"))
1.60 kristaps 944: curp->outtype = OUTT_TREE;
1.164 schwarze 945: else if (0 == strcmp(arg, "man"))
946: curp->outtype = OUTT_MAN;
1.43 kristaps 947: else if (0 == strcmp(arg, "html"))
1.60 kristaps 948: curp->outtype = OUTT_HTML;
1.285 schwarze 949: else if (0 == strcmp(arg, "markdown"))
950: curp->outtype = OUTT_MARKDOWN;
1.163 kristaps 951: else if (0 == strcmp(arg, "utf8"))
952: curp->outtype = OUTT_UTF8;
1.162 kristaps 953: else if (0 == strcmp(arg, "locale"))
954: curp->outtype = OUTT_LOCALE;
1.85 kristaps 955: else if (0 == strcmp(arg, "ps"))
956: curp->outtype = OUTT_PS;
1.100 kristaps 957: else if (0 == strcmp(arg, "pdf"))
958: curp->outtype = OUTT_PDF;
1.1 kristaps 959: else {
1.247 schwarze 960: warnx("-T %s: Bad argument", arg);
1.245 schwarze 961: return 0;
1.1 kristaps 962: }
963:
1.245 schwarze 964: return 1;
1.1 kristaps 965: }
966:
967: static int
1.103 schwarze 968: woptions(struct curparse *curp, char *arg)
1.1 kristaps 969: {
1.34 kristaps 970: char *v, *o;
1.293 ! schwarze 971: const char *toks[11];
1.1 kristaps 972:
1.103 schwarze 973: toks[0] = "stop";
974: toks[1] = "all";
1.293 ! schwarze 975: toks[2] = "base";
! 976: toks[3] = "style";
! 977: toks[4] = "warning";
! 978: toks[5] = "error";
! 979: toks[6] = "unsupp";
! 980: toks[7] = "fatal";
! 981: toks[8] = "openbsd";
! 982: toks[9] = "netbsd";
! 983: toks[10] = NULL;
1.1 kristaps 984:
1.34 kristaps 985: while (*arg) {
986: o = arg;
1.272 schwarze 987: switch (getsubopt(&arg, (char * const *)toks, &v)) {
1.173 schwarze 988: case 0:
1.103 schwarze 989: curp->wstop = 1;
1.1 kristaps 990: break;
1.173 schwarze 991: case 1:
992: case 2:
1.293 ! schwarze 993: curp->mmin = MANDOCERR_BASE;
1.290 schwarze 994: break;
995: case 3:
1.293 ! schwarze 996: curp->mmin = MANDOCERR_STYLE;
1.1 kristaps 997: break;
1.290 schwarze 998: case 4:
1.293 ! schwarze 999: curp->mmin = MANDOCERR_WARNING;
1.24 kristaps 1000: break;
1.290 schwarze 1001: case 5:
1.293 ! schwarze 1002: curp->mmin = MANDOCERR_ERROR;
1.217 schwarze 1003: break;
1.290 schwarze 1004: case 6:
1.293 ! schwarze 1005: curp->mmin = MANDOCERR_UNSUPP;
! 1006: break;
! 1007: case 7:
! 1008: curp->mmin = MANDOCERR_MAX;
! 1009: break;
! 1010: case 8:
! 1011: curp->mmin = MANDOCERR_BASE;
! 1012: curp->os_e = MANDOC_OS_OPENBSD;
! 1013: break;
! 1014: case 9:
! 1015: curp->mmin = MANDOCERR_BASE;
! 1016: curp->os_e = MANDOC_OS_NETBSD;
1.50 kristaps 1017: break;
1.1 kristaps 1018: default:
1.247 schwarze 1019: warnx("-W %s: Bad argument", o);
1.245 schwarze 1020: return 0;
1.1 kristaps 1021: }
1.34 kristaps 1022: }
1.245 schwarze 1023: return 1;
1.1 kristaps 1024: }
1025:
1.153 kristaps 1026: static void
1.173 schwarze 1027: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.155 kristaps 1028: const char *file, int line, int col, const char *msg)
1.71 kristaps 1029: {
1.177 schwarze 1030: const char *mparse_msg;
1.103 schwarze 1031:
1.275 schwarze 1032: fprintf(stderr, "%s: %s:", getprogname(),
1033: file == NULL ? "<stdin>" : file);
1.175 schwarze 1034:
1035: if (line)
1036: fprintf(stderr, "%d:%d:", line, col + 1);
1037:
1.293 ! schwarze 1038: fprintf(stderr, " %s",
! 1039: t < MANDOCERR_STYLE ? "BASE" : mparse_strlevel(lvl));
1.177 schwarze 1040:
1.293 ! schwarze 1041: if ((mparse_msg = mparse_strerror(t)) != NULL)
1.177 schwarze 1042: fprintf(stderr, ": %s", mparse_msg);
1.154 kristaps 1043:
1.73 kristaps 1044: if (msg)
1045: fprintf(stderr, ": %s", msg);
1.154 kristaps 1046:
1.73 kristaps 1047: fputc('\n', stderr);
1.183 schwarze 1048: }
1049:
1.225 schwarze 1050: static pid_t
1.244 schwarze 1051: spawn_pager(struct tag_files *tag_files)
1.183 schwarze 1052: {
1.265 schwarze 1053: const struct timespec timeout = { 0, 100000000 }; /* 0.1s */
1.184 schwarze 1054: #define MAX_PAGER_ARGS 16
1055: char *argv[MAX_PAGER_ARGS];
1056: const char *pager;
1057: char *cp;
1.239 schwarze 1058: size_t cmdlen;
1.184 schwarze 1059: int argc;
1.225 schwarze 1060: pid_t pager_pid;
1.183 schwarze 1061:
1.239 schwarze 1062: pager = getenv("MANPAGER");
1063: if (pager == NULL || *pager == '\0')
1064: pager = getenv("PAGER");
1065: if (pager == NULL || *pager == '\0')
1066: pager = "more -s";
1067: cp = mandoc_strdup(pager);
1068:
1069: /*
1070: * Parse the pager command into words.
1071: * Intentionally do not do anything fancy here.
1072: */
1073:
1074: argc = 0;
1075: while (argc + 4 < MAX_PAGER_ARGS) {
1076: argv[argc++] = cp;
1077: cp = strchr(cp, ' ');
1078: if (cp == NULL)
1079: break;
1080: *cp++ = '\0';
1081: while (*cp == ' ')
1082: cp++;
1083: if (*cp == '\0')
1084: break;
1085: }
1086:
1.268 schwarze 1087: /* For less(1), use the tag file. */
1.239 schwarze 1088:
1.244 schwarze 1089: if ((cmdlen = strlen(argv[0])) >= 4) {
1.239 schwarze 1090: cp = argv[0] + cmdlen - 4;
1.268 schwarze 1091: if (strcmp(cp, "less") == 0) {
1.244 schwarze 1092: argv[argc++] = mandoc_strdup("-T");
1093: argv[argc++] = tag_files->tfn;
1094: }
1.239 schwarze 1095: }
1.244 schwarze 1096: argv[argc++] = tag_files->ofn;
1.239 schwarze 1097: argv[argc] = NULL;
1098:
1.225 schwarze 1099: switch (pager_pid = fork()) {
1.183 schwarze 1100: case -1:
1.247 schwarze 1101: err((int)MANDOCLEVEL_SYSERR, "fork");
1.183 schwarze 1102: case 0:
1.224 schwarze 1103: break;
1104: default:
1.258 schwarze 1105: (void)setpgid(pager_pid, 0);
1.279 schwarze 1106: (void)tcsetpgrp(tag_files->ofd, pager_pid);
1.255 schwarze 1107: #if HAVE_PLEDGE
1.258 schwarze 1108: if (pledge("stdio rpath tmppath tty proc", NULL) == -1)
1.255 schwarze 1109: err((int)MANDOCLEVEL_SYSERR, "pledge");
1110: #endif
1.259 schwarze 1111: tag_files->pager_pid = pager_pid;
1.245 schwarze 1112: return pager_pid;
1.184 schwarze 1113: }
1114:
1.224 schwarze 1115: /* The child process becomes the pager. */
1.184 schwarze 1116:
1.247 schwarze 1117: if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
1118: err((int)MANDOCLEVEL_SYSERR, "pager stdout");
1.244 schwarze 1119: close(tag_files->ofd);
1120: close(tag_files->tfd);
1.265 schwarze 1121:
1122: /* Do not start the pager before controlling the terminal. */
1123:
1.279 schwarze 1124: while (tcgetpgrp(STDOUT_FILENO) != getpid())
1.265 schwarze 1125: nanosleep(&timeout, NULL);
1126:
1.184 schwarze 1127: execvp(argv[0], argv);
1.247 schwarze 1128: err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
1.71 kristaps 1129: }
CVSweb