Annotation of mandoc/main.c, Revision 1.259
1.259 ! schwarze 1: /* $Id: main.c,v 1.258 2015/11/14 23:57:47 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
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.259 ! schwarze 533: man_pgid = getpgid(0);
! 534: tag_files->tcpgid = man_pgid == getpid() ?
! 535: getpgid(getppid()) : man_pgid;
! 536: pager_pid = 0;
! 537: signum = SIGSTOP;
1.258 schwarze 538: for (;;) {
1.259 ! schwarze 539:
! 540: /* Stop here until moved to the foreground. */
! 541:
! 542: tc_pgid = tcgetpgrp(STDIN_FILENO);
! 543: if (tc_pgid != man_pgid) {
! 544: if (tc_pgid == pager_pid) {
! 545: (void)tcsetpgrp(STDIN_FILENO,
! 546: man_pgid);
! 547: if (signum == SIGTTIN)
! 548: continue;
! 549: } else
! 550: tag_files->tcpgid = tc_pgid;
! 551: kill(0, signum);
! 552: continue;
! 553: }
! 554:
! 555: /* Once in the foreground, activate the pager. */
! 556:
! 557: if (pager_pid) {
! 558: (void)tcsetpgrp(STDIN_FILENO, pager_pid);
! 559: kill(pager_pid, SIGCONT);
! 560: } else
! 561: pager_pid = spawn_pager(tag_files);
! 562:
! 563: /* Wait for the pager to stop or exit. */
! 564:
! 565: while ((pid = waitpid(pager_pid, &status,
! 566: WUNTRACED)) == -1 && errno == EINTR)
! 567: continue;
! 568:
! 569: if (pid == -1) {
1.258 schwarze 570: warn("wait");
571: rc = MANDOCLEVEL_SYSERR;
572: break;
573: }
574: if (!WIFSTOPPED(status))
575: break;
576:
1.259 ! schwarze 577: signum = WSTOPSIG(status);
1.258 schwarze 578: }
1.239 schwarze 579: tag_unlink();
1.225 schwarze 580: }
1.224 schwarze 581:
1.245 schwarze 582: return (int)rc;
1.1 kristaps 583: }
584:
1.55 kristaps 585: static void
1.180 schwarze 586: usage(enum argmode argmode)
1.1 kristaps 587: {
588:
1.180 schwarze 589: switch (argmode) {
590: case ARG_FILE:
1.228 schwarze 591: fputs("usage: mandoc [-acfhkl] [-I os=name] "
592: "[-K encoding] [-mformat] [-O option]\n"
593: "\t [-T output] [-W level] [file ...]\n", stderr);
1.180 schwarze 594: break;
595: case ARG_NAME:
1.221 schwarze 596: fputs("usage: man [-acfhklw] [-C file] [-I os=name] "
1.208 schwarze 597: "[-K encoding] [-M path] [-m path]\n"
598: "\t [-O option=value] [-S subsection] [-s section] "
599: "[-T output] [-W level]\n"
1.180 schwarze 600: "\t [section] name ...\n", stderr);
601: break;
602: case ARG_WORD:
1.221 schwarze 603: fputs("usage: whatis [-acfhklw] [-C file] "
1.188 schwarze 604: "[-M path] [-m path] [-O outkey] [-S arch]\n"
605: "\t [-s section] name ...\n", stderr);
1.180 schwarze 606: break;
607: case ARG_EXPR:
1.221 schwarze 608: fputs("usage: apropos [-acfhklw] [-C file] "
1.188 schwarze 609: "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.180 schwarze 610: "\t [-s section] expression ...\n", stderr);
611: break;
612: }
1.105 kristaps 613: exit((int)MANDOCLEVEL_BADARG);
1.68 joerg 614: }
1.213 schwarze 615:
616: static int
617: fs_lookup(const struct manpaths *paths, size_t ipath,
618: const char *sec, const char *arch, const char *name,
619: struct manpage **res, size_t *ressz)
620: {
1.222 schwarze 621: glob_t globinfo;
1.213 schwarze 622: struct manpage *page;
623: char *file;
1.222 schwarze 624: int form, globres;
1.213 schwarze 625:
1.222 schwarze 626: form = FORM_SRC;
1.213 schwarze 627: mandoc_asprintf(&file, "%s/man%s/%s.%s",
628: paths->paths[ipath], sec, name, sec);
1.222 schwarze 629: if (access(file, R_OK) != -1)
1.213 schwarze 630: goto found;
631: free(file);
632:
633: mandoc_asprintf(&file, "%s/cat%s/%s.0",
634: paths->paths[ipath], sec, name);
635: if (access(file, R_OK) != -1) {
636: form = FORM_CAT;
637: goto found;
638: }
639: free(file);
640:
641: if (arch != NULL) {
642: mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
643: paths->paths[ipath], sec, arch, name, sec);
1.222 schwarze 644: if (access(file, R_OK) != -1)
1.213 schwarze 645: goto found;
646: free(file);
647: }
1.222 schwarze 648:
1.240 schwarze 649: mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",
1.222 schwarze 650: paths->paths[ipath], sec, name);
651: globres = glob(file, 0, NULL, &globinfo);
652: if (globres != 0 && globres != GLOB_NOMATCH)
1.247 schwarze 653: warn("%s: glob", file);
1.222 schwarze 654: free(file);
655: if (globres == 0)
656: file = mandoc_strdup(*globinfo.gl_pathv);
657: globfree(&globinfo);
658: if (globres != 0)
1.245 schwarze 659: return 0;
1.213 schwarze 660:
661: found:
1.218 schwarze 662: #if HAVE_SQLITE3
1.254 schwarze 663: warnx("outdated mandoc.db lacks %s(%s) entry, run makewhatis %s",
1.247 schwarze 664: name, sec, paths->paths[ipath]);
1.218 schwarze 665: #endif
1.213 schwarze 666: *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
667: page = *res + (*ressz - 1);
668: page->file = file;
669: page->names = NULL;
670: page->output = NULL;
671: page->ipath = ipath;
672: page->bits = NAME_FILE & NAME_MASK;
673: page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
674: page->form = form;
1.245 schwarze 675: return 1;
1.213 schwarze 676: }
677:
678: static void
679: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
680: int argc, char **argv, struct manpage **res, size_t *ressz)
681: {
682: const char *const sections[] =
683: {"1", "8", "6", "2", "3", "3p", "5", "7", "4", "9"};
684: const size_t nsec = sizeof(sections)/sizeof(sections[0]);
685:
686: size_t ipath, isec, lastsz;
687:
688: assert(cfg->argmode == ARG_NAME);
689:
690: *res = NULL;
691: *ressz = lastsz = 0;
692: while (argc) {
693: for (ipath = 0; ipath < paths->sz; ipath++) {
694: if (cfg->sec != NULL) {
695: if (fs_lookup(paths, ipath, cfg->sec,
696: cfg->arch, *argv, res, ressz) &&
697: cfg->firstmatch)
698: return;
699: } else for (isec = 0; isec < nsec; isec++)
700: if (fs_lookup(paths, ipath, sections[isec],
701: cfg->arch, *argv, res, ressz) &&
702: cfg->firstmatch)
703: return;
704: }
705: if (*ressz == lastsz)
1.247 schwarze 706: warnx("No entry for %s in the manual.", *argv);
1.213 schwarze 707: lastsz = *ressz;
708: argv++;
709: argc--;
710: }
711: }
1.68 joerg 712:
1.64 kristaps 713: static void
1.227 schwarze 714: parse(struct curparse *curp, int fd, const char *file)
1.1 kristaps 715: {
1.227 schwarze 716: enum mandoclevel rctmp;
1.234 schwarze 717: struct roff_man *man;
1.112 kristaps 718:
1.154 kristaps 719: /* Begin by parsing the file itself. */
1.112 kristaps 720:
1.154 kristaps 721: assert(file);
722: assert(fd >= -1);
1.112 kristaps 723:
1.227 schwarze 724: rctmp = mparse_readfd(curp->mp, fd, file);
725: if (rc < rctmp)
726: rc = rctmp;
1.112 kristaps 727:
1.1 kristaps 728: /*
1.154 kristaps 729: * With -Wstop and warnings or errors of at least the requested
730: * level, do not produce output.
1.1 kristaps 731: */
732:
1.227 schwarze 733: if (rctmp != MANDOCLEVEL_OK && curp->wstop)
734: return;
1.111 kristaps 735:
736: /* If unset, allocate output dev now (if applicable). */
737:
1.250 schwarze 738: if (curp->outdata == NULL) {
1.111 kristaps 739: switch (curp->outtype) {
1.173 schwarze 740: case OUTT_HTML:
1.249 schwarze 741: curp->outdata = html_alloc(curp->outopts);
1.162 kristaps 742: break;
1.173 schwarze 743: case OUTT_UTF8:
1.249 schwarze 744: curp->outdata = utf8_alloc(curp->outopts);
1.163 kristaps 745: break;
1.173 schwarze 746: case OUTT_LOCALE:
1.249 schwarze 747: curp->outdata = locale_alloc(curp->outopts);
1.111 kristaps 748: break;
1.173 schwarze 749: case OUTT_ASCII:
1.249 schwarze 750: curp->outdata = ascii_alloc(curp->outopts);
1.111 kristaps 751: break;
1.173 schwarze 752: case OUTT_PDF:
1.249 schwarze 753: curp->outdata = pdf_alloc(curp->outopts);
1.111 kristaps 754: break;
1.173 schwarze 755: case OUTT_PS:
1.249 schwarze 756: curp->outdata = ps_alloc(curp->outopts);
1.111 kristaps 757: break;
758: default:
759: break;
760: }
1.250 schwarze 761: }
1.111 kristaps 762:
1.250 schwarze 763: mparse_result(curp->mp, &man, NULL);
764:
765: /* Execute the out device, if it exists. */
766:
767: if (man == NULL)
768: return;
769: if (man->macroset == MACROSET_MDOC) {
1.251 schwarze 770: mdoc_validate(man);
1.111 kristaps 771: switch (curp->outtype) {
1.173 schwarze 772: case OUTT_HTML:
1.250 schwarze 773: html_mdoc(curp->outdata, man);
1.111 kristaps 774: break;
1.173 schwarze 775: case OUTT_TREE:
1.250 schwarze 776: tree_mdoc(curp->outdata, man);
1.111 kristaps 777: break;
1.173 schwarze 778: case OUTT_MAN:
1.250 schwarze 779: man_mdoc(curp->outdata, man);
1.164 schwarze 780: break;
1.173 schwarze 781: case OUTT_PDF:
782: case OUTT_ASCII:
783: case OUTT_UTF8:
784: case OUTT_LOCALE:
785: case OUTT_PS:
1.250 schwarze 786: terminal_mdoc(curp->outdata, man);
787: break;
788: default:
789: break;
790: }
791: }
792: if (man->macroset == MACROSET_MAN) {
1.253 schwarze 793: man_validate(man);
1.250 schwarze 794: switch (curp->outtype) {
795: case OUTT_HTML:
796: html_man(curp->outdata, man);
797: break;
798: case OUTT_TREE:
799: tree_man(curp->outdata, man);
800: break;
801: case OUTT_MAN:
802: man_man(curp->outdata, man);
803: break;
804: case OUTT_PDF:
805: case OUTT_ASCII:
806: case OUTT_UTF8:
807: case OUTT_LOCALE:
808: case OUTT_PS:
809: terminal_man(curp->outdata, man);
1.111 kristaps 810: break;
811: default:
812: break;
813: }
814: }
1.186 schwarze 815: }
816:
1.227 schwarze 817: static void
1.197 schwarze 818: passthrough(const char *file, int fd, int synopsis_only)
1.186 schwarze 819: {
1.197 schwarze 820: const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
821: const char synr[] = "SYNOPSIS";
822:
823: FILE *stream;
1.186 schwarze 824: const char *syscall;
1.257 schwarze 825: char *line, *cp;
826: size_t linesz;
1.197 schwarze 827: int print;
1.210 schwarze 828:
1.257 schwarze 829: line = NULL;
830: linesz = 0;
1.197 schwarze 831:
832: if ((stream = fdopen(fd, "r")) == NULL) {
833: close(fd);
834: syscall = "fdopen";
835: goto fail;
836: }
1.186 schwarze 837:
1.197 schwarze 838: print = 0;
1.257 schwarze 839: while (getline(&line, &linesz, stream) != -1) {
840: cp = line;
1.197 schwarze 841: if (synopsis_only) {
842: if (print) {
1.257 schwarze 843: if ( ! isspace((unsigned char)*cp))
1.197 schwarze 844: goto done;
1.257 schwarze 845: while (isspace((unsigned char)*cp))
846: cp++;
1.197 schwarze 847: } else {
1.257 schwarze 848: if (strcmp(cp, synb) == 0 ||
849: strcmp(cp, synr) == 0)
1.197 schwarze 850: print = 1;
851: continue;
852: }
853: }
1.257 schwarze 854: if (fputs(cp, stdout)) {
855: fclose(stream);
856: syscall = "fputs";
857: goto fail;
858: }
1.197 schwarze 859: }
1.186 schwarze 860:
1.197 schwarze 861: if (ferror(stream)) {
862: fclose(stream);
1.257 schwarze 863: syscall = "getline";
1.197 schwarze 864: goto fail;
865: }
1.193 schwarze 866:
1.197 schwarze 867: done:
1.257 schwarze 868: free(line);
1.197 schwarze 869: fclose(stream);
1.227 schwarze 870: return;
1.186 schwarze 871:
872: fail:
1.257 schwarze 873: free(line);
1.247 schwarze 874: warn("%s: SYSERR: %s", file, syscall);
1.227 schwarze 875: if (rc < MANDOCLEVEL_SYSERR)
876: rc = MANDOCLEVEL_SYSERR;
1.194 schwarze 877: }
878:
879: static int
880: koptions(int *options, char *arg)
881: {
882:
883: if ( ! strcmp(arg, "utf-8")) {
884: *options |= MPARSE_UTF8;
885: *options &= ~MPARSE_LATIN1;
886: } else if ( ! strcmp(arg, "iso-8859-1")) {
887: *options |= MPARSE_LATIN1;
888: *options &= ~MPARSE_UTF8;
889: } else if ( ! strcmp(arg, "us-ascii")) {
890: *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
891: } else {
1.247 schwarze 892: warnx("-K %s: Bad argument", arg);
1.245 schwarze 893: return 0;
1.194 schwarze 894: }
1.245 schwarze 895: return 1;
1.10 kristaps 896: }
897:
898: static int
1.170 schwarze 899: moptions(int *options, char *arg)
1.10 kristaps 900: {
901:
1.180 schwarze 902: if (arg == NULL)
903: /* nothing to do */;
904: else if (0 == strcmp(arg, "doc"))
1.170 schwarze 905: *options |= MPARSE_MDOC;
1.19 kristaps 906: else if (0 == strcmp(arg, "andoc"))
1.170 schwarze 907: /* nothing to do */;
1.17 kristaps 908: else if (0 == strcmp(arg, "an"))
1.170 schwarze 909: *options |= MPARSE_MAN;
1.10 kristaps 910: else {
1.247 schwarze 911: warnx("-m %s: Bad argument", arg);
1.245 schwarze 912: return 0;
1.10 kristaps 913: }
914:
1.245 schwarze 915: return 1;
1.1 kristaps 916: }
917:
918: static int
1.60 kristaps 919: toptions(struct curparse *curp, char *arg)
1.1 kristaps 920: {
921:
922: if (0 == strcmp(arg, "ascii"))
1.60 kristaps 923: curp->outtype = OUTT_ASCII;
924: else if (0 == strcmp(arg, "lint")) {
925: curp->outtype = OUTT_LINT;
1.103 schwarze 926: curp->wlevel = MANDOCLEVEL_WARNING;
1.154 kristaps 927: } else if (0 == strcmp(arg, "tree"))
1.60 kristaps 928: curp->outtype = OUTT_TREE;
1.164 schwarze 929: else if (0 == strcmp(arg, "man"))
930: curp->outtype = OUTT_MAN;
1.43 kristaps 931: else if (0 == strcmp(arg, "html"))
1.60 kristaps 932: curp->outtype = OUTT_HTML;
1.163 kristaps 933: else if (0 == strcmp(arg, "utf8"))
934: curp->outtype = OUTT_UTF8;
1.162 kristaps 935: else if (0 == strcmp(arg, "locale"))
936: curp->outtype = OUTT_LOCALE;
1.59 kristaps 937: else if (0 == strcmp(arg, "xhtml"))
1.195 schwarze 938: curp->outtype = OUTT_HTML;
1.85 kristaps 939: else if (0 == strcmp(arg, "ps"))
940: curp->outtype = OUTT_PS;
1.100 kristaps 941: else if (0 == strcmp(arg, "pdf"))
942: curp->outtype = OUTT_PDF;
1.1 kristaps 943: else {
1.247 schwarze 944: warnx("-T %s: Bad argument", arg);
1.245 schwarze 945: return 0;
1.1 kristaps 946: }
947:
1.245 schwarze 948: return 1;
1.1 kristaps 949: }
950:
951: static int
1.103 schwarze 952: woptions(struct curparse *curp, char *arg)
1.1 kristaps 953: {
1.34 kristaps 954: char *v, *o;
1.217 schwarze 955: const char *toks[7];
1.1 kristaps 956:
1.103 schwarze 957: toks[0] = "stop";
958: toks[1] = "all";
959: toks[2] = "warning";
960: toks[3] = "error";
1.217 schwarze 961: toks[4] = "unsupp";
962: toks[5] = "fatal";
963: toks[6] = NULL;
1.1 kristaps 964:
1.34 kristaps 965: while (*arg) {
966: o = arg;
1.45 kristaps 967: switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.173 schwarze 968: case 0:
1.103 schwarze 969: curp->wstop = 1;
1.1 kristaps 970: break;
1.173 schwarze 971: case 1:
972: case 2:
1.103 schwarze 973: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 974: break;
1.173 schwarze 975: case 3:
1.103 schwarze 976: curp->wlevel = MANDOCLEVEL_ERROR;
1.24 kristaps 977: break;
1.173 schwarze 978: case 4:
1.217 schwarze 979: curp->wlevel = MANDOCLEVEL_UNSUPP;
980: break;
981: case 5:
1.215 schwarze 982: curp->wlevel = MANDOCLEVEL_BADARG;
1.50 kristaps 983: break;
1.1 kristaps 984: default:
1.247 schwarze 985: warnx("-W %s: Bad argument", o);
1.245 schwarze 986: return 0;
1.1 kristaps 987: }
1.34 kristaps 988: }
1.1 kristaps 989:
1.245 schwarze 990: return 1;
1.1 kristaps 991: }
992:
1.153 kristaps 993: static void
1.173 schwarze 994: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.155 kristaps 995: const char *file, int line, int col, const char *msg)
1.71 kristaps 996: {
1.177 schwarze 997: const char *mparse_msg;
1.103 schwarze 998:
1.254 schwarze 999: fprintf(stderr, "%s: %s:", getprogname(), file);
1.175 schwarze 1000:
1001: if (line)
1002: fprintf(stderr, "%d:%d:", line, col + 1);
1003:
1.177 schwarze 1004: fprintf(stderr, " %s", mparse_strlevel(lvl));
1005:
1006: if (NULL != (mparse_msg = mparse_strerror(t)))
1007: fprintf(stderr, ": %s", mparse_msg);
1.154 kristaps 1008:
1.73 kristaps 1009: if (msg)
1010: fprintf(stderr, ": %s", msg);
1.154 kristaps 1011:
1.73 kristaps 1012: fputc('\n', stderr);
1.183 schwarze 1013: }
1014:
1.225 schwarze 1015: static pid_t
1.244 schwarze 1016: spawn_pager(struct tag_files *tag_files)
1.183 schwarze 1017: {
1.184 schwarze 1018: #define MAX_PAGER_ARGS 16
1019: char *argv[MAX_PAGER_ARGS];
1020: const char *pager;
1021: char *cp;
1.239 schwarze 1022: size_t cmdlen;
1.184 schwarze 1023: int argc;
1.225 schwarze 1024: pid_t pager_pid;
1.183 schwarze 1025:
1.239 schwarze 1026: pager = getenv("MANPAGER");
1027: if (pager == NULL || *pager == '\0')
1028: pager = getenv("PAGER");
1029: if (pager == NULL || *pager == '\0')
1030: pager = "more -s";
1031: cp = mandoc_strdup(pager);
1032:
1033: /*
1034: * Parse the pager command into words.
1035: * Intentionally do not do anything fancy here.
1036: */
1037:
1038: argc = 0;
1039: while (argc + 4 < MAX_PAGER_ARGS) {
1040: argv[argc++] = cp;
1041: cp = strchr(cp, ' ');
1042: if (cp == NULL)
1043: break;
1044: *cp++ = '\0';
1045: while (*cp == ' ')
1046: cp++;
1047: if (*cp == '\0')
1048: break;
1049: }
1050:
1.244 schwarze 1051: /* For more(1) and less(1), use the tag file. */
1.239 schwarze 1052:
1.244 schwarze 1053: if ((cmdlen = strlen(argv[0])) >= 4) {
1.239 schwarze 1054: cp = argv[0] + cmdlen - 4;
1.244 schwarze 1055: if (strcmp(cp, "less") == 0 || strcmp(cp, "more") == 0) {
1056: argv[argc++] = mandoc_strdup("-T");
1057: argv[argc++] = tag_files->tfn;
1058: }
1.239 schwarze 1059: }
1.244 schwarze 1060: argv[argc++] = tag_files->ofn;
1.239 schwarze 1061: argv[argc] = NULL;
1062:
1.225 schwarze 1063: switch (pager_pid = fork()) {
1.183 schwarze 1064: case -1:
1.247 schwarze 1065: err((int)MANDOCLEVEL_SYSERR, "fork");
1.183 schwarze 1066: case 0:
1.258 schwarze 1067: /* Set pgrp in both parent and child to avoid racing exec. */
1068: (void)setpgid(0, 0);
1.224 schwarze 1069: break;
1070: default:
1.258 schwarze 1071: (void)setpgid(pager_pid, 0);
1.259 ! schwarze 1072: (void)tcsetpgrp(STDIN_FILENO, pager_pid);
1.255 schwarze 1073: #if HAVE_PLEDGE
1.258 schwarze 1074: if (pledge("stdio rpath tmppath tty proc", NULL) == -1)
1.255 schwarze 1075: err((int)MANDOCLEVEL_SYSERR, "pledge");
1076: #endif
1.259 ! schwarze 1077: tag_files->pager_pid = pager_pid;
1.245 schwarze 1078: return pager_pid;
1.184 schwarze 1079: }
1080:
1.224 schwarze 1081: /* The child process becomes the pager. */
1.184 schwarze 1082:
1.247 schwarze 1083: if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
1084: err((int)MANDOCLEVEL_SYSERR, "pager stdout");
1.244 schwarze 1085: close(tag_files->ofd);
1086: close(tag_files->tfd);
1.184 schwarze 1087: execvp(argv[0], argv);
1.247 schwarze 1088: err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
1.71 kristaps 1089: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to main.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc