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

Annotation of mandoc/main.c, Revision 1.211

1.211   ! schwarze    1: /*     $Id: main.c,v 1.210 2014/12/31 16:52:39 schwarze Exp $ */
1.1       kristaps    2: /*
1.183     schwarze    3:  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.170     schwarze    4:  * Copyright (c) 2010, 2011, 2012, 2014 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.183     schwarze  408:        if (use_pager && isatty(STDOUT_FILENO))
                    409:                spawn_pager();
                    410:
1.195     schwarze  411:        curp.mchars = mchars_alloc();
                    412:        curp.mp = mparse_alloc(options, curp.wlevel, mmsg,
                    413:            curp.mchars, defos);
1.154     kristaps  414:
1.165     kristaps  415:        /*
                    416:         * Conditionally start up the lookaside buffer before parsing.
                    417:         */
                    418:        if (OUTT_MAN == curp.outtype)
                    419:                mparse_keep(curp.mp);
                    420:
1.186     schwarze  421:        if (argc == 0)
1.154     kristaps  422:                parse(&curp, STDIN_FILENO, "<stdin>", &rc);
1.64      kristaps  423:
1.186     schwarze  424:        while (argc) {
                    425: #if HAVE_SQLITE3
                    426:                if (resp != NULL) {
1.200     schwarze  427:                        rc = mparse_open(curp.mp, &fd, resp->file);
1.192     schwarze  428:                        if (fd == -1)
                    429:                                /* nothing */;
                    430:                        else if (resp->form & FORM_SRC) {
1.189     schwarze  431:                                /* For .so only; ignore failure. */
                    432:                                chdir(paths.paths[resp->ipath]);
1.192     schwarze  433:                                parse(&curp, fd, resp->file, &rc);
1.189     schwarze  434:                        } else
1.197     schwarze  435:                                rc = passthrough(resp->file, fd,
                    436:                                    synopsis_only);
1.186     schwarze  437:                        resp++;
                    438:                } else
                    439: #endif
1.192     schwarze  440:                {
1.200     schwarze  441:                        rc = mparse_open(curp.mp, &fd, *argv++);
1.192     schwarze  442:                        if (fd != -1)
                    443:                                parse(&curp, fd, argv[-1], &rc);
                    444:                }
                    445:
1.200     schwarze  446:                if (mparse_wait(curp.mp) != MANDOCLEVEL_OK)
1.192     schwarze  447:                        rc = MANDOCLEVEL_SYSERR;
                    448:
1.154     kristaps  449:                if (MANDOCLEVEL_OK != rc && curp.wstop)
1.64      kristaps  450:                        break;
1.210     schwarze  451:
                    452:                if (--argc && curp.outtype <= OUTT_UTF8)
                    453:                        ascii_sepline(curp.outdata);
1.1       kristaps  454:        }
                    455:
1.22      kristaps  456:        if (curp.outfree)
                    457:                (*curp.outfree)(curp.outdata);
1.195     schwarze  458:        mparse_free(curp.mp);
                    459:        mchars_free(curp.mchars);
1.182     schwarze  460:
                    461: #if HAVE_SQLITE3
                    462: out:
                    463:        if (search.argmode != ARG_FILE) {
1.189     schwarze  464:                manpath_free(&paths);
1.182     schwarze  465:                mansearch_free(res, sz);
                    466:                mansearch_setup(0);
                    467:        }
                    468: #endif
                    469:
1.166     schwarze  470:        free(defos);
1.1       kristaps  471:
1.154     kristaps  472:        return((int)rc);
1.1       kristaps  473: }
                    474:
1.55      kristaps  475: static void
1.1       kristaps  476: version(void)
                    477: {
                    478:
1.180     schwarze  479:        printf("mandoc %s\n", VERSION);
1.105     kristaps  480:        exit((int)MANDOCLEVEL_OK);
1.1       kristaps  481: }
                    482:
