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