[BACK]Return to main.c CVS log [TXT][DIR] Up to [local] / src / usr.bin / mandoc

Annotation of src/usr.bin/mandoc/main.c, Revision 1.246

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