[BACK]Return to main.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/main.c, Revision 1.352

1.352   ! schwarze    1: /* $Id: main.c,v 1.351 2020/07/20 16:57:30 schwarze Exp $ */
1.1       kristaps    2: /*
1.345     schwarze    3:  * Copyright (c) 2010-2012, 2014-2020 Ingo Schwarze <schwarze@openbsd.org>
1.183     schwarze    4:  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
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.345     schwarze   18:  *
                     19:  * Main program for mandoc(1), man(1), apropos(1), whatis(1), and help(1).
1.1       kristaps   20:  */
1.58      kristaps   21: #include "config.h"
1.178     schwarze   22:
                     23: #include <sys/types.h>
1.304     schwarze   24: #include <sys/ioctl.h>
1.216     schwarze   25: #include <sys/param.h> /* MACHINE */
1.326     schwarze   26: #include <sys/stat.h>
1.224     schwarze   27: #include <sys/wait.h>
1.58      kristaps   28:
1.1       kristaps   29: #include <assert.h>
1.185     schwarze   30: #include <ctype.h>
1.256     schwarze   31: #if HAVE_ERR
1.247     schwarze   32: #include <err.h>
1.256     schwarze   33: #endif
1.258     schwarze   34: #include <errno.h>
1.186     schwarze   35: #include <fcntl.h>
1.222     schwarze   36: #include <glob.h>
1.341     schwarze   37: #include <limits.h>
1.269     kristaps   38: #if HAVE_SANDBOX_INIT
                     39: #include <sandbox.h>
                     40: #endif
1.226     schwarze   41: #include <signal.h>
1.1       kristaps   42: #include <stdio.h>
1.45      kristaps   43: #include <stdint.h>
1.1       kristaps   44: #include <stdlib.h>
                     45: #include <string.h>
1.321     schwarze   46: #include <termios.h>
1.265     schwarze   47: #include <time.h>
1.1       kristaps   48: #include <unistd.h>
                     49:
1.231     schwarze   50: #include "mandoc_aux.h"
1.71      kristaps   51: #include "mandoc.h"
1.294     schwarze   52: #include "mandoc_xr.h"
1.231     schwarze   53: #include "roff.h"
1.1       kristaps   54: #include "mdoc.h"
1.10      kristaps   55: #include "man.h"
1.311     schwarze   56: #include "mandoc_parse.h"
1.348     schwarze   57: #include "tag.h"
1.345     schwarze   58: #include "term_tag.h"
1.231     schwarze   59: #include "main.h"
1.229     schwarze   60: #include "manconf.h"
1.180     schwarze   61: #include "mansearch.h"
1.16      kristaps   62:
1.181     schwarze   63: enum   outmode {
                     64:        OUTMODE_DEF = 0,
                     65:        OUTMODE_FLN,
                     66:        OUTMODE_LST,
                     67:        OUTMODE_ALL,
                     68:        OUTMODE_ONE
                     69: };
                     70:
1.19      kristaps   71: enum   outt {
1.154     kristaps   72:        OUTT_ASCII = 0, /* -Tascii */
1.162     kristaps   73:        OUTT_LOCALE,    /* -Tlocale */
1.163     kristaps   74:        OUTT_UTF8,      /* -Tutf8 */
1.154     kristaps   75:        OUTT_TREE,      /* -Ttree */
1.164     schwarze   76:        OUTT_MAN,       /* -Tman */
1.154     kristaps   77:        OUTT_HTML,      /* -Thtml */
1.285     schwarze   78:        OUTT_MARKDOWN,  /* -Tmarkdown */
1.154     kristaps   79:        OUTT_LINT,      /* -Tlint */
                     80:        OUTT_PS,        /* -Tps */
                     81:        OUTT_PDF        /* -Tpdf */
1.19      kristaps   82: };
                     83:
1.335     schwarze   84: struct outstate {
1.336     schwarze   85:        struct tag_files *tag_files;    /* Tagging state variables. */
1.293     schwarze   86:        void             *outdata;      /* data for output */
1.336     schwarze   87:        int               use_pager;
1.148     kristaps   88:        int               wstop;        /* stop after a file with a warning */
1.337     schwarze   89:        int               had_output;   /* Some output was generated. */
1.173     schwarze   90:        enum outt         outtype;      /* which output to use */
1.79      kristaps   91: };
1.270     schwarze   92:
                     93:
                     94: int                      mandocdb(int, char *[]);
1.79      kristaps   95:
1.312     schwarze   96: static void              check_xr(void);
1.213     schwarze   97: static int               fs_lookup(const struct manpaths *,
                     98:                                size_t ipath, const char *,
                     99:                                const char *, const char *,
                    100:                                struct manpage **, size_t *);
1.295     schwarze  101: static int               fs_search(const struct mansearch *,
1.340     schwarze  102:                                const struct manpaths *, const char *,
1.213     schwarze  103:                                struct manpage **, size_t *);
1.344     schwarze  104: static void              glob_esc(char **, const char *, const char *);
1.335     schwarze  105: static void              outdata_alloc(struct outstate *, struct manoutput *);
1.334     schwarze  106: static void              parse(struct mparse *, int, const char *,
1.335     schwarze  107:                                struct outstate *, struct manoutput *);
1.329     schwarze  108: static void              passthrough(int, int);
1.337     schwarze  109: static void              process_onefile(struct mparse *, struct manpage *,
                    110:                                int, struct outstate *, struct manconf *);
1.350     schwarze  111: static void              run_pager(struct outstate *, char *);
                    112: static pid_t             spawn_pager(struct outstate *, char *);
1.283     schwarze  113: static void              usage(enum argmode) __attribute__((__noreturn__));
1.334     schwarze  114: static int               woptions(char *, enum mandoc_os *, int *);
1.1       kristaps  115:
1.182     schwarze  116: static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
1.202     schwarze  117: static char              help_arg[] = "help";
                    118: static char             *help_argv[] = {help_arg, NULL};
1.1       kristaps  119:
1.173     schwarze  120:
1.1       kristaps  121: int
                    122: main(int argc, char *argv[])
                    123: {
1.334     schwarze  124:        struct manconf   conf;          /* Manpaths and output options. */
1.335     schwarze  125:        struct outstate  outst;         /* Output state. */
1.334     schwarze  126:        struct winsize   ws;            /* Result of ioctl(TIOCGWINSZ). */
                    127:        struct mansearch search;        /* Search options. */
1.338     schwarze  128:        struct manpage  *res;           /* Complete list of search results. */
                    129:        struct manpage  *resn;          /* Search results for one name. */
1.334     schwarze  130:        struct mparse   *mp;            /* Opaque parser object. */
                    131:        const char      *conf_file;     /* -C: alternate config file. */
                    132:        const char      *os_s;          /* -I: Operating system for display. */
1.337     schwarze  133:        const char      *progname, *sec;
1.334     schwarze  134:        char            *defpaths;      /* -M: override manpaths. */
                    135:        char            *auxpaths;      /* -m: additional manpaths. */
                    136:        char            *oarg;          /* -O: output option string. */
                    137:        char            *tagarg;        /* -O tag: default value. */
1.207     schwarze  138:        unsigned char   *uc;
1.338     schwarze  139:        size_t           ressz;         /* Number of elements in res[]. */
                    140:        size_t           resnsz;        /* Number of elements in resn[]. */
                    141:        size_t           i, ib, ssz;
1.334     schwarze  142:        int              options;       /* Parser options. */
                    143:        int              show_usage;    /* Invalid argument: give up. */
1.230     schwarze  144:        int              prio, best_prio;
1.337     schwarze  145:        int              startdir;
1.180     schwarze  146:        int              c;
1.334     schwarze  147:        enum mandoc_os   os_e;          /* Check base system conventions. */
                    148:        enum outmode     outmode;       /* According to command line. */
1.1       kristaps  149:
1.254     schwarze  150: #if HAVE_PROGNAME
                    151:        progname = getprogname();
                    152: #else
1.219     schwarze  153:        if (argc < 1)
1.254     schwarze  154:                progname = mandoc_strdup("mandoc");
                    155:        else if ((progname = strrchr(argv[0], '/')) == NULL)
                    156:                progname = argv[0];
1.54      kristaps  157:        else
1.254     schwarze  158:                ++progname;
                    159:        setprogname(progname);
1.247     schwarze  160: #endif
1.203     schwarze  161:
1.317     schwarze  162:        mandoc_msg_setoutfile(stderr);
1.254     schwarze  163:        if (strncmp(progname, "mandocdb", 8) == 0 ||
                    164:            strcmp(progname, BINM_MAKEWHATIS) == 0)
1.245     schwarze  165:                return mandocdb(argc, argv);
1.179     schwarze  166:
1.255     schwarze  167: #if HAVE_PLEDGE
1.352   ! schwarze  168:        if (pledge("stdio rpath wpath cpath tmppath tty proc exec", NULL) == -1) {
1.329     schwarze  169:                mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));
                    170:                return mandoc_msg_getrc();
                    171:        }
1.269     kristaps  172: #endif
                    173: #if HAVE_SANDBOX_INIT
                    174:        if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1)
                    175:                errx((int)MANDOCLEVEL_SYSERR, "sandbox_init");
1.255     schwarze  176: #endif
                    177:
1.180     schwarze  178:        /* Search options. */
                    179:
1.229     schwarze  180:        memset(&conf, 0, sizeof(conf));
1.334     schwarze  181:        conf_file = NULL;
                    182:        defpaths = auxpaths = NULL;
1.180     schwarze  183:
                    184:        memset(&search, 0, sizeof(struct mansearch));
                    185:        search.outkey = "Nd";
1.282     schwarze  186:        oarg = NULL;
1.180     schwarze  187:
1.254     schwarze  188:        if (strcmp(progname, BINM_MAN) == 0)
1.180     schwarze  189:                search.argmode = ARG_NAME;
1.254     schwarze  190:        else if (strcmp(progname, BINM_APROPOS) == 0)
1.180     schwarze  191:                search.argmode = ARG_EXPR;
1.254     schwarze  192:        else if (strcmp(progname, BINM_WHATIS) == 0)
1.180     schwarze  193:                search.argmode = ARG_WORD;
1.254     schwarze  194:        else if (strncmp(progname, "help", 4) == 0)
1.202     schwarze  195:                search.argmode = ARG_NAME;
1.180     schwarze  196:        else
                    197:                search.argmode = ARG_FILE;
                    198:
1.335     schwarze  199:        /* Parser options. */
1.54      kristaps  200:
1.335     schwarze  201:        options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.334     schwarze  202:        os_e = MANDOC_OS_OTHER;
                    203:        os_s = NULL;
1.335     schwarze  204:
                    205:        /* Formatter options. */
                    206:
                    207:        memset(&outst, 0, sizeof(outst));
1.336     schwarze  208:        outst.tag_files = NULL;
1.335     schwarze  209:        outst.outtype = OUTT_LOCALE;
1.336     schwarze  210:        outst.use_pager = 1;
1.19      kristaps  211:
1.180     schwarze  212:        show_usage = 0;
1.181     schwarze  213:        outmode = OUTMODE_DEF;
1.183     schwarze  214:
1.289     schwarze  215:        while ((c = getopt(argc, argv,
                    216:            "aC:cfhI:iK:klM:m:O:S:s:T:VW:w")) != -1) {
                    217:                if (c == 'i' && search.argmode == ARG_EXPR) {
                    218:                        optind--;
                    219:                        break;
                    220:                }
1.1       kristaps  221:                switch (c) {
1.181     schwarze  222:                case 'a':
                    223:                        outmode = OUTMODE_ALL;
                    224:                        break;
1.180     schwarze  225:                case 'C':
                    226:                        conf_file = optarg;
                    227:                        break;
1.183     schwarze  228:                case 'c':
1.336     schwarze  229:                        outst.use_pager = 0;
1.183     schwarze  230:                        break;
1.180     schwarze  231:                case 'f':
                    232:                        search.argmode = ARG_WORD;
                    233:                        break;
1.190     schwarze  234:                case 'h':
1.230     schwarze  235:                        conf.output.synopsisonly = 1;
1.336     schwarze  236:                        outst.use_pager = 0;
1.190     schwarze  237:                        outmode = OUTMODE_ALL;
                    238:                        break;
1.173     schwarze  239:                case 'I':
1.329     schwarze  240:                        if (strncmp(optarg, "os=", 3) != 0) {
                    241:                                mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
                    242:                                    "-I %s", optarg);
                    243:                                return mandoc_msg_getrc();
1.166     schwarze  244:                        }
1.334     schwarze  245:                        if (os_s != NULL) {
1.329     schwarze  246:                                mandoc_msg(MANDOCERR_BADARG_DUPE, 0, 0,
                    247:                                    "-I %s", optarg);
                    248:                                return mandoc_msg_getrc();
1.166     schwarze  249:                        }
1.334     schwarze  250:                        os_s = optarg + 3;
1.181     schwarze  251:                        break;
1.194     schwarze  252:                case 'K':
1.329     schwarze  253:                        options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
                    254:                        if (strcmp(optarg, "utf-8") == 0)
                    255:                                options |=  MPARSE_UTF8;
                    256:                        else if (strcmp(optarg, "iso-8859-1") == 0)
                    257:                                options |=  MPARSE_LATIN1;
                    258:                        else if (strcmp(optarg, "us-ascii") != 0) {
                    259:                                mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
                    260:                                    "-K %s", optarg);
                    261:                                return mandoc_msg_getrc();
                    262:                        }
1.194     schwarze  263:                        break;
1.180     schwarze  264:                case 'k':
                    265:                        search.argmode = ARG_EXPR;
                    266:                        break;
1.188     schwarze  267:                case 'l':
                    268:                        search.argmode = ARG_FILE;
                    269:                        outmode = OUTMODE_ALL;
                    270:                        break;
1.180     schwarze  271:                case 'M':
                    272:                        defpaths = optarg;
                    273:                        break;
1.173     schwarze  274:                case 'm':
1.180     schwarze  275:                        auxpaths = optarg;
1.10      kristaps  276:                        break;
1.173     schwarze  277:                case 'O':
1.282     schwarze  278:                        oarg = optarg;
1.44      kristaps  279:                        break;
1.180     schwarze  280:                case 'S':
                    281:                        search.arch = optarg;
                    282:                        break;
                    283:                case 's':
                    284:                        search.sec = optarg;
                    285:                        break;
1.173     schwarze  286:                case 'T':
1.329     schwarze  287:                        if (strcmp(optarg, "ascii") == 0)
1.335     schwarze  288:                                outst.outtype = OUTT_ASCII;
1.329     schwarze  289:                        else if (strcmp(optarg, "lint") == 0) {
1.335     schwarze  290:                                outst.outtype = OUTT_LINT;
1.329     schwarze  291:                                mandoc_msg_setoutfile(stdout);
                    292:                                mandoc_msg_setmin(MANDOCERR_BASE);
                    293:                        } else if (strcmp(optarg, "tree") == 0)
1.335     schwarze  294:                                outst.outtype = OUTT_TREE;
1.329     schwarze  295:                        else if (strcmp(optarg, "man") == 0)
1.335     schwarze  296:                                outst.outtype = OUTT_MAN;
1.329     schwarze  297:                        else if (strcmp(optarg, "html") == 0)
1.335     schwarze  298:                                outst.outtype = OUTT_HTML;
1.329     schwarze  299:                        else if (strcmp(optarg, "markdown") == 0)
1.335     schwarze  300:                                outst.outtype = OUTT_MARKDOWN;
1.329     schwarze  301:                        else if (strcmp(optarg, "utf8") == 0)
1.335     schwarze  302:                                outst.outtype = OUTT_UTF8;
1.329     schwarze  303:                        else if (strcmp(optarg, "locale") == 0)
1.335     schwarze  304:                                outst.outtype = OUTT_LOCALE;
1.329     schwarze  305:                        else if (strcmp(optarg, "ps") == 0)
1.335     schwarze  306:                                outst.outtype = OUTT_PS;
1.329     schwarze  307:                        else if (strcmp(optarg, "pdf") == 0)
1.335     schwarze  308:                                outst.outtype = OUTT_PDF;
1.329     schwarze  309:                        else {
                    310:                                mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
                    311:                                    "-T %s", optarg);
                    312:                                return mandoc_msg_getrc();
                    313:                        }
1.1       kristaps  314:                        break;
1.173     schwarze  315:                case 'W':
1.335     schwarze  316:                        if (woptions(optarg, &os_e, &outst.wstop) == -1)
1.329     schwarze  317:                                return mandoc_msg_getrc();
1.1       kristaps  318:                        break;
1.181     schwarze  319:                case 'w':
                    320:                        outmode = OUTMODE_FLN;
                    321:                        break;
1.1       kristaps  322:                default:
1.180     schwarze  323:                        show_usage = 1;
                    324:                        break;
1.1       kristaps  325:                }
1.180     schwarze  326:        }
                    327:
                    328:        if (show_usage)
                    329:                usage(search.argmode);
                    330:
1.185     schwarze  331:        /* Postprocess options. */
                    332:
1.342     schwarze  333:        switch (outmode) {
                    334:        case OUTMODE_DEF:
1.181     schwarze  335:                switch (search.argmode) {
                    336:                case ARG_FILE:
                    337:                        outmode = OUTMODE_ALL;
1.336     schwarze  338:                        outst.use_pager = 0;
1.181     schwarze  339:                        break;
                    340:                case ARG_NAME:
                    341:                        outmode = OUTMODE_ONE;
                    342:                        break;
                    343:                default:
                    344:                        outmode = OUTMODE_LST;
                    345:                        break;
1.282     schwarze  346:                }
1.342     schwarze  347:                break;
                    348:        case OUTMODE_FLN:
                    349:                if (search.argmode == ARG_FILE)
                    350:                        outmode = OUTMODE_ALL;
                    351:                break;
                    352:        case OUTMODE_ALL:
                    353:                break;
                    354:        case OUTMODE_LST:
                    355:        case OUTMODE_ONE:
                    356:                abort();
1.282     schwarze  357:        }
                    358:
                    359:        if (oarg != NULL) {
                    360:                if (outmode == OUTMODE_LST)
                    361:                        search.outkey = oarg;
                    362:                else {
                    363:                        while (oarg != NULL) {
                    364:                                if (manconf_output(&conf.output,
1.327     schwarze  365:                                    strsep(&oarg, ","), 0) == -1)
1.329     schwarze  366:                                        return mandoc_msg_getrc();
1.282     schwarze  367:                        }
1.181     schwarze  368:                }
                    369:        }
                    370:
1.335     schwarze  371:        if (outst.outtype != OUTT_TREE || conf.output.noval == 0)
1.315     schwarze  372:                options |= MPARSE_VALIDATE;
                    373:
1.246     schwarze  374:        if (outmode == OUTMODE_FLN ||
                    375:            outmode == OUTMODE_LST ||
1.352   ! schwarze  376:            (conf.output.outfilename == NULL &&
        !           377:             conf.output.tagfilename == NULL &&
        !           378:             isatty(STDOUT_FILENO) == 0))
1.336     schwarze  379:                outst.use_pager = 0;
1.304     schwarze  380:
1.336     schwarze  381:        if (outst.use_pager &&
1.304     schwarze  382:            (conf.output.width == 0 || conf.output.indent == 0) &&
1.306     schwarze  383:            ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) != -1 &&
                    384:            ws.ws_col > 1) {
1.304     schwarze  385:                if (conf.output.width == 0 && ws.ws_col < 79)
                    386:                        conf.output.width = ws.ws_col - 1;
                    387:                if (conf.output.indent == 0 && ws.ws_col < 66)
                    388:                        conf.output.indent = 3;
                    389:        }
1.246     schwarze  390:
1.255     schwarze  391: #if HAVE_PLEDGE
1.352   ! schwarze  392:        if (outst.use_pager == 0)
        !           393:                c = pledge("stdio rpath", NULL);
        !           394:        else if (conf.output.outfilename != NULL ||
        !           395:            conf.output.tagfilename != NULL)
        !           396:                c = pledge("stdio rpath wpath cpath", NULL);
        !           397:        else
        !           398:                c = pledge("stdio rpath tmppath tty proc exec", NULL);
        !           399:        if (c == -1) {
        !           400:                mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));
        !           401:                return mandoc_msg_getrc();
1.329     schwarze  402:        }
1.255     schwarze  403: #endif
                    404:
1.185     schwarze  405:        /* Parse arguments. */
                    406:
1.219     schwarze  407:        if (argc > 0) {
                    408:                argc -= optind;
                    409:                argv += optind;
                    410:        }
1.185     schwarze  411:
1.202     schwarze  412:        /*
1.338     schwarze  413:         * Quirks for help(1) and man(1),
                    414:         * in particular for a section argument without -s.
1.202     schwarze  415:         */
                    416:
                    417:        if (search.argmode == ARG_NAME) {
1.254     schwarze  418:                if (*progname == 'h') {
1.202     schwarze  419:                        if (argc == 0) {
                    420:                                argv = help_argv;
                    421:                                argc = 1;
                    422:                        }
1.211     schwarze  423:                } else if (argc > 1 &&
1.223     kristaps  424:                    ((uc = (unsigned char *)argv[0]) != NULL) &&
1.207     schwarze  425:                    ((isdigit(uc[0]) && (uc[1] == '\0' ||
1.324     schwarze  426:                      isalpha(uc[1]))) ||
1.207     schwarze  427:                     (uc[0] == 'n' && uc[1] == '\0'))) {
1.223     kristaps  428:                        search.sec = (char *)uc;
1.202     schwarze  429:                        argv++;
                    430:                        argc--;
                    431:                }
1.216     schwarze  432:                if (search.arch == NULL)
                    433:                        search.arch = getenv("MACHINE");
1.223     kristaps  434: #ifdef MACHINE
1.216     schwarze  435:                if (search.arch == NULL)
                    436:                        search.arch = MACHINE;
1.223     kristaps  437: #endif
1.338     schwarze  438:                if (outmode == OUTMODE_ONE)
                    439:                        search.firstmatch = 1;
1.185     schwarze  440:        }
1.182     schwarze  441:
1.316     schwarze  442:        /*
                    443:         * Use the first argument for -O tag in addition to
                    444:         * using it as a search term for man(1) or apropos(1).
                    445:         */
                    446:
                    447:        if (conf.output.tag != NULL && *conf.output.tag == '\0') {
                    448:                tagarg = argc > 0 && search.argmode == ARG_EXPR ?
                    449:                    strchr(*argv, '=') : NULL;
                    450:                conf.output.tag = tagarg == NULL ? *argv : tagarg + 1;
                    451:        }
                    452:
1.338     schwarze  453:        /* Read the configuration file. */
1.180     schwarze  454:
1.338     schwarze  455:        if (search.argmode != ARG_FILE)
                    456:                manconf_parse(&conf, conf_file, defpaths, auxpaths);
1.182     schwarze  457:
1.338     schwarze  458:        /* man(1): Resolve each name individually. */
1.182     schwarze  459:
1.338     schwarze  460:        if (search.argmode == ARG_NAME) {
1.343     schwarze  461:                if (argc < 1) {
                    462:                        if (outmode != OUTMODE_FLN)
                    463:                                usage(ARG_NAME);
                    464:                        if (conf.manpath.sz == 0) {
                    465:                                warnx("The manpath is empty.");
                    466:                                mandoc_msg_setrc(MANDOCLEVEL_BADARG);
                    467:                        } else {
                    468:                                for (i = 0; i + 1 < conf.manpath.sz; i++)
                    469:                                        printf("%s:", conf.manpath.paths[i]);
                    470:                                printf("%s\n", conf.manpath.paths[i]);
                    471:                        }
                    472:                        manconf_free(&conf);
                    473:                        return (int)mandoc_msg_getrc();
                    474:                }
1.338     schwarze  475:                for (res = NULL, ressz = 0; argc > 0; argc--, argv++) {
                    476:                        (void)mansearch(&search, &conf.manpath,
                    477:                            1, argv, &resn, &resnsz);
                    478:                        if (resnsz == 0)
                    479:                                (void)fs_search(&search, &conf.manpath,
1.340     schwarze  480:                                    *argv, &resn, &resnsz);
                    481:                        if (resnsz == 0 && strchr(*argv, '/') == NULL) {
                    482:                                if (search.arch != NULL &&
                    483:                                    arch_valid(search.arch, OSENUM) == 0)
                    484:                                        warnx("Unknown architecture \"%s\".",
                    485:                                            search.arch);
                    486:                                else if (search.sec != NULL)
                    487:                                        warnx("No entry for %s in "
                    488:                                            "section %s of the manual.",
                    489:                                            *argv, search.sec);
                    490:                                else
                    491:                                        warnx("No entry for %s in "
                    492:                                            "the manual.", *argv);
                    493:                                mandoc_msg_setrc(MANDOCLEVEL_BADARG);
                    494:                                continue;
                    495:                        }
1.338     schwarze  496:                        if (resnsz == 0) {
                    497:                                if (access(*argv, R_OK) == -1) {
                    498:                                        mandoc_msg_setinfilename(*argv);
1.329     schwarze  499:                                        mandoc_msg(MANDOCERR_BADARG_BAD,
                    500:                                            0, 0, "%s", strerror(errno));
                    501:                                        mandoc_msg_setinfilename(NULL);
1.305     schwarze  502:                                        continue;
                    503:                                }
1.338     schwarze  504:                                resnsz = 1;
                    505:                                resn = mandoc_calloc(resnsz, sizeof(*res));
                    506:                                resn->file = mandoc_strdup(*argv);
                    507:                                resn->ipath = SIZE_MAX;
                    508:                                resn->form = FORM_SRC;
                    509:                        }
                    510:                        if (outmode != OUTMODE_ONE || resnsz == 1) {
1.305     schwarze  511:                                res = mandoc_reallocarray(res,
1.338     schwarze  512:                                    ressz + resnsz, sizeof(*res));
                    513:                                memcpy(res + ressz, resn,
                    514:                                    sizeof(*resn) * resnsz);
                    515:                                ressz += resnsz;
                    516:                                continue;
1.305     schwarze  517:                        }
1.187     schwarze  518:
1.338     schwarze  519:                        /* Search for the best section. */
1.182     schwarze  520:
1.325     schwarze  521:                        best_prio = 40;
1.338     schwarze  522:                        for (ib = i = 0; i < resnsz; i++) {
                    523:                                sec = resn[i].file;
1.264     schwarze  524:                                sec += strcspn(sec, "123456789");
                    525:                                if (sec[0] == '\0')
1.325     schwarze  526:                                        continue; /* No section at all. */
1.264     schwarze  527:                                prio = sec_prios[sec[0] - '1'];
1.325     schwarze  528:                                if (search.sec != NULL) {
                    529:                                        ssz = strlen(search.sec);
                    530:                                        if (strncmp(sec, search.sec, ssz) == 0)
                    531:                                                sec += ssz;
                    532:                                } else
                    533:                                        sec++; /* Prefer without suffix. */
                    534:                                if (*sec != '/')
                    535:                                        prio += 10; /* Wrong dir name. */
                    536:                                if (search.sec != NULL &&
                    537:                                    (strlen(sec) <= ssz  + 3 ||
                    538:                                     strcmp(sec + strlen(sec) - ssz,
                    539:                                      search.sec) != 0))
                    540:                                        prio += 20; /* Wrong file ext. */
1.182     schwarze  541:                                if (prio >= best_prio)
                    542:                                        continue;
                    543:                                best_prio = prio;
1.338     schwarze  544:                                ib = i;
1.182     schwarze  545:                        }
1.338     schwarze  546:                        res = mandoc_reallocarray(res, ressz + 1,
                    547:                            sizeof(*res));
                    548:                        memcpy(res + ressz++, resn + ib, sizeof(*resn));
1.181     schwarze  549:                }
1.182     schwarze  550:
1.338     schwarze  551:        /* apropos(1), whatis(1): Process the full search expression. */
                    552:
                    553:        } else if (search.argmode != ARG_FILE) {
                    554:                if (mansearch(&search, &conf.manpath,
                    555:                    argc, argv, &res, &ressz) == 0)
                    556:                        usage(search.argmode);
1.182     schwarze  557:
1.338     schwarze  558:                if (ressz == 0) {
                    559:                        warnx("nothing appropriate");
                    560:                        mandoc_msg_setrc(MANDOCLEVEL_BADARG);
1.182     schwarze  561:                        goto out;
1.338     schwarze  562:                }
                    563:
                    564:        /* mandoc(1): Take command line arguments as file names. */
                    565:
1.337     schwarze  566:        } else {
1.338     schwarze  567:                ressz = argc > 0 ? argc : 1;
                    568:                res = mandoc_calloc(ressz, sizeof(*res));
                    569:                for (i = 0; i < ressz; i++) {
1.337     schwarze  570:                        if (argc > 0)
                    571:                                res[i].file = mandoc_strdup(argv[i]);
                    572:                        res[i].ipath = SIZE_MAX;
                    573:                        res[i].form = FORM_SRC;
                    574:                }
1.180     schwarze  575:        }
                    576:
1.338     schwarze  577:        switch (outmode) {
                    578:        case OUTMODE_FLN:
                    579:                for (i = 0; i < ressz; i++)
                    580:                        puts(res[i].file);
                    581:                goto out;
                    582:        case OUTMODE_LST:
                    583:                for (i = 0; i < ressz; i++)
                    584:                        printf("%s - %s\n", res[i].names,
                    585:                            res[i].output == NULL ? "" :
                    586:                            res[i].output);
                    587:                goto out;
                    588:        default:
                    589:                break;
                    590:        }
1.255     schwarze  591:
1.329     schwarze  592:        if (search.argmode == ARG_FILE && auxpaths != NULL) {
                    593:                if (strcmp(auxpaths, "doc") == 0)
                    594:                        options |= MPARSE_MDOC;
                    595:                else if (strcmp(auxpaths, "an") == 0)
                    596:                        options |= MPARSE_MAN;
                    597:        }
1.241     schwarze  598:
1.249     schwarze  599:        mchars_alloc();
1.334     schwarze  600:        mp = mparse_alloc(options, os_e, os_s);
1.154     kristaps  601:
1.305     schwarze  602:        /*
                    603:         * Remember the original working directory, if possible.
                    604:         * This will be needed if some names on the command line
                    605:         * are page names and some are relative file names.
                    606:         * Do not error out if the current directory is not
                    607:         * readable: Maybe it won't be needed after all.
                    608:         */
                    609:        startdir = open(".", O_RDONLY | O_DIRECTORY);
1.338     schwarze  610:        for (i = 0; i < ressz; i++) {
                    611:                process_onefile(mp, res + i, startdir, &outst, &conf);
1.335     schwarze  612:                if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
1.64      kristaps  613:                        break;
1.1       kristaps  614:        }
1.305     schwarze  615:        if (startdir != -1) {
                    616:                (void)fchdir(startdir);
                    617:                close(startdir);
                    618:        }
1.348     schwarze  619:        if (conf.output.tag != NULL && conf.output.tag_found == 0) {
                    620:                mandoc_msg(MANDOCERR_TAG, 0, 0, "%s", conf.output.tag);
                    621:                conf.output.tag = NULL;
                    622:        }
1.335     schwarze  623:        if (outst.outdata != NULL) {
                    624:                switch (outst.outtype) {
1.252     schwarze  625:                case OUTT_HTML:
1.335     schwarze  626:                        html_free(outst.outdata);
1.252     schwarze  627:                        break;
                    628:                case OUTT_UTF8:
                    629:                case OUTT_LOCALE:
                    630:                case OUTT_ASCII:
1.335     schwarze  631:                        ascii_free(outst.outdata);
1.252     schwarze  632:                        break;
                    633:                case OUTT_PDF:
                    634:                case OUTT_PS:
1.335     schwarze  635:                        pspdf_free(outst.outdata);
1.252     schwarze  636:                        break;
                    637:                default:
                    638:                        break;
                    639:                }
1.250     schwarze  640:        }
1.294     schwarze  641:        mandoc_xr_free();
1.334     schwarze  642:        mparse_free(mp);
1.249     schwarze  643:        mchars_free();
1.182     schwarze  644:
                    645: out:
1.338     schwarze  646:        mansearch_free(res, ressz);
1.337     schwarze  647:        if (search.argmode != ARG_FILE)
1.229     schwarze  648:                manconf_free(&conf);
1.1       kristaps  649:
1.336     schwarze  650:        if (outst.tag_files != NULL) {
1.352   ! schwarze  651:                if (term_tag_close() != -1 &&
        !           652:                    conf.output.outfilename == NULL &&
        !           653:                    conf.output.tagfilename == NULL)
1.350     schwarze  654:                        run_pager(&outst, conf.output.tag);
1.345     schwarze  655:                term_tag_unlink();
1.337     schwarze  656:        } else if (outst.had_output && outst.outtype != OUTT_LINT)
1.330     schwarze  657:                mandoc_msg_summary();
                    658:
1.312     schwarze  659:        return (int)mandoc_msg_getrc();
1.1       kristaps  660: }
                    661:
1.55      kristaps  662: static void
1.180     schwarze  663: usage(enum argmode argmode)
1.1       kristaps  664: {
1.180     schwarze  665:        switch (argmode) {
                    666:        case ARG_FILE:
1.287     schwarze  667:                fputs("usage: mandoc [-ac] [-I os=name] "
                    668:                    "[-K encoding] [-mdoc | -man] [-O options]\n"
1.228     schwarze  669:                    "\t      [-T output] [-W level] [file ...]\n", stderr);
1.180     schwarze  670:                break;
                    671:        case ARG_NAME:
1.287     schwarze  672:                fputs("usage: man [-acfhklw] [-C file] [-M path] "
                    673:                    "[-m path] [-S subsection]\n"
                    674:                    "\t   [[-s] section] name ...\n", stderr);
1.180     schwarze  675:                break;
                    676:        case ARG_WORD:
1.287     schwarze  677:                fputs("usage: whatis [-afk] [-C file] "
1.188     schwarze  678:                    "[-M path] [-m path] [-O outkey] [-S arch]\n"
                    679:                    "\t      [-s section] name ...\n", stderr);
1.180     schwarze  680:                break;
                    681:        case ARG_EXPR:
1.287     schwarze  682:                fputs("usage: apropos [-afk] [-C file] "
1.188     schwarze  683:                    "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.180     schwarze  684:                    "\t       [-s section] expression ...\n", stderr);
                    685:                break;
                    686:        }
1.105     kristaps  687:        exit((int)MANDOCLEVEL_BADARG);
1.68      joerg     688: }
1.213     schwarze  689:
1.344     schwarze  690: static void
                    691: glob_esc(char **dst, const char *src, const char *suffix)
                    692: {
                    693:        while (*src != '\0') {
                    694:                if (strchr("*?[", *src) != NULL)
                    695:                        *(*dst)++ = '\\';
                    696:                *(*dst)++ = *src++;
                    697:        }
                    698:        while (*suffix != '\0')
                    699:                *(*dst)++ = *suffix++;
                    700: }
                    701:
1.213     schwarze  702: static int
                    703: fs_lookup(const struct manpaths *paths, size_t ipath,
                    704:        const char *sec, const char *arch, const char *name,
                    705:        struct manpage **res, size_t *ressz)
                    706: {
1.326     schwarze  707:        struct stat      sb;
1.222     schwarze  708:        glob_t           globinfo;
1.213     schwarze  709:        struct manpage  *page;
1.344     schwarze  710:        char            *file, *cp;
1.274     schwarze  711:        int              globres;
                    712:        enum form        form;
1.213     schwarze  713:
1.344     schwarze  714:        const char *const slman = "/man";
                    715:        const char *const slash = "/";
                    716:        const char *const sglob = ".[01-9]*";
                    717:
1.222     schwarze  718:        form = FORM_SRC;
1.213     schwarze  719:        mandoc_asprintf(&file, "%s/man%s/%s.%s",
                    720:            paths->paths[ipath], sec, name, sec);
1.326     schwarze  721:        if (stat(file, &sb) != -1)
1.213     schwarze  722:                goto found;
                    723:        free(file);
                    724:
                    725:        mandoc_asprintf(&file, "%s/cat%s/%s.0",
                    726:            paths->paths[ipath], sec, name);
1.326     schwarze  727:        if (stat(file, &sb) != -1) {
1.213     schwarze  728:                form = FORM_CAT;
                    729:                goto found;
                    730:        }
                    731:        free(file);
                    732:
                    733:        if (arch != NULL) {
                    734:                mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
                    735:                    paths->paths[ipath], sec, arch, name, sec);
1.326     schwarze  736:                if (stat(file, &sb) != -1)
1.213     schwarze  737:                        goto found;
                    738:                free(file);
                    739:        }
1.222     schwarze  740:
1.344     schwarze  741:        cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
                    742:            strlen(slman) + strlen(sec) * 2 + strlen(slash) +
                    743:            strlen(name) * 2 + strlen(sglob) + 1);
                    744:        glob_esc(&cp, paths->paths[ipath], slman);
                    745:        glob_esc(&cp, sec, slash);
                    746:        glob_esc(&cp, name, sglob);
                    747:        *cp = '\0';
1.222     schwarze  748:        globres = glob(file, 0, NULL, &globinfo);
                    749:        if (globres != 0 && globres != GLOB_NOMATCH)
1.329     schwarze  750:                mandoc_msg(MANDOCERR_GLOB, 0, 0,
                    751:                    "%s: %s", file, strerror(errno));
1.222     schwarze  752:        free(file);
                    753:        if (globres == 0)
                    754:                file = mandoc_strdup(*globinfo.gl_pathv);
                    755:        globfree(&globinfo);
1.326     schwarze  756:        if (globres == 0) {
                    757:                if (stat(file, &sb) != -1)
                    758:                        goto found;
                    759:                free(file);
                    760:        }
1.296     schwarze  761:        if (res != NULL || ipath + 1 != paths->sz)
1.329     schwarze  762:                return -1;
1.213     schwarze  763:
1.296     schwarze  764:        mandoc_asprintf(&file, "%s.%s", name, sec);
1.326     schwarze  765:        globres = stat(file, &sb);
1.296     schwarze  766:        free(file);
1.329     schwarze  767:        return globres;
1.296     schwarze  768:
1.213     schwarze  769: found:
1.266     schwarze  770:        warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
                    771:            name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
1.296     schwarze  772:        if (res == NULL) {
                    773:                free(file);
1.329     schwarze  774:                return 0;
1.296     schwarze  775:        }
1.329     schwarze  776:        *res = mandoc_reallocarray(*res, ++*ressz, sizeof(**res));
1.213     schwarze  777:        page = *res + (*ressz - 1);
                    778:        page->file = file;
                    779:        page->names = NULL;
                    780:        page->output = NULL;
1.323     schwarze  781:        page->bits = NAME_FILE & NAME_MASK;
1.213     schwarze  782:        page->ipath = ipath;
                    783:        page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
                    784:        page->form = form;
1.329     schwarze  785:        return 0;
1.213     schwarze  786: }
                    787:
1.295     schwarze  788: static int
1.213     schwarze  789: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
1.340     schwarze  790:        const char *name, struct manpage **res, size_t *ressz)
1.213     schwarze  791: {
                    792:        const char *const sections[] =
1.264     schwarze  793:            {"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"};
1.213     schwarze  794:        const size_t nsec = sizeof(sections)/sizeof(sections[0]);
                    795:
1.340     schwarze  796:        size_t           ipath, isec;
1.213     schwarze  797:
                    798:        assert(cfg->argmode == ARG_NAME);
1.295     schwarze  799:        if (res != NULL)
                    800:                *res = NULL;
1.340     schwarze  801:        *ressz = 0;
                    802:        for (ipath = 0; ipath < paths->sz; ipath++) {
                    803:                if (cfg->sec != NULL) {
                    804:                        if (fs_lookup(paths, ipath, cfg->sec, cfg->arch,
                    805:                            name, res, ressz) != -1 && cfg->firstmatch)
                    806:                                return 0;
                    807:                } else {
                    808:                        for (isec = 0; isec < nsec; isec++)
1.213     schwarze  809:                                if (fs_lookup(paths, ipath, sections[isec],
1.340     schwarze  810:                                    cfg->arch, name, res, ressz) != -1 &&
1.213     schwarze  811:                                    cfg->firstmatch)
1.329     schwarze  812:                                        return 0;
1.213     schwarze  813:                }
                    814:        }
1.329     schwarze  815:        return -1;
1.213     schwarze  816: }
1.68      joerg     817:
1.64      kristaps  818: static void
1.337     schwarze  819: process_onefile(struct mparse *mp, struct manpage *resp, int startdir,
                    820:     struct outstate *outst, struct manconf *conf)
                    821: {
                    822:        int      fd;
                    823:
                    824:        /*
                    825:         * Changing directories is not needed in ARG_FILE mode.
                    826:         * Do it on a best-effort basis.  Even in case of
                    827:         * failure, some functionality may still work.
                    828:         */
                    829:        if (resp->ipath != SIZE_MAX)
                    830:                (void)chdir(conf->manpath.paths[resp->ipath]);
                    831:        else if (startdir != -1)
                    832:                (void)fchdir(startdir);
                    833:
                    834:        mandoc_msg_setinfilename(resp->file);
                    835:        if (resp->file != NULL) {
                    836:                if ((fd = mparse_open(mp, resp->file)) == -1) {
                    837:                        mandoc_msg(resp->ipath == SIZE_MAX ?
                    838:                            MANDOCERR_BADARG_BAD : MANDOCERR_OPEN,
                    839:                            0, 0, "%s", strerror(errno));
                    840:                        mandoc_msg_setinfilename(NULL);
                    841:                        return;
                    842:                }
                    843:        } else
                    844:                fd = STDIN_FILENO;
                    845:
1.347     schwarze  846:        if (outst->use_pager) {
                    847:                outst->use_pager = 0;
1.352   ! schwarze  848:                outst->tag_files = term_tag_init(conf->output.outfilename,
        !           849:                    conf->output.tagfilename);
        !           850:                if ((conf->output.outfilename != NULL ||
        !           851:                     conf->output.tagfilename != NULL) &&
        !           852:                    pledge("stdio rpath cpath", NULL) == -1) {
        !           853:                        mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
        !           854:                            "%s", strerror(errno));
        !           855:                        exit(mandoc_msg_getrc());
        !           856:                }
1.347     schwarze  857:        }
                    858:        if (outst->had_output && outst->outtype <= OUTT_UTF8) {
                    859:                if (outst->outdata == NULL)
                    860:                        outdata_alloc(outst, &conf->output);
                    861:                terminal_sepline(outst->outdata);
1.337     schwarze  862:        }
                    863:
                    864:        if (resp->form == FORM_SRC)
                    865:                parse(mp, fd, resp->file, outst, &conf->output);
                    866:        else {
                    867:                passthrough(fd, conf->output.synopsisonly);
                    868:                outst->had_output = 1;
                    869:        }
                    870:
                    871:        if (ferror(stdout)) {
                    872:                if (outst->tag_files != NULL) {
                    873:                        mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s",
                    874:                            outst->tag_files->ofn, strerror(errno));
1.345     schwarze  875:                        term_tag_unlink();
1.337     schwarze  876:                        outst->tag_files = NULL;
                    877:                } else
                    878:                        mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s",
                    879:                            strerror(errno));
                    880:        }
                    881:        mandoc_msg_setinfilename(NULL);
                    882: }
                    883:
                    884: static void
1.335     schwarze  885: parse(struct mparse *mp, int fd, const char *file,
                    886:     struct outstate *outst, struct manoutput *outconf)
1.1       kristaps  887: {
1.337     schwarze  888:        static int               previous;
                    889:        struct roff_meta        *meta;
1.112     kristaps  890:
1.337     schwarze  891:        assert(fd >= 0);
                    892:        if (file == NULL)
                    893:                file = "<stdin>";
1.112     kristaps  894:
1.337     schwarze  895:        if (previous)
                    896:                mparse_reset(mp);
                    897:        else
                    898:                previous = 1;
1.112     kristaps  899:
1.334     schwarze  900:        mparse_readfd(mp, fd, file);
1.261     schwarze  901:        if (fd != STDIN_FILENO)
                    902:                close(fd);
1.112     kristaps  903:
1.1       kristaps  904:        /*
1.154     kristaps  905:         * With -Wstop and warnings or errors of at least the requested
                    906:         * level, do not produce output.
1.1       kristaps  907:         */
                    908:
1.335     schwarze  909:        if (outst->wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
1.227     schwarze  910:                return;
1.111     kristaps  911:
1.335     schwarze  912:        if (outst->outdata == NULL)
                    913:                outdata_alloc(outst, outconf);
                    914:        else if (outst->outtype == OUTT_HTML)
1.349     schwarze  915:                html_reset(outst->outdata);
1.111     kristaps  916:
1.315     schwarze  917:        mandoc_xr_reset();
1.334     schwarze  918:        meta = mparse_result(mp);
1.250     schwarze  919:
                    920:        /* Execute the out device, if it exists. */
                    921:
1.337     schwarze  922:        outst->had_output = 1;
1.315     schwarze  923:        if (meta->macroset == MACROSET_MDOC) {
1.335     schwarze  924:                switch (outst->outtype) {
1.173     schwarze  925:                case OUTT_HTML:
1.335     schwarze  926:                        html_mdoc(outst->outdata, meta);
1.111     kristaps  927:                        break;
1.173     schwarze  928:                case OUTT_TREE:
1.335     schwarze  929:                        tree_mdoc(outst->outdata, meta);
1.111     kristaps  930:                        break;
1.173     schwarze  931:                case OUTT_MAN:
1.335     schwarze  932:                        man_mdoc(outst->outdata, meta);
1.164     schwarze  933:                        break;
1.173     schwarze  934:                case OUTT_PDF:
                    935:                case OUTT_ASCII:
                    936:                case OUTT_UTF8:
                    937:                case OUTT_LOCALE:
                    938:                case OUTT_PS:
1.335     schwarze  939:                        terminal_mdoc(outst->outdata, meta);
1.250     schwarze  940:                        break;
1.285     schwarze  941:                case OUTT_MARKDOWN:
1.335     schwarze  942:                        markdown_mdoc(outst->outdata, meta);
1.285     schwarze  943:                        break;
1.250     schwarze  944:                default:
                    945:                        break;
                    946:                }
                    947:        }
1.315     schwarze  948:        if (meta->macroset == MACROSET_MAN) {
1.335     schwarze  949:                switch (outst->outtype) {
1.250     schwarze  950:                case OUTT_HTML:
1.335     schwarze  951:                        html_man(outst->outdata, meta);
1.250     schwarze  952:                        break;
                    953:                case OUTT_TREE:
1.335     schwarze  954:                        tree_man(outst->outdata, meta);
1.250     schwarze  955:                        break;
                    956:                case OUTT_MAN:
1.334     schwarze  957:                        mparse_copy(mp);
1.250     schwarze  958:                        break;
                    959:                case OUTT_PDF:
                    960:                case OUTT_ASCII:
                    961:                case OUTT_UTF8:
                    962:                case OUTT_LOCALE:
                    963:                case OUTT_PS:
1.335     schwarze  964:                        terminal_man(outst->outdata, meta);
1.111     kristaps  965:                        break;
                    966:                default:
                    967:                        break;
                    968:                }
1.276     schwarze  969:        }
1.348     schwarze  970:        if (outconf->tag != NULL && outconf->tag_found == 0 &&
                    971:            tag_exists(outconf->tag))
                    972:                outconf->tag_found = 1;
1.312     schwarze  973:        if (mandoc_msg_getmin() < MANDOCERR_STYLE)
                    974:                check_xr();
1.294     schwarze  975: }
                    976:
                    977: static void
1.312     schwarze  978: check_xr(void)
1.294     schwarze  979: {
                    980:        static struct manpaths   paths;
                    981:        struct mansearch         search;
                    982:        struct mandoc_xr        *xr;
                    983:        size_t                   sz;
                    984:
                    985:        if (paths.sz == 0)
                    986:                manpath_base(&paths);
                    987:
                    988:        for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) {
1.297     schwarze  989:                if (xr->line == -1)
                    990:                        continue;
1.294     schwarze  991:                search.arch = NULL;
                    992:                search.sec = xr->sec;
                    993:                search.outkey = NULL;
                    994:                search.argmode = ARG_NAME;
                    995:                search.firstmatch = 1;
                    996:                if (mansearch(&search, &paths, 1, &xr->name, NULL, &sz))
1.295     schwarze  997:                        continue;
1.340     schwarze  998:                if (fs_search(&search, &paths, xr->name, NULL, &sz) != -1)
1.294     schwarze  999:                        continue;
1.298     schwarze 1000:                if (xr->count == 1)
1.313     schwarze 1001:                        mandoc_msg(MANDOCERR_XR_BAD, xr->line,
                   1002:                            xr->pos + 1, "Xr %s %s", xr->name, xr->sec);
1.298     schwarze 1003:                else
1.313     schwarze 1004:                        mandoc_msg(MANDOCERR_XR_BAD, xr->line,
                   1005:                            xr->pos + 1, "Xr %s %s (%d times)",
1.298     schwarze 1006:                            xr->name, xr->sec, xr->count);
1.294     schwarze 1007:        }
1.276     schwarze 1008: }
                   1009:
                   1010: static void
1.335     schwarze 1011: outdata_alloc(struct outstate *outst, struct manoutput *outconf)
1.276     schwarze 1012: {
1.335     schwarze 1013:        switch (outst->outtype) {
1.276     schwarze 1014:        case OUTT_HTML:
1.335     schwarze 1015:                outst->outdata = html_alloc(outconf);
1.276     schwarze 1016:                break;
                   1017:        case OUTT_UTF8:
1.335     schwarze 1018:                outst->outdata = utf8_alloc(outconf);
1.276     schwarze 1019:                break;
                   1020:        case OUTT_LOCALE:
1.335     schwarze 1021:                outst->outdata = locale_alloc(outconf);
1.276     schwarze 1022:                break;
                   1023:        case OUTT_ASCII:
1.335     schwarze 1024:                outst->outdata = ascii_alloc(outconf);
1.276     schwarze 1025:                break;
                   1026:        case OUTT_PDF:
1.335     schwarze 1027:                outst->outdata = pdf_alloc(outconf);
1.276     schwarze 1028:                break;
                   1029:        case OUTT_PS:
1.335     schwarze 1030:                outst->outdata = ps_alloc(outconf);
1.276     schwarze 1031:                break;
                   1032:        default:
                   1033:                break;
1.111     kristaps 1034:        }
1.186     schwarze 1035: }
                   1036:
1.227     schwarze 1037: static void
1.329     schwarze 1038: passthrough(int fd, int synopsis_only)
1.186     schwarze 1039: {
1.197     schwarze 1040:        const char       synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
                   1041:        const char       synr[] = "SYNOPSIS";
                   1042:
                   1043:        FILE            *stream;
1.257     schwarze 1044:        char            *line, *cp;
                   1045:        size_t           linesz;
1.277     schwarze 1046:        ssize_t          len, written;
1.329     schwarze 1047:        int              lno, print;
1.210     schwarze 1048:
1.329     schwarze 1049:        stream = NULL;
1.257     schwarze 1050:        line = NULL;
                   1051:        linesz = 0;
1.197     schwarze 1052:
1.277     schwarze 1053:        if (fflush(stdout) == EOF) {
1.329     schwarze 1054:                mandoc_msg(MANDOCERR_FFLUSH, 0, 0, "%s", strerror(errno));
                   1055:                goto done;
1.277     schwarze 1056:        }
1.197     schwarze 1057:        if ((stream = fdopen(fd, "r")) == NULL) {
                   1058:                close(fd);
1.329     schwarze 1059:                mandoc_msg(MANDOCERR_FDOPEN, 0, 0, "%s", strerror(errno));
                   1060:                goto done;
1.197     schwarze 1061:        }
1.186     schwarze 1062:
1.329     schwarze 1063:        lno = print = 0;
1.277     schwarze 1064:        while ((len = getline(&line, &linesz, stream)) != -1) {
1.329     schwarze 1065:                lno++;
1.257     schwarze 1066:                cp = line;
1.197     schwarze 1067:                if (synopsis_only) {
                   1068:                        if (print) {
1.257     schwarze 1069:                                if ( ! isspace((unsigned char)*cp))
1.197     schwarze 1070:                                        goto done;
1.277     schwarze 1071:                                while (isspace((unsigned char)*cp)) {
1.257     schwarze 1072:                                        cp++;
1.277     schwarze 1073:                                        len--;
                   1074:                                }
1.197     schwarze 1075:                        } else {
1.257     schwarze 1076:                                if (strcmp(cp, synb) == 0 ||
                   1077:                                    strcmp(cp, synr) == 0)
1.197     schwarze 1078:                                        print = 1;
                   1079:                                continue;
                   1080:                        }
                   1081:                }
1.277     schwarze 1082:                for (; len > 0; len -= written) {
1.329     schwarze 1083:                        if ((written = write(STDOUT_FILENO, cp, len)) == -1) {
                   1084:                                mandoc_msg(MANDOCERR_WRITE, 0, 0,
                   1085:                                    "%s", strerror(errno));
                   1086:                                goto done;
                   1087:                        }
1.257     schwarze 1088:                }
1.197     schwarze 1089:        }
1.329     schwarze 1090:        if (ferror(stream))
                   1091:                mandoc_msg(MANDOCERR_GETLINE, lno, 0, "%s", strerror(errno));
1.193     schwarze 1092:
1.197     schwarze 1093: done:
1.257     schwarze 1094:        free(line);
1.329     schwarze 1095:        if (stream != NULL)
                   1096:                fclose(stream);
1.1       kristaps 1097: }
                   1098:
                   1099: static int
1.334     schwarze 1100: woptions(char *arg, enum mandoc_os *os_e, int *wstop)
1.1       kristaps 1101: {
1.34      kristaps 1102:        char            *v, *o;
1.293     schwarze 1103:        const char      *toks[11];
1.1       kristaps 1104:
1.103     schwarze 1105:        toks[0] = "stop";
                   1106:        toks[1] = "all";
1.293     schwarze 1107:        toks[2] = "base";
                   1108:        toks[3] = "style";
                   1109:        toks[4] = "warning";
                   1110:        toks[5] = "error";
                   1111:        toks[6] = "unsupp";
                   1112:        toks[7] = "fatal";
                   1113:        toks[8] = "openbsd";
                   1114:        toks[9] = "netbsd";
                   1115:        toks[10] = NULL;
1.1       kristaps 1116:
1.34      kristaps 1117:        while (*arg) {
                   1118:                o = arg;
1.272     schwarze 1119:                switch (getsubopt(&arg, (char * const *)toks, &v)) {
1.173     schwarze 1120:                case 0:
1.334     schwarze 1121:                        *wstop = 1;
1.1       kristaps 1122:                        break;
1.173     schwarze 1123:                case 1:
                   1124:                case 2:
1.312     schwarze 1125:                        mandoc_msg_setmin(MANDOCERR_BASE);
1.290     schwarze 1126:                        break;
                   1127:                case 3:
1.312     schwarze 1128:                        mandoc_msg_setmin(MANDOCERR_STYLE);
1.1       kristaps 1129:                        break;
1.290     schwarze 1130:                case 4:
1.312     schwarze 1131:                        mandoc_msg_setmin(MANDOCERR_WARNING);
1.24      kristaps 1132:                        break;
1.290     schwarze 1133:                case 5:
1.312     schwarze 1134:                        mandoc_msg_setmin(MANDOCERR_ERROR);
1.217     schwarze 1135:                        break;
1.290     schwarze 1136:                case 6:
1.312     schwarze 1137:                        mandoc_msg_setmin(MANDOCERR_UNSUPP);
1.293     schwarze 1138:                        break;
                   1139:                case 7:
1.329     schwarze 1140:                        mandoc_msg_setmin(MANDOCERR_BADARG);
1.293     schwarze 1141:                        break;
                   1142:                case 8:
1.312     schwarze 1143:                        mandoc_msg_setmin(MANDOCERR_BASE);
1.334     schwarze 1144:                        *os_e = MANDOC_OS_OPENBSD;
1.293     schwarze 1145:                        break;
                   1146:                case 9:
1.312     schwarze 1147:                        mandoc_msg_setmin(MANDOCERR_BASE);
1.334     schwarze 1148:                        *os_e = MANDOC_OS_NETBSD;
1.50      kristaps 1149:                        break;
1.1       kristaps 1150:                default:
1.329     schwarze 1151:                        mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, "-W %s", o);
                   1152:                        return -1;
1.1       kristaps 1153:                }
1.34      kristaps 1154:        }
1.329     schwarze 1155:        return 0;
1.333     schwarze 1156: }
                   1157:
                   1158: /*
                   1159:  * Wait until moved to the foreground,
                   1160:  * then fork the pager and wait for the user to close it.
                   1161:  */
                   1162: static void
