mandoc/main.c - diff

Return to main.c CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/main.c between version 1.218 and 1.241

version 1.218, 2015/02/03 21:16:02

version 1.241, 2015/07/19 00:07:42

Line 8

* purpose with or without fee is hereby granted, provided that the above

* 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

* 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

* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN

* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF

Line 20

#include <sys/types.h>

#include <sys/param.h> /* MACHINE */

#include <sys/wait.h>

#include <assert.h>

#include <ctype.h>

#include <errno.h>

#include <fcntl.h>

#include <glob.h>

#include <signal.h>

#include <stdio.h>

#include <stdint.h>

#include <stdlib.h>

#include <string.h>

#include <unistd.h>

#include "mandoc.h"

#include "mandoc_aux.h"

#include "main.h"

#include "mandoc.h"

#include "roff.h"

#include "mdoc.h"

#include "man.h"

#include "manpath.h"

#include "tag.h"

#include "main.h"

#include "manconf.h"

#include "mansearch.h"

#if !defined(__GNUC__) || (__GNUC__ < 2)

Line 54 enum outmode {

Line 59 enum outmode {

OUTMODE_ONE

};

typedef void (*out_mdoc)(void *, const struct mdoc *);

typedef void (*out_mdoc)(void *, const struct roff_man *);

typedef void (*out_man)(void *, const struct man *);

typedef void (*out_man)(void *, const struct roff_man *);

typedef void (*out_free)(void *);

enum outt {

Line 80 struct curparse {

Line 85 struct curparse {

out_man outman; /* man output ptr */

out_free outfree; /* free output ptr */

void *outdata; /* data for output */

char outopts[BUFSIZ]; /* buf of output opts */

struct manoutput *outopts; /* output options */

};

static int fs_lookup(const struct manpaths *,

Line 90 static int fs_lookup(const struct manpaths *,

Line 95 static int fs_lookup(const struct manpaths *,

static void fs_search(const struct mansearch *,

const struct manpaths *, int, char**,

struct manpage **, size_t *);

static void handle_sigpipe(int);

static int koptions(int *, char *);

#if HAVE_SQLITE3

int mandocdb(int, char**);

Line 97 int mandocdb(int, char**);

Line 103 int mandocdb(int, char**);

static int moptions(int *, char *);

static void mmsg(enum mandocerr, enum mandoclevel,

const char *, int, int, const char *);

static void parse(struct curparse *, int,

static void parse(struct curparse *, int, const char *);

const char *, enum mandoclevel *);

static void passthrough(const char *, int, int);

static enum mandoclevel passthrough(const char *, int, int);

static pid_t spawn_pager(void);

static void spawn_pager(void);

static int toptions(struct curparse *, char *);

static void usage(enum argmode) __attribute__((noreturn));

static void version(void) __attribute__((noreturn));

static int woptions(struct curparse *, char *);

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};

static const char *progname;

static enum mandoclevel rc;

int

main(int argc, char *argv[])

{

struct manconf conf;

struct curparse curp;

struct mansearch search;

struct manpaths paths;

char *auxpaths;

char *defos;

unsigned char *uc;

struct manpage *res, *resp;

char *conf_file, *defpaths;

size_t isec, i, sz;

int prio, best_prio, synopsis_only;

int prio, best_prio;

char sec;

enum mandoclevel rc, rctmp;

enum mandoclevel rctmp;

enum outmode outmode;

int fd;

int show_usage;

int use_pager;

int options;

int c;

pid_t pager_pid; /* 0: don't use; 1: not yet spawned. */

progname = strrchr(argv[0], '/');

if (argc < 1)

if (progname == NULL)

progname = "mandoc";

else if ((progname = strrchr(argv[0], '/')) == NULL)

progname = argv[0];

else

++progname;

Line 147 main(int argc, char *argv[])

Line 153 main(int argc, char *argv[])

/* Search options. */

memset(&paths, 0, sizeof(struct manpaths));

memset(&conf, 0, sizeof(conf));

conf_file = defpaths = NULL;

auxpaths = NULL;

Line 170 main(int argc, char *argv[])

Line 176 main(int argc, char *argv[])

memset(&curp, 0, sizeof(struct curparse));

curp.outtype = OUTT_LOCALE;

curp.wlevel = MANDOCLEVEL_BADARG;

curp.outopts = &conf.output;

options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;

defos = NULL;

use_pager = 1;

pager_pid = 1;

show_usage = 0;

synopsis_only = 0;

outmode = OUTMODE_DEF;

while (-1 != (c = getopt(argc, argv,

Line 188 main(int argc, char *argv[])

Line 194 main(int argc, char *argv[])

conf_file = optarg;

break;

case 'c':

use_pager = 0;

pager_pid = 0;

break;

case 'f':

search.argmode = ARG_WORD;

break;

case 'h':

(void)strlcat(curp.outopts, "synopsis,", BUFSIZ);

conf.output.synopsisonly = 1;

synopsis_only = 1;

pager_pid = 0;

use_pager = 0;

outmode = OUTMODE_ALL;

break;

case 'I':

Line 236 main(int argc, char *argv[])

Line 241 main(int argc, char *argv[])

break;

case 'O':

search.outkey = optarg;

(void)strlcat(curp.outopts, optarg, BUFSIZ);

while (optarg != NULL)

(void)strlcat(curp.outopts, ",", BUFSIZ);

manconf_output(&conf.output,

strsep(&optarg, ","));

break;

case 'S':

search.arch = optarg;

Line 256 main(int argc, char *argv[])

Line 262 main(int argc, char *argv[])

case 'w':

outmode = OUTMODE_FLN;

break;

case 'V':

version();

/* NOTREACHED */

default:

show_usage = 1;

break;

Line 274 main(int argc, char *argv[])

Line 277 main(int argc, char *argv[])

switch (search.argmode) {

case ARG_FILE:

outmode = OUTMODE_ALL;

use_pager = 0;

pager_pid = 0;

break;

case ARG_NAME:

outmode = OUTMODE_ONE;

Line 287 main(int argc, char *argv[])

Line 290 main(int argc, char *argv[])

/* Parse arguments. */

argc -= optind;

if (argc > 0) {

argv += optind;

argc -= optind;

argv += optind;

}

resp = NULL;

Line 303 main(int argc, char *argv[])

Line 308 main(int argc, char *argv[])

argc = 1;

}

} else if (argc > 1 &&

((uc = argv[0]) != NULL) &&

((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 = uc;

search.sec = (char *)uc;

argv++;

argc--;

}

if (search.arch == NULL)

search.arch = getenv("MACHINE");

#ifdef MACHINE

if (search.arch == NULL)

search.arch = MACHINE;

#endif

}

rc = MANDOCLEVEL_OK;

Line 331 main(int argc, char *argv[])

Line 338 main(int argc, char *argv[])

/* Access the mandoc database. */

manpath_parse(&paths, conf_file, defpaths, auxpaths);

manconf_parse(&conf, conf_file, defpaths, auxpaths);

#if HAVE_SQLITE3

mansearch_setup(1);

if( ! mansearch(&search, &paths, argc, argv, &res, &sz))

if ( ! mansearch(&search, &conf.manpath,

argc, argv, &res, &sz))

usage(search.argmode);

#else

if (search.argmode != ARG_NAME) {

Line 345 main(int argc, char *argv[])

Line 353 main(int argc, char *argv[])

sz = 0;

#endif

if (sz == 0 && search.argmode == ARG_NAME)

if (sz == 0) {

fs_search(&search, &paths, argc, argv, &res, &sz);

if (search.argmode == ARG_NAME)

fs_search(&search, &conf.manpath,

argc, argv, &res, &sz);

else

fprintf(stderr,

"%s: nothing appropriate\n",

progname);

}

if (sz == 0) {

rc = MANDOCLEVEL_BADARG;

Line 404 main(int argc, char *argv[])

Line 419 main(int argc, char *argv[])

if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths))

return((int)MANDOCLEVEL_BADARG);

if (pager_pid == 1 && isatty(STDOUT_FILENO) == 0)

pager_pid = 0;

curp.mchars = mchars_alloc();

curp.mp = mparse_alloc(options, curp.wlevel, mmsg,

curp.mchars, defos);

Line 414 main(int argc, char *argv[])

Line 432 main(int argc, char *argv[])

if (OUTT_MAN == curp.outtype)

mparse_keep(curp.mp);

if (argc == 0) {

if (argc < 1) {

if (use_pager && isatty(STDOUT_FILENO))

if (pager_pid == 1)

spawn_pager();

pager_pid = spawn_pager();

parse(&curp, STDIN_FILENO, "<stdin>", &rc);

parse(&curp, STDIN_FILENO, "<stdin>");

}

while (argc) {

while (argc > 0) {

rctmp = mparse_open(curp.mp, &fd,

resp != NULL ? resp->file : *argv);

if (rc < rctmp)

rc = rctmp;

if (fd != -1) {

if (use_pager && isatty(STDOUT_FILENO))

if (pager_pid == 1)

spawn_pager();

pager_pid = spawn_pager();

use_pager = 0;

if (resp == NULL)

parse(&curp, fd, *argv, &rc);

parse(&curp, fd, *argv);

else if (resp->form & FORM_SRC) {

/* For .so only; ignore failure. */

chdir(paths.paths[resp->ipath]);

chdir(conf.manpath.paths[resp->ipath]);

parse(&curp, fd, resp->file, &rc);

parse(&curp, fd, resp->file);

} else {

} else

rctmp = passthrough(resp->file, fd,

passthrough(resp->file, fd,

synopsis_only);

conf.output.synopsisonly);

if (rc < rctmp)

rc = rctmp;

}

rctmp = mparse_wait(curp.mp);

if (rc < rctmp)

Line 470 main(int argc, char *argv[])

Line 484 main(int argc, char *argv[])

out:

if (search.argmode != ARG_FILE) {

manpath_free(&paths);

manconf_free(&conf);

#if HAVE_SQLITE3

mansearch_free(res, sz);

mansearch_setup(0);

Line 479 out:

Line 493 out:

free(defos);

return((int)rc);

}

* If a pager is attached, flush the pipe leading to it

* and signal end of file such that the user can browse

* to the end. Then wait for the user to close the pager.

static void

if (pager_pid != 0 && pager_pid != 1) {

version(void)

fclose(stdout);

{

tag_write();

waitpid(pager_pid, NULL, 0);

tag_unlink();

}

printf("mandoc %s\n", VERSION);

return((int)rc);

exit((int)MANDOCLEVEL_OK);

}

static void

Line 496 usage(enum argmode argmode)

Line 515 usage(enum argmode argmode)

switch (argmode) {

case ARG_FILE:

fputs("usage: mandoc [-acfhklV] [-Ios=name] "

fputs("usage: mandoc [-acfhkl] [-I os=name] "

"[-Kencoding] [-mformat] [-Ooption]\n"

"[-K encoding] [-mformat] [-O option]\n"

"\t [-Toutput] [-Wlevel] [file ...]\n", stderr);

"\t [-T output] [-W level] [file ...]\n", stderr);

break;

case ARG_NAME:

fputs("usage: man [-acfhklVw] [-C file] [-I os=name] "

fputs("usage: man [-acfhklw] [-C file] [-I os=name] "

"[-K encoding] [-M path] [-m path]\n"

"\t [-O option=value] [-S subsection] [-s section] "

"[-T output] [-W level]\n"

"\t [section] name ...\n", stderr);

break;

case ARG_WORD:

fputs("usage: whatis [-acfhklVw] [-C file] "

fputs("usage: whatis [-acfhklw] [-C file] "

"[-M path] [-m path] [-O outkey] [-S arch]\n"

"\t [-s section] name ...\n", stderr);

break;

case ARG_EXPR:

fputs("usage: apropos [-acfhklVw] [-C file] "

fputs("usage: apropos [-acfhklw] [-C file] "

"[-M path] [-m path] [-O outkey] [-S arch]\n"

"\t [-s section] expression ...\n", stderr);

break;

Line 526 fs_lookup(const struct manpaths *paths, size_t ipath,

Line 545 fs_lookup(const struct manpaths *paths, size_t ipath,

const char *sec, const char *arch, const char *name,

struct manpage **res, size_t *ressz)

{

glob_t globinfo;

struct manpage *page;

char *file;

int form;

int form, globres;

form = FORM_SRC;

mandoc_asprintf(&file, "%s/man%s/%s.%s",

paths->paths[ipath], sec, name, sec);

if (access(file, R_OK) != -1) {

if (access(file, R_OK) != -1)

form = FORM_SRC;

goto found;

}

free(file);

mandoc_asprintf(&file, "%s/cat%s/%s.0",

Line 549 fs_lookup(const struct manpaths *paths, size_t ipath,

Line 568 fs_lookup(const struct manpaths *paths, size_t ipath,

if (arch != NULL) {

mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",

paths->paths[ipath], sec, arch, name, sec);

if (access(file, R_OK) != -1) {

if (access(file, R_OK) != -1)

form = FORM_SRC;

goto found;

}

free(file);

}

return(0);

mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",

paths->paths[ipath], sec, name);

globres = glob(file, 0, NULL, &globinfo);

if (globres != 0 && globres != GLOB_NOMATCH)

fprintf(stderr, "%s: %s: glob: %s\n",

progname, file, strerror(errno));

free(file);

if (globres == 0)

file = mandoc_strdup(*globinfo.gl_pathv);

globfree(&globinfo);

if (globres != 0)

return(0);

found:

#if HAVE_SQLITE3

fprintf(stderr, "%s: outdated mandoc.db lacks %s(%s) entry,\n"

fprintf(stderr, "%s: outdated mandoc.db lacks %s(%s) entry, run "

" consider running # makewhatis %s\n",

"makewhatis %s\n", progname, name, sec, paths->paths[ipath]);

progname, name, sec, paths->paths[ipath]);

#endif

*res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));

page = *res + (*ressz - 1);

page->file = file;

Line 614 fs_search(const struct mansearch *cfg, const struct ma

Line 641 fs_search(const struct mansearch *cfg, const struct ma

}

static void

parse(struct curparse *curp, int fd, const char *file,

parse(struct curparse *curp, int fd, const char *file)

enum mandoclevel *level)

{

enum mandoclevel rc;

enum mandoclevel rctmp;

struct mdoc *mdoc;

struct roff_man *man;

struct man *man;

/* Begin by parsing the file itself. */

assert(file);

assert(fd >= -1);

rc = mparse_readfd(curp->mp, fd, file);

rctmp = mparse_readfd(curp->mp, fd, file);

if (rc < rctmp)

rc = rctmp;

* With -Wstop and warnings or errors of at least the requested

* level, do not produce output.

if (MANDOCLEVEL_OK != rc && curp->wstop)

if (rctmp != MANDOCLEVEL_OK && curp->wstop)

goto cleanup;

return;

/* If unset, allocate output dev now (if applicable). */

Line 704 parse(struct curparse *curp, int fd, const char *file,

Line 731 parse(struct curparse *curp, int fd, const char *file,

}

mparse_result(curp->mp, &mdoc, &man, NULL);

mparse_result(curp->mp, &man, NULL);

/* Execute the out device, if it exists. */

if (man && curp->outman)

if (man == NULL)

return;

if (curp->outmdoc != NULL && man->macroset == MACROSET_MDOC)

(*curp->outmdoc)(curp->outdata, man);

if (curp->outman != NULL && man->macroset == MACROSET_MAN)

(*curp->outman)(curp->outdata, man);

if (mdoc && curp->outmdoc)

(*curp->outmdoc)(curp->outdata, mdoc);

cleanup:

if (*level < rc)

*level = rc;

}

static enum mandoclevel

static void

passthrough(const char *file, int fd, int synopsis_only)

{

const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";

Line 776 passthrough(const char *file, int fd, int synopsis_onl

Line 801 passthrough(const char *file, int fd, int synopsis_onl

done:

fclose(stream);

return(MANDOCLEVEL_OK);

return;

fail:

fprintf(stderr, "%s: %s: SYSERR: %s: %s",

progname, file, syscall, strerror(errno));

return(MANDOCLEVEL_SYSERR);

if (rc < MANDOCLEVEL_SYSERR)

rc = MANDOCLEVEL_SYSERR;

}

static int

Line 926 mmsg(enum mandocerr t, enum mandoclevel lvl,

Line 952 mmsg(enum mandocerr t, enum mandoclevel lvl,

}

static void

handle_sigpipe(int signum)

{

exit((int)rc);

}

static pid_t

spawn_pager(void)

{

#define MAX_PAGER_ARGS 16

char *argv[MAX_PAGER_ARGS];

const char *pager;

char *cp;

size_t cmdlen;

int fildes[2];

int argc;

pid_t pager_pid;

pager = getenv("MANPAGER");

if (pager == NULL || *pager == '\0')

pager = getenv("PAGER");

if (pager == NULL || *pager == '\0')

pager = "more -s";

cp = mandoc_strdup(pager);

* Parse the pager command into words.

* Intentionally do not do anything fancy here.

argc = 0;

while (argc + 4 < MAX_PAGER_ARGS) {

argv[argc++] = cp;

cp = strchr(cp, ' ');

if (cp == NULL)

break;

*cp++ = '\0';

while (*cp == ' ')

cp++;

if (*cp == '\0')

break;

}

/* Read all text right away and use the tag file. */

if ((cmdlen = strlen(argv[0])) >= 4) {

cp = argv[0] + cmdlen - 4;

if (strcmp(cp, "less") == 0 ||

strcmp(cp, "more") == 0) {

tag_init();

argv[argc++] = mandoc_strdup("+G1G");

argv[argc++] = mandoc_strdup("-T");

argv[argc++] = tag_filename();

}

argv[argc] = NULL;

if (pipe(fildes) == -1) {

fprintf(stderr, "%s: pipe: %s\n",

progname, strerror(errno));

return;

return(0);

}

switch (fork()) {

switch (pager_pid = fork()) {

case -1:

fprintf(stderr, "%s: fork: %s\n",

progname, strerror(errno));

exit((int)MANDOCLEVEL_SYSERR);

case 0:

break;

default:

close(fildes[0]);

if (dup2(fildes[1], STDOUT_FILENO) == -1) {

fprintf(stderr, "%s: dup output: %s\n",

progname, strerror(errno));

exit((int)MANDOCLEVEL_SYSERR);

}

return;

close(fildes[1]);

default:

signal(SIGPIPE, handle_sigpipe);

break;

return(pager_pid);

}

/* The original process becomes the pager. */

/* The child process becomes the pager. */

close(fildes[1]);

if (dup2(fildes[0], STDIN_FILENO) == -1) {

Line 966 spawn_pager(void)

Line 1042 spawn_pager(void)

progname, strerror(errno));

exit((int)MANDOCLEVEL_SYSERR);

}

close(fildes[0]);

pager = getenv("MANPAGER");

if (pager == NULL || *pager == '\0')

pager = getenv("PAGER");

if (pager == NULL || *pager == '\0')

pager = "/usr/bin/more -s";

cp = mandoc_strdup(pager);

* Parse the pager command into words.

* Intentionally do not do anything fancy here.

argc = 0;

while (argc + 1 < MAX_PAGER_ARGS) {

argv[argc++] = cp;

cp = strchr(cp, ' ');

if (cp == NULL)

break;

*cp++ = '\0';

while (*cp == ' ')

cp++;

if (*cp == '\0')

break;

}

argv[argc] = NULL;

/* Hand over to the pager. */

execvp(argv[0], argv);

fprintf(stderr, "%s: exec: %s\n",

fprintf(stderr, "%s: exec %s: %s\n",

progname, strerror(errno));

progname, argv[0], strerror(errno));

exit((int)MANDOCLEVEL_SYSERR);

}

CVSweb