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