1.55      kristaps  483: static void
1.180     schwarze  484: usage(enum argmode argmode)
1.1       kristaps  485: {
                    486:
1.180     schwarze  487:        switch (argmode) {
                    488:        case ARG_FILE:
1.190     schwarze  489:                fputs("usage: mandoc [-acfhklV] [-Ios=name] "
1.196     schwarze  490:                    "[-Kencoding] [-mformat] [-Ooption]\n"
                    491:                    "\t      [-Toutput] [-Wlevel] [file ...]\n", stderr);
1.180     schwarze  492:                break;
                    493:        case ARG_NAME:
1.208     schwarze  494:                fputs("usage: man [-acfhklVw] [-C file] [-I os=name] "
                    495:                    "[-K encoding] [-M path] [-m path]\n"
                    496:                    "\t   [-O option=value] [-S subsection] [-s section] "
                    497:                    "[-T output] [-W level]\n"
1.180     schwarze  498:                    "\t   [section] name ...\n", stderr);
                    499:                break;
                    500:        case ARG_WORD:
1.190     schwarze  501:                fputs("usage: whatis [-acfhklVw] [-C file] "
1.188     schwarze  502:                    "[-M path] [-m path] [-O outkey] [-S arch]\n"
                    503:                    "\t      [-s section] name ...\n", stderr);
1.180     schwarze  504:                break;
                    505:        case ARG_EXPR:
1.190     schwarze  506:                fputs("usage: apropos [-acfhklVw] [-C file] "
1.188     schwarze  507:                    "[-M path] [-m path] [-O outkey] [-S arch]\n"
1.180     schwarze  508:                    "\t       [-s section] expression ...\n", stderr);
                    509:                break;
                    510:        }
1.105     kristaps  511:        exit((int)MANDOCLEVEL_BADARG);
1.68      joerg     512: }
                    513:
1.64      kristaps  514: static void
1.173     schwarze  515: parse(struct curparse *curp, int fd, const char *file,
                    516:        enum mandoclevel *level)
1.1       kristaps  517: {
1.154     kristaps  518:        enum mandoclevel  rc;
                    519:        struct mdoc      *mdoc;
                    520:        struct man       *man;
1.112     kristaps  521:
1.154     kristaps  522:        /* Begin by parsing the file itself. */
1.112     kristaps  523:
1.154     kristaps  524:        assert(file);
                    525:        assert(fd >= -1);
1.112     kristaps  526:
1.154     kristaps  527:        rc = mparse_readfd(curp->mp, fd, file);
1.112     kristaps  528:
1.154     kristaps  529:        /* Stop immediately if the parse has failed. */
1.92      kristaps  530:
1.154     kristaps  531:        if (MANDOCLEVEL_FATAL <= rc)
1.111     kristaps  532:                goto cleanup;
                    533:
1.1       kristaps  534:        /*
1.154     kristaps  535:         * With -Wstop and warnings or errors of at least the requested
                    536:         * level, do not produce output.
1.1       kristaps  537:         */
                    538:
1.154     kristaps  539:        if (MANDOCLEVEL_OK != rc && curp->wstop)
1.111     kristaps  540:                goto cleanup;
                    541:
                    542:        /* If unset, allocate output dev now (if applicable). */
                    543:
                    544:        if ( ! (curp->outman && curp->outmdoc)) {
                    545:                switch (curp->outtype) {
1.173     schwarze  546:                case OUTT_HTML:
1.195     schwarze  547:                        curp->outdata = html_alloc(curp->mchars,
                    548:                            curp->outopts);
1.162     kristaps  549:                        curp->outfree = html_free;
                    550:                        break;
1.173     schwarze  551:                case OUTT_UTF8:
1.195     schwarze  552:                        curp->outdata = utf8_alloc(curp->mchars,
                    553:                            curp->outopts);
1.163     kristaps  554:                        curp->outfree = ascii_free;
                    555:                        break;
1.173     schwarze  556:                case OUTT_LOCALE:
1.195     schwarze  557:                        curp->outdata = locale_alloc(curp->mchars,
                    558:                            curp->outopts);
1.162     kristaps  559:                        curp->outfree = ascii_free;
1.111     kristaps  560:                        break;
1.173     schwarze  561:                case OUTT_ASCII:
1.195     schwarze  562:                        curp->outdata = ascii_alloc(curp->mchars,
                    563:                            curp->outopts);
1.111     kristaps  564:                        curp->outfree = ascii_free;
                    565:                        break;
1.173     schwarze  566:                case OUTT_PDF:
1.195     schwarze  567:                        curp->outdata = pdf_alloc(curp->mchars,
                    568:                            curp->outopts);
1.111     kristaps  569:                        curp->outfree = pspdf_free;
                    570:                        break;
1.173     schwarze  571:                case OUTT_PS:
1.195     schwarze  572:                        curp->outdata = ps_alloc(curp->mchars,
                    573:                            curp->outopts);
1.111     kristaps  574:                        curp->outfree = pspdf_free;
                    575:                        break;
                    576:                default:
                    577:                        break;
                    578:                }
                    579:
                    580:                switch (curp->outtype) {
1.173     schwarze  581:                case OUTT_HTML:
1.111     kristaps  582:                        curp->outman = html_man;
                    583:                        curp->outmdoc = html_mdoc;
                    584:                        break;
1.173     schwarze  585:                case OUTT_TREE:
1.111     kristaps  586:                        curp->outman = tree_man;
                    587:                        curp->outmdoc = tree_mdoc;
                    588:                        break;
1.173     schwarze  589:                case OUTT_MAN:
1.164     schwarze  590:                        curp->outmdoc = man_mdoc;
1.165     kristaps  591:                        curp->outman = man_man;
1.164     schwarze  592:                        break;
1.173     schwarze  593:                case OUTT_PDF:
1.111     kristaps  594:                        /* FALLTHROUGH */
1.173     schwarze  595:                case OUTT_ASCII:
1.111     kristaps  596:                        /* FALLTHROUGH */
1.173     schwarze  597:                case OUTT_UTF8:
1.163     kristaps  598:                        /* FALLTHROUGH */
1.173     schwarze  599:                case OUTT_LOCALE:
1.162     kristaps  600:                        /* FALLTHROUGH */
1.173     schwarze  601:                case OUTT_PS:
1.111     kristaps  602:                        curp->outman = terminal_man;
                    603:                        curp->outmdoc = terminal_mdoc;
                    604:                        break;
                    605:                default:
                    606:                        break;
                    607:                }
                    608:        }
                    609:
1.171     schwarze  610:        mparse_result(curp->mp, &mdoc, &man, NULL);
1.154     kristaps  611:
1.111     kristaps  612:        /* Execute the out device, if it exists. */
                    613:
1.154     kristaps  614:        if (man && curp->outman)
                    615:                (*curp->outman)(curp->outdata, man);
                    616:        if (mdoc && curp->outmdoc)
                    617:                (*curp->outmdoc)(curp->outdata, mdoc);
1.111     kristaps  618:
                    619:  cleanup:
1.112     kristaps  620:
1.154     kristaps  621:        mparse_reset(curp->mp);
1.111     kristaps  622:
1.154     kristaps  623:        if (*level < rc)
                    624:                *level = rc;
1.186     schwarze  625: }
                    626:
1.205     schwarze  627: #if HAVE_SQLITE3
1.186     schwarze  628: static enum mandoclevel
1.197     schwarze  629: passthrough(const char *file, int fd, int synopsis_only)
1.186     schwarze  630: {
1.197     schwarze  631:        const char       synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
                    632:        const char       synr[] = "SYNOPSIS";
                    633:
                    634:        FILE            *stream;
1.186     schwarze  635:        const char      *syscall;
1.197     schwarze  636:        char            *line;
                    637:        size_t           len, off;
                    638:        ssize_t          nw;
                    639:        int              print;
1.210     schwarze  640:
                    641:        fflush(stdout);
1.197     schwarze  642:
                    643:        if ((stream = fdopen(fd, "r")) == NULL) {
                    644:                close(fd);
                    645:                syscall = "fdopen";
                    646:                goto fail;
                    647:        }
1.186     schwarze  648:
1.197     schwarze  649:        print = 0;
                    650:        while ((line = fgetln(stream, &len)) != NULL) {
                    651:                if (synopsis_only) {
                    652:                        if (print) {
                    653:                                if ( ! isspace((unsigned char)*line))
                    654:                                        goto done;
                    655:                                while (len &&
                    656:                                    isspace((unsigned char)*line)) {
                    657:                                        line++;
                    658:                                        len--;
                    659:                                }
                    660:                        } else {
                    661:                                if ((len == sizeof(synb) &&
                    662:                                     ! strncmp(line, synb, len - 1)) ||
                    663:                                    (len == sizeof(synr) &&
                    664:                                     ! strncmp(line, synr, len - 1)))
                    665:                                        print = 1;
                    666:                                continue;
                    667:                        }
                    668:                }
                    669:                for (off = 0; off < len; off += nw)
                    670:                        if ((nw = write(STDOUT_FILENO, line + off,
                    671:                            len - off)) == -1 || nw == 0) {
                    672:                                fclose(stream);
1.186     schwarze  673:                                syscall = "write";
                    674:                                goto fail;
                    675:                        }
1.197     schwarze  676:        }
1.186     schwarze  677:
1.197     schwarze  678:        if (ferror(stream)) {
                    679:                fclose(stream);
                    680:                syscall = "fgetln";
                    681:                goto fail;
                    682:        }
1.193     schwarze  683:
1.197     schwarze  684: done:
                    685:        fclose(stream);
                    686:        return(MANDOCLEVEL_OK);
1.186     schwarze  687:
                    688: fail:
                    689:        fprintf(stderr, "%s: %s: SYSERR: %s: %s",
                    690:            progname, file, syscall, strerror(errno));
                    691:        return(MANDOCLEVEL_SYSERR);
1.194     schwarze  692: }
1.205     schwarze  693: #endif
1.194     schwarze  694:
                    695: static int
                    696: koptions(int *options, char *arg)
                    697: {
                    698:
                    699:        if ( ! strcmp(arg, "utf-8")) {
                    700:                *options |=  MPARSE_UTF8;
                    701:                *options &= ~MPARSE_LATIN1;
                    702:        } else if ( ! strcmp(arg, "iso-8859-1")) {
                    703:                *options |=  MPARSE_LATIN1;
                    704:                *options &= ~MPARSE_UTF8;
                    705:        } else if ( ! strcmp(arg, "us-ascii")) {
                    706:                *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
                    707:        } else {
1.209     schwarze  708:                fprintf(stderr, "%s: -K %s: Bad argument\n",
1.194     schwarze  709:                    progname, arg);
                    710:                return(0);
                    711:        }
                    712:        return(1);
1.10      kristaps  713: }
                    714:
                    715: static int
1.170     schwarze  716: moptions(int *options, char *arg)
1.10      kristaps  717: {
                    718:
1.180     schwarze  719:        if (arg == NULL)
                    720:                /* nothing to do */;
                    721:        else if (0 == strcmp(arg, "doc"))
1.170     schwarze  722:                *options |= MPARSE_MDOC;
1.19      kristaps  723:        else if (0 == strcmp(arg, "andoc"))
1.170     schwarze  724:                /* nothing to do */;
1.17      kristaps  725:        else if (0 == strcmp(arg, "an"))
1.170     schwarze  726:                *options |= MPARSE_MAN;
1.10      kristaps  727:        else {
1.209     schwarze  728:                fprintf(stderr, "%s: -m %s: Bad argument\n",
1.176     schwarze  729:                    progname, arg);
1.10      kristaps  730:                return(0);
                    731:        }
                    732:
                    733:        return(1);
1.1       kristaps  734: }
                    735:
                    736: static int
