version 1.341, 2020/01/20 10:37:15 |
version 1.352, 2020/07/21 15:10:01 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
|
* Copyright (c) 2010-2012, 2014-2020 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2010-2012, 2014-2019 Ingo Schwarze <schwarze@openbsd.org> |
|
* Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.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 |
|
|
* 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 "config.h" |
|
|
|
|
#include "man.h" |
#include "man.h" |
#include "mandoc_parse.h" |
#include "mandoc_parse.h" |
#include "tag.h" |
#include "tag.h" |
|
#include "term_tag.h" |
#include "main.h" |
#include "main.h" |
#include "manconf.h" |
#include "manconf.h" |
#include "mansearch.h" |
#include "mansearch.h" |
Line 98 static int fs_lookup(const struct manpaths *, |
|
Line 101 static int fs_lookup(const struct manpaths *, |
|
static int fs_search(const struct mansearch *, |
static int fs_search(const struct mansearch *, |
const struct manpaths *, const char *, |
const struct manpaths *, const char *, |
struct manpage **, size_t *); |
struct manpage **, size_t *); |
|
static void glob_esc(char **, const char *, const char *); |
static void outdata_alloc(struct outstate *, struct manoutput *); |
static void outdata_alloc(struct outstate *, struct manoutput *); |
static void parse(struct mparse *, int, const char *, |
static void parse(struct mparse *, int, const char *, |
struct outstate *, struct manoutput *); |
struct outstate *, struct manoutput *); |
static void passthrough(int, int); |
static void passthrough(int, int); |
static void process_onefile(struct mparse *, struct manpage *, |
static void process_onefile(struct mparse *, struct manpage *, |
int, struct outstate *, struct manconf *); |
int, struct outstate *, struct manconf *); |
static void run_pager(struct tag_files *); |
static void run_pager(struct outstate *, char *); |
static pid_t spawn_pager(struct tag_files *); |
static pid_t spawn_pager(struct outstate *, char *); |
static void usage(enum argmode) __attribute__((__noreturn__)); |
static void usage(enum argmode) __attribute__((__noreturn__)); |
static int woptions(char *, enum mandoc_os *, int *); |
static int woptions(char *, enum mandoc_os *, int *); |
|
|
Line 161 main(int argc, char *argv[]) |
|
Line 165 main(int argc, char *argv[]) |
|
return mandocdb(argc, argv); |
return mandocdb(argc, argv); |
|
|
#if HAVE_PLEDGE |
#if HAVE_PLEDGE |
if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1) { |
if (pledge("stdio rpath wpath cpath tmppath tty proc exec", NULL) == -1) { |
mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno)); |
mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno)); |
return mandoc_msg_getrc(); |
return mandoc_msg_getrc(); |
} |
} |
Line 326 main(int argc, char *argv[]) |
|
Line 330 main(int argc, char *argv[]) |
|
|
|
/* Postprocess options. */ |
/* Postprocess options. */ |
|
|
if (outmode == OUTMODE_DEF) { |
switch (outmode) { |
|
case OUTMODE_DEF: |
switch (search.argmode) { |
switch (search.argmode) { |
case ARG_FILE: |
case ARG_FILE: |
outmode = OUTMODE_ALL; |
outmode = OUTMODE_ALL; |
Line 339 main(int argc, char *argv[]) |
|
Line 344 main(int argc, char *argv[]) |
|
outmode = OUTMODE_LST; |
outmode = OUTMODE_LST; |
break; |
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(); |
} |
} |
|
|
if (oarg != NULL) { |
if (oarg != NULL) { |
Line 358 main(int argc, char *argv[]) |
|
Line 373 main(int argc, char *argv[]) |
|
|
|
if (outmode == OUTMODE_FLN || |
if (outmode == OUTMODE_FLN || |
outmode == OUTMODE_LST || |
outmode == OUTMODE_LST || |
!isatty(STDOUT_FILENO)) |
(conf.output.outfilename == NULL && |
|
conf.output.tagfilename == NULL && |
|
isatty(STDOUT_FILENO) == 0)) |
outst.use_pager = 0; |
outst.use_pager = 0; |
|
|
if (outst.use_pager && |
if (outst.use_pager && |
Line 372 main(int argc, char *argv[]) |
|
Line 389 main(int argc, char *argv[]) |
|
} |
} |
|
|
#if HAVE_PLEDGE |
#if HAVE_PLEDGE |
if (outst.use_pager == 0) { |
if (outst.use_pager == 0) |
if (pledge("stdio rpath", NULL) == -1) { |
c = pledge("stdio rpath", NULL); |
mandoc_msg(MANDOCERR_PLEDGE, 0, 0, |
else if (conf.output.outfilename != NULL || |
"%s", strerror(errno)); |
conf.output.tagfilename != NULL) |
return mandoc_msg_getrc(); |
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 |
#endif |
|
|
Line 437 main(int argc, char *argv[]) |
|
Line 458 main(int argc, char *argv[]) |
|
/* man(1): Resolve each name individually. */ |
/* man(1): Resolve each name individually. */ |
|
|
if (search.argmode == ARG_NAME) { |
if (search.argmode == ARG_NAME) { |
if (argc < 1) |
if (argc < 1) { |
usage(ARG_NAME); |
if (outmode != OUTMODE_FLN) |
|
usage(ARG_NAME); |
|
if (conf.manpath.sz == 0) { |
|
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++) { |
for (res = NULL, ressz = 0; argc > 0; argc--, argv++) { |
(void)mansearch(&search, &conf.manpath, |
(void)mansearch(&search, &conf.manpath, |
1, argv, &resn, &resnsz); |
1, argv, &resn, &resnsz); |
Line 574 main(int argc, char *argv[]) |
|
Line 607 main(int argc, char *argv[]) |
|
* readable: Maybe it won't be needed after all. |
* readable: Maybe it won't be needed after all. |
*/ |
*/ |
startdir = open(".", O_RDONLY | O_DIRECTORY); |
startdir = open(".", O_RDONLY | O_DIRECTORY); |
|
|
for (i = 0; i < ressz; i++) { |
for (i = 0; i < ressz; i++) { |
process_onefile(mp, res + i, startdir, &outst, &conf); |
process_onefile(mp, res + i, startdir, &outst, &conf); |
if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK) |
if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK) |
Line 584 main(int argc, char *argv[]) |
|
Line 616 main(int argc, char *argv[]) |
|
(void)fchdir(startdir); |
(void)fchdir(startdir); |
close(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) { |
if (outst.outdata != NULL) { |
switch (outst.outtype) { |
switch (outst.outtype) { |
case OUTT_HTML: |
case OUTT_HTML: |
|
|
manconf_free(&conf); |
manconf_free(&conf); |
|
|
if (outst.tag_files != NULL) { |
if (outst.tag_files != NULL) { |
fclose(stdout); |
if (term_tag_close() != -1 && |
tag_write(); |
conf.output.outfilename == NULL && |
run_pager(outst.tag_files); |
conf.output.tagfilename == NULL) |
tag_unlink(); |
run_pager(&outst, conf.output.tag); |
|
term_tag_unlink(); |
} else if (outst.had_output && outst.outtype != OUTT_LINT) |
} else if (outst.had_output && outst.outtype != OUTT_LINT) |
mandoc_msg_summary(); |
mandoc_msg_summary(); |
|
|
Line 651 usage(enum argmode argmode) |
|
Line 687 usage(enum argmode argmode) |
|
exit((int)MANDOCLEVEL_BADARG); |
exit((int)MANDOCLEVEL_BADARG); |
} |
} |
|
|
|
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 int |
static int |
fs_lookup(const struct manpaths *paths, size_t ipath, |
fs_lookup(const struct manpaths *paths, size_t ipath, |
const char *sec, const char *arch, const char *name, |
const char *sec, const char *arch, const char *name, |
Line 659 fs_lookup(const struct manpaths *paths, size_t ipath, |
|
Line 707 fs_lookup(const struct manpaths *paths, size_t ipath, |
|
struct stat sb; |
struct stat sb; |
glob_t globinfo; |
glob_t globinfo; |
struct manpage *page; |
struct manpage *page; |
char *file; |
char *file, *cp; |
int globres; |
int globres; |
enum form form; |
enum form form; |
|
|
|
const char *const slman = "/man"; |
|
const char *const slash = "/"; |
|
const char *const sglob = ".[01-9]*"; |
|
|
form = FORM_SRC; |
form = FORM_SRC; |
mandoc_asprintf(&file, "%s/man%s/%s.%s", |
mandoc_asprintf(&file, "%s/man%s/%s.%s", |
paths->paths[ipath], sec, name, sec); |
paths->paths[ipath], sec, name, sec); |
Line 686 fs_lookup(const struct manpaths *paths, size_t ipath, |
|
Line 738 fs_lookup(const struct manpaths *paths, size_t ipath, |
|
free(file); |
free(file); |
} |
} |
|
|
mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*", |
cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 + |
paths->paths[ipath], sec, name); |
strlen(slman) + strlen(sec) * 2 + strlen(slash) + |
|
strlen(name) * 2 + strlen(sglob) + 1); |
|
glob_esc(&cp, paths->paths[ipath], slman); |
|
glob_esc(&cp, sec, slash); |
|
glob_esc(&cp, name, sglob); |
|
*cp = '\0'; |
globres = glob(file, 0, NULL, &globinfo); |
globres = glob(file, 0, NULL, &globinfo); |
if (globres != 0 && globres != GLOB_NOMATCH) |
if (globres != 0 && globres != GLOB_NOMATCH) |
mandoc_msg(MANDOCERR_GLOB, 0, 0, |
mandoc_msg(MANDOCERR_GLOB, 0, 0, |
Line 788 process_onefile(struct mparse *mp, struct manpage *res |
|
Line 845 process_onefile(struct mparse *mp, struct manpage *res |
|
|
|
if (outst->use_pager) { |
if (outst->use_pager) { |
outst->use_pager = 0; |
outst->use_pager = 0; |
outst->tag_files = tag_init(conf->output.tag); |
outst->tag_files = term_tag_init(conf->output.outfilename, |
|
conf->output.tagfilename); |
|
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()); |
|
} |
} |
} |
|
|
if (outst->had_output && outst->outtype <= OUTT_UTF8) { |
if (outst->had_output && outst->outtype <= OUTT_UTF8) { |
if (outst->outdata == NULL) |
if (outst->outdata == NULL) |
outdata_alloc(outst, &conf->output); |
outdata_alloc(outst, &conf->output); |
Line 808 process_onefile(struct mparse *mp, struct manpage *res |
|
Line 872 process_onefile(struct mparse *mp, struct manpage *res |
|
if (outst->tag_files != NULL) { |
if (outst->tag_files != NULL) { |
mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s", |
mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s", |
outst->tag_files->ofn, strerror(errno)); |
outst->tag_files->ofn, strerror(errno)); |
tag_unlink(); |
term_tag_unlink(); |
outst->tag_files = NULL; |
outst->tag_files = NULL; |
} else |
} else |
mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s", |
mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s", |
Line 848 parse(struct mparse *mp, int fd, const char *file, |
|
Line 912 parse(struct mparse *mp, int fd, const char *file, |
|
if (outst->outdata == NULL) |
if (outst->outdata == NULL) |
outdata_alloc(outst, outconf); |
outdata_alloc(outst, outconf); |
else if (outst->outtype == OUTT_HTML) |
else if (outst->outtype == OUTT_HTML) |
html_reset(outst); |
html_reset(outst->outdata); |
|
|
mandoc_xr_reset(); |
mandoc_xr_reset(); |
meta = mparse_result(mp); |
meta = mparse_result(mp); |
Line 903 parse(struct mparse *mp, int fd, const char *file, |
|
Line 967 parse(struct mparse *mp, int fd, const char *file, |
|
break; |
break; |
} |
} |
} |
} |
|
if (outconf->tag != NULL && outconf->tag_found == 0 && |
|
tag_exists(outconf->tag)) |
|
outconf->tag_found = 1; |
if (mandoc_msg_getmin() < MANDOCERR_STYLE) |
if (mandoc_msg_getmin() < MANDOCERR_STYLE) |
check_xr(); |
check_xr(); |
} |
} |
Line 1093 woptions(char *arg, enum mandoc_os *os_e, int *wstop) |
|
Line 1160 woptions(char *arg, enum mandoc_os *os_e, int *wstop) |
|
* then fork the pager and wait for the user to close it. |
* then fork the pager and wait for the user to close it. |
*/ |
*/ |
static void |
static void |
run_pager(struct tag_files *tag_files) |
run_pager(struct outstate *outst, char *tag_target) |
{ |
{ |
int signum, status; |
int signum, status; |
pid_t man_pgid, tc_pgid; |
pid_t man_pgid, tc_pgid; |
pid_t pager_pid, wait_pid; |
pid_t pager_pid, wait_pid; |
|
|
man_pgid = getpgid(0); |
man_pgid = getpgid(0); |
tag_files->tcpgid = man_pgid == getpid() ? getpgid(getppid()) : |
outst->tag_files->tcpgid = |
man_pgid; |
man_pgid == getpid() ? getpgid(getppid()) : man_pgid; |
pager_pid = 0; |
pager_pid = 0; |
signum = SIGSTOP; |
signum = SIGSTOP; |
|
|
for (;;) { |
for (;;) { |
/* Stop here until moved to the foreground. */ |
/* Stop here until moved to the foreground. */ |
|
|
tc_pgid = tcgetpgrp(tag_files->ofd); |
tc_pgid = tcgetpgrp(STDOUT_FILENO); |
if (tc_pgid != man_pgid) { |
if (tc_pgid != man_pgid) { |
if (tc_pgid == pager_pid) { |
if (tc_pgid == pager_pid) { |
(void)tcsetpgrp(tag_files->ofd, man_pgid); |
(void)tcsetpgrp(STDOUT_FILENO, man_pgid); |
if (signum == SIGTTIN) |
if (signum == SIGTTIN) |
continue; |
continue; |
} else |
} else |
tag_files->tcpgid = tc_pgid; |
outst->tag_files->tcpgid = tc_pgid; |
kill(0, signum); |
kill(0, signum); |
continue; |
continue; |
} |
} |
Line 1123 run_pager(struct tag_files *tag_files) |
|
Line 1190 run_pager(struct tag_files *tag_files) |
|
/* Once in the foreground, activate the pager. */ |
/* Once in the foreground, activate the pager. */ |
|
|
if (pager_pid) { |
if (pager_pid) { |
(void)tcsetpgrp(tag_files->ofd, pager_pid); |
(void)tcsetpgrp(STDOUT_FILENO, pager_pid); |
kill(pager_pid, SIGCONT); |
kill(pager_pid, SIGCONT); |
} else |
} else |
pager_pid = spawn_pager(tag_files); |
pager_pid = spawn_pager(outst, tag_target); |
|
|
/* Wait for the pager to stop or exit. */ |
/* Wait for the pager to stop or exit. */ |
|
|
Line 1147 run_pager(struct tag_files *tag_files) |
|
Line 1214 run_pager(struct tag_files *tag_files) |
|
} |
} |
|
|
static pid_t |
static pid_t |
spawn_pager(struct tag_files *tag_files) |
spawn_pager(struct outstate *outst, char *tag_target) |
{ |
{ |
const struct timespec timeout = { 0, 100000000 }; /* 0.1s */ |
const struct timespec timeout = { 0, 100000000 }; /* 0.1s */ |
#define MAX_PAGER_ARGS 16 |
#define MAX_PAGER_ARGS 16 |
Line 1160 spawn_pager(struct tag_files *tag_files) |
|
Line 1227 spawn_pager(struct tag_files *tag_files) |
|
int argc, use_ofn; |
int argc, use_ofn; |
pid_t pager_pid; |
pid_t pager_pid; |
|
|
|
assert(outst->tag_files->ofd == -1); |
|
assert(outst->tag_files->tfs == NULL); |
|
|
pager = getenv("MANPAGER"); |
pager = getenv("MANPAGER"); |
if (pager == NULL || *pager == '\0') |
if (pager == NULL || *pager == '\0') |
pager = getenv("PAGER"); |
pager = getenv("PAGER"); |
if (pager == NULL || *pager == '\0') |
if (pager == NULL || *pager == '\0') |
pager = "more -s"; |
pager = BINM_PAGER; |
cp = mandoc_strdup(pager); |
cp = mandoc_strdup(pager); |
|
|
/* |
/* |
Line 1189 spawn_pager(struct tag_files *tag_files) |
|
Line 1259 spawn_pager(struct tag_files *tag_files) |
|
|
|
use_ofn = 1; |
use_ofn = 1; |
#if HAVE_LESS_T |
#if HAVE_LESS_T |
if (*tag_files->tfn != '\0' && (cmdlen = strlen(argv[0])) >= 4) { |
if (*outst->tag_files->tfn != '\0' && |
|
(cmdlen = strlen(argv[0])) >= 4) { |
cp = argv[0] + cmdlen - 4; |
cp = argv[0] + cmdlen - 4; |
if (strcmp(cp, "less") == 0) { |
if (strcmp(cp, "less") == 0) { |
argv[argc++] = mandoc_strdup("-T"); |
argv[argc++] = mandoc_strdup("-T"); |
argv[argc++] = tag_files->tfn; |
argv[argc++] = outst->tag_files->tfn; |
if (tag_files->tagname != NULL) { |
if (tag_target != NULL) { |
argv[argc++] = mandoc_strdup("-t"); |
argv[argc++] = mandoc_strdup("-t"); |
argv[argc++] = tag_files->tagname; |
argv[argc++] = tag_target; |
use_ofn = 0; |
use_ofn = 0; |
} |
} |
} |
} |
} |
} |
#endif |
#endif |
if (use_ofn) |
if (use_ofn) { |
argv[argc++] = tag_files->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] = outst->tag_files->ofn; |
|
argc++; |
|
} |
argv[argc] = NULL; |
argv[argc] = NULL; |
|
|
switch (pager_pid = fork()) { |
switch (pager_pid = fork()) { |
Line 1214 spawn_pager(struct tag_files *tag_files) |
|
Line 1291 spawn_pager(struct tag_files *tag_files) |
|
break; |
break; |
default: |
default: |
(void)setpgid(pager_pid, 0); |
(void)setpgid(pager_pid, 0); |
(void)tcsetpgrp(tag_files->ofd, pager_pid); |
(void)tcsetpgrp(STDOUT_FILENO, pager_pid); |
#if HAVE_PLEDGE |
#if HAVE_PLEDGE |
if (pledge("stdio rpath tmppath tty proc", NULL) == -1) { |
if (pledge("stdio rpath tmppath tty proc", NULL) == -1) { |
mandoc_msg(MANDOCERR_PLEDGE, 0, 0, |
mandoc_msg(MANDOCERR_PLEDGE, 0, 0, |
Line 1222 spawn_pager(struct tag_files *tag_files) |
|
Line 1299 spawn_pager(struct tag_files *tag_files) |
|
exit(mandoc_msg_getrc()); |
exit(mandoc_msg_getrc()); |
} |
} |
#endif |
#endif |
tag_files->pager_pid = pager_pid; |
outst->tag_files->pager_pid = pager_pid; |
return pager_pid; |
return pager_pid; |
} |
} |
|
|
/* The child process becomes the pager. */ |
/* |
|
* The child process becomes the pager. |
if (dup2(tag_files->ofd, STDOUT_FILENO) == -1) { |
* Do not start it before controlling the terminal. |
mandoc_msg(MANDOCERR_DUP, 0, 0, "%s", strerror(errno)); |
*/ |
_exit(mandoc_msg_getrc()); |
|
} |
|
close(tag_files->ofd); |
|
assert(tag_files->tfd == -1); |
|
|
|
/* Do not start the pager before controlling the terminal. */ |
|
|
|
while (tcgetpgrp(STDOUT_FILENO) != getpid()) |
while (tcgetpgrp(STDOUT_FILENO) != getpid()) |
nanosleep(&timeout, NULL); |
nanosleep(&timeout, NULL); |