Annotation of mandoc/main.c, Revision 1.285
1.285 ! schwarze 1: /* $Id: main.c,v 1.284 2017/02/22 14:58:48 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_INT,
60: OUTMODE_ONE
61: };
62:
1.19 kristaps 63: enum outt {
1.154 kristaps 64: OUTT_ASCII = 0, /* -Tascii */
1.162 kristaps 65: OUTT_LOCALE, /* -Tlocale */
1.163 kristaps 66: OUTT_UTF8, /* -Tutf8 */
1.154 kristaps 67: OUTT_TREE, /* -Ttree */
1.164 schwarze 68: OUTT_MAN, /* -Tman */
1.154 kristaps 69: OUTT_HTML, /* -Thtml */
1.285 ! schwarze 70: OUTT_MARKDOWN, /* -Tmarkdown */
1.154 kristaps 71: OUTT_LINT, /* -Tlint */
72: OUTT_PS, /* -Tps */
73: OUTT_PDF /* -Tpdf */
1.19 kristaps 74: };
75:
1.5 kristaps 76: struct curparse {
1.154 kristaps 77: struct mparse *mp;
1.148 kristaps 78: enum mandoclevel wlevel; /* ignore messages below this */
79: int wstop; /* stop after a file with a warning */
1.173 schwarze 80: enum outt outtype; /* which output to use */
1.79 kristaps 81: void *outdata; /* data for output */
1.230 schwarze 82: struct manoutput *outopts; /* output options */
1.79 kristaps 83: };
1.270 schwarze 84:
85:
86: int mandocdb(int, char *[]);
1.79 kristaps 87:
1.213 schwarze 88: static int fs_lookup(const struct manpaths *,
89: size_t ipath, const char *,
90: const char *, const char *,
91: struct manpage **, size_t *);
92: static void fs_search(const struct mansearch *,
93: const struct manpaths *, int, char**,
94: struct manpage **, size_t *);
1.194 schwarze 95: static int koptions(int *, char *);
1.170 schwarze 96: static int moptions(int *, char *);
1.155 kristaps 97: static void mmsg(enum mandocerr, enum mandoclevel,
98: const char *, int, int, const char *);
1.276 schwarze 99: static void outdata_alloc(struct curparse *);
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.283 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.282 schwarze 117: struct mansearch search;
1.5 kristaps 118: struct curparse curp;
1.244 schwarze 119: struct tag_files *tag_files;
1.282 schwarze 120: struct manpage *res, *resp;
121: const char *progname, *sec, *thisarg;
122: char *conf_file, *defpaths, *auxpaths;
123: char *defos, *oarg;
1.207 schwarze 124: unsigned char *uc;
1.264 schwarze 125: size_t i, sz;
1.230 schwarze 126: int prio, best_prio;
1.181 schwarze 127: enum outmode outmode;
1.192 schwarze 128: int fd;
1.180 schwarze 129: int show_usage;
1.170 schwarze 130: int options;
1.244 schwarze 131: int use_pager;
1.259 schwarze 132: int status, signum;
1.180 schwarze 133: int c;
1.259 schwarze 134: pid_t pager_pid, tc_pgid, man_pgid, pid;
1.1 kristaps 135:
1.254 schwarze 136: #if HAVE_PROGNAME
137: progname = getprogname();
138: #else
1.219 schwarze 139: if (argc < 1)
1.254 schwarze 140: progname = mandoc_strdup("mandoc");
141: else if ((progname = strrchr(argv[0], '/')) == NULL)
142: progname = argv[0];
1.54 kristaps 143: else
1.254 schwarze 144: ++progname;
145: setprogname(progname);
1.247 schwarze 146: #endif
1.203 schwarze 147:
1.254 schwarze 148: if (strncmp(progname, "mandocdb", 8) == 0 ||
149: strcmp(progname, BINM_MAKEWHATIS) == 0)
1.245 schwarze 150: return mandocdb(argc, argv);
1.179 schwarze 151:
1.255 schwarze 152: #if HAVE_PLEDGE
1.284 schwarze 153: if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1)
1.255 schwarze 154: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.269 kristaps 155: #endif
156:
157: #if HAVE_SANDBOX_INIT
158: if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1)
159: errx((int)MANDOCLEVEL_SYSERR, "sandbox_init");
1.255 schwarze 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";
1.282 schwarze 170: oarg = NULL;
1.180 schwarze 171:
1.254 schwarze 172: if (strcmp(progname, BINM_MAN) == 0)
1.180 schwarze 173: search.argmode = ARG_NAME;
1.254 schwarze 174: else if (strcmp(progname, BINM_APROPOS) == 0)
1.180 schwarze 175: search.argmode = ARG_EXPR;
1.254 schwarze 176: else if (strcmp(progname, BINM_WHATIS) == 0)
1.180 schwarze 177: search.argmode = ARG_WORD;
1.254 schwarze 178: else if (strncmp(progname, "help", 4) == 0)
1.202 schwarze 179: search.argmode = ARG_NAME;
1.180 schwarze 180: else
181: search.argmode = ARG_FILE;
182:
183: /* Parser and formatter options. */
1.54 kristaps 184:
1.51 kristaps 185: memset(&curp, 0, sizeof(struct curparse));
1.201 schwarze 186: curp.outtype = OUTT_LOCALE;
1.215 schwarze 187: curp.wlevel = MANDOCLEVEL_BADARG;
1.230 schwarze 188: curp.outopts = &conf.output;
1.194 schwarze 189: options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.166 schwarze 190: defos = NULL;
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.194 schwarze 197: while (-1 != (c = getopt(argc, argv,
198: "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
1.1 kristaps 199: switch (c) {
1.181 schwarze 200: case 'a':
201: outmode = OUTMODE_ALL;
202: break;
1.180 schwarze 203: case 'C':
204: conf_file = optarg;
205: break;
1.183 schwarze 206: case 'c':
1.244 schwarze 207: use_pager = 0;
1.183 schwarze 208: break;
1.180 schwarze 209: case 'f':
210: search.argmode = ARG_WORD;
211: break;
1.190 schwarze 212: case 'h':
1.230 schwarze 213: conf.output.synopsisonly = 1;
1.244 schwarze 214: use_pager = 0;
1.190 schwarze 215: outmode = OUTMODE_ALL;
216: break;
1.173 schwarze 217: case 'I':
1.166 schwarze 218: if (strncmp(optarg, "os=", 3)) {
1.247 schwarze 219: warnx("-I %s: Bad argument", optarg);
1.245 schwarze 220: return (int)MANDOCLEVEL_BADARG;
1.166 schwarze 221: }
222: if (defos) {
1.247 schwarze 223: warnx("-I %s: Duplicate argument", optarg);
1.245 schwarze 224: return (int)MANDOCLEVEL_BADARG;
1.166 schwarze 225: }
226: defos = mandoc_strdup(optarg + 3);
227: break;
1.181 schwarze 228: case 'i':
229: outmode = OUTMODE_INT;
230: break;
1.194 schwarze 231: case 'K':
232: if ( ! koptions(&options, optarg))
1.245 schwarze 233: return (int)MANDOCLEVEL_BADARG;
1.194 schwarze 234: break;
1.180 schwarze 235: case 'k':
236: search.argmode = ARG_EXPR;
237: break;
1.188 schwarze 238: case 'l':
239: search.argmode = ARG_FILE;
240: outmode = OUTMODE_ALL;
241: break;
1.180 schwarze 242: case 'M':
243: defpaths = optarg;
244: break;
1.173 schwarze 245: case 'm':
1.180 schwarze 246: auxpaths = optarg;
1.10 kristaps 247: break;
1.173 schwarze 248: case 'O':
1.282 schwarze 249: oarg = optarg;
1.44 kristaps 250: break;
1.180 schwarze 251: case 'S':
252: search.arch = optarg;
253: break;
254: case 's':
255: search.sec = optarg;
256: break;
1.173 schwarze 257: case 'T':
1.60 kristaps 258: if ( ! toptions(&curp, optarg))
1.245 schwarze 259: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 260: break;
1.173 schwarze 261: case 'W':
1.103 schwarze 262: if ( ! woptions(&curp, optarg))
1.245 schwarze 263: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 264: break;
1.181 schwarze 265: case 'w':
266: outmode = OUTMODE_FLN;
267: break;
1.1 kristaps 268: default:
1.180 schwarze 269: show_usage = 1;
270: break;
1.1 kristaps 271: }
1.180 schwarze 272: }
273:
274: if (show_usage)
275: usage(search.argmode);
276:
1.185 schwarze 277: /* Postprocess options. */
278:
1.181 schwarze 279: if (outmode == OUTMODE_DEF) {
280: switch (search.argmode) {
281: case ARG_FILE:
282: outmode = OUTMODE_ALL;
1.244 schwarze 283: use_pager = 0;
1.181 schwarze 284: break;
285: case ARG_NAME:
286: outmode = OUTMODE_ONE;
287: break;
288: default:
289: outmode = OUTMODE_LST;
290: break;
1.282 schwarze 291: }
292: }
293:
294: if (oarg != NULL) {
295: if (outmode == OUTMODE_LST)
296: search.outkey = oarg;
297: else {
298: while (oarg != NULL) {
299: thisarg = oarg;
300: if (manconf_output(&conf.output,
301: strsep(&oarg, ","), 0) == 0)
302: continue;
303: warnx("-O %s: Bad argument", thisarg);
304: return (int)MANDOCLEVEL_BADARG;
305: }
1.181 schwarze 306: }
307: }
308:
1.246 schwarze 309: if (outmode == OUTMODE_FLN ||
310: outmode == OUTMODE_LST ||
311: !isatty(STDOUT_FILENO))
312: use_pager = 0;
313:
1.255 schwarze 314: #if HAVE_PLEDGE
1.260 schwarze 315: if (!use_pager)
1.284 schwarze 316: if (pledge("stdio rpath", NULL) == -1)
1.260 schwarze 317: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.255 schwarze 318: #endif
319:
1.185 schwarze 320: /* Parse arguments. */
321:
1.219 schwarze 322: if (argc > 0) {
323: argc -= optind;
324: argv += optind;
325: }
1.186 schwarze 326: resp = NULL;
1.185 schwarze 327:
1.202 schwarze 328: /*
329: * Quirks for help(1)
330: * and for a man(1) section argument without -s.
331: */
332:
333: if (search.argmode == ARG_NAME) {
1.254 schwarze 334: if (*progname == 'h') {
1.202 schwarze 335: if (argc == 0) {
336: argv = help_argv;
337: argc = 1;
338: }
1.211 schwarze 339: } else if (argc > 1 &&
1.223 kristaps 340: ((uc = (unsigned char *)argv[0]) != NULL) &&
1.207 schwarze 341: ((isdigit(uc[0]) && (uc[1] == '\0' ||
342: (isalpha(uc[1]) && uc[2] == '\0'))) ||
343: (uc[0] == 'n' && uc[1] == '\0'))) {
1.223 kristaps 344: search.sec = (char *)uc;
1.202 schwarze 345: argv++;
346: argc--;
347: }
1.216 schwarze 348: if (search.arch == NULL)
349: search.arch = getenv("MACHINE");
1.223 kristaps 350: #ifdef MACHINE
1.216 schwarze 351: if (search.arch == NULL)
352: search.arch = MACHINE;
1.223 kristaps 353: #endif
1.185 schwarze 354: }
1.182 schwarze 355:
356: rc = MANDOCLEVEL_OK;
1.180 schwarze 357:
358: /* man(1), whatis(1), apropos(1) */
359:
360: if (search.argmode != ARG_FILE) {
1.199 schwarze 361: if (search.argmode == ARG_NAME &&
362: outmode == OUTMODE_ONE)
363: search.firstmatch = 1;
1.182 schwarze 364:
365: /* Access the mandoc database. */
366:
1.229 schwarze 367: manconf_parse(&conf, conf_file, defpaths, auxpaths);
368: if ( ! mansearch(&search, &conf.manpath,
369: argc, argv, &res, &sz))
1.180 schwarze 370: usage(search.argmode);
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.274 schwarze 473: else if (resp->form == FORM_SRC) {
1.189 schwarze 474: /* For .so only; ignore failure. */
1.229 schwarze 475: chdir(conf.manpath.paths[resp->ipath]);
1.227 schwarze 476: parse(&curp, fd, resp->file);
477: } else
1.230 schwarze 478: passthrough(resp->file, fd,
479: conf.output.synopsisonly);
1.212 schwarze 480:
1.276 schwarze 481: if (argc > 1 && curp.outtype <= OUTT_UTF8) {
482: if (curp.outdata == NULL)
483: outdata_alloc(&curp);
1.267 schwarze 484: terminal_sepline(curp.outdata);
1.276 schwarze 485: }
1.262 schwarze 486: } else if (rc < MANDOCLEVEL_ERROR)
487: rc = MANDOCLEVEL_ERROR;
1.192 schwarze 488:
1.154 kristaps 489: if (MANDOCLEVEL_OK != rc && curp.wstop)
1.64 kristaps 490: break;
1.210 schwarze 491:
1.212 schwarze 492: if (resp != NULL)
493: resp++;
494: else
495: argv++;
496: if (--argc)
497: mparse_reset(curp.mp);
1.1 kristaps 498: }
499:
1.252 schwarze 500: if (curp.outdata != NULL) {
501: switch (curp.outtype) {
502: case OUTT_HTML:
503: html_free(curp.outdata);
504: break;
505: case OUTT_UTF8:
506: case OUTT_LOCALE:
507: case OUTT_ASCII:
508: ascii_free(curp.outdata);
509: break;
510: case OUTT_PDF:
511: case OUTT_PS:
512: pspdf_free(curp.outdata);
513: break;
514: default:
515: break;
516: }
1.250 schwarze 517: }
1.195 schwarze 518: mparse_free(curp.mp);
1.249 schwarze 519: mchars_free();
1.182 schwarze 520:
521: out:
522: if (search.argmode != ARG_FILE) {
1.229 schwarze 523: manconf_free(&conf);
1.182 schwarze 524: mansearch_free(res, sz);
525: }
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:
1.279 schwarze 546: tc_pgid = tcgetpgrp(tag_files->ofd);
1.259 schwarze 547: if (tc_pgid != man_pgid) {
548: if (tc_pgid == pager_pid) {
1.279 schwarze 549: (void)tcsetpgrp(tag_files->ofd,
1.259 schwarze 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) {
1.279 schwarze 562: (void)tcsetpgrp(tag_files->ofd, pager_pid);
1.259 schwarze 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.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:
922: static int
1.170 schwarze 923: moptions(int *options, char *arg)
1.10 kristaps 924: {
925:
1.180 schwarze 926: if (arg == NULL)
927: /* nothing to do */;
928: else if (0 == strcmp(arg, "doc"))
1.170 schwarze 929: *options |= MPARSE_MDOC;
1.19 kristaps 930: else if (0 == strcmp(arg, "andoc"))
1.170 schwarze 931: /* nothing to do */;
1.17 kristaps 932: else if (0 == strcmp(arg, "an"))
1.170 schwarze 933: *options |= MPARSE_MAN;
1.10 kristaps 934: else {
1.247 schwarze 935: warnx("-m %s: Bad argument", arg);
1.245 schwarze 936: return 0;
1.10 kristaps 937: }
938:
1.245 schwarze 939: return 1;
1.1 kristaps 940: }
941:
942: static int
1.60 kristaps 943: toptions(struct curparse *curp, char *arg)
1.1 kristaps 944: {
945:
946: if (0 == strcmp(arg, "ascii"))
1.60 kristaps 947: curp->outtype = OUTT_ASCII;
948: else if (0 == strcmp(arg, "lint")) {
949: curp->outtype = OUTT_LINT;
1.103 schwarze 950: curp->wlevel = MANDOCLEVEL_WARNING;
1.154 kristaps 951: } else if (0 == strcmp(arg, "tree"))
1.60 kristaps 952: curp->outtype = OUTT_TREE;
1.164 schwarze 953: else if (0 == strcmp(arg, "man"))
954: curp->outtype = OUTT_MAN;
1.43 kristaps 955: else if (0 == strcmp(arg, "html"))
1.60 kristaps 956: curp->outtype = OUTT_HTML;
1.285 ! schwarze 957: else if (0 == strcmp(arg, "markdown"))
! 958: curp->outtype = OUTT_MARKDOWN;
1.163 kristaps 959: else if (0 == strcmp(arg, "utf8"))
960: curp->outtype = OUTT_UTF8;
1.162 kristaps 961: else if (0 == strcmp(arg, "locale"))
962: curp->outtype = OUTT_LOCALE;
1.59 kristaps 963: else if (0 == strcmp(arg, "xhtml"))
1.195 schwarze 964: curp->outtype = OUTT_HTML;
1.85 kristaps 965: else if (0 == strcmp(arg, "ps"))
966: curp->outtype = OUTT_PS;
1.100 kristaps 967: else if (0 == strcmp(arg, "pdf"))
968: curp->outtype = OUTT_PDF;
1.1 kristaps 969: else {
1.247 schwarze 970: warnx("-T %s: Bad argument", arg);
1.245 schwarze 971: return 0;
1.1 kristaps 972: }
973:
1.245 schwarze 974: return 1;
1.1 kristaps 975: }
976:
977: static int
1.103 schwarze 978: woptions(struct curparse *curp, char *arg)
1.1 kristaps 979: {
1.34 kristaps 980: char *v, *o;
1.217 schwarze 981: const char *toks[7];
1.1 kristaps 982:
1.103 schwarze 983: toks[0] = "stop";
984: toks[1] = "all";
985: toks[2] = "warning";
986: toks[3] = "error";
1.217 schwarze 987: toks[4] = "unsupp";
988: toks[5] = "fatal";
989: toks[6] = NULL;
1.1 kristaps 990:
1.34 kristaps 991: while (*arg) {
992: o = arg;
1.272 schwarze 993: switch (getsubopt(&arg, (char * const *)toks, &v)) {
1.173 schwarze 994: case 0:
1.103 schwarze 995: curp->wstop = 1;
1.1 kristaps 996: break;
1.173 schwarze 997: case 1:
998: case 2:
1.103 schwarze 999: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 1000: break;
1.173 schwarze 1001: case 3:
1.103 schwarze 1002: curp->wlevel = MANDOCLEVEL_ERROR;
1.24 kristaps 1003: break;
1.173 schwarze 1004: case 4:
1.217 schwarze 1005: curp->wlevel = MANDOCLEVEL_UNSUPP;
1006: break;
1007: case 5:
1.215 schwarze 1008: curp->wlevel = MANDOCLEVEL_BADARG;
1.50 kristaps 1009: break;
1.1 kristaps 1010: default:
1.247 schwarze 1011: warnx("-W %s: Bad argument", o);
1.245 schwarze 1012: return 0;
1.1 kristaps 1013: }
1.34 kristaps 1014: }
1.1 kristaps 1015:
1.245 schwarze 1016: return 1;
1.1 kristaps 1017: }
1018:
1.153 kristaps 1019: static void
1.173 schwarze 1020: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.155 kristaps 1021: const char *file, int line, int col, const char *msg)
1.71 kristaps 1022: {
1.177 schwarze 1023: const char *mparse_msg;
1.103 schwarze 1024:
1.275 schwarze 1025: fprintf(stderr, "%s: %s:", getprogname(),
1026: file == NULL ? "<stdin>" : file);
1.175 schwarze 1027:
1028: if (line)
1029: fprintf(stderr, "%d:%d:", line, col + 1);
1030:
1.177 schwarze 1031: fprintf(stderr, " %s", mparse_strlevel(lvl));
1032:
1033: if (NULL != (mparse_msg = mparse_strerror(t)))
1034: fprintf(stderr, ": %s", mparse_msg);
1.154 kristaps 1035:
1.73 kristaps 1036: if (msg)
1037: fprintf(stderr, ": %s", msg);
1.154 kristaps 1038:
1.73 kristaps 1039: fputc('\n', stderr);
1.183 schwarze 1040: }
1041:
1.225 schwarze 1042: static pid_t
1.244 schwarze 1043: spawn_pager(struct tag_files *tag_files)
1.183 schwarze 1044: {
1.265 schwarze 1045: const struct timespec timeout = { 0, 100000000 }; /* 0.1s */
1.184 schwarze 1046: #define MAX_PAGER_ARGS 16
1047: char *argv[MAX_PAGER_ARGS];
1048: const char *pager;
1049: char *cp;
1.239 schwarze 1050: size_t cmdlen;
1.184 schwarze 1051: int argc;
1.225 schwarze 1052: pid_t pager_pid;
1.183 schwarze 1053:
1.239 schwarze 1054: pager = getenv("MANPAGER");
1055: if (pager == NULL || *pager == '\0')
1056: pager = getenv("PAGER");
1057: if (pager == NULL || *pager == '\0')
1058: pager = "more -s";
1059: cp = mandoc_strdup(pager);
1060:
1061: /*
1062: * Parse the pager command into words.
1063: * Intentionally do not do anything fancy here.
1064: */
1065:
1066: argc = 0;
1067: while (argc + 4 < MAX_PAGER_ARGS) {
1068: argv[argc++] = cp;
1069: cp = strchr(cp, ' ');
1070: if (cp == NULL)
1071: break;
1072: *cp++ = '\0';
1073: while (*cp == ' ')
1074: cp++;
1075: if (*cp == '\0')
1076: break;
1077: }
1078:
1.268 schwarze 1079: /* For less(1), use the tag file. */
1.239 schwarze 1080:
1.244 schwarze 1081: if ((cmdlen = strlen(argv[0])) >= 4) {
1.239 schwarze 1082: cp = argv[0] + cmdlen - 4;
1.268 schwarze 1083: if (strcmp(cp, "less") == 0) {
1.244 schwarze 1084: argv[argc++] = mandoc_strdup("-T");
1085: argv[argc++] = tag_files->tfn;
1086: }
1.239 schwarze 1087: }
1.244 schwarze 1088: argv[argc++] = tag_files->ofn;
1.239 schwarze 1089: argv[argc] = NULL;
1090:
1.225 schwarze 1091: switch (pager_pid = fork()) {
1.183 schwarze 1092: case -1:
1.247 schwarze 1093: err((int)MANDOCLEVEL_SYSERR, "fork");
1.183 schwarze 1094: case 0:
1.224 schwarze 1095: break;
1096: default:
1.258 schwarze 1097: (void)setpgid(pager_pid, 0);
1.279 schwarze 1098: (void)tcsetpgrp(tag_files->ofd, pager_pid);
1.255 schwarze 1099: #if HAVE_PLEDGE
1.258 schwarze 1100: if (pledge("stdio rpath tmppath tty proc", NULL) == -1)
1.255 schwarze 1101: err((int)MANDOCLEVEL_SYSERR, "pledge");
1102: #endif
1.259 schwarze 1103: tag_files->pager_pid = pager_pid;
1.245 schwarze 1104: return pager_pid;
1.184 schwarze 1105: }
1106:
1.224 schwarze 1107: /* The child process becomes the pager. */
1.184 schwarze 1108:
1.247 schwarze 1109: if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
1110: err((int)MANDOCLEVEL_SYSERR, "pager stdout");
1.244 schwarze 1111: close(tag_files->ofd);
1112: close(tag_files->tfd);
1.265 schwarze 1113:
1114: /* Do not start the pager before controlling the terminal. */
1115:
1.279 schwarze 1116: while (tcgetpgrp(STDOUT_FILENO) != getpid())
1.265 schwarze 1117: nanosleep(&timeout, NULL);
1118:
1.184 schwarze 1119: execvp(argv[0], argv);
1.247 schwarze 1120: err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
1.71 kristaps 1121: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to main.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc