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