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

Annotation of mandoc/main.c, Revision 1.212

1.212   ! schwarze    1: /*     $Id: main.c,v 1.211 2015/01/01 13:20:38 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.25      kristaps   11:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     12:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     13:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     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.58      kristaps   22:
1.1       kristaps   23: #include <assert.h>
1.185     schwarze   24: #include <ctype.h>
1.183     schwarze   25: #include <errno.h>
1.186     schwarze   26: #include <fcntl.h>
1.1       kristaps   27: #include <stdio.h>
1.45      kristaps   28: #include <stdint.h>
1.1       kristaps   29: #include <stdlib.h>
                     30: #include <string.h>
                     31: #include <unistd.h>
                     32:
1.71      kristaps   33: #include "mandoc.h"
1.172     schwarze   34: #include "mandoc_aux.h"
1.90      kristaps   35: #include "main.h"
1.1       kristaps   36: #include "mdoc.h"
1.10      kristaps   37: #include "man.h"
1.180     schwarze   38: #include "manpath.h"
                     39: #include "mansearch.h"
1.101     joerg      40:
1.55      kristaps   41: #if !defined(__GNUC__) || (__GNUC__ < 2)
1.56      kristaps   42: # if !defined(lint)
                     43: #  define __attribute__(x)
                     44: # endif
1.55      kristaps   45: #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */
1.16      kristaps   46:
1.181     schwarze   47: enum   outmode {
                     48:        OUTMODE_DEF = 0,
                     49:        OUTMODE_FLN,
                     50:        OUTMODE_LST,
                     51:        OUTMODE_ALL,
                     52:        OUTMODE_INT,
                     53:        OUTMODE_ONE
                     54: };
                     55:
1.42      kristaps   56: typedef        void            (*out_mdoc)(void *, const struct mdoc *);
                     57: typedef        void            (*out_man)(void *, const struct man *);
1.22      kristaps   58: typedef        void            (*out_free)(void *);
                     59:
1.19      kristaps   60: enum   outt {
1.154     kristaps   61:        OUTT_ASCII = 0, /* -Tascii */
1.162     kristaps   62:        OUTT_LOCALE,    /* -Tlocale */
1.163     kristaps   63:        OUTT_UTF8,      /* -Tutf8 */
1.154     kristaps   64:        OUTT_TREE,      /* -Ttree */
1.164     schwarze   65:        OUTT_MAN,       /* -Tman */
1.154     kristaps   66:        OUTT_HTML,      /* -Thtml */
                     67:        OUTT_LINT,      /* -Tlint */
                     68:        OUTT_PS,        /* -Tps */
                     69:        OUTT_PDF        /* -Tpdf */
1.19      kristaps   70: };
                     71:
1.5       kristaps   72: struct curparse {
1.154     kristaps   73:        struct mparse    *mp;
1.195     schwarze   74:        struct mchars    *mchars;       /* character table */
1.148     kristaps   75:        enum mandoclevel  wlevel;       /* ignore messages below this */
                     76:        int               wstop;        /* stop after a file with a warning */
1.173     schwarze   77:        enum outt         outtype;      /* which output to use */
1.79      kristaps   78:        out_mdoc          outmdoc;      /* mdoc output ptr */
1.173     schwarze   79:        out_man           outman;       /* man output ptr */
1.79      kristaps   80:        out_free          outfree;      /* free output ptr */
                     81:        void             *outdata;      /* data for output */
                     82:        char              outopts[BUFSIZ]; /* buf of output opts */
                     83: };
                     84:
1.194     schwarze   85: static int               koptions(int *, char *);
1.203     schwarze   86: #if HAVE_SQLITE3
                     87: int                      mandocdb(int, char**);
                     88: #endif
1.170     schwarze   89: static int               moptions(int *, char *);
1.155     kristaps   90: static void              mmsg(enum mandocerr, enum mandoclevel,
                     91:                                const char *, int, int, const char *);
1.173     schwarze   92: static void              parse(struct curparse *, int,
1.154     kristaps   93:                                const char *, enum mandoclevel *);
1.205     schwarze   94: #if HAVE_SQLITE3
1.197     schwarze   95: static enum mandoclevel  passthrough(const char *, int, int);
1.205     schwarze   96: #endif
1.183     schwarze   97: static void              spawn_pager(void);
1.66      kristaps   98: static int               toptions(struct curparse *, char *);
1.180     schwarze   99: static void              usage(enum argmode) __attribute__((noreturn));
1.55      kristaps  100: static void              version(void) __attribute__((noreturn));
1.103     schwarze  101: static int               woptions(struct curparse *, char *);
1.1       kristaps  102:
1.182     schwarze  103: static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
1.202     schwarze  104: static char              help_arg[] = "help";
                    105: static char             *help_argv[] = {help_arg, NULL};
1.54      kristaps  106: static const char       *progname;
1.1       kristaps  107:
1.173     schwarze  108:
1.1       kristaps  109: int
                    110: main(int argc, char *argv[])
                    111: {
1.5       kristaps  112:        struct curparse  curp;
1.180     schwarze  113:        struct mansearch search;
                    114:        struct manpaths  paths;
1.205     schwarze  115:        char            *auxpaths;
1.180     schwarze  116:        char            *defos;
1.207     schwarze  117:        unsigned char   *uc;
1.180     schwarze  118: #if HAVE_SQLITE3
1.186     schwarze  119:        struct manpage  *res, *resp;
1.205     schwarze  120:        char            *conf_file, *defpaths;
1.182     schwarze  121:        size_t           isec, i, sz;
1.205     schwarze  122:        int              prio, best_prio, synopsis_only;
1.182     schwarze  123:        char             sec;
1.180     schwarze  124: #endif
                    125:        enum mandoclevel rc;
1.181     schwarze  126:        enum outmode     outmode;
1.192     schwarze  127:        int              fd;
1.180     schwarze  128:        int              show_usage;
1.183     schwarze  129:        int              use_pager;
1.170     schwarze  130:        int              options;
1.180     schwarze  131:        int              c;
1.1       kristaps  132:
1.54      kristaps  133:        progname = strrchr(argv[0], '/');
                    134:        if (progname == NULL)
                    135:                progname = argv[0];
                    136:        else
                    137:                ++progname;
1.203     schwarze  138:
                    139: #if HAVE_SQLITE3
1.204     schwarze  140:        if (strcmp(progname, BINM_MAKEWHATIS) == 0)
1.203     schwarze  141:                return(mandocdb(argc, argv));
                    142: #endif
1.179     schwarze  143:
1.180     schwarze  144:        /* Search options. */
                    145:
                    146:        memset(&paths, 0, sizeof(struct manpaths));
1.205     schwarze  147: #if HAVE_SQLITE3
                    148:        conf_file = defpaths = NULL;
                    149: #endif
                    150:        auxpaths = NULL;
1.180     schwarze  151:
                    152:        memset(&search, 0, sizeof(struct mansearch));
                    153:        search.outkey = "Nd";
                    154:
1.204     schwarze  155:        if (strcmp(progname, BINM_MAN) == 0)
1.180     schwarze  156:                search.argmode = ARG_NAME;
1.204     schwarze  157:        else if (strcmp(progname, BINM_APROPOS) == 0)
1.180     schwarze  158:                search.argmode = ARG_EXPR;
1.204     schwarze  159:        else if (strcmp(progname, BINM_WHATIS) == 0)
1.180     schwarze  160:                search.argmode = ARG_WORD;
1.202     schwarze  161:        else if (strncmp(progname, "help", 4) == 0)
                    162:                search.argmode = ARG_NAME;
1.180     schwarze  163:        else
                    164:                search.argmode = ARG_FILE;
                    165:
                    166:        /* Parser and formatter options. */
1.54      kristaps  167:
1.51      kristaps  168:        memset(&curp, 0, sizeof(struct curparse));
1.201     schwarze  169:        curp.outtype = OUTT_LOCALE;
1.103     schwarze  170:        curp.wlevel  = MANDOCLEVEL_FATAL;
1.194     schwarze  171:        options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
1.166     schwarze  172:        defos = NULL;
1.19      kristaps  173:
1.183     schwarze  174:        use_pager = 1;
1.180     schwarze  175:        show_usage = 0;
1.205     schwarze  176: #if HAVE_SQLITE3
1.197     schwarze  177:        synopsis_only = 0;
1.205     schwarze  178: #endif
1.181     schwarze  179:        outmode = OUTMODE_DEF;
1.183     schwarze  180:
1.194     schwarze  181:        while (-1 != (c = getopt(argc, argv,
                    182:                        "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
1.1       kristaps  183:                switch (c) {
1.181     schwarze  184:                case 'a':
                    185:                        outmode = OUTMODE_ALL;
                    186:                        break;
1.180     schwarze  187:                case 'C':
1.205     schwarze  188: #if HAVE_SQLITE3
1.180     schwarze  189:                        conf_file = optarg;
1.205     schwarze  190: #endif
1.180     schwarze  191:                        break;
1.183     schwarze  192:                case 'c':
                    193:                        use_pager = 0;
                    194:                        break;
1.180     schwarze  195:                case 'f':
                    196:                        search.argmode = ARG_WORD;
                    197:                        break;
1.190     schwarze  198:                case 'h':
                    199:                        (void)strlcat(curp.outopts, "synopsis,", BUFSIZ);
1.205     schwarze  200: #if HAVE_SQLITE3
1.197     schwarze  201:                        synopsis_only = 1;
1.205     schwarze  202: #endif
1.198     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.173     schwarze  208:                                fprintf(stderr,
1.209     schwarze  209:                                    "%s: -I %s: Bad argument\n",
1.176     schwarze  210:                                    progname, optarg);
1.166     schwarze  211:                                return((int)MANDOCLEVEL_BADARG);
                    212:                        }
                    213:                        if (defos) {
1.173     schwarze  214:                                fprintf(stderr,
1.209     schwarze  215:                                    "%s: -I %s: Duplicate argument\n",
1.176     schwarze  216:                                    progname, optarg);
1.166     schwarze  217:                                return((int)MANDOCLEVEL_BADARG);
                    218:                        }
                    219:                        defos = mandoc_strdup(optarg + 3);
                    220:                        break;
1.181     schwarze  221:                case 'i':
                    222:                        outmode = OUTMODE_INT;
                    223:                        break;
1.194     schwarze  224:                case 'K':
                    225:                        if ( ! koptions(&options, optarg))
                    226:                                return((int)MANDOCLEVEL_BADARG);
                    227:                        break;
1.180     schwarze  228:                case 'k':
                    229:                        search.argmode = ARG_EXPR;
                    230:                        break;
1.188     schwarze  231:                case 'l':
                    232:                        search.argmode = ARG_FILE;
                    233:                        outmode = OUTMODE_ALL;
                    234:                        break;
1.180     schwarze  235:                case 'M':
1.205     schwarze  236: #if HAVE_SQLITE3
1.180     schwarze  237:                        defpaths = optarg;
1.205     schwarze  238: #endif
1.180     schwarze  239:                        break;
1.173     schwarze  240:                case 'm':
1.180     schwarze  241:                        auxpaths = optarg;
1.10      kristaps  242:                        break;
1.173     schwarze  243:                case 'O':
1.180     schwarze  244:                        search.outkey = optarg;
1.49      kristaps  245:                        (void)strlcat(curp.outopts, optarg, BUFSIZ);
                    246:                        (void)strlcat(curp.outopts, ",", BUFSIZ);
1.44      kristaps  247:                        break;
1.180     schwarze  248:                case 'S':
                    249:                        search.arch = optarg;
                    250:                        break;
                    251:                case 's':
                    252:                        search.sec = optarg;
                    253:                        break;
1.173     schwarze  254:                case 'T':
1.60      kristaps  255:                        if ( ! toptions(&curp, optarg))
1.105     kristaps  256:                                return((int)MANDOCLEVEL_BADARG);
1.1       kristaps  257:                        break;
1.173     schwarze  258:                case 'W':
1.103     schwarze  259:                        if ( ! woptions(&curp, optarg))
1.105     kristaps  260:                                return((int)MANDOCLEVEL_BADARG);
1.1       kristaps  261:                        break;
1.181     schwarze  262:                case 'w':
                    263:                        outmode = OUTMODE_FLN;
                    264:                        break;
1.173     schwarze  265:                case 'V':
1.1       kristaps  266:                        version();
                    267:                        /* NOTREACHED */
                    268:                default:
1.180     schwarze  269:                        show_usage = 1;
                    270:                        break;
1.1       kristaps  271:                }
1.180     schwarze  272:        }
                    273:
                    274:        if (show_usage)
                    275:                usage(search.argmode);
                    276:
1.185     schwarze  277:        /* Postprocess options. */
                    278:
1.181     schwarze  279:        if (outmode == OUTMODE_DEF) {
                    280:                switch (search.argmode) {
                    281:                case ARG_FILE:
                    282:                        outmode = OUTMODE_ALL;
1.183     schwarze  283:                        use_pager = 0;
1.181     schwarze  284:                        break;
                    285:                case ARG_NAME:
                    286:                        outmode = OUTMODE_ONE;
                    287:                        break;
                    288:                default:
                    289:                        outmode = OUTMODE_LST;
                    290:                        break;
                    291:                }
                    292:        }
                    293:
1.185     schwarze  294:        /* Parse arguments. */
                    295:
1.180     schwarze  296:        argc -= optind;
                    297:        argv += optind;
1.182     schwarze  298: #if HAVE_SQLITE3
1.186     schwarze  299:        resp = NULL;
1.182     schwarze  300: #endif
1.185     schwarze  301:
1.202     schwarze  302:        /*
                    303:         * Quirks for help(1)
                    304:         * and for a man(1) section argument without -s.
                    305:         */
                    306:
                    307:        if (search.argmode == ARG_NAME) {
                    308:                if (*progname == 'h') {
                    309:                        if (argc == 0) {
                    310:                                argv = help_argv;
                    311:                                argc = 1;
                    312:                        }
1.211     schwarze  313:                } else if (argc > 1 &&
                    314:                    ((uc = argv[0]) != NULL) &&
1.207     schwarze  315:                    ((isdigit(uc[0]) && (uc[1] == '\0' ||
                    316:                      (isalpha(uc[1]) && uc[2] == '\0'))) ||
                    317:                     (uc[0] == 'n' && uc[1] == '\0'))) {
                    318:                        search.sec = uc;
1.202     schwarze  319:                        argv++;
                    320:                        argc--;
                    321:                }
1.185     schwarze  322:        }
1.182     schwarze  323:
                    324:        rc = MANDOCLEVEL_OK;
1.180     schwarze  325:
                    326:        /* man(1), whatis(1), apropos(1) */
                    327:
                    328:        if (search.argmode != ARG_FILE) {
                    329: #if HAVE_SQLITE3
                    330:                if (argc == 0)
                    331:                        usage(search.argmode);
1.199     schwarze  332:
                    333:                if (search.argmode == ARG_NAME &&
                    334:                    outmode == OUTMODE_ONE)
                    335:                        search.firstmatch = 1;
1.182     schwarze  336:
                    337:                /* Access the mandoc database. */
                    338:
1.180     schwarze  339:                manpath_parse(&paths, conf_file, defpaths, auxpaths);
                    340:                mansearch_setup(1);
                    341:                if( ! mansearch(&search, &paths, argc, argv, &res, &sz))
                    342:                        usage(search.argmode);
1.186     schwarze  343:                resp = res;
1.187     schwarze  344:
                    345:                if (sz == 0) {
                    346:                        if (search.argmode == ARG_NAME)
                    347:                                fprintf(stderr, "%s: No entry for %s "
                    348:                                    "in the manual.\n", progname, argv[0]);
                    349:                        rc = MANDOCLEVEL_BADARG;
                    350:                        goto out;
                    351:                }
1.182     schwarze  352:
                    353:                /*
                    354:                 * For standard man(1) and -a output mode,
                    355:                 * prepare for copying filename pointers
                    356:                 * into the program parameter array.
                    357:                 */
                    358:
                    359:                if (outmode == OUTMODE_ONE) {
                    360:                        argc = 1;
                    361:                        best_prio = 10;
1.186     schwarze  362:                } else if (outmode == OUTMODE_ALL)
1.182     schwarze  363:                        argc = (int)sz;
                    364:
                    365:                /* Iterate all matching manuals. */
                    366:
1.181     schwarze  367:                for (i = 0; i < sz; i++) {
                    368:                        if (outmode == OUTMODE_FLN)
                    369:                                puts(res[i].file);
1.182     schwarze  370:                        else if (outmode == OUTMODE_LST)
1.181     schwarze  371:                                printf("%s - %s\n", res[i].names,
                    372:                                    res[i].output == NULL ? "" :
                    373:                                    res[i].output);
1.186     schwarze  374:                        else if (outmode == OUTMODE_ONE) {
1.182     schwarze  375:                                /* Search for the best section. */
                    376:                                isec = strcspn(res[i].file, "123456789");
                    377:                                sec = res[i].file[isec];
                    378:                                if ('\0' == sec)
                    379:                                        continue;
                    380:                                prio = sec_prios[sec - '1'];
                    381:                                if (prio >= best_prio)
                    382:                                        continue;
                    383:                                best_prio = prio;
1.186     schwarze  384:                                resp = res + i;
1.182     schwarze  385:                        }
1.181     schwarze  386:                }
1.182     schwarze  387:
                    388:                /*
                    389:                 * For man(1), -a and -i output mode, fall through
                    390:                 * to the main mandoc(1) code iterating files
                    391:                 * and running the parsers on each of them.
                    392:                 */
                    393:
                    394:                if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
                    395:                        goto out;
1.180     schwarze  396: #else
                    397:                fputs("mandoc: database support not compiled in\n",
                    398:                    stderr);
                    399:                return((int)MANDOCLEVEL_BADARG);
                    400: #endif
                    401:        }
                    402:
                    403:        /* mandoc(1) */
                    404:
1.209     schwarze  405:        if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths))
1.180     schwarze  406:                return((int)MANDOCLEVEL_BADARG);
1.1       kristaps  407:
1.195     schwarze  408:        curp.mchars = mchars_alloc();
                    409:        curp.mp = mparse_alloc(options, curp.wlevel, mmsg,
                    410:            curp.mchars, defos);
1.154     kristaps  411:
1.165     kristaps  412:        /*
                    413:         * Conditionally start up the lookaside buffer before parsing.
                    414:         */
                    415:        if (OUTT_MAN == curp.outtype)
                    416:                mparse_keep(curp.mp);
                    417:
1.212   ! schwarze  418:        if (argc == 0) {
        !           419:                if (use_pager && isatty(STDOUT_FILENO))
        !           420:                        spawn_pager();
1.154     kristaps  421:                parse(&curp, STDIN_FILENO, "<stdin>", &rc);
1.212   ! schwarze  422:        }
1.64      kristaps  423:
1.186     schwarze  424:        while (argc) {
1.212   ! schwarze  425:                rc = mparse_open(curp.mp, &fd,
        !           426: #if HAVE_SQLITE3
        !           427:                    resp != NULL ? resp->file :
        !           428: #endif
        !           429:                    *argv);
        !           430:
        !           431:                if (fd != -1) {
        !           432:                        if (use_pager && isatty(STDOUT_FILENO))
        !           433:                                spawn_pager();
        !           434:                        use_pager = 0;
        !           435:
        !           436: #if HAVE_SQLITE3
        !           437:                        if (resp == NULL)
        !           438: #endif
        !           439:                                parse(&curp, fd, *argv, &rc);
1.186     schwarze  440: #if HAVE_SQLITE3
1.192     schwarze  441:                        else if (resp->form & FORM_SRC) {
1.189     schwarze  442:                                /* For .so only; ignore failure. */
                    443:                                chdir(paths.paths[resp->ipath]);
1.192     schwarze  444:                                parse(&curp, fd, resp->file, &rc);
1.189     schwarze  445:                        } else
1.197     schwarze  446:                                rc = passthrough(resp->file, fd,
                    447:                                    synopsis_only);
1.186     schwarze  448: #endif
1.212   ! schwarze  449:
        !           450:                        if (mparse_wait(curp.mp) != MANDOCLEVEL_OK)
        !           451:                                rc = MANDOCLEVEL_SYSERR;
        !           452:
        !           453:                        if (argc > 1 && curp.outtype <= OUTT_UTF8)
        !           454:                                ascii_sepline(curp.outdata);
1.192     schwarze  455:                }
                    456:
1.154     kristaps  457:                if (MANDOCLEVEL_OK != rc && curp.wstop)
1.64      kristaps  458:                        break;
1.210     schwarze  459:
1.212   ! schwarze  460: #if HAVE_SQLITE3
        !           461:                if (resp != NULL)
        !           462:                        resp++;
        !           463:                else
        !           464: #endif
        !           465:                        argv++;
        !           466:                if (--argc)
        !           467:                        mparse_reset(curp.mp);
1.1       kristaps  468:        }
                    469:
