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