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

Annotation of mandoc/main.c, Revision 1.254

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

CVSweb