main.c revision 260e9a87725c090ba5835b1f9f0b62fa2f96036f
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov/* $Id: main.c,v 1.225 2015/03/10 13:50:03 schwarze Exp $ */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * Copyright (c) 2010-2012, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Permission to use, copy, modify, and distribute this software for any
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * purpose with or without fee is hereby granted, provided that the above
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * copyright notice and this permission notice appear in all copies.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore# if !defined(lint)
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore#endif /* !defined(__GNUC__) || (__GNUC__ < 2) */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amoretypedef void (*out_mdoc)(void *, const struct mdoc *);
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amoretypedef void (*out_man)(void *, const struct man *);
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amoretypedef void (*out_free)(void *);
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore enum mandoclevel wlevel; /* ignore messages below this */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore int wstop; /* stop after a file with a warning */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore char outopts[BUFSIZ]; /* buf of output opts */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov const char *, const char *,
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov const struct manpaths *, int, char**,
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankovstatic int koptions(int *, char *);
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankovint mandocdb(int, char**);
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankovstatic int moptions(int *, char *);
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amorestatic void mmsg(enum mandocerr, enum mandoclevel,
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore const char *, int, int, const char *);
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore const char *, enum mandoclevel *);
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankovstatic enum mandoclevel passthrough(const char *, int, int);
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amorestatic int toptions(struct curparse *, char *);
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankovstatic void usage(enum argmode) __attribute__((noreturn));
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amorestatic int woptions(struct curparse *, char *);
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankovstatic const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amorestatic const char *progname;
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov unsigned char *uc;
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov pid_t pager_pid; /* 0: don't use; 1: not yet spawned. */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov else if ((progname = strrchr(argv[0], '/')) == NULL)
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* Search options. */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* Parser and formatter options. */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov (void)strlcat(curp.outopts, "synopsis,", BUFSIZ);
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov "%s: -I %s: Bad argument\n",
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov "%s: -I %s: Duplicate argument\n",
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore (void)strlcat(curp.outopts, optarg, BUFSIZ);
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* Postprocess options. */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* Parse arguments. */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * Quirks for help(1)
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * and for a man(1) section argument without -s.
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* man(1), whatis(1), apropos(1) */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* Access the mandoc database. */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov manpath_parse(&paths, conf_file, defpaths, auxpaths);
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov if( ! mansearch(&search, &paths, argc, argv, &res, &sz))
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov fputs("mandoc: database support not compiled in\n",
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov fs_search(&search, &paths, argc, argv, &res, &sz);
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * For standard man(1) and -a output mode,
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * prepare for copying filename pointers
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * into the program parameter array.
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* Iterate all matching manuals. */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov for (i = 0; i < sz; i++) {
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* Search for the best section. */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * For man(1), -a and -i output mode, fall through
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * to the main mandoc(1) code iterating files
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * and running the parsers on each of them.
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* mandoc(1) */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths))
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov curp.mp = mparse_alloc(options, curp.wlevel, mmsg,
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Conditionally start up the lookaside buffer before parsing.
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov while (argc > 0) {
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* For .so only; ignore failure. */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * If a pager is attached, flush the pipe leading to it
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * and signal end of file such that the user can browse
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * to the end. Then wait for the user to close the pager.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore return((int)rc);
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov "[-Kencoding] [-mformat] [-Ooption]\n"
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov "\t [-Toutput] [-Wlevel] [file ...]\n", stderr);
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov fputs("usage: man [-acfhklw] [-C file] [-I os=name] "
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov "[-K encoding] [-M path] [-m path]\n"
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov "\t [-O option=value] [-S subsection] [-s section] "
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov "[-T output] [-W level]\n"
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov "[-M path] [-m path] [-O outkey] [-S arch]\n"
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov "[-M path] [-m path] [-O outkey] [-S arch]\n"
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankovfs_lookup(const struct manpaths *paths, size_t ipath,
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov const char *sec, const char *arch, const char *name,
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov fprintf(stderr, "%s: outdated mandoc.db lacks %s(%s) entry,\n"
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov " consider running # makewhatis %s\n",
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankovfs_search(const struct mansearch *cfg, const struct manpaths *paths,
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov int argc, char **argv, struct manpage **res, size_t *ressz)
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov const char *const sections[] =
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov {"1", "8", "6", "2", "3", "3p", "5", "7", "4", "9"};
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov const size_t nsec = sizeof(sections)/sizeof(sections[0]);
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov "%s: No entry for %s in the manual.\n",
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankovparse(struct curparse *curp, int fd, const char *file,
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore /* Begin by parsing the file itself. */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * With -Wstop and warnings or errors of at least the requested
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * level, do not produce output.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore /* If unset, allocate output dev now (if applicable). */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore /* FALLTHROUGH */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore /* FALLTHROUGH */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore /* FALLTHROUGH */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore /* FALLTHROUGH */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore /* Execute the out device, if it exists. */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankovpassthrough(const char *file, int fd, int synopsis_only)
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* nothing to do */;
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* nothing to do */;
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore switch (getsubopt(&arg, UNCONST(toks), &v)) {
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore /* FALLTHROUGH */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore const char *file, int line, int col, const char *msg)
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov const char *pager;
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* The child process becomes the pager. */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * Parse the pager command into words.
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * Intentionally do not do anything fancy here.
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* Hand over to the pager. */