Annotation of src/usr.bin/mandoc/main.c, Revision 1.192
1.192 ! schwarze 1: /* $OpenBSD: main.c,v 1.191 2017/04/18 15:26:33 schwarze Exp $ */
1.1 kristaps 2: /*
1.95 schwarze 3: * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.181 schwarze 4: * Copyright (c) 2010-2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
1.86 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.2 schwarze 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.134 schwarze 11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.2 schwarze 12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.134 schwarze 13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.2 schwarze 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: */
19:
1.95 schwarze 20: #include <sys/types.h>
1.122 schwarze 21: #include <sys/param.h> /* MACHINE */
1.129 schwarze 22: #include <sys/wait.h>
1.95 schwarze 23:
1.1 kristaps 24: #include <assert.h>
1.95 schwarze 25: #include <ctype.h>
1.152 schwarze 26: #include <err.h>
1.165 schwarze 27: #include <errno.h>
1.95 schwarze 28: #include <fcntl.h>
1.127 schwarze 29: #include <glob.h>
1.131 schwarze 30: #include <signal.h>
1.1 kristaps 31: #include <stdio.h>
1.17 schwarze 32: #include <stdint.h>
1.1 kristaps 33: #include <stdlib.h>
34: #include <string.h>
1.172 schwarze 35: #include <time.h>
1.1 kristaps 36: #include <unistd.h>
37:
1.136 schwarze 38: #include "mandoc_aux.h"
1.30 schwarze 39: #include "mandoc.h"
1.136 schwarze 40: #include "roff.h"
1.1 kristaps 41: #include "mdoc.h"
42: #include "man.h"
1.144 schwarze 43: #include "tag.h"
1.136 schwarze 44: #include "main.h"
1.134 schwarze 45: #include "manconf.h"
1.95 schwarze 46: #include "mansearch.h"
47:
48: enum outmode {
49: OUTMODE_DEF = 0,
50: OUTMODE_FLN,
51: OUTMODE_LST,
52: OUTMODE_ALL,
53: OUTMODE_ONE
54: };
1.1 kristaps 55:
56: enum outt {
1.76 schwarze 57: OUTT_ASCII = 0, /* -Tascii */
1.77 schwarze 58: OUTT_LOCALE, /* -Tlocale */
59: OUTT_UTF8, /* -Tutf8 */
1.76 schwarze 60: OUTT_TREE, /* -Ttree */
1.78 schwarze 61: OUTT_MAN, /* -Tman */
1.76 schwarze 62: OUTT_HTML, /* -Thtml */
1.188 schwarze 63: OUTT_MARKDOWN, /* -Tmarkdown */
1.76 schwarze 64: OUTT_LINT, /* -Tlint */
65: OUTT_PS, /* -Tps */
66: OUTT_PDF /* -Tpdf */
1.1 kristaps 67: };
68:
69: struct curparse {
1.76 schwarze 70: struct mparse *mp;
1.75 schwarze 71: enum mandoclevel wlevel; /* ignore messages below this */
72: int wstop; /* stop after a file with a warning */
1.90 schwarze 73: enum outt outtype; /* which output to use */
1.33 schwarze 74: void *outdata; /* data for output */
1.135 schwarze 75: struct manoutput *outopts; /* output options */
1.33 schwarze 76: };
1.174 schwarze 77:
78:
79: int mandocdb(int, char *[]);
1.33 schwarze 80:
1.119 schwarze 81: static int fs_lookup(const struct manpaths *,
82: size_t ipath, const char *,
83: const char *, const char *,
84: struct manpage **, size_t *);
85: static void fs_search(const struct mansearch *,
86: const struct manpaths *, int, char**,
87: struct manpage **, size_t *);
1.103 schwarze 88: static int koptions(int *, char *);
1.189 schwarze 89: static void moptions(int *, char *);
1.76 schwarze 90: static void mmsg(enum mandocerr, enum mandoclevel,
91: const char *, int, int, const char *);
1.179 schwarze 92: static void outdata_alloc(struct curparse *);
1.132 schwarze 93: static void parse(struct curparse *, int, const char *);
94: static void passthrough(const char *, int, int);
1.149 schwarze 95: static pid_t spawn_pager(struct tag_files *);
1.27 schwarze 96: static int toptions(struct curparse *, char *);
1.184 schwarze 97: static void usage(enum argmode) __attribute__((__noreturn__));
1.45 schwarze 98: static int woptions(struct curparse *, char *);
1.1 kristaps 99:
1.95 schwarze 100: static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
1.110 schwarze 101: static char help_arg[] = "help";
102: static char *help_argv[] = {help_arg, NULL};
1.131 schwarze 103: static enum mandoclevel rc;
1.1 kristaps 104:
1.90 schwarze 105:
1.1 kristaps 106: int
107: main(int argc, char *argv[])
108: {
1.134 schwarze 109: struct manconf conf;
1.186 schwarze 110: struct mansearch search;
1.1 kristaps 111: struct curparse curp;
1.149 schwarze 112: struct tag_files *tag_files;
1.186 schwarze 113: struct manpage *res, *resp;
114: const char *progname, *sec, *thisarg;
115: char *conf_file, *defpaths, *auxpaths;
116: char *defos, *oarg;
1.113 schwarze 117: unsigned char *uc;
1.171 schwarze 118: size_t i, sz;
1.135 schwarze 119: int prio, best_prio;
1.95 schwarze 120: enum outmode outmode;
1.100 schwarze 121: int fd;
1.95 schwarze 122: int show_usage;
1.87 schwarze 123: int options;
1.149 schwarze 124: int use_pager;
1.166 schwarze 125: int status, signum;
1.95 schwarze 126: int c;
1.166 schwarze 127: pid_t pager_pid, tc_pgid, man_pgid, pid;
1.1 kristaps 128:
1.162 schwarze 129: progname = getprogname();
130: if (strncmp(progname, "mandocdb", 8) == 0 ||
131: strncmp(progname, "makewhatis", 10) == 0)
1.150 schwarze 132: return mandocdb(argc, argv);
1.19 schwarze 133:
1.187 schwarze 134: if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1)
1.163 schwarze 135: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.154 schwarze 136:
1.95 schwarze 137: /* Search options. */
138:
1.134 schwarze 139: memset(&conf, 0, sizeof(conf));
1.111 schwarze 140: conf_file = defpaths = NULL;
141: auxpaths = NULL;
1.95 schwarze 142:
143: memset(&search, 0, sizeof(struct mansearch));
144: search.outkey = "Nd";
1.186 schwarze 145: oarg = NULL;
1.95 schwarze 146:
1.162 schwarze 147: if (strcmp(progname, "man") == 0)
1.95 schwarze 148: search.argmode = ARG_NAME;
1.162 schwarze 149: else if (strncmp(progname, "apropos", 7) == 0)
1.95 schwarze 150: search.argmode = ARG_EXPR;
1.162 schwarze 151: else if (strncmp(progname, "whatis", 6) == 0)
1.95 schwarze 152: search.argmode = ARG_WORD;
1.162 schwarze 153: else if (strncmp(progname, "help", 4) == 0)
1.110 schwarze 154: search.argmode = ARG_NAME;
1.95 schwarze 155: else
156: search.argmode = ARG_FILE;
157:
158: /* Parser and formatter options. */
159:
1.19 schwarze 160: memset(&curp, 0, sizeof(struct curparse));
1.109 schwarze 161: curp.outtype = OUTT_LOCALE;
1.121 schwarze 162: curp.wlevel = MANDOCLEVEL_BADARG;
1.135 schwarze 163: curp.outopts = &conf.output;
1.103 schwarze 164: options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.83 schwarze 165: defos = NULL;
1.1 kristaps 166:
1.149 schwarze 167: use_pager = 1;
168: tag_files = NULL;
1.95 schwarze 169: show_usage = 0;
170: outmode = OUTMODE_DEF;
171:
1.192 ! schwarze 172: while ((c = getopt(argc, argv,
! 173: "aC:cfhI:iK:klM:m:O:S:s:T:VW:w")) != -1) {
! 174: if (c == 'i' && search.argmode == ARG_EXPR) {
! 175: optind--;
! 176: break;
! 177: }
1.1 kristaps 178: switch (c) {
1.95 schwarze 179: case 'a':
180: outmode = OUTMODE_ALL;
181: break;
182: case 'C':
183: conf_file = optarg;
184: break;
185: case 'c':
1.149 schwarze 186: use_pager = 0;
1.95 schwarze 187: break;
188: case 'f':
189: search.argmode = ARG_WORD;
190: break;
1.98 schwarze 191: case 'h':
1.135 schwarze 192: conf.output.synopsisonly = 1;
1.149 schwarze 193: use_pager = 0;
1.98 schwarze 194: outmode = OUTMODE_ALL;
195: break;
1.90 schwarze 196: case 'I':
1.83 schwarze 197: if (strncmp(optarg, "os=", 3)) {
1.152 schwarze 198: warnx("-I %s: Bad argument", optarg);
1.150 schwarze 199: return (int)MANDOCLEVEL_BADARG;
1.83 schwarze 200: }
201: if (defos) {
1.152 schwarze 202: warnx("-I %s: Duplicate argument", optarg);
1.150 schwarze 203: return (int)MANDOCLEVEL_BADARG;
1.83 schwarze 204: }
205: defos = mandoc_strdup(optarg + 3);
1.95 schwarze 206: break;
1.103 schwarze 207: case 'K':
208: if ( ! koptions(&options, optarg))
1.150 schwarze 209: return (int)MANDOCLEVEL_BADARG;
1.103 schwarze 210: break;
1.95 schwarze 211: case 'k':
212: search.argmode = ARG_EXPR;
213: break;
1.96 schwarze 214: case 'l':
215: search.argmode = ARG_FILE;
216: outmode = OUTMODE_ALL;
217: break;
1.95 schwarze 218: case 'M':
219: defpaths = optarg;
220: break;
1.90 schwarze 221: case 'm':
1.95 schwarze 222: auxpaths = optarg;
1.1 kristaps 223: break;
1.90 schwarze 224: case 'O':
1.186 schwarze 225: oarg = optarg;
1.17 schwarze 226: break;
1.95 schwarze 227: case 'S':
228: search.arch = optarg;
229: break;
230: case 's':
231: search.sec = optarg;
232: break;
1.90 schwarze 233: case 'T':
1.22 schwarze 234: if ( ! toptions(&curp, optarg))
1.150 schwarze 235: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 236: break;
1.90 schwarze 237: case 'W':
1.45 schwarze 238: if ( ! woptions(&curp, optarg))
1.150 schwarze 239: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 240: break;
1.95 schwarze 241: case 'w':
242: outmode = OUTMODE_FLN;
243: break;
1.1 kristaps 244: default:
1.95 schwarze 245: show_usage = 1;
246: break;
247: }
248: }
249:
250: if (show_usage)
251: usage(search.argmode);
252:
253: /* Postprocess options. */
254:
255: if (outmode == OUTMODE_DEF) {
256: switch (search.argmode) {
257: case ARG_FILE:
258: outmode = OUTMODE_ALL;
1.149 schwarze 259: use_pager = 0;
1.95 schwarze 260: break;
261: case ARG_NAME:
262: outmode = OUTMODE_ONE;
263: break;
264: default:
265: outmode = OUTMODE_LST;
266: break;
1.186 schwarze 267: }
268: }
269:
270: if (oarg != NULL) {
271: if (outmode == OUTMODE_LST)
272: search.outkey = oarg;
273: else {
274: while (oarg != NULL) {
275: thisarg = oarg;
276: if (manconf_output(&conf.output,
277: strsep(&oarg, ","), 0) == 0)
278: continue;
279: warnx("-O %s: Bad argument", thisarg);
280: return (int)MANDOCLEVEL_BADARG;
281: }
1.95 schwarze 282: }
283: }
284:
1.151 schwarze 285: if (outmode == OUTMODE_FLN ||
286: outmode == OUTMODE_LST ||
287: !isatty(STDOUT_FILENO))
288: use_pager = 0;
289:
1.167 schwarze 290: if (!use_pager)
1.187 schwarze 291: if (pledge("stdio rpath", NULL) == -1)
1.167 schwarze 292: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.154 schwarze 293:
1.95 schwarze 294: /* Parse arguments. */
295:
1.124 schwarze 296: if (argc > 0) {
297: argc -= optind;
298: argv += optind;
299: }
1.95 schwarze 300: resp = NULL;
301:
1.110 schwarze 302: /*
303: * Quirks for help(1)
304: * and for a man(1) section argument without -s.
305: */
306:
307: if (search.argmode == ARG_NAME) {
1.162 schwarze 308: if (*progname == 'h') {
1.110 schwarze 309: if (argc == 0) {
310: argv = help_argv;
311: argc = 1;
312: }
1.117 schwarze 313: } else if (argc > 1 &&
1.128 schwarze 314: ((uc = (unsigned char *)argv[0]) != NULL) &&
1.113 schwarze 315: ((isdigit(uc[0]) && (uc[1] == '\0' ||
316: (isalpha(uc[1]) && uc[2] == '\0'))) ||
317: (uc[0] == 'n' && uc[1] == '\0'))) {
1.128 schwarze 318: search.sec = (char *)uc;
1.110 schwarze 319: argv++;
320: argc--;
321: }
1.122 schwarze 322: if (search.arch == NULL)
323: search.arch = getenv("MACHINE");
324: if (search.arch == NULL)
325: search.arch = MACHINE;
1.95 schwarze 326: }
327:
328: rc = MANDOCLEVEL_OK;
329:
330: /* man(1), whatis(1), apropos(1) */
331:
332: if (search.argmode != ARG_FILE) {
1.107 schwarze 333: if (search.argmode == ARG_NAME &&
334: outmode == OUTMODE_ONE)
335: search.firstmatch = 1;
1.95 schwarze 336:
337: /* Access the mandoc database. */
338:
1.134 schwarze 339: manconf_parse(&conf, conf_file, defpaths, auxpaths);
340: if ( ! mansearch(&search, &conf.manpath,
341: argc, argv, &res, &sz))
1.95 schwarze 342: usage(search.argmode);
1.119 schwarze 343:
1.142 schwarze 344: if (sz == 0) {
345: if (search.argmode == ARG_NAME)
346: fs_search(&search, &conf.manpath,
347: argc, argv, &res, &sz);
348: else
1.152 schwarze 349: warnx("nothing appropriate");
1.142 schwarze 350: }
1.95 schwarze 351:
352: if (sz == 0) {
353: rc = MANDOCLEVEL_BADARG;
354: goto out;
355: }
356:
357: /*
358: * For standard man(1) and -a output mode,
359: * prepare for copying filename pointers
360: * into the program parameter array.
361: */
362:
363: if (outmode == OUTMODE_ONE) {
364: argc = 1;
1.171 schwarze 365: best_prio = 20;
1.95 schwarze 366: } else if (outmode == OUTMODE_ALL)
367: argc = (int)sz;
368:
369: /* Iterate all matching manuals. */
370:
1.119 schwarze 371: resp = res;
1.95 schwarze 372: for (i = 0; i < sz; i++) {
373: if (outmode == OUTMODE_FLN)
374: puts(res[i].file);
375: else if (outmode == OUTMODE_LST)
376: printf("%s - %s\n", res[i].names,
377: res[i].output == NULL ? "" :
378: res[i].output);
379: else if (outmode == OUTMODE_ONE) {
380: /* Search for the best section. */
1.171 schwarze 381: sec = res[i].file;
382: sec += strcspn(sec, "123456789");
383: if (sec[0] == '\0')
1.95 schwarze 384: continue;
1.171 schwarze 385: prio = sec_prios[sec[0] - '1'];
386: if (sec[1] != '/')
387: prio += 10;
1.95 schwarze 388: if (prio >= best_prio)
389: continue;
390: best_prio = prio;
391: resp = res + i;
392: }
1.1 kristaps 393: }
394:
1.95 schwarze 395: /*
396: * For man(1), -a and -i output mode, fall through
397: * to the main mandoc(1) code iterating files
398: * and running the parsers on each of them.
399: */
400:
401: if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
402: goto out;
403: }
404:
405: /* mandoc(1) */
1.157 schwarze 406:
1.167 schwarze 407: if (use_pager) {
408: if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1)
409: err((int)MANDOCLEVEL_SYSERR, "pledge");
410: } else {
411: if (pledge("stdio rpath", NULL) == -1)
412: err((int)MANDOCLEVEL_SYSERR, "pledge");
413: }
1.95 schwarze 414:
1.189 schwarze 415: if (search.argmode == ARG_FILE)
416: moptions(&options, auxpaths);
1.146 schwarze 417:
1.155 schwarze 418: mchars_alloc();
419: curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos);
1.76 schwarze 420:
1.80 schwarze 421: /*
422: * Conditionally start up the lookaside buffer before parsing.
423: */
424: if (OUTT_MAN == curp.outtype)
425: mparse_keep(curp.mp);
426:
1.124 schwarze 427: if (argc < 1) {
1.149 schwarze 428: if (use_pager)
429: tag_files = tag_init();
1.132 schwarze 430: parse(&curp, STDIN_FILENO, "<stdin>");
1.118 schwarze 431: }
1.27 schwarze 432:
1.124 schwarze 433: while (argc > 0) {
1.169 schwarze 434: fd = mparse_open(curp.mp, resp != NULL ? resp->file : *argv);
1.118 schwarze 435: if (fd != -1) {
1.149 schwarze 436: if (use_pager) {
437: tag_files = tag_init();
438: use_pager = 0;
439: }
1.118 schwarze 440:
441: if (resp == NULL)
1.132 schwarze 442: parse(&curp, fd, *argv);
1.177 schwarze 443: else if (resp->form == FORM_SRC) {
1.97 schwarze 444: /* For .so only; ignore failure. */
1.134 schwarze 445: chdir(conf.manpath.paths[resp->ipath]);
1.132 schwarze 446: parse(&curp, fd, resp->file);
447: } else
1.135 schwarze 448: passthrough(resp->file, fd,
449: conf.output.synopsisonly);
1.118 schwarze 450:
1.179 schwarze 451: if (argc > 1 && curp.outtype <= OUTT_UTF8) {
452: if (curp.outdata == NULL)
453: outdata_alloc(&curp);
1.173 schwarze 454: terminal_sepline(curp.outdata);
1.179 schwarze 455: }
1.169 schwarze 456: } else if (rc < MANDOCLEVEL_ERROR)
457: rc = MANDOCLEVEL_ERROR;
1.100 schwarze 458:
1.76 schwarze 459: if (MANDOCLEVEL_OK != rc && curp.wstop)
1.27 schwarze 460: break;
1.116 schwarze 461:
1.118 schwarze 462: if (resp != NULL)
463: resp++;
464: else
465: argv++;
466: if (--argc)
467: mparse_reset(curp.mp);
1.1 kristaps 468: }
469:
1.160 schwarze 470: if (curp.outdata != NULL) {
471: switch (curp.outtype) {
472: case OUTT_HTML:
473: html_free(curp.outdata);
474: break;
475: case OUTT_UTF8:
476: case OUTT_LOCALE:
477: case OUTT_ASCII:
478: ascii_free(curp.outdata);
479: break;
480: case OUTT_PDF:
481: case OUTT_PS:
482: pspdf_free(curp.outdata);
483: break;
484: default:
485: break;
486: }
1.158 schwarze 487: }
1.102 schwarze 488: mparse_free(curp.mp);
1.155 schwarze 489: mchars_free();
1.95 schwarze 490:
491: out:
492: if (search.argmode != ARG_FILE) {
1.134 schwarze 493: manconf_free(&conf);
1.95 schwarze 494: mansearch_free(res, sz);
495: }
496:
1.83 schwarze 497: free(defos);
1.1 kristaps 498:
1.129 schwarze 499: /*
1.149 schwarze 500: * When using a pager, finish writing both temporary files,
501: * fork it, wait for the user to close it, and clean up.
1.129 schwarze 502: */
503:
1.149 schwarze 504: if (tag_files != NULL) {
1.130 schwarze 505: fclose(stdout);
1.144 schwarze 506: tag_write();
1.166 schwarze 507: man_pgid = getpgid(0);
508: tag_files->tcpgid = man_pgid == getpid() ?
509: getpgid(getppid()) : man_pgid;
510: pager_pid = 0;
511: signum = SIGSTOP;
1.165 schwarze 512: for (;;) {
1.166 schwarze 513:
514: /* Stop here until moved to the foreground. */
515:
1.182 schwarze 516: tc_pgid = tcgetpgrp(tag_files->ofd);
1.166 schwarze 517: if (tc_pgid != man_pgid) {
518: if (tc_pgid == pager_pid) {
1.182 schwarze 519: (void)tcsetpgrp(tag_files->ofd,
1.166 schwarze 520: man_pgid);
521: if (signum == SIGTTIN)
522: continue;
523: } else
524: tag_files->tcpgid = tc_pgid;
525: kill(0, signum);
526: continue;
527: }
528:
529: /* Once in the foreground, activate the pager. */
530:
531: if (pager_pid) {
1.182 schwarze 532: (void)tcsetpgrp(tag_files->ofd, pager_pid);
1.166 schwarze 533: kill(pager_pid, SIGCONT);
534: } else
535: pager_pid = spawn_pager(tag_files);
536:
537: /* Wait for the pager to stop or exit. */
538:
539: while ((pid = waitpid(pager_pid, &status,
540: WUNTRACED)) == -1 && errno == EINTR)
541: continue;
542:
543: if (pid == -1) {
1.165 schwarze 544: warn("wait");
545: rc = MANDOCLEVEL_SYSERR;
546: break;
547: }
548: if (!WIFSTOPPED(status))
549: break;
550:
1.166 schwarze 551: signum = WSTOPSIG(status);
1.165 schwarze 552: }
1.144 schwarze 553: tag_unlink();
1.130 schwarze 554: }
1.129 schwarze 555:
1.150 schwarze 556: return (int)rc;
1.1 kristaps 557: }
558:
1.20 schwarze 559: static void
1.95 schwarze 560: usage(enum argmode argmode)
1.1 kristaps 561: {
562:
1.95 schwarze 563: switch (argmode) {
564: case ARG_FILE:
1.190 schwarze 565: fputs("usage: mandoc [-ac] [-I os=name] "
566: "[-K encoding] [-mdoc | -man] [-O options]\n"
1.133 schwarze 567: "\t [-T output] [-W level] [file ...]\n", stderr);
1.95 schwarze 568: break;
569: case ARG_NAME:
1.190 schwarze 570: fputs("usage: man [-acfhklw] [-C file] [-M path] "
571: "[-m path] [-S subsection]\n"
572: "\t [[-s] section] name ...\n", stderr);
1.95 schwarze 573: break;
574: case ARG_WORD:
1.190 schwarze 575: fputs("usage: whatis [-afk] [-C file] "
1.96 schwarze 576: "[-M path] [-m path] [-O outkey] [-S arch]\n"
577: "\t [-s section] name ...\n", stderr);
1.95 schwarze 578: break;
579: case ARG_EXPR:
1.190 schwarze 580: fputs("usage: apropos [-afk] [-C file] "
1.96 schwarze 581: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.95 schwarze 582: "\t [-s section] expression ...\n", stderr);
583: break;
584: }
1.47 schwarze 585: exit((int)MANDOCLEVEL_BADARG);
1.119 schwarze 586: }
587:
588: static int
589: fs_lookup(const struct manpaths *paths, size_t ipath,
590: const char *sec, const char *arch, const char *name,
591: struct manpage **res, size_t *ressz)
592: {
1.127 schwarze 593: glob_t globinfo;
1.119 schwarze 594: struct manpage *page;
595: char *file;
1.177 schwarze 596: int globres;
597: enum form form;
1.119 schwarze 598:
1.127 schwarze 599: form = FORM_SRC;
1.119 schwarze 600: mandoc_asprintf(&file, "%s/man%s/%s.%s",
601: paths->paths[ipath], sec, name, sec);
1.127 schwarze 602: if (access(file, R_OK) != -1)
1.119 schwarze 603: goto found;
604: free(file);
605:
606: mandoc_asprintf(&file, "%s/cat%s/%s.0",
607: paths->paths[ipath], sec, name);
608: if (access(file, R_OK) != -1) {
609: form = FORM_CAT;
610: goto found;
611: }
612: free(file);
613:
614: if (arch != NULL) {
615: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
616: paths->paths[ipath], sec, arch, name, sec);
1.127 schwarze 617: if (access(file, R_OK) != -1)
1.119 schwarze 618: goto found;
619: free(file);
620: }
1.127 schwarze 621:
1.145 schwarze 622: mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",
1.127 schwarze 623: paths->paths[ipath], sec, name);
624: globres = glob(file, 0, NULL, &globinfo);
625: if (globres != 0 && globres != GLOB_NOMATCH)
1.152 schwarze 626: warn("%s: glob", file);
1.127 schwarze 627: free(file);
628: if (globres == 0)
629: file = mandoc_strdup(*globinfo.gl_pathv);
630: globfree(&globinfo);
631: if (globres != 0)
1.150 schwarze 632: return 0;
1.119 schwarze 633:
634: found:
1.152 schwarze 635: warnx("outdated mandoc.db lacks %s(%s) entry, run makewhatis %s",
636: name, sec, paths->paths[ipath]);
1.119 schwarze 637: *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
638: page = *res + (*ressz - 1);
639: page->file = file;
640: page->names = NULL;
641: page->output = NULL;
642: page->ipath = ipath;
643: page->bits = NAME_FILE & NAME_MASK;
644: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
645: page->form = form;
1.150 schwarze 646: return 1;
1.119 schwarze 647: }
648:
649: static void
650: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
651: int argc, char **argv, struct manpage **res, size_t *ressz)
652: {
653: const char *const sections[] =
1.171 schwarze 654: {"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"};
1.119 schwarze 655: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
656:
657: size_t ipath, isec, lastsz;
658:
659: assert(cfg->argmode == ARG_NAME);
660:
661: *res = NULL;
662: *ressz = lastsz = 0;
663: while (argc) {
664: for (ipath = 0; ipath < paths->sz; ipath++) {
665: if (cfg->sec != NULL) {
666: if (fs_lookup(paths, ipath, cfg->sec,
667: cfg->arch, *argv, res, ressz) &&
668: cfg->firstmatch)
669: return;
670: } else for (isec = 0; isec < nsec; isec++)
671: if (fs_lookup(paths, ipath, sections[isec],
672: cfg->arch, *argv, res, ressz) &&
673: cfg->firstmatch)
674: return;
675: }
676: if (*ressz == lastsz)
1.152 schwarze 677: warnx("No entry for %s in the manual.", *argv);
1.119 schwarze 678: lastsz = *ressz;
679: argv++;
680: argc--;
681: }
1.1 kristaps 682: }
683:
1.27 schwarze 684: static void
1.132 schwarze 685: parse(struct curparse *curp, int fd, const char *file)
1.52 schwarze 686: {
1.132 schwarze 687: enum mandoclevel rctmp;
1.139 schwarze 688: struct roff_man *man;
1.52 schwarze 689:
1.76 schwarze 690: /* Begin by parsing the file itself. */
1.52 schwarze 691:
1.76 schwarze 692: assert(file);
1.170 florian 693: assert(fd >= 0);
1.52 schwarze 694:
1.132 schwarze 695: rctmp = mparse_readfd(curp->mp, fd, file);
1.168 schwarze 696: if (fd != STDIN_FILENO)
697: close(fd);
1.132 schwarze 698: if (rc < rctmp)
699: rc = rctmp;
1.1 kristaps 700:
1.51 schwarze 701: /*
1.76 schwarze 702: * With -Wstop and warnings or errors of at least the requested
703: * level, do not produce output.
1.51 schwarze 704: */
705:
1.132 schwarze 706: if (rctmp != MANDOCLEVEL_OK && curp->wstop)
707: return;
1.51 schwarze 708:
1.179 schwarze 709: if (curp->outdata == NULL)
710: outdata_alloc(curp);
1.51 schwarze 711:
1.158 schwarze 712: mparse_result(curp->mp, &man, NULL);
713:
714: /* Execute the out device, if it exists. */
715:
716: if (man == NULL)
717: return;
718: if (man->macroset == MACROSET_MDOC) {
1.185 schwarze 719: if (curp->outtype != OUTT_TREE || !curp->outopts->noval)
720: mdoc_validate(man);
1.51 schwarze 721: switch (curp->outtype) {
1.90 schwarze 722: case OUTT_HTML:
1.158 schwarze 723: html_mdoc(curp->outdata, man);
1.51 schwarze 724: break;
1.90 schwarze 725: case OUTT_TREE:
1.158 schwarze 726: tree_mdoc(curp->outdata, man);
1.51 schwarze 727: break;
1.90 schwarze 728: case OUTT_MAN:
1.158 schwarze 729: man_mdoc(curp->outdata, man);
1.78 schwarze 730: break;
1.90 schwarze 731: case OUTT_PDF:
732: case OUTT_ASCII:
733: case OUTT_UTF8:
734: case OUTT_LOCALE:
735: case OUTT_PS:
1.158 schwarze 736: terminal_mdoc(curp->outdata, man);
737: break;
1.188 schwarze 738: case OUTT_MARKDOWN:
739: markdown_mdoc(curp->outdata, man);
740: break;
1.158 schwarze 741: default:
742: break;
743: }
744: }
745: if (man->macroset == MACROSET_MAN) {
1.185 schwarze 746: if (curp->outtype != OUTT_TREE || !curp->outopts->noval)
747: man_validate(man);
1.158 schwarze 748: switch (curp->outtype) {
749: case OUTT_HTML:
750: html_man(curp->outdata, man);
751: break;
752: case OUTT_TREE:
753: tree_man(curp->outdata, man);
754: break;
755: case OUTT_MAN:
756: man_man(curp->outdata, man);
757: break;
758: case OUTT_PDF:
759: case OUTT_ASCII:
760: case OUTT_UTF8:
761: case OUTT_LOCALE:
762: case OUTT_PS:
763: terminal_man(curp->outdata, man);
1.51 schwarze 764: break;
765: default:
766: break;
767: }
1.179 schwarze 768: }
1.181 schwarze 769: mparse_updaterc(curp->mp, &rc);
1.179 schwarze 770: }
771:
772: static void
773: outdata_alloc(struct curparse *curp)
774: {
775: switch (curp->outtype) {
776: case OUTT_HTML:
777: curp->outdata = html_alloc(curp->outopts);
778: break;
779: case OUTT_UTF8:
780: curp->outdata = utf8_alloc(curp->outopts);
781: break;
782: case OUTT_LOCALE:
783: curp->outdata = locale_alloc(curp->outopts);
784: break;
785: case OUTT_ASCII:
786: curp->outdata = ascii_alloc(curp->outopts);
787: break;
788: case OUTT_PDF:
789: curp->outdata = pdf_alloc(curp->outopts);
790: break;
791: case OUTT_PS:
792: curp->outdata = ps_alloc(curp->outopts);
793: break;
794: default:
795: break;
1.51 schwarze 796: }
1.1 kristaps 797: }
798:
1.132 schwarze 799: static void
1.105 schwarze 800: passthrough(const char *file, int fd, int synopsis_only)
1.95 schwarze 801: {
1.105 schwarze 802: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
803: const char synr[] = "SYNOPSIS";
804:
805: FILE *stream;
1.95 schwarze 806: const char *syscall;
1.164 schwarze 807: char *line, *cp;
808: size_t linesz;
1.180 schwarze 809: ssize_t len, written;
1.105 schwarze 810: int print;
1.116 schwarze 811:
1.164 schwarze 812: line = NULL;
813: linesz = 0;
1.105 schwarze 814:
1.180 schwarze 815: if (fflush(stdout) == EOF) {
816: syscall = "fflush";
817: goto fail;
818: }
819:
1.105 schwarze 820: if ((stream = fdopen(fd, "r")) == NULL) {
821: close(fd);
822: syscall = "fdopen";
823: goto fail;
824: }
1.95 schwarze 825:
1.105 schwarze 826: print = 0;
1.180 schwarze 827: while ((len = getline(&line, &linesz, stream)) != -1) {
1.164 schwarze 828: cp = line;
1.105 schwarze 829: if (synopsis_only) {
830: if (print) {
1.164 schwarze 831: if ( ! isspace((unsigned char)*cp))
1.105 schwarze 832: goto done;
1.180 schwarze 833: while (isspace((unsigned char)*cp)) {
1.164 schwarze 834: cp++;
1.180 schwarze 835: len--;
836: }
1.105 schwarze 837: } else {
1.164 schwarze 838: if (strcmp(cp, synb) == 0 ||
839: strcmp(cp, synr) == 0)
1.105 schwarze 840: print = 1;
841: continue;
842: }
843: }
1.180 schwarze 844: for (; len > 0; len -= written) {
845: if ((written = write(STDOUT_FILENO, cp, len)) != -1)
846: continue;
1.164 schwarze 847: fclose(stream);
1.180 schwarze 848: syscall = "write";
1.164 schwarze 849: goto fail;
850: }
1.105 schwarze 851: }
1.95 schwarze 852:
1.105 schwarze 853: if (ferror(stream)) {
854: fclose(stream);
1.164 schwarze 855: syscall = "getline";
1.105 schwarze 856: goto fail;
857: }
1.101 schwarze 858:
1.105 schwarze 859: done:
1.164 schwarze 860: free(line);
1.105 schwarze 861: fclose(stream);
1.132 schwarze 862: return;
1.95 schwarze 863:
864: fail:
1.164 schwarze 865: free(line);
1.152 schwarze 866: warn("%s: SYSERR: %s", file, syscall);
1.132 schwarze 867: if (rc < MANDOCLEVEL_SYSERR)
868: rc = MANDOCLEVEL_SYSERR;
1.103 schwarze 869: }
870:
871: static int
872: koptions(int *options, char *arg)
873: {
874:
875: if ( ! strcmp(arg, "utf-8")) {
876: *options |= MPARSE_UTF8;
877: *options &= ~MPARSE_LATIN1;
878: } else if ( ! strcmp(arg, "iso-8859-1")) {
879: *options |= MPARSE_LATIN1;
880: *options &= ~MPARSE_UTF8;
881: } else if ( ! strcmp(arg, "us-ascii")) {
882: *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
883: } else {
1.152 schwarze 884: warnx("-K %s: Bad argument", arg);
1.150 schwarze 885: return 0;
1.103 schwarze 886: }
1.150 schwarze 887: return 1;
1.95 schwarze 888: }
889:
1.189 schwarze 890: static void
1.87 schwarze 891: moptions(int *options, char *arg)
1.1 kristaps 892: {
893:
1.95 schwarze 894: if (arg == NULL)
1.189 schwarze 895: return;
896: if (strcmp(arg, "doc") == 0)
1.87 schwarze 897: *options |= MPARSE_MDOC;
1.189 schwarze 898: else if (strcmp(arg, "an") == 0)
1.87 schwarze 899: *options |= MPARSE_MAN;
1.1 kristaps 900: }
901:
902: static int
1.22 schwarze 903: toptions(struct curparse *curp, char *arg)
1.1 kristaps 904: {
905:
906: if (0 == strcmp(arg, "ascii"))
1.22 schwarze 907: curp->outtype = OUTT_ASCII;
908: else if (0 == strcmp(arg, "lint")) {
909: curp->outtype = OUTT_LINT;
1.45 schwarze 910: curp->wlevel = MANDOCLEVEL_WARNING;
1.76 schwarze 911: } else if (0 == strcmp(arg, "tree"))
1.22 schwarze 912: curp->outtype = OUTT_TREE;
1.78 schwarze 913: else if (0 == strcmp(arg, "man"))
914: curp->outtype = OUTT_MAN;
1.17 schwarze 915: else if (0 == strcmp(arg, "html"))
1.22 schwarze 916: curp->outtype = OUTT_HTML;
1.188 schwarze 917: else if (0 == strcmp(arg, "markdown"))
918: curp->outtype = OUTT_MARKDOWN;
1.77 schwarze 919: else if (0 == strcmp(arg, "utf8"))
920: curp->outtype = OUTT_UTF8;
921: else if (0 == strcmp(arg, "locale"))
922: curp->outtype = OUTT_LOCALE;
1.21 schwarze 923: else if (0 == strcmp(arg, "xhtml"))
1.102 schwarze 924: curp->outtype = OUTT_HTML;
1.36 schwarze 925: else if (0 == strcmp(arg, "ps"))
926: curp->outtype = OUTT_PS;
1.43 schwarze 927: else if (0 == strcmp(arg, "pdf"))
928: curp->outtype = OUTT_PDF;
1.1 kristaps 929: else {
1.152 schwarze 930: warnx("-T %s: Bad argument", arg);
1.150 schwarze 931: return 0;
1.1 kristaps 932: }
933:
1.150 schwarze 934: return 1;
1.1 kristaps 935: }
936:
937: static int
1.45 schwarze 938: woptions(struct curparse *curp, char *arg)
1.1 kristaps 939: {
1.10 schwarze 940: char *v, *o;
1.123 schwarze 941: const char *toks[7];
1.1 kristaps 942:
1.45 schwarze 943: toks[0] = "stop";
944: toks[1] = "all";
945: toks[2] = "warning";
946: toks[3] = "error";
1.123 schwarze 947: toks[4] = "unsupp";
948: toks[5] = "fatal";
949: toks[6] = NULL;
1.1 kristaps 950:
1.10 schwarze 951: while (*arg) {
952: o = arg;
1.176 schwarze 953: switch (getsubopt(&arg, (char * const *)toks, &v)) {
1.90 schwarze 954: case 0:
1.45 schwarze 955: curp->wstop = 1;
1.1 kristaps 956: break;
1.90 schwarze 957: case 1:
958: case 2:
1.45 schwarze 959: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 960: break;
1.90 schwarze 961: case 3:
1.45 schwarze 962: curp->wlevel = MANDOCLEVEL_ERROR;
1.1 kristaps 963: break;
1.90 schwarze 964: case 4:
1.123 schwarze 965: curp->wlevel = MANDOCLEVEL_UNSUPP;
966: break;
967: case 5:
1.121 schwarze 968: curp->wlevel = MANDOCLEVEL_BADARG;
1.19 schwarze 969: break;
1.1 kristaps 970: default:
1.152 schwarze 971: warnx("-W %s: Bad argument", o);
1.150 schwarze 972: return 0;
1.1 kristaps 973: }
1.10 schwarze 974: }
1.1 kristaps 975:
1.150 schwarze 976: return 1;
1.1 kristaps 977: }
978:
1.75 schwarze 979: static void
1.90 schwarze 980: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.76 schwarze 981: const char *file, int line, int col, const char *msg)
1.30 schwarze 982: {
1.94 schwarze 983: const char *mparse_msg;
1.45 schwarze 984:
1.178 schwarze 985: fprintf(stderr, "%s: %s:", getprogname(),
986: file == NULL ? "<stdin>" : file);
1.92 schwarze 987:
988: if (line)
989: fprintf(stderr, "%d:%d:", line, col + 1);
990:
1.94 schwarze 991: fprintf(stderr, " %s", mparse_strlevel(lvl));
992:
993: if (NULL != (mparse_msg = mparse_strerror(t)))
994: fprintf(stderr, ": %s", mparse_msg);
1.30 schwarze 995:
996: if (msg)
997: fprintf(stderr, ": %s", msg);
1.76 schwarze 998:
1.30 schwarze 999: fputc('\n', stderr);
1.95 schwarze 1000: }
1001:
1.130 schwarze 1002: static pid_t
1.149 schwarze 1003: spawn_pager(struct tag_files *tag_files)
1.95 schwarze 1004: {
1.172 schwarze 1005: const struct timespec timeout = { 0, 100000000 }; /* 0.1s */
1.95 schwarze 1006: #define MAX_PAGER_ARGS 16
1007: char *argv[MAX_PAGER_ARGS];
1008: const char *pager;
1009: char *cp;
1.144 schwarze 1010: size_t cmdlen;
1.95 schwarze 1011: int argc;
1.130 schwarze 1012: pid_t pager_pid;
1.95 schwarze 1013:
1.144 schwarze 1014: pager = getenv("MANPAGER");
1015: if (pager == NULL || *pager == '\0')
1016: pager = getenv("PAGER");
1017: if (pager == NULL || *pager == '\0')
1018: pager = "more -s";
1019: cp = mandoc_strdup(pager);
1020:
1021: /*
1022: * Parse the pager command into words.
1023: * Intentionally do not do anything fancy here.
1024: */
1025:
1026: argc = 0;
1027: while (argc + 4 < MAX_PAGER_ARGS) {
1028: argv[argc++] = cp;
1029: cp = strchr(cp, ' ');
1030: if (cp == NULL)
1031: break;
1032: *cp++ = '\0';
1033: while (*cp == ' ')
1034: cp++;
1035: if (*cp == '\0')
1036: break;
1037: }
1038:
1.149 schwarze 1039: /* For more(1) and less(1), use the tag file. */
1.144 schwarze 1040:
1.149 schwarze 1041: if ((cmdlen = strlen(argv[0])) >= 4) {
1.144 schwarze 1042: cp = argv[0] + cmdlen - 4;
1.149 schwarze 1043: if (strcmp(cp, "less") == 0 || strcmp(cp, "more") == 0) {
1044: argv[argc++] = mandoc_strdup("-T");
1045: argv[argc++] = tag_files->tfn;
1046: }
1.144 schwarze 1047: }
1.149 schwarze 1048: argv[argc++] = tag_files->ofn;
1.144 schwarze 1049: argv[argc] = NULL;
1050:
1.130 schwarze 1051: switch (pager_pid = fork()) {
1.95 schwarze 1052: case -1:
1.152 schwarze 1053: err((int)MANDOCLEVEL_SYSERR, "fork");
1.95 schwarze 1054: case 0:
1.129 schwarze 1055: break;
1056: default:
1.165 schwarze 1057: (void)setpgid(pager_pid, 0);
1.182 schwarze 1058: (void)tcsetpgrp(tag_files->ofd, pager_pid);
1.165 schwarze 1059: if (pledge("stdio rpath tmppath tty proc", NULL) == -1)
1.163 schwarze 1060: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.166 schwarze 1061: tag_files->pager_pid = pager_pid;
1.150 schwarze 1062: return pager_pid;
1.95 schwarze 1063: }
1064:
1.129 schwarze 1065: /* The child process becomes the pager. */
1.95 schwarze 1066:
1.152 schwarze 1067: if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
1068: err((int)MANDOCLEVEL_SYSERR, "pager stdout");
1.149 schwarze 1069: close(tag_files->ofd);
1070: close(tag_files->tfd);
1.172 schwarze 1071:
1072: /* Do not start the pager before controlling the terminal. */
1073:
1.182 schwarze 1074: while (tcgetpgrp(STDOUT_FILENO) != getpid())
1.172 schwarze 1075: nanosleep(&timeout, NULL);
1076:
1.95 schwarze 1077: execvp(argv[0], argv);
1.152 schwarze 1078: err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
1.30 schwarze 1079: }
![[BACK]](/icons/back.gif){kind=icon}
Return to main.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc