Annotation of src/usr.bin/mandoc/main.c, Revision 1.171
1.171 ! schwarze 1: /* $OpenBSD: main.c,v 1.170 2016/01/16 21:56:32 florian Exp $ */
1.1 kristaps 2: /*
1.95 schwarze 3: * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.169 schwarze 4: * Copyright (c) 2010-2012, 2014-2016 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>
35: #include <unistd.h>
36:
1.136 schwarze 37: #include "mandoc_aux.h"
1.30 schwarze 38: #include "mandoc.h"
1.136 schwarze 39: #include "roff.h"
1.1 kristaps 40: #include "mdoc.h"
41: #include "man.h"
1.144 schwarze 42: #include "tag.h"
1.136 schwarze 43: #include "main.h"
1.134 schwarze 44: #include "manconf.h"
1.95 schwarze 45: #include "mansearch.h"
46:
47: enum outmode {
48: OUTMODE_DEF = 0,
49: OUTMODE_FLN,
50: OUTMODE_LST,
51: OUTMODE_ALL,
52: OUTMODE_INT,
53: OUTMODE_ONE
54: };
1.1 kristaps 55:
56: enum outt {
1.76 schwarze 57: OUTT_ASCII = 0, /* -Tascii */
1.77 schwarze 58: OUTT_LOCALE, /* -Tlocale */
59: OUTT_UTF8, /* -Tutf8 */
1.76 schwarze 60: OUTT_TREE, /* -Ttree */
1.78 schwarze 61: OUTT_MAN, /* -Tman */
1.76 schwarze 62: OUTT_HTML, /* -Thtml */
63: OUTT_LINT, /* -Tlint */
64: OUTT_PS, /* -Tps */
65: OUTT_PDF /* -Tpdf */
1.1 kristaps 66: };
67:
68: struct curparse {
1.76 schwarze 69: struct mparse *mp;
1.75 schwarze 70: enum mandoclevel wlevel; /* ignore messages below this */
71: int wstop; /* stop after a file with a warning */
1.90 schwarze 72: enum outt outtype; /* which output to use */
1.33 schwarze 73: void *outdata; /* data for output */
1.135 schwarze 74: struct manoutput *outopts; /* output options */
1.33 schwarze 75: };
76:
1.119 schwarze 77: static int fs_lookup(const struct manpaths *,
78: size_t ipath, const char *,
79: const char *, const char *,
80: struct manpage **, size_t *);
81: static void fs_search(const struct mansearch *,
82: const struct manpaths *, int, char**,
83: struct manpage **, size_t *);
1.103 schwarze 84: static int koptions(int *, char *);
1.79 schwarze 85: int mandocdb(int, char**);
1.87 schwarze 86: static int moptions(int *, char *);
1.76 schwarze 87: static void mmsg(enum mandocerr, enum mandoclevel,
88: const char *, int, int, const char *);
1.132 schwarze 89: static void parse(struct curparse *, int, const char *);
90: static void passthrough(const char *, int, int);
1.149 schwarze 91: static pid_t spawn_pager(struct tag_files *);
1.27 schwarze 92: static int toptions(struct curparse *, char *);
1.95 schwarze 93: static void usage(enum argmode) __attribute__((noreturn));
1.45 schwarze 94: static int woptions(struct curparse *, char *);
1.1 kristaps 95:
1.95 schwarze 96: static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
1.110 schwarze 97: static char help_arg[] = "help";
98: static char *help_argv[] = {help_arg, NULL};
1.131 schwarze 99: static enum mandoclevel rc;
1.1 kristaps 100:
1.90 schwarze 101:
1.1 kristaps 102: int
103: main(int argc, char *argv[])
104: {
1.134 schwarze 105: struct manconf conf;
1.1 kristaps 106: struct curparse curp;
1.95 schwarze 107: struct mansearch search;
1.149 schwarze 108: struct tag_files *tag_files;
1.162 schwarze 109: const char *progname;
1.111 schwarze 110: char *auxpaths;
1.95 schwarze 111: char *defos;
1.113 schwarze 112: unsigned char *uc;
1.95 schwarze 113: struct manpage *res, *resp;
1.111 schwarze 114: char *conf_file, *defpaths;
1.171 ! schwarze 115: const char *sec;
! 116: size_t i, sz;
1.135 schwarze 117: int prio, best_prio;
1.95 schwarze 118: enum outmode outmode;
1.100 schwarze 119: int fd;
1.95 schwarze 120: int show_usage;
1.87 schwarze 121: int options;
1.149 schwarze 122: int use_pager;
1.166 schwarze 123: int status, signum;
1.95 schwarze 124: int c;
1.166 schwarze 125: pid_t pager_pid, tc_pgid, man_pgid, pid;
1.1 kristaps 126:
1.162 schwarze 127: progname = getprogname();
128: if (strncmp(progname, "mandocdb", 8) == 0 ||
129: strncmp(progname, "makewhatis", 10) == 0)
1.150 schwarze 130: return mandocdb(argc, argv);
1.19 schwarze 131:
1.165 schwarze 132: if (pledge("stdio rpath tmppath tty proc exec flock", NULL) == -1)
1.163 schwarze 133: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.154 schwarze 134:
1.95 schwarze 135: /* Search options. */
136:
1.134 schwarze 137: memset(&conf, 0, sizeof(conf));
1.111 schwarze 138: conf_file = defpaths = NULL;
139: auxpaths = NULL;
1.95 schwarze 140:
141: memset(&search, 0, sizeof(struct mansearch));
142: search.outkey = "Nd";
143:
1.162 schwarze 144: if (strcmp(progname, "man") == 0)
1.95 schwarze 145: search.argmode = ARG_NAME;
1.162 schwarze 146: else if (strncmp(progname, "apropos", 7) == 0)
1.95 schwarze 147: search.argmode = ARG_EXPR;
1.162 schwarze 148: else if (strncmp(progname, "whatis", 6) == 0)
1.95 schwarze 149: search.argmode = ARG_WORD;
1.162 schwarze 150: else if (strncmp(progname, "help", 4) == 0)
1.110 schwarze 151: search.argmode = ARG_NAME;
1.95 schwarze 152: else
153: search.argmode = ARG_FILE;
154:
155: /* Parser and formatter options. */
156:
1.19 schwarze 157: memset(&curp, 0, sizeof(struct curparse));
1.109 schwarze 158: curp.outtype = OUTT_LOCALE;
1.121 schwarze 159: curp.wlevel = MANDOCLEVEL_BADARG;
1.135 schwarze 160: curp.outopts = &conf.output;
1.103 schwarze 161: options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.83 schwarze 162: defos = NULL;
1.1 kristaps 163:
1.149 schwarze 164: use_pager = 1;
165: tag_files = NULL;
1.95 schwarze 166: show_usage = 0;
167: outmode = OUTMODE_DEF;
168:
1.103 schwarze 169: while (-1 != (c = getopt(argc, argv,
170: "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
1.1 kristaps 171: switch (c) {
1.95 schwarze 172: case 'a':
173: outmode = OUTMODE_ALL;
174: break;
175: case 'C':
176: conf_file = optarg;
177: break;
178: case 'c':
1.149 schwarze 179: use_pager = 0;
1.95 schwarze 180: break;
181: case 'f':
182: search.argmode = ARG_WORD;
183: break;
1.98 schwarze 184: case 'h':
1.135 schwarze 185: conf.output.synopsisonly = 1;
1.149 schwarze 186: use_pager = 0;
1.98 schwarze 187: outmode = OUTMODE_ALL;
188: break;
1.90 schwarze 189: case 'I':
1.83 schwarze 190: if (strncmp(optarg, "os=", 3)) {
1.152 schwarze 191: warnx("-I %s: Bad argument", optarg);
1.150 schwarze 192: return (int)MANDOCLEVEL_BADARG;
1.83 schwarze 193: }
194: if (defos) {
1.152 schwarze 195: warnx("-I %s: Duplicate argument", optarg);
1.150 schwarze 196: return (int)MANDOCLEVEL_BADARG;
1.83 schwarze 197: }
198: defos = mandoc_strdup(optarg + 3);
199: break;
1.95 schwarze 200: case 'i':
201: outmode = OUTMODE_INT;
202: break;
1.103 schwarze 203: case 'K':
204: if ( ! koptions(&options, optarg))
1.150 schwarze 205: return (int)MANDOCLEVEL_BADARG;
1.103 schwarze 206: break;
1.95 schwarze 207: case 'k':
208: search.argmode = ARG_EXPR;
209: break;
1.96 schwarze 210: case 'l':
211: search.argmode = ARG_FILE;
212: outmode = OUTMODE_ALL;
213: break;
1.95 schwarze 214: case 'M':
215: defpaths = optarg;
216: break;
1.90 schwarze 217: case 'm':
1.95 schwarze 218: auxpaths = optarg;
1.1 kristaps 219: break;
1.90 schwarze 220: case 'O':
1.95 schwarze 221: search.outkey = optarg;
1.135 schwarze 222: while (optarg != NULL)
223: manconf_output(&conf.output,
224: strsep(&optarg, ","));
1.17 schwarze 225: break;
1.95 schwarze 226: case 'S':
227: search.arch = optarg;
228: break;
229: case 's':
230: search.sec = optarg;
231: break;
1.90 schwarze 232: case 'T':
1.22 schwarze 233: if ( ! toptions(&curp, optarg))
1.150 schwarze 234: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 235: break;
1.90 schwarze 236: case 'W':
1.45 schwarze 237: if ( ! woptions(&curp, optarg))
1.150 schwarze 238: return (int)MANDOCLEVEL_BADARG;
1.1 kristaps 239: break;
1.95 schwarze 240: case 'w':
241: outmode = OUTMODE_FLN;
242: break;
1.1 kristaps 243: default:
1.95 schwarze 244: show_usage = 1;
245: break;
246: }
247: }
248:
249: if (show_usage)
250: usage(search.argmode);
251:
252: /* Postprocess options. */
253:
254: if (outmode == OUTMODE_DEF) {
255: switch (search.argmode) {
256: case ARG_FILE:
257: outmode = OUTMODE_ALL;
1.149 schwarze 258: use_pager = 0;
1.95 schwarze 259: break;
260: case ARG_NAME:
261: outmode = OUTMODE_ONE;
262: break;
263: default:
264: outmode = OUTMODE_LST;
265: break;
266: }
267: }
268:
1.151 schwarze 269: if (outmode == OUTMODE_FLN ||
270: outmode == OUTMODE_LST ||
271: !isatty(STDOUT_FILENO))
272: use_pager = 0;
273:
1.167 schwarze 274: if (!use_pager)
275: if (pledge("stdio rpath flock", NULL) == -1)
276: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.154 schwarze 277:
1.95 schwarze 278: /* Parse arguments. */
279:
1.124 schwarze 280: if (argc > 0) {
281: argc -= optind;
282: argv += optind;
283: }
1.95 schwarze 284: resp = NULL;
285:
1.110 schwarze 286: /*
287: * Quirks for help(1)
288: * and for a man(1) section argument without -s.
289: */
290:
291: if (search.argmode == ARG_NAME) {
1.162 schwarze 292: if (*progname == 'h') {
1.110 schwarze 293: if (argc == 0) {
294: argv = help_argv;
295: argc = 1;
296: }
1.117 schwarze 297: } else if (argc > 1 &&
1.128 schwarze 298: ((uc = (unsigned char *)argv[0]) != NULL) &&
1.113 schwarze 299: ((isdigit(uc[0]) && (uc[1] == '\0' ||
300: (isalpha(uc[1]) && uc[2] == '\0'))) ||
301: (uc[0] == 'n' && uc[1] == '\0'))) {
1.128 schwarze 302: search.sec = (char *)uc;
1.110 schwarze 303: argv++;
304: argc--;
305: }
1.122 schwarze 306: if (search.arch == NULL)
307: search.arch = getenv("MACHINE");
308: if (search.arch == NULL)
309: search.arch = MACHINE;
1.95 schwarze 310: }
311:
312: rc = MANDOCLEVEL_OK;
313:
314: /* man(1), whatis(1), apropos(1) */
315:
316: if (search.argmode != ARG_FILE) {
317: if (argc == 0)
318: usage(search.argmode);
1.107 schwarze 319:
320: if (search.argmode == ARG_NAME &&
321: outmode == OUTMODE_ONE)
322: search.firstmatch = 1;
1.95 schwarze 323:
324: /* Access the mandoc database. */
325:
1.134 schwarze 326: manconf_parse(&conf, conf_file, defpaths, auxpaths);
1.95 schwarze 327: mansearch_setup(1);
1.134 schwarze 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.100 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:
439: if (argc > 1 && curp.outtype <= OUTT_UTF8)
440: ascii_sepline(curp.outdata);
1.169 schwarze 441: } else if (rc < MANDOCLEVEL_ERROR)
442: rc = MANDOCLEVEL_ERROR;
1.100 schwarze 443:
1.76 schwarze 444: if (MANDOCLEVEL_OK != rc && curp.wstop)
1.27 schwarze 445: break;
1.116 schwarze 446:
1.118 schwarze 447: if (resp != NULL)
448: resp++;
449: else
450: argv++;
451: if (--argc)
452: mparse_reset(curp.mp);
1.1 kristaps 453: }
454:
1.160 schwarze 455: if (curp.outdata != NULL) {
456: switch (curp.outtype) {
457: case OUTT_HTML:
458: html_free(curp.outdata);
459: break;
460: case OUTT_UTF8:
461: case OUTT_LOCALE:
462: case OUTT_ASCII:
463: ascii_free(curp.outdata);
464: break;
465: case OUTT_PDF:
466: case OUTT_PS:
467: pspdf_free(curp.outdata);
468: break;
469: default:
470: break;
471: }
1.158 schwarze 472: }
1.102 schwarze 473: mparse_free(curp.mp);
1.155 schwarze 474: mchars_free();
1.95 schwarze 475:
476: out:
477: if (search.argmode != ARG_FILE) {
1.134 schwarze 478: manconf_free(&conf);
1.95 schwarze 479: mansearch_free(res, sz);
480: mansearch_setup(0);
481: }
482:
1.83 schwarze 483: free(defos);
1.1 kristaps 484:
1.129 schwarze 485: /*
1.149 schwarze 486: * When using a pager, finish writing both temporary files,
487: * fork it, wait for the user to close it, and clean up.
1.129 schwarze 488: */
489:
1.149 schwarze 490: if (tag_files != NULL) {
1.130 schwarze 491: fclose(stdout);
1.144 schwarze 492: tag_write();
1.166 schwarze 493: man_pgid = getpgid(0);
494: tag_files->tcpgid = man_pgid == getpid() ?
495: getpgid(getppid()) : man_pgid;
496: pager_pid = 0;
497: signum = SIGSTOP;
1.165 schwarze 498: for (;;) {
1.166 schwarze 499:
500: /* Stop here until moved to the foreground. */
501:
502: tc_pgid = tcgetpgrp(STDIN_FILENO);
503: if (tc_pgid != man_pgid) {
504: if (tc_pgid == pager_pid) {
505: (void)tcsetpgrp(STDIN_FILENO,
506: man_pgid);
507: if (signum == SIGTTIN)
508: continue;
509: } else
510: tag_files->tcpgid = tc_pgid;
511: kill(0, signum);
512: continue;
513: }
514:
515: /* Once in the foreground, activate the pager. */
516:
517: if (pager_pid) {
518: (void)tcsetpgrp(STDIN_FILENO, pager_pid);
519: kill(pager_pid, SIGCONT);
520: } else
521: pager_pid = spawn_pager(tag_files);
522:
523: /* Wait for the pager to stop or exit. */
524:
525: while ((pid = waitpid(pager_pid, &status,
526: WUNTRACED)) == -1 && errno == EINTR)
527: continue;
528:
529: if (pid == -1) {
1.165 schwarze 530: warn("wait");
531: rc = MANDOCLEVEL_SYSERR;
532: break;
533: }
534: if (!WIFSTOPPED(status))
535: break;
536:
1.166 schwarze 537: signum = WSTOPSIG(status);
1.165 schwarze 538: }
1.144 schwarze 539: tag_unlink();
1.130 schwarze 540: }
1.129 schwarze 541:
1.150 schwarze 542: return (int)rc;
1.1 kristaps 543: }
544:
1.20 schwarze 545: static void
1.95 schwarze 546: usage(enum argmode argmode)
1.1 kristaps 547: {
548:
1.95 schwarze 549: switch (argmode) {
550: case ARG_FILE:
1.133 schwarze 551: fputs("usage: mandoc [-acfhkl] [-I os=name] "
552: "[-K encoding] [-mformat] [-O option]\n"
553: "\t [-T output] [-W level] [file ...]\n", stderr);
1.95 schwarze 554: break;
555: case ARG_NAME:
1.126 schwarze 556: fputs("usage: man [-acfhklw] [-C file] [-I os=name] "
1.114 jmc 557: "[-K encoding] [-M path] [-m path]\n"
558: "\t [-O option=value] [-S subsection] [-s section] "
559: "[-T output] [-W level]\n"
1.95 schwarze 560: "\t [section] name ...\n", stderr);
561: break;
562: case ARG_WORD:
1.126 schwarze 563: fputs("usage: whatis [-acfhklw] [-C file] "
1.96 schwarze 564: "[-M path] [-m path] [-O outkey] [-S arch]\n"
565: "\t [-s section] name ...\n", stderr);
1.95 schwarze 566: break;
567: case ARG_EXPR:
1.126 schwarze 568: fputs("usage: apropos [-acfhklw] [-C file] "
1.96 schwarze 569: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.95 schwarze 570: "\t [-s section] expression ...\n", stderr);
571: break;
572: }
1.47 schwarze 573: exit((int)MANDOCLEVEL_BADARG);
1.119 schwarze 574: }
575:
576: static int
577: fs_lookup(const struct manpaths *paths, size_t ipath,
578: const char *sec, const char *arch, const char *name,
579: struct manpage **res, size_t *ressz)
580: {
1.127 schwarze 581: glob_t globinfo;
1.119 schwarze 582: struct manpage *page;
583: char *file;
1.127 schwarze 584: int form, globres;
1.119 schwarze 585:
1.127 schwarze 586: form = FORM_SRC;
1.119 schwarze 587: mandoc_asprintf(&file, "%s/man%s/%s.%s",
588: paths->paths[ipath], sec, name, sec);
1.127 schwarze 589: if (access(file, R_OK) != -1)
1.119 schwarze 590: goto found;
591: free(file);
592:
593: mandoc_asprintf(&file, "%s/cat%s/%s.0",
594: paths->paths[ipath], sec, name);
595: if (access(file, R_OK) != -1) {
596: form = FORM_CAT;
597: goto found;
598: }
599: free(file);
600:
601: if (arch != NULL) {
602: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
603: paths->paths[ipath], sec, arch, name, sec);
1.127 schwarze 604: if (access(file, R_OK) != -1)
1.119 schwarze 605: goto found;
606: free(file);
607: }
1.127 schwarze 608:
1.145 schwarze 609: mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",
1.127 schwarze 610: paths->paths[ipath], sec, name);
611: globres = glob(file, 0, NULL, &globinfo);
612: if (globres != 0 && globres != GLOB_NOMATCH)
1.152 schwarze 613: warn("%s: glob", file);
1.127 schwarze 614: free(file);
615: if (globres == 0)
616: file = mandoc_strdup(*globinfo.gl_pathv);
617: globfree(&globinfo);
618: if (globres != 0)
1.150 schwarze 619: return 0;
1.119 schwarze 620:
621: found:
1.152 schwarze 622: warnx("outdated mandoc.db lacks %s(%s) entry, run makewhatis %s",
623: name, sec, paths->paths[ipath]);
1.119 schwarze 624: *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
625: page = *res + (*ressz - 1);
626: page->file = file;
627: page->names = NULL;
628: page->output = NULL;
629: page->ipath = ipath;
630: page->bits = NAME_FILE & NAME_MASK;
631: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
632: page->form = form;
1.150 schwarze 633: return 1;
1.119 schwarze 634: }
635:
636: static void
637: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
638: int argc, char **argv, struct manpage **res, size_t *ressz)
639: {
640: const char *const sections[] =
1.171 ! schwarze 641: {"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"};
1.119 schwarze 642: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
643:
644: size_t ipath, isec, lastsz;
645:
646: assert(cfg->argmode == ARG_NAME);
647:
648: *res = NULL;
649: *ressz = lastsz = 0;
650: while (argc) {
651: for (ipath = 0; ipath < paths->sz; ipath++) {
652: if (cfg->sec != NULL) {
653: if (fs_lookup(paths, ipath, cfg->sec,
654: cfg->arch, *argv, res, ressz) &&
655: cfg->firstmatch)
656: return;
657: } else for (isec = 0; isec < nsec; isec++)
658: if (fs_lookup(paths, ipath, sections[isec],
659: cfg->arch, *argv, res, ressz) &&
660: cfg->firstmatch)
661: return;
662: }
663: if (*ressz == lastsz)
1.152 schwarze 664: warnx("No entry for %s in the manual.", *argv);
1.119 schwarze 665: lastsz = *ressz;
666: argv++;
667: argc--;
668: }
1.1 kristaps 669: }
670:
1.27 schwarze 671: static void
1.132 schwarze 672: parse(struct curparse *curp, int fd, const char *file)
1.52 schwarze 673: {
1.132 schwarze 674: enum mandoclevel rctmp;
1.139 schwarze 675: struct roff_man *man;
1.52 schwarze 676:
1.76 schwarze 677: /* Begin by parsing the file itself. */
1.52 schwarze 678:
1.76 schwarze 679: assert(file);
1.170 florian 680: assert(fd >= 0);
1.52 schwarze 681:
1.132 schwarze 682: rctmp = mparse_readfd(curp->mp, fd, file);
1.168 schwarze 683: if (fd != STDIN_FILENO)
684: close(fd);
1.132 schwarze 685: if (rc < rctmp)
686: rc = rctmp;
1.1 kristaps 687:
1.51 schwarze 688: /*
1.76 schwarze 689: * With -Wstop and warnings or errors of at least the requested
690: * level, do not produce output.
1.51 schwarze 691: */
692:
1.132 schwarze 693: if (rctmp != MANDOCLEVEL_OK && curp->wstop)
694: return;
1.51 schwarze 695:
696: /* If unset, allocate output dev now (if applicable). */
697:
1.158 schwarze 698: if (curp->outdata == NULL) {
1.51 schwarze 699: switch (curp->outtype) {
1.90 schwarze 700: case OUTT_HTML:
1.155 schwarze 701: curp->outdata = html_alloc(curp->outopts);
1.77 schwarze 702: break;
1.90 schwarze 703: case OUTT_UTF8:
1.155 schwarze 704: curp->outdata = utf8_alloc(curp->outopts);
1.77 schwarze 705: break;
1.90 schwarze 706: case OUTT_LOCALE:
1.155 schwarze 707: curp->outdata = locale_alloc(curp->outopts);
1.51 schwarze 708: break;
1.90 schwarze 709: case OUTT_ASCII:
1.155 schwarze 710: curp->outdata = ascii_alloc(curp->outopts);
1.51 schwarze 711: break;
1.90 schwarze 712: case OUTT_PDF:
1.155 schwarze 713: curp->outdata = pdf_alloc(curp->outopts);
1.51 schwarze 714: break;
1.90 schwarze 715: case OUTT_PS:
1.155 schwarze 716: curp->outdata = ps_alloc(curp->outopts);
1.51 schwarze 717: break;
718: default:
719: break;
720: }
1.158 schwarze 721: }
1.51 schwarze 722:
1.158 schwarze 723: mparse_result(curp->mp, &man, NULL);
724:
725: /* Execute the out device, if it exists. */
726:
727: if (man == NULL)
728: return;
729: if (man->macroset == MACROSET_MDOC) {
1.159 schwarze 730: mdoc_validate(man);
1.51 schwarze 731: switch (curp->outtype) {
1.90 schwarze 732: case OUTT_HTML:
1.158 schwarze 733: html_mdoc(curp->outdata, man);
1.51 schwarze 734: break;
1.90 schwarze 735: case OUTT_TREE:
1.158 schwarze 736: tree_mdoc(curp->outdata, man);
1.51 schwarze 737: break;
1.90 schwarze 738: case OUTT_MAN:
1.158 schwarze 739: man_mdoc(curp->outdata, man);
1.78 schwarze 740: break;
1.90 schwarze 741: case OUTT_PDF:
742: case OUTT_ASCII:
743: case OUTT_UTF8:
744: case OUTT_LOCALE:
745: case OUTT_PS:
1.158 schwarze 746: terminal_mdoc(curp->outdata, man);
747: break;
748: default:
749: break;
750: }
751: }
752: if (man->macroset == MACROSET_MAN) {
1.161 schwarze 753: man_validate(man);
1.158 schwarze 754: switch (curp->outtype) {
755: case OUTT_HTML:
756: html_man(curp->outdata, man);
757: break;
758: case OUTT_TREE:
759: tree_man(curp->outdata, man);
760: break;
761: case OUTT_MAN:
762: man_man(curp->outdata, man);
763: break;
764: case OUTT_PDF:
765: case OUTT_ASCII:
766: case OUTT_UTF8:
767: case OUTT_LOCALE:
768: case OUTT_PS:
769: terminal_man(curp->outdata, man);
1.51 schwarze 770: break;
771: default:
772: break;
773: }
774: }
1.1 kristaps 775: }
776:
1.132 schwarze 777: static void
1.105 schwarze 778: passthrough(const char *file, int fd, int synopsis_only)
1.95 schwarze 779: {
1.105 schwarze 780: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
781: const char synr[] = "SYNOPSIS";
782:
783: FILE *stream;
1.95 schwarze 784: const char *syscall;
1.164 schwarze 785: char *line, *cp;
786: size_t linesz;
1.105 schwarze 787: int print;
1.116 schwarze 788:
1.164 schwarze 789: line = NULL;
790: linesz = 0;
1.105 schwarze 791:
792: if ((stream = fdopen(fd, "r")) == NULL) {
793: close(fd);
794: syscall = "fdopen";
795: goto fail;
796: }
1.95 schwarze 797:
1.105 schwarze 798: print = 0;
1.164 schwarze 799: while (getline(&line, &linesz, stream) != -1) {
800: cp = line;
1.105 schwarze 801: if (synopsis_only) {
802: if (print) {
1.164 schwarze 803: if ( ! isspace((unsigned char)*cp))
1.105 schwarze 804: goto done;
1.164 schwarze 805: while (isspace((unsigned char)*cp))
806: cp++;
1.105 schwarze 807: } else {
1.164 schwarze 808: if (strcmp(cp, synb) == 0 ||
809: strcmp(cp, synr) == 0)
1.105 schwarze 810: print = 1;
811: continue;
812: }
813: }
1.164 schwarze 814: if (fputs(cp, stdout)) {
815: fclose(stream);
816: syscall = "fputs";
817: goto fail;
818: }
1.105 schwarze 819: }
1.95 schwarze 820:
1.105 schwarze 821: if (ferror(stream)) {
822: fclose(stream);
1.164 schwarze 823: syscall = "getline";
1.105 schwarze 824: goto fail;
825: }
1.101 schwarze 826:
1.105 schwarze 827: done:
1.164 schwarze 828: free(line);
1.105 schwarze 829: fclose(stream);
1.132 schwarze 830: return;
1.95 schwarze 831:
832: fail:
1.164 schwarze 833: free(line);
1.152 schwarze 834: warn("%s: SYSERR: %s", file, syscall);
1.132 schwarze 835: if (rc < MANDOCLEVEL_SYSERR)
836: rc = MANDOCLEVEL_SYSERR;
1.103 schwarze 837: }
838:
839: static int
840: koptions(int *options, char *arg)
841: {
842:
843: if ( ! strcmp(arg, "utf-8")) {
844: *options |= MPARSE_UTF8;
845: *options &= ~MPARSE_LATIN1;
846: } else if ( ! strcmp(arg, "iso-8859-1")) {
847: *options |= MPARSE_LATIN1;
848: *options &= ~MPARSE_UTF8;
849: } else if ( ! strcmp(arg, "us-ascii")) {
850: *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
851: } else {
1.152 schwarze 852: warnx("-K %s: Bad argument", arg);
1.150 schwarze 853: return 0;
1.103 schwarze 854: }
1.150 schwarze 855: return 1;
1.95 schwarze 856: }
857:
1.1 kristaps 858: static int
1.87 schwarze 859: moptions(int *options, char *arg)
1.1 kristaps 860: {
861:
1.95 schwarze 862: if (arg == NULL)
863: /* nothing to do */;
864: else if (0 == strcmp(arg, "doc"))
1.87 schwarze 865: *options |= MPARSE_MDOC;
1.1 kristaps 866: else if (0 == strcmp(arg, "andoc"))
1.87 schwarze 867: /* nothing to do */;
1.1 kristaps 868: else if (0 == strcmp(arg, "an"))
1.87 schwarze 869: *options |= MPARSE_MAN;
1.1 kristaps 870: else {
1.152 schwarze 871: warnx("-m %s: Bad argument", arg);
1.150 schwarze 872: return 0;
1.1 kristaps 873: }
874:
1.150 schwarze 875: return 1;
1.1 kristaps 876: }
877:
878: static int
1.22 schwarze 879: toptions(struct curparse *curp, char *arg)
1.1 kristaps 880: {
881:
882: if (0 == strcmp(arg, "ascii"))
1.22 schwarze 883: curp->outtype = OUTT_ASCII;
884: else if (0 == strcmp(arg, "lint")) {
885: curp->outtype = OUTT_LINT;
1.45 schwarze 886: curp->wlevel = MANDOCLEVEL_WARNING;
1.76 schwarze 887: } else if (0 == strcmp(arg, "tree"))
1.22 schwarze 888: curp->outtype = OUTT_TREE;
1.78 schwarze 889: else if (0 == strcmp(arg, "man"))
890: curp->outtype = OUTT_MAN;
1.17 schwarze 891: else if (0 == strcmp(arg, "html"))
1.22 schwarze 892: curp->outtype = OUTT_HTML;
1.77 schwarze 893: else if (0 == strcmp(arg, "utf8"))
894: curp->outtype = OUTT_UTF8;
895: else if (0 == strcmp(arg, "locale"))
896: curp->outtype = OUTT_LOCALE;
1.21 schwarze 897: else if (0 == strcmp(arg, "xhtml"))
1.102 schwarze 898: curp->outtype = OUTT_HTML;
1.36 schwarze 899: else if (0 == strcmp(arg, "ps"))
900: curp->outtype = OUTT_PS;
1.43 schwarze 901: else if (0 == strcmp(arg, "pdf"))
902: curp->outtype = OUTT_PDF;
1.1 kristaps 903: else {
1.152 schwarze 904: warnx("-T %s: Bad argument", arg);
1.150 schwarze 905: return 0;
1.1 kristaps 906: }
907:
1.150 schwarze 908: return 1;
1.1 kristaps 909: }
910:
911: static int
1.45 schwarze 912: woptions(struct curparse *curp, char *arg)
1.1 kristaps 913: {
1.10 schwarze 914: char *v, *o;
1.123 schwarze 915: const char *toks[7];
1.1 kristaps 916:
1.45 schwarze 917: toks[0] = "stop";
918: toks[1] = "all";
919: toks[2] = "warning";
920: toks[3] = "error";
1.123 schwarze 921: toks[4] = "unsupp";
922: toks[5] = "fatal";
923: toks[6] = NULL;
1.1 kristaps 924:
1.10 schwarze 925: while (*arg) {
926: o = arg;
1.17 schwarze 927: switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.90 schwarze 928: case 0:
1.45 schwarze 929: curp->wstop = 1;
1.1 kristaps 930: break;
1.90 schwarze 931: case 1:
932: case 2:
1.45 schwarze 933: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 934: break;
1.90 schwarze 935: case 3:
1.45 schwarze 936: curp->wlevel = MANDOCLEVEL_ERROR;
1.1 kristaps 937: break;
1.90 schwarze 938: case 4:
1.123 schwarze 939: curp->wlevel = MANDOCLEVEL_UNSUPP;
940: break;
941: case 5:
1.121 schwarze 942: curp->wlevel = MANDOCLEVEL_BADARG;
1.19 schwarze 943: break;
1.1 kristaps 944: default:
1.152 schwarze 945: warnx("-W %s: Bad argument", o);
1.150 schwarze 946: return 0;
1.1 kristaps 947: }
1.10 schwarze 948: }
1.1 kristaps 949:
1.150 schwarze 950: return 1;
1.1 kristaps 951: }
952:
1.75 schwarze 953: static void
1.90 schwarze 954: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.76 schwarze 955: const char *file, int line, int col, const char *msg)
1.30 schwarze 956: {
1.94 schwarze 957: const char *mparse_msg;
1.45 schwarze 958:
1.162 schwarze 959: fprintf(stderr, "%s: %s:", getprogname(), file);
1.92 schwarze 960:
961: if (line)
962: fprintf(stderr, "%d:%d:", line, col + 1);
963:
1.94 schwarze 964: fprintf(stderr, " %s", mparse_strlevel(lvl));
965:
966: if (NULL != (mparse_msg = mparse_strerror(t)))
967: fprintf(stderr, ": %s", mparse_msg);
1.30 schwarze 968:
969: if (msg)
970: fprintf(stderr, ": %s", msg);
1.76 schwarze 971:
1.30 schwarze 972: fputc('\n', stderr);
1.95 schwarze 973: }
974:
1.130 schwarze 975: static pid_t
1.149 schwarze 976: spawn_pager(struct tag_files *tag_files)
1.95 schwarze 977: {
978: #define MAX_PAGER_ARGS 16
979: char *argv[MAX_PAGER_ARGS];
980: const char *pager;
981: char *cp;
1.144 schwarze 982: size_t cmdlen;
1.95 schwarze 983: int argc;
1.130 schwarze 984: pid_t pager_pid;
1.95 schwarze 985:
1.144 schwarze 986: pager = getenv("MANPAGER");
987: if (pager == NULL || *pager == '\0')
988: pager = getenv("PAGER");
989: if (pager == NULL || *pager == '\0')
990: pager = "more -s";
991: cp = mandoc_strdup(pager);
992:
993: /*
994: * Parse the pager command into words.
995: * Intentionally do not do anything fancy here.
996: */
997:
998: argc = 0;
999: while (argc + 4 < MAX_PAGER_ARGS) {
1000: argv[argc++] = cp;
1001: cp = strchr(cp, ' ');
1002: if (cp == NULL)
1003: break;
1004: *cp++ = '\0';
1005: while (*cp == ' ')
1006: cp++;
1007: if (*cp == '\0')
1008: break;
1009: }
1010:
1.149 schwarze 1011: /* For more(1) and less(1), use the tag file. */
1.144 schwarze 1012:
1.149 schwarze 1013: if ((cmdlen = strlen(argv[0])) >= 4) {
1.144 schwarze 1014: cp = argv[0] + cmdlen - 4;
1.149 schwarze 1015: if (strcmp(cp, "less") == 0 || strcmp(cp, "more") == 0) {
1016: argv[argc++] = mandoc_strdup("-T");
1017: argv[argc++] = tag_files->tfn;
1018: }
1.144 schwarze 1019: }
1.149 schwarze 1020: argv[argc++] = tag_files->ofn;
1.144 schwarze 1021: argv[argc] = NULL;
1022:
1.130 schwarze 1023: switch (pager_pid = fork()) {
1.95 schwarze 1024: case -1:
1.152 schwarze 1025: err((int)MANDOCLEVEL_SYSERR, "fork");
1.95 schwarze 1026: case 0:
1.165 schwarze 1027: /* Set pgrp in both parent and child to avoid racing exec. */
1028: (void)setpgid(0, 0);
1.129 schwarze 1029: break;
1030: default:
1.165 schwarze 1031: (void)setpgid(pager_pid, 0);
1.166 schwarze 1032: (void)tcsetpgrp(STDIN_FILENO, pager_pid);
1.165 schwarze 1033: if (pledge("stdio rpath tmppath tty proc", NULL) == -1)
1.163 schwarze 1034: err((int)MANDOCLEVEL_SYSERR, "pledge");
1.166 schwarze 1035: tag_files->pager_pid = pager_pid;
1.150 schwarze 1036: return pager_pid;
1.95 schwarze 1037: }
1038:
1.129 schwarze 1039: /* The child process becomes the pager. */
1.95 schwarze 1040:
1.152 schwarze 1041: if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
1042: err((int)MANDOCLEVEL_SYSERR, "pager stdout");
1.149 schwarze 1043: close(tag_files->ofd);
1044: close(tag_files->tfd);
1.95 schwarze 1045: execvp(argv[0], argv);
1.152 schwarze 1046: err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
1.30 schwarze 1047: }
![[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