[BACK]Return to main.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/main.c between version 1.127 and 1.345

version 1.127, 2010/12/29 14:38:14 version 1.345, 2020/03/13 15:32:28
Line 1 
Line 1 
 /*      $Id$ */  /* $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2010-2012, 2014-2020 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2010 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).
  */   */
 #ifdef HAVE_CONFIG_H  
 #include "config.h"  #include "config.h"
 #endif  
   
 #include <sys/mman.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>  #include <ctype.h>
   #if HAVE_ERR
   #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 <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.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 "term_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  outstate {
         const char       *file;         /* Current parse. */          struct tag_files *tag_files;    /* Tagging state variables. */
         int               fd;           /* Current parse. */  
         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 */          int               use_pager;
           int               wstop;        /* stop after a file with a warning */
           int               had_output;   /* Some output was generated. */
           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 *,
                                   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 manoutput *);
   static  void              passthrough(int, int);
   static  void              process_onefile(struct mparse *, struct manpage *,
                                   int, struct outstate *, struct manconf *);
   static  void              run_pager(struct tag_files *);
   static  pid_t             spawn_pager(struct tag_files *);
   static  void              usage(enum argmode) __attribute__((__noreturn__));
   static  int               woptions(char *, enum mandoc_os *, int *);
   
         "generic warning",  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};
   
         /* related to the prologue */  
         "no title in document",  
         "document title should be all caps",  
         "unknown manual section",  
         "cannot parse date argument",  
         "prologue macros out of order",  
         "duplicate prologue macro",  
         "macro not allowed in prologue",  
         "macro not allowed in body",  
   
         /* related to document structure */  int
         ".so is fragile, better use ln(1)",  main(int argc, char *argv[])
         "NAME section must come first",  {
         "bad NAME section contents",          struct manconf   conf;          /* Manpaths and output options. */
         "manual name not yet set",          struct outstate  outst;         /* Output state. */
         "sections out of conventional order",          struct winsize   ws;            /* Result of ioctl(TIOCGWINSZ). */
         "duplicate section name",          struct mansearch search;        /* Search options. */
         "section not in conventional manual section",          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;
           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. */
   
         /* related to macros and nesting */  #if HAVE_PROGNAME
         "skipping obsolete macro",          progname = getprogname();
         "skipping paragraph macro",  #else
         "blocks badly nested",          if (argc < 1)
         "child violates parent syntax",                  progname = mandoc_strdup("mandoc");
         "nested displays are not portable",          else if ((progname = strrchr(argv[0], '/')) == NULL)
         "already in literal mode",                  progname = argv[0];
           else
                   ++progname;
           setprogname(progname);
   #endif
   
         /* related to missing macro arguments */          mandoc_msg_setoutfile(stderr);
         "skipping empty macro",          if (strncmp(progname, "mandocdb", 8) == 0 ||
         "missing display type",              strcmp(progname, BINM_MAKEWHATIS) == 0)
         "list type must come first",                  return mandocdb(argc, argv);
         "tag lists require a width argument",  
         "missing font type",  
   
         /* related to bad macro arguments */  #if HAVE_PLEDGE
         "skipping argument",          if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1) {
         "duplicate argument",                  mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));
         "duplicate display type",                  return mandoc_msg_getrc();
         "duplicate list type",          }
         "unknown AT&T UNIX version",  #endif
         "bad Boolean value",  #if HAVE_SANDBOX_INIT
         "unknown font",          if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1)
         "unknown standard specifier",                  errx((int)MANDOCLEVEL_SYSERR, "sandbox_init");
         "bad width argument",  #endif
   
         /* related to plain text */          /* Search options. */
         "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",          memset(&conf, 0, sizeof(conf));
           conf_file = NULL;
           defpaths = auxpaths = NULL;
   
         "bad table syntax",          memset(&search, 0, sizeof(struct mansearch));
         "bad table option",          search.outkey = "Nd";
         "bad table layout",          oarg = NULL;
         "no table layout cells specified",  
         "input stack limit exceeded, infinite loop?",  
         "skipping bad character",  
         "skipping text before the first section header",  
         "skipping unknown macro",  
         "NOT IMPLEMENTED: 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",          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;
   
         "column syntax is inconsistent",          /* Parser options. */
         "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);          options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
 static  void              pdesc(struct curparse *);          os_e = MANDOC_OS_OTHER;
 static  void              fdesc(struct curparse *);          os_s = NULL;
 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  void              usage(void) __attribute__((noreturn));  
 static  void              version(void) __attribute__((noreturn));  
 static  int               woptions(struct curparse *, char *);  
   
 static  const char       *progname;          /* Formatter options. */
 static  enum mandoclevel  file_status = MANDOCLEVEL_OK;  
 static  enum mandoclevel  exit_status = MANDOCLEVEL_OK;  
   
 int          memset(&outst, 0, sizeof(outst));
 main(int argc, char *argv[])          outst.tag_files = NULL;
 {          outst.outtype = OUTT_LOCALE;
         int              c;          outst.use_pager = 1;
         struct curparse  curp;  
   
         progname = strrchr(argv[0], '/');          show_usage = 0;
         if (progname == NULL)          outmode = OUTMODE_DEF;
                 progname = argv[0];  
         else  
                 ++progname;  
   
         memset(&curp, 0, sizeof(struct curparse));          while ((c = getopt(argc, argv,
               "aC:cfhI:iK:klM:m:O:S:s:T:VW:w")) != -1) {
         curp.inttype = INTT_AUTO;                  if (c == 'i' && search.argmode == ARG_EXPR) {
         curp.outtype = OUTT_ASCII;                          optind--;
         curp.wlevel  = MANDOCLEVEL_FATAL;                          break;
                   }
         /* LINTED */  
         while (-1 != (c = getopt(argc, argv, "m:O:T:VW:")))  
                 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':
                         if ( ! toptions(&curp, optarg))                          outst.use_pager = 0;
                                 return((int)MANDOCLEVEL_BADARG);  
                         break;                          break;
                 case ('W'):                  case 'f':
                         if ( ! woptions(&curp, optarg))                          search.argmode = ARG_WORD;
                                 return((int)MANDOCLEVEL_BADARG);  
                         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);
   
         if (NULL == *argv) {          /* Postprocess options. */
                 curp.file = "<stdin>";  
                 curp.fd = STDIN_FILENO;  
   
                 fdesc(&curp);          switch (outmode) {
           case OUTMODE_DEF:
                   switch (search.argmode) {
                   case ARG_FILE:
                           outmode = OUTMODE_ALL;
                           outst.use_pager = 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 (*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) {
                                   if (manconf_output(&conf.output,
                                       strsep(&oarg, ","), 0) == -1)
                                           return mandoc_msg_getrc();
                           }
                   }
         }          }
   
         if (curp.outfree)          if (outst.outtype != OUTT_TREE || conf.output.noval == 0)
                 (*curp.outfree)(curp.outdata);                  options |= MPARSE_VALIDATE;
         if (curp.pmdoc)  
                 mdoc_free(curp.pmdoc);  
         if (curp.pman)  
                 man_free(curp.pman);  
         if (curp.roff)  
                 roff_free(curp.roff);  
   
         return((int)exit_status);          if (outmode == OUTMODE_FLN ||
 }              outmode == OUTMODE_LST ||
               !isatty(STDOUT_FILENO))
                   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;
           }
   
 static void  #if HAVE_PLEDGE
 version(void)          if (outst.use_pager == 0) {
 {                  if (pledge("stdio rpath", NULL) == -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((int)MANDOCLEVEL_OK);  
 }  
   
           if (argc > 0) {
                   argc -= optind;
                   argv += optind;
           }
   
 static void          /*
 usage(void)           * Quirks for help(1) and man(1),
 {           * in particular for a section argument without -s.
            */
   
         (void)fprintf(stderr, "usage: %s "          if (search.argmode == ARG_NAME) {
                         "[-V] "                  if (*progname == 'h') {
                         "[-foption] "                          if (argc == 0) {
                         "[-mformat] "                                  argv = help_argv;
                         "[-Ooption] "                                  argc = 1;
                         "[-Toutput] "                          }
                         "[-Werr] "                  } else if (argc > 1 &&
                         "[file...]\n",                      ((uc = (unsigned char *)argv[0]) != NULL) &&
                         progname);                      ((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;
           }
   
         exit((int)MANDOCLEVEL_BADARG);  
 }  
   
 static void  
 ffile(const char *file, struct curparse *curp)  
 {  
   
         /*          /*
          * Called once per input file.  Get the file ready for reading,           * Use the first argument for -O tag in addition to
          * pass it through to the parser-driver, then close it out.           * using it as a search term for man(1) or apropos(1).
          * XXX: don't do anything special as this is only called for  
          * files; stdin goes directly to fdesc().  
          */           */
   
         curp->file = file;          if (conf.output.tag != NULL && *conf.output.tag == '\0') {
                   tagarg = argc > 0 && search.argmode == ARG_EXPR ?
         if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {                      strchr(*argv, '=') : NULL;
                 perror(curp->file);                  conf.output.tag = tagarg == NULL ? *argv : tagarg + 1;
                 exit_status = MANDOCLEVEL_SYSERR;  
                 return;  
         }          }
   
         fdesc(curp);          /* Read the configuration file. */
   
         if (-1 == close(curp->fd))          if (search.argmode != ARG_FILE)
                 perror(curp->file);                  manconf_parse(&conf, conf_file, defpaths, auxpaths);
 }  
   
 static int          /* man(1): Resolve each name individually. */
 pfile(const char *file, struct curparse *curp)  
 {  
         const char      *savefile;  
         int              fd, savefd;  
   
         if (-1 == (fd = open(file, O_RDONLY, 0))) {          if (search.argmode == ARG_NAME) {
                 perror(file);                  if (argc < 1) {
                 file_status = MANDOCLEVEL_SYSERR;                          if (outmode != OUTMODE_FLN)
                 return(0);                                  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++) {
                           (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;
                                   continue;
                           }
   
         savefile = curp->file;                          /* Search for the best section. */
         savefd = curp->fd;  
   
         curp->file = file;                          best_prio = 40;
         curp->fd = fd;                          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 &&
                                       (strlen(sec) <= ssz  + 3 ||
                                        strcmp(sec + strlen(sec) - ssz,
                                         search.sec) != 0))
                                           prio += 20; /* Wrong file ext. */
                                   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));
                   }
   
         pdesc(curp);          /* apropos(1), whatis(1): Process the full search expression. */
   
         curp->file = savefile;          } else if (search.argmode != ARG_FILE) {
         curp->fd = savefd;                  if (mansearch(&search, &conf.manpath,
                       argc, argv, &res, &ressz) == 0)
                           usage(search.argmode);
   
         if (-1 == close(fd))                  if (ressz == 0) {
                 perror(file);                          warnx("nothing appropriate");
                           mandoc_msg_setrc(MANDOCLEVEL_BADARG);
                           goto out;
                   }
   
         return(MANDOCLEVEL_FATAL > file_status ? 1 : 0);          /* mandoc(1): Take command line arguments as file names. */
 }  
   
           } else {
 static void                  ressz = argc > 0 ? argc : 1;
 resize_buf(struct buf *buf, size_t initial)                  res = mandoc_calloc(ressz, sizeof(*res));
 {                  for (i = 0; i < ressz; i++) {
                           if (argc > 0)
         buf->sz = buf->sz > initial/2 ? 2 * buf->sz : initial;                                  res[i].file = mandoc_strdup(argv[i]);
         buf->buf = realloc(buf->buf, buf->sz);                          res[i].ipath = SIZE_MAX;
         if (NULL == buf->buf) {                          res[i].form = FORM_SRC;
                 perror(NULL);                  }
                 exit((int)MANDOCLEVEL_SYSERR);  
         }          }
 }  
   
           switch (outmode) {
 static int          case OUTMODE_FLN:
 read_whole_file(struct curparse *curp, struct buf *fb, int *with_mmap)                  for (i = 0; i < ressz; i++)
 {                          puts(res[i].file);
         struct stat      st;                  goto out;
         size_t           off;          case OUTMODE_LST:
         ssize_t          ssz;                  for (i = 0; i < ressz; i++)
                           printf("%s - %s\n", res[i].names,
         if (-1 == fstat(curp->fd, &st)) {                              res[i].output == NULL ? "" :
                 perror(curp->file);                              res[i].output);
                 return(0);                  goto out;
           default:
                   break;
         }          }
   
         /*          if (search.argmode == ARG_FILE && auxpaths != NULL) {
          * If we're a regular file, try just reading in the whole entry                  if (strcmp(auxpaths, "doc") == 0)
          * via mmap().  This is faster than reading it into blocks, and                          options |= MPARSE_MDOC;
          * since each file is only a few bytes to begin with, I'm not                  else if (strcmp(auxpaths, "an") == 0)
          * concerned that this is going to tank any machines.                          options |= MPARSE_MAN;
          */  
   
         if (S_ISREG(st.st_mode)) {  
                 if (st.st_size >= (1U << 31)) {  
                         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);  
         }          }
   
           mchars_alloc();
           mp = mparse_alloc(options, os_e, os_s);
   
         /*          /*
          * If this isn't a regular file (like, say, stdin), then we must           * Remember the original working directory, if possible.
          * go the old way and just read things in bit by bit.           * 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);
         *with_mmap = 0;          for (i = 0; i < ressz; i++) {
         off = 0;                  process_onefile(mp, res + i, startdir, &outst, &conf);
         fb->sz = 0;                  if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
         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;                          break;
           }
           if (startdir != -1) {
                   (void)fchdir(startdir);
                   close(startdir);
           }
           if (outst.outdata != NULL) {
                   switch (outst.outtype) {
                   case OUTT_HTML:
                           html_free(outst.outdata);
                           break;
                   case OUTT_UTF8:
                   case OUTT_LOCALE:
                   case OUTT_ASCII:
                           term_tag_finish();
                           ascii_free(outst.outdata);
                           break;
                   case OUTT_PDF:
                   case OUTT_PS:
                           pspdf_free(outst.outdata);
                           break;
                   default:
                           break;
                 }                  }
                 off += (size_t)ssz;  
         }          }
           mandoc_xr_free();
           mparse_free(mp);
           mchars_free();
   
         free(fb->buf);  out:
         fb->buf = NULL;          mansearch_free(res, ressz);
         return(0);          if (search.argmode != ARG_FILE)
                   manconf_free(&conf);
   
           if (outst.tag_files != NULL) {
                   fclose(stdout);
                   run_pager(outst.tag_files);
                   term_tag_unlink();
           } else if (outst.had_output && outst.outtype != OUTT_LINT)
                   mandoc_msg_summary();
   
           return (int)mandoc_msg_getrc();
 }  }
   
   static void
   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);
   }
   
 static void  static void
 fdesc(struct curparse *curp)  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
          * Called once per file with an opened file descriptor.  All  fs_lookup(const struct manpaths *paths, size_t ipath,
          * pre-file-parse operations (whether stdin or a file) should go          const char *sec, const char *arch, const char *name,
          * here.          struct manpage **res, size_t *ressz)
          *  {
          * This calls down into the nested parser, which drills down and          struct stat      sb;
          * fully parses a file and all its dependences (i.e., `so').  It          glob_t           globinfo;
          * then runs the cleanup validators and pushes to output.          struct manpage  *page;
          */          char            *file, *cp;
           int              globres;
           enum form        form;
   
         /* Zero the parse type. */          const char *const slman = "/man";
           const char *const slash = "/";
           const char *const sglob = ".[01-9]*";
   
         curp->mdoc = NULL;          form = FORM_SRC;
         curp->man = NULL;          mandoc_asprintf(&file, "%s/man%s/%s.%s",
         file_status = MANDOCLEVEL_OK;              paths->paths[ipath], sec, name, sec);
           if (stat(file, &sb) != -1)
                   goto found;
           free(file);
   
         /* Make sure the mandotory roff parser is initialised. */          mandoc_asprintf(&file, "%s/cat%s/%s.0",
               paths->paths[ipath], sec, name);
           if (stat(file, &sb) != -1) {
                   form = FORM_CAT;
                   goto found;
           }
           free(file);
   
         if (NULL == curp->roff) {          if (arch != NULL) {
                 curp->roff = roff_alloc(&curp->regs, curp, mmsg);                  mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
                 assert(curp->roff);                      paths->paths[ipath], sec, arch, name, sec);
                   if (stat(file, &sb) != -1)
                           goto found;
                   free(file);
         }          }
   
         /* Fully parse the file. */          cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
               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);
           if (globres != 0 && globres != GLOB_NOMATCH)
                   mandoc_msg(MANDOCERR_GLOB, 0, 0,
                       "%s: %s", file, strerror(errno));
           free(file);
           if (globres == 0)
                   file = mandoc_strdup(*globinfo.gl_pathv);
           globfree(&globinfo);
           if (globres == 0) {
                   if (stat(file, &sb) != -1)
                           goto found;
                   free(file);
           }
           if (res != NULL || ipath + 1 != paths->sz)
                   return -1;
   
         pdesc(curp);          mandoc_asprintf(&file, "%s.%s", name, sec);
           globres = stat(file, &sb);
           free(file);
           return globres;
   
         if (MANDOCLEVEL_FATAL <= file_status)  found:
                 goto cleanup;          warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
               name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
           if (res == NULL) {
                   free(file);
                   return 0;
           }
           *res = mandoc_reallocarray(*res, ++*ressz, sizeof(**res));
           page = *res + (*ressz - 1);
           page->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;
           return 0;
   }
   
         /* NOTE a parser may not have been assigned, yet. */  static int
   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]);
   
         if ( ! (curp->man || curp->mdoc)) {          size_t           ipath, isec;
                 fprintf(stderr, "%s: Not a manual\n", curp->file);  
                 file_status = MANDOCLEVEL_FATAL;          assert(cfg->argmode == ARG_NAME);
                 goto cleanup;          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;
   }
   
         /* Clean up the parse routine ASTs. */  static void
   process_onefile(struct mparse *mp, struct manpage *resp, int startdir,
       struct outstate *outst, struct manconf *conf)
   {
           int      fd;
   
         if (curp->mdoc && ! mdoc_endparse(curp->mdoc)) {          /*
                 assert(MANDOCLEVEL_FATAL <= file_status);           * Changing directories is not needed in ARG_FILE mode.
                 goto cleanup;           * 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);
   
           mandoc_msg_setinfilename(resp->file);
           if (resp->file != NULL) {
                   if ((fd = mparse_open(mp, resp->file)) == -1) {
                           mandoc_msg(resp->ipath == SIZE_MAX ?
                               MANDOCERR_BADARG_BAD : MANDOCERR_OPEN,
                               0, 0, "%s", strerror(errno));
                           mandoc_msg_setinfilename(NULL);
                           return;
                   }
           } else
                   fd = STDIN_FILENO;
   
           if (outst->outtype <= OUTT_UTF8) {
                   if (outst->use_pager) {
                           outst->use_pager = 0;
                           outst->tag_files = term_tag_init(conf->output.tag);
                   }
                   if (outst->had_output) {
                           if (outst->outdata == NULL)
                                   outdata_alloc(outst, &conf->output);
                           terminal_sepline(outst->outdata);
                   }
         }          }
   
         if (curp->man && ! man_endparse(curp->man)) {          if (resp->form == FORM_SRC)
                 assert(MANDOCLEVEL_FATAL <= file_status);                  parse(mp, fd, resp->file, outst, &conf->output);
                 goto cleanup;          else {
                   passthrough(fd, conf->output.synopsisonly);
                   outst->had_output = 1;
         }          }
   
         assert(curp->roff);          if (ferror(stdout)) {
         if ( ! roff_endparse(curp->roff)) {                  if (outst->tag_files != NULL) {
                 assert(MANDOCLEVEL_FATAL <= file_status);                          mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s",
                 goto cleanup;                              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);
   }
   
   static void
   parse(struct mparse *mp, int fd, const char *file,
       struct outstate *outst, struct manoutput *outconf)
   {
           static int               previous;
           struct roff_meta        *meta;
   
           assert(fd >= 0);
           if (file == NULL)
                   file = "<stdin>";
   
           if (previous)
                   mparse_reset(mp);
           else
                   previous = 1;
   
           mparse_readfd(mp, fd, file);
           if (fd != STDIN_FILENO)
                   close(fd);
   
         /*          /*
          * With -Wstop and warnings or errors of at least           * With -Wstop and warnings or errors of at least the requested
          * the requested level, do not produce output.           * level, do not produce output.
          */           */
   
         if (MANDOCLEVEL_OK != file_status && curp->wstop)          if (outst->wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
                 goto cleanup;                  return;
   
         /* If unset, allocate output dev now (if applicable). */          if (outst->outdata == NULL)
                   outdata_alloc(outst, outconf);
           else if (outst->outtype == OUTT_HTML)
                   html_reset(outst);
   
         if ( ! (curp->outman && curp->outmdoc)) {          mandoc_xr_reset();
                 switch (curp->outtype) {          meta = mparse_result(mp);
                 case (OUTT_XHTML):  
                         curp->outdata = xhtml_alloc(curp->outopts);          /* Execute the out device, if it exists. */
   
           outst->had_output = 1;
           if (meta->macroset == MACROSET_MDOC) {
                   switch (outst->outtype) {
                   case OUTT_HTML:
                           html_mdoc(outst->outdata, meta);
                         break;                          break;
                 case (OUTT_HTML):                  case OUTT_TREE:
                         curp->outdata = html_alloc(curp->outopts);                          tree_mdoc(outst->outdata, meta);
                         break;                          break;
                 case (OUTT_ASCII):                  case OUTT_MAN:
                         curp->outdata = ascii_alloc(curp->outopts);                          man_mdoc(outst->outdata, meta);
                         curp->outfree = ascii_free;  
                         break;                          break;
                 case (OUTT_PDF):                  case OUTT_PDF:
                         curp->outdata = pdf_alloc(curp->outopts);                  case OUTT_ASCII:
                         curp->outfree = pspdf_free;                  case OUTT_UTF8:
                   case OUTT_LOCALE:
                   case OUTT_PS:
                           terminal_mdoc(outst->outdata, meta);
                         break;                          break;
                 case (OUTT_PS):                  case OUTT_MARKDOWN:
                         curp->outdata = ps_alloc(curp->outopts);                          markdown_mdoc(outst->outdata, meta);
                         curp->outfree = pspdf_free;  
                         break;                          break;
                 default:                  default:
                         break;                          break;
                 }                  }
           }
                 switch (curp->outtype) {          if (meta->macroset == MACROSET_MAN) {
                 case (OUTT_HTML):                  switch (outst->outtype) {
                         /* FALLTHROUGH */                  case OUTT_HTML:
                 case (OUTT_XHTML):                          html_man(outst->outdata, meta);
                         curp->outman = html_man;  
                         curp->outmdoc = html_mdoc;  
                         curp->outfree = html_free;  
                         break;                          break;
                 case (OUTT_TREE):                  case OUTT_TREE:
                         curp->outman = tree_man;                          tree_man(outst->outdata, meta);
                         curp->outmdoc = tree_mdoc;  
                         break;                          break;
                 case (OUTT_PDF):                  case OUTT_MAN:
                         /* FALLTHROUGH */                          mparse_copy(mp);
                 case (OUTT_ASCII):  
                         /* FALLTHROUGH */  
                 case (OUTT_PS):  
                         curp->outman = terminal_man;  
                         curp->outmdoc = terminal_mdoc;  
                         break;                          break;
                   case OUTT_PDF:
                   case OUTT_ASCII:
                   case OUTT_UTF8:
                   case OUTT_LOCALE:
                   case OUTT_PS:
                           terminal_man(outst->outdata, meta);
                           break;
                 default:                  default:
                         break;                          break;
                 }                  }
         }          }
           if (mandoc_msg_getmin() < MANDOCERR_STYLE)
         /* Execute the out device, if it exists. */                  check_xr();
   
         if (curp->man && curp->outman)  
                 (*curp->outman)(curp->outdata, curp->man);  
         if (curp->mdoc && curp->outmdoc)  
                 (*curp->outmdoc)(curp->outdata, curp->mdoc);  
   
  cleanup:  
   
         memset(&curp->regs, 0, sizeof(struct regset));  
   
         /* Reset the current-parse compilers. */  
   
         if (curp->mdoc)  
                 mdoc_reset(curp->mdoc);  
         if (curp->man)  
                 man_reset(curp->man);  
   
         assert(curp->roff);  
         roff_reset(curp->roff);  
   
         if (exit_status < file_status)  
                 exit_status = file_status;  
   
         return;  
 }  }
   
 static void  static void
 pdesc(struct curparse *curp)  check_xr(void)
 {  {
         struct buf       blk;          static struct manpaths   paths;
         int              with_mmap;          struct mansearch         search;
           struct mandoc_xr        *xr;
           size_t                   sz;
   
         /*          if (paths.sz == 0)
          * Run for each opened file; may be called more than once for                  manpath_base(&paths);
          * each full parse sequence if the opened file is nested (i.e.,  
          * from `so').  Simply sucks in the whole file and moves into  
          * the parse phase for the file.  
          */  
   
         if ( ! read_whole_file(curp, &blk, &with_mmap)) {          for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) {
                 file_status = MANDOCLEVEL_SYSERR;                  if (xr->line == -1)
                 return;                          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, xr->name, NULL, &sz) != -1)
                           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);
         }          }
   }
   
         /* Line number is per-file. */  static void
   outdata_alloc(struct outstate *outst, struct manoutput *outconf)
         curp->line = 1;  {
           switch (outst->outtype) {
         parsebuf(curp, blk, 1);          case OUTT_HTML:
                   outst->outdata = html_alloc(outconf);
         if (with_mmap)                  break;
                 munmap(blk.buf, blk.sz);          case OUTT_UTF8:
         else                  outst->outdata = utf8_alloc(outconf);
                 free(blk.buf);                  break;
           case OUTT_LOCALE:
                   outst->outdata = locale_alloc(outconf);
                   break;
           case OUTT_ASCII:
                   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:
                   break;
           }
 }  }
   
 static void  static void
 parsebuf(struct curparse *curp, struct buf blk, int start)  passthrough(int fd, int synopsis_only)
 {  {
         struct buf       ln;          const char       synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
         enum rofferr     rr;          const char       synr[] = "SYNOPSIS";
         int              i, of, rc;  
         int              pos; /* byte number in the ln buffer */  
         int              lnn; /* line number in the real file */  
         unsigned char    c;  
   
         /*          FILE            *stream;
          * Main parse routine for an opened file.  This is called for          char            *line, *cp;
          * each opened file and simply loops around the full input file,          size_t           linesz;
          * possibly nesting (i.e., with `so').          ssize_t          len, written;
          */          int              lno, print;
   
         memset(&ln, 0, sizeof(struct buf));          stream = NULL;
           line = NULL;
           linesz = 0;
   
         lnn = curp->line;          if (fflush(stdout) == EOF) {
         pos = 0;                  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;
           }
   
         for (i = 0; i < (int)blk.sz; ) {          lno = print = 0;
                 if (0 == pos && '\0' == blk.buf[i])          while ((len = getline(&line, &linesz, stream)) != -1) {
                         break;                  lno++;
                   cp = line;
                 if (start) {                  if (synopsis_only) {
                         curp->line = lnn;                          if (print) {
                         curp->reparse_count = 0;                                  if ( ! isspace((unsigned char)*cp))
                 }                                          goto done;
                                   while (isspace((unsigned char)*cp)) {
                 while (i < (int)blk.sz && (start || '\0' != blk.buf[i])) {                                          cp++;
                         if ('\n' == blk.buf[i]) {                                          len--;
                                 ++i;                                  }
                                 ++lnn;                          } else {
                                 break;                                  if (strcmp(cp, synb) == 0 ||
                         }                                      strcmp(cp, synr) == 0)
                                           print = 1;
                         /*  
                          * 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 ( ! (isascii(c) &&  
                                         (isgraph(c) || isblank(c)))) {  
                                 mmsg(MANDOCERR_BADCHAR, curp,  
                                     curp->line, pos, "ignoring byte");  
                                 i++;  
                                 continue;                                  continue;
                         }                          }
                   }
                         /* Trailing backslash = a plain char. */                  for (; len > 0; len -= written) {
                           if ((written = write(STDOUT_FILENO, cp, len)) == -1) {
                         if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {                                  mandoc_msg(MANDOCERR_WRITE, 0, 0,
                                 if (pos >= (int)ln.sz)                                      "%s", strerror(errno));
                                         resize_buf(&ln, 256);                                  goto done;
                                 ln.buf[pos++] = blk.buf[i++];  
                                 continue;  
                         }                          }
                   }
           }
           if (ferror(stream))
                   mandoc_msg(MANDOCERR_GETLINE, lno, 0, "%s", strerror(errno));
   
                         /* Found escape & at least one other char. */  done:
           free(line);
           if (stream != NULL)
                   fclose(stream);
   }
   
                         if ('\n' == blk.buf[i + 1]) {  static int
                                 i += 2;  woptions(char *arg, enum mandoc_os *os_e, int *wstop)
                                 /* Escaped newlines are skipped over */  {
                                 ++lnn;          char            *v, *o;
                                 continue;          const char      *toks[11];
                         }  
   
                         if ('"' == blk.buf[i + 1]) {          toks[0] = "stop";
                                 i += 2;          toks[1] = "all";
                                 /* Comment, skip to end of line */          toks[2] = "base";
                                 for (; i < (int)blk.sz; ++i) {          toks[3] = "style";
                                         if ('\n' == blk.buf[i]) {          toks[4] = "warning";
                                                 ++i;          toks[5] = "error";
                                                 ++lnn;          toks[6] = "unsupp";
                                                 break;          toks[7] = "fatal";
                                         }          toks[8] = "openbsd";
                                 }          toks[9] = "netbsd";
           toks[10] = NULL;
   
                                 /* Backout trailing whitespaces */          while (*arg) {
                                 for (; pos > 0; --pos) {                  o = arg;
                                         if (ln.buf[pos - 1] != ' ')                  switch (getsubopt(&arg, (char * const *)toks, &v)) {
                                                 break;                  case 0:
                                         if (pos > 2 && ln.buf[pos - 2] == '\\')                          *wstop = 1;
                                                 break;                          break;
                                 }                  case 1:
                                 break;                  case 2:
                         }                          mandoc_msg_setmin(MANDOCERR_BASE);
                           break;
                         /* Some other escape sequence, copy & cont. */                  case 3:
                           mandoc_msg_setmin(MANDOCERR_STYLE);
                         if (pos + 1 >= (int)ln.sz)                          break;
                                 resize_buf(&ln, 256);                  case 4:
                           mandoc_msg_setmin(MANDOCERR_WARNING);
                         ln.buf[pos++] = blk.buf[i++];                          break;
                         ln.buf[pos++] = blk.buf[i++];                  case 5:
                           mandoc_msg_setmin(MANDOCERR_ERROR);
                           break;
                   case 6:
                           mandoc_msg_setmin(MANDOCERR_UNSUPP);
                           break;
                   case 7:
                           mandoc_msg_setmin(MANDOCERR_BADARG);
                           break;
                   case 8:
                           mandoc_msg_setmin(MANDOCERR_BASE);
                           *os_e = MANDOC_OS_OPENBSD;
                           break;
                   case 9:
                           mandoc_msg_setmin(MANDOCERR_BASE);
                           *os_e = MANDOC_OS_NETBSD;
                           break;
                   default:
                           mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, "-W %s", o);
                           return -1;
                 }                  }
           }
           return 0;
   }
   
                 if (pos >= (int)ln.sz)  /*
                         resize_buf(&ln, 256);   * Wait until moved to the foreground,
    * then fork the pager and wait for the user to close it.
    */
   static void
   run_pager(struct tag_files *tag_files)
   {
           int      signum, status;
           pid_t    man_pgid, tc_pgid;
           pid_t    pager_pid, wait_pid;
   
                 ln.buf[pos] = '\0';          man_pgid = getpgid(0);
           tag_files->tcpgid = man_pgid == getpid() ? getpgid(getppid()) :
               man_pgid;
           pager_pid = 0;
           signum = SIGSTOP;
   
                 /*          for (;;) {
                  * A significant amount of complexity is contained by                  /* Stop here until moved to the foreground. */
                  * 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;                  tc_pgid = tcgetpgrp(tag_files->ofd);
                   if (tc_pgid != man_pgid) {
 rerun:                          if (tc_pgid == pager_pid) {
                 rr = roff_parseln                                  (void)tcsetpgrp(tag_files->ofd, man_pgid);
                         (curp->roff, curp->line,                                  if (signum == SIGTTIN)
                          &ln.buf, &ln.sz, of, &of);                                          continue;
   
                 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;  
                 case (ROFF_SO):  
                         if (pfile(ln.buf + of, curp)) {  
                                 pos = 0;  
                                 continue;  
                         } else                          } else
                                 break;                                  tag_files->tcpgid = tc_pgid;
                 case (ROFF_CONT):                          kill(0, signum);
                         break;                          continue;
                 }                  }
   
                 /*                  /* Once in the foreground, activate the pager. */
                  * 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))                  if (pager_pid) {
                         pset(ln.buf + of, pos - of, curp);                          (void)tcsetpgrp(tag_files->ofd, pager_pid);
                           kill(pager_pid, SIGCONT);
                   } else
                           pager_pid = spawn_pager(tag_files);
   
                 /*                  /* Wait for the pager to stop or exit. */
                  * Lastly, push down into the parsers themselves.  One  
                  * of these will have already been set in the pset()  
                  * routine.  
                  */  
   
                 if (curp->man || curp->mdoc) {                  while ((wait_pid = waitpid(pager_pid, &status,
                         rc = curp->man ?                      WUNTRACED)) == -1 && errno == EINTR)
                                 man_parseln(curp->man,                          continue;
                                         curp->line, ln.buf, of) :  
                                 mdoc_parseln(curp->mdoc,  
                                         curp->line, ln.buf, of);  
   
                         if ( ! rc) {                  if (wait_pid == -1) {
                                 assert(MANDOCLEVEL_FATAL <= file_status);                          mandoc_msg(MANDOCERR_WAIT, 0, 0,
                                 break;                              "%s", strerror(errno));
                         }                          break;
                 }                  }
                   if (!WIFSTOPPED(status))
                 /* Temporary buffers typically are not full. */  
   
                 if (0 == start && '\0' == blk.buf[i])  
                         break;                          break;
   
                 /* Start the next input line. */                  signum = WSTOPSIG(status);
   
                 pos = 0;  
         }          }
   
         free(ln.buf);  
 }  }
   
 static void  static pid_t
 pset(const char *buf, int pos, struct curparse *curp)  spawn_pager(struct tag_files *tag_files)
 {  {
         int              i;          const struct timespec timeout = { 0, 100000000 };  /* 0.1s */
   #define MAX_PAGER_ARGS 16
           char            *argv[MAX_PAGER_ARGS];
           const char      *pager;
           char            *cp;
   #if HAVE_LESS_T
           size_t           cmdlen;
   #endif
           int              argc, use_ofn;
           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);
   
         /*          /*
          * Try to intuit which kind of manual parser should be used.  If           * Parse the pager command into words.
          * passed in by command-line (-man, -mdoc), then use that           * Intentionally do not do anything fancy here.
          * explicitly.  If passed as -mandoc, then try to guess from the  
          * line: either skip dot-lines, use -mdoc when finding `.Dt', or  
          * default to -man, which is more lenient.  
          *  
          * 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]) {          argc = 0;
                 for (i = 1; buf[i]; i++)          while (argc + 5 < MAX_PAGER_ARGS) {
                         if (' ' != buf[i] && '\t' != buf[i])                  argv[argc++] = cp;
                                 break;                  cp = strchr(cp, ' ');
                 if ('\0' == buf[i])                  if (cp == NULL)
                         return;                          break;
                   *cp++ = '\0';
                   while (*cp == ' ')
                           cp++;
                   if (*cp == '\0')
                           break;
         }          }
   
         switch (curp->inttype) {          /* For less(1), use the tag file. */
         case (INTT_MDOC):  
                 if (NULL == curp->pmdoc)  
                         curp->pmdoc = mdoc_alloc  
                                 (&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))  {          use_ofn = 1;
                 if (NULL == curp->pmdoc)  #if HAVE_LESS_T
                         curp->pmdoc = mdoc_alloc          if (*tag_files->tfn != '\0' && (cmdlen = strlen(argv[0])) >= 4) {
                                 (&curp->regs, curp, mmsg);                  cp = argv[0] + cmdlen - 4;
                 assert(curp->pmdoc);                  if (strcmp(cp, "less") == 0) {
                 curp->mdoc = curp->pmdoc;                          argv[argc++] = mandoc_strdup("-T");
                 return;                          argv[argc++] = tag_files->tfn;
         }                          if (tag_files->tagname != NULL) {
                                   argv[argc++] = mandoc_strdup("-t");
         if (NULL == curp->pman)                                  argv[argc++] = tag_files->tagname;
                 curp->pman = man_alloc(&curp->regs, curp, mmsg);                                  use_ofn = 0;
         assert(curp->pman);                          }
         curp->man = curp->pman;                  }
 }  
   
 static int  
 moptions(enum intt *tflags, char *arg)  
 {  
   
         if (0 == strcmp(arg, "doc"))  
                 *tflags = INTT_MDOC;  
         else if (0 == strcmp(arg, "andoc"))  
                 *tflags = INTT_AUTO;  
         else if (0 == strcmp(arg, "an"))  
                 *tflags = INTT_MAN;  
         else {  
                 fprintf(stderr, "%s: Bad argument\n", arg);  
                 return(0);  
         }          }
   #endif
           if (use_ofn)
                   argv[argc++] = tag_files->ofn;
           argv[argc] = NULL;
   
         return(1);          switch (pager_pid = fork()) {
 }          case -1:
                   mandoc_msg(MANDOCERR_FORK, 0, 0, "%s", strerror(errno));
 static int                  exit(mandoc_msg_getrc());
 toptions(struct curparse *curp, char *arg)          case 0:
 {                  break;
           default:
         if (0 == strcmp(arg, "ascii"))                  (void)setpgid(pager_pid, 0);
                 curp->outtype = OUTT_ASCII;                  (void)tcsetpgrp(tag_files->ofd, pager_pid);
         else if (0 == strcmp(arg, "lint")) {  #if HAVE_PLEDGE
                 curp->outtype = OUTT_LINT;                  if (pledge("stdio rpath tmppath tty proc", NULL) == -1) {
                 curp->wlevel  = MANDOCLEVEL_WARNING;                          mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
                               "%s", strerror(errno));
                           exit(mandoc_msg_getrc());
                   }
   #endif
                   tag_files->pager_pid = pager_pid;
                   return pager_pid;
         }          }
         else if (0 == strcmp(arg, "tree"))  
                 curp->outtype = OUTT_TREE;  
         else if (0 == strcmp(arg, "html"))  
                 curp->outtype = OUTT_HTML;  
         else if (0 == strcmp(arg, "xhtml"))  
                 curp->outtype = OUTT_XHTML;  
         else if (0 == strcmp(arg, "ps"))  
                 curp->outtype = OUTT_PS;  
         else if (0 == strcmp(arg, "pdf"))  
                 curp->outtype = OUTT_PDF;  
         else {  
                 fprintf(stderr, "%s: Bad argument\n", arg);  
                 return(0);  
         }  
   
         return(1);          /* The child process becomes the pager. */
 }  
   
 static int          if (dup2(tag_files->ofd, STDOUT_FILENO) == -1) {
 woptions(struct curparse *curp, char *arg)                  mandoc_msg(MANDOCERR_DUP, 0, 0, "%s", strerror(errno));
 {                  _exit(mandoc_msg_getrc());
         char            *v, *o;  
         const char      *toks[6];  
   
         toks[0] = "stop";  
         toks[1] = "all";  
         toks[2] = "warning";  
         toks[3] = "error";  
         toks[4] = "fatal";  
         toks[5] = NULL;  
   
         while (*arg) {  
                 o = arg;  
                 switch (getsubopt(&arg, UNCONST(toks), &v)) {  
                 case (0):  
                         curp->wstop = 1;  
                         break;  
                 case (1):  
                         /* FALLTHROUGH */  
                 case (2):  
                         curp->wlevel = MANDOCLEVEL_WARNING;  
                         break;  
                 case (3):  
                         curp->wlevel = MANDOCLEVEL_ERROR;  
                         break;  
                 case (4):  
                         curp->wlevel = MANDOCLEVEL_FATAL;  
                         break;  
                 default:  
                         fprintf(stderr, "-W%s: Bad argument\n", o);  
                         return(0);  
                 }  
         }          }
           close(tag_files->ofd);
           assert(tag_files->tfs == NULL);
   
         return(1);          /* Do not start the pager before controlling the terminal. */
 }  
   
 static int          while (tcgetpgrp(STDOUT_FILENO) != getpid())
 mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg)                  nanosleep(&timeout, NULL);
 {  
         struct curparse *cp;  
         enum mandoclevel level;  
   
         level = MANDOCLEVEL_FATAL;          execvp(argv[0], argv);
         while (t < mandoclimits[level])          mandoc_msg(MANDOCERR_EXEC, 0, 0, "%s: %s", argv[0], strerror(errno));
                 /* LINTED */          _exit(mandoc_msg_getrc());
                 level--;  
   
         cp = (struct curparse *)arg;  
         if (level < cp->wlevel)  
                 return(1);  
   
         fprintf(stderr, "%s:%d:%d: %s: %s",  
             cp->file, ln, col + 1, mandoclevels[level], mandocerrs[t]);  
         if (msg)  
                 fprintf(stderr, ": %s", msg);  
         fputc('\n', stderr);  
   
         if (file_status < level)  
                 file_status = level;  
   
         return(level < MANDOCLEVEL_FATAL);  
 }  }
Legend:
Removed from v.1.127  
changed lines
  Added in v.1.345
CVSweb