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