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

Annotation of mandoc/main.c, Revision 1.249

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

CVSweb