1.22      kristaps  470:        if (curp.outfree)
                    471:                (*curp.outfree)(curp.outdata);
1.195     schwarze  472:        mparse_free(curp.mp);
                    473:        mchars_free(curp.mchars);
1.182     schwarze  474:
                    475: #if HAVE_SQLITE3
                    476: out:
                    477:        if (search.argmode != ARG_FILE) {
1.189     schwarze  478:                manpath_free(&paths);
1.182     schwarze  479:                mansearch_free(res, sz);
                    480:                mansearch_setup(0);
                    481:        }
                    482: #endif
                    483:
1.166     schwarze  484:        free(defos);
1.1       kristaps  485:
1.154     kristaps  486:        return((int)rc);
1.1       kristaps  487: }
                    488:
1.55      kristaps  489: static void
1.1       kristaps  490: version(void)
                    491: {
                    492:
1.180     schwarze  493:        printf("mandoc %s\n", VERSION);
1.105     kristaps  494:        exit((int)MANDOCLEVEL_OK);
1.1       kristaps  495: }
                    496:
1.55      kristaps  497: static void
1.180     schwarze  498: usage(enum argmode argmode)
1.1       kristaps  499: {
                    500:
1.180     schwarze  501:        switch (argmode) {
                    502:        case ARG_FILE:
1.190     schwarze  503:                fputs("usage: mandoc [-acfhklV] [-Ios=name] "
1.196     schwarze  504:                    "[-Kencoding] [-mformat] [-Ooption]\n"
                    505:                    "\t      [-Toutput] [-Wlevel] [file ...]\n", stderr);
1.180     schwarze  506:                break;
                    507:        case ARG_NAME:
1.208     schwarze  508:                fputs("usage: man [-acfhklVw] [-C file] [-I os=name] "
                    509:                    "[-K encoding] [-M path] [-m path]\n"
                    510:                    "\t   [-O option=value] [-S subsection] [-s section] "
                    511:                    "[-T output] [-W level]\n"
1.180     schwarze  512:                    "\t   [section] name ...\n", stderr);
                    513:                break;
                    514:        case ARG_WORD:
1.190     schwarze  515:                fputs("usage: whatis [-acfhklVw] [-C file] "
1.188     schwarze  516:                    "[-M path] [-m path] [-O outkey] [-S arch]\n"
                    517:                    "\t      [-s section] name ...\n", stderr);
1.180     schwarze  518:                break;
                    519:        case ARG_EXPR:
1.190     schwarze  520:                fputs("usage: apropos [-acfhklVw] [-C file] "
1.188     schwarze  521:                    "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.180     schwarze  522:                    "\t       [-s section] expression ...\n", stderr);
                    523:                break;
                    524:        }
1.105     kristaps  525:        exit((int)MANDOCLEVEL_BADARG);
1.68      joerg     526: }
                    527:
1.64      kristaps  528: static void
1.173     schwarze  529: parse(struct curparse *curp, int fd, const char *file,
                    530:        enum mandoclevel *level)
1.1       kristaps  531: {
1.154     kristaps  532:        enum mandoclevel  rc;
                    533:        struct mdoc      *mdoc;
                    534:        struct man       *man;
1.112     kristaps  535:
1.154     kristaps  536:        /* Begin by parsing the file itself. */
1.112     kristaps  537:
1.154     kristaps  538:        assert(file);
                    539:        assert(fd >= -1);
1.112     kristaps  540:
1.154     kristaps  541:        rc = mparse_readfd(curp->mp, fd, file);
1.112     kristaps  542:
1.154     kristaps  543:        /* Stop immediately if the parse has failed. */
1.92      kristaps  544:
1.154     kristaps  545:        if (MANDOCLEVEL_FATAL <= rc)
1.111     kristaps  546:                goto cleanup;
                    547:
1.1       kristaps  548:        /*
1.154     kristaps  549:         * With -Wstop and warnings or errors of at least the requested
                    550:         * level, do not produce output.
1.1       kristaps  551:         */
                    552:
1.154     kristaps  553:        if (MANDOCLEVEL_OK != rc && curp->wstop)
1.111     kristaps  554:                goto cleanup;
                    555:
                    556:        /* If unset, allocate output dev now (if applicable). */
                    557:
                    558:        if ( ! (curp->outman && curp->outmdoc)) {
                    559:                switch (curp->outtype) {
1.173     schwarze  560:                case OUTT_HTML:
1.195     schwarze  561:                        curp->outdata = html_alloc(curp->mchars,
                    562:                            curp->outopts);
1.162     kristaps  563:                        curp->outfree = html_free;
                    564:                        break;
1.173     schwarze  565:                case OUTT_UTF8:
1.195     schwarze  566:                        curp->outdata = utf8_alloc(curp->mchars,
                    567:                            curp->outopts);
1.163     kristaps  568:                        curp->outfree = ascii_free;
                    569:                        break;
1.173     schwarze  570:                case OUTT_LOCALE:
1.195     schwarze  571:                        curp->outdata = locale_alloc(curp->mchars,
                    572:                            curp->outopts);
1.162     kristaps  573:                        curp->outfree = ascii_free;
1.111     kristaps  574:                        break;
1.173     schwarze  575:                case OUTT_ASCII:
1.195     schwarze  576:                        curp->outdata = ascii_alloc(curp->mchars,
                    577:                            curp->outopts);
1.111     kristaps  578:                        curp->outfree = ascii_free;
                    579:                        break;
1.173     schwarze  580:                case OUTT_PDF:
1.195     schwarze  581:                        curp->outdata = pdf_alloc(curp->mchars,
                    582:                            curp->outopts);
1.111     kristaps  583:                        curp->outfree = pspdf_free;
                    584:                        break;
1.173     schwarze  585:                case OUTT_PS:
1.195     schwarze  586:                        curp->outdata = ps_alloc(curp->mchars,
                    587:                            curp->outopts);
1.111     kristaps  588:                        curp->outfree = pspdf_free;
                    589:                        break;
                    590:                default:
                    591:                        break;
                    592:                }
                    593:
                    594:                switch (curp->outtype) {
1.173     schwarze  595:                case OUTT_HTML:
1.111     kristaps  596:                        curp->outman = html_man;
                    597:                        curp->outmdoc = html_mdoc;
                    598:                        break;
1.173     schwarze  599:                case OUTT_TREE:
1.111     kristaps  600:                        curp->outman = tree_man;
                    601:                        curp->outmdoc = tree_mdoc;
                    602:                        break;
1.173     schwarze  603:                case OUTT_MAN:
1.164     schwarze  604:                        curp->outmdoc = man_mdoc;
1.165     kristaps  605:                        curp->outman = man_man;
1.164     schwarze  606:                        break;
1.173     schwarze  607:                case OUTT_PDF:
1.111     kristaps  608:                        /* FALLTHROUGH */
1.173     schwarze  609:                case OUTT_ASCII:
1.111     kristaps  610:                        /* FALLTHROUGH */
1.173     schwarze  611:                case OUTT_UTF8:
1.163     kristaps  612:                        /* FALLTHROUGH */
1.173     schwarze  613:                case OUTT_LOCALE:
1.162     kristaps  614:                        /* FALLTHROUGH */
1.173     schwarze  615:                case OUTT_PS:
1.111     kristaps  616:                        curp->outman = terminal_man;
                    617:                        curp->outmdoc = terminal_mdoc;
                    618:                        break;
                    619:                default:
                    620:                        break;
                    621:                }
                    622:        }
                    623:
1.171     schwarze  624:        mparse_result(curp->mp, &mdoc, &man, NULL);
1.154     kristaps  625:
1.111     kristaps  626:        /* Execute the out device, if it exists. */
                    627:
1.154     kristaps  628:        if (man && curp->outman)
                    629:                (*curp->outman)(curp->outdata, man);
                    630:        if (mdoc && curp->outmdoc)
                    631:                (*curp->outmdoc)(curp->outdata, mdoc);
1.111     kristaps  632:
1.212   ! schwarze  633: cleanup:
1.154     kristaps  634:        if (*level < rc)
                    635:                *level = rc;
1.186     schwarze  636: }
                    637:
1.205     schwarze  638: #if HAVE_SQLITE3
1.186     schwarze  639: static enum mandoclevel
1.197     schwarze  640: passthrough(const char *file, int fd, int synopsis_only)
1.186     schwarze  641: {
1.197     schwarze  642:        const char       synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
                    643:        const char       synr[] = "SYNOPSIS";
                    644:
                    645:        FILE            *stream;
1.186     schwarze  646:        const char      *syscall;
1.197     schwarze  647:        char            *line;
                    648:        size_t           len, off;
                    649:        ssize_t          nw;
                    650:        int              print;
1.210     schwarze  651:
                    652:        fflush(stdout);
1.197     schwarze  653:
                    654:        if ((stream = fdopen(fd, "r")) == NULL) {
                    655:                close(fd);
                    656:                syscall = "fdopen";
                    657:                goto fail;
                    658:        }
1.186     schwarze  659:
1.197     schwarze  660:        print = 0;
                    661:        while ((line = fgetln(stream, &len)) != NULL) {
                    662:                if (synopsis_only) {
                    663:                        if (print) {
                    664:                                if ( ! isspace((unsigned char)*line))
                    665:                                        goto done;
                    666:                                while (len &&
                    667:                                    isspace((unsigned char)*line)) {
                    668:                                        line++;
                    669:                                        len--;
                    670:                                }
                    671:                        } else {
                    672:                                if ((len == sizeof(synb) &&
                    673:                                     ! strncmp(line, synb, len - 1)) ||
                    674:                                    (len == sizeof(synr) &&
                    675:                                     ! strncmp(line, synr, len - 1)))
                    676:                                        print = 1;
                    677:                                continue;
                    678:                        }
                    679:                }
                    680:                for (off = 0; off < len; off += nw)
                    681:                        if ((nw = write(STDOUT_FILENO, line + off,
                    682:                            len - off)) == -1 || nw == 0) {
                    683:                                fclose(stream);
1.186     schwarze  684:                                syscall = "write";
                    685:                                goto fail;
                    686:                        }
1.197     schwarze  687:        }
1.186     schwarze  688:
1.197     schwarze  689:        if (ferror(stream)) {
                    690:                fclose(stream);
                    691:                syscall = "fgetln";
                    692:                goto fail;
                    693:        }
1.193     schwarze  694:
1.197     schwarze  695: done:
                    696:        fclose(stream);
                    697:        return(MANDOCLEVEL_OK);
1.186     schwarze  698:
                    699: fail:
                    700:        fprintf(stderr, "%s: %s: SYSERR: %s: %s",
                    701:            progname, file, syscall, strerror(errno));
                    702:        return(MANDOCLEVEL_SYSERR);
1.194     schwarze  703: }
1.205     schwarze  704: #endif
1.194     schwarze  705:
                    706: static int
                    707: koptions(int *options, char *arg)
                    708: {
                    709:
                    710:        if ( ! strcmp(arg, "utf-8")) {
                    711:                *options |=  MPARSE_UTF8;
                    712:                *options &= ~MPARSE_LATIN1;
                    713:        } else if ( ! strcmp(arg, "iso-8859-1")) {
                    714:                *options |=  MPARSE_LATIN1;
                    715:                *options &= ~MPARSE_UTF8;
                    716:        } else if ( ! strcmp(arg, "us-ascii")) {
                    717:                *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
                    718:        } else {
1.209     schwarze  719:                fprintf(stderr, "%s: -K %s: Bad argument\n",
1.194     schwarze  720:                    progname, arg);
                    721:                return(0);
                    722:        }
                    723:        return(1);
1.10      kristaps  724: }
                    725:
                    726: static int
1.170     schwarze  727: moptions(int *options, char *arg)
1.10      kristaps  728: {
                    729:
1.180     schwarze  730:        if (arg == NULL)
                    731:                /* nothing to do */;
                    732:        else if (0 == strcmp(arg, "doc"))
1.170     schwarze  733:                *options |= MPARSE_MDOC;
1.19      kristaps  734:        else if (0 == strcmp(arg, "andoc"))
1.170     schwarze  735:                /* nothing to do */;
1.17      kristaps  736:        else if (0 == strcmp(arg, "an"))
1.170     schwarze  737:                *options |= MPARSE_MAN;
1.10      kristaps  738:        else {
1.209     schwarze  739:                fprintf(stderr, "%s: -m %s: Bad argument\n",
1.176     schwarze  740:                    progname, arg);
1.10      kristaps  741:                return(0);
                    742:        }
                    743:
                    744:        return(1);
1.1       kristaps  745: }
                    746:
                    747: static int
1.60      kristaps  748: toptions(struct curparse *curp, char *arg)
1.1       kristaps  749: {
                    750:
                    751:        if (0 == strcmp(arg, "ascii"))
1.60      kristaps  752:                curp->outtype = OUTT_ASCII;
                    753:        else if (0 == strcmp(arg, "lint")) {
                    754:                curp->outtype = OUTT_LINT;
1.103     schwarze  755:                curp->wlevel  = MANDOCLEVEL_WARNING;
1.154     kristaps  756:        } else if (0 == strcmp(arg, "tree"))
1.60      kristaps  757:                curp->outtype = OUTT_TREE;
1.164     schwarze  758:        else if (0 == strcmp(arg, "man"))
                    759:                curp->outtype = OUTT_MAN;
1.43      kristaps  760:        else if (0 == strcmp(arg, "html"))
1.60      kristaps  761:                curp->outtype = OUTT_HTML;
1.163     kristaps  762:        else if (0 == strcmp(arg, "utf8"))
                    763:                curp->outtype = OUTT_UTF8;
1.162     kristaps  764:        else if (0 == strcmp(arg, "locale"))
                    765:                curp->outtype = OUTT_LOCALE;
1.59      kristaps  766:        else if (0 == strcmp(arg, "xhtml"))
1.195     schwarze  767:                curp->outtype = OUTT_HTML;
1.85      kristaps  768:        else if (0 == strcmp(arg, "ps"))
                    769:                curp->outtype = OUTT_PS;
1.100     kristaps  770:        else if (0 == strcmp(arg, "pdf"))
                    771:                curp->outtype = OUTT_PDF;
1.1       kristaps  772:        else {
1.209     schwarze  773:                fprintf(stderr, "%s: -T %s: Bad argument\n",
1.176     schwarze  774:                    progname, arg);
1.1       kristaps  775:                return(0);
                    776:        }
                    777:
                    778:        return(1);
                    779: }
                    780:
                    781: static int
1.103     schwarze  782: woptions(struct curparse *curp, char *arg)
1.1       kristaps  783: {
1.34      kristaps  784:        char            *v, *o;
1.173     schwarze  785:        const char      *toks[6];
1.1       kristaps  786:
1.103     schwarze  787:        toks[0] = "stop";
                    788:        toks[1] = "all";
                    789:        toks[2] = "warning";
                    790:        toks[3] = "error";
                    791:        toks[4] = "fatal";
                    792:        toks[5] = NULL;
1.1       kristaps  793:
1.34      kristaps  794:        while (*arg) {
                    795:                o = arg;
1.45      kristaps  796:                switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.173     schwarze  797:                case 0:
1.103     schwarze  798:                        curp->wstop = 1;
1.1       kristaps  799:                        break;
1.173     schwarze  800:                case 1:
1.103     schwarze  801:                        /* FALLTHROUGH */
1.173     schwarze  802:                case 2:
1.103     schwarze  803:                        curp->wlevel = MANDOCLEVEL_WARNING;
1.1       kristaps  804:                        break;
1.173     schwarze  805:                case 3:
1.103     schwarze  806:                        curp->wlevel = MANDOCLEVEL_ERROR;
1.24      kristaps  807:                        break;
1.173     schwarze  808:                case 4:
1.103     schwarze  809:                        curp->wlevel = MANDOCLEVEL_FATAL;
1.50      kristaps  810:                        break;
1.1       kristaps  811:                default:
1.209     schwarze  812:                        fprintf(stderr, "%s: -W %s: Bad argument\n",
1.176     schwarze  813:                            progname, o);
1.1       kristaps  814:                        return(0);
                    815:                }
1.34      kristaps  816:        }
1.1       kristaps  817:
                    818:        return(1);
                    819: }
                    820:
1.153     kristaps  821: static void
1.173     schwarze  822: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.155     kristaps  823:                const char *file, int line, int col, const char *msg)
1.71      kristaps  824: {
1.177     schwarze  825:        const char      *mparse_msg;
1.103     schwarze  826:
1.175     schwarze  827:        fprintf(stderr, "%s: %s:", progname, file);
                    828:
                    829:        if (line)
                    830:                fprintf(stderr, "%d:%d:", line, col + 1);
                    831:
1.177     schwarze  832:        fprintf(stderr, " %s", mparse_strlevel(lvl));
                    833:
                    834:        if (NULL != (mparse_msg = mparse_strerror(t)))
                    835:                fprintf(stderr, ": %s", mparse_msg);
1.154     kristaps  836:
1.73      kristaps  837:        if (msg)
                    838:                fprintf(stderr, ": %s", msg);
1.154     kristaps  839:
1.73      kristaps  840:        fputc('\n', stderr);
1.183     schwarze  841: }
                    842:
                    843: static void
                    844: spawn_pager(void)
                    845: {
1.184     schwarze  846: #define MAX_PAGER_ARGS 16
                    847:        char            *argv[MAX_PAGER_ARGS];
                    848:        const char      *pager;
                    849:        char            *cp;
                    850:        int              fildes[2];
                    851:        int              argc;
1.183     schwarze  852:
                    853:        if (pipe(fildes) == -1) {
                    854:                fprintf(stderr, "%s: pipe: %s\n",
                    855:                    progname, strerror(errno));
                    856:                return;
                    857:        }
                    858:
                    859:        switch (fork()) {
                    860:        case -1:
                    861:                fprintf(stderr, "%s: fork: %s\n",
                    862:                    progname, strerror(errno));
                    863:                exit((int)MANDOCLEVEL_SYSERR);
                    864:        case 0:
                    865:                close(fildes[0]);
                    866:                if (dup2(fildes[1], STDOUT_FILENO) == -1) {
                    867:                        fprintf(stderr, "%s: dup output: %s\n",
                    868:                            progname, strerror(errno));
                    869:                        exit((int)MANDOCLEVEL_SYSERR);
                    870:                }
                    871:                return;
                    872:        default:
1.184     schwarze  873:                break;
                    874:        }
                    875:
                    876:        /* The original process becomes the pager. */
                    877:
                    878:        close(fildes[1]);
                    879:        if (dup2(fildes[0], STDIN_FILENO) == -1) {
                    880:                fprintf(stderr, "%s: dup input: %s\n",
                    881:                    progname, strerror(errno));
1.183     schwarze  882:                exit((int)MANDOCLEVEL_SYSERR);
                    883:        }
1.184     schwarze  884:
                    885:        pager = getenv("MANPAGER");
                    886:        if (pager == NULL || *pager == '\0')
                    887:                pager = getenv("PAGER");
                    888:        if (pager == NULL || *pager == '\0')
                    889:                pager = "/usr/bin/more -s";
                    890:        cp = mandoc_strdup(pager);
                    891:
                    892:        /*
                    893:         * Parse the pager command into words.
                    894:         * Intentionally do not do anything fancy here.
                    895:         */
                    896:
                    897:        argc = 0;
                    898:        while (argc + 1 < MAX_PAGER_ARGS) {
                    899:                argv[argc++] = cp;
                    900:                cp = strchr(cp, ' ');
                    901:                if (cp == NULL)
                    902:                        break;
                    903:                *cp++ = '\0';
                    904:                while (*cp == ' ')
                    905:                        cp++;
                    906:                if (*cp == '\0')
                    907:                        break;
                    908:        }
                    909:        argv[argc] = NULL;
                    910:
                    911:        /* Hand over to the pager. */
                    912:
                    913:        execvp(argv[0], argv);
                    914:        fprintf(stderr, "%s: exec: %s\n",
                    915:            progname, strerror(errno));
                    916:        exit((int)MANDOCLEVEL_SYSERR);
1.71      kristaps  917: }

CVSweb