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

1.151   ! schwarze    1: /*     $OpenBSD: main.c,v 1.150 2015/10/06 18:30:43 schwarze Exp $ */
1.1       kristaps    2: /*
1.95      schwarze    3:  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.118     schwarze    4:  * Copyright (c) 2010-2012, 2014, 2015 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.122     schwarze   21: #include <sys/param.h> /* MACHINE */
1.129     schwarze   22: #include <sys/wait.h>
1.95      schwarze   23:
1.1       kristaps   24: #include <assert.h>
1.95      schwarze   25: #include <ctype.h>
                     26: #include <errno.h>
                     27: #include <fcntl.h>
1.127     schwarze   28: #include <glob.h>
1.131     schwarze   29: #include <signal.h>
1.1       kristaps   30: #include <stdio.h>
1.17      schwarze   31: #include <stdint.h>
1.1       kristaps   32: #include <stdlib.h>
                     33: #include <string.h>
                     34: #include <unistd.h>
                     35:
1.136     schwarze   36: #include "mandoc_aux.h"
1.30      schwarze   37: #include "mandoc.h"
1.136     schwarze   38: #include "roff.h"
1.1       kristaps   39: #include "mdoc.h"
                     40: #include "man.h"
1.144     schwarze   41: #include "tag.h"
1.136     schwarze   42: #include "main.h"
1.134     schwarze   43: #include "manconf.h"
1.95      schwarze   44: #include "mansearch.h"
                     45:
                     46: enum   outmode {
                     47:        OUTMODE_DEF = 0,
                     48:        OUTMODE_FLN,
                     49:        OUTMODE_LST,
                     50:        OUTMODE_ALL,
                     51:        OUTMODE_INT,
                     52:        OUTMODE_ONE
                     53: };
1.1       kristaps   54:
1.139     schwarze   55: typedef        void            (*out_mdoc)(void *, const struct roff_man *);
                     56: typedef        void            (*out_man)(void *, const struct roff_man *);
1.1       kristaps   57: typedef        void            (*out_free)(void *);
                     58:
                     59: enum   outt {
1.76      schwarze   60:        OUTT_ASCII = 0, /* -Tascii */
1.77      schwarze   61:        OUTT_LOCALE,    /* -Tlocale */
                     62:        OUTT_UTF8,      /* -Tutf8 */
1.76      schwarze   63:        OUTT_TREE,      /* -Ttree */
1.78      schwarze   64:        OUTT_MAN,       /* -Tman */
1.76      schwarze   65:        OUTT_HTML,      /* -Thtml */
                     66:        OUTT_LINT,      /* -Tlint */
                     67:        OUTT_PS,        /* -Tps */
                     68:        OUTT_PDF        /* -Tpdf */
1.1       kristaps   69: };
                     70:
                     71: struct curparse {
1.76      schwarze   72:        struct mparse    *mp;
1.102     schwarze   73:        struct mchars    *mchars;       /* character table */
1.75      schwarze   74:        enum mandoclevel  wlevel;       /* ignore messages below this */
                     75:        int               wstop;        /* stop after a file with a warning */
1.90      schwarze   76:        enum outt         outtype;      /* which output to use */
1.33      schwarze   77:        out_mdoc          outmdoc;      /* mdoc output ptr */
1.90      schwarze   78:        out_man           outman;       /* man output ptr */
1.33      schwarze   79:        out_free          outfree;      /* free output ptr */
                     80:        void             *outdata;      /* data for output */
1.135     schwarze   81:        struct manoutput *outopts;      /* output options */
1.33      schwarze   82: };
                     83:
1.119     schwarze   84: static int               fs_lookup(const struct manpaths *,
                     85:                                size_t ipath, const char *,
                     86:                                const char *, const char *,
                     87:                                struct manpage **, size_t *);
                     88: static void              fs_search(const struct mansearch *,
                     89:                                const struct manpaths *, int, char**,
                     90:                                struct manpage **, size_t *);
1.103     schwarze   91: static int               koptions(int *, char *);
1.79      schwarze   92: int                      mandocdb(int, char**);
1.87      schwarze   93: static int               moptions(int *, char *);
1.76      schwarze   94: static void              mmsg(enum mandocerr, enum mandoclevel,
                     95:                                const char *, int, int, const char *);
1.132     schwarze   96: static void              parse(struct curparse *, int, const char *);
                     97: static void              passthrough(const char *, int, int);
1.149     schwarze   98: static pid_t             spawn_pager(struct tag_files *);
1.27      schwarze   99: static int               toptions(struct curparse *, char *);
1.95      schwarze  100: static void              usage(enum argmode) __attribute__((noreturn));
1.45      schwarze  101: static int               woptions(struct curparse *, char *);
1.1       kristaps  102:
1.95      schwarze  103: static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
1.110     schwarze  104: static char              help_arg[] = "help";
                    105: static char             *help_argv[] = {help_arg, NULL};