1.60      kristaps  737: toptions(struct curparse *curp, char *arg)
1.1       kristaps  738: {
                    739:
                    740:        if (0 == strcmp(arg, "ascii"))
1.60      kristaps  741:                curp->outtype = OUTT_ASCII;
                    742:        else if (0 == strcmp(arg, "lint")) {
                    743:                curp->outtype = OUTT_LINT;
1.103     schwarze  744:                curp->wlevel  = MANDOCLEVEL_WARNING;
1.154     kristaps  745:        } else if (0 == strcmp(arg, "tree"))
1.60      kristaps  746:                curp->outtype = OUTT_TREE;
1.164     schwarze  747:        else if (0 == strcmp(arg, "man"))
                    748:                curp->outtype = OUTT_MAN;
1.43      kristaps  749:        else if (0 == strcmp(arg, "html"))
1.60      kristaps  750:                curp->outtype = OUTT_HTML;
1.163     kristaps  751:        else if (0 == strcmp(arg, "utf8"))
                    752:                curp->outtype = OUTT_UTF8;
1.162     kristaps  753:        else if (0 == strcmp(arg, "locale"))
                    754:                curp->outtype = OUTT_LOCALE;
1.59      kristaps  755:        else if (0 == strcmp(arg, "xhtml"))
1.195     schwarze  756:                curp->outtype = OUTT_HTML;
1.85      kristaps  757:        else if (0 == strcmp(arg, "ps"))
                    758:                curp->outtype = OUTT_PS;
1.100     kristaps  759:        else if (0 == strcmp(arg, "pdf"))
                    760:                curp->outtype = OUTT_PDF;
1.1       kristaps  761:        else {
1.209     schwarze  762:                fprintf(stderr, "%s: -T %s: Bad argument\n",
1.176     schwarze  763:                    progname, arg);
1.1       kristaps  764:                return(0);
                    765:        }
                    766:
                    767:        return(1);
                    768: }
                    769:
                    770: static int
1.103     schwarze  771: woptions(struct curparse *curp, char *arg)
1.1       kristaps  772: {
1.34      kristaps  773:        char            *v, *o;
1.173     schwarze  774:        const char      *toks[6];
1.1       kristaps  775:
1.103     schwarze  776:        toks[0] = "stop";
                    777:        toks[1] = "all";
                    778:        toks[2] = "warning";
                    779:        toks[3] = "error";
                    780:        toks[4] = "fatal";
                    781:        toks[5] = NULL;
1.1       kristaps  782:
1.34      kristaps  783:        while (*arg) {
                    784:                o = arg;
1.45      kristaps  785:                switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.173     schwarze  786:                case 0:
1.103     schwarze  787:                        curp->wstop = 1;
1.1       kristaps  788:                        break;
1.173     schwarze  789:                case 1:
1.103     schwarze  790:                        /* FALLTHROUGH */
1.173     schwarze  791:                case 2:
1.103     schwarze  792:                        curp->wlevel = MANDOCLEVEL_WARNING;
1.1       kristaps  793:                        break;
1.173     schwarze  794:                case 3:
1.103     schwarze  795:                        curp->wlevel = MANDOCLEVEL_ERROR;
1.24      kristaps  796:                        break;
1.173     schwarze  797:                case 4:
1.103     schwarze  798:                        curp->wlevel = MANDOCLEVEL_FATAL;
1.50      kristaps  799:                        break;
1.1       kristaps  800:                default:
1.209     schwarze  801:                        fprintf(stderr, "%s: -W %s: Bad argument\n",
1.176     schwarze  802:                            progname, o);
1.1       kristaps  803:                        return(0);
                    804:                }
1.34      kristaps  805:        }
1.1       kristaps  806:
                    807:        return(1);
                    808: }
                    809:
1.153     kristaps  810: static void
1.173     schwarze  811: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.155     kristaps  812:                const char *file, int line, int col, const char *msg)
1.71      kristaps  813: {
1.177     schwarze  814:        const char      *mparse_msg;
1.103     schwarze  815:
1.175     schwarze  816:        fprintf(stderr, "%s: %s:", progname, file);
                    817:
                    818:        if (line)
                    819:                fprintf(stderr, "%d:%d:", line, col + 1);
                    820:
1.177     schwarze  821:        fprintf(stderr, " %s", mparse_strlevel(lvl));
                    822:
                    823:        if (NULL != (mparse_msg = mparse_strerror(t)))
                    824:                fprintf(stderr, ": %s", mparse_msg);
1.154     kristaps  825:
1.73      kristaps  826:        if (msg)
                    827:                fprintf(stderr, ": %s", msg);
1.154     kristaps  828:
1.73      kristaps  829:        fputc('\n', stderr);
1.183     schwarze  830: }
                    831:
                    832: static void
                    833: spawn_pager(void)
                    834: {
1.184     schwarze  835: #define MAX_PAGER_ARGS 16
                    836:        char            *argv[MAX_PAGER_ARGS];
                    837:        const char      *pager;
                    838:        char            *cp;
                    839:        int              fildes[2];
                    840:        int              argc;
1.183     schwarze  841:
                    842:        if (pipe(fildes) == -1) {
                    843:                fprintf(stderr, "%s: pipe: %s\n",
                    844:                    progname, strerror(errno));
                    845:                return;
                    846:        }
                    847:
                    848:        switch (fork()) {
                    849:        case -1:
                    850:                fprintf(stderr, "%s: fork: %s\n",
                    851:                    progname, strerror(errno));
                    852:                exit((int)MANDOCLEVEL_SYSERR);
                    853:        case 0:
                    854:                close(fildes[0]);
                    855:                if (dup2(fildes[1], STDOUT_FILENO) == -1) {
                    856:                        fprintf(stderr, "%s: dup output: %s\n",
                    857:                            progname, strerror(errno));
                    858:                        exit((int)MANDOCLEVEL_SYSERR);
                    859:                }
                    860:                return;
                    861:        default:
1.184     schwarze  862:                break;
                    863:        }
                    864:
                    865:        /* The original process becomes the pager. */
                    866:
                    867:        close(fildes[1]);
                    868:        if (dup2(fildes[0], STDIN_FILENO) == -1) {
                    869:                fprintf(stderr, "%s: dup input: %s\n",
                    870:                    progname, strerror(errno));
1.183     schwarze  871:                exit((int)MANDOCLEVEL_SYSERR);
                    872:        }
1.184     schwarze  873:
                    874:        pager = getenv("MANPAGER");
                    875:        if (pager == NULL || *pager == '\0')
                    876:                pager = getenv("PAGER");
                    877:        if (pager == NULL || *pager == '\0')
                    878:                pager = "/usr/bin/more -s";
                    879:        cp = mandoc_strdup(pager);
                    880:
                    881:        /*
                    882:         * Parse the pager command into words.
                    883:         * Intentionally do not do anything fancy here.
                    884:         */
                    885:
                    886:        argc = 0;
                    887:        while (argc + 1 < MAX_PAGER_ARGS) {
                    888:                argv[argc++] = cp;
                    889:                cp = strchr(cp, ' ');
                    890:                if (cp == NULL)
                    891:                        break;
                    892:                *cp++ = '\0';
                    893:                while (*cp == ' ')
                    894:                        cp++;
                    895:                if (*cp == '\0')
                    896:                        break;
                    897:        }
                    898:        argv[argc] = NULL;
                    899:
                    900:        /* Hand over to the pager. */
                    901:
                    902:        execvp(argv[0], argv);
                    903:        fprintf(stderr, "%s: exec: %s\n",
                    904:            progname, strerror(errno));
                    905:        exit((int)MANDOCLEVEL_SYSERR);
1.71      kristaps  906: }

CVSweb