| version 1.33, 2009/07/04 09:01:55 |
version 1.361, 2022/04/14 16:43:43 |
|
|
| /* $Id$ */ |
/* $Id$ */ |
| /* |
/* |
| * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se> |
* Copyright (c) 2010-2012, 2014-2021 Ingo Schwarze <schwarze@openbsd.org> |
| |
* Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv> |
| |
* Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org> |
| * |
* |
| * Permission to use, copy, modify, and distribute this software for any |
* Permission to use, copy, modify, and distribute this software for any |
| * purpose with or without fee is hereby granted, provided that the above |
* purpose with or without fee is hereby granted, provided that the above |
| * copyright notice and this permission notice appear in all copies. |
* copyright notice and this permission notice appear in all copies. |
| * |
* |
| * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES |
| * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
| * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR |
| * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
| * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
| * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
| * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| |
* |
| |
* Main program for mandoc(1), man(1), apropos(1), whatis(1), and help(1). |
| */ |
*/ |
| |
#include "config.h" |
| |
|
| |
#include <sys/types.h> |
| |
#include <sys/ioctl.h> |
| |
#include <sys/param.h> /* MACHINE */ |
| #include <sys/stat.h> |
#include <sys/stat.h> |
| |
#include <sys/wait.h> |
| |
|
| #include <assert.h> |
#include <assert.h> |
| |
#include <ctype.h> |
| |
#if HAVE_ERR |
| #include <err.h> |
#include <err.h> |
| |
#endif |
| |
#include <errno.h> |
| #include <fcntl.h> |
#include <fcntl.h> |
| |
#include <glob.h> |
| |
#include <limits.h> |
| |
#if HAVE_SANDBOX_INIT |
| |
#include <sandbox.h> |
| |
#endif |
| |
#include <signal.h> |
| #include <stdio.h> |
#include <stdio.h> |
| |
#include <stdint.h> |
| #include <stdlib.h> |
#include <stdlib.h> |
| #include <string.h> |
#include <string.h> |
| |
#include <termios.h> |
| |
#include <time.h> |
| #include <unistd.h> |
#include <unistd.h> |
| |
|
| |
#include "mandoc_aux.h" |
| |
#include "mandoc.h" |
| |
#include "mandoc_xr.h" |
| |
#include "roff.h" |
| #include "mdoc.h" |
#include "mdoc.h" |
| #include "man.h" |
#include "man.h" |
| |
#include "mandoc_parse.h" |
| |
#include "tag.h" |
| |
#include "term_tag.h" |
| |
#include "main.h" |
| |
#include "manconf.h" |
| |
#include "mansearch.h" |
| |
|
| /* Account for FreeBSD and Linux in our declarations. */ |
enum outmode { |
| |
OUTMODE_DEF = 0, |
| #ifdef __linux__ |
OUTMODE_FLN, |
| extern int getsubopt(char **, char * const *, char **); |
OUTMODE_LST, |
| # ifndef __dead |
OUTMODE_ALL, |
| # define __dead __attribute__((__noreturn__)) |
OUTMODE_ONE |
| # endif |
|
| #elif defined(__dead2) |
|
| # ifndef __dead |
|
| # define __dead __dead2 |
|
| # endif |
|
| #endif |
|
| |
|
| typedef int (*out_mdoc)(void *, const struct mdoc *); |
|
| typedef int (*out_man)(void *, const struct man *); |
|
| typedef void (*out_free)(void *); |
|
| |
|
| struct buf { |
|
| char *buf; |
|
| size_t sz; |
|
| }; |
}; |
| |
|
| enum intt { |
|
| INTT_AUTO, |
|
| INTT_MDOC, |
|
| INTT_MAN |
|
| }; |
|
| |
|
| enum outt { |
enum outt { |
| OUTT_ASCII = 0, |
OUTT_ASCII = 0, /* -Tascii */ |
| OUTT_TREE, |
OUTT_LOCALE, /* -Tlocale */ |
| OUTT_LINT |
OUTT_UTF8, /* -Tutf8 */ |
| |
OUTT_TREE, /* -Ttree */ |
| |
OUTT_MAN, /* -Tman */ |
| |
OUTT_HTML, /* -Thtml */ |
| |
OUTT_MARKDOWN, /* -Tmarkdown */ |
| |
OUTT_LINT, /* -Tlint */ |
| |
OUTT_PS, /* -Tps */ |
| |
OUTT_PDF /* -Tpdf */ |
| }; |
}; |
| |
|
| struct curparse { |
struct outstate { |
| const char *file; /* Current parse. */ |
struct tag_files *tag_files; /* Tagging state variables. */ |
| int fd; /* Current parse. */ |
void *outdata; /* data for output */ |
| int wflags; |
int use_pager; |
| #define WARN_WALL 0x03 /* All-warnings mask. */ |
int wstop; /* stop after a file with a warning */ |
| #define WARN_WCOMPAT (1 << 0) /* Compatibility warnings. */ |
int had_output; /* Some output was generated. */ |
| #define WARN_WSYNTAX (1 << 1) /* Syntax warnings. */ |
enum outt outtype; /* which output to use */ |
| #define WARN_WERR (1 << 2) /* Warnings->errors. */ |
|
| int fflags; |
|
| #define IGN_SCOPE (1 << 0) /* Ignore scope errors. */ |
|
| #define NO_IGN_ESCAPE (1 << 1) /* Don't ignore bad escapes. */ |
|
| #define NO_IGN_MACRO (1 << 2) /* Don't ignore bad macros. */ |
|
| #define NO_IGN_CHARS (1 << 3) /* Don't ignore bad chars. */ |
|
| enum intt inttype; /* Input parsers... */ |
|
| struct man *man; |
|
| struct man *lastman; |
|
| struct mdoc *mdoc; |
|
| struct mdoc *lastmdoc; |
|
| enum outt outtype; /* Output devices... */ |
|
| out_mdoc outmdoc; |
|
| out_man outman; |
|
| out_free outfree; |
|
| void *outdata; |
|
| }; |
}; |
| |
|
| extern void *ascii_alloc(void); |
|
| extern int tree_mdoc(void *, const struct mdoc *); |
|
| extern int tree_man(void *, const struct man *); |
|
| extern int terminal_mdoc(void *, const struct mdoc *); |
|
| extern int terminal_man(void *, const struct man *); |
|
| extern void terminal_free(void *); |
|
| |
|
| static int foptions(int *, char *); |
int mandocdb(int, char *[]); |
| static int toptions(enum outt *, char *); |
|
| static int moptions(enum intt *, char *); |
|
| static int woptions(int *, char *); |
|
| static int merr(void *, int, int, const char *); |
|
| static int manwarn(void *, int, int, const char *); |
|
| static int mdocwarn(void *, int, int, |
|
| enum mdoc_warn, const char *); |
|
| static int ffile(struct buf *, struct buf *, |
|
| const char *, struct curparse *); |
|
| static int fdesc(struct buf *, struct buf *, |
|
| struct curparse *); |
|
| static int pset(const char *, int, struct curparse *, |
|
| struct man **, struct mdoc **); |
|
| static struct man *man_init(struct curparse *); |
|
| static struct mdoc *mdoc_init(struct curparse *); |
|
| __dead static void version(void); |
|
| __dead static void usage(void); |
|
| |
|
| extern char *__progname; |
static void check_xr(struct manpaths *); |
| |
static void fs_append(char **, size_t, int, |
| |
size_t, const char *, enum form, |
| |
struct manpage **, size_t *); |
| |
static int fs_lookup(const struct manpaths *, size_t, |
| |
const char *, const char *, const char *, |
| |
struct manpage **, size_t *); |
| |
static int fs_search(const struct mansearch *, |
| |
const struct manpaths *, const char *, |
| |
struct manpage **, size_t *); |
| |
static void glob_esc(char **, const char *, const char *); |
| |
static void outdata_alloc(struct outstate *, struct manoutput *); |
| |
static void parse(struct mparse *, int, const char *, |
| |
struct outstate *, struct manconf *); |
| |
static void passthrough(int, int); |
| |
static void process_onefile(struct mparse *, struct manpage *, |
| |
int, struct outstate *, struct manconf *); |
| |
static void run_pager(struct outstate *, char *); |
| |
static pid_t spawn_pager(struct outstate *, char *); |
| |
static void usage(enum argmode) __attribute__((__noreturn__)); |
| |
static int woptions(char *, enum mandoc_os *, int *); |
| |
|
| |
static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9}; |
| |
static char help_arg[] = "help"; |
| |
static char *help_argv[] = {help_arg, NULL}; |
| |
|
| |
|
| int |
int |
| main(int argc, char *argv[]) |
main(int argc, char *argv[]) |
| { |
{ |
| int c, rc; |
struct manconf conf; /* Manpaths and output options. */ |
| struct buf ln, blk; |
struct outstate outst; /* Output state. */ |
| struct curparse curp; |
struct winsize ws; /* Result of ioctl(TIOCGWINSZ). */ |
| |
struct mansearch search; /* Search options. */ |
| |
struct manpage *res; /* Complete list of search results. */ |
| |
struct manpage *resn; /* Search results for one name. */ |
| |
struct mparse *mp; /* Opaque parser object. */ |
| |
const char *conf_file; /* -C: alternate config file. */ |
| |
const char *os_s; /* -I: Operating system for display. */ |
| |
const char *progname, *sec, *ep; |
| |
char *defpaths; /* -M: override manpaths. */ |
| |
char *auxpaths; /* -m: additional manpaths. */ |
| |
char *oarg; /* -O: output option string. */ |
| |
char *tagarg; /* -O tag: default value. */ |
| |
unsigned char *uc; |
| |
size_t ressz; /* Number of elements in res[]. */ |
| |
size_t resnsz; /* Number of elements in resn[]. */ |
| |
size_t i, ib, ssz; |
| |
int options; /* Parser options. */ |
| |
int show_usage; /* Invalid argument: give up. */ |
| |
int prio, best_prio; |
| |
int startdir; |
| |
int c; |
| |
enum mandoc_os os_e; /* Check base system conventions. */ |
| |
enum outmode outmode; /* According to command line. */ |
| |
|
| bzero(&curp, sizeof(struct curparse)); |
#if DEBUG_MEMORY |
| |
mandoc_dbg_init(argc, argv); |
| |
#endif |
| |
#if HAVE_PROGNAME |
| |
progname = getprogname(); |
| |
#else |
| |
if (argc < 1) |
| |
progname = "mandoc"; |
| |
else if ((progname = strrchr(argv[0], '/')) == NULL) |
| |
progname = argv[0]; |
| |
else |
| |
++progname; |
| |
setprogname(progname); |
| |
#endif |
| |
|
| curp.inttype = INTT_AUTO; |
mandoc_msg_setoutfile(stderr); |
| curp.outtype = OUTT_ASCII; |
if (strncmp(progname, "mandocdb", 8) == 0 || |
| |
strcmp(progname, BINM_MAKEWHATIS) == 0) |
| |
return mandocdb(argc, argv); |
| |
|
| /* LINTED */ |
#if HAVE_PLEDGE |
| while (-1 != (c = getopt(argc, argv, "f:m:VW:T:"))) |
if (pledge("stdio rpath wpath cpath tmppath tty proc exec", NULL) == -1) { |
| |
mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno)); |
| |
return mandoc_msg_getrc(); |
| |
} |
| |
#endif |
| |
#if HAVE_SANDBOX_INIT |
| |
if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1) |
| |
errx((int)MANDOCLEVEL_SYSERR, "sandbox_init"); |
| |
#endif |
| |
|
| |
/* Search options. */ |
| |
|
| |
memset(&conf, 0, sizeof(conf)); |
| |
conf_file = NULL; |
| |
defpaths = auxpaths = NULL; |
| |
|
| |
memset(&search, 0, sizeof(struct mansearch)); |
| |
search.outkey = "Nd"; |
| |
oarg = NULL; |
| |
|
| |
if (strcmp(progname, BINM_MAN) == 0) |
| |
search.argmode = ARG_NAME; |
| |
else if (strcmp(progname, BINM_APROPOS) == 0) |
| |
search.argmode = ARG_EXPR; |
| |
else if (strcmp(progname, BINM_WHATIS) == 0) |
| |
search.argmode = ARG_WORD; |
| |
else if (strncmp(progname, "help", 4) == 0) |
| |
search.argmode = ARG_NAME; |
| |
else |
| |
search.argmode = ARG_FILE; |
| |
|
| |
/* Parser options. */ |
| |
|
| |
options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1; |
| |
os_e = MANDOC_OS_OTHER; |
| |
os_s = NULL; |
| |
|
| |
/* Formatter options. */ |
| |
|
| |
memset(&outst, 0, sizeof(outst)); |
| |
outst.tag_files = NULL; |
| |
outst.outtype = OUTT_LOCALE; |
| |
outst.use_pager = 1; |
| |
|
| |
show_usage = 0; |
| |
outmode = OUTMODE_DEF; |
| |
|
| |
while ((c = getopt(argc, argv, |
| |
"aC:cfhI:iK:klM:m:O:S:s:T:VW:w")) != -1) { |
| |
if (c == 'i' && search.argmode == ARG_EXPR) { |
| |
optind--; |
| |
break; |
| |
} |
| switch (c) { |
switch (c) { |
| case ('f'): |
case 'a': |
| if ( ! foptions(&curp.fflags, optarg)) |
outmode = OUTMODE_ALL; |
| return(EXIT_FAILURE); |
|
| break; |
break; |
| case ('m'): |
case 'C': |
| if ( ! moptions(&curp.inttype, optarg)) |
conf_file = optarg; |
| return(EXIT_FAILURE); |
|
| break; |
break; |
| case ('T'): |
case 'c': |
| if ( ! toptions(&curp.outtype, optarg)) |
outst.use_pager = 0; |
| return(EXIT_FAILURE); |
|
| break; |
break; |
| case ('W'): |
case 'f': |
| if ( ! woptions(&curp.wflags, optarg)) |
search.argmode = ARG_WORD; |
| return(EXIT_FAILURE); |
|
| break; |
break; |
| case ('V'): |
case 'h': |
| version(); |
conf.output.synopsisonly = 1; |
| /* NOTREACHED */ |
outst.use_pager = 0; |
| |
outmode = OUTMODE_ALL; |
| |
break; |
| |
case 'I': |
| |
if (strncmp(optarg, "os=", 3) != 0) { |
| |
mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, |
| |
"-I %s", optarg); |
| |
return mandoc_msg_getrc(); |
| |
} |
| |
if (os_s != NULL) { |
| |
mandoc_msg(MANDOCERR_BADARG_DUPE, 0, 0, |
| |
"-I %s", optarg); |
| |
return mandoc_msg_getrc(); |
| |
} |
| |
os_s = optarg + 3; |
| |
break; |
| |
case 'K': |
| |
options &= ~(MPARSE_UTF8 | MPARSE_LATIN1); |
| |
if (strcmp(optarg, "utf-8") == 0) |
| |
options |= MPARSE_UTF8; |
| |
else if (strcmp(optarg, "iso-8859-1") == 0) |
| |
options |= MPARSE_LATIN1; |
| |
else if (strcmp(optarg, "us-ascii") != 0) { |
| |
mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, |
| |
"-K %s", optarg); |
| |
return mandoc_msg_getrc(); |
| |
} |
| |
break; |
| |
case 'k': |
| |
search.argmode = ARG_EXPR; |
| |
break; |
| |
case 'l': |
| |
search.argmode = ARG_FILE; |
| |
outmode = OUTMODE_ALL; |
| |
break; |
| |
case 'M': |
| |
defpaths = optarg; |
| |
break; |
| |
case 'm': |
| |
auxpaths = optarg; |
| |
break; |
| |
case 'O': |
| |
oarg = optarg; |
| |
break; |
| |
case 'S': |
| |
search.arch = optarg; |
| |
break; |
| |
case 's': |
| |
search.sec = optarg; |
| |
break; |
| |
case 'T': |
| |
if (strcmp(optarg, "ascii") == 0) |
| |
outst.outtype = OUTT_ASCII; |
| |
else if (strcmp(optarg, "lint") == 0) { |
| |
outst.outtype = OUTT_LINT; |
| |
mandoc_msg_setoutfile(stdout); |
| |
mandoc_msg_setmin(MANDOCERR_BASE); |
| |
} else if (strcmp(optarg, "tree") == 0) |
| |
outst.outtype = OUTT_TREE; |
| |
else if (strcmp(optarg, "man") == 0) |
| |
outst.outtype = OUTT_MAN; |
| |
else if (strcmp(optarg, "html") == 0) |
| |
outst.outtype = OUTT_HTML; |
| |
else if (strcmp(optarg, "markdown") == 0) |
| |
outst.outtype = OUTT_MARKDOWN; |
| |
else if (strcmp(optarg, "utf8") == 0) |
| |
outst.outtype = OUTT_UTF8; |
| |
else if (strcmp(optarg, "locale") == 0) |
| |
outst.outtype = OUTT_LOCALE; |
| |
else if (strcmp(optarg, "ps") == 0) |
| |
outst.outtype = OUTT_PS; |
| |
else if (strcmp(optarg, "pdf") == 0) |
| |
outst.outtype = OUTT_PDF; |
| |
else { |
| |
mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, |
| |
"-T %s", optarg); |
| |
return mandoc_msg_getrc(); |
| |
} |
| |
break; |
| |
case 'W': |
| |
if (woptions(optarg, &os_e, &outst.wstop) == -1) |
| |
return mandoc_msg_getrc(); |
| |
break; |
| |
case 'w': |
| |
outmode = OUTMODE_FLN; |
| |
break; |
| default: |
default: |
| usage(); |
show_usage = 1; |
| /* NOTREACHED */ |
break; |
| } |
} |
| |
} |
| |
|
| argc -= optind; |
if (show_usage) |
| argv += optind; |
usage(search.argmode); |
| |
|
| bzero(&ln, sizeof(struct buf)); |
/* Postprocess options. */ |
| bzero(&blk, sizeof(struct buf)); |
|
| |
|
| rc = 1; |
switch (outmode) { |
| |
case OUTMODE_DEF: |
| if (NULL == *argv) { |
switch (search.argmode) { |
| curp.file = "<stdin>"; |
case ARG_FILE: |
| curp.fd = STDIN_FILENO; |
outmode = OUTMODE_ALL; |
| if ( ! fdesc(&blk, &ln, &curp)) |
outst.use_pager = 0; |
| rc = 0; |
break; |
| |
case ARG_NAME: |
| |
outmode = OUTMODE_ONE; |
| |
break; |
| |
default: |
| |
outmode = OUTMODE_LST; |
| |
break; |
| |
} |
| |
break; |
| |
case OUTMODE_FLN: |
| |
if (search.argmode == ARG_FILE) |
| |
outmode = OUTMODE_ALL; |
| |
break; |
| |
case OUTMODE_ALL: |
| |
break; |
| |
case OUTMODE_LST: |
| |
case OUTMODE_ONE: |
| |
abort(); |
| } |
} |
| |
|
| while (rc && *argv) { |
if (oarg != NULL) { |
| if ( ! ffile(&blk, &ln, *argv, &curp)) |
if (outmode == OUTMODE_LST) |
| rc = 0; |
search.outkey = oarg; |
| argv++; |
else { |
| if (*argv && rc) { |
while (oarg != NULL) { |
| if (curp.lastman) |
if (manconf_output(&conf.output, |
| if ( ! man_reset(curp.lastman)) |
strsep(&oarg, ","), 0) == -1) |
| rc = 0; |
return mandoc_msg_getrc(); |
| if (curp.lastmdoc) |
} |
| if ( ! mdoc_reset(curp.lastmdoc)) |
|
| rc = 0; |
|
| curp.lastman = NULL; |
|
| curp.lastmdoc = NULL; |
|
| } |
} |
| } |
} |
| |
|
| if (blk.buf) |
if (outst.outtype != OUTT_TREE || conf.output.noval == 0) |
| free(blk.buf); |
options |= MPARSE_VALIDATE; |
| if (ln.buf) |
|
| free(ln.buf); |
|
| if (curp.outfree) |
|
| (*curp.outfree)(curp.outdata); |
|
| if (curp.mdoc) |
|
| mdoc_free(curp.mdoc); |
|
| if (curp.man) |
|
| man_free(curp.man); |
|
| |
|
| return(rc ? EXIT_SUCCESS : EXIT_FAILURE); |
if (outmode == OUTMODE_FLN || |
| } |
outmode == OUTMODE_LST || |
| |
(conf.output.outfilename == NULL && |
| |
conf.output.tagfilename == NULL && |
| |
isatty(STDOUT_FILENO) == 0)) |
| |
outst.use_pager = 0; |
| |
|
| |
if (outst.use_pager && |
| |
(conf.output.width == 0 || conf.output.indent == 0) && |
| |
ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) != -1 && |
| |
ws.ws_col > 1) { |
| |
if (conf.output.width == 0 && ws.ws_col < 79) |
| |
conf.output.width = ws.ws_col - 1; |
| |
if (conf.output.indent == 0 && ws.ws_col < 66) |
| |
conf.output.indent = 3; |
| |
} |
| |
|
| __dead static void |
#if HAVE_PLEDGE |
| version(void) |
if (outst.use_pager == 0) |
| { |
c = pledge("stdio rpath", NULL); |
| |
else if (conf.output.outfilename != NULL || |
| |
conf.output.tagfilename != NULL) |
| |
c = pledge("stdio rpath wpath cpath", NULL); |
| |
else |
| |
c = pledge("stdio rpath tmppath tty proc exec", NULL); |
| |
if (c == -1) { |
| |
mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno)); |
| |
return mandoc_msg_getrc(); |
| |
} |
| |
#endif |
| |
|
| (void)printf("%s %s\n", __progname, VERSION); |
/* Parse arguments. */ |
| exit(EXIT_SUCCESS); |
|
| } |
|
| |
|
| |
if (argc > 0) { |
| |
argc -= optind; |
| |
argv += optind; |
| |
} |
| |
|
| __dead static void |
/* |
| usage(void) |
* Quirks for help(1) and man(1), |
| { |
* in particular for a section argument without -s. |
| |
*/ |
| |
|
| (void)fprintf(stderr, "usage: %s [-V] [-foption...] " |
if (search.argmode == ARG_NAME) { |
| "[-mformat] [-Toutput] [-Werr...]\n", |
if (*progname == 'h') { |
| __progname); |
if (argc == 0) { |
| exit(EXIT_FAILURE); |
argv = help_argv; |
| } |
argc = 1; |
| |
} |
| |
} else if (argc > 1 && |
| |
((uc = (unsigned char *)argv[0]) != NULL) && |
| |
((isdigit(uc[0]) && (uc[1] == '\0' || |
| |
isalpha(uc[1]))) || |
| |
(uc[0] == 'n' && uc[1] == '\0'))) { |
| |
search.sec = (char *)uc; |
| |
argv++; |
| |
argc--; |
| |
} |
| |
if (search.arch == NULL) |
| |
search.arch = getenv("MACHINE"); |
| |
#ifdef MACHINE |
| |
if (search.arch == NULL) |
| |
search.arch = MACHINE; |
| |
#endif |
| |
if (outmode == OUTMODE_ONE) |
| |
search.firstmatch = 1; |
| |
} |
| |
|
| |
/* |
| |
* Use the first argument for -O tag in addition to |
| |
* using it as a search term for man(1) or apropos(1). |
| |
*/ |
| |
|
| static struct man * |
if (conf.output.tag != NULL && *conf.output.tag == '\0') { |
| man_init(struct curparse *curp) |
tagarg = argc > 0 && search.argmode == ARG_EXPR ? |
| { |
strchr(*argv, '=') : NULL; |
| int pflags; |
conf.output.tag = tagarg == NULL ? *argv : tagarg + 1; |
| struct man *man; |
} |
| struct man_cb mancb; |
|
| |
|
| mancb.man_err = merr; |
/* Read the configuration file. */ |
| mancb.man_warn = manwarn; |
|
| |
|
| /* Defaults from mandoc.1. */ |
if (search.argmode != ARG_FILE || |
| |
mandoc_msg_getmin() == MANDOCERR_STYLE) |
| |
manconf_parse(&conf, conf_file, defpaths, auxpaths); |
| |
|
| pflags = MAN_IGN_MACRO | MAN_IGN_ESCAPE | MAN_IGN_CHARS; |
/* man(1): Resolve each name individually. */ |
| |
|
| if (curp->fflags & NO_IGN_MACRO) |
if (search.argmode == ARG_NAME) { |
| pflags &= ~MAN_IGN_MACRO; |
if (argc < 1) { |
| if (curp->fflags & NO_IGN_CHARS) |
if (outmode != OUTMODE_FLN) |
| pflags &= ~MAN_IGN_CHARS; |
usage(ARG_NAME); |
| if (curp->fflags & NO_IGN_ESCAPE) |
if (conf.manpath.sz == 0) { |
| pflags &= ~MAN_IGN_ESCAPE; |
warnx("The manpath is empty."); |
| |
mandoc_msg_setrc(MANDOCLEVEL_BADARG); |
| |
} else { |
| |
for (i = 0; i + 1 < conf.manpath.sz; i++) |
| |
printf("%s:", conf.manpath.paths[i]); |
| |
printf("%s\n", conf.manpath.paths[i]); |
| |
} |
| |
manconf_free(&conf); |
| |
return (int)mandoc_msg_getrc(); |
| |
} |
| |
for (res = NULL, ressz = 0; argc > 0; argc--, argv++) { |
| |
(void)mansearch(&search, &conf.manpath, |
| |
1, argv, &resn, &resnsz); |
| |
if (resnsz == 0) |
| |
(void)fs_search(&search, &conf.manpath, |
| |
*argv, &resn, &resnsz); |
| |
if (resnsz == 0 && strchr(*argv, '/') == NULL) { |
| |
if (search.arch != NULL && |
| |
arch_valid(search.arch, OSENUM) == 0) |
| |
warnx("Unknown architecture \"%s\".", |
| |
search.arch); |
| |
else if (search.sec != NULL) |
| |
warnx("No entry for %s in " |
| |
"section %s of the manual.", |
| |
*argv, search.sec); |
| |
else |
| |
warnx("No entry for %s in " |
| |
"the manual.", *argv); |
| |
mandoc_msg_setrc(MANDOCLEVEL_BADARG); |
| |
continue; |
| |
} |
| |
if (resnsz == 0) { |
| |
if (access(*argv, R_OK) == -1) { |
| |
mandoc_msg_setinfilename(*argv); |
| |
mandoc_msg(MANDOCERR_BADARG_BAD, |
| |
0, 0, "%s", strerror(errno)); |
| |
mandoc_msg_setinfilename(NULL); |
| |
continue; |
| |
} |
| |
resnsz = 1; |
| |
resn = mandoc_calloc(resnsz, sizeof(*res)); |
| |
resn->file = mandoc_strdup(*argv); |
| |
resn->ipath = SIZE_MAX; |
| |
resn->form = FORM_SRC; |
| |
} |
| |
if (outmode != OUTMODE_ONE || resnsz == 1) { |
| |
res = mandoc_reallocarray(res, |
| |
ressz + resnsz, sizeof(*res)); |
| |
memcpy(res + ressz, resn, |
| |
sizeof(*resn) * resnsz); |
| |
ressz += resnsz; |
| |
free(resn); |
| |
resn = NULL; |
| |
resnsz = 0; |
| |
continue; |
| |
} |
| |
|
| if (NULL == (man = man_alloc(curp, pflags, &mancb))) |
/* Search for the best section. */ |
| warnx("memory exhausted"); |
|
| |
|
| return(man); |
best_prio = 40; |
| } |
for (ib = i = 0; i < resnsz; i++) { |
| |
sec = resn[i].file; |
| |
sec += strcspn(sec, "123456789"); |
| |
if (sec[0] == '\0') |
| |
continue; /* No section at all. */ |
| |
prio = sec_prios[sec[0] - '1']; |
| |
if (search.sec != NULL) { |
| |
ssz = strlen(search.sec); |
| |
if (strncmp(sec, search.sec, ssz) == 0) |
| |
sec += ssz; |
| |
} else |
| |
sec++; /* Prefer without suffix. */ |
| |
if (*sec != '/') |
| |
prio += 10; /* Wrong dir name. */ |
| |
if (search.sec != NULL) { |
| |
ep = strchr(sec, '\0'); |
| |
if (ep - sec > 3 && |
| |
strncmp(ep - 3, ".gz", 3) == 0) |
| |
ep -= 3; |
| |
if ((size_t)(ep - sec) < ssz + 3 || |
| |
strncmp(ep - ssz, search.sec, |
| |
ssz) != 0) /* Wrong file */ |
| |
prio += 20; /* extension. */ |
| |
} |
| |
if (prio >= best_prio) |
| |
continue; |
| |
best_prio = prio; |
| |
ib = i; |
| |
} |
| |
res = mandoc_reallocarray(res, ressz + 1, |
| |
sizeof(*res)); |
| |
memcpy(res + ressz++, resn + ib, sizeof(*resn)); |
| |
memset(resn + ib, 0, sizeof(*resn)); |
| |
mansearch_free(resn, resnsz); |
| |
resn = NULL; |
| |
resnsz = 0; |
| |
} |
| |
|
| |
/* apropos(1), whatis(1): Process the full search expression. */ |
| |
|
| static struct mdoc * |
} else if (search.argmode != ARG_FILE) { |
| mdoc_init(struct curparse *curp) |
if (mansearch(&search, &conf.manpath, |
| { |
argc, argv, &res, &ressz) == 0) |
| int pflags; |
usage(search.argmode); |
| struct mdoc *mdoc; |
|
| struct mdoc_cb mdoccb; |
|
| |
|
| mdoccb.mdoc_err = merr; |
if (ressz == 0) { |
| mdoccb.mdoc_warn = mdocwarn; |
warnx("nothing appropriate"); |
| |
mandoc_msg_setrc(MANDOCLEVEL_BADARG); |
| |
goto out; |
| |
} |
| |
|
| /* Defaults from mandoc.1. */ |
/* mandoc(1): Take command line arguments as file names. */ |
| |
|
| pflags = MDOC_IGN_MACRO | MDOC_IGN_ESCAPE | MDOC_IGN_CHARS; |
} else { |
| |
ressz = argc > 0 ? argc : 1; |
| |
res = mandoc_calloc(ressz, sizeof(*res)); |
| |
for (i = 0; i < ressz; i++) { |
| |
if (argc > 0) |
| |
res[i].file = mandoc_strdup(argv[i]); |
| |
res[i].ipath = SIZE_MAX; |
| |
res[i].form = FORM_SRC; |
| |
} |
| |
} |
| |
|
| if (curp->fflags & IGN_SCOPE) |
switch (outmode) { |
| pflags |= MDOC_IGN_SCOPE; |
case OUTMODE_FLN: |
| if (curp->fflags & NO_IGN_ESCAPE) |
for (i = 0; i < ressz; i++) |
| pflags &= ~MDOC_IGN_ESCAPE; |
puts(res[i].file); |
| if (curp->fflags & NO_IGN_MACRO) |
goto out; |
| pflags &= ~MDOC_IGN_MACRO; |
case OUTMODE_LST: |
| if (curp->fflags & NO_IGN_CHARS) |
for (i = 0; i < ressz; i++) |
| pflags &= ~MDOC_IGN_CHARS; |
printf("%s - %s\n", res[i].names, |
| |
res[i].output == NULL ? "" : |
| |
res[i].output); |
| |
goto out; |
| |
default: |
| |
break; |
| |
} |
| |
|
| if (NULL == (mdoc = mdoc_alloc(curp, pflags, &mdoccb))) |
if (search.argmode == ARG_FILE && auxpaths != NULL) { |
| warnx("memory exhausted"); |
if (strcmp(auxpaths, "doc") == 0) |
| |
options |= MPARSE_MDOC; |
| |
else if (strcmp(auxpaths, "an") == 0) |
| |
options |= MPARSE_MAN; |
| |
} |
| |
|
| return(mdoc); |
mchars_alloc(); |
| } |
mp = mparse_alloc(options, os_e, os_s); |
| |
|
| |
/* |
| |
* Remember the original working directory, if possible. |
| |
* This will be needed if some names on the command line |
| |
* are page names and some are relative file names. |
| |
* Do not error out if the current directory is not |
| |
* readable: Maybe it won't be needed after all. |
| |
*/ |
| |
startdir = open(".", O_RDONLY | O_DIRECTORY); |
| |
for (i = 0; i < ressz; i++) { |
| |
process_onefile(mp, res + i, startdir, &outst, &conf); |
| |
if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK) |
| |
break; |
| |
} |
| |
if (startdir != -1) { |
| |
(void)fchdir(startdir); |
| |
close(startdir); |
| |
} |
| |
if (conf.output.tag != NULL && conf.output.tag_found == 0) { |
| |
mandoc_msg(MANDOCERR_TAG, 0, 0, "%s", conf.output.tag); |
| |
conf.output.tag = NULL; |
| |
} |
| |
if (outst.outdata != NULL) { |
| |
switch (outst.outtype) { |
| |
case OUTT_HTML: |
| |
html_free(outst.outdata); |
| |
break; |
| |
case OUTT_UTF8: |
| |
case OUTT_LOCALE: |
| |
case OUTT_ASCII: |
| |
ascii_free(outst.outdata); |
| |
break; |
| |
case OUTT_PDF: |
| |
case OUTT_PS: |
| |
pspdf_free(outst.outdata); |
| |
break; |
| |
default: |
| |
break; |
| |
} |
| |
} |
| |
mandoc_xr_free(); |
| |
mparse_free(mp); |
| |
mchars_free(); |
| |
|
| static int |
out: |
| ffile(struct buf *blk, struct buf *ln, |
mansearch_free(res, ressz); |
| const char *file, struct curparse *curp) |
if (search.argmode != ARG_FILE) |
| { |
manconf_free(&conf); |
| int c; |
|
| |
|
| curp->file = file; |
if (outst.tag_files != NULL) { |
| if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) { |
if (term_tag_close() != -1 && |
| warn("%s", curp->file); |
conf.output.outfilename == NULL && |
| return(0); |
conf.output.tagfilename == NULL) |
| } |
run_pager(&outst, conf.output.tag); |
| |
term_tag_unlink(); |
| |
} else if (outst.had_output && outst.outtype != OUTT_LINT) |
| |
mandoc_msg_summary(); |
| |
|
| c = fdesc(blk, ln, curp); |
#if DEBUG_MEMORY |
| |
mandoc_dbg_finish(); |
| |
#endif |
| |
return (int)mandoc_msg_getrc(); |
| |
} |
| |
|
| if (-1 == close(curp->fd)) |
static void |
| warn("%s", curp->file); |
usage(enum argmode argmode) |
| |
{ |
| |
switch (argmode) { |
| |
case ARG_FILE: |
| |
fputs("usage: mandoc [-ac] [-I os=name] " |
| |
"[-K encoding] [-mdoc | -man] [-O options]\n" |
| |
"\t [-T output] [-W level] [file ...]\n", stderr); |
| |
break; |
| |
case ARG_NAME: |
| |
fputs("usage: man [-acfhklw] [-C file] [-M path] " |
| |
"[-m path] [-S subsection]\n" |
| |
"\t [[-s] section] name ...\n", stderr); |
| |
break; |
| |
case ARG_WORD: |
| |
fputs("usage: whatis [-afk] [-C file] " |
| |
"[-M path] [-m path] [-O outkey] [-S arch]\n" |
| |
"\t [-s section] name ...\n", stderr); |
| |
break; |
| |
case ARG_EXPR: |
| |
fputs("usage: apropos [-afk] [-C file] " |
| |
"[-M path] [-m path] [-O outkey] [-S arch]\n" |
| |
"\t [-s section] expression ...\n", stderr); |
| |
break; |
| |
} |
| |
exit((int)MANDOCLEVEL_BADARG); |
| |
} |
| |
|
| return(c); |
static void |
| |
glob_esc(char **dst, const char *src, const char *suffix) |
| |
{ |
| |
while (*src != '\0') { |
| |
if (strchr("*?[", *src) != NULL) |
| |
*(*dst)++ = '\\'; |
| |
*(*dst)++ = *src++; |
| |
} |
| |
while (*suffix != '\0') |
| |
*(*dst)++ = *suffix++; |
| } |
} |
| |
|
| |
static void |
| |
fs_append(char **file, size_t filesz, int copy, size_t ipath, |
| |
const char *sec, enum form form, struct manpage **res, size_t *ressz) |
| |
{ |
| |
struct manpage *page; |
| |
|
| |
*res = mandoc_reallocarray(*res, *ressz + filesz, sizeof(**res)); |
| |
page = *res + *ressz; |
| |
*ressz += filesz; |
| |
for (;;) { |
| |
page->file = copy ? mandoc_strdup(*file) : *file; |
| |
page->names = NULL; |
| |
page->output = NULL; |
| |
page->bits = NAME_FILE & NAME_MASK; |
| |
page->ipath = ipath; |
| |
page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10; |
| |
page->form = form; |
| |
if (--filesz == 0) |
| |
break; |
| |
file++; |
| |
page++; |
| |
} |
| |
} |
| |
|
| static int |
static int |
| fdesc(struct buf *blk, struct buf *ln, struct curparse *curp) |
fs_lookup(const struct manpaths *paths, size_t ipath, |
| |
const char *sec, const char *arch, const char *name, |
| |
struct manpage **res, size_t *ressz) |
| { |
{ |
| size_t sz; |
struct stat sb; |
| ssize_t ssz; |
glob_t globinfo; |
| struct stat st; |
char *file, *cp, secnum[2]; |
| int j, i, pos, lnn, comment; |
int globres; |
| struct man *man; |
enum form form; |
| struct mdoc *mdoc; |
|
| |
|
| sz = BUFSIZ; |
const char *const slman = "/man"; |
| man = NULL; |
const char *const slash = "/"; |
| mdoc = NULL; |
const char *const sglob = ".[01-9]*"; |
| |
const char *const dot = "."; |
| |
const char *const aster = "*"; |
| |
|
| /* |
memset(&globinfo, 0, sizeof(globinfo)); |
| * Two buffers: ln and buf. buf is the input buffer optimised |
form = FORM_SRC; |
| * here for each file's block size. ln is a line buffer. Both |
|
| * growable, hence passed in by ptr-ptr. |
|
| */ |
|
| |
|
| if (-1 == fstat(curp->fd, &st)) |
mandoc_asprintf(&file, "%s/man%s/%s.%s", |
| warn("%s", curp->file); |
paths->paths[ipath], sec, name, sec); |
| else if ((size_t)st.st_blksize > sz) |
if (stat(file, &sb) != -1) |
| sz = st.st_blksize; |
goto found; |
| |
free(file); |
| |
|
| if (sz > blk->sz) { |
mandoc_asprintf(&file, "%s/cat%s/%s.0", |
| blk->buf = realloc(blk->buf, sz); |
paths->paths[ipath], sec, name); |
| if (NULL == blk->buf) { |
if (stat(file, &sb) != -1) { |
| warn("realloc"); |
form = FORM_CAT; |
| return(0); |
goto found; |
| } |
|
| blk->sz = sz; |
|
| } |
} |
| |
free(file); |
| |
|
| /* Fill buf with file blocksize. */ |
if (arch != NULL) { |
| |
mandoc_asprintf(&file, "%s/man%s/%s/%s.%s", |
| |
paths->paths[ipath], sec, arch, name, sec); |
| |
if (stat(file, &sb) != -1) |
| |
goto found; |
| |
free(file); |
| |
} |
| |
|
| for (lnn = pos = comment = 0; ; ) { |
cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 + |
| if (-1 == (ssz = read(curp->fd, blk->buf, sz))) { |
strlen(slman) + strlen(sec) * 2 + strlen(slash) + |
| warn("%s", curp->file); |
strlen(name) * 2 + strlen(sglob) + 1); |
| return(0); |
glob_esc(&cp, paths->paths[ipath], slman); |
| } else if (0 == ssz) |
glob_esc(&cp, sec, slash); |
| break; |
glob_esc(&cp, name, sglob); |
| |
*cp = '\0'; |
| |
globres = glob(file, 0, NULL, &globinfo); |
| |
if (globres != 0 && globres != GLOB_NOMATCH) |
| |
mandoc_msg(MANDOCERR_GLOB, 0, 0, |
| |
"%s: %s", file, strerror(errno)); |
| |
free(file); |
| |
file = NULL; |
| |
if (globres == 0) |
| |
goto found; |
| |
globfree(&globinfo); |
| |
|
| /* Parse the read block into partial or full lines. */ |
if (sec[1] != '\0' && *ressz == 0) { |
| |
secnum[0] = sec[0]; |
| |
secnum[1] = '\0'; |
| |
cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 + |
| |
strlen(slman) + strlen(secnum) * 2 + strlen(slash) + |
| |
strlen(name) * 2 + strlen(dot) + |
| |
strlen(sec) * 2 + strlen(aster) + 1); |
| |
glob_esc(&cp, paths->paths[ipath], slman); |
| |
glob_esc(&cp, secnum, slash); |
| |
glob_esc(&cp, name, dot); |
| |
glob_esc(&cp, sec, aster); |
| |
*cp = '\0'; |
| |
globres = glob(file, 0, NULL, &globinfo); |
| |
if (globres != 0 && globres != GLOB_NOMATCH) |
| |
mandoc_msg(MANDOCERR_GLOB, 0, 0, |
| |
"%s: %s", file, strerror(errno)); |
| |
free(file); |
| |
file = NULL; |
| |
if (globres == 0) |
| |
goto found; |
| |
globfree(&globinfo); |
| |
} |
| |
|
| for (i = 0; i < (int)ssz; i++) { |
if (res != NULL || ipath + 1 != paths->sz) |
| if (pos >= (int)ln->sz) { |
return -1; |
| ln->sz += 256; /* Step-size. */ |
|
| ln->buf = realloc(ln->buf, ln->sz); |
|
| if (NULL == ln->buf) { |
|
| warn("realloc"); |
|
| return(0); |
|
| } |
|
| } |
|
| |
|
| if ('\n' != blk->buf[i]) { |
mandoc_asprintf(&file, "%s.%s", name, sec); |
| if (comment) |
globres = stat(file, &sb); |
| continue; |
free(file); |
| ln->buf[pos++] = blk->buf[i]; |
return globres; |
| |
|
| /* Handle in-line `\"' comments. */ |
found: |
| |
warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s", |
| |
name, sec, BINM_MAKEWHATIS, paths->paths[ipath]); |
| |
if (res == NULL) |
| |
free(file); |
| |
else if (file == NULL) |
| |
fs_append(globinfo.gl_pathv, globinfo.gl_pathc, 1, |
| |
ipath, sec, form, res, ressz); |
| |
else |
| |
fs_append(&file, 1, 0, ipath, sec, form, res, ressz); |
| |
globfree(&globinfo); |
| |
return 0; |
| |
} |
| |
|
| if (1 == pos || '\"' != ln->buf[pos - 1]) |
static int |
| continue; |
fs_search(const struct mansearch *cfg, const struct manpaths *paths, |
| |
const char *name, struct manpage **res, size_t *ressz) |
| |
{ |
| |
const char *const sections[] = |
| |
{"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"}; |
| |
const size_t nsec = sizeof(sections)/sizeof(sections[0]); |
| |
|
| for (j = pos - 2; j >= 0; j--) |
size_t ipath, isec; |
| if ('\\' != ln->buf[j]) |
|
| break; |
|
| |
|
| if ( ! ((pos - 2 - j) % 2)) |
assert(cfg->argmode == ARG_NAME); |
| continue; |
if (res != NULL) |
| |
*res = NULL; |
| |
*ressz = 0; |
| |
for (ipath = 0; ipath < paths->sz; ipath++) { |
| |
if (cfg->sec != NULL) { |
| |
if (fs_lookup(paths, ipath, cfg->sec, cfg->arch, |
| |
name, res, ressz) != -1 && cfg->firstmatch) |
| |
return 0; |
| |
} else { |
| |
for (isec = 0; isec < nsec; isec++) |
| |
if (fs_lookup(paths, ipath, sections[isec], |
| |
cfg->arch, name, res, ressz) != -1 && |
| |
cfg->firstmatch) |
| |
return 0; |
| |
} |
| |
} |
| |
return -1; |
| |
} |
| |
|
| comment = 1; |
static void |
| pos -= 2; |
process_onefile(struct mparse *mp, struct manpage *resp, int startdir, |
| continue; |
struct outstate *outst, struct manconf *conf) |
| } |
{ |
| |
int fd; |
| |
|
| /* Handle escaped `\\n' newlines. */ |
/* |
| |
* Changing directories is not needed in ARG_FILE mode. |
| |
* Do it on a best-effort basis. Even in case of |
| |
* failure, some functionality may still work. |
| |
*/ |
| |
if (resp->ipath != SIZE_MAX) |
| |
(void)chdir(conf->manpath.paths[resp->ipath]); |
| |
else if (startdir != -1) |
| |
(void)fchdir(startdir); |
| |
|
| if (pos > 0 && 0 == comment && |
mandoc_msg_setinfilename(resp->file); |
| '\\' == ln->buf[pos - 1]) { |
if (resp->file != NULL) { |
| for (j = pos - 1; j >= 0; j--) |
if ((fd = mparse_open(mp, resp->file)) == -1) { |
| if ('\\' != ln->buf[j]) |
mandoc_msg(resp->ipath == SIZE_MAX ? |
| break; |
MANDOCERR_BADARG_BAD : MANDOCERR_OPEN, |
| if ( ! ((pos - j) % 2)) { |
0, 0, "%s", strerror(errno)); |
| pos--; |
mandoc_msg_setinfilename(NULL); |
| lnn++; |
return; |
| continue; |
} |
| } |
} else |
| } |
fd = STDIN_FILENO; |
| |
|
| ln->buf[pos] = 0; |
if (outst->use_pager) { |
| lnn++; |
outst->use_pager = 0; |
| |
outst->tag_files = term_tag_init(conf->output.outfilename, |
| |
outst->outtype == OUTT_HTML ? ".html" : "", |
| |
conf->output.tagfilename); |
| |
#if HAVE_PLEDGE |
| |
if ((conf->output.outfilename != NULL || |
| |
conf->output.tagfilename != NULL) && |
| |
pledge("stdio rpath cpath", NULL) == -1) { |
| |
mandoc_msg(MANDOCERR_PLEDGE, 0, 0, |
| |
"%s", strerror(errno)); |
| |
exit(mandoc_msg_getrc()); |
| |
} |
| |
#endif |
| |
} |
| |
if (outst->had_output && outst->outtype <= OUTT_UTF8) { |
| |
if (outst->outdata == NULL) |
| |
outdata_alloc(outst, &conf->output); |
| |
terminal_sepline(outst->outdata); |
| |
} |
| |
|
| /* If unset, assign parser in pset(). */ |
if (resp->form == FORM_SRC) |
| |
parse(mp, fd, resp->file, outst, conf); |
| |
else { |
| |
passthrough(fd, conf->output.synopsisonly); |
| |
outst->had_output = 1; |
| |
} |
| |
|
| if ( ! (man || mdoc) && ! pset(ln->buf, |
if (ferror(stdout)) { |
| pos, curp, &man, &mdoc)) |
if (outst->tag_files != NULL) { |
| return(0); |
mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s", |
| |
outst->tag_files->ofn, strerror(errno)); |
| |
term_tag_unlink(); |
| |
outst->tag_files = NULL; |
| |
} else |
| |
mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s", |
| |
strerror(errno)); |
| |
} |
| |
mandoc_msg_setinfilename(NULL); |
| |
} |
| |
|
| pos = comment = 0; |
static void |
| |
parse(struct mparse *mp, int fd, const char *file, |
| |
struct outstate *outst, struct manconf *conf) |
| |
{ |
| |
static struct manpaths basepaths; |
| |
static int previous; |
| |
struct roff_meta *meta; |
| |
|
| /* Pass down into parsers. */ |
assert(fd >= 0); |
| |
if (file == NULL) |
| |
file = "<stdin>"; |
| |
|
| if (man && ! man_parseln(man, lnn, ln->buf)) |
if (previous) |
| return(0); |
mparse_reset(mp); |
| if (mdoc && ! mdoc_parseln(mdoc, lnn, ln->buf)) |
else |
| return(0); |
previous = 1; |
| } |
|
| } |
|
| |
|
| /* NOTE a parser may not have been assigned, yet. */ |
mparse_readfd(mp, fd, file); |
| |
if (fd != STDIN_FILENO) |
| |
close(fd); |
| |
|
| if ( ! (man || mdoc)) { |
/* |
| warnx("%s: not a manual", curp->file); |
* With -Wstop and warnings or errors of at least the requested |
| return(0); |
* level, do not produce output. |
| } |
*/ |
| |
|
| if (mdoc && ! mdoc_endparse(mdoc)) |
if (outst->wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK) |
| return(0); |
return; |
| if (man && ! man_endparse(man)) |
|
| return(0); |
|
| |
|
| /* If unset, allocate output dev now (if applicable). */ |
if (outst->outdata == NULL) |
| |
outdata_alloc(outst, &conf->output); |
| |
else if (outst->outtype == OUTT_HTML) |
| |
html_reset(outst->outdata); |
| |
|
| if ( ! (curp->outman && curp->outmdoc)) { |
mandoc_xr_reset(); |
| switch (curp->outtype) { |
meta = mparse_result(mp); |
| case (OUTT_TREE): |
|
| curp->outman = tree_man; |
/* Execute the out device, if it exists. */ |
| curp->outmdoc = tree_mdoc; |
|
| |
outst->had_output = 1; |
| |
if (meta->macroset == MACROSET_MDOC) { |
| |
switch (outst->outtype) { |
| |
case OUTT_HTML: |
| |
html_mdoc(outst->outdata, meta); |
| break; |
break; |
| case (OUTT_LINT): |
case OUTT_TREE: |
| |
tree_mdoc(outst->outdata, meta); |
| break; |
break; |
| |
case OUTT_MAN: |
| |
man_mdoc(outst->outdata, meta); |
| |
break; |
| |
case OUTT_PDF: |
| |
case OUTT_ASCII: |
| |
case OUTT_UTF8: |
| |
case OUTT_LOCALE: |
| |
case OUTT_PS: |
| |
terminal_mdoc(outst->outdata, meta); |
| |
break; |
| |
case OUTT_MARKDOWN: |
| |
markdown_mdoc(outst->outdata, meta); |
| |
break; |
| default: |
default: |
| curp->outdata = ascii_alloc(); |
|
| curp->outman = terminal_man; |
|
| curp->outmdoc = terminal_mdoc; |
|
| curp->outfree = terminal_free; |
|
| break; |
break; |
| } |
} |
| } |
} |
| |
if (meta->macroset == MACROSET_MAN) { |
| |
switch (outst->outtype) { |
| |
case OUTT_HTML: |
| |
html_man(outst->outdata, meta); |
| |
break; |
| |
case OUTT_TREE: |
| |
tree_man(outst->outdata, meta); |
| |
break; |
| |
case OUTT_MAN: |
| |
mparse_copy(mp); |
| |
break; |
| |
case OUTT_PDF: |
| |
case OUTT_ASCII: |
| |
case OUTT_UTF8: |
| |
case OUTT_LOCALE: |
| |
case OUTT_PS: |
| |
terminal_man(outst->outdata, meta); |
| |
break; |
| |
case OUTT_MARKDOWN: |
| |
mandoc_msg(MANDOCERR_MAN_TMARKDOWN, 0, 0, NULL); |
| |
break; |
| |
default: |
| |
break; |
| |
} |
| |
} |
| |
if (conf->output.tag != NULL && conf->output.tag_found == 0 && |
| |
tag_exists(conf->output.tag)) |
| |
conf->output.tag_found = 1; |
| |
|
| /* Execute the out device, if it exists. */ |
if (mandoc_msg_getmin() < MANDOCERR_STYLE) { |
| |
if (basepaths.sz == 0) |
| if (man && curp->outman) |
manpath_base(&basepaths); |
| if ( ! (*curp->outman)(curp->outdata, man)) |
check_xr(&basepaths); |
| return(0); |
} else if (mandoc_msg_getmin() < MANDOCERR_WARNING) |
| if (mdoc && curp->outmdoc) |
check_xr(&conf->manpath); |
| if ( ! (*curp->outmdoc)(curp->outdata, mdoc)) |
|
| return(0); |
|
| |
|
| return(1); |
|
| } |
} |
| |
|
| |
static void |
| static int |
check_xr(struct manpaths *paths) |
| pset(const char *buf, int pos, struct curparse *curp, |
|
| struct man **man, struct mdoc **mdoc) |
|
| { |
{ |
| int i; |
struct mansearch search; |
| |
struct mandoc_xr *xr; |
| |
size_t sz; |
| |
|
| /* |
for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) { |
| * Try to intuit which kind of manual parser should be used. If |
if (xr->line == -1) |
| * passed in by command-line (-man, -mdoc), then use that |
continue; |
| * explicitly. If passed as -mandoc, then try to guess from the |
search.arch = NULL; |
| * line: either skip dot-lines, use -mdoc when finding `.Dt', or |
search.sec = xr->sec; |
| * default to -man, which is more lenient. |
search.outkey = NULL; |
| */ |
search.argmode = ARG_NAME; |
| |
search.firstmatch = 1; |
| if (buf[0] == '.') { |
if (mansearch(&search, paths, 1, &xr->name, NULL, &sz)) |
| for (i = 1; buf[i]; i++) |
continue; |
| if (' ' != buf[i] && '\t' != buf[i]) |
if (fs_search(&search, paths, xr->name, NULL, &sz) != -1) |
| break; |
continue; |
| if (0 == buf[i]) |
if (xr->count == 1) |
| return(1); |
mandoc_msg(MANDOCERR_XR_BAD, xr->line, |
| |
xr->pos + 1, "Xr %s %s", xr->name, xr->sec); |
| |
else |
| |
mandoc_msg(MANDOCERR_XR_BAD, xr->line, |
| |
xr->pos + 1, "Xr %s %s (%d times)", |
| |
xr->name, xr->sec, xr->count); |
| } |
} |
| |
} |
| |
|
| switch (curp->inttype) { |
static void |
| case (INTT_MDOC): |
outdata_alloc(struct outstate *outst, struct manoutput *outconf) |
| if (NULL == curp->mdoc) |
{ |
| curp->mdoc = mdoc_init(curp); |
switch (outst->outtype) { |
| if (NULL == (*mdoc = curp->mdoc)) |
case OUTT_HTML: |
| return(0); |
outst->outdata = html_alloc(outconf); |
| curp->lastmdoc = *mdoc; |
break; |
| return(1); |
case OUTT_UTF8: |
| case (INTT_MAN): |
outst->outdata = utf8_alloc(outconf); |
| if (NULL == curp->man) |
break; |
| curp->man = man_init(curp); |
case OUTT_LOCALE: |
| if (NULL == (*man = curp->man)) |
outst->outdata = locale_alloc(outconf); |
| return(0); |
break; |
| curp->lastman = *man; |
case OUTT_ASCII: |
| return(1); |
outst->outdata = ascii_alloc(outconf); |
| |
break; |
| |
case OUTT_PDF: |
| |
outst->outdata = pdf_alloc(outconf); |
| |
break; |
| |
case OUTT_PS: |
| |
outst->outdata = ps_alloc(outconf); |
| |
break; |
| default: |
default: |
| break; |
break; |
| } |
} |
| |
|
| if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3)) { |
|
| if (NULL == curp->mdoc) |
|
| curp->mdoc = mdoc_init(curp); |
|
| if (NULL == (*mdoc = curp->mdoc)) |
|
| return(0); |
|
| curp->lastmdoc = *mdoc; |
|
| return(1); |
|
| } |
|
| |
|
| if (NULL == curp->man) |
|
| curp->man = man_init(curp); |
|
| if (NULL == (*man = curp->man)) |
|
| return(0); |
|
| curp->lastman = *man; |
|
| return(1); |
|
| } |
} |
| |
|
| |
static void |
| static int |
passthrough(int fd, int synopsis_only) |
| moptions(enum intt *tflags, char *arg) |
|
| { |
{ |
| |
const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS"; |
| |
const char synr[] = "SYNOPSIS"; |
| |
|
| if (0 == strcmp(arg, "doc")) |
FILE *stream; |
| *tflags = INTT_MDOC; |
char *line, *cp; |
| else if (0 == strcmp(arg, "andoc")) |
size_t linesz; |
| *tflags = INTT_AUTO; |
ssize_t len, written; |
| else if (0 == strcmp(arg, "an")) |
int lno, print; |
| *tflags = INTT_MAN; |
|
| else { |
|
| warnx("bad argument: -m%s", arg); |
|
| return(0); |
|
| } |
|
| |
|
| return(1); |
stream = NULL; |
| } |
line = NULL; |
| |
linesz = 0; |
| |
|
| |
if (fflush(stdout) == EOF) { |
| |
mandoc_msg(MANDOCERR_FFLUSH, 0, 0, "%s", strerror(errno)); |
| |
goto done; |
| |
} |
| |
if ((stream = fdopen(fd, "r")) == NULL) { |
| |
close(fd); |
| |
mandoc_msg(MANDOCERR_FDOPEN, 0, 0, "%s", strerror(errno)); |
| |
goto done; |
| |
} |
| |
|
| static int |
lno = print = 0; |
| toptions(enum outt *tflags, char *arg) |
while ((len = getline(&line, &linesz, stream)) != -1) { |
| { |
lno++; |
| |
cp = line; |
| if (0 == strcmp(arg, "ascii")) |
if (synopsis_only) { |
| *tflags = OUTT_ASCII; |
if (print) { |
| else if (0 == strcmp(arg, "lint")) |
if ( ! isspace((unsigned char)*cp)) |
| *tflags = OUTT_LINT; |
goto done; |
| else if (0 == strcmp(arg, "tree")) |
while (isspace((unsigned char)*cp)) { |
| *tflags = OUTT_TREE; |
cp++; |
| else { |
len--; |
| warnx("bad argument: -T%s", arg); |
} |
| return(0); |
} else { |
| |
if (strcmp(cp, synb) == 0 || |
| |
strcmp(cp, synr) == 0) |
| |
print = 1; |
| |
continue; |
| |
} |
| |
} |
| |
for (; len > 0; len -= written) { |
| |
if ((written = write(STDOUT_FILENO, cp, len)) == -1) { |
| |
mandoc_msg(MANDOCERR_WRITE, 0, 0, |
| |
"%s", strerror(errno)); |
| |
goto done; |
| |
} |
| |
} |
| } |
} |
| |
if (ferror(stream)) |
| |
mandoc_msg(MANDOCERR_GETLINE, lno, 0, "%s", strerror(errno)); |
| |
|
| return(1); |
done: |
| |
free(line); |
| |
if (stream != NULL) |
| |
fclose(stream); |
| } |
} |
| |
|
| |
|
| static int |
static int |
| foptions(int *fflags, char *arg) |
woptions(char *arg, enum mandoc_os *os_e, int *wstop) |
| { |
{ |
| char *v; |
char *v, *o; |
| char *toks[6]; |
const char *toks[11]; |
| |
|
| toks[0] = "ign-scope"; |
toks[0] = "stop"; |
| toks[1] = "no-ign-escape"; |
toks[1] = "all"; |
| toks[2] = "no-ign-macro"; |
toks[2] = "base"; |
| toks[3] = "no-ign-chars"; |
toks[3] = "style"; |
| toks[4] = "strict"; |
toks[4] = "warning"; |
| toks[5] = NULL; |
toks[5] = "error"; |
| |
toks[6] = "unsupp"; |
| |
toks[7] = "fatal"; |
| |
toks[8] = "openbsd"; |
| |
toks[9] = "netbsd"; |
| |
toks[10] = NULL; |
| |
|
| while (*arg) |
while (*arg) { |
| switch (getsubopt(&arg, toks, &v)) { |
o = arg; |
| case (0): |
switch (getsubopt(&arg, (char * const *)toks, &v)) { |
| *fflags |= IGN_SCOPE; |
case 0: |
| |
*wstop = 1; |
| break; |
break; |
| case (1): |
case 1: |
| *fflags |= NO_IGN_ESCAPE; |
case 2: |
| |
mandoc_msg_setmin(MANDOCERR_BASE); |
| break; |
break; |
| case (2): |
case 3: |
| *fflags |= NO_IGN_MACRO; |
mandoc_msg_setmin(MANDOCERR_STYLE); |
| break; |
break; |
| case (3): |
case 4: |
| *fflags |= NO_IGN_CHARS; |
mandoc_msg_setmin(MANDOCERR_WARNING); |
| break; |
break; |
| case (4): |
case 5: |
| *fflags |= NO_IGN_ESCAPE | |
mandoc_msg_setmin(MANDOCERR_ERROR); |
| NO_IGN_MACRO | NO_IGN_CHARS; |
|
| break; |
break; |
| default: |
case 6: |
| warnx("bad argument: -f%s", suboptarg); |
mandoc_msg_setmin(MANDOCERR_UNSUPP); |
| return(0); |
|
| } |
|
| |
|
| return(1); |
|
| } |
|
| |
|
| |
|
| static int |
|
| woptions(int *wflags, char *arg) |
|
| { |
|
| char *v; |
|
| char *toks[5]; |
|
| |
|
| toks[0] = "all"; |
|
| toks[1] = "compat"; |
|
| toks[2] = "syntax"; |
|
| toks[3] = "error"; |
|
| toks[4] = NULL; |
|
| |
|
| while (*arg) |
|
| switch (getsubopt(&arg, toks, &v)) { |
|
| case (0): |
|
| *wflags |= WARN_WALL; |
|
| break; |
break; |
| case (1): |
case 7: |
| *wflags |= WARN_WCOMPAT; |
mandoc_msg_setmin(MANDOCERR_BADARG); |
| break; |
break; |
| case (2): |
case 8: |
| *wflags |= WARN_WSYNTAX; |
mandoc_msg_setmin(MANDOCERR_BASE); |
| |
*os_e = MANDOC_OS_OPENBSD; |
| break; |
break; |
| case (3): |
case 9: |
| *wflags |= WARN_WERR; |
mandoc_msg_setmin(MANDOCERR_BASE); |
| |
*os_e = MANDOC_OS_NETBSD; |
| break; |
break; |
| default: |
default: |
| warnx("bad argument: -W%s", suboptarg); |
mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, "-W %s", o); |
| return(0); |
return -1; |
| } |
} |
| |
} |
| return(1); |
return 0; |
| } |
} |
| |
|
| |
/* |
| /* ARGSUSED */ |
* Wait until moved to the foreground, |
| static int |
* then fork the pager and wait for the user to close it. |
| merr(void *arg, int line, int col, const char *msg) |
*/ |
| |
static void |
| |
run_pager(struct outstate *outst, char *tag_target) |
| { |
{ |
| struct curparse *curp; |
int signum, status; |
| |
pid_t man_pgid, tc_pgid; |
| |
pid_t pager_pid, wait_pid; |
| |
|
| curp = (struct curparse *)arg; |
man_pgid = getpgid(0); |
| warnx("%s:%d: error: %s (column %d)", |
outst->tag_files->tcpgid = |
| curp->file, line, msg, col); |
man_pgid == getpid() ? getpgid(getppid()) : man_pgid; |
| |
pager_pid = 0; |
| |
signum = SIGSTOP; |
| |
|
| return(0); |
for (;;) { |
| } |
/* Stop here until moved to the foreground. */ |
| |
|
| |
tc_pgid = tcgetpgrp(STDOUT_FILENO); |
| |
if (tc_pgid != man_pgid) { |
| |
if (tc_pgid == pager_pid) { |
| |
(void)tcsetpgrp(STDOUT_FILENO, man_pgid); |
| |
if (signum == SIGTTIN) |
| |
continue; |
| |
} else |
| |
outst->tag_files->tcpgid = tc_pgid; |
| |
kill(0, signum); |
| |
continue; |
| |
} |
| |
|
| static int |
/* Once in the foreground, activate the pager. */ |
| mdocwarn(void *arg, int line, int col, |
|
| enum mdoc_warn type, const char *msg) |
|
| { |
|
| struct curparse *curp; |
|
| char *wtype; |
|
| |
|
| curp = (struct curparse *)arg; |
if (pager_pid) { |
| wtype = NULL; |
(void)tcsetpgrp(STDOUT_FILENO, pager_pid); |
| |
kill(pager_pid, SIGCONT); |
| |
} else |
| |
pager_pid = spawn_pager(outst, tag_target); |
| |
|
| switch (type) { |
/* Wait for the pager to stop or exit. */ |
| case (WARN_COMPAT): |
|
| wtype = "compat"; |
while ((wait_pid = waitpid(pager_pid, &status, |
| if (curp->wflags & WARN_WCOMPAT) |
WUNTRACED)) == -1 && errno == EINTR) |
| |
continue; |
| |
|
| |
if (wait_pid == -1) { |
| |
mandoc_msg(MANDOCERR_WAIT, 0, 0, |
| |
"%s", strerror(errno)); |
| break; |
break; |
| return(1); |
} |
| case (WARN_SYNTAX): |
if (!WIFSTOPPED(status)) |
| wtype = "syntax"; |
|
| if (curp->wflags & WARN_WSYNTAX) |
|
| break; |
break; |
| return(1); |
|
| |
signum = WSTOPSIG(status); |
| } |
} |
| |
} |
| |
|
| assert(wtype); |
static pid_t |
| warnx("%s:%d: %s warning: %s (column %d)", |
spawn_pager(struct outstate *outst, char *tag_target) |
| curp->file, line, wtype, msg, col); |
{ |
| |
const struct timespec timeout = { 0, 100000000 }; /* 0.1s */ |
| |
#define MAX_PAGER_ARGS 16 |
| |
char *argv[MAX_PAGER_ARGS]; |
| |
const char *pager; |
| |
char *cp; |
| |
size_t wordlen; |
| |
#if HAVE_LESS_T |
| |
size_t cmdlen; |
| |
#endif |
| |
int argc, use_ofn; |
| |
pid_t pager_pid; |
| |
|
| if ( ! (curp->wflags & WARN_WERR)) |
assert(outst->tag_files->ofd == -1); |
| return(1); |
assert(outst->tag_files->tfs == NULL); |
| |
|
| warnx("considering warnings as errors"); |
|
| return(0); |
|
| } |
|
| |
|
| |
pager = getenv("MANPAGER"); |
| |
if (pager == NULL || *pager == '\0') |
| |
pager = getenv("PAGER"); |
| |
if (pager == NULL || *pager == '\0') |
| |
pager = BINM_PAGER; |
| |
|
| static int |
/* |
| manwarn(void *arg, int line, int col, const char *msg) |
* Parse the pager command into words. |
| { |
* Intentionally do not do anything fancy here. |
| struct curparse *curp; |
*/ |
| |
|
| curp = (struct curparse *)arg; |
argc = 0; |
| |
while (*pager != '\0' && argc + 5 < MAX_PAGER_ARGS) { |
| |
wordlen = strcspn(pager, " "); |
| |
argv[argc++] = mandoc_strndup(pager, wordlen); |
| |
pager += wordlen; |
| |
while (*pager == ' ') |
| |
pager++; |
| |
} |
| |
|
| if ( ! (curp->wflags & WARN_WSYNTAX)) |
/* For less(1), use the tag file. */ |
| return(1); |
|
| |
|
| warnx("%s:%d: syntax warning: %s (column %d)", |
use_ofn = 1; |
| curp->file, line, msg, col); |
#if HAVE_LESS_T |
| |
if (*outst->tag_files->tfn != '\0' && |
| |
(cmdlen = strlen(argv[0])) >= 4) { |
| |
cp = argv[0] + cmdlen - 4; |
| |
if (strcmp(cp, "less") == 0) { |
| |
argv[argc++] = mandoc_strdup("-T"); |
| |
argv[argc++] = mandoc_strdup(outst->tag_files->tfn); |
| |
if (tag_target != NULL) { |
| |
argv[argc++] = mandoc_strdup("-t"); |
| |
argv[argc++] = mandoc_strdup(tag_target); |
| |
use_ofn = 0; |
| |
} |
| |
} |
| |
} |
| |
#endif |
| |
if (use_ofn) { |
| |
if (outst->outtype == OUTT_HTML && tag_target != NULL) |
| |
mandoc_asprintf(&argv[argc], "file://%s#%s", |
| |
outst->tag_files->ofn, tag_target); |
| |
else |
| |
argv[argc] = mandoc_strdup(outst->tag_files->ofn); |
| |
argc++; |
| |
} |
| |
argv[argc] = NULL; |
| |
|
| if ( ! (curp->wflags & WARN_WERR)) |
switch (pager_pid = fork()) { |
| return(1); |
case -1: |
| |
mandoc_msg(MANDOCERR_FORK, 0, 0, "%s", strerror(errno)); |
| |
exit(mandoc_msg_getrc()); |
| |
case 0: |
| |
break; |
| |
default: |
| |
while (argc > 0) |
| |
free(argv[--argc]); |
| |
(void)setpgid(pager_pid, 0); |
| |
(void)tcsetpgrp(STDOUT_FILENO, pager_pid); |
| |
#if HAVE_PLEDGE |
| |
if (pledge("stdio rpath tmppath tty proc", NULL) == -1) { |
| |
mandoc_msg(MANDOCERR_PLEDGE, 0, 0, |
| |
"%s", strerror(errno)); |
| |
exit(mandoc_msg_getrc()); |
| |
} |
| |
#endif |
| |
outst->tag_files->pager_pid = pager_pid; |
| |
return pager_pid; |
| |
} |
| |
|
| warnx("considering warnings as errors"); |
/* |
| return(0); |
* The child process becomes the pager. |
| |
* Do not start it before controlling the terminal. |
| |
*/ |
| |
|
| |
while (tcgetpgrp(STDOUT_FILENO) != getpid()) |
| |
nanosleep(&timeout, NULL); |
| |
|
| |
execvp(argv[0], argv); |
| |
mandoc_msg(MANDOCERR_EXEC, 0, 0, "%s: %s", argv[0], strerror(errno)); |
| |
_exit(mandoc_msg_getrc()); |
| } |
} |
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to main.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc