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