1.350     schwarze 1163: run_pager(struct outstate *outst, char *tag_target)
1.333     schwarze 1164: {
                   1165:        int      signum, status;
                   1166:        pid_t    man_pgid, tc_pgid;
                   1167:        pid_t    pager_pid, wait_pid;
                   1168:
                   1169:        man_pgid = getpgid(0);
1.350     schwarze 1170:        outst->tag_files->tcpgid =
                   1171:            man_pgid == getpid() ? getpgid(getppid()) : man_pgid;
1.333     schwarze 1172:        pager_pid = 0;
                   1173:        signum = SIGSTOP;
                   1174:
                   1175:        for (;;) {
                   1176:                /* Stop here until moved to the foreground. */
                   1177:
1.348     schwarze 1178:                tc_pgid = tcgetpgrp(STDOUT_FILENO);
1.333     schwarze 1179:                if (tc_pgid != man_pgid) {
                   1180:                        if (tc_pgid == pager_pid) {
1.348     schwarze 1181:                                (void)tcsetpgrp(STDOUT_FILENO, man_pgid);
1.333     schwarze 1182:                                if (signum == SIGTTIN)
                   1183:                                        continue;
                   1184:                        } else
1.350     schwarze 1185:                                outst->tag_files->tcpgid = tc_pgid;
1.333     schwarze 1186:                        kill(0, signum);
                   1187:                        continue;
                   1188:                }
                   1189:
                   1190:                /* Once in the foreground, activate the pager. */
                   1191:
                   1192:                if (pager_pid) {
1.348     schwarze 1193:                        (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
1.333     schwarze 1194:                        kill(pager_pid, SIGCONT);
                   1195:                } else
1.350     schwarze 1196:                        pager_pid = spawn_pager(outst, tag_target);
1.333     schwarze 1197:
                   1198:                /* Wait for the pager to stop or exit. */
                   1199:
                   1200:                while ((wait_pid = waitpid(pager_pid, &status,
                   1201:                    WUNTRACED)) == -1 && errno == EINTR)
                   1202:                        continue;
                   1203:
                   1204:                if (wait_pid == -1) {
                   1205:                        mandoc_msg(MANDOCERR_WAIT, 0, 0,
                   1206:                            "%s", strerror(errno));
                   1207:                        break;
                   1208:                }
                   1209:                if (!WIFSTOPPED(status))
                   1210:                        break;
                   1211:
                   1212:                signum = WSTOPSIG(status);
                   1213:        }
1.183     schwarze 1214: }
                   1215:
1.225     schwarze 1216: static pid_t
1.350     schwarze 1217: spawn_pager(struct outstate *outst, char *tag_target)
1.183     schwarze 1218: {
1.265     schwarze 1219:        const struct timespec timeout = { 0, 100000000 };  /* 0.1s */
1.184     schwarze 1220: #define MAX_PAGER_ARGS 16
                   1221:        char            *argv[MAX_PAGER_ARGS];
                   1222:        const char      *pager;
                   1223:        char            *cp;
1.322     schwarze 1224: #if HAVE_LESS_T
1.239     schwarze 1225:        size_t           cmdlen;
1.322     schwarze 1226: #endif
1.309     schwarze 1227:        int              argc, use_ofn;
1.225     schwarze 1228:        pid_t            pager_pid;
1.183     schwarze 1229:
1.350     schwarze 1230:        assert(outst->tag_files->ofd == -1);
                   1231:        assert(outst->tag_files->tfs == NULL);
1.348     schwarze 1232:
1.239     schwarze 1233:        pager = getenv("MANPAGER");
                   1234:        if (pager == NULL || *pager == '\0')
                   1235:                pager = getenv("PAGER");
                   1236:        if (pager == NULL || *pager == '\0')
1.351     schwarze 1237:                pager = BINM_PAGER;
1.239     schwarze 1238:        cp = mandoc_strdup(pager);
                   1239:
                   1240:        /*
                   1241:         * Parse the pager command into words.
                   1242:         * Intentionally do not do anything fancy here.
                   1243:         */
                   1244:
                   1245:        argc = 0;
1.309     schwarze 1246:        while (argc + 5 < MAX_PAGER_ARGS) {
1.239     schwarze 1247:                argv[argc++] = cp;
                   1248:                cp = strchr(cp, ' ');
                   1249:                if (cp == NULL)
                   1250:                        break;
                   1251:                *cp++ = '\0';
                   1252:                while (*cp == ' ')
                   1253:                        cp++;
                   1254:                if (*cp == '\0')
                   1255:                        break;
                   1256:        }
                   1257:
1.268     schwarze 1258:        /* For less(1), use the tag file. */
1.239     schwarze 1259:
1.309     schwarze 1260:        use_ofn = 1;
1.322     schwarze 1261: #if HAVE_LESS_T
1.350     schwarze 1262:        if (*outst->tag_files->tfn != '\0' &&
                   1263:            (cmdlen = strlen(argv[0])) >= 4) {
1.239     schwarze 1264:                cp = argv[0] + cmdlen - 4;
1.268     schwarze 1265:                if (strcmp(cp, "less") == 0) {
1.244     schwarze 1266:                        argv[argc++] = mandoc_strdup("-T");
1.350     schwarze 1267:                        argv[argc++] = outst->tag_files->tfn;
1.348     schwarze 1268:                        if (tag_target != NULL) {
1.309     schwarze 1269:                                argv[argc++] = mandoc_strdup("-t");
1.348     schwarze 1270:                                argv[argc++] = tag_target;
1.309     schwarze 1271:                                use_ofn = 0;
                   1272:                        }
1.244     schwarze 1273:                }
1.239     schwarze 1274:        }
1.322     schwarze 1275: #endif
1.350     schwarze 1276:        if (use_ofn) {
                   1277:                if (outst->outtype == OUTT_HTML && tag_target != NULL)
                   1278:                        mandoc_asprintf(&argv[argc], "file://%s#%s",
                   1279:                            outst->tag_files->ofn, tag_target);
                   1280:                else
                   1281:                        argv[argc] = outst->tag_files->ofn;
                   1282:                argc++;
                   1283:        }
1.239     schwarze 1284:        argv[argc] = NULL;
                   1285:
1.225     schwarze 1286:        switch (pager_pid = fork()) {
1.183     schwarze 1287:        case -1:
1.329     schwarze 1288:                mandoc_msg(MANDOCERR_FORK, 0, 0, "%s", strerror(errno));
                   1289:                exit(mandoc_msg_getrc());
1.183     schwarze 1290:        case 0:
1.224     schwarze 1291:                break;
                   1292:        default:
1.258     schwarze 1293:                (void)setpgid(pager_pid, 0);
1.348     schwarze 1294:                (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
1.255     schwarze 1295: #if HAVE_PLEDGE
1.329     schwarze 1296:                if (pledge("stdio rpath tmppath tty proc", NULL) == -1) {
                   1297:                        mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
                   1298:                            "%s", strerror(errno));
                   1299:                        exit(mandoc_msg_getrc());
                   1300:                }
1.255     schwarze 1301: #endif
1.350     schwarze 1302:                outst->tag_files->pager_pid = pager_pid;
1.245     schwarze 1303:                return pager_pid;
1.184     schwarze 1304:        }
                   1305:
1.348     schwarze 1306:        /*
                   1307:         * The child process becomes the pager.
                   1308:         * Do not start it before controlling the terminal.
                   1309:         */
1.265     schwarze 1310:
1.279     schwarze 1311:        while (tcgetpgrp(STDOUT_FILENO) != getpid())
1.265     schwarze 1312:                nanosleep(&timeout, NULL);
                   1313:
1.184     schwarze 1314:        execvp(argv[0], argv);
1.329     schwarze 1315:        mandoc_msg(MANDOCERR_EXEC, 0, 0, "%s: %s", argv[0], strerror(errno));
                   1316:        _exit(mandoc_msg_getrc());
1.71      kristaps 1317: }

CVSweb