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