[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.238

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