1.19      schwarze  106: static const char       *progname;
1.131     schwarze  107: static enum mandoclevel  rc;
1.1       kristaps  108:
1.90      schwarze  109:
1.1       kristaps  110: int
                    111: main(int argc, char *argv[])
                    112: {
1.134     schwarze  113:        struct manconf   conf;
1.1       kristaps  114:        struct curparse  curp;
1.95      schwarze  115:        struct mansearch search;
1.149     schwarze  116:        struct tag_files *tag_files;
1.111     schwarze  117:        char            *auxpaths;
1.95      schwarze  118:        char            *defos;
1.113     schwarze  119:        unsigned char   *uc;
1.95      schwarze  120:        struct manpage  *res, *resp;
1.111     schwarze  121:        char            *conf_file, *defpaths;
1.95      schwarze  122:        size_t           isec, i, sz;
1.135     schwarze  123:        int              prio, best_prio;
1.95      schwarze  124:        char             sec;
1.131     schwarze  125:        enum mandoclevel rctmp;
1.95      schwarze  126:        enum outmode     outmode;
1.100     schwarze  127:        int              fd;
1.95      schwarze  128:        int              show_usage;
1.87      schwarze  129:        int              options;
1.149     schwarze  130:        int              use_pager;
1.95      schwarze  131:        int              c;
1.1       kristaps  132:
1.124     schwarze  133:        if (argc < 1)
                    134:                progname = "mandoc";
                    135:        else if ((progname = strrchr(argv[0], '/')) == NULL)
1.19      schwarze  136:                progname = argv[0];
                    137:        else
                    138:                ++progname;
1.79      schwarze  139:
1.82      schwarze  140:        if (0 == strncmp(progname, "mandocdb", 8) ||
                    141:            0 == strncmp(progname, "makewhatis", 10))
1.150     schwarze  142:                return mandocdb(argc, argv);
1.19      schwarze  143:
1.95      schwarze  144:        /* Search options. */
                    145:
1.134     schwarze  146:        memset(&conf, 0, sizeof(conf));
1.111     schwarze  147:        conf_file = defpaths = NULL;
                    148:        auxpaths = NULL;
1.95      schwarze  149:
                    150:        memset(&search, 0, sizeof(struct mansearch));
                    151:        search.outkey = "Nd";
                    152:
                    153:        if (strcmp(progname, "man") == 0)
                    154:                search.argmode = ARG_NAME;
                    155:        else if (strncmp(progname, "apropos", 7) == 0)
                    156:                search.argmode = ARG_EXPR;
                    157:        else if (strncmp(progname, "whatis", 6) == 0)
                    158:                search.argmode = ARG_WORD;
1.110     schwarze  159:        else if (strncmp(progname, "help", 4) == 0)
                    160:                search.argmode = ARG_NAME;
1.95      schwarze  161:        else
                    162:                search.argmode = ARG_FILE;
                    163:
                    164:        /* Parser and formatter options. */
                    165:
1.19      schwarze  166:        memset(&curp, 0, sizeof(struct curparse));
1.109     schwarze  167:        curp.outtype = OUTT_LOCALE;
1.121     schwarze  168:        curp.wlevel  = MANDOCLEVEL_BADARG;
1.135     schwarze  169:        curp.outopts = &conf.output;
1.103     schwarze  170:        options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.83      schwarze  171:        defos = NULL;
1.1       kristaps  172:
1.149     schwarze  173:        use_pager = 1;
                    174:        tag_files = NULL;
1.95      schwarze  175:        show_usage = 0;
                    176:        outmode = OUTMODE_DEF;
                    177:
1.103     schwarze  178:        while (-1 != (c = getopt(argc, argv,
                    179:                        "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
1.1       kristaps  180:                switch (c) {
1.95      schwarze  181:                case 'a':
                    182:                        outmode = OUTMODE_ALL;
                    183:                        break;
                    184:                case 'C':
                    185:                        conf_file = optarg;
                    186:                        break;
                    187:                case 'c':
1.149     schwarze  188:                        use_pager = 0;
1.95      schwarze  189:                        break;
                    190:                case 'f':
                    191:                        search.argmode = ARG_WORD;
                    192:                        break;
1.98      schwarze  193:                case 'h':
1.135     schwarze  194:                        conf.output.synopsisonly = 1;
1.149     schwarze  195:                        use_pager = 0;
1.98      schwarze  196:                        outmode = OUTMODE_ALL;
                    197:                        break;
1.90      schwarze  198:                case 'I':
1.83      schwarze  199:                        if (strncmp(optarg, "os=", 3)) {
1.90      schwarze  200:                                fprintf(stderr,
1.115     schwarze  201:                                    "%s: -I %s: Bad argument\n",
1.93      schwarze  202:                                    progname, optarg);
1.150     schwarze  203:                                return (int)MANDOCLEVEL_BADARG;
1.83      schwarze  204:                        }
                    205:                        if (defos) {
1.90      schwarze  206:                                fprintf(stderr,
1.115     schwarze  207:                                    "%s: -I %s: Duplicate argument\n",
1.93      schwarze  208:                                    progname, optarg);
1.150     schwarze  209:                                return (int)MANDOCLEVEL_BADARG;
1.83      schwarze  210:                        }
                    211:                        defos = mandoc_strdup(optarg + 3);
                    212:                        break;
1.95      schwarze  213:                case 'i':
                    214:                        outmode = OUTMODE_INT;
                    215:                        break;
1.103     schwarze  216:                case 'K':
                    217:                        if ( ! koptions(&options, optarg))
1.150     schwarze  218:                                return (int)MANDOCLEVEL_BADARG;
1.103     schwarze  219:                        break;
1.95      schwarze  220:                case 'k':
                    221:                        search.argmode = ARG_EXPR;
                    222:                        break;
1.96      schwarze  223:                case 'l':
                    224:                        search.argmode = ARG_FILE;
                    225:                        outmode = OUTMODE_ALL;
                    226:                        break;
1.95      schwarze  227:                case 'M':
                    228:                        defpaths = optarg;
                    229:                        break;
1.90      schwarze  230:                case 'm':
1.95      schwarze  231:                        auxpaths = optarg;
1.1       kristaps  232:                        break;
1.90      schwarze  233:                case 'O':
1.95      schwarze  234:                        search.outkey = optarg;
1.135     schwarze  235:                        while (optarg != NULL)
                    236:                                manconf_output(&conf.output,
                    237:                                    strsep(&optarg, ","));
1.17      schwarze  238:                        break;
1.95      schwarze  239:                case 'S':
                    240:                        search.arch = optarg;
                    241:                        break;
                    242:                case 's':
                    243:                        search.sec = optarg;
                    244:                        break;
1.90      schwarze  245:                case 'T':
1.22      schwarze  246:                        if ( ! toptions(&curp, optarg))
1.150     schwarze  247:                                return (int)MANDOCLEVEL_BADARG;
1.1       kristaps  248:                        break;
1.90      schwarze  249:                case 'W':
1.45      schwarze  250:                        if ( ! woptions(&curp, optarg))
1.150     schwarze  251:                                return (int)MANDOCLEVEL_BADARG;
1.1       kristaps  252:                        break;
1.95      schwarze  253:                case 'w':
                    254:                        outmode = OUTMODE_FLN;
                    255:                        break;
1.1       kristaps  256:                default:
1.95      schwarze  257:                        show_usage = 1;
                    258:                        break;
                    259:                }
                    260:        }
                    261:
                    262:        if (show_usage)
                    263:                usage(search.argmode);
                    264:
                    265:        /* Postprocess options. */
                    266:
                    267:        if (outmode == OUTMODE_DEF) {
                    268:                switch (search.argmode) {
                    269:                case ARG_FILE:
                    270:                        outmode = OUTMODE_ALL;
1.149     schwarze  271:                        use_pager = 0;
1.95      schwarze  272:                        break;
                    273:                case ARG_NAME:
                    274:                        outmode = OUTMODE_ONE;
                    275:                        break;
                    276:                default:
                    277:                        outmode = OUTMODE_LST;
                    278:                        break;
                    279:                }
                    280:        }
                    281:
1.151   ! schwarze  282:        if (outmode == OUTMODE_FLN ||
        !           283:            outmode == OUTMODE_LST ||
        !           284:            !isatty(STDOUT_FILENO))
        !           285:                use_pager = 0;
        !           286:
1.95      schwarze  287:        /* Parse arguments. */
                    288:
1.124     schwarze  289:        if (argc > 0) {
                    290:                argc -= optind;
                    291:                argv += optind;
                    292:        }
1.95      schwarze  293:        resp = NULL;
                    294:
1.110     schwarze  295:        /*
                    296:         * Quirks for help(1)
                    297:         * and for a man(1) section argument without -s.
                    298:         */
                    299:
                    300:        if (search.argmode == ARG_NAME) {
                    301:                if (*progname == 'h') {
                    302:                        if (argc == 0) {
                    303:                                argv = help_argv;
                    304:                                argc = 1;
                    305:                        }
1.117     schwarze  306:                } else if (argc > 1 &&
1.128     schwarze  307:                    ((uc = (unsigned char *)argv[0]) != NULL) &&
1.113     schwarze  308:                    ((isdigit(uc[0]) && (uc[1] == '\0' ||
                    309:                      (isalpha(uc[1]) && uc[2] == '\0'))) ||
                    310:                     (uc[0] == 'n' && uc[1] == '\0'))) {
1.128     schwarze  311:                        search.sec = (char *)uc;
1.110     schwarze  312:                        argv++;
                    313:                        argc--;
                    314:                }
1.122     schwarze  315:                if (search.arch == NULL)
                    316:                        search.arch = getenv("MACHINE");
                    317:                if (search.arch == NULL)
                    318:                        search.arch = MACHINE;
1.95      schwarze  319:        }
                    320:
                    321:        rc = MANDOCLEVEL_OK;
                    322:
                    323:        /* man(1), whatis(1), apropos(1) */
                    324:
                    325:        if (search.argmode != ARG_FILE) {
                    326:                if (argc == 0)
                    327:                        usage(search.argmode);
1.107     schwarze  328:
                    329:                if (search.argmode == ARG_NAME &&
                    330:                    outmode == OUTMODE_ONE)
                    331:                        search.firstmatch = 1;
1.95      schwarze  332:
                    333:                /* Access the mandoc database. */
                    334:
1.134     schwarze  335:                manconf_parse(&conf, conf_file, defpaths, auxpaths);
1.95      schwarze  336:                mansearch_setup(1);
1.134     schwarze  337:                if ( ! mansearch(&search, &conf.manpath,
                    338:                    argc, argv, &res, &sz))
1.95      schwarze  339:                        usage(search.argmode);
1.119     schwarze  340:
1.142     schwarze  341:                if (sz == 0) {
                    342:                        if (search.argmode == ARG_NAME)
                    343:                                fs_search(&search, &conf.manpath,
                    344:                                    argc, argv, &res, &sz);
                    345:                        else
                    346:                                fprintf(stderr,
                    347:                                    "%s: nothing appropriate\n",
                    348:                                    progname);
                    349:                }
1.95      schwarze  350:
                    351:                if (sz == 0) {
                    352:                        rc = MANDOCLEVEL_BADARG;
                    353:                        goto out;
                    354:                }
                    355:
                    356:                /*
                    357:                 * For standard man(1) and -a output mode,
                    358:                 * prepare for copying filename pointers
                    359:                 * into the program parameter array.
                    360:                 */
                    361:
                    362:                if (outmode == OUTMODE_ONE) {
                    363:                        argc = 1;
                    364:                        best_prio = 10;
                    365:                } else if (outmode == OUTMODE_ALL)
                    366:                        argc = (int)sz;
                    367:
                    368:                /* Iterate all matching manuals. */
                    369:
1.119     schwarze  370:                resp = res;
1.95      schwarze  371:                for (i = 0; i < sz; i++) {
                    372:                        if (outmode == OUTMODE_FLN)
                    373:                                puts(res[i].file);
                    374:                        else if (outmode == OUTMODE_LST)
                    375:                                printf("%s - %s\n", res[i].names,
                    376:                                    res[i].output == NULL ? "" :
                    377:                                    res[i].output);
                    378:                        else if (outmode == OUTMODE_ONE) {
                    379:                                /* Search for the best section. */
                    380:                                isec = strcspn(res[i].file, "123456789");
                    381:                                sec = res[i].file[isec];
                    382:                                if ('\0' == sec)
                    383:                                        continue;
                    384:                                prio = sec_prios[sec - '1'];
                    385:                                if (prio >= best_prio)
                    386:                                        continue;
                    387:                                best_prio = prio;
                    388:                                resp = res + i;
                    389:                        }
1.1       kristaps  390:                }
                    391:
1.95      schwarze  392:                /*
                    393:                 * For man(1), -a and -i output mode, fall through
                    394:                 * to the main mandoc(1) code iterating files
                    395:                 * and running the parsers on each of them.
                    396:                 */
                    397:
                    398:                if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
                    399:                        goto out;
                    400:        }
                    401:
                    402:        /* mandoc(1) */
                    403:
1.115     schwarze  404:        if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths))
1.150     schwarze  405:                return (int)MANDOCLEVEL_BADARG;
1.146     schwarze  406:
1.102     schwarze  407:        curp.mchars = mchars_alloc();
                    408:        curp.mp = mparse_alloc(options, curp.wlevel, mmsg,
                    409:            curp.mchars, defos);
1.76      schwarze  410:
1.80      schwarze  411:        /*
                    412:         * Conditionally start up the lookaside buffer before parsing.
                    413:         */
                    414:        if (OUTT_MAN == curp.outtype)
                    415:                mparse_keep(curp.mp);
                    416:
1.124     schwarze  417:        if (argc < 1) {
1.149     schwarze  418:                if (use_pager)
                    419:                        tag_files = tag_init();
1.132     schwarze  420:                parse(&curp, STDIN_FILENO, "<stdin>");
1.118     schwarze  421:        }
1.27      schwarze  422:
1.124     schwarze  423:        while (argc > 0) {
1.120     schwarze  424:                rctmp = mparse_open(curp.mp, &fd,
1.118     schwarze  425:                    resp != NULL ? resp->file : *argv);
1.120     schwarze  426:                if (rc < rctmp)
                    427:                        rc = rctmp;
1.118     schwarze  428:
                    429:                if (fd != -1) {
1.149     schwarze  430:                        if (use_pager) {
                    431:                                tag_files = tag_init();
                    432:                                use_pager = 0;
                    433:                        }
1.118     schwarze  434:
                    435:                        if (resp == NULL)
1.132     schwarze  436:                                parse(&curp, fd, *argv);
1.100     schwarze  437:                        else if (resp->form & FORM_SRC) {
1.97      schwarze  438:                                /* For .so only; ignore failure. */
1.134     schwarze  439:                                chdir(conf.manpath.paths[resp->ipath]);
1.132     schwarze  440:                                parse(&curp, fd, resp->file);
                    441:                        } else
1.135     schwarze  442:                                passthrough(resp->file, fd,
                    443:                                    conf.output.synopsisonly);
1.118     schwarze  444:
                    445:                        if (argc > 1 && curp.outtype <= OUTT_UTF8)
                    446:                                ascii_sepline(curp.outdata);
1.100     schwarze  447:                }
                    448:
1.76      schwarze  449:                if (MANDOCLEVEL_OK != rc && curp.wstop)
1.27      schwarze  450:                        break;
1.116     schwarze  451:
1.118     schwarze  452:                if (resp != NULL)
                    453:                        resp++;
                    454:                else
                    455:                        argv++;
                    456:                if (--argc)
                    457:                        mparse_reset(curp.mp);
1.1       kristaps  458:        }
                    459:
                    460:        if (curp.outfree)
                    461:                (*curp.outfree)(curp.outdata);
1.102     schwarze  462:        mparse_free(curp.mp);
                    463:        mchars_free(curp.mchars);
1.95      schwarze  464:
                    465: out:
                    466:        if (search.argmode != ARG_FILE) {
1.134     schwarze  467:                manconf_free(&conf);
1.95      schwarze  468:                mansearch_free(res, sz);
                    469:                mansearch_setup(0);
                    470:        }
                    471:
1.83      schwarze  472:        free(defos);
1.1       kristaps  473:
1.129     schwarze  474:        /*
1.149     schwarze  475:         * When using a pager, finish writing both temporary files,
                    476:         * fork it, wait for the user to close it, and clean up.
1.129     schwarze  477:         */
                    478:
1.149     schwarze  479:        if (tag_files != NULL) {
1.130     schwarze  480:                fclose(stdout);
1.144     schwarze  481:                tag_write();
1.149     schwarze  482:                waitpid(spawn_pager(tag_files), NULL, 0);
1.144     schwarze  483:                tag_unlink();
1.130     schwarze  484:        }
1.129     schwarze  485:
1.150     schwarze  486:        return (int)rc;
1.1       kristaps  487: }
                    488:
1.20      schwarze  489: static void
1.95      schwarze  490: usage(enum argmode argmode)
1.1       kristaps  491: {
                    492:
1.95      schwarze  493:        switch (argmode) {
                    494:        case ARG_FILE:
1.133     schwarze  495:                fputs("usage: mandoc [-acfhkl] [-I os=name] "
                    496:                    "[-K encoding] [-mformat] [-O option]\n"
                    497:                    "\t      [-T output] [-W level] [file ...]\n", stderr);
1.95      schwarze  498:                break;
                    499:        case ARG_NAME:
1.126     schwarze  500:                fputs("usage: man [-acfhklw] [-C file] [-I os=name] "
1.114     jmc       501:                    "[-K encoding] [-M path] [-m path]\n"
                    502:                    "\t   [-O option=value] [-S subsection] [-s section] "
                    503:                    "[-T output] [-W level]\n"
1.95      schwarze  504:                    "\t   [section] name ...\n", stderr);
                    505:                break;
                    506:        case ARG_WORD:
1.126     schwarze  507:                fputs("usage: whatis [-acfhklw] [-C file] "
1.96      schwarze  508:                    "[-M path] [-m path] [-O outkey] [-S arch]\n"
                    509:                    "\t      [-s section] name ...\n", stderr);
1.95      schwarze  510:                break;
                    511:        case ARG_EXPR:
1.126     schwarze  512:                fputs("usage: apropos [-acfhklw] [-C file] "
1.96      schwarze  513:                    "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.95      schwarze  514:                    "\t       [-s section] expression ...\n", stderr);
                    515:                break;
                    516:        }
1.47      schwarze  517:        exit((int)MANDOCLEVEL_BADARG);
1.119     schwarze  518: }
                    519:
                    520: static int
                    521: fs_lookup(const struct manpaths *paths, size_t ipath,
                    522:        const char *sec, const char *arch, const char *name,
                    523:        struct manpage **res, size_t *ressz)
                    524: {
1.127     schwarze  525:        glob_t           globinfo;
1.119     schwarze  526:        struct manpage  *page;
                    527:        char            *file;
1.127     schwarze  528:        int              form, globres;
1.119     schwarze  529:
1.127     schwarze  530:        form = FORM_SRC;
1.119     schwarze  531:        mandoc_asprintf(&file, "%s/man%s/%s.%s",
                    532:            paths->paths[ipath], sec, name, sec);
1.127     schwarze  533:        if (access(file, R_OK) != -1)
1.119     schwarze  534:                goto found;
                    535:        free(file);
                    536:
                    537:        mandoc_asprintf(&file, "%s/cat%s/%s.0",
                    538:            paths->paths[ipath], sec, name);
                    539:        if (access(file, R_OK) != -1) {
                    540:                form = FORM_CAT;
                    541:                goto found;
                    542:        }
                    543:        free(file);
                    544:
                    545:        if (arch != NULL) {
                    546:                mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
                    547:                    paths->paths[ipath], sec, arch, name, sec);
1.127     schwarze  548:                if (access(file, R_OK) != -1)
1.119     schwarze  549:                        goto found;
                    550:                free(file);
                    551:        }
1.127     schwarze  552:
1.145     schwarze  553:        mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",
1.127     schwarze  554:            paths->paths[ipath], sec, name);
                    555:        globres = glob(file, 0, NULL, &globinfo);
                    556:        if (globres != 0 && globres != GLOB_NOMATCH)
                    557:                fprintf(stderr, "%s: %s: glob: %s\n",
                    558:                    progname, file, strerror(errno));
                    559:        free(file);
                    560:        if (globres == 0)
                    561:                file = mandoc_strdup(*globinfo.gl_pathv);
                    562:        globfree(&globinfo);
                    563:        if (globres != 0)
