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