Annotation of src/usr.bin/mandoc/main.c, Revision 1.146
1.146 ! schwarze 1: /* $OpenBSD: main.c,v 1.145 2015/07/18 05:46:52 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>
26: #include <errno.h>
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.131 schwarze 91: static void handle_sigpipe(int);
1.103 schwarze 92: static int koptions(int *, char *);
1.79 schwarze 93: int mandocdb(int, char**);
1.87 schwarze 94: static int moptions(int *, char *);
1.76 schwarze 95: static void mmsg(enum mandocerr, enum mandoclevel,
96: const char *, int, int, const char *);
1.132 schwarze 97: static void parse(struct curparse *, int, const char *);
98: static void passthrough(const char *, int, int);
1.130 schwarze 99: static pid_t spawn_pager(void);
1.27 schwarze 100: static int toptions(struct curparse *, char *);
1.95 schwarze 101: static void usage(enum argmode) __attribute__((noreturn));
1.45 schwarze 102: static int woptions(struct curparse *, char *);
1.1 kristaps 103:
1.95 schwarze 104: static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
1.110 schwarze 105: static char help_arg[] = "help";
106: static char *help_argv[] = {help_arg, NULL};
1.19 schwarze 107: static const char *progname;
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.111 schwarze 117: char *auxpaths;
1.95 schwarze 118: char *defos;
1.113 schwarze 119: unsigned char *uc;
1.95 schwarze 120: struct manpage *res, *resp;
1.111 schwarze 121: char *conf_file, *defpaths;
1.95 schwarze 122: size_t isec, i, sz;
1.135 schwarze 123: int prio, best_prio;
1.95 schwarze 124: char sec;
1.131 schwarze 125: enum mandoclevel rctmp;
1.95 schwarze 126: enum outmode outmode;
1.100 schwarze 127: int fd;
1.95 schwarze 128: int show_usage;
1.87 schwarze 129: int options;
1.95 schwarze 130: int c;
1.130 schwarze 131: pid_t pager_pid; /* 0: don't use; 1: not yet spawned. */
1.1 kristaps 132:
1.124 schwarze 133: if (argc < 1)
134: progname = "mandoc";
135: else if ((progname = strrchr(argv[0], '/')) == NULL)
1.19 schwarze 136: progname = argv[0];
137: else
138: ++progname;
1.79 schwarze 139:
1.82 schwarze 140: if (0 == strncmp(progname, "mandocdb", 8) ||
141: 0 == strncmp(progname, "makewhatis", 10))
1.79 schwarze 142: return(mandocdb(argc, argv));
1.19 schwarze 143:
1.95 schwarze 144: /* Search options. */
145:
1.134 schwarze 146: memset(&conf, 0, sizeof(conf));
1.111 schwarze 147: conf_file = defpaths = NULL;
148: auxpaths = NULL;
1.95 schwarze 149:
150: memset(&search, 0, sizeof(struct mansearch));
151: search.outkey = "Nd";
152:
153: if (strcmp(progname, "man") == 0)
154: search.argmode = ARG_NAME;
155: else if (strncmp(progname, "apropos", 7) == 0)
156: search.argmode = ARG_EXPR;
157: else if (strncmp(progname, "whatis", 6) == 0)
158: search.argmode = ARG_WORD;
1.110 schwarze 159: else if (strncmp(progname, "help", 4) == 0)
160: search.argmode = ARG_NAME;
1.95 schwarze 161: else
162: search.argmode = ARG_FILE;
163:
164: /* Parser and formatter options. */
165:
1.19 schwarze 166: memset(&curp, 0, sizeof(struct curparse));
1.109 schwarze 167: curp.outtype = OUTT_LOCALE;
1.121 schwarze 168: curp.wlevel = MANDOCLEVEL_BADARG;
1.135 schwarze 169: curp.outopts = &conf.output;
1.103 schwarze 170: options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.83 schwarze 171: defos = NULL;
1.1 kristaps 172:
1.130 schwarze 173: pager_pid = 1;
1.95 schwarze 174: show_usage = 0;
175: outmode = OUTMODE_DEF;
176:
1.103 schwarze 177: while (-1 != (c = getopt(argc, argv,
178: "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
1.1 kristaps 179: switch (c) {
1.95 schwarze 180: case 'a':
181: outmode = OUTMODE_ALL;
182: break;
183: case 'C':
184: conf_file = optarg;
185: break;
186: case 'c':
1.130 schwarze 187: pager_pid = 0;
1.95 schwarze 188: break;
189: case 'f':
190: search.argmode = ARG_WORD;
191: break;
1.98 schwarze 192: case 'h':
1.135 schwarze 193: conf.output.synopsisonly = 1;
1.130 schwarze 194: pager_pid = 0;
1.98 schwarze 195: outmode = OUTMODE_ALL;
196: break;
1.90 schwarze 197: case 'I':
1.83 schwarze 198: if (strncmp(optarg, "os=", 3)) {
1.90 schwarze 199: fprintf(stderr,
1.115 schwarze 200: "%s: -I %s: Bad argument\n",
1.93 schwarze 201: progname, optarg);
1.83 schwarze 202: return((int)MANDOCLEVEL_BADARG);
203: }
204: if (defos) {
1.90 schwarze 205: fprintf(stderr,
1.115 schwarze 206: "%s: -I %s: Duplicate argument\n",
1.93 schwarze 207: progname, optarg);
1.83 schwarze 208: return((int)MANDOCLEVEL_BADARG);
209: }
210: defos = mandoc_strdup(optarg + 3);
211: break;
1.95 schwarze 212: case 'i':
213: outmode = OUTMODE_INT;
214: break;
1.103 schwarze 215: case 'K':
216: if ( ! koptions(&options, optarg))
217: return((int)MANDOCLEVEL_BADARG);
218: break;
1.95 schwarze 219: case 'k':
220: search.argmode = ARG_EXPR;
221: break;
1.96 schwarze 222: case 'l':
223: search.argmode = ARG_FILE;
224: outmode = OUTMODE_ALL;
225: break;
1.95 schwarze 226: case 'M':
227: defpaths = optarg;
228: break;
1.90 schwarze 229: case 'm':
1.95 schwarze 230: auxpaths = optarg;
1.1 kristaps 231: break;
1.90 schwarze 232: case 'O':
1.95 schwarze 233: search.outkey = optarg;
1.135 schwarze 234: while (optarg != NULL)
235: manconf_output(&conf.output,
236: strsep(&optarg, ","));
1.17 schwarze 237: break;
1.95 schwarze 238: case 'S':
239: search.arch = optarg;
240: break;
241: case 's':
242: search.sec = optarg;
243: break;
1.90 schwarze 244: case 'T':
1.22 schwarze 245: if ( ! toptions(&curp, optarg))
1.47 schwarze 246: return((int)MANDOCLEVEL_BADARG);
1.1 kristaps 247: break;
1.90 schwarze 248: case 'W':
1.45 schwarze 249: if ( ! woptions(&curp, optarg))
1.47 schwarze 250: return((int)MANDOCLEVEL_BADARG);
1.1 kristaps 251: break;
1.95 schwarze 252: case 'w':
253: outmode = OUTMODE_FLN;
254: break;
1.1 kristaps 255: default:
1.95 schwarze 256: show_usage = 1;
257: break;
258: }
259: }
260:
261: if (show_usage)
262: usage(search.argmode);
263:
264: /* Postprocess options. */
265:
266: if (outmode == OUTMODE_DEF) {
267: switch (search.argmode) {
268: case ARG_FILE:
269: outmode = OUTMODE_ALL;
1.130 schwarze 270: pager_pid = 0;
1.95 schwarze 271: break;
272: case ARG_NAME:
273: outmode = OUTMODE_ONE;
274: break;
275: default:
276: outmode = OUTMODE_LST;
277: break;
278: }
279: }
280:
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) {
295: if (*progname == 'h') {
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) {
320: if (argc == 0)
321: usage(search.argmode);
1.107 schwarze 322:
323: if (search.argmode == ARG_NAME &&
324: outmode == OUTMODE_ONE)
325: search.firstmatch = 1;
1.95 schwarze 326:
327: /* Access the mandoc database. */
328:
1.134 schwarze 329: manconf_parse(&conf, conf_file, defpaths, auxpaths);
1.95 schwarze 330: mansearch_setup(1);
1.134 schwarze 331: if ( ! mansearch(&search, &conf.manpath,
332: argc, argv, &res, &sz))
1.95 schwarze 333: usage(search.argmode);
1.119 schwarze 334:
1.142 schwarze 335: if (sz == 0) {
336: if (search.argmode == ARG_NAME)
337: fs_search(&search, &conf.manpath,
338: argc, argv, &res, &sz);
339: else
340: fprintf(stderr,
341: "%s: nothing appropriate\n",
342: progname);
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.95 schwarze 399: return((int)MANDOCLEVEL_BADARG);
400:
1.146 ! schwarze 401: if (pager_pid == 1 && isatty(STDOUT_FILENO) == 0)
! 402: pager_pid = 0;
! 403:
1.102 schwarze 404: curp.mchars = mchars_alloc();
405: curp.mp = mparse_alloc(options, curp.wlevel, mmsg,
406: curp.mchars, 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.146 ! schwarze 415: if (pager_pid == 1)
1.130 schwarze 416: pager_pid = spawn_pager();
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.146 ! schwarze 427: if (pager_pid == 1)
1.130 schwarze 428: pager_pid = spawn_pager();
1.118 schwarze 429:
430: if (resp == NULL)
1.132 schwarze 431: parse(&curp, fd, *argv);
1.100 schwarze 432: else if (resp->form & FORM_SRC) {
1.97 schwarze 433: /* For .so only; ignore failure. */
1.134 schwarze 434: chdir(conf.manpath.paths[resp->ipath]);
1.132 schwarze 435: parse(&curp, fd, resp->file);
436: } else
1.135 schwarze 437: passthrough(resp->file, fd,
438: conf.output.synopsisonly);
1.118 schwarze 439:
1.120 schwarze 440: rctmp = mparse_wait(curp.mp);
441: if (rc < rctmp)
442: rc = rctmp;
1.118 schwarze 443:
444: if (argc > 1 && curp.outtype <= OUTT_UTF8)
445: ascii_sepline(curp.outdata);
1.100 schwarze 446: }
447:
1.76 schwarze 448: if (MANDOCLEVEL_OK != rc && curp.wstop)
1.27 schwarze 449: break;
1.116 schwarze 450:
1.118 schwarze 451: if (resp != NULL)
452: resp++;
453: else
454: argv++;
455: if (--argc)
456: mparse_reset(curp.mp);
1.1 kristaps 457: }
458:
459: if (curp.outfree)
460: (*curp.outfree)(curp.outdata);
1.102 schwarze 461: mparse_free(curp.mp);
462: mchars_free(curp.mchars);
1.95 schwarze 463:
464: out:
465: if (search.argmode != ARG_FILE) {
1.134 schwarze 466: manconf_free(&conf);
1.95 schwarze 467: mansearch_free(res, sz);
468: mansearch_setup(0);
469: }
470:
1.83 schwarze 471: free(defos);
1.1 kristaps 472:
1.129 schwarze 473: /*
1.130 schwarze 474: * If a pager is attached, flush the pipe leading to it
475: * and signal end of file such that the user can browse
476: * to the end. Then wait for the user to close the pager.
1.129 schwarze 477: */
478:
1.130 schwarze 479: if (pager_pid != 0 && pager_pid != 1) {
480: fclose(stdout);
1.144 schwarze 481: tag_write();
1.130 schwarze 482: waitpid(pager_pid, NULL, 0);
1.144 schwarze 483: tag_unlink();
1.130 schwarze 484: }
1.129 schwarze 485:
1.76 schwarze 486: return((int)rc);
1.1 kristaps 487: }
488:
1.20 schwarze 489: static void
1.95 schwarze 490: usage(enum argmode argmode)
1.1 kristaps 491: {
492:
1.95 schwarze 493: switch (argmode) {
494: case ARG_FILE:
1.133 schwarze 495: fputs("usage: mandoc [-acfhkl] [-I os=name] "
496: "[-K encoding] [-mformat] [-O option]\n"
497: "\t [-T output] [-W level] [file ...]\n", stderr);
1.95 schwarze 498: break;
499: case ARG_NAME:
1.126 schwarze 500: fputs("usage: man [-acfhklw] [-C file] [-I os=name] "
1.114 jmc 501: "[-K encoding] [-M path] [-m path]\n"
502: "\t [-O option=value] [-S subsection] [-s section] "
503: "[-T output] [-W level]\n"
1.95 schwarze 504: "\t [section] name ...\n", stderr);
505: break;
506: case ARG_WORD:
1.126 schwarze 507: fputs("usage: whatis [-acfhklw] [-C file] "
1.96 schwarze 508: "[-M path] [-m path] [-O outkey] [-S arch]\n"
509: "\t [-s section] name ...\n", stderr);
1.95 schwarze 510: break;
511: case ARG_EXPR:
1.126 schwarze 512: fputs("usage: apropos [-acfhklw] [-C file] "
1.96 schwarze 513: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.95 schwarze 514: "\t [-s section] expression ...\n", stderr);
515: break;
516: }
1.47 schwarze 517: exit((int)MANDOCLEVEL_BADARG);
1.119 schwarze 518: }
519:
520: static int
521: fs_lookup(const struct manpaths *paths, size_t ipath,
522: const char *sec, const char *arch, const char *name,
523: struct manpage **res, size_t *ressz)
524: {
1.127 schwarze 525: glob_t globinfo;
1.119 schwarze 526: struct manpage *page;
527: char *file;
1.127 schwarze 528: int form, globres;
1.119 schwarze 529:
1.127 schwarze 530: form = FORM_SRC;
1.119 schwarze 531: mandoc_asprintf(&file, "%s/man%s/%s.%s",
532: paths->paths[ipath], sec, name, sec);
1.127 schwarze 533: if (access(file, R_OK) != -1)
1.119 schwarze 534: goto found;
535: free(file);
536:
537: mandoc_asprintf(&file, "%s/cat%s/%s.0",
538: paths->paths[ipath], sec, name);
539: if (access(file, R_OK) != -1) {
540: form = FORM_CAT;
541: goto found;
542: }
543: free(file);
544:
545: if (arch != NULL) {
546: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
547: paths->paths[ipath], sec, arch, name, sec);
1.127 schwarze 548: if (access(file, R_OK) != -1)
1.119 schwarze 549: goto found;
550: free(file);
551: }
1.127 schwarze 552:
1.145 schwarze 553: mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",
1.127 schwarze 554: paths->paths[ipath], sec, name);
555: globres = glob(file, 0, NULL, &globinfo);
556: if (globres != 0 && globres != GLOB_NOMATCH)
557: fprintf(stderr, "%s: %s: glob: %s\n",
558: progname, file, strerror(errno));
559: free(file);
560: if (globres == 0)
561: file = mandoc_strdup(*globinfo.gl_pathv);
562: globfree(&globinfo);
563: if (globres != 0)
564: return(0);
1.119 schwarze 565:
566: found:
1.138 schwarze 567: fprintf(stderr, "%s: outdated mandoc.db lacks %s(%s) entry, run "
568: "makewhatis %s\n", progname, name, sec, paths->paths[ipath]);
1.119 schwarze 569: *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
570: page = *res + (*ressz - 1);
571: page->file = file;
572: page->names = NULL;
573: page->output = NULL;
574: page->ipath = ipath;
575: page->bits = NAME_FILE & NAME_MASK;
576: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
577: page->form = form;
578: return(1);
579: }
580:
581: static void
582: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
583: int argc, char **argv, struct manpage **res, size_t *ressz)
584: {
585: const char *const sections[] =
586: {"1", "8", "6", "2", "3", "3p", "5", "7", "4", "9"};
587: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
588:
589: size_t ipath, isec, lastsz;
590:
591: assert(cfg->argmode == ARG_NAME);
592:
593: *res = NULL;
594: *ressz = lastsz = 0;
595: while (argc) {
596: for (ipath = 0; ipath < paths->sz; ipath++) {
597: if (cfg->sec != NULL) {
598: if (fs_lookup(paths, ipath, cfg->sec,
599: cfg->arch, *argv, res, ressz) &&
600: cfg->firstmatch)
601: return;
602: } else for (isec = 0; isec < nsec; isec++)
603: if (fs_lookup(paths, ipath, sections[isec],
604: cfg->arch, *argv, res, ressz) &&
605: cfg->firstmatch)
606: return;
607: }
608: if (*ressz == lastsz)
609: fprintf(stderr,
610: "%s: No entry for %s in the manual.\n",
611: progname, *argv);
612: lastsz = *ressz;
613: argv++;
614: argc--;
615: }
1.1 kristaps 616: }
617:
1.27 schwarze 618: static void
1.132 schwarze 619: parse(struct curparse *curp, int fd, const char *file)
1.52 schwarze 620: {
1.132 schwarze 621: enum mandoclevel rctmp;
1.139 schwarze 622: struct roff_man *man;
1.52 schwarze 623:
1.76 schwarze 624: /* Begin by parsing the file itself. */
1.52 schwarze 625:
1.76 schwarze 626: assert(file);
627: assert(fd >= -1);
1.52 schwarze 628:
1.132 schwarze 629: rctmp = mparse_readfd(curp->mp, fd, file);
630: if (rc < rctmp)
631: rc = rctmp;
1.1 kristaps 632:
1.51 schwarze 633: /*
1.76 schwarze 634: * With -Wstop and warnings or errors of at least the requested
635: * level, do not produce output.
1.51 schwarze 636: */
637:
1.132 schwarze 638: if (rctmp != MANDOCLEVEL_OK && curp->wstop)
639: return;
1.51 schwarze 640:
641: /* If unset, allocate output dev now (if applicable). */
642:
643: if ( ! (curp->outman && curp->outmdoc)) {
644: switch (curp->outtype) {
1.90 schwarze 645: case OUTT_HTML:
1.102 schwarze 646: curp->outdata = html_alloc(curp->mchars,
647: curp->outopts);
1.77 schwarze 648: curp->outfree = html_free;
649: break;
1.90 schwarze 650: case OUTT_UTF8:
1.102 schwarze 651: curp->outdata = utf8_alloc(curp->mchars,
652: curp->outopts);
1.77 schwarze 653: curp->outfree = ascii_free;
654: break;
1.90 schwarze 655: case OUTT_LOCALE:
1.102 schwarze 656: curp->outdata = locale_alloc(curp->mchars,
657: curp->outopts);
1.77 schwarze 658: curp->outfree = ascii_free;
1.51 schwarze 659: break;
1.90 schwarze 660: case OUTT_ASCII:
1.102 schwarze 661: curp->outdata = ascii_alloc(curp->mchars,
662: curp->outopts);
1.51 schwarze 663: curp->outfree = ascii_free;
664: break;
1.90 schwarze 665: case OUTT_PDF:
1.102 schwarze 666: curp->outdata = pdf_alloc(curp->mchars,
667: curp->outopts);
1.51 schwarze 668: curp->outfree = pspdf_free;
669: break;
1.90 schwarze 670: case OUTT_PS:
1.102 schwarze 671: curp->outdata = ps_alloc(curp->mchars,
672: curp->outopts);
1.51 schwarze 673: curp->outfree = pspdf_free;
674: break;
675: default:
676: break;
677: }
678:
679: switch (curp->outtype) {
1.90 schwarze 680: case OUTT_HTML:
1.51 schwarze 681: curp->outman = html_man;
682: curp->outmdoc = html_mdoc;
683: break;
1.90 schwarze 684: case OUTT_TREE:
1.51 schwarze 685: curp->outman = tree_man;
686: curp->outmdoc = tree_mdoc;
687: break;
1.90 schwarze 688: case OUTT_MAN:
1.78 schwarze 689: curp->outmdoc = man_mdoc;
1.80 schwarze 690: curp->outman = man_man;
1.78 schwarze 691: break;
1.90 schwarze 692: case OUTT_PDF:
1.51 schwarze 693: /* FALLTHROUGH */
1.90 schwarze 694: case OUTT_ASCII:
1.51 schwarze 695: /* FALLTHROUGH */
1.90 schwarze 696: case OUTT_UTF8:
1.77 schwarze 697: /* FALLTHROUGH */
1.90 schwarze 698: case OUTT_LOCALE:
1.77 schwarze 699: /* FALLTHROUGH */
1.90 schwarze 700: case OUTT_PS:
1.51 schwarze 701: curp->outman = terminal_man;
702: curp->outmdoc = terminal_mdoc;
703: break;
704: default:
705: break;
706: }
707: }
708:
1.140 schwarze 709: mparse_result(curp->mp, &man, NULL);
1.76 schwarze 710:
1.51 schwarze 711: /* Execute the out device, if it exists. */
712:
1.140 schwarze 713: if (man == NULL)
714: return;
715: if (curp->outmdoc != NULL && man->macroset == MACROSET_MDOC)
716: (*curp->outmdoc)(curp->outdata, man);
717: if (curp->outman != NULL && man->macroset == MACROSET_MAN)
1.76 schwarze 718: (*curp->outman)(curp->outdata, man);
1.1 kristaps 719: }
720:
1.132 schwarze 721: static void
1.105 schwarze 722: passthrough(const char *file, int fd, int synopsis_only)
1.95 schwarze 723: {
1.105 schwarze 724: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
725: const char synr[] = "SYNOPSIS";
726:
727: FILE *stream;
1.95 schwarze 728: const char *syscall;
1.105 schwarze 729: char *line;
730: size_t len, off;
731: ssize_t nw;
732: int print;
1.116 schwarze 733:
734: fflush(stdout);
1.105 schwarze 735:
736: if ((stream = fdopen(fd, "r")) == NULL) {
737: close(fd);
738: syscall = "fdopen";
739: goto fail;
740: }
1.95 schwarze 741:
1.105 schwarze 742: print = 0;
743: while ((line = fgetln(stream, &len)) != NULL) {
744: if (synopsis_only) {
745: if (print) {
746: if ( ! isspace((unsigned char)*line))
747: goto done;
748: while (len &&
749: isspace((unsigned char)*line)) {
750: line++;
751: len--;
752: }
753: } else {
754: if ((len == sizeof(synb) &&
755: ! strncmp(line, synb, len - 1)) ||
756: (len == sizeof(synr) &&
757: ! strncmp(line, synr, len - 1)))
758: print = 1;
759: continue;
760: }
761: }
762: for (off = 0; off < len; off += nw)
763: if ((nw = write(STDOUT_FILENO, line + off,
764: len - off)) == -1 || nw == 0) {
765: fclose(stream);
1.95 schwarze 766: syscall = "write";
767: goto fail;
768: }
1.105 schwarze 769: }
1.95 schwarze 770:
1.105 schwarze 771: if (ferror(stream)) {
772: fclose(stream);
773: syscall = "fgetln";
774: goto fail;
775: }
1.101 schwarze 776:
1.105 schwarze 777: done:
778: fclose(stream);
1.132 schwarze 779: return;
1.95 schwarze 780:
781: fail:
782: fprintf(stderr, "%s: %s: SYSERR: %s: %s",
783: progname, file, syscall, strerror(errno));
1.132 schwarze 784: if (rc < MANDOCLEVEL_SYSERR)
785: rc = MANDOCLEVEL_SYSERR;
1.103 schwarze 786: }
787:
788: static int
789: koptions(int *options, char *arg)
790: {
791:
792: if ( ! strcmp(arg, "utf-8")) {
793: *options |= MPARSE_UTF8;
794: *options &= ~MPARSE_LATIN1;
795: } else if ( ! strcmp(arg, "iso-8859-1")) {
796: *options |= MPARSE_LATIN1;
797: *options &= ~MPARSE_UTF8;
798: } else if ( ! strcmp(arg, "us-ascii")) {
799: *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
800: } else {
1.115 schwarze 801: fprintf(stderr, "%s: -K %s: Bad argument\n",
1.103 schwarze 802: progname, arg);
803: return(0);
804: }
805: return(1);
1.95 schwarze 806: }
807:
1.1 kristaps 808: static int
1.87 schwarze 809: moptions(int *options, char *arg)
1.1 kristaps 810: {
811:
1.95 schwarze 812: if (arg == NULL)
813: /* nothing to do */;
814: else if (0 == strcmp(arg, "doc"))
1.87 schwarze 815: *options |= MPARSE_MDOC;
1.1 kristaps 816: else if (0 == strcmp(arg, "andoc"))
1.87 schwarze 817: /* nothing to do */;
1.1 kristaps 818: else if (0 == strcmp(arg, "an"))
1.87 schwarze 819: *options |= MPARSE_MAN;
1.1 kristaps 820: else {
1.115 schwarze 821: fprintf(stderr, "%s: -m %s: Bad argument\n",
1.93 schwarze 822: progname, arg);
1.1 kristaps 823: return(0);
824: }
825:
826: return(1);
827: }
828:
829: static int
1.22 schwarze 830: toptions(struct curparse *curp, char *arg)
1.1 kristaps 831: {
832:
833: if (0 == strcmp(arg, "ascii"))
1.22 schwarze 834: curp->outtype = OUTT_ASCII;
835: else if (0 == strcmp(arg, "lint")) {
836: curp->outtype = OUTT_LINT;
1.45 schwarze 837: curp->wlevel = MANDOCLEVEL_WARNING;
1.76 schwarze 838: } else if (0 == strcmp(arg, "tree"))
1.22 schwarze 839: curp->outtype = OUTT_TREE;
1.78 schwarze 840: else if (0 == strcmp(arg, "man"))
841: curp->outtype = OUTT_MAN;
1.17 schwarze 842: else if (0 == strcmp(arg, "html"))
1.22 schwarze 843: curp->outtype = OUTT_HTML;
1.77 schwarze 844: else if (0 == strcmp(arg, "utf8"))
845: curp->outtype = OUTT_UTF8;
846: else if (0 == strcmp(arg, "locale"))
847: curp->outtype = OUTT_LOCALE;
1.21 schwarze 848: else if (0 == strcmp(arg, "xhtml"))
1.102 schwarze 849: curp->outtype = OUTT_HTML;
1.36 schwarze 850: else if (0 == strcmp(arg, "ps"))
851: curp->outtype = OUTT_PS;
1.43 schwarze 852: else if (0 == strcmp(arg, "pdf"))
853: curp->outtype = OUTT_PDF;
1.1 kristaps 854: else {
1.115 schwarze 855: fprintf(stderr, "%s: -T %s: Bad argument\n",
1.93 schwarze 856: progname, arg);
1.1 kristaps 857: return(0);
858: }
859:
860: return(1);
861: }
862:
863: static int
1.45 schwarze 864: woptions(struct curparse *curp, char *arg)
1.1 kristaps 865: {
1.10 schwarze 866: char *v, *o;
1.123 schwarze 867: const char *toks[7];
1.1 kristaps 868:
1.45 schwarze 869: toks[0] = "stop";
870: toks[1] = "all";
871: toks[2] = "warning";
872: toks[3] = "error";
1.123 schwarze 873: toks[4] = "unsupp";
874: toks[5] = "fatal";
875: toks[6] = NULL;
1.1 kristaps 876:
1.10 schwarze 877: while (*arg) {
878: o = arg;
1.17 schwarze 879: switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.90 schwarze 880: case 0:
1.45 schwarze 881: curp->wstop = 1;
1.1 kristaps 882: break;
1.90 schwarze 883: case 1:
1.45 schwarze 884: /* FALLTHROUGH */
1.90 schwarze 885: case 2:
1.45 schwarze 886: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 887: break;
1.90 schwarze 888: case 3:
1.45 schwarze 889: curp->wlevel = MANDOCLEVEL_ERROR;
1.1 kristaps 890: break;
1.90 schwarze 891: case 4:
1.123 schwarze 892: curp->wlevel = MANDOCLEVEL_UNSUPP;
893: break;
894: case 5:
1.121 schwarze 895: curp->wlevel = MANDOCLEVEL_BADARG;
1.19 schwarze 896: break;
1.1 kristaps 897: default:
1.115 schwarze 898: fprintf(stderr, "%s: -W %s: Bad argument\n",
1.93 schwarze 899: progname, o);
1.1 kristaps 900: return(0);
901: }
1.10 schwarze 902: }
1.1 kristaps 903:
904: return(1);
905: }
906:
1.75 schwarze 907: static void
1.90 schwarze 908: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.76 schwarze 909: const char *file, int line, int col, const char *msg)
1.30 schwarze 910: {
1.94 schwarze 911: const char *mparse_msg;
1.45 schwarze 912:
1.92 schwarze 913: fprintf(stderr, "%s: %s:", progname, file);
914:
915: if (line)
916: fprintf(stderr, "%d:%d:", line, col + 1);
917:
1.94 schwarze 918: fprintf(stderr, " %s", mparse_strlevel(lvl));
919:
920: if (NULL != (mparse_msg = mparse_strerror(t)))
921: fprintf(stderr, ": %s", mparse_msg);
1.30 schwarze 922:
923: if (msg)
924: fprintf(stderr, ": %s", msg);
1.76 schwarze 925:
1.30 schwarze 926: fputc('\n', stderr);
1.95 schwarze 927: }
928:
1.131 schwarze 929: static void
930: handle_sigpipe(int signum)
931: {
932:
1.132 schwarze 933: exit((int)rc);
1.131 schwarze 934: }
935:
1.130 schwarze 936: static pid_t
1.95 schwarze 937: spawn_pager(void)
938: {
939: #define MAX_PAGER_ARGS 16
940: char *argv[MAX_PAGER_ARGS];
941: const char *pager;
942: char *cp;
1.144 schwarze 943: size_t cmdlen;
1.95 schwarze 944: int fildes[2];
945: int argc;
1.130 schwarze 946: pid_t pager_pid;
1.95 schwarze 947:
1.144 schwarze 948: pager = getenv("MANPAGER");
949: if (pager == NULL || *pager == '\0')
950: pager = getenv("PAGER");
951: if (pager == NULL || *pager == '\0')
952: pager = "more -s";
953: cp = mandoc_strdup(pager);
954:
955: /*
956: * Parse the pager command into words.
957: * Intentionally do not do anything fancy here.
958: */
959:
960: argc = 0;
961: while (argc + 4 < MAX_PAGER_ARGS) {
962: argv[argc++] = cp;
963: cp = strchr(cp, ' ');
964: if (cp == NULL)
965: break;
966: *cp++ = '\0';
967: while (*cp == ' ')
968: cp++;
969: if (*cp == '\0')
970: break;
971: }
972:
973: /* Read all text right away and use the tag file. */
974:
975: if ((cmdlen = strlen(argv[0])) >= 4) {
976: cp = argv[0] + cmdlen - 4;
977: if (strcmp(cp, "less") == 0 ||
978: strcmp(cp, "more") == 0) {
979: tag_init();
980: argv[argc++] = mandoc_strdup("+G1G");
981: argv[argc++] = mandoc_strdup("-T");
982: argv[argc++] = tag_filename();
983: }
984: }
985: argv[argc] = NULL;
986:
1.95 schwarze 987: if (pipe(fildes) == -1) {
988: fprintf(stderr, "%s: pipe: %s\n",
989: progname, strerror(errno));
1.130 schwarze 990: return(0);
1.95 schwarze 991: }
992:
1.130 schwarze 993: switch (pager_pid = fork()) {
1.95 schwarze 994: case -1:
995: fprintf(stderr, "%s: fork: %s\n",
996: progname, strerror(errno));
997: exit((int)MANDOCLEVEL_SYSERR);
998: case 0:
1.129 schwarze 999: break;
1000: default:
1.95 schwarze 1001: close(fildes[0]);
1002: if (dup2(fildes[1], STDOUT_FILENO) == -1) {
1003: fprintf(stderr, "%s: dup output: %s\n",
1004: progname, strerror(errno));
1005: exit((int)MANDOCLEVEL_SYSERR);
1006: }
1.129 schwarze 1007: close(fildes[1]);
1.131 schwarze 1008: signal(SIGPIPE, handle_sigpipe);
1.130 schwarze 1009: return(pager_pid);
1.95 schwarze 1010: }
1011:
1.129 schwarze 1012: /* The child process becomes the pager. */
1.95 schwarze 1013:
1014: close(fildes[1]);
1015: if (dup2(fildes[0], STDIN_FILENO) == -1) {
1016: fprintf(stderr, "%s: dup input: %s\n",
1017: progname, strerror(errno));
1018: exit((int)MANDOCLEVEL_SYSERR);
1019: }
1.129 schwarze 1020: close(fildes[0]);
1.95 schwarze 1021:
1022: /* Hand over to the pager. */
1023:
1024: execvp(argv[0], argv);
1.143 schwarze 1025: fprintf(stderr, "%s: exec %s: %s\n",
1026: progname, argv[0], strerror(errno));
1.95 schwarze 1027: exit((int)MANDOCLEVEL_SYSERR);
1.30 schwarze 1028: }
![[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