1.150     schwarze  564:                return 0;
1.119     schwarze  565:
                    566: found:
1.138     schwarze  567:        fprintf(stderr, "%s: outdated mandoc.db lacks %s(%s) entry, run "
                    568:            "makewhatis %s\n", progname, name, sec, paths->paths[ipath]);
1.119     schwarze  569:        *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
                    570:        page = *res + (*ressz - 1);
                    571:        page->file = file;
                    572:        page->names = NULL;
                    573:        page->output = NULL;
                    574:        page->ipath = ipath;
                    575:        page->bits = NAME_FILE & NAME_MASK;
                    576:        page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
                    577:        page->form = form;
1.150     schwarze  578:        return 1;
1.119     schwarze  579: }
                    580:
                    581: static void
                    582: fs_search(const struct mansearch *cfg, const struct manpaths *paths,
                    583:        int argc, char **argv, struct manpage **res, size_t *ressz)
                    584: {
                    585:        const char *const sections[] =
                    586:            {"1", "8", "6", "2", "3", "3p", "5", "7", "4", "9"};
                    587:        const size_t nsec = sizeof(sections)/sizeof(sections[0]);
                    588:
                    589:        size_t           ipath, isec, lastsz;
                    590:
                    591:        assert(cfg->argmode == ARG_NAME);
                    592:
                    593:        *res = NULL;
                    594:        *ressz = lastsz = 0;
                    595:        while (argc) {
                    596:                for (ipath = 0; ipath < paths->sz; ipath++) {
                    597:                        if (cfg->sec != NULL) {
                    598:                                if (fs_lookup(paths, ipath, cfg->sec,
                    599:                                    cfg->arch, *argv, res, ressz) &&
                    600:                                    cfg->firstmatch)
                    601:                                        return;
                    602:                        } else for (isec = 0; isec < nsec; isec++)
                    603:                                if (fs_lookup(paths, ipath, sections[isec],
                    604:                                    cfg->arch, *argv, res, ressz) &&
                    605:                                    cfg->firstmatch)
                    606:                                        return;
                    607:                }
                    608:                if (*ressz == lastsz)
                    609:                        fprintf(stderr,
                    610:                            "%s: No entry for %s in the manual.\n",
                    611:                            progname, *argv);
                    612:                lastsz = *ressz;
                    613:                argv++;
                    614:                argc--;
                    615:        }
1.1       kristaps  616: }
                    617:
1.27      schwarze  618: static void
1.132     schwarze  619: parse(struct curparse *curp, int fd, const char *file)
1.52      schwarze  620: {
1.132     schwarze  621:        enum mandoclevel  rctmp;
1.139     schwarze  622:        struct roff_man  *man;
1.52      schwarze  623:
1.76      schwarze  624:        /* Begin by parsing the file itself. */
1.52      schwarze  625:
1.76      schwarze  626:        assert(file);
                    627:        assert(fd >= -1);
1.52      schwarze  628:
1.132     schwarze  629:        rctmp = mparse_readfd(curp->mp, fd, file);
                    630:        if (rc < rctmp)
                    631:                rc = rctmp;
1.1       kristaps  632:
1.51      schwarze  633:        /*
1.76      schwarze  634:         * With -Wstop and warnings or errors of at least the requested
                    635:         * level, do not produce output.
1.51      schwarze  636:         */
                    637:
1.132     schwarze  638:        if (rctmp != MANDOCLEVEL_OK && curp->wstop)
                    639:                return;
1.51      schwarze  640:
                    641:        /* If unset, allocate output dev now (if applicable). */
                    642:
                    643:        if ( ! (curp->outman && curp->outmdoc)) {
                    644:                switch (curp->outtype) {
1.90      schwarze  645:                case OUTT_HTML:
1.102     schwarze  646:                        curp->outdata = html_alloc(curp->mchars,
                    647:                            curp->outopts);
1.77      schwarze  648:                        curp->outfree = html_free;
                    649:                        break;
1.90      schwarze  650:                case OUTT_UTF8:
1.102     schwarze  651:                        curp->outdata = utf8_alloc(curp->mchars,
                    652:                            curp->outopts);
1.77      schwarze  653:                        curp->outfree = ascii_free;
                    654:                        break;
1.90      schwarze  655:                case OUTT_LOCALE:
1.102     schwarze  656:                        curp->outdata = locale_alloc(curp->mchars,
                    657:                            curp->outopts);
1.77      schwarze  658:                        curp->outfree = ascii_free;
1.51      schwarze  659:                        break;
1.90      schwarze  660:                case OUTT_ASCII:
1.102     schwarze  661:                        curp->outdata = ascii_alloc(curp->mchars,
                    662:                            curp->outopts);
1.51      schwarze  663:                        curp->outfree = ascii_free;
                    664:                        break;
1.90      schwarze  665:                case OUTT_PDF:
1.102     schwarze  666:                        curp->outdata = pdf_alloc(curp->mchars,
                    667:                            curp->outopts);
1.51      schwarze  668:                        curp->outfree = pspdf_free;
                    669:                        break;
1.90      schwarze  670:                case OUTT_PS:
1.102     schwarze  671:                        curp->outdata = ps_alloc(curp->mchars,
                    672:                            curp->outopts);
1.51      schwarze  673:                        curp->outfree = pspdf_free;
                    674:                        break;
                    675:                default:
                    676:                        break;
                    677:                }
                    678:
                    679:                switch (curp->outtype) {
1.90      schwarze  680:                case OUTT_HTML:
1.51      schwarze  681:                        curp->outman = html_man;
                    682:                        curp->outmdoc = html_mdoc;
                    683:                        break;
1.90      schwarze  684:                case OUTT_TREE:
1.51      schwarze  685:                        curp->outman = tree_man;
                    686:                        curp->outmdoc = tree_mdoc;
                    687:                        break;
1.90      schwarze  688:                case OUTT_MAN:
1.78      schwarze  689:                        curp->outmdoc = man_mdoc;
1.80      schwarze  690:                        curp->outman = man_man;
1.78      schwarze  691:                        break;
1.90      schwarze  692:                case OUTT_PDF:
1.51      schwarze  693:                        /* FALLTHROUGH */
1.90      schwarze  694:                case OUTT_ASCII:
1.51      schwarze  695:                        /* FALLTHROUGH */
1.90      schwarze  696:                case OUTT_UTF8:
1.77      schwarze  697:                        /* FALLTHROUGH */
1.90      schwarze  698:                case OUTT_LOCALE:
1.77      schwarze  699:                        /* FALLTHROUGH */
1.90      schwarze  700:                case OUTT_PS:
1.51      schwarze  701:                        curp->outman = terminal_man;
                    702:                        curp->outmdoc = terminal_mdoc;
                    703:                        break;
                    704:                default:
                    705:                        break;
                    706:                }
                    707:        }
                    708:
1.140     schwarze  709:        mparse_result(curp->mp, &man, NULL);
1.76      schwarze  710:
1.51      schwarze  711:        /* Execute the out device, if it exists. */
                    712:
1.140     schwarze  713:        if (man == NULL)
                    714:                return;
                    715:        if (curp->outmdoc != NULL && man->macroset == MACROSET_MDOC)
                    716:                (*curp->outmdoc)(curp->outdata, man);
                    717:        if (curp->outman != NULL && man->macroset == MACROSET_MAN)
1.76      schwarze  718:                (*curp->outman)(curp->outdata, man);
1.1       kristaps  719: }
                    720:
1.132     schwarze  721: static void
1.105     schwarze  722: passthrough(const char *file, int fd, int synopsis_only)
1.95      schwarze  723: {
1.105     schwarze  724:        const char       synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
                    725:        const char       synr[] = "SYNOPSIS";
                    726:
                    727:        FILE            *stream;
1.95      schwarze  728:        const char      *syscall;
1.105     schwarze  729:        char            *line;
                    730:        size_t           len, off;
                    731:        ssize_t          nw;
                    732:        int              print;
1.116     schwarze  733:
                    734:        fflush(stdout);
1.105     schwarze  735:
                    736:        if ((stream = fdopen(fd, "r")) == NULL) {
                    737:                close(fd);
                    738:                syscall = "fdopen";
                    739:                goto fail;
                    740:        }
1.95      schwarze  741:
1.105     schwarze  742:        print = 0;
                    743:        while ((line = fgetln(stream, &len)) != NULL) {
                    744:                if (synopsis_only) {
                    745:                        if (print) {
                    746:                                if ( ! isspace((unsigned char)*line))
                    747:                                        goto done;
                    748:                                while (len &&
                    749:                                    isspace((unsigned char)*line)) {
                    750:                                        line++;
                    751:                                        len--;
                    752:                                }
                    753:                        } else {
                    754:                                if ((len == sizeof(synb) &&
                    755:                                     ! strncmp(line, synb, len - 1)) ||
                    756:                                    (len == sizeof(synr) &&
                    757:                                     ! strncmp(line, synr, len - 1)))
                    758:                                        print = 1;
                    759:                                continue;
                    760:                        }
                    761:                }
                    762:                for (off = 0; off < len; off += nw)
                    763:                        if ((nw = write(STDOUT_FILENO, line + off,
                    764:                            len - off)) == -1 || nw == 0) {
                    765:                                fclose(stream);
1.95      schwarze  766:                                syscall = "write";
                    767:                                goto fail;
                    768:                        }
1.105     schwarze  769:        }
1.95      schwarze  770:
1.105     schwarze  771:        if (ferror(stream)) {
                    772:                fclose(stream);
                    773:                syscall = "fgetln";
                    774:                goto fail;
                    775:        }
1.101     schwarze  776:
1.105     schwarze  777: done:
                    778:        fclose(stream);
1.132     schwarze  779:        return;
1.95      schwarze  780:
                    781: fail:
                    782:        fprintf(stderr, "%s: %s: SYSERR: %s: %s",
                    783:            progname, file, syscall, strerror(errno));
1.132     schwarze  784:        if (rc < MANDOCLEVEL_SYSERR)
                    785:                rc = MANDOCLEVEL_SYSERR;
1.103     schwarze  786: }
                    787:
                    788: static int
                    789: koptions(int *options, char *arg)
                    790: {
                    791:
                    792:        if ( ! strcmp(arg, "utf-8")) {
                    793:                *options |=  MPARSE_UTF8;
                    794:                *options &= ~MPARSE_LATIN1;
                    795:        } else if ( ! strcmp(arg, "iso-8859-1")) {
                    796:                *options |=  MPARSE_LATIN1;
                    797:                *options &= ~MPARSE_UTF8;
                    798:        } else if ( ! strcmp(arg, "us-ascii")) {
                    799:                *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
                    800:        } else {
1.115     schwarze  801:                fprintf(stderr, "%s: -K %s: Bad argument\n",
1.103     schwarze  802:                    progname, arg);
1.150     schwarze  803:                return 0;
1.103     schwarze  804:        }
1.150     schwarze  805:        return 1;
1.95      schwarze  806: }
                    807:
1.1       kristaps  808: static int
1.87      schwarze  809: moptions(int *options, char *arg)
1.1       kristaps  810: {
                    811:
1.95      schwarze  812:        if (arg == NULL)
                    813:                /* nothing to do */;
                    814:        else if (0 == strcmp(arg, "doc"))
1.87      schwarze  815:                *options |= MPARSE_MDOC;
1.1       kristaps  816:        else if (0 == strcmp(arg, "andoc"))
1.87      schwarze  817:                /* nothing to do */;
1.1       kristaps  818:        else if (0 == strcmp(arg, "an"))
1.87      schwarze  819:                *options |= MPARSE_MAN;
1.1       kristaps  820:        else {
1.115     schwarze  821:                fprintf(stderr, "%s: -m %s: Bad argument\n",
1.93      schwarze  822:                    progname, arg);
1.150     schwarze  823:                return 0;
1.1       kristaps  824:        }
                    825:
1.150     schwarze  826:        return 1;
1.1       kristaps  827: }
                    828:
                    829: static int
1.22      schwarze  830: toptions(struct curparse *curp, char *arg)
1.1       kristaps  831: {
                    832:
                    833:        if (0 == strcmp(arg, "ascii"))
1.22      schwarze  834:                curp->outtype = OUTT_ASCII;
                    835:        else if (0 == strcmp(arg, "lint")) {
                    836:                curp->outtype = OUTT_LINT;
1.45      schwarze  837:                curp->wlevel  = MANDOCLEVEL_WARNING;
1.76      schwarze  838:        } else if (0 == strcmp(arg, "tree"))
1.22      schwarze  839:                curp->outtype = OUTT_TREE;
1.78      schwarze  840:        else if (0 == strcmp(arg, "man"))
                    841:                curp->outtype = OUTT_MAN;
1.17      schwarze  842:        else if (0 == strcmp(arg, "html"))
1.22      schwarze  843:                curp->outtype = OUTT_HTML;
1.77      schwarze  844:        else if (0 == strcmp(arg, "utf8"))
                    845:                curp->outtype = OUTT_UTF8;
                    846:        else if (0 == strcmp(arg, "locale"))
                    847:                curp->outtype = OUTT_LOCALE;
1.21      schwarze  848:        else if (0 == strcmp(arg, "xhtml"))
1.102     schwarze  849:                curp->outtype = OUTT_HTML;
1.36      schwarze  850:        else if (0 == strcmp(arg, "ps"))
                    851:                curp->outtype = OUTT_PS;
1.43      schwarze  852:        else if (0 == strcmp(arg, "pdf"))
                    853:                curp->outtype = OUTT_PDF;
1.1       kristaps  854:        else {
1.115     schwarze  855:                fprintf(stderr, "%s: -T %s: Bad argument\n",
1.93      schwarze  856:                    progname, arg);
1.150     schwarze  857:                return 0;
1.1       kristaps  858:        }
                    859:
1.150     schwarze  860:        return 1;
1.1       kristaps  861: }
                    862:
                    863: static int
