Annotation of mandoc/main.c, Revision 1.258
1.258 ! schwarze 1: /* $Id: main.c,v 1.257 2015/11/07 17:58:55 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.258 ! schwarze 135: int status;
1.180 schwarze 136: int c;
1.258 ! schwarze 137: pid_t pager_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
302: if (!use_pager && pledge("stdio rpath flock", NULL) == -1)
303: err((int)MANDOCLEVEL_SYSERR, "pledge");
304: #endif
305:
1.185 schwarze 306: /* Parse arguments. */
307:
1.219 schwarze 308: if (argc > 0) {
309: argc -= optind;
310: argv += optind;
311: }
1.186 schwarze 312: resp = NULL;
1.185 schwarze 313:
1.202 schwarze 314: /*
315: * Quirks for help(1)
316: * and for a man(1) section argument without -s.
317: */
318:
319: if (search.argmode == ARG_NAME) {
1.254 schwarze 320: if (*progname == 'h') {
1.202 schwarze 321: if (argc == 0) {
322: argv = help_argv;
323: argc = 1;
324: }
1.211 schwarze 325: } else if (argc > 1 &&
1.223 kristaps 326: ((uc = (unsigned char *)argv[0]) != NULL) &&
1.207 schwarze 327: ((isdigit(uc[0]) && (uc[1] == '\0' ||
328: (isalpha(uc[1]) && uc[2] == '\0'))) ||
329: (uc[0] == 'n' && uc[1] == '\0'))) {
1.223 kristaps 330: search.sec = (char *)uc;
1.202 schwarze 331: argv++;
332: argc--;
333: }
1.216 schwarze 334: if (search.arch == NULL)
335: search.arch = getenv("MACHINE");
1.223 kristaps 336: #ifdef MACHINE
1.216 schwarze 337: if (search.arch == NULL)
338: search.arch = MACHINE;
1.223 kristaps 339: #endif
1.185 schwarze 340: }
1.182 schwarze 341:
342: rc = MANDOCLEVEL_OK;
1.180 schwarze 343:
344: /* man(1), whatis(1), apropos(1) */
345:
346: if (search.argmode != ARG_FILE) {
347: if (argc == 0)
348: usage(search.argmode);
1.199 schwarze 349:
350: if (search.argmode == ARG_NAME &&
351: outmode == OUTMODE_ONE)
352: search.firstmatch = 1;
1.182 schwarze 353:
354: /* Access the mandoc database. */
355:
1.229 schwarze 356: manconf_parse(&conf, conf_file, defpaths, auxpaths);
1.218 schwarze 357: #if HAVE_SQLITE3
1.180 schwarze 358: mansearch_setup(1);
1.229 schwarze 359: if ( ! mansearch(&search, &conf.manpath,
360: argc, argv, &res, &sz))
1.180 schwarze 361: usage(search.argmode);
1.218 schwarze 362: #else
363: if (search.argmode != ARG_NAME) {
364: fputs("mandoc: database support not compiled in\n",
365: stderr);
1.245 schwarze 366: return (int)MANDOCLEVEL_BADARG;
1.218 schwarze 367: }
368: sz = 0;
369: #endif
1.213 schwarze 370:
1.237 schwarze 371: if (sz == 0) {
372: if (search.argmode == ARG_NAME)
373: fs_search(&search, &conf.manpath,
374: argc, argv, &res, &sz);
375: else
1.247 schwarze 376: warnx("nothing appropriate");
1.237 schwarze 377: }
1.187 schwarze 378:
379: if (sz == 0) {
380: rc = MANDOCLEVEL_BADARG;
381: goto out;
382: }
1.182 schwarze 383:
384: /*
385: * For standard man(1) and -a output mode,
386: * prepare for copying filename pointers
387: * into the program parameter array.
388: */
389:
390: if (outmode == OUTMODE_ONE) {
391: argc = 1;
392: best_prio = 10;
1.186 schwarze 393: } else if (outmode == OUTMODE_ALL)
1.182 schwarze 394: argc = (int)sz;
395:
396: /* Iterate all matching manuals. */
397:
1.213 schwarze 398: resp = res;
1.181 schwarze 399: for (i = 0; i < sz; i++) {
400: if (outmode == OUTMODE_FLN)
401: puts(res[i].file);
1.182 schwarze 402: else if (outmode == OUTMODE_LST)
1.181 schwarze 403: printf("%s - %s\n", res[i].names,
404: res[i].output == NULL ? "" :
405: res[i].output);
1.186 schwarze 406: else if (outmode == OUTMODE_ONE) {
1.182 schwarze 407: /* Search for the best section. */
408: isec = strcspn(res[i].file, "123456789");
409: sec = res[i].file[isec];
410: if ('\0' == sec)
411: continue;
412: prio = sec_prios[sec - '1'];
413: if (prio >= best_prio)
414: continue;
415: best_prio = prio;
1.186 schwarze 416: resp = res + i;
1.182 schwarze 417: }
1.181 schwarze 418: }
1.182 schwarze 419:
420: /*
421: * For man(1), -a and -i output mode, fall through
422: * to the main mandoc(1) code iterating files
423: * and running the parsers on each of them.
424: */
425:
426: if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
427: goto out;
1.180 schwarze 428: }
429:
430: /* mandoc(1) */
431:
1.255 schwarze 432: #if HAVE_PLEDGE
1.258 ! schwarze 433: if (pledge(use_pager ? "stdio rpath tmppath tty proc exec" :
1.255 schwarze 434: "stdio rpath", NULL) == -1)
435: err((int)MANDOCLEVEL_SYSERR, "pledge");
436: #endif
437:
1.209 schwarze 438: if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths))
1.245 schwarze 439: return (int)MANDOCLEVEL_BADARG;
1.241 schwarze 440:
1.249 schwarze 441: mchars_alloc();
442: curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos);
1.154 kristaps 443:
1.165 kristaps 444: /*
445: * Conditionally start up the lookaside buffer before parsing.
446: */
447: if (OUTT_MAN == curp.outtype)
448: mparse_keep(curp.mp);
449:
1.219 schwarze 450: if (argc < 1) {
1.244 schwarze 451: if (use_pager)
452: tag_files = tag_init();
1.227 schwarze 453: parse(&curp, STDIN_FILENO, "<stdin>");
1.212 schwarze 454: }
1.64 kristaps 455:
1.219 schwarze 456: while (argc > 0) {
1.214 schwarze 457: rctmp = mparse_open(curp.mp, &fd,
1.218 schwarze 458: resp != NULL ? resp->file : *argv);
1.214 schwarze 459: if (rc < rctmp)
460: rc = rctmp;
1.212 schwarze 461:
462: if (fd != -1) {
1.244 schwarze 463: if (use_pager) {
464: tag_files = tag_init();
465: use_pager = 0;
466: }
1.212 schwarze 467:
468: if (resp == NULL)
1.227 schwarze 469: parse(&curp, fd, *argv);
1.192 schwarze 470: else if (resp->form & FORM_SRC) {
1.189 schwarze 471: /* For .so only; ignore failure. */
1.229 schwarze 472: chdir(conf.manpath.paths[resp->ipath]);
1.227 schwarze 473: parse(&curp, fd, resp->file);
474: } else
1.230 schwarze 475: passthrough(resp->file, fd,
476: conf.output.synopsisonly);
1.212 schwarze 477:
478: if (argc > 1 && curp.outtype <= OUTT_UTF8)
479: ascii_sepline(curp.outdata);
1.192 schwarze 480: }
481:
1.154 kristaps 482: if (MANDOCLEVEL_OK != rc && curp.wstop)
1.64 kristaps 483: break;
1.210 schwarze 484:
1.212 schwarze 485: if (resp != NULL)
486: resp++;
487: else
488: argv++;
489: if (--argc)
490: mparse_reset(curp.mp);
1.1 kristaps 491: }
492:
1.252 schwarze 493: if (curp.outdata != NULL) {
494: switch (curp.outtype) {
495: case OUTT_HTML:
496: html_free(curp.outdata);
497: break;
498: case OUTT_UTF8:
499: case OUTT_LOCALE:
500: case OUTT_ASCII:
501: ascii_free(curp.outdata);
502: break;
503: case OUTT_PDF:
504: case OUTT_PS:
505: pspdf_free(curp.outdata);
506: break;
507: default:
508: break;
509: }
1.250 schwarze 510: }
1.195 schwarze 511: mparse_free(curp.mp);
1.249 schwarze 512: mchars_free();
1.182 schwarze 513:
514: out:
515: if (search.argmode != ARG_FILE) {
1.229 schwarze 516: manconf_free(&conf);
1.218 schwarze 517: #if HAVE_SQLITE3
1.182 schwarze 518: mansearch_free(res, sz);
519: mansearch_setup(0);
1.218 schwarze 520: #endif
1.182 schwarze 521: }
522:
1.166 schwarze 523: free(defos);
1.1 kristaps 524:
1.224 schwarze 525: /*
1.244 schwarze 526: * When using a pager, finish writing both temporary files,
527: * fork it, wait for the user to close it, and clean up.
1.224 schwarze 528: */
529:
1.244 schwarze 530: if (tag_files != NULL) {
1.225 schwarze 531: fclose(stdout);
1.239 schwarze 532: tag_write();
1.258 ! schwarze 533: pager_pid = spawn_pager(tag_files);
! 534: for (;;) {
! 535: if (waitpid(pager_pid, &status, WUNTRACED) == -1) {
! 536: if (errno == EINTR)
! 537: continue;
! 538: warn("wait");
! 539: rc = MANDOCLEVEL_SYSERR;
! 540: break;
! 541: }
! 542: if (!WIFSTOPPED(status))
! 543: break;
! 544:
! 545: (void)tcsetpgrp(STDIN_FILENO, getpgid(0));
! 546: kill(0, WSTOPSIG(status));
! 547:
! 548: /*
! 549: * I'm now stopped.
! 550: * When getting SIGCONT, continue here:
! 551: */
! 552:
! 553: (void)tcsetpgrp(STDIN_FILENO, pager_pid);
! 554: kill(pager_pid, SIGCONT);
! 555: }
1.239 schwarze 556: tag_unlink();
1.225 schwarze 557: }
1.224 schwarze 558:
1.245 schwarze 559: return (int)rc;
1.1 kristaps 560: }
561:
1.55 kristaps 562: static void
1.180 schwarze 563: usage(enum argmode argmode)
1.1 kristaps 564: {
565:
1.180 schwarze 566: switch (argmode) {
567: case ARG_FILE:
1.228 schwarze 568: fputs("usage: mandoc [-acfhkl] [-I os=name] "
569: "[-K encoding] [-mformat] [-O option]\n"
570: "\t [-T output] [-W level] [file ...]\n", stderr);
1.180 schwarze 571: break;
572: case ARG_NAME:
1.221 schwarze 573: fputs("usage: man [-acfhklw] [-C file] [-I os=name] "
1.208 schwarze 574: "[-K encoding] [-M path] [-m path]\n"
575: "\t [-O option=value] [-S subsection] [-s section] "
576: "[-T output] [-W level]\n"
1.180 schwarze 577: "\t [section] name ...\n", stderr);
578: break;
579: case ARG_WORD:
1.221 schwarze 580: fputs("usage: whatis [-acfhklw] [-C file] "
1.188 schwarze 581: "[-M path] [-m path] [-O outkey] [-S arch]\n"
582: "\t [-s section] name ...\n", stderr);
1.180 schwarze 583: break;
584: case ARG_EXPR:
1.221 schwarze 585: fputs("usage: apropos [-acfhklw] [-C file] "
1.188 schwarze 586: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.180 schwarze 587: "\t [-s section] expression ...\n", stderr);
588: break;
589: }
1.105 kristaps 590: exit((int)MANDOCLEVEL_BADARG);
1.68 joerg 591: }
1.213 schwarze 592:
593: static int
594: fs_lookup(const struct manpaths *paths, size_t ipath,
595: const char *sec, const char *arch, const char *name,
596: struct manpage **res, size_t *ressz)
597: {
1.222 schwarze 598: glob_t globinfo;
1.213 schwarze 599: struct manpage *page;
600: char *file;
1.222 schwarze 601: int form, globres;
1.213 schwarze 602:
1.222 schwarze 603: form = FORM_SRC;
1.213 schwarze 604: mandoc_asprintf(&file, "%s/man%s/%s.%s",
605: paths->paths[ipath], sec, name, sec);
1.222 schwarze 606: if (access(file, R_OK) != -1)
1.213 schwarze 607: goto found;
608: free(file);
609:
610: mandoc_asprintf(&file, "%s/cat%s/%s.0",
611: paths->paths[ipath], sec, name);
612: if (access(file, R_OK) != -1) {
613: form = FORM_CAT;
614: goto found;
615: }
616: free(file);
617:
618: if (arch != NULL) {
619: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
620: paths->paths[ipath], sec, arch, name, sec);
1.222 schwarze 621: if (access(file, R_OK) != -1)
1.213 schwarze 622: goto found;
623: free(file);
624: }
1.222 schwarze 625:
1.240 schwarze 626: mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",
1.222 schwarze 627: paths->paths[ipath], sec, name);
628: globres = glob(file, 0, NULL, &globinfo);
629: if (globres != 0 && globres != GLOB_NOMATCH)
1.247 schwarze 630: warn("%s: glob", file);
1.222 schwarze 631: free(file);
632: if (globres == 0)
633: file = mandoc_strdup(*globinfo.gl_pathv);
634: globfree(&globinfo);
635: if (globres != 0)
1.245 schwarze 636: return 0;
1.213 schwarze 637:
638: found:
1.218 schwarze 639: #if HAVE_SQLITE3
1.254 schwarze 640: warnx("outdated mandoc.db lacks %s(%s) entry, run makewhatis %s",
1.247 schwarze 641: name, sec, paths->paths[ipath]);
1.218 schwarze 642: #endif
1.213 schwarze 643: *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
644: page = *res + (*ressz - 1);
645: page->file = file;
646: page->names = NULL;
647: page->output = NULL;
648: page->ipath = ipath;
649: page->bits = NAME_FILE & NAME_MASK;
650: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
651: page->form = form;
1.245 schwarze 652: return 1;
1.213 schwarze 653: }
654:
655: static void
656: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
657: int argc, char **argv, struct manpage **res, size_t *ressz)
658: {
659: const char *const sections[] =
660: {"1", "8", "6", "2", "3", "3p", "5", "7", "4", "9"};
661: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
662:
663: size_t ipath, isec, lastsz;
664:
665: assert(cfg->argmode == ARG_NAME);
666:
667: *res = NULL;
668: *ressz = lastsz = 0;
669: while (argc) {
670: for (ipath = 0; ipath < paths->sz; ipath++) {
671: if (cfg->sec != NULL) {
672: if (fs_lookup(paths, ipath, cfg->sec,
673: cfg->arch, *argv, res, ressz) &&
674: cfg->firstmatch)
675: return;
676: } else for (isec = 0; isec < nsec; isec++)
677: if (fs_lookup(paths, ipath, sections[isec],
678: cfg->arch, *argv, res, ressz) &&
679: cfg->firstmatch)
680: return;
681: }
682: if (*ressz == lastsz)
1.247 schwarze 683: warnx("No entry for %s in the manual.", *argv);
1.213 schwarze 684: lastsz = *ressz;
685: argv++;
686: argc--;
687: }
688: }
1.68 joerg 689:
1.64 kristaps 690: static void
1.227 schwarze 691: parse(struct curparse *curp, int fd, const char *file)
1.1 kristaps 692: {
1.227 schwarze 693: enum mandoclevel rctmp;
1.234 schwarze 694: struct roff_man *man;
1.112 kristaps 695:
1.154 kristaps 696: /* Begin by parsing the file itself. */
1.112 kristaps 697:
1.154 kristaps 698: assert(file);
699: assert(fd >= -1);
1.112 kristaps 700:
1.227 schwarze 701: rctmp = mparse_readfd(curp->mp, fd, file);
702: if (rc < rctmp)
703: rc = rctmp;
1.112 kristaps 704:
1.1 kristaps 705: /*
1.154 kristaps 706: * With -Wstop and warnings or errors of at least the requested
707: * level, do not produce output.
1.1 kristaps 708: */
709:
1.227 schwarze 710: if (rctmp != MANDOCLEVEL_OK && curp->wstop)
711: return;
1.111 kristaps 712:
713: /* If unset, allocate output dev now (if applicable). */
714:
1.250 schwarze 715: if (curp->outdata == NULL) {
1.111 kristaps 716: switch (curp->outtype) {
1.173 schwarze 717: case OUTT_HTML:
1.249 schwarze 718: curp->outdata = html_alloc(curp->outopts);
1.162 kristaps 719: break;
1.173 schwarze 720: case OUTT_UTF8:
1.249 schwarze 721: curp->outdata = utf8_alloc(curp->outopts);
1.163 kristaps 722: break;
1.173 schwarze 723: case OUTT_LOCALE:
1.249 schwarze 724: curp->outdata = locale_alloc(curp->outopts);
1.111 kristaps 725: break;
1.173 schwarze 726: case OUTT_ASCII:
1.249 schwarze 727: curp->outdata = ascii_alloc(curp->outopts);
1.111 kristaps 728: break;
1.173 schwarze 729: case OUTT_PDF:
1.249 schwarze 730: curp->outdata = pdf_alloc(curp->outopts);
1.111 kristaps 731: break;
1.173 schwarze 732: case OUTT_PS:
1.249 schwarze 733: curp->outdata = ps_alloc(curp->outopts);
1.111 kristaps 734: break;
735: default:
736: break;
737: }
1.250 schwarze 738: }
1.111 kristaps 739:
1.250 schwarze 740: mparse_result(curp->mp, &man, NULL);
741:
742: /* Execute the out device, if it exists. */
743:
744: if (man == NULL)
745: return;
746: if (man->macroset == MACROSET_MDOC) {
1.251 schwarze 747: mdoc_validate(man);
1.111 kristaps 748: switch (curp->outtype) {
1.173 schwarze 749: case OUTT_HTML:
1.250 schwarze 750: html_mdoc(curp->outdata, man);
1.111 kristaps 751: break;
1.173 schwarze 752: case OUTT_TREE:
1.250 schwarze 753: tree_mdoc(curp->outdata, man);
1.111 kristaps 754: break;
1.173 schwarze 755: case OUTT_MAN:
1.250 schwarze 756: man_mdoc(curp->outdata, man);
1.164 schwarze 757: break;
1.173 schwarze 758: case OUTT_PDF:
759: case OUTT_ASCII:
760: case OUTT_UTF8:
761: case OUTT_LOCALE:
762: case OUTT_PS:
1.250 schwarze 763: terminal_mdoc(curp->outdata, man);
764: break;
765: default:
766: break;
767: }
768: }
769: if (man->macroset == MACROSET_MAN) {
1.253 schwarze 770: man_validate(man);
1.250 schwarze 771: switch (curp->outtype) {
772: case OUTT_HTML:
773: html_man(curp->outdata, man);
774: break;
775: case OUTT_TREE:
776: tree_man(curp->outdata, man);
777: break;
778: case OUTT_MAN:
779: man_man(curp->outdata, man);
780: break;
781: case OUTT_PDF:
782: case OUTT_ASCII:
783: case OUTT_UTF8:
784: case OUTT_LOCALE:
785: case OUTT_PS:
786: terminal_man(curp->outdata, man);
1.111 kristaps 787: break;
788: default:
789: break;
790: }
791: }
1.186 schwarze 792: }
793:
1.227 schwarze 794: static void
1.197 schwarze 795: passthrough(const char *file, int fd, int synopsis_only)
1.186 schwarze 796: {
1.197 schwarze 797: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
798: const char synr[] = "SYNOPSIS";
799:
800: FILE *stream;
1.186 schwarze 801: const char *syscall;
1.257 schwarze 802: char *line, *cp;
803: size_t linesz;
1.197 schwarze 804: int print;
1.210 schwarze 805:
1.257 schwarze 806: line = NULL;
807: linesz = 0;
1.197 schwarze 808:
809: if ((stream = fdopen(fd, "r")) == NULL) {
810: close(fd);
811: syscall = "fdopen";
812: goto fail;
813: }
1.186 schwarze 814:
1.197 schwarze 815: print = 0;
1.257 schwarze 816: while (getline(&line, &linesz, stream) != -1) {
817: cp = line;
1.197 schwarze 818: if (synopsis_only) {
819: if (print) {
1.257 schwarze 820: if ( ! isspace((unsigned char)*cp))
1.197 schwarze 821: goto done;
1.257 schwarze 822: while (isspace((unsigned char)*cp))
823: cp++;
1.197 schwarze 824: } else {
1.257 schwarze 825: if (strcmp(cp, synb) == 0 ||
826: strcmp(cp, synr) == 0)
1.197 schwarze 827: print = 1;
828: continue;
829: }
830: }
1.257 schwarze 831: if (fputs(cp, stdout)) {
832: fclose(stream);
833: syscall = "fputs";
834: goto fail;
835: }
1.197 schwarze 836: }
1.186 schwarze 837:
1.197 schwarze 838: if (ferror(stream)) {
839: fclose(stream);
1.257 schwarze 840: syscall = "getline";
1.197 schwarze 841: goto fail;
842: }
1.193 schwarze 843:
1.197 schwarze 844: done:
1.257 schwarze 845: free(line);
1.197 schwarze 846: fclose(stream);
1.227 schwarze 847: return;
1.186 schwarze 848:
849: fail:
1.257 schwarze 850: free(line);
1.247 schwarze 851: warn("%s: SYSERR: %s", file, syscall);
1.227 schwarze 852: if (rc < MANDOCLEVEL_SYSERR)
853: rc = MANDOCLEVEL_SYSERR;
1.194 schwarze 854: }
855:
856: static int
857: koptions(int *options, char *arg)
858: {
859:
860: if ( ! strcmp(arg, "utf-8")) {
861: *options |= MPARSE_UTF8;
862: *options &= ~MPARSE_LATIN1;
863: } else if ( ! strcmp(arg, "iso-8859-1")) {
864: *options |= MPARSE_LATIN1;
865: *options &= ~MPARSE_UTF8;
866: } else if ( ! strcmp(arg, "us-ascii")) {
867: *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
868: } else {
1.247 schwarze 869: warnx("-K %s: Bad argument", arg);
1.245 schwarze 870: return 0;
1.194 schwarze 871: }
1.245 schwarze 872: return 1;
1.10 kristaps 873: }
874:
875: static int
1.170 schwarze 876: moptions(int *options, char *arg)
1.10 kristaps 877: {
878:
1.180 schwarze 879: if (arg == NULL)
880: /* nothing to do */;
881: else if (0 == strcmp(arg, "doc"))
1.170 schwarze 882: *options |= MPARSE_MDOC;
1.19 kristaps 883: else if (0 == strcmp(arg, "andoc"))
1.170 schwarze 884: /* nothing to do */;
1.17 kristaps 885: else if (0 == strcmp(arg, "an"))
1.170 schwarze 886: *options |= MPARSE_MAN;
1.10 kristaps 887: else {
1.247 schwarze 888: warnx("-m %s: Bad argument", arg);
1.245 schwarze 889: return 0;
1.10 kristaps 890: }
891:
1.245 schwarze 892: return 1;
1.1 kristaps 893: }
894:
895: static int
1.60 kristaps 896: toptions(struct curparse *curp, char *arg)
1.1 kristaps 897: {
898:
899: if (0 == strcmp(arg, "ascii"))
1.60 kristaps 900: curp->outtype = OUTT_ASCII;
901: else if (0 == strcmp(arg, "lint")) {
902: curp->outtype = OUTT_LINT;
1.103 schwarze 903: curp->wlevel = MANDOCLEVEL_WARNING;
1.154 kristaps 904: } else if (0 == strcmp(arg, "tree"))
1.60 kristaps 905: curp->outtype = OUTT_TREE;
1.164 schwarze 906: else if (0 == strcmp(arg, "man"))
907: curp->outtype = OUTT_MAN;
1.43 kristaps 908: else if (0 == strcmp(arg, "html"))
1.60 kristaps 909: curp->outtype = OUTT_HTML;
1.163 kristaps 910: else if (0 == strcmp(arg, "utf8"))
911: curp->outtype = OUTT_UTF8;
1.162 kristaps 912: else if (0 == strcmp(arg, "locale"))
913: curp->outtype = OUTT_LOCALE;
1.59 kristaps 914: else if (0 == strcmp(arg, "xhtml"))
1.195 schwarze 915: curp->outtype = OUTT_HTML;
1.85 kristaps 916: else if (0 == strcmp(arg, "ps"))
917: curp->outtype = OUTT_PS;
1.100 kristaps 918: else if (0 == strcmp(arg, "pdf"))
919: curp->outtype = OUTT_PDF;
1.1 kristaps 920: else {
1.247 schwarze 921: warnx("-T %s: Bad argument", arg);
1.245 schwarze 922: return 0;
1.1 kristaps 923: }
924:
1.245 schwarze 925: return 1;
1.1 kristaps 926: }
927:
928: static int
1.103 schwarze 929: woptions(struct curparse *curp, char *arg)
1.1 kristaps 930: {
1.34 kristaps 931: char *v, *o;
1.217 schwarze 932: const char *toks[7];
1.1 kristaps 933:
1.103 schwarze 934: toks[0] = "stop";
935: toks[1] = "all";
936: toks[2] = "warning";
937: toks[3] = "error";
1.217 schwarze 938: toks[4] = "unsupp";
939: toks[5] = "fatal";
940: toks[6] = NULL;
1.1 kristaps 941:
1.34 kristaps 942: while (*arg) {
943: o = arg;
1.45 kristaps 944: switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.173 schwarze 945: case 0:
1.103 schwarze 946: curp->wstop = 1;
1.1 kristaps 947: break;
1.173 schwarze 948: case 1:
949: case 2:
1.103 schwarze 950: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 951: break;
1.173 schwarze 952: case 3:
1.103 schwarze 953: curp->wlevel = MANDOCLEVEL_ERROR;
1.24 kristaps 954: break;
1.173 schwarze 955: case 4:
1.217 schwarze 956: curp->wlevel = MANDOCLEVEL_UNSUPP;
957: break;
958: case 5:
1.215 schwarze 959: curp->wlevel = MANDOCLEVEL_BADARG;
1.50 kristaps 960: break;
1.1 kristaps 961: default:
1.247 schwarze 962: warnx("-W %s: Bad argument", o);
1.245 schwarze 963: return 0;
1.1 kristaps 964: }
1.34 kristaps 965: }
1.1 kristaps 966:
1.245 schwarze 967: return 1;
1.1 kristaps 968: }
969:
1.153 kristaps 970: static void
1.173 schwarze 971: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.155 kristaps 972: const char *file, int line, int col, const char *msg)
1.71 kristaps 973: {
1.177 schwarze 974: const char *mparse_msg;
1.103 schwarze 975:
1.254 schwarze 976: fprintf(stderr, "%s: %s:", getprogname(), file);
1.175 schwarze 977:
978: if (line)
979: fprintf(stderr, "%d:%d:", line, col + 1);
980:
1.177 schwarze 981: fprintf(stderr, " %s", mparse_strlevel(lvl));
982:
983: if (NULL != (mparse_msg = mparse_strerror(t)))
984: fprintf(stderr, ": %s", mparse_msg);
1.154 kristaps 985:
1.73 kristaps 986: if (msg)
987: fprintf(stderr, ": %s", msg);
1.154 kristaps 988:
1.73 kristaps 989: fputc('\n', stderr);
1.183 schwarze 990: }
991:
1.225 schwarze 992: static pid_t
1.244 schwarze 993: spawn_pager(struct tag_files *tag_files)
1.183 schwarze 994: {
1.184 schwarze 995: #define MAX_PAGER_ARGS 16
996: char *argv[MAX_PAGER_ARGS];
997: const char *pager;
998: char *cp;
1.239 schwarze 999: size_t cmdlen;
1.184 schwarze 1000: int argc;
1.225 schwarze 1001: pid_t pager_pid;
1.183 schwarze 1002:
1.239 schwarze 1003: pager = getenv("MANPAGER");
1004: if (pager == NULL || *pager == '\0')
1005: pager = getenv("PAGER");
1006: if (pager == NULL || *pager == '\0')
1007: pager = "more -s";
1008: cp = mandoc_strdup(pager);
1009:
1010: /*
1011: * Parse the pager command into words.
1012: * Intentionally do not do anything fancy here.
1013: */
1014:
1015: argc = 0;
1016: while (argc + 4 < MAX_PAGER_ARGS) {
1017: argv[argc++] = cp;
1018: cp = strchr(cp, ' ');
1019: if (cp == NULL)
1020: break;
1021: *cp++ = '\0';
1022: while (*cp == ' ')
1023: cp++;
1024: if (*cp == '\0')
1025: break;
1026: }
1027:
1.244 schwarze 1028: /* For more(1) and less(1), use the tag file. */
1.239 schwarze 1029:
1.244 schwarze 1030: if ((cmdlen = strlen(argv[0])) >= 4) {
1.239 schwarze 1031: cp = argv[0] + cmdlen - 4;
1.244 schwarze 1032: if (strcmp(cp, "less") == 0 || strcmp(cp, "more") == 0) {
1033: argv[argc++] = mandoc_strdup("-T");
1034: argv[argc++] = tag_files->tfn;
1035: }
1.239 schwarze 1036: }
1.244 schwarze 1037: argv[argc++] = tag_files->ofn;
1.239 schwarze 1038: argv[argc] = NULL;
1039:
1.225 schwarze 1040: switch (pager_pid = fork()) {
1.183 schwarze 1041: case -1:
1.247 schwarze 1042: err((int)MANDOCLEVEL_SYSERR, "fork");
1.183 schwarze 1043: case 0:
1.258 ! schwarze 1044: /* Set pgrp in both parent and child to avoid racing exec. */
! 1045: (void)setpgid(0, 0);
1.224 schwarze 1046: break;
1047: default:
1.258 ! schwarze 1048: (void)setpgid(pager_pid, 0);
! 1049: if (tcsetpgrp(STDIN_FILENO, pager_pid) == -1)
! 1050: err((int)MANDOCLEVEL_SYSERR, "tcsetpgrp");
1.255 schwarze 1051: #if HAVE_PLEDGE
1.258 ! schwarze 1052: if (pledge("stdio rpath tmppath tty proc", NULL) == -1)
1.255 schwarze 1053: err((int)MANDOCLEVEL_SYSERR, "pledge");
1054: #endif
1.245 schwarze 1055: return pager_pid;
1.184 schwarze 1056: }
1057:
1.224 schwarze 1058: /* The child process becomes the pager. */
1.184 schwarze 1059:
1.247 schwarze 1060: if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
1061: err((int)MANDOCLEVEL_SYSERR, "pager stdout");
1.244 schwarze 1062: close(tag_files->ofd);
1063: close(tag_files->tfd);
1.184 schwarze 1064: execvp(argv[0], argv);
1.247 schwarze 1065: err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
1.71 kristaps 1066: }
CVSweb