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