1.45      schwarze  864: woptions(struct curparse *curp, char *arg)
1.1       kristaps  865: {
1.10      schwarze  866:        char            *v, *o;
1.123     schwarze  867:        const char      *toks[7];
1.1       kristaps  868:
1.45      schwarze  869:        toks[0] = "stop";
                    870:        toks[1] = "all";
                    871:        toks[2] = "warning";
                    872:        toks[3] = "error";
1.123     schwarze  873:        toks[4] = "unsupp";
                    874:        toks[5] = "fatal";
                    875:        toks[6] = NULL;
1.1       kristaps  876:
1.10      schwarze  877:        while (*arg) {
                    878:                o = arg;
1.17      schwarze  879:                switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.90      schwarze  880:                case 0:
1.45      schwarze  881:                        curp->wstop = 1;
1.1       kristaps  882:                        break;
1.90      schwarze  883:                case 1:
1.45      schwarze  884:                        /* FALLTHROUGH */
1.90      schwarze  885:                case 2:
1.45      schwarze  886:                        curp->wlevel = MANDOCLEVEL_WARNING;
1.1       kristaps  887:                        break;
1.90      schwarze  888:                case 3:
1.45      schwarze  889:                        curp->wlevel = MANDOCLEVEL_ERROR;
1.1       kristaps  890:                        break;
1.90      schwarze  891:                case 4:
1.123     schwarze  892:                        curp->wlevel = MANDOCLEVEL_UNSUPP;
                    893:                        break;
                    894:                case 5:
1.121     schwarze  895:                        curp->wlevel = MANDOCLEVEL_BADARG;
1.19      schwarze  896:                        break;
1.1       kristaps  897:                default:
1.115     schwarze  898:                        fprintf(stderr, "%s: -W %s: Bad argument\n",
1.93      schwarze  899:                            progname, o);
1.150     schwarze  900:                        return 0;
1.1       kristaps  901:                }
1.10      schwarze  902:        }
1.1       kristaps  903:
1.150     schwarze  904:        return 1;
1.1       kristaps  905: }
                    906:
1.75      schwarze  907: static void
1.90      schwarze  908: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.76      schwarze  909:                const char *file, int line, int col, const char *msg)
1.30      schwarze  910: {
1.94      schwarze  911:        const char      *mparse_msg;
1.45      schwarze  912:
1.92      schwarze  913:        fprintf(stderr, "%s: %s:", progname, file);
                    914:
                    915:        if (line)
                    916:                fprintf(stderr, "%d:%d:", line, col + 1);
                    917:
1.94      schwarze  918:        fprintf(stderr, " %s", mparse_strlevel(lvl));
                    919:
                    920:        if (NULL != (mparse_msg = mparse_strerror(t)))
                    921:                fprintf(stderr, ": %s", mparse_msg);
1.30      schwarze  922:
                    923:        if (msg)
                    924:                fprintf(stderr, ": %s", msg);
1.76      schwarze  925:
1.30      schwarze  926:        fputc('\n', stderr);
1.95      schwarze  927: }
                    928:
1.130     schwarze  929: static pid_t
1.149     schwarze  930: spawn_pager(struct tag_files *tag_files)
1.95      schwarze  931: {
                    932: #define MAX_PAGER_ARGS 16
                    933:        char            *argv[MAX_PAGER_ARGS];
                    934:        const char      *pager;
                    935:        char            *cp;
1.144     schwarze  936:        size_t           cmdlen;
1.95      schwarze  937:        int              argc;
1.130     schwarze  938:        pid_t            pager_pid;
1.95      schwarze  939:
1.144     schwarze  940:        pager = getenv("MANPAGER");
                    941:        if (pager == NULL || *pager == '\0')
                    942:                pager = getenv("PAGER");
                    943:        if (pager == NULL || *pager == '\0')
                    944:                pager = "more -s";
                    945:        cp = mandoc_strdup(pager);
                    946:
                    947:        /*
                    948:         * Parse the pager command into words.
                    949:         * Intentionally do not do anything fancy here.
                    950:         */
                    951:
                    952:        argc = 0;
                    953:        while (argc + 4 < MAX_PAGER_ARGS) {
                    954:                argv[argc++] = cp;
                    955:                cp = strchr(cp, ' ');
                    956:                if (cp == NULL)
                    957:                        break;
                    958:                *cp++ = '\0';
                    959:                while (*cp == ' ')
                    960:                        cp++;
                    961:                if (*cp == '\0')
                    962:                        break;
                    963:        }
                    964:
1.149     schwarze  965:        /* For more(1) and less(1), use the tag file. */
1.144     schwarze  966:
1.149     schwarze  967:        if ((cmdlen = strlen(argv[0])) >= 4) {
1.144     schwarze  968:                cp = argv[0] + cmdlen - 4;
1.149     schwarze  969:                if (strcmp(cp, "less") == 0 || strcmp(cp, "more") == 0) {
                    970:                        argv[argc++] = mandoc_strdup("-T");
                    971:                        argv[argc++] = tag_files->tfn;
                    972:                }
1.144     schwarze  973:        }
1.149     schwarze  974:        argv[argc++] = tag_files->ofn;
1.144     schwarze  975:        argv[argc] = NULL;
                    976:
1.130     schwarze  977:        switch (pager_pid = fork()) {
1.95      schwarze  978:        case -1:
                    979:                fprintf(stderr, "%s: fork: %s\n",
                    980:                    progname, strerror(errno));
                    981:                exit((int)MANDOCLEVEL_SYSERR);
                    982:        case 0:
1.129     schwarze  983:                break;
                    984:        default:
1.150     schwarze  985:                return pager_pid;
1.95      schwarze  986:        }
                    987:
1.129     schwarze  988:        /* The child process becomes the pager. */
1.95      schwarze  989:
1.149     schwarze  990:        if (dup2(tag_files->ofd, STDOUT_FILENO) == -1) {
                    991:                fprintf(stderr, "pager: stdout: %s\n", strerror(errno));
1.95      schwarze  992:                exit((int)MANDOCLEVEL_SYSERR);
                    993:        }
1.149     schwarze  994:        close(tag_files->ofd);
                    995:        close(tag_files->tfd);
1.95      schwarze  996:        execvp(argv[0], argv);
1.143     schwarze  997:        fprintf(stderr, "%s: exec %s: %s\n",
                    998:            progname, argv[0], strerror(errno));
1.95      schwarze  999:        exit((int)MANDOCLEVEL_SYSERR);
1.30      schwarze 1000: }