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