Annotation of mandoc/main.c, Revision 1.252
1.252 ! schwarze 1: /* $Id: main.c,v 1.251 2015/10/20 02:01:31 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.252 ! schwarze 469: if (curp.outdata != NULL) {
! 470: switch (curp.outtype) {
! 471: case OUTT_HTML:
! 472: html_free(curp.outdata);
! 473: break;
! 474: case OUTT_UTF8:
! 475: case OUTT_LOCALE:
! 476: case OUTT_ASCII:
! 477: ascii_free(curp.outdata);
! 478: break;
! 479: case OUTT_PDF:
! 480: case OUTT_PS:
! 481: pspdf_free(curp.outdata);
! 482: break;
! 483: default:
! 484: break;
! 485: }
1.250 schwarze 486: }
1.195 schwarze 487: mparse_free(curp.mp);
1.249 schwarze 488: mchars_free();
1.182 schwarze 489:
490: out:
491: if (search.argmode != ARG_FILE) {
1.229 schwarze 492: manconf_free(&conf);
1.218 schwarze 493: #if HAVE_SQLITE3
1.182 schwarze 494: mansearch_free(res, sz);
495: mansearch_setup(0);
1.218 schwarze 496: #endif
1.182 schwarze 497: }
498:
1.166 schwarze 499: free(defos);
1.1 kristaps 500:
1.224 schwarze 501: /*
1.244 schwarze 502: * When using a pager, finish writing both temporary files,
503: * fork it, wait for the user to close it, and clean up.
1.224 schwarze 504: */
505:
1.244 schwarze 506: if (tag_files != NULL) {
1.225 schwarze 507: fclose(stdout);
1.239 schwarze 508: tag_write();
1.244 schwarze 509: waitpid(spawn_pager(tag_files), NULL, 0);
1.239 schwarze 510: tag_unlink();
1.225 schwarze 511: }
1.224 schwarze 512:
1.245 schwarze 513: return (int)rc;
1.1 kristaps 514: }
515:
1.55 kristaps 516: static void
1.180 schwarze 517: usage(enum argmode argmode)
1.1 kristaps 518: {
519:
1.180 schwarze 520: switch (argmode) {
521: case ARG_FILE:
1.228 schwarze 522: fputs("usage: mandoc [-acfhkl] [-I os=name] "
523: "[-K encoding] [-mformat] [-O option]\n"
524: "\t [-T output] [-W level] [file ...]\n", stderr);
1.180 schwarze 525: break;
526: case ARG_NAME:
1.221 schwarze 527: fputs("usage: man [-acfhklw] [-C file] [-I os=name] "
1.208 schwarze 528: "[-K encoding] [-M path] [-m path]\n"
529: "\t [-O option=value] [-S subsection] [-s section] "
530: "[-T output] [-W level]\n"
1.180 schwarze 531: "\t [section] name ...\n", stderr);
532: break;
533: case ARG_WORD:
1.221 schwarze 534: fputs("usage: whatis [-acfhklw] [-C file] "
1.188 schwarze 535: "[-M path] [-m path] [-O outkey] [-S arch]\n"
536: "\t [-s section] name ...\n", stderr);
1.180 schwarze 537: break;
538: case ARG_EXPR:
1.221 schwarze 539: fputs("usage: apropos [-acfhklw] [-C file] "
1.188 schwarze 540: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.180 schwarze 541: "\t [-s section] expression ...\n", stderr);
542: break;
543: }
1.105 kristaps 544: exit((int)MANDOCLEVEL_BADARG);
1.68 joerg 545: }
1.213 schwarze 546:
547: static int
548: fs_lookup(const struct manpaths *paths, size_t ipath,
549: const char *sec, const char *arch, const char *name,
550: struct manpage **res, size_t *ressz)
551: {
1.222 schwarze 552: glob_t globinfo;
1.213 schwarze 553: struct manpage *page;
554: char *file;
1.222 schwarze 555: int form, globres;
1.213 schwarze 556:
1.222 schwarze 557: form = FORM_SRC;
1.213 schwarze 558: mandoc_asprintf(&file, "%s/man%s/%s.%s",
559: paths->paths[ipath], sec, name, sec);
1.222 schwarze 560: if (access(file, R_OK) != -1)
1.213 schwarze 561: goto found;
562: free(file);
563:
564: mandoc_asprintf(&file, "%s/cat%s/%s.0",
565: paths->paths[ipath], sec, name);
566: if (access(file, R_OK) != -1) {
567: form = FORM_CAT;
568: goto found;
569: }
570: free(file);
571:
572: if (arch != NULL) {
573: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
574: paths->paths[ipath], sec, arch, name, sec);
1.222 schwarze 575: if (access(file, R_OK) != -1)
1.213 schwarze 576: goto found;
577: free(file);
578: }
1.222 schwarze 579:
1.240 schwarze 580: mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",
1.222 schwarze 581: paths->paths[ipath], sec, name);
582: globres = glob(file, 0, NULL, &globinfo);
583: if (globres != 0 && globres != GLOB_NOMATCH)
1.247 schwarze 584: warn("%s: glob", file);
1.222 schwarze 585: free(file);
586: if (globres == 0)
587: file = mandoc_strdup(*globinfo.gl_pathv);
588: globfree(&globinfo);
589: if (globres != 0)
1.245 schwarze 590: return 0;
1.213 schwarze 591:
592: found:
1.218 schwarze 593: #if HAVE_SQLITE3
1.247 schwarze 594: warnx("outdated mandoc.db lacks %s(%s) entry, run makewhatis %s\n",
595: name, sec, paths->paths[ipath]);
1.218 schwarze 596: #endif
1.213 schwarze 597: *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
598: page = *res + (*ressz - 1);
599: page->file = file;
600: page->names = NULL;
601: page->output = NULL;
602: page->ipath = ipath;
603: page->bits = NAME_FILE & NAME_MASK;
604: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
605: page->form = form;
1.245 schwarze 606: return 1;
1.213 schwarze 607: }
608:
609: static void
610: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
611: int argc, char **argv, struct manpage **res, size_t *ressz)
612: {
613: const char *const sections[] =
614: {"1", "8", "6", "2", "3", "3p", "5", "7", "4", "9"};
615: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
616:
617: size_t ipath, isec, lastsz;
618:
619: assert(cfg->argmode == ARG_NAME);
620:
621: *res = NULL;
622: *ressz = lastsz = 0;
623: while (argc) {
624: for (ipath = 0; ipath < paths->sz; ipath++) {
625: if (cfg->sec != NULL) {
626: if (fs_lookup(paths, ipath, cfg->sec,
627: cfg->arch, *argv, res, ressz) &&
628: cfg->firstmatch)
629: return;
630: } else for (isec = 0; isec < nsec; isec++)
631: if (fs_lookup(paths, ipath, sections[isec],
632: cfg->arch, *argv, res, ressz) &&
633: cfg->firstmatch)
634: return;
635: }
636: if (*ressz == lastsz)
1.247 schwarze 637: warnx("No entry for %s in the manual.", *argv);
1.213 schwarze 638: lastsz = *ressz;
639: argv++;
640: argc--;
641: }
642: }
1.68 joerg 643:
1.64 kristaps 644: static void
1.227 schwarze 645: parse(struct curparse *curp, int fd, const char *file)
1.1 kristaps 646: {
1.227 schwarze 647: enum mandoclevel rctmp;
1.234 schwarze 648: struct roff_man *man;
1.112 kristaps 649:
1.154 kristaps 650: /* Begin by parsing the file itself. */
1.112 kristaps 651:
1.154 kristaps 652: assert(file);
653: assert(fd >= -1);
1.112 kristaps 654:
1.227 schwarze 655: rctmp = mparse_readfd(curp->mp, fd, file);
656: if (rc < rctmp)
657: rc = rctmp;
1.112 kristaps 658:
1.1 kristaps 659: /*
1.154 kristaps 660: * With -Wstop and warnings or errors of at least the requested
661: * level, do not produce output.
1.1 kristaps 662: */
663:
1.227 schwarze 664: if (rctmp != MANDOCLEVEL_OK && curp->wstop)
665: return;
1.111 kristaps 666:
667: /* If unset, allocate output dev now (if applicable). */
668:
1.250 schwarze 669: if (curp->outdata == NULL) {
1.111 kristaps 670: switch (curp->outtype) {
1.173 schwarze 671: case OUTT_HTML:
1.249 schwarze 672: curp->outdata = html_alloc(curp->outopts);
1.162 kristaps 673: break;
1.173 schwarze 674: case OUTT_UTF8:
1.249 schwarze 675: curp->outdata = utf8_alloc(curp->outopts);
1.163 kristaps 676: break;
1.173 schwarze 677: case OUTT_LOCALE:
1.249 schwarze 678: curp->outdata = locale_alloc(curp->outopts);
1.111 kristaps 679: break;
1.173 schwarze 680: case OUTT_ASCII:
1.249 schwarze 681: curp->outdata = ascii_alloc(curp->outopts);
1.111 kristaps 682: break;
1.173 schwarze 683: case OUTT_PDF:
1.249 schwarze 684: curp->outdata = pdf_alloc(curp->outopts);
1.111 kristaps 685: break;
1.173 schwarze 686: case OUTT_PS:
1.249 schwarze 687: curp->outdata = ps_alloc(curp->outopts);
1.111 kristaps 688: break;
689: default:
690: break;
691: }
1.250 schwarze 692: }
1.111 kristaps 693:
1.250 schwarze 694: mparse_result(curp->mp, &man, NULL);
695:
696: /* Execute the out device, if it exists. */
697:
698: if (man == NULL)
699: return;
700: if (man->macroset == MACROSET_MDOC) {
1.251 schwarze 701: mdoc_validate(man);
1.111 kristaps 702: switch (curp->outtype) {
1.173 schwarze 703: case OUTT_HTML:
1.250 schwarze 704: html_mdoc(curp->outdata, man);
1.111 kristaps 705: break;
1.173 schwarze 706: case OUTT_TREE:
1.250 schwarze 707: tree_mdoc(curp->outdata, man);
1.111 kristaps 708: break;
1.173 schwarze 709: case OUTT_MAN:
1.250 schwarze 710: man_mdoc(curp->outdata, man);
1.164 schwarze 711: break;
1.173 schwarze 712: case OUTT_PDF:
713: case OUTT_ASCII:
714: case OUTT_UTF8:
715: case OUTT_LOCALE:
716: case OUTT_PS:
1.250 schwarze 717: terminal_mdoc(curp->outdata, man);
718: break;
719: default:
720: break;
721: }
722: }
723: if (man->macroset == MACROSET_MAN) {
724: switch (curp->outtype) {
725: case OUTT_HTML:
726: html_man(curp->outdata, man);
727: break;
728: case OUTT_TREE:
729: tree_man(curp->outdata, man);
730: break;
731: case OUTT_MAN:
732: man_man(curp->outdata, man);
733: break;
734: case OUTT_PDF:
735: case OUTT_ASCII:
736: case OUTT_UTF8:
737: case OUTT_LOCALE:
738: case OUTT_PS:
739: terminal_man(curp->outdata, man);
1.111 kristaps 740: break;
741: default:
742: break;
743: }
744: }
1.186 schwarze 745: }
746:
1.227 schwarze 747: static void
1.197 schwarze 748: passthrough(const char *file, int fd, int synopsis_only)
1.186 schwarze 749: {
1.197 schwarze 750: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
751: const char synr[] = "SYNOPSIS";
752:
753: FILE *stream;
1.186 schwarze 754: const char *syscall;
1.197 schwarze 755: char *line;
756: size_t len, off;
757: ssize_t nw;
758: int print;
1.210 schwarze 759:
760: fflush(stdout);
1.197 schwarze 761:
762: if ((stream = fdopen(fd, "r")) == NULL) {
763: close(fd);
764: syscall = "fdopen";
765: goto fail;
766: }
1.186 schwarze 767:
1.197 schwarze 768: print = 0;
769: while ((line = fgetln(stream, &len)) != NULL) {
770: if (synopsis_only) {
771: if (print) {
772: if ( ! isspace((unsigned char)*line))
773: goto done;
774: while (len &&
775: isspace((unsigned char)*line)) {
776: line++;
777: len--;
778: }
779: } else {
780: if ((len == sizeof(synb) &&
781: ! strncmp(line, synb, len - 1)) ||
782: (len == sizeof(synr) &&
783: ! strncmp(line, synr, len - 1)))
784: print = 1;
785: continue;
786: }
787: }
788: for (off = 0; off < len; off += nw)
789: if ((nw = write(STDOUT_FILENO, line + off,
790: len - off)) == -1 || nw == 0) {
791: fclose(stream);
1.186 schwarze 792: syscall = "write";
793: goto fail;
794: }
1.197 schwarze 795: }
1.186 schwarze 796:
1.197 schwarze 797: if (ferror(stream)) {
798: fclose(stream);
799: syscall = "fgetln";
800: goto fail;
801: }
1.193 schwarze 802:
1.197 schwarze 803: done:
804: fclose(stream);
1.227 schwarze 805: return;
1.186 schwarze 806:
807: fail:
1.247 schwarze 808: warn("%s: SYSERR: %s", file, syscall);
1.227 schwarze 809: if (rc < MANDOCLEVEL_SYSERR)
810: rc = MANDOCLEVEL_SYSERR;
1.194 schwarze 811: }
812:
813: static int
814: koptions(int *options, char *arg)
815: {
816:
817: if ( ! strcmp(arg, "utf-8")) {
818: *options |= MPARSE_UTF8;
819: *options &= ~MPARSE_LATIN1;
820: } else if ( ! strcmp(arg, "iso-8859-1")) {
821: *options |= MPARSE_LATIN1;
822: *options &= ~MPARSE_UTF8;
823: } else if ( ! strcmp(arg, "us-ascii")) {
824: *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
825: } else {
1.247 schwarze 826: warnx("-K %s: Bad argument", arg);
1.245 schwarze 827: return 0;
1.194 schwarze 828: }
1.245 schwarze 829: return 1;
1.10 kristaps 830: }
831:
832: static int
1.170 schwarze 833: moptions(int *options, char *arg)
1.10 kristaps 834: {
835:
1.180 schwarze 836: if (arg == NULL)
837: /* nothing to do */;
838: else if (0 == strcmp(arg, "doc"))
1.170 schwarze 839: *options |= MPARSE_MDOC;
1.19 kristaps 840: else if (0 == strcmp(arg, "andoc"))
1.170 schwarze 841: /* nothing to do */;
1.17 kristaps 842: else if (0 == strcmp(arg, "an"))
1.170 schwarze 843: *options |= MPARSE_MAN;
1.10 kristaps 844: else {
1.247 schwarze 845: warnx("-m %s: Bad argument", arg);
1.245 schwarze 846: return 0;
1.10 kristaps 847: }
848:
1.245 schwarze 849: return 1;
1.1 kristaps 850: }
851:
852: static int
1.60 kristaps 853: toptions(struct curparse *curp, char *arg)
1.1 kristaps 854: {
855:
856: if (0 == strcmp(arg, "ascii"))
1.60 kristaps 857: curp->outtype = OUTT_ASCII;
858: else if (0 == strcmp(arg, "lint")) {
859: curp->outtype = OUTT_LINT;
1.103 schwarze 860: curp->wlevel = MANDOCLEVEL_WARNING;
1.154 kristaps 861: } else if (0 == strcmp(arg, "tree"))
1.60 kristaps 862: curp->outtype = OUTT_TREE;
1.164 schwarze 863: else if (0 == strcmp(arg, "man"))
864: curp->outtype = OUTT_MAN;
1.43 kristaps 865: else if (0 == strcmp(arg, "html"))
1.60 kristaps 866: curp->outtype = OUTT_HTML;
1.163 kristaps 867: else if (0 == strcmp(arg, "utf8"))
868: curp->outtype = OUTT_UTF8;
1.162 kristaps 869: else if (0 == strcmp(arg, "locale"))
870: curp->outtype = OUTT_LOCALE;
1.59 kristaps 871: else if (0 == strcmp(arg, "xhtml"))
1.195 schwarze 872: curp->outtype = OUTT_HTML;
1.85 kristaps 873: else if (0 == strcmp(arg, "ps"))
874: curp->outtype = OUTT_PS;
1.100 kristaps 875: else if (0 == strcmp(arg, "pdf"))
876: curp->outtype = OUTT_PDF;
1.1 kristaps 877: else {
1.247 schwarze 878: warnx("-T %s: Bad argument", arg);
1.245 schwarze 879: return 0;
1.1 kristaps 880: }
881:
1.245 schwarze 882: return 1;
1.1 kristaps 883: }
884:
885: static int
1.103 schwarze 886: woptions(struct curparse *curp, char *arg)
1.1 kristaps 887: {
1.34 kristaps 888: char *v, *o;
1.217 schwarze 889: const char *toks[7];
1.1 kristaps 890:
1.103 schwarze 891: toks[0] = "stop";
892: toks[1] = "all";
893: toks[2] = "warning";
894: toks[3] = "error";
1.217 schwarze 895: toks[4] = "unsupp";
896: toks[5] = "fatal";
897: toks[6] = NULL;
1.1 kristaps 898:
1.34 kristaps 899: while (*arg) {
900: o = arg;
1.45 kristaps 901: switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.173 schwarze 902: case 0:
1.103 schwarze 903: curp->wstop = 1;
1.1 kristaps 904: break;
1.173 schwarze 905: case 1:
906: case 2:
1.103 schwarze 907: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 908: break;
1.173 schwarze 909: case 3:
1.103 schwarze 910: curp->wlevel = MANDOCLEVEL_ERROR;
1.24 kristaps 911: break;
1.173 schwarze 912: case 4:
1.217 schwarze 913: curp->wlevel = MANDOCLEVEL_UNSUPP;
914: break;
915: case 5:
1.215 schwarze 916: curp->wlevel = MANDOCLEVEL_BADARG;
1.50 kristaps 917: break;
1.1 kristaps 918: default:
1.247 schwarze 919: warnx("-W %s: Bad argument", o);
1.245 schwarze 920: return 0;
1.1 kristaps 921: }
1.34 kristaps 922: }
1.1 kristaps 923:
1.245 schwarze 924: return 1;
1.1 kristaps 925: }
926:
1.153 kristaps 927: static void
1.173 schwarze 928: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.155 kristaps 929: const char *file, int line, int col, const char *msg)
1.71 kristaps 930: {
1.177 schwarze 931: const char *mparse_msg;
1.103 schwarze 932:
1.247 schwarze 933: fprintf(stderr, "%s: %s:", __progname, file);
1.175 schwarze 934:
935: if (line)
936: fprintf(stderr, "%d:%d:", line, col + 1);
937:
1.177 schwarze 938: fprintf(stderr, " %s", mparse_strlevel(lvl));
939:
940: if (NULL != (mparse_msg = mparse_strerror(t)))
941: fprintf(stderr, ": %s", mparse_msg);
1.154 kristaps 942:
1.73 kristaps 943: if (msg)
944: fprintf(stderr, ": %s", msg);
1.154 kristaps 945:
1.73 kristaps 946: fputc('\n', stderr);
1.183 schwarze 947: }
948:
1.225 schwarze 949: static pid_t
1.244 schwarze 950: spawn_pager(struct tag_files *tag_files)
1.183 schwarze 951: {
1.184 schwarze 952: #define MAX_PAGER_ARGS 16
953: char *argv[MAX_PAGER_ARGS];
954: const char *pager;
955: char *cp;
1.239 schwarze 956: size_t cmdlen;
1.184 schwarze 957: int argc;
1.225 schwarze 958: pid_t pager_pid;
1.183 schwarze 959:
1.239 schwarze 960: pager = getenv("MANPAGER");
961: if (pager == NULL || *pager == '\0')
962: pager = getenv("PAGER");
963: if (pager == NULL || *pager == '\0')
964: pager = "more -s";
965: cp = mandoc_strdup(pager);
966:
967: /*
968: * Parse the pager command into words.
969: * Intentionally do not do anything fancy here.
970: */
971:
972: argc = 0;
973: while (argc + 4 < MAX_PAGER_ARGS) {
974: argv[argc++] = cp;
975: cp = strchr(cp, ' ');
976: if (cp == NULL)
977: break;
978: *cp++ = '\0';
979: while (*cp == ' ')
980: cp++;
981: if (*cp == '\0')
982: break;
983: }
984:
1.244 schwarze 985: /* For more(1) and less(1), use the tag file. */
1.239 schwarze 986:
1.244 schwarze 987: if ((cmdlen = strlen(argv[0])) >= 4) {
1.239 schwarze 988: cp = argv[0] + cmdlen - 4;
1.244 schwarze 989: if (strcmp(cp, "less") == 0 || strcmp(cp, "more") == 0) {
990: argv[argc++] = mandoc_strdup("-T");
991: argv[argc++] = tag_files->tfn;
992: }
1.239 schwarze 993: }
1.244 schwarze 994: argv[argc++] = tag_files->ofn;
1.239 schwarze 995: argv[argc] = NULL;
996:
1.225 schwarze 997: switch (pager_pid = fork()) {
1.183 schwarze 998: case -1:
1.247 schwarze 999: err((int)MANDOCLEVEL_SYSERR, "fork");
1.183 schwarze 1000: case 0:
1.224 schwarze 1001: break;
1002: default:
1.245 schwarze 1003: return pager_pid;
1.184 schwarze 1004: }
1005:
1.224 schwarze 1006: /* The child process becomes the pager. */
1.184 schwarze 1007:
1.247 schwarze 1008: if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
1009: err((int)MANDOCLEVEL_SYSERR, "pager stdout");
1.244 schwarze 1010: close(tag_files->ofd);
1011: close(tag_files->tfd);
1.184 schwarze 1012: execvp(argv[0], argv);
1.247 schwarze 1013: err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
1.71 kristaps 1014: }
CVSweb