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