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