version 1.147, 2011/03/07 01:35:51 |
version 1.314, 2018/12/20 21:30:32 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2010-2012, 2014-2018 Ingo Schwarze <schwarze@openbsd.org> |
|
* 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. |
*/ |
*/ |
#ifdef HAVE_CONFIG_H |
|
#include "config.h" |
#include "config.h" |
#endif |
|
|
|
#include <sys/mman.h> |
#include <sys/types.h> |
#include <sys/stat.h> |
#include <sys/ioctl.h> |
|
#include <sys/param.h> /* MACHINE */ |
|
#include <sys/termios.h> |
|
#include <sys/wait.h> |
|
|
#include <assert.h> |
#include <assert.h> |
#include <ctype.h> |
#include <ctype.h> |
|
#if HAVE_ERR |
|
#include <err.h> |
|
#endif |
|
#include <errno.h> |
#include <fcntl.h> |
#include <fcntl.h> |
|
#include <glob.h> |
|
#if HAVE_SANDBOX_INIT |
|
#include <sandbox.h> |
|
#endif |
|
#include <signal.h> |
#include <stdio.h> |
#include <stdio.h> |
#include <stdint.h> |
#include <stdint.h> |
#include <stdlib.h> |
#include <stdlib.h> |
#include <string.h> |
#include <string.h> |
|
#include <time.h> |
#include <unistd.h> |
#include <unistd.h> |
|
|
|
#include "mandoc_aux.h" |
#include "mandoc.h" |
#include "mandoc.h" |
#include "main.h" |
#include "mandoc_xr.h" |
|
#include "roff.h" |
#include "mdoc.h" |
#include "mdoc.h" |
#include "man.h" |
#include "man.h" |
#include "roff.h" |
#include "mandoc_parse.h" |
|
#include "tag.h" |
|
#include "main.h" |
|
#include "manconf.h" |
|
#include "mansearch.h" |
|
|
#ifndef MAP_FILE |
enum outmode { |
#define MAP_FILE 0 |
OUTMODE_DEF = 0, |
#endif |
OUTMODE_FLN, |
|
OUTMODE_LST, |
#define REPARSE_LIMIT 1000 |
OUTMODE_ALL, |
#define UNCONST(a) ((void *)(uintptr_t)(const void *)(a)) |
OUTMODE_ONE |
|
|
/* FIXME: Intel's compiler? LLVM? pcc? */ |
|
|
|
#if !defined(__GNUC__) || (__GNUC__ < 2) |
|
# if !defined(lint) |
|
# define __attribute__(x) |
|
# endif |
|
#endif /* !defined(__GNUC__) || (__GNUC__ < 2) */ |
|
|
|
typedef void (*out_mdoc)(void *, const struct mdoc *); |
|
typedef void (*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_HTML, |
OUTT_UTF8, /* -Tutf8 */ |
OUTT_XHTML, |
OUTT_TREE, /* -Ttree */ |
OUTT_LINT, |
OUTT_MAN, /* -Tman */ |
OUTT_PS, |
OUTT_HTML, /* -Thtml */ |
OUTT_PDF |
OUTT_MARKDOWN, /* -Tmarkdown */ |
|
OUTT_LINT, /* -Tlint */ |
|
OUTT_PS, /* -Tps */ |
|
OUTT_PDF /* -Tpdf */ |
}; |
}; |
|
|
struct curparse { |
struct curparse { |
const char *file; /* Current parse. */ |
struct mparse *mp; |
int fd; /* Current parse. */ |
struct manoutput *outopts; /* output options */ |
int line; /* Line number in the file. */ |
|
enum mandoclevel wlevel; /* Ignore messages below this. */ |
|
int wstop; /* Stop after a file with a warning. */ |
|
enum intt inttype; /* which parser to use */ |
|
struct man *pman; /* persistent man parser */ |
|
struct mdoc *pmdoc; /* persistent mdoc parser */ |
|
struct man *man; /* man parser */ |
|
struct mdoc *mdoc; /* mdoc parser */ |
|
struct roff *roff; /* roff parser (!NULL) */ |
|
struct regset regs; /* roff registers */ |
|
int reparse_count; /* finite interpolation stack */ |
|
enum outt outtype; /* which output to use */ |
|
out_mdoc outmdoc; /* mdoc output ptr */ |
|
out_man outman; /* man output ptr */ |
|
out_free outfree; /* free output ptr */ |
|
void *outdata; /* data for output */ |
void *outdata; /* data for output */ |
char outopts[BUFSIZ]; /* buf of output opts */ |
char *os_s; /* operating system for display */ |
|
int wstop; /* stop after a file with a warning */ |
|
enum mandoc_os os_e; /* check base system conventions */ |
|
enum outt outtype; /* which output to use */ |
}; |
}; |
|
|
static const char * const mandoclevels[MANDOCLEVEL_MAX] = { |
|
"SUCCESS", |
|
"RESERVED", |
|
"WARNING", |
|
"ERROR", |
|
"FATAL", |
|
"BADARG", |
|
"SYSERR" |
|
}; |
|
|
|
static const enum mandocerr mandoclimits[MANDOCLEVEL_MAX] = { |
int mandocdb(int, char *[]); |
MANDOCERR_OK, |
|
MANDOCERR_WARNING, |
|
MANDOCERR_WARNING, |
|
MANDOCERR_ERROR, |
|
MANDOCERR_FATAL, |
|
MANDOCERR_MAX, |
|
MANDOCERR_MAX |
|
}; |
|
|
|
static const char * const mandocerrs[MANDOCERR_MAX] = { |
static void check_xr(void); |
"ok", |
static int fs_lookup(const struct manpaths *, |
|
size_t ipath, const char *, |
"generic warning", |
const char *, const char *, |
|
struct manpage **, size_t *); |
/* related to the prologue */ |
static int fs_search(const struct mansearch *, |
"no title in document", |
const struct manpaths *, int, char**, |
"document title should be all caps", |
struct manpage **, size_t *); |
"unknown manual section", |
static int koptions(int *, char *); |
"date missing, using today's date", |
static void moptions(int *, char *); |
"cannot parse date, using it verbatim", |
static void outdata_alloc(struct curparse *); |
"prologue macros out of order", |
static void parse(struct curparse *, int, const char *); |
"duplicate prologue macro", |
static void passthrough(const char *, int, int); |
"macro not allowed in prologue", |
static pid_t spawn_pager(struct tag_files *); |
"macro not allowed in body", |
|
|
|
/* related to document structure */ |
|
".so is fragile, better use ln(1)", |
|
"NAME section must come first", |
|
"bad NAME section contents", |
|
"manual name not yet set", |
|
"sections out of conventional order", |
|
"duplicate section name", |
|
"section not in conventional manual section", |
|
|
|
/* related to macros and nesting */ |
|
"skipping obsolete macro", |
|
"skipping paragraph macro", |
|
"skipping no-space macro", |
|
"blocks badly nested", |
|
"child violates parent syntax", |
|
"nested displays are not portable", |
|
"already in literal mode", |
|
|
|
/* related to missing macro arguments */ |
|
"skipping empty macro", |
|
"argument count wrong", |
|
"missing display type", |
|
"list type must come first", |
|
"tag lists require a width argument", |
|
"missing font type", |
|
"skipping end of block that is not open", |
|
|
|
/* related to bad macro arguments */ |
|
"skipping argument", |
|
"duplicate argument", |
|
"duplicate display type", |
|
"duplicate list type", |
|
"unknown AT&T UNIX version", |
|
"bad Boolean value", |
|
"unknown font", |
|
"unknown standard specifier", |
|
"bad width argument", |
|
|
|
/* related to plain text */ |
|
"blank line in non-literal context", |
|
"tab in non-literal context", |
|
"end of line whitespace", |
|
"bad comment style", |
|
"unknown escape sequence", |
|
"unterminated quoted string", |
|
|
|
"generic error", |
|
|
|
/* related to tables */ |
|
"bad table syntax", |
|
"bad table option", |
|
"bad table layout", |
|
"no table layout cells specified", |
|
"no table data cells specified", |
|
"ignore data in cell", |
|
"data block still open", |
|
"ignoring extra data cells", |
|
|
|
"input stack limit exceeded, infinite loop?", |
|
"skipping bad character", |
|
"escaped character not allowed in a name", |
|
"skipping text before the first section header", |
|
"skipping unknown macro", |
|
"NOT IMPLEMENTED, please use groff: skipping request", |
|
"line scope broken", |
|
"argument count wrong", |
|
"skipping end of block that is not open", |
|
"missing end of block", |
|
"scope open on exit", |
|
"uname(3) system call failed", |
|
"macro requires line argument(s)", |
|
"macro requires body argument(s)", |
|
"macro requires argument(s)", |
|
"missing list type", |
|
"line argument(s) will be lost", |
|
"body argument(s) will be lost", |
|
|
|
"generic fatal error", |
|
|
|
"column syntax is inconsistent", |
|
"NOT IMPLEMENTED: .Bd -file", |
|
"line scope broken, syntax violated", |
|
"argument count wrong, violates syntax", |
|
"child violates parent syntax", |
|
"argument count wrong, violates syntax", |
|
"NOT IMPLEMENTED: .so with absolute path or \"..\"", |
|
"no document body", |
|
"no document prologue", |
|
"static buffer exhausted", |
|
}; |
|
|
|
static void parsebuf(struct curparse *, struct buf, int); |
|
static void pdesc(struct curparse *); |
|
static void fdesc(struct curparse *); |
|
static void ffile(const char *, struct curparse *); |
|
static int pfile(const char *, struct curparse *); |
|
static int moptions(enum intt *, char *); |
|
static int mmsg(enum mandocerr, void *, |
|
int, int, const char *); |
|
static void pset(const char *, int, struct curparse *); |
|
static int toptions(struct curparse *, char *); |
static int toptions(struct curparse *, char *); |
static void usage(void) __attribute__((noreturn)); |
static void usage(enum argmode) __attribute__((__noreturn__)); |
static void version(void) __attribute__((noreturn)); |
|
static int woptions(struct curparse *, char *); |
static int woptions(struct curparse *, char *); |
|
|
static const char *progname; |
static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9}; |
static enum mandoclevel file_status = MANDOCLEVEL_OK; |
static char help_arg[] = "help"; |
static enum mandoclevel exit_status = MANDOCLEVEL_OK; |
static char *help_argv[] = {help_arg, NULL}; |
|
|
|
|
int |
int |
main(int argc, char *argv[]) |
main(int argc, char *argv[]) |
{ |
{ |
int c; |
struct manconf conf; |
|
struct mansearch search; |
struct curparse curp; |
struct curparse curp; |
|
struct winsize ws; |
|
struct tag_files *tag_files; |
|
struct manpage *res, *resp; |
|
const char *progname, *sec, *thisarg; |
|
char *conf_file, *defpaths, *auxpaths; |
|
char *oarg; |
|
unsigned char *uc; |
|
size_t i, sz; |
|
int prio, best_prio; |
|
enum outmode outmode; |
|
int fd, startdir; |
|
int show_usage; |
|
int options; |
|
int use_pager; |
|
int status, signum; |
|
int c; |
|
pid_t pager_pid, tc_pgid, man_pgid, pid; |
|
|
progname = strrchr(argv[0], '/'); |
#if HAVE_PROGNAME |
if (progname == NULL) |
progname = getprogname(); |
|
#else |
|
if (argc < 1) |
|
progname = mandoc_strdup("mandoc"); |
|
else if ((progname = strrchr(argv[0], '/')) == NULL) |
progname = argv[0]; |
progname = argv[0]; |
else |
else |
++progname; |
++progname; |
|
setprogname(progname); |
|
#endif |
|
|
|
if (strncmp(progname, "mandocdb", 8) == 0 || |
|
strcmp(progname, BINM_MAKEWHATIS) == 0) |
|
return mandocdb(argc, argv); |
|
|
|
#if HAVE_PLEDGE |
|
if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1) |
|
err((int)MANDOCLEVEL_SYSERR, "pledge"); |
|
#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 = defpaths = NULL; |
|
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 and formatter options. */ |
|
|
memset(&curp, 0, sizeof(struct curparse)); |
memset(&curp, 0, sizeof(struct curparse)); |
|
curp.outtype = OUTT_LOCALE; |
|
curp.outopts = &conf.output; |
|
options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1; |
|
|
curp.inttype = INTT_AUTO; |
use_pager = 1; |
curp.outtype = OUTT_ASCII; |
tag_files = NULL; |
curp.wlevel = MANDOCLEVEL_FATAL; |
show_usage = 0; |
|
outmode = OUTMODE_DEF; |
|
|
/* LINTED */ |
while ((c = getopt(argc, argv, |
while (-1 != (c = getopt(argc, argv, "m:O:T:VW:"))) |
"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 ('m'): |
case 'a': |
if ( ! moptions(&curp.inttype, optarg)) |
outmode = OUTMODE_ALL; |
return((int)MANDOCLEVEL_BADARG); |
|
break; |
break; |
case ('O'): |
case 'C': |
(void)strlcat(curp.outopts, optarg, BUFSIZ); |
conf_file = optarg; |
(void)strlcat(curp.outopts, ",", BUFSIZ); |
|
break; |
break; |
case ('T'): |
case 'c': |
|
use_pager = 0; |
|
break; |
|
case 'f': |
|
search.argmode = ARG_WORD; |
|
break; |
|
case 'h': |
|
conf.output.synopsisonly = 1; |
|
use_pager = 0; |
|
outmode = OUTMODE_ALL; |
|
break; |
|
case 'I': |
|
if (strncmp(optarg, "os=", 3)) { |
|
warnx("-I %s: Bad argument", optarg); |
|
return (int)MANDOCLEVEL_BADARG; |
|
} |
|
if (curp.os_s != NULL) { |
|
warnx("-I %s: Duplicate argument", optarg); |
|
return (int)MANDOCLEVEL_BADARG; |
|
} |
|
curp.os_s = mandoc_strdup(optarg + 3); |
|
break; |
|
case 'K': |
|
if ( ! koptions(&options, optarg)) |
|
return (int)MANDOCLEVEL_BADARG; |
|
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 ( ! toptions(&curp, optarg)) |
if ( ! toptions(&curp, optarg)) |
return((int)MANDOCLEVEL_BADARG); |
return (int)MANDOCLEVEL_BADARG; |
break; |
break; |
case ('W'): |
case 'W': |
if ( ! woptions(&curp, optarg)) |
if ( ! woptions(&curp, optarg)) |
return((int)MANDOCLEVEL_BADARG); |
return (int)MANDOCLEVEL_BADARG; |
break; |
break; |
case ('V'): |
case 'w': |
version(); |
outmode = OUTMODE_FLN; |
/* NOTREACHED */ |
break; |
default: |
default: |
usage(); |
show_usage = 1; |
/* NOTREACHED */ |
break; |
} |
} |
|
} |
|
|
argc -= optind; |
if (show_usage) |
argv += optind; |
usage(search.argmode); |
|
|
if (NULL == *argv) { |
/* Postprocess options. */ |
curp.file = "<stdin>"; |
|
curp.fd = STDIN_FILENO; |
|
|
|
fdesc(&curp); |
if (outmode == OUTMODE_DEF) { |
|
switch (search.argmode) { |
|
case ARG_FILE: |
|
outmode = OUTMODE_ALL; |
|
use_pager = 0; |
|
break; |
|
case ARG_NAME: |
|
outmode = OUTMODE_ONE; |
|
break; |
|
default: |
|
outmode = OUTMODE_LST; |
|
break; |
|
} |
} |
} |
|
|
while (*argv) { |
if (oarg != NULL) { |
ffile(*argv, &curp); |
if (outmode == OUTMODE_LST) |
if (MANDOCLEVEL_OK != exit_status && curp.wstop) |
search.outkey = oarg; |
break; |
else { |
++argv; |
while (oarg != NULL) { |
|
thisarg = oarg; |
|
if (manconf_output(&conf.output, |
|
strsep(&oarg, ","), 0) == 0) |
|
continue; |
|
warnx("-O %s: Bad argument", thisarg); |
|
return (int)MANDOCLEVEL_BADARG; |
|
} |
|
} |
} |
} |
|
|
if (curp.outfree) |
if (outmode == OUTMODE_FLN || |
(*curp.outfree)(curp.outdata); |
outmode == OUTMODE_LST || |
if (curp.pmdoc) |
!isatty(STDOUT_FILENO)) |
mdoc_free(curp.pmdoc); |
use_pager = 0; |
if (curp.pman) |
|
man_free(curp.pman); |
|
if (curp.roff) |
|
roff_free(curp.roff); |
|
|
|
return((int)exit_status); |
if (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; |
|
} |
|
|
|
#if HAVE_PLEDGE |
|
if (!use_pager) |
|
if (pledge("stdio rpath", NULL) == -1) |
|
err((int)MANDOCLEVEL_SYSERR, "pledge"); |
|
#endif |
|
|
static void |
/* Parse arguments. */ |
version(void) |
|
{ |
|
|
|
(void)printf("%s %s\n", progname, VERSION); |
if (argc > 0) { |
exit((int)MANDOCLEVEL_OK); |
argc -= optind; |
} |
argv += optind; |
|
} |
|
resp = NULL; |
|
|
|
|
static void |
|
usage(void) |
|
{ |
|
|
|
(void)fprintf(stderr, "usage: %s " |
|
"[-V] " |
|
"[-foption] " |
|
"[-mformat] " |
|
"[-Ooption] " |
|
"[-Toutput] " |
|
"[-Werr] " |
|
"[file...]\n", |
|
progname); |
|
|
|
exit((int)MANDOCLEVEL_BADARG); |
|
} |
|
|
|
static void |
|
ffile(const char *file, struct curparse *curp) |
|
{ |
|
|
|
/* |
/* |
* Called once per input file. Get the file ready for reading, |
* Quirks for help(1) |
* pass it through to the parser-driver, then close it out. |
* and for a man(1) section argument without -s. |
* XXX: don't do anything special as this is only called for |
|
* files; stdin goes directly to fdesc(). |
|
*/ |
*/ |
|
|
curp->file = file; |
if (search.argmode == ARG_NAME) { |
|
if (*progname == 'h') { |
if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) { |
if (argc == 0) { |
perror(curp->file); |
argv = help_argv; |
exit_status = MANDOCLEVEL_SYSERR; |
argc = 1; |
return; |
} |
|
} else if (argc > 1 && |
|
((uc = (unsigned char *)argv[0]) != NULL) && |
|
((isdigit(uc[0]) && (uc[1] == '\0' || |
|
(isalpha(uc[1]) && uc[2] == '\0'))) || |
|
(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 |
} |
} |
|
|
fdesc(curp); |
/* man(1), whatis(1), apropos(1) */ |
|
|
if (-1 == close(curp->fd)) |
if (search.argmode != ARG_FILE) { |
perror(curp->file); |
if (search.argmode == ARG_NAME && |
} |
outmode == OUTMODE_ONE) |
|
search.firstmatch = 1; |
|
|
static int |
/* Access the mandoc database. */ |
pfile(const char *file, struct curparse *curp) |
|
{ |
|
const char *savefile; |
|
int fd, savefd; |
|
|
|
if (-1 == (fd = open(file, O_RDONLY, 0))) { |
manconf_parse(&conf, conf_file, defpaths, auxpaths); |
perror(file); |
if ( ! mansearch(&search, &conf.manpath, |
file_status = MANDOCLEVEL_SYSERR; |
argc, argv, &res, &sz)) |
return(0); |
usage(search.argmode); |
} |
|
|
|
savefile = curp->file; |
if (sz == 0 && search.argmode == ARG_NAME) |
savefd = curp->fd; |
fs_search(&search, &conf.manpath, |
|
argc, argv, &res, &sz); |
|
|
curp->file = file; |
if (search.argmode == ARG_NAME) { |
curp->fd = fd; |
for (c = 0; c < argc; c++) { |
|
if (strchr(argv[c], '/') == NULL) |
|
continue; |
|
if (access(argv[c], R_OK) == -1) { |
|
warn("%s", argv[c]); |
|
continue; |
|
} |
|
res = mandoc_reallocarray(res, |
|
sz + 1, sizeof(*res)); |
|
res[sz].file = mandoc_strdup(argv[c]); |
|
res[sz].names = NULL; |
|
res[sz].output = NULL; |
|
res[sz].ipath = SIZE_MAX; |
|
res[sz].sec = 10; |
|
res[sz].form = FORM_SRC; |
|
sz++; |
|
} |
|
} |
|
|
pdesc(curp); |
if (sz == 0) { |
|
if (search.argmode != ARG_NAME) |
|
warnx("nothing appropriate"); |
|
mandoc_msg_setrc(MANDOCLEVEL_BADARG); |
|
goto out; |
|
} |
|
|
curp->file = savefile; |
/* |
curp->fd = savefd; |
* For standard man(1) and -a output mode, |
|
* prepare for copying filename pointers |
|
* into the program parameter array. |
|
*/ |
|
|
if (-1 == close(fd)) |
if (outmode == OUTMODE_ONE) { |
perror(file); |
argc = 1; |
|
best_prio = 20; |
|
} else if (outmode == OUTMODE_ALL) |
|
argc = (int)sz; |
|
|
return(MANDOCLEVEL_FATAL > file_status ? 1 : 0); |
/* Iterate all matching manuals. */ |
} |
|
|
|
|
resp = res; |
|
for (i = 0; i < sz; i++) { |
|
if (outmode == OUTMODE_FLN) |
|
puts(res[i].file); |
|
else if (outmode == OUTMODE_LST) |
|
printf("%s - %s\n", res[i].names, |
|
res[i].output == NULL ? "" : |
|
res[i].output); |
|
else if (outmode == OUTMODE_ONE) { |
|
/* Search for the best section. */ |
|
sec = res[i].file; |
|
sec += strcspn(sec, "123456789"); |
|
if (sec[0] == '\0') |
|
continue; |
|
prio = sec_prios[sec[0] - '1']; |
|
if (sec[1] != '/') |
|
prio += 10; |
|
if (prio >= best_prio) |
|
continue; |
|
best_prio = prio; |
|
resp = res + i; |
|
} |
|
} |
|
|
static void |
/* |
resize_buf(struct buf *buf, size_t initial) |
* For man(1), -a and -i output mode, fall through |
{ |
* to the main mandoc(1) code iterating files |
|
* and running the parsers on each of them. |
|
*/ |
|
|
buf->sz = buf->sz > initial/2 ? 2 * buf->sz : initial; |
if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST) |
buf->buf = realloc(buf->buf, buf->sz); |
goto out; |
if (NULL == buf->buf) { |
|
perror(NULL); |
|
exit((int)MANDOCLEVEL_SYSERR); |
|
} |
} |
} |
|
|
|
|
/* mandoc(1) */ |
|
|
static int |
#if HAVE_PLEDGE |
read_whole_file(struct curparse *curp, struct buf *fb, int *with_mmap) |
if (use_pager) { |
{ |
if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1) |
struct stat st; |
err((int)MANDOCLEVEL_SYSERR, "pledge"); |
size_t off; |
} else { |
ssize_t ssz; |
if (pledge("stdio rpath", NULL) == -1) |
|
err((int)MANDOCLEVEL_SYSERR, "pledge"); |
if (-1 == fstat(curp->fd, &st)) { |
|
perror(curp->file); |
|
return(0); |
|
} |
} |
|
#endif |
|
|
/* |
if (search.argmode == ARG_FILE) |
* If we're a regular file, try just reading in the whole entry |
moptions(&options, auxpaths); |
* via mmap(). This is faster than reading it into blocks, and |
|
* since each file is only a few bytes to begin with, I'm not |
|
* concerned that this is going to tank any machines. |
|
*/ |
|
|
|
if (S_ISREG(st.st_mode)) { |
mchars_alloc(); |
if (st.st_size >= (1U << 31)) { |
curp.mp = mparse_alloc(options, curp.os_e, curp.os_s); |
fprintf(stderr, "%s: input too large\n", |
|
curp->file); |
|
return(0); |
|
} |
|
*with_mmap = 1; |
|
fb->sz = (size_t)st.st_size; |
|
fb->buf = mmap(NULL, fb->sz, PROT_READ, |
|
MAP_FILE|MAP_SHARED, curp->fd, 0); |
|
if (fb->buf != MAP_FAILED) |
|
return(1); |
|
} |
|
|
|
/* |
if (argc < 1) { |
* If this isn't a regular file (like, say, stdin), then we must |
if (use_pager) |
* go the old way and just read things in bit by bit. |
tag_files = tag_init(); |
*/ |
thisarg = "<stdin>"; |
|
mandoc_msg_setinfilename(thisarg); |
*with_mmap = 0; |
parse(&curp, STDIN_FILENO, thisarg); |
off = 0; |
mandoc_msg_setinfilename(NULL); |
fb->sz = 0; |
|
fb->buf = NULL; |
|
for (;;) { |
|
if (off == fb->sz) { |
|
if (fb->sz == (1U << 31)) { |
|
fprintf(stderr, "%s: input too large\n", |
|
curp->file); |
|
break; |
|
} |
|
resize_buf(fb, 65536); |
|
} |
|
ssz = read(curp->fd, fb->buf + (int)off, fb->sz - off); |
|
if (ssz == 0) { |
|
fb->sz = off; |
|
return(1); |
|
} |
|
if (ssz == -1) { |
|
perror(curp->file); |
|
break; |
|
} |
|
off += (size_t)ssz; |
|
} |
} |
|
|
free(fb->buf); |
|
fb->buf = NULL; |
|
return(0); |
|
} |
|
|
|
|
|
static void |
|
fdesc(struct curparse *curp) |
|
{ |
|
|
|
/* |
/* |
* Called once per file with an opened file descriptor. All |
* Remember the original working directory, if possible. |
* pre-file-parse operations (whether stdin or a file) should go |
* This will be needed if some names on the command line |
* here. |
* are page names and some are relative file names. |
* |
* Do not error out if the current directory is not |
* This calls down into the nested parser, which drills down and |
* readable: Maybe it won't be needed after all. |
* fully parses a file and all its dependences (i.e., `so'). It |
|
* then runs the cleanup validators and pushes to output. |
|
*/ |
*/ |
|
startdir = open(".", O_RDONLY | O_DIRECTORY); |
|
|
/* Zero the parse type. */ |
while (argc > 0) { |
|
|
curp->mdoc = NULL; |
/* |
curp->man = NULL; |
* Changing directories is not needed in ARG_FILE mode. |
file_status = MANDOCLEVEL_OK; |
* Do it on a best-effort basis. Even in case of |
|
* failure, some functionality may still work. |
|
*/ |
|
if (resp != NULL) { |
|
if (resp->ipath != SIZE_MAX) |
|
(void)chdir(conf.manpath.paths[resp->ipath]); |
|
else if (startdir != -1) |
|
(void)fchdir(startdir); |
|
thisarg = resp->file; |
|
} else |
|
thisarg = *argv; |
|
|
/* Make sure the mandotory roff parser is initialised. */ |
fd = mparse_open(curp.mp, thisarg); |
|
if (fd != -1) { |
|
if (use_pager) { |
|
use_pager = 0; |
|
tag_files = tag_init(); |
|
if (conf.output.tag != NULL && |
|
tag_files->tagname == NULL) |
|
tag_files->tagname = |
|
*conf.output.tag != '\0' ? |
|
conf.output.tag : *argv; |
|
} |
|
|
if (NULL == curp->roff) { |
mandoc_msg_setinfilename(thisarg); |
curp->roff = roff_alloc(&curp->regs, curp, mmsg); |
if (resp == NULL || resp->form == FORM_SRC) |
assert(curp->roff); |
parse(&curp, fd, thisarg); |
} |
else |
|
passthrough(resp->file, fd, |
|
conf.output.synopsisonly); |
|
mandoc_msg_setinfilename(NULL); |
|
|
/* Fully parse the file. */ |
if (ferror(stdout)) { |
|
if (tag_files != NULL) { |
|
warn("%s", tag_files->ofn); |
|
tag_unlink(); |
|
tag_files = NULL; |
|
} else |
|
warn("stdout"); |
|
mandoc_msg_setrc(MANDOCLEVEL_SYSERR); |
|
break; |
|
} |
|
|
pdesc(curp); |
if (argc > 1 && curp.outtype <= OUTT_UTF8) { |
|
if (curp.outdata == NULL) |
|
outdata_alloc(&curp); |
|
terminal_sepline(curp.outdata); |
|
} |
|
} else |
|
mandoc_msg(MANDOCERR_FILE, 0, 0, |
|
"%s", strerror(errno)); |
|
|
if (MANDOCLEVEL_FATAL <= file_status) |
if (curp.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK) |
goto cleanup; |
break; |
|
|
/* NOTE a parser may not have been assigned, yet. */ |
if (resp != NULL) |
|
resp++; |
if ( ! (curp->man || curp->mdoc)) { |
else |
fprintf(stderr, "%s: Not a manual\n", curp->file); |
argv++; |
file_status = MANDOCLEVEL_FATAL; |
if (--argc) |
goto cleanup; |
mparse_reset(curp.mp); |
} |
} |
|
if (startdir != -1) { |
/* Clean up the parse routine ASTs. */ |
(void)fchdir(startdir); |
|
close(startdir); |
if (curp->mdoc && ! mdoc_endparse(curp->mdoc)) { |
|
assert(MANDOCLEVEL_FATAL <= file_status); |
|
goto cleanup; |
|
} |
} |
|
|
if (curp->man && ! man_endparse(curp->man)) { |
if (curp.outdata != NULL) { |
assert(MANDOCLEVEL_FATAL <= file_status); |
switch (curp.outtype) { |
goto cleanup; |
case OUTT_HTML: |
} |
html_free(curp.outdata); |
|
|
assert(curp->roff); |
|
roff_endparse(curp->roff); |
|
|
|
/* |
|
* With -Wstop and warnings or errors of at least |
|
* the requested level, do not produce output. |
|
*/ |
|
|
|
if (MANDOCLEVEL_OK != file_status && curp->wstop) |
|
goto cleanup; |
|
|
|
/* If unset, allocate output dev now (if applicable). */ |
|
|
|
if ( ! (curp->outman && curp->outmdoc)) { |
|
switch (curp->outtype) { |
|
case (OUTT_XHTML): |
|
curp->outdata = xhtml_alloc(curp->outopts); |
|
break; |
break; |
case (OUTT_HTML): |
case OUTT_UTF8: |
curp->outdata = html_alloc(curp->outopts); |
case OUTT_LOCALE: |
|
case OUTT_ASCII: |
|
ascii_free(curp.outdata); |
break; |
break; |
case (OUTT_ASCII): |
case OUTT_PDF: |
curp->outdata = ascii_alloc(curp->outopts); |
case OUTT_PS: |
curp->outfree = ascii_free; |
pspdf_free(curp.outdata); |
break; |
break; |
case (OUTT_PDF): |
|
curp->outdata = pdf_alloc(curp->outopts); |
|
curp->outfree = pspdf_free; |
|
break; |
|
case (OUTT_PS): |
|
curp->outdata = ps_alloc(curp->outopts); |
|
curp->outfree = pspdf_free; |
|
break; |
|
default: |
default: |
break; |
break; |
} |
} |
|
} |
|
mandoc_xr_free(); |
|
mparse_free(curp.mp); |
|
mchars_free(); |
|
|
switch (curp->outtype) { |
out: |
case (OUTT_HTML): |
if (search.argmode != ARG_FILE) { |
/* FALLTHROUGH */ |
manconf_free(&conf); |
case (OUTT_XHTML): |
mansearch_free(res, sz); |
curp->outman = html_man; |
|
curp->outmdoc = html_mdoc; |
|
curp->outfree = html_free; |
|
break; |
|
case (OUTT_TREE): |
|
curp->outman = tree_man; |
|
curp->outmdoc = tree_mdoc; |
|
break; |
|
case (OUTT_PDF): |
|
/* FALLTHROUGH */ |
|
case (OUTT_ASCII): |
|
/* FALLTHROUGH */ |
|
case (OUTT_PS): |
|
curp->outman = terminal_man; |
|
curp->outmdoc = terminal_mdoc; |
|
break; |
|
default: |
|
break; |
|
} |
|
} |
} |
|
|
/* Execute the out device, if it exists. */ |
free(curp.os_s); |
|
|
if (curp->man && curp->outman) |
/* |
(*curp->outman)(curp->outdata, curp->man); |
* When using a pager, finish writing both temporary files, |
if (curp->mdoc && curp->outmdoc) |
* fork it, wait for the user to close it, and clean up. |
(*curp->outmdoc)(curp->outdata, curp->mdoc); |
*/ |
|
|
cleanup: |
if (tag_files != NULL) { |
|
fclose(stdout); |
|
tag_write(); |
|
man_pgid = getpgid(0); |
|
tag_files->tcpgid = man_pgid == getpid() ? |
|
getpgid(getppid()) : man_pgid; |
|
pager_pid = 0; |
|
signum = SIGSTOP; |
|
for (;;) { |
|
|
memset(&curp->regs, 0, sizeof(struct regset)); |
/* Stop here until moved to the foreground. */ |
|
|
/* Reset the current-parse compilers. */ |
tc_pgid = tcgetpgrp(tag_files->ofd); |
|
if (tc_pgid != man_pgid) { |
|
if (tc_pgid == pager_pid) { |
|
(void)tcsetpgrp(tag_files->ofd, |
|
man_pgid); |
|
if (signum == SIGTTIN) |
|
continue; |
|
} else |
|
tag_files->tcpgid = tc_pgid; |
|
kill(0, signum); |
|
continue; |
|
} |
|
|
if (curp->mdoc) |
/* Once in the foreground, activate the pager. */ |
mdoc_reset(curp->mdoc); |
|
if (curp->man) |
|
man_reset(curp->man); |
|
|
|
assert(curp->roff); |
if (pager_pid) { |
roff_reset(curp->roff); |
(void)tcsetpgrp(tag_files->ofd, pager_pid); |
|
kill(pager_pid, SIGCONT); |
|
} else |
|
pager_pid = spawn_pager(tag_files); |
|
|
if (exit_status < file_status) |
/* Wait for the pager to stop or exit. */ |
exit_status = file_status; |
|
|
|
return; |
while ((pid = waitpid(pager_pid, &status, |
|
WUNTRACED)) == -1 && errno == EINTR) |
|
continue; |
|
|
|
if (pid == -1) { |
|
warn("wait"); |
|
mandoc_msg_setrc(MANDOCLEVEL_SYSERR); |
|
break; |
|
} |
|
if (!WIFSTOPPED(status)) |
|
break; |
|
|
|
signum = WSTOPSIG(status); |
|
} |
|
tag_unlink(); |
|
} |
|
return (int)mandoc_msg_getrc(); |
} |
} |
|
|
static void |
static void |
pdesc(struct curparse *curp) |
usage(enum argmode argmode) |
{ |
{ |
struct buf blk; |
|
int with_mmap; |
|
|
|
/* |
switch (argmode) { |
* Run for each opened file; may be called more than once for |
case ARG_FILE: |
* each full parse sequence if the opened file is nested (i.e., |
fputs("usage: mandoc [-ac] [-I os=name] " |
* from `so'). Simply sucks in the whole file and moves into |
"[-K encoding] [-mdoc | -man] [-O options]\n" |
* the parse phase for the file. |
"\t [-T output] [-W level] [file ...]\n", stderr); |
*/ |
break; |
|
case ARG_NAME: |
if ( ! read_whole_file(curp, &blk, &with_mmap)) { |
fputs("usage: man [-acfhklw] [-C file] [-M path] " |
file_status = MANDOCLEVEL_SYSERR; |
"[-m path] [-S subsection]\n" |
return; |
"\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); |
/* Line number is per-file. */ |
|
|
|
curp->line = 1; |
|
|
|
parsebuf(curp, blk, 1); |
|
|
|
if (with_mmap) |
|
munmap(blk.buf, blk.sz); |
|
else |
|
free(blk.buf); |
|
} |
} |
|
|
static void |
static int |
parsebuf(struct curparse *curp, struct buf blk, int start) |
fs_lookup(const struct manpaths *paths, size_t ipath, |
|
const char *sec, const char *arch, const char *name, |
|
struct manpage **res, size_t *ressz) |
{ |
{ |
const struct tbl_span *span; |
glob_t globinfo; |
struct buf ln; |
struct manpage *page; |
enum rofferr rr; |
char *file; |
int i, of, rc; |
int globres; |
int pos; /* byte number in the ln buffer */ |
enum form form; |
int lnn; /* line number in the real file */ |
|
unsigned char c; |
|
|
|
/* |
form = FORM_SRC; |
* Main parse routine for an opened file. This is called for |
mandoc_asprintf(&file, "%s/man%s/%s.%s", |
* each opened file and simply loops around the full input file, |
paths->paths[ipath], sec, name, sec); |
* possibly nesting (i.e., with `so'). |
if (access(file, R_OK) != -1) |
*/ |
goto found; |
|
free(file); |
|
|
memset(&ln, 0, sizeof(struct buf)); |
mandoc_asprintf(&file, "%s/cat%s/%s.0", |
|
paths->paths[ipath], sec, name); |
|
if (access(file, R_OK) != -1) { |
|
form = FORM_CAT; |
|
goto found; |
|
} |
|
free(file); |
|
|
lnn = curp->line; |
if (arch != NULL) { |
pos = 0; |
mandoc_asprintf(&file, "%s/man%s/%s/%s.%s", |
|
paths->paths[ipath], sec, arch, name, sec); |
|
if (access(file, R_OK) != -1) |
|
goto found; |
|
free(file); |
|
} |
|
|
for (i = 0; i < (int)blk.sz; ) { |
mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*", |
if (0 == pos && '\0' == blk.buf[i]) |
paths->paths[ipath], sec, name); |
break; |
globres = glob(file, 0, NULL, &globinfo); |
|
if (globres != 0 && globres != GLOB_NOMATCH) |
|
warn("%s: glob", file); |
|
free(file); |
|
if (globres == 0) |
|
file = mandoc_strdup(*globinfo.gl_pathv); |
|
globfree(&globinfo); |
|
if (globres == 0) |
|
goto found; |
|
if (res != NULL || ipath + 1 != paths->sz) |
|
return 0; |
|
|
if (start) { |
mandoc_asprintf(&file, "%s.%s", name, sec); |
curp->line = lnn; |
globres = access(file, R_OK); |
curp->reparse_count = 0; |
free(file); |
} |
return globres != -1; |
|
|
while (i < (int)blk.sz && (start || '\0' != blk.buf[i])) { |
found: |
|
warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s", |
|
name, sec, BINM_MAKEWHATIS, paths->paths[ipath]); |
|
if (res == NULL) { |
|
free(file); |
|
return 1; |
|
} |
|
*res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage)); |
|
page = *res + (*ressz - 1); |
|
page->file = file; |
|
page->names = NULL; |
|
page->output = NULL; |
|
page->ipath = ipath; |
|
page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10; |
|
page->form = form; |
|
return 1; |
|
} |
|
|
/* |
static int |
* When finding an unescaped newline character, |
fs_search(const struct mansearch *cfg, const struct manpaths *paths, |
* leave the character loop to process the line. |
int argc, char **argv, struct manpage **res, size_t *ressz) |
* Skip a preceding carriage return, if any. |
{ |
*/ |
const char *const sections[] = |
|
{"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"}; |
|
const size_t nsec = sizeof(sections)/sizeof(sections[0]); |
|
|
if ('\r' == blk.buf[i] && i + 1 < (int)blk.sz && |
size_t ipath, isec, lastsz; |
'\n' == blk.buf[i + 1]) |
|
++i; |
|
if ('\n' == blk.buf[i]) { |
|
++i; |
|
++lnn; |
|
break; |
|
} |
|
|
|
/* |
assert(cfg->argmode == ARG_NAME); |
* Warn about bogus characters. If you're using |
|
* non-ASCII encoding, you're screwing your |
|
* readers. Since I'd rather this not happen, |
|
* I'll be helpful and drop these characters so |
|
* we don't display gibberish. Note to manual |
|
* writers: use special characters. |
|
*/ |
|
|
|
c = (unsigned char) blk.buf[i]; |
if (res != NULL) |
|
*res = NULL; |
|
*ressz = lastsz = 0; |
|
while (argc) { |
|
for (ipath = 0; ipath < paths->sz; ipath++) { |
|
if (cfg->sec != NULL) { |
|
if (fs_lookup(paths, ipath, cfg->sec, |
|
cfg->arch, *argv, res, ressz) && |
|
cfg->firstmatch) |
|
return 1; |
|
} else for (isec = 0; isec < nsec; isec++) |
|
if (fs_lookup(paths, ipath, sections[isec], |
|
cfg->arch, *argv, res, ressz) && |
|
cfg->firstmatch) |
|
return 1; |
|
} |
|
if (res != NULL && *ressz == lastsz && |
|
strchr(*argv, '/') == NULL) { |
|
if (cfg->sec == NULL) |
|
warnx("No entry for %s in the manual.", |
|
*argv); |
|
else |
|
warnx("No entry for %s in section %s " |
|
"of the manual.", *argv, cfg->sec); |
|
} |
|
lastsz = *ressz; |
|
argv++; |
|
argc--; |
|
} |
|
return 0; |
|
} |
|
|
if ( ! (isascii(c) && |
static void |
(isgraph(c) || isblank(c)))) { |
parse(struct curparse *curp, int fd, const char *file) |
mmsg(MANDOCERR_BADCHAR, curp, |
{ |
curp->line, pos, "ignoring byte"); |
struct roff_man *man; |
i++; |
|
continue; |
|
} |
|
|
|
/* Trailing backslash = a plain char. */ |
/* Begin by parsing the file itself. */ |
|
|
if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) { |
assert(file); |
if (pos >= (int)ln.sz) |
assert(fd >= 0); |
resize_buf(&ln, 256); |
|
ln.buf[pos++] = blk.buf[i++]; |
|
continue; |
|
} |
|
|
|
/* |
mparse_readfd(curp->mp, fd, file); |
* Found escape and at least one other character. |
if (fd != STDIN_FILENO) |
* When it's a newline character, skip it. |
close(fd); |
* When there is a carriage return in between, |
|
* skip that one as well. |
|
*/ |
|
|
|
if ('\r' == blk.buf[i + 1] && i + 2 < (int)blk.sz && |
/* |
'\n' == blk.buf[i + 2]) |
* With -Wstop and warnings or errors of at least the requested |
++i; |
* level, do not produce output. |
if ('\n' == blk.buf[i + 1]) { |
*/ |
i += 2; |
|
++lnn; |
|
continue; |
|
} |
|
|
|
if ('"' == blk.buf[i + 1]) { |
if (curp->wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK) |
i += 2; |
return; |
/* Comment, skip to end of line */ |
|
for (; i < (int)blk.sz; ++i) { |
|
if ('\n' == blk.buf[i]) { |
|
++i; |
|
++lnn; |
|
break; |
|
} |
|
} |
|
|
|
/* Backout trailing whitespaces */ |
if (curp->outdata == NULL) |
for (; pos > 0; --pos) { |
outdata_alloc(curp); |
if (ln.buf[pos - 1] != ' ') |
|
break; |
|
if (pos > 2 && ln.buf[pos - 2] == '\\') |
|
break; |
|
} |
|
break; |
|
} |
|
|
|
/* Some other escape sequence, copy & cont. */ |
mparse_result(curp->mp, &man, NULL); |
|
|
if (pos + 1 >= (int)ln.sz) |
/* Execute the out device, if it exists. */ |
resize_buf(&ln, 256); |
|
|
|
ln.buf[pos++] = blk.buf[i++]; |
if (man == NULL) |
ln.buf[pos++] = blk.buf[i++]; |
return; |
} |
mandoc_xr_reset(); |
|
if (man->macroset == MACROSET_MDOC) { |
if (pos >= (int)ln.sz) |
if (curp->outtype != OUTT_TREE || !curp->outopts->noval) |
resize_buf(&ln, 256); |
mdoc_validate(man); |
|
switch (curp->outtype) { |
ln.buf[pos] = '\0'; |
case OUTT_HTML: |
|
html_mdoc(curp->outdata, man); |
/* |
|
* A significant amount of complexity is contained by |
|
* the roff preprocessor. It's line-oriented but can be |
|
* expressed on one line, so we need at times to |
|
* readjust our starting point and re-run it. The roff |
|
* preprocessor can also readjust the buffers with new |
|
* data, so we pass them in wholesale. |
|
*/ |
|
|
|
of = 0; |
|
|
|
rerun: |
|
rr = roff_parseln |
|
(curp->roff, curp->line, |
|
&ln.buf, &ln.sz, of, &of); |
|
|
|
switch (rr) { |
|
case (ROFF_REPARSE): |
|
if (REPARSE_LIMIT >= ++curp->reparse_count) |
|
parsebuf(curp, ln, 0); |
|
else |
|
mmsg(MANDOCERR_ROFFLOOP, curp, |
|
curp->line, pos, NULL); |
|
pos = 0; |
|
continue; |
|
case (ROFF_APPEND): |
|
pos = strlen(ln.buf); |
|
continue; |
|
case (ROFF_RERUN): |
|
goto rerun; |
|
case (ROFF_IGN): |
|
pos = 0; |
|
continue; |
|
case (ROFF_ERR): |
|
assert(MANDOCLEVEL_FATAL <= file_status); |
|
break; |
break; |
case (ROFF_SO): |
case OUTT_TREE: |
if (pfile(ln.buf + of, curp)) { |
tree_mdoc(curp->outdata, man); |
pos = 0; |
break; |
continue; |
case OUTT_MAN: |
} else |
man_mdoc(curp->outdata, man); |
break; |
break; |
|
case OUTT_PDF: |
|
case OUTT_ASCII: |
|
case OUTT_UTF8: |
|
case OUTT_LOCALE: |
|
case OUTT_PS: |
|
terminal_mdoc(curp->outdata, man); |
|
break; |
|
case OUTT_MARKDOWN: |
|
markdown_mdoc(curp->outdata, man); |
|
break; |
default: |
default: |
break; |
break; |
} |
} |
|
} |
/* |
if (man->macroset == MACROSET_MAN) { |
* If we encounter errors in the recursive parsebuf() |
if (curp->outtype != OUTT_TREE || !curp->outopts->noval) |
* call, make sure we don't continue parsing. |
man_validate(man); |
*/ |
switch (curp->outtype) { |
|
case OUTT_HTML: |
if (MANDOCLEVEL_FATAL <= file_status) |
html_man(curp->outdata, man); |
break; |
break; |
|
case OUTT_TREE: |
/* |
tree_man(curp->outdata, man); |
* If input parsers have not been allocated, do so now. |
|
* We keep these instanced betwen parsers, but set them |
|
* locally per parse routine since we can use different |
|
* parsers with each one. |
|
*/ |
|
|
|
if ( ! (curp->man || curp->mdoc)) |
|
pset(ln.buf + of, pos - of, curp); |
|
|
|
/* |
|
* Lastly, push down into the parsers themselves. One |
|
* of these will have already been set in the pset() |
|
* routine. |
|
* If libroff returns ROFF_TBL, then add it to the |
|
* currently open parse. Since we only get here if |
|
* there does exist data (see tbl_data.c), we're |
|
* guaranteed that something's been allocated. |
|
* Do the same for ROFF_EQN. |
|
*/ |
|
|
|
rc = -1; |
|
|
|
if (ROFF_TBL == rr) |
|
while (NULL != (span = roff_span(curp->roff))) { |
|
rc = curp->man ? |
|
man_addspan(curp->man, span) : |
|
mdoc_addspan(curp->mdoc, span); |
|
if (0 == rc) |
|
break; |
|
} |
|
else if (ROFF_EQN == rr) |
|
rc = curp->mdoc ? |
|
mdoc_addeqn(curp->mdoc, |
|
roff_eqn(curp->roff)) : |
|
man_addeqn(curp->man, |
|
roff_eqn(curp->roff)); |
|
else if (curp->man || curp->mdoc) |
|
rc = curp->man ? |
|
man_parseln(curp->man, |
|
curp->line, ln.buf, of) : |
|
mdoc_parseln(curp->mdoc, |
|
curp->line, ln.buf, of); |
|
|
|
if (0 == rc) { |
|
assert(MANDOCLEVEL_FATAL <= file_status); |
|
break; |
break; |
|
case OUTT_MAN: |
|
mparse_copy(curp->mp); |
|
break; |
|
case OUTT_PDF: |
|
case OUTT_ASCII: |
|
case OUTT_UTF8: |
|
case OUTT_LOCALE: |
|
case OUTT_PS: |
|
terminal_man(curp->outdata, man); |
|
break; |
|
default: |
|
break; |
} |
} |
|
} |
|
if (mandoc_msg_getmin() < MANDOCERR_STYLE) |
|
check_xr(); |
|
} |
|
|
/* Temporary buffers typically are not full. */ |
static void |
|
check_xr(void) |
|
{ |
|
static struct manpaths paths; |
|
struct mansearch search; |
|
struct mandoc_xr *xr; |
|
size_t sz; |
|
|
if (0 == start && '\0' == blk.buf[i]) |
if (paths.sz == 0) |
break; |
manpath_base(&paths); |
|
|
/* Start the next input line. */ |
for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) { |
|
if (xr->line == -1) |
pos = 0; |
continue; |
|
search.arch = NULL; |
|
search.sec = xr->sec; |
|
search.outkey = NULL; |
|
search.argmode = ARG_NAME; |
|
search.firstmatch = 1; |
|
if (mansearch(&search, &paths, 1, &xr->name, NULL, &sz)) |
|
continue; |
|
if (fs_search(&search, &paths, 1, &xr->name, NULL, &sz)) |
|
continue; |
|
if (xr->count == 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); |
} |
} |
|
} |
|
|
free(ln.buf); |
static void |
|
outdata_alloc(struct curparse *curp) |
|
{ |
|
switch (curp->outtype) { |
|
case OUTT_HTML: |
|
curp->outdata = html_alloc(curp->outopts); |
|
break; |
|
case OUTT_UTF8: |
|
curp->outdata = utf8_alloc(curp->outopts); |
|
break; |
|
case OUTT_LOCALE: |
|
curp->outdata = locale_alloc(curp->outopts); |
|
break; |
|
case OUTT_ASCII: |
|
curp->outdata = ascii_alloc(curp->outopts); |
|
break; |
|
case OUTT_PDF: |
|
curp->outdata = pdf_alloc(curp->outopts); |
|
break; |
|
case OUTT_PS: |
|
curp->outdata = ps_alloc(curp->outopts); |
|
break; |
|
default: |
|
break; |
|
} |
} |
} |
|
|
static void |
static void |
pset(const char *buf, int pos, struct curparse *curp) |
passthrough(const char *file, int fd, int synopsis_only) |
{ |
{ |
int i; |
const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS"; |
|
const char synr[] = "SYNOPSIS"; |
|
|
/* |
FILE *stream; |
* Try to intuit which kind of manual parser should be used. If |
const char *syscall; |
* passed in by command-line (-man, -mdoc), then use that |
char *line, *cp; |
* explicitly. If passed as -mandoc, then try to guess from the |
size_t linesz; |
* line: either skip dot-lines, use -mdoc when finding `.Dt', or |
ssize_t len, written; |
* default to -man, which is more lenient. |
int print; |
* |
|
* Separate out pmdoc/pman from mdoc/man: the first persists |
|
* through all parsers, while the latter is used per-parse. |
|
*/ |
|
|
|
if ('.' == buf[0] || '\'' == buf[0]) { |
line = NULL; |
for (i = 1; buf[i]; i++) |
linesz = 0; |
if (' ' != buf[i] && '\t' != buf[i]) |
|
break; |
if (fflush(stdout) == EOF) { |
if ('\0' == buf[i]) |
syscall = "fflush"; |
return; |
goto fail; |
} |
} |
|
|
switch (curp->inttype) { |
if ((stream = fdopen(fd, "r")) == NULL) { |
case (INTT_MDOC): |
close(fd); |
if (NULL == curp->pmdoc) |
syscall = "fdopen"; |
curp->pmdoc = mdoc_alloc |
goto fail; |
(&curp->regs, curp, mmsg); |
|
assert(curp->pmdoc); |
|
curp->mdoc = curp->pmdoc; |
|
return; |
|
case (INTT_MAN): |
|
if (NULL == curp->pman) |
|
curp->pman = man_alloc |
|
(&curp->regs, curp, mmsg); |
|
assert(curp->pman); |
|
curp->man = curp->pman; |
|
return; |
|
default: |
|
break; |
|
} |
} |
|
|
if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3)) { |
print = 0; |
if (NULL == curp->pmdoc) |
while ((len = getline(&line, &linesz, stream)) != -1) { |
curp->pmdoc = mdoc_alloc |
cp = line; |
(&curp->regs, curp, mmsg); |
if (synopsis_only) { |
assert(curp->pmdoc); |
if (print) { |
curp->mdoc = curp->pmdoc; |
if ( ! isspace((unsigned char)*cp)) |
return; |
goto done; |
} |
while (isspace((unsigned char)*cp)) { |
|
cp++; |
|
len--; |
|
} |
|
} 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) |
|
continue; |
|
fclose(stream); |
|
syscall = "write"; |
|
goto fail; |
|
} |
|
} |
|
|
if (NULL == curp->pman) |
if (ferror(stream)) { |
curp->pman = man_alloc(&curp->regs, curp, mmsg); |
fclose(stream); |
assert(curp->pman); |
syscall = "getline"; |
curp->man = curp->pman; |
goto fail; |
|
} |
|
|
|
done: |
|
free(line); |
|
fclose(stream); |
|
return; |
|
|
|
fail: |
|
free(line); |
|
warn("%s: SYSERR: %s", file, syscall); |
|
mandoc_msg_setrc(MANDOCLEVEL_SYSERR); |
} |
} |
|
|
static int |
static int |
moptions(enum intt *tflags, char *arg) |
koptions(int *options, char *arg) |
{ |
{ |
|
|
if (0 == strcmp(arg, "doc")) |
if ( ! strcmp(arg, "utf-8")) { |
*tflags = INTT_MDOC; |
*options |= MPARSE_UTF8; |
else if (0 == strcmp(arg, "andoc")) |
*options &= ~MPARSE_LATIN1; |
*tflags = INTT_AUTO; |
} else if ( ! strcmp(arg, "iso-8859-1")) { |
else if (0 == strcmp(arg, "an")) |
*options |= MPARSE_LATIN1; |
*tflags = INTT_MAN; |
*options &= ~MPARSE_UTF8; |
else { |
} else if ( ! strcmp(arg, "us-ascii")) { |
fprintf(stderr, "%s: Bad argument\n", arg); |
*options &= ~(MPARSE_UTF8 | MPARSE_LATIN1); |
return(0); |
} else { |
|
warnx("-K %s: Bad argument", arg); |
|
return 0; |
} |
} |
|
return 1; |
|
} |
|
|
return(1); |
static void |
|
moptions(int *options, char *arg) |
|
{ |
|
|
|
if (arg == NULL) |
|
return; |
|
if (strcmp(arg, "doc") == 0) |
|
*options |= MPARSE_MDOC; |
|
else if (strcmp(arg, "an") == 0) |
|
*options |= MPARSE_MAN; |
} |
} |
|
|
static int |
static int |
Line 982 toptions(struct curparse *curp, char *arg) |
|
Line 1055 toptions(struct curparse *curp, char *arg) |
|
curp->outtype = OUTT_ASCII; |
curp->outtype = OUTT_ASCII; |
else if (0 == strcmp(arg, "lint")) { |
else if (0 == strcmp(arg, "lint")) { |
curp->outtype = OUTT_LINT; |
curp->outtype = OUTT_LINT; |
curp->wlevel = MANDOCLEVEL_WARNING; |
mandoc_msg_setoutfile(stdout); |
} |
mandoc_msg_setmin(MANDOCERR_BASE); |
else if (0 == strcmp(arg, "tree")) |
} else if (0 == strcmp(arg, "tree")) |
curp->outtype = OUTT_TREE; |
curp->outtype = OUTT_TREE; |
|
else if (0 == strcmp(arg, "man")) |
|
curp->outtype = OUTT_MAN; |
else if (0 == strcmp(arg, "html")) |
else if (0 == strcmp(arg, "html")) |
curp->outtype = OUTT_HTML; |
curp->outtype = OUTT_HTML; |
else if (0 == strcmp(arg, "xhtml")) |
else if (0 == strcmp(arg, "markdown")) |
curp->outtype = OUTT_XHTML; |
curp->outtype = OUTT_MARKDOWN; |
|
else if (0 == strcmp(arg, "utf8")) |
|
curp->outtype = OUTT_UTF8; |
|
else if (0 == strcmp(arg, "locale")) |
|
curp->outtype = OUTT_LOCALE; |
else if (0 == strcmp(arg, "ps")) |
else if (0 == strcmp(arg, "ps")) |
curp->outtype = OUTT_PS; |
curp->outtype = OUTT_PS; |
else if (0 == strcmp(arg, "pdf")) |
else if (0 == strcmp(arg, "pdf")) |
curp->outtype = OUTT_PDF; |
curp->outtype = OUTT_PDF; |
else { |
else { |
fprintf(stderr, "%s: Bad argument\n", arg); |
warnx("-T %s: Bad argument", arg); |
return(0); |
return 0; |
} |
} |
|
|
return(1); |
return 1; |
} |
} |
|
|
static int |
static int |
woptions(struct curparse *curp, char *arg) |
woptions(struct curparse *curp, char *arg) |
{ |
{ |
char *v, *o; |
char *v, *o; |
const char *toks[6]; |
const char *toks[11]; |
|
|
toks[0] = "stop"; |
toks[0] = "stop"; |
toks[1] = "all"; |
toks[1] = "all"; |
toks[2] = "warning"; |
toks[2] = "base"; |
toks[3] = "error"; |
toks[3] = "style"; |
toks[4] = "fatal"; |
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) { |
o = arg; |
o = arg; |
switch (getsubopt(&arg, UNCONST(toks), &v)) { |
switch (getsubopt(&arg, (char * const *)toks, &v)) { |
case (0): |
case 0: |
curp->wstop = 1; |
curp->wstop = 1; |
break; |
break; |
case (1): |
case 1: |
/* FALLTHROUGH */ |
case 2: |
case (2): |
mandoc_msg_setmin(MANDOCERR_BASE); |
curp->wlevel = MANDOCLEVEL_WARNING; |
|
break; |
break; |
case (3): |
case 3: |
curp->wlevel = MANDOCLEVEL_ERROR; |
mandoc_msg_setmin(MANDOCERR_STYLE); |
break; |
break; |
case (4): |
case 4: |
curp->wlevel = MANDOCLEVEL_FATAL; |
mandoc_msg_setmin(MANDOCERR_WARNING); |
break; |
break; |
|
case 5: |
|
mandoc_msg_setmin(MANDOCERR_ERROR); |
|
break; |
|
case 6: |
|
mandoc_msg_setmin(MANDOCERR_UNSUPP); |
|
break; |
|
case 7: |
|
mandoc_msg_setmin(MANDOCERR_MAX); |
|
break; |
|
case 8: |
|
mandoc_msg_setmin(MANDOCERR_BASE); |
|
curp->os_e = MANDOC_OS_OPENBSD; |
|
break; |
|
case 9: |
|
mandoc_msg_setmin(MANDOCERR_BASE); |
|
curp->os_e = MANDOC_OS_NETBSD; |
|
break; |
default: |
default: |
fprintf(stderr, "-W%s: Bad argument\n", o); |
warnx("-W %s: Bad argument", o); |
return(0); |
return 0; |
} |
} |
} |
} |
|
return 1; |
return(1); |
|
} |
} |
|
|
static int |
static pid_t |
mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg) |
spawn_pager(struct tag_files *tag_files) |
{ |
{ |
struct curparse *cp; |
const struct timespec timeout = { 0, 100000000 }; /* 0.1s */ |
enum mandoclevel level; |
#define MAX_PAGER_ARGS 16 |
|
char *argv[MAX_PAGER_ARGS]; |
|
const char *pager; |
|
char *cp; |
|
size_t cmdlen; |
|
int argc, use_ofn; |
|
pid_t pager_pid; |
|
|
level = MANDOCLEVEL_FATAL; |
pager = getenv("MANPAGER"); |
while (t < mandoclimits[level]) |
if (pager == NULL || *pager == '\0') |
/* LINTED */ |
pager = getenv("PAGER"); |
level--; |
if (pager == NULL || *pager == '\0') |
|
pager = "more -s"; |
|
cp = mandoc_strdup(pager); |
|
|
cp = (struct curparse *)arg; |
/* |
if (level < cp->wlevel) |
* Parse the pager command into words. |
return(1); |
* Intentionally do not do anything fancy here. |
|
*/ |
|
|
fprintf(stderr, "%s:%d:%d: %s: %s", |
argc = 0; |
cp->file, ln, col + 1, mandoclevels[level], mandocerrs[t]); |
while (argc + 5 < MAX_PAGER_ARGS) { |
if (msg) |
argv[argc++] = cp; |
fprintf(stderr, ": %s", msg); |
cp = strchr(cp, ' '); |
fputc('\n', stderr); |
if (cp == NULL) |
|
break; |
|
*cp++ = '\0'; |
|
while (*cp == ' ') |
|
cp++; |
|
if (*cp == '\0') |
|
break; |
|
} |
|
|
if (file_status < level) |
/* For less(1), use the tag file. */ |
file_status = level; |
|
|
use_ofn = 1; |
return(level < MANDOCLEVEL_FATAL); |
if ((cmdlen = strlen(argv[0])) >= 4) { |
|
cp = argv[0] + cmdlen - 4; |
|
if (strcmp(cp, "less") == 0) { |
|
argv[argc++] = mandoc_strdup("-T"); |
|
argv[argc++] = tag_files->tfn; |
|
if (tag_files->tagname != NULL) { |
|
argv[argc++] = mandoc_strdup("-t"); |
|
argv[argc++] = tag_files->tagname; |
|
use_ofn = 0; |
|
} |
|
} |
|
} |
|
if (use_ofn) |
|
argv[argc++] = tag_files->ofn; |
|
argv[argc] = NULL; |
|
|
|
switch (pager_pid = fork()) { |
|
case -1: |
|
err((int)MANDOCLEVEL_SYSERR, "fork"); |
|
case 0: |
|
break; |
|
default: |
|
(void)setpgid(pager_pid, 0); |
|
(void)tcsetpgrp(tag_files->ofd, pager_pid); |
|
#if HAVE_PLEDGE |
|
if (pledge("stdio rpath tmppath tty proc", NULL) == -1) |
|
err((int)MANDOCLEVEL_SYSERR, "pledge"); |
|
#endif |
|
tag_files->pager_pid = pager_pid; |
|
return pager_pid; |
|
} |
|
|
|
/* The child process becomes the pager. */ |
|
|
|
if (dup2(tag_files->ofd, STDOUT_FILENO) == -1) |
|
err((int)MANDOCLEVEL_SYSERR, "pager stdout"); |
|
close(tag_files->ofd); |
|
assert(tag_files->tfd == -1); |
|
|
|
/* Do not start the pager before controlling the terminal. */ |
|
|
|
while (tcgetpgrp(STDOUT_FILENO) != getpid()) |
|
nanosleep(&timeout, NULL); |
|
|
|
execvp(argv[0], argv); |
|
err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]); |
} |
} |