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

Diff for /mandoc/main.c between version 1.159 and 1.235

version 1.159, 2011/03/23 09:47:13 version 1.235, 2015/04/18 16:34:25
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2010-2012, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
    * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.   * copyright notice and this permission notice appear in all copies.
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */   */
 #ifdef HAVE_CONFIG_H  
 #include "config.h"  #include "config.h"
 #endif  
   
   #include <sys/types.h>
   #include <sys/param.h>  /* MACHINE */
   #include <sys/wait.h>
   
 #include <assert.h>  #include <assert.h>
   #include <ctype.h>
   #include <errno.h>
   #include <fcntl.h>
   #include <glob.h>
   #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 <unistd.h>  #include <unistd.h>
   
   #include "mandoc_aux.h"
 #include "mandoc.h"  #include "mandoc.h"
 #include "main.h"  #include "roff.h"
 #include "mdoc.h"  #include "mdoc.h"
 #include "man.h"  #include "man.h"
   #include "main.h"
   #include "manconf.h"
   #include "mansearch.h"
   
 #if !defined(__GNUC__) || (__GNUC__ < 2)  #if !defined(__GNUC__) || (__GNUC__ < 2)
 # if !defined(lint)  # if !defined(lint)
Line 37 
Line 49 
 # endif  # endif
 #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */  #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */
   
 typedef void            (*out_mdoc)(void *, const struct mdoc *);  enum    outmode {
 typedef void            (*out_man)(void *, const struct man *);          OUTMODE_DEF = 0,
           OUTMODE_FLN,
           OUTMODE_LST,
           OUTMODE_ALL,
           OUTMODE_INT,
           OUTMODE_ONE
   };
   
   typedef void            (*out_mdoc)(void *, const struct roff_man *);
   typedef void            (*out_man)(void *, const struct roff_man *);
 typedef void            (*out_free)(void *);  typedef void            (*out_free)(void *);
   
 enum    outt {  enum    outt {
         OUTT_ASCII = 0, /* -Tascii */          OUTT_ASCII = 0, /* -Tascii */
           OUTT_LOCALE,    /* -Tlocale */
           OUTT_UTF8,      /* -Tutf8 */
         OUTT_TREE,      /* -Ttree */          OUTT_TREE,      /* -Ttree */
           OUTT_MAN,       /* -Tman */
         OUTT_HTML,      /* -Thtml */          OUTT_HTML,      /* -Thtml */
         OUTT_XHTML,     /* -Txhtml */  
         OUTT_LINT,      /* -Tlint */          OUTT_LINT,      /* -Tlint */
         OUTT_PS,        /* -Tps */          OUTT_PS,        /* -Tps */
         OUTT_PDF        /* -Tpdf */          OUTT_PDF        /* -Tpdf */
Line 53  enum outt {
Line 76  enum outt {
   
 struct  curparse {  struct  curparse {
         struct mparse    *mp;          struct mparse    *mp;
           struct mchars    *mchars;       /* character table */
         enum mandoclevel  wlevel;       /* ignore messages below this */          enum mandoclevel  wlevel;       /* ignore messages below this */
         int               wstop;        /* stop after a file with a warning */          int               wstop;        /* stop after a file with a warning */
         enum outt         outtype;      /* which output to use */          enum outt         outtype;      /* which output to use */
         out_mdoc          outmdoc;      /* mdoc output ptr */          out_mdoc          outmdoc;      /* mdoc output ptr */
         out_man           outman;       /* man output ptr */          out_man           outman;       /* man output ptr */
         out_free          outfree;      /* free 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 */          struct manoutput *outopts;      /* output options */
 };  };
   
 static  const char * const      mandoclevels[MANDOCLEVEL_MAX] = {  static  int               fs_lookup(const struct manpaths *,
         "SUCCESS",                                  size_t ipath, const char *,
         "RESERVED",                                  const char *, const char *,
         "WARNING",                                  struct manpage **, size_t *);
         "ERROR",  static  void              fs_search(const struct mansearch *,
         "FATAL",                                  const struct manpaths *, int, char**,
         "BADARG",                                  struct manpage **, size_t *);
         "SYSERR"  static  void              handle_sigpipe(int);
 };  static  int               koptions(int *, char *);
   #if HAVE_SQLITE3
 static  const char * const      mandocerrs[MANDOCERR_MAX] = {  int                       mandocdb(int, char**);
         "ok",  #endif
   static  int               moptions(int *, char *);
         "generic warning",  
   
         /* related to the prologue */  
         "no title in document",  
         "document title should be all caps",  
         "unknown manual section",  
         "date missing, using today's date",  
         "cannot parse date, using it verbatim",  
         "prologue macros out of order",  
         "duplicate prologue macro",  
         "macro not allowed in prologue",  
         "macro not allowed in body",  
   
         /* related to document structure */  
         ".so is fragile, better use ln(1)",  
         "NAME section must come first",  
         "bad NAME section contents",  
         "manual name not yet set",  
         "sections out of conventional order",  
         "duplicate section name",  
         "section not in conventional manual section",  
   
         /* related to macros and nesting */  
         "skipping obsolete macro",  
         "skipping paragraph macro",  
         "skipping no-space macro",  
         "blocks badly nested",  
         "child violates parent syntax",  
         "nested displays are not portable",  
         "already in literal mode",  
         "line scope broken",  
   
         /* related to missing macro arguments */  
         "skipping empty macro",  
         "argument count wrong",  
         "missing display type",  
         "list type must come first",  
         "tag lists require a width argument",  
         "missing font type",  
         "skipping end of block that is not open",  
   
         /* related to bad macro arguments */  
         "skipping argument",  
         "duplicate argument",  
         "duplicate display type",  
         "duplicate list type",  
         "unknown AT&T UNIX version",  
         "bad Boolean value",  
         "unknown font",  
         "unknown standard specifier",  
         "bad width argument",  
   
         /* related to plain text */  
         "blank line in non-literal context",  
         "tab in non-literal context",  
         "end of line whitespace",  
         "bad comment style",  
         "unknown escape sequence",  
         "unterminated quoted string",  
   
         "generic error",  
   
         /* related to tables */  
         "bad table syntax",  
         "bad table option",  
         "bad table layout",  
         "no table layout cells specified",  
         "no table data cells specified",  
         "ignore data in cell",  
         "data block still open",  
         "ignoring extra data cells",  
   
         "input stack limit exceeded, infinite loop?",  
         "skipping bad character",  
         "escaped character not allowed in a name",  
         "skipping text before the first section header",  
         "skipping unknown macro",  
         "NOT IMPLEMENTED, please use groff: skipping request",  
         "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",  
   
         "not a manual",  
         "column syntax is inconsistent",  
         "NOT IMPLEMENTED: .Bd -file",  
         "line scope broken, syntax violated",  
         "argument count wrong, violates syntax",  
         "child violates parent syntax",  
         "argument count wrong, violates syntax",  
         "NOT IMPLEMENTED: .so with absolute path or \"..\"",  
         "no document body",  
         "no document prologue",  
         "static buffer exhausted",  
 };  
   
 static  int               moptions(enum mparset *, char *);  
 static  void              mmsg(enum mandocerr, enum mandoclevel,  static  void              mmsg(enum mandocerr, enum mandoclevel,
                                 const char *, int, int, const char *);                                  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  pid_t             spawn_pager(void);
 static  int               toptions(struct curparse *, char *);  static  int               toptions(struct curparse *, char *);
 static  void              usage(void) __attribute__((noreturn));  static  void              usage(enum argmode) __attribute__((noreturn));
 static  void              version(void) __attribute__((noreturn));  
 static  int               woptions(struct curparse *, char *);  static  int               woptions(struct curparse *, char *);
   
   static  const 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  const char       *progname;
   static  enum mandoclevel  rc;
   
   
 int  int
 main(int argc, char *argv[])  main(int argc, char *argv[])
 {  {
         int              c;          struct manconf   conf;
         struct curparse  curp;          struct curparse  curp;
         enum mparset     type;          struct mansearch search;
         enum mandoclevel rc;          char            *auxpaths;
           char            *defos;
           unsigned char   *uc;
           struct manpage  *res, *resp;
           char            *conf_file, *defpaths;
           size_t           isec, i, sz;
           int              prio, best_prio;
           char             sec;
           enum mandoclevel rctmp;
           enum outmode     outmode;
           int              fd;
           int              show_usage;
           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];                  progname = argv[0];
         else          else
                 ++progname;                  ++progname;
   
   #if HAVE_SQLITE3
           if (strcmp(progname, BINM_MAKEWHATIS) == 0)
                   return(mandocdb(argc, argv));
   #endif
   
           /* Search options. */
   
           memset(&conf, 0, sizeof(conf));
           conf_file = defpaths = NULL;
           auxpaths = NULL;
   
           memset(&search, 0, sizeof(struct mansearch));
           search.outkey = "Nd";
   
           if (strcmp(progname, BINM_MAN) == 0)
                   search.argmode = ARG_NAME;
           else if (strcmp(progname, BINM_APROPOS) == 0)
                   search.argmode = ARG_EXPR;
           else if (strcmp(progname, BINM_WHATIS) == 0)
                   search.argmode = ARG_WORD;
           else if (strncmp(progname, "help", 4) == 0)
                   search.argmode = ARG_NAME;
           else
                   search.argmode = ARG_FILE;
   
           /* Parser and formatter options. */
   
         memset(&curp, 0, sizeof(struct curparse));          memset(&curp, 0, sizeof(struct curparse));
           curp.outtype = OUTT_LOCALE;
           curp.wlevel  = MANDOCLEVEL_BADARG;
           curp.outopts = &conf.output;
           options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
           defos = NULL;
   
         type = MPARSE_AUTO;          pager_pid = 1;
         curp.outtype = OUTT_ASCII;          show_usage = 0;
         curp.wlevel  = MANDOCLEVEL_FATAL;          outmode = OUTMODE_DEF;
   
         /* LINTED */          while (-1 != (c = getopt(argc, argv,
         while (-1 != (c = getopt(argc, argv, "m:O:T:VW:")))                          "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
                 switch (c) {                  switch (c) {
                 case ('m'):                  case 'a':
                         if ( ! moptions(&type, optarg))                          outmode = OUTMODE_ALL;
                           break;
                   case 'C':
                           conf_file = optarg;
                           break;
                   case 'c':
                           pager_pid = 0;
                           break;
                   case 'f':
                           search.argmode = ARG_WORD;
                           break;
                   case 'h':
                           conf.output.synopsisonly = 1;
                           pager_pid = 0;
                           outmode = OUTMODE_ALL;
                           break;
                   case 'I':
                           if (strncmp(optarg, "os=", 3)) {
                                   fprintf(stderr,
                                       "%s: -I %s: Bad argument\n",
                                       progname, optarg);
                                 return((int)MANDOCLEVEL_BADARG);                                  return((int)MANDOCLEVEL_BADARG);
                           }
                           if (defos) {
                                   fprintf(stderr,
                                       "%s: -I %s: Duplicate argument\n",
                                       progname, optarg);
                                   return((int)MANDOCLEVEL_BADARG);
                           }
                           defos = mandoc_strdup(optarg + 3);
                         break;                          break;
                 case ('O'):                  case 'i':
                         (void)strlcat(curp.outopts, optarg, BUFSIZ);                          outmode = OUTMODE_INT;
                         (void)strlcat(curp.outopts, ",", BUFSIZ);  
                         break;                          break;
                 case ('T'):                  case 'K':
                           if ( ! koptions(&options, optarg))
                                   return((int)MANDOCLEVEL_BADARG);
                           break;
                   case 'k':
                           search.argmode = ARG_EXPR;
                           break;
                   case 'l':
                           search.argmode = ARG_FILE;
                           outmode = OUTMODE_ALL;
                           break;
                   case 'M':
                           defpaths = optarg;
                           break;
                   case 'm':
                           auxpaths = optarg;
                           break;
                   case 'O':
                           search.outkey = optarg;
                           while (optarg != NULL)
                                   manconf_output(&conf.output,
                                       strsep(&optarg, ","));
                           break;
                   case 'S':
                           search.arch = optarg;
                           break;
                   case 's':
                           search.sec = optarg;
                           break;
                   case 'T':
                         if ( ! toptions(&curp, optarg))                          if ( ! toptions(&curp, optarg))
                                 return((int)MANDOCLEVEL_BADARG);                                  return((int)MANDOCLEVEL_BADARG);
                         break;                          break;
                 case ('W'):                  case 'W':
                         if ( ! woptions(&curp, optarg))                          if ( ! woptions(&curp, optarg))
                                 return((int)MANDOCLEVEL_BADARG);                                  return((int)MANDOCLEVEL_BADARG);
                         break;                          break;
                 case ('V'):                  case 'w':
                         version();                          outmode = OUTMODE_FLN;
                         /* NOTREACHED */                          break;
                 default:                  default:
                         usage();                          show_usage = 1;
                         /* NOTREACHED */                          break;
                 }                  }
           }
   
         curp.mp = mparse_alloc(type, curp.wlevel, mmsg, &curp);          if (show_usage)
                   usage(search.argmode);
   
         argc -= optind;          /* Postprocess options. */
         argv += optind;  
   
           if (outmode == OUTMODE_DEF) {
                   switch (search.argmode) {
                   case ARG_FILE:
                           outmode = OUTMODE_ALL;
                           pager_pid = 0;
                           break;
                   case ARG_NAME:
                           outmode = OUTMODE_ONE;
                           break;
                   default:
                           outmode = OUTMODE_LST;
                           break;
                   }
           }
   
           /* Parse arguments. */
   
           if (argc > 0) {
                   argc -= optind;
                   argv += optind;
           }
           resp = NULL;
   
           /*
            * Quirks for help(1)
            * and for a man(1) section argument without -s.
            */
   
           if (search.argmode == ARG_NAME) {
                   if (*progname == 'h') {
                           if (argc == 0) {
                                   argv = help_argv;
                                   argc = 1;
                           }
                   } else if (argc > 1 &&
                       ((uc = (unsigned char *)argv[0]) != NULL) &&
                       ((isdigit(uc[0]) && (uc[1] == '\0' ||
                         (isalpha(uc[1]) && uc[2] == '\0'))) ||
                        (uc[0] == 'n' && uc[1] == '\0'))) {
                           search.sec = (char *)uc;
                           argv++;
                           argc--;
                   }
                   if (search.arch == NULL)
                           search.arch = getenv("MACHINE");
   #ifdef MACHINE
                   if (search.arch == NULL)
                           search.arch = MACHINE;
   #endif
           }
   
         rc = MANDOCLEVEL_OK;          rc = MANDOCLEVEL_OK;
   
         if (NULL == *argv)          /* man(1), whatis(1), apropos(1) */
                 parse(&curp, STDIN_FILENO, "<stdin>", &rc);  
   
         while (*argv) {          if (search.argmode != ARG_FILE) {
                 parse(&curp, -1, *argv, &rc);                  if (argc == 0)
                           usage(search.argmode);
   
                   if (search.argmode == ARG_NAME &&
                       outmode == OUTMODE_ONE)
                           search.firstmatch = 1;
   
                   /* Access the mandoc database. */
   
                   manconf_parse(&conf, conf_file, defpaths, auxpaths);
   #if HAVE_SQLITE3
                   mansearch_setup(1);
                   if ( ! mansearch(&search, &conf.manpath,
                       argc, argv, &res, &sz))
                           usage(search.argmode);
   #else
                   if (search.argmode != ARG_NAME) {
                           fputs("mandoc: database support not compiled in\n",
                               stderr);
                           return((int)MANDOCLEVEL_BADARG);
                   }
                   sz = 0;
   #endif
   
                   if (sz == 0 && search.argmode == ARG_NAME)
                           fs_search(&search, &conf.manpath,
                               argc, argv, &res, &sz);
   
                   if (sz == 0) {
                           rc = MANDOCLEVEL_BADARG;
                           goto out;
                   }
   
                   /*
                    * For standard man(1) and -a output mode,
                    * prepare for copying filename pointers
                    * into the program parameter array.
                    */
   
                   if (outmode == OUTMODE_ONE) {
                           argc = 1;
                           best_prio = 10;
                   } else if (outmode == OUTMODE_ALL)
                           argc = (int)sz;
   
                   /* Iterate all matching manuals. */
   
                   resp = res;
                   for (i = 0; i < sz; i++) {
                           if (outmode == OUTMODE_FLN)
                                   puts(res[i].file);
                           else if (outmode == OUTMODE_LST)
                                   printf("%s - %s\n", res[i].names,
                                       res[i].output == NULL ? "" :
                                       res[i].output);
                           else if (outmode == OUTMODE_ONE) {
                                   /* Search for the best section. */
                                   isec = strcspn(res[i].file, "123456789");
                                   sec = res[i].file[isec];
                                   if ('\0' == sec)
                                           continue;
                                   prio = sec_prios[sec - '1'];
                                   if (prio >= best_prio)
                                           continue;
                                   best_prio = prio;
                                   resp = res + i;
                           }
                   }
   
                   /*
                    * For man(1), -a and -i output mode, fall through
                    * to the main mandoc(1) code iterating files
                    * and running the parsers on each of them.
                    */
   
                   if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
                           goto out;
           }
   
           /* mandoc(1) */
   
           if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths))
                   return((int)MANDOCLEVEL_BADARG);
   
           curp.mchars = mchars_alloc();
           curp.mp = mparse_alloc(options, curp.wlevel, mmsg,
               curp.mchars, defos);
   
           /*
            * Conditionally start up the lookaside buffer before parsing.
            */
           if (OUTT_MAN == curp.outtype)
                   mparse_keep(curp.mp);
   
           if (argc < 1) {
                   if (pager_pid == 1 && isatty(STDOUT_FILENO))
                           pager_pid = spawn_pager();
                   parse(&curp, STDIN_FILENO, "<stdin>");
           }
   
           while (argc > 0) {
                   rctmp = mparse_open(curp.mp, &fd,
                       resp != NULL ? resp->file : *argv);
                   if (rc < rctmp)
                           rc = rctmp;
   
                   if (fd != -1) {
                           if (pager_pid == 1 && isatty(STDOUT_FILENO))
                                   pager_pid = spawn_pager();
   
                           if (resp == NULL)
                                   parse(&curp, fd, *argv);
                           else if (resp->form & FORM_SRC) {
                                   /* For .so only; ignore failure. */
                                   chdir(conf.manpath.paths[resp->ipath]);
                                   parse(&curp, fd, resp->file);
                           } else
                                   passthrough(resp->file, fd,
                                       conf.output.synopsisonly);
   
                           rctmp = mparse_wait(curp.mp);
                           if (rc < rctmp)
                                   rc = rctmp;
   
                           if (argc > 1 && curp.outtype <= OUTT_UTF8)
                                   ascii_sepline(curp.outdata);
                   }
   
                 if (MANDOCLEVEL_OK != rc && curp.wstop)                  if (MANDOCLEVEL_OK != rc && curp.wstop)
                         break;                          break;
                 ++argv;  
                   if (resp != NULL)
                           resp++;
                   else
                           argv++;
                   if (--argc)
                           mparse_reset(curp.mp);
         }          }
   
         if (curp.outfree)          if (curp.outfree)
                 (*curp.outfree)(curp.outdata);                  (*curp.outfree)(curp.outdata);
         if (curp.mp)          mparse_free(curp.mp);
                 mparse_free(curp.mp);          mchars_free(curp.mchars);
   
   out:
           if (search.argmode != ARG_FILE) {
                   manconf_free(&conf);
   #if HAVE_SQLITE3
                   mansearch_free(res, sz);
                   mansearch_setup(0);
   #endif
           }
   
           free(defos);
   
           /*
            * 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.
            */
   
           if (pager_pid != 0 && pager_pid != 1) {
                   fclose(stdout);
                   waitpid(pager_pid, NULL, 0);
           }
   
         return((int)rc);          return((int)rc);
 }  }
   
 static void  static void
 version(void)  usage(enum argmode argmode)
 {  {
   
         printf("%s %s\n", progname, VERSION);          switch (argmode) {
         exit((int)MANDOCLEVEL_OK);          case ARG_FILE:
                   fputs("usage: mandoc [-acfhkl] [-I os=name] "
                       "[-K encoding] [-mformat] [-O option]\n"
                       "\t      [-T output] [-W level] [file ...]\n", stderr);
                   break;
           case ARG_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 [-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 [-acfhklw] [-C file] "
                       "[-M path] [-m path] [-O outkey] [-S arch]\n"
                       "\t       [-s section] expression ...\n", stderr);
                   break;
           }
           exit((int)MANDOCLEVEL_BADARG);
 }  }
   
   static int
   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, globres;
   
           form = FORM_SRC;
           mandoc_asprintf(&file, "%s/man%s/%s.%s",
               paths->paths[ipath], sec, name, sec);
           if (access(file, R_OK) != -1)
                   goto found;
           free(file);
   
           mandoc_asprintf(&file, "%s/cat%s/%s.0",
               paths->paths[ipath], sec, name);
           if (access(file, R_OK) != -1) {
                   form = FORM_CAT;
                   goto found;
           }
           free(file);
   
           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)
                           goto found;
                   free(file);
           }
   
           mandoc_asprintf(&file, "%s/man%s/%s.*",
               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, run "
               "makewhatis %s\n", progname, name, sec, paths->paths[ipath]);
   #endif
           *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
           page = *res + (*ressz - 1);
           page->file = file;
           page->names = NULL;
           page->output = NULL;
           page->ipath = ipath;
           page->bits = NAME_FILE & NAME_MASK;
           page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
           page->form = form;
           return(1);
   }
   
 static void  static void
 usage(void)  fs_search(const struct mansearch *cfg, const struct manpaths *paths,
           int argc, char **argv, struct manpage **res, size_t *ressz)
 {  {
           const char *const sections[] =
               {"1", "8", "6", "2", "3", "3p", "5", "7", "4", "9"};
           const size_t nsec = sizeof(sections)/sizeof(sections[0]);
   
         fprintf(stderr, "usage: %s "          size_t           ipath, isec, lastsz;
                         "[-V] "  
                         "[-foption] "  
                         "[-mformat] "  
                         "[-Ooption] "  
                         "[-Toutput] "  
                         "[-Werr] "  
                         "[file...]\n",  
                         progname);  
   
         exit((int)MANDOCLEVEL_BADARG);          assert(cfg->argmode == ARG_NAME);
   
           *res = NULL;
           *ressz = lastsz = 0;
           while (argc) {
                   for (ipath = 0; ipath < paths->sz; ipath++) {
                           if (cfg->sec != NULL) {
                                   if (fs_lookup(paths, ipath, cfg->sec,
                                       cfg->arch, *argv, res, ressz) &&
                                       cfg->firstmatch)
                                           return;
                           } else for (isec = 0; isec < nsec; isec++)
                                   if (fs_lookup(paths, ipath, sections[isec],
                                       cfg->arch, *argv, res, ressz) &&
                                       cfg->firstmatch)
                                           return;
                   }
                   if (*ressz == lastsz)
                           fprintf(stderr,
                               "%s: No entry for %s in the manual.\n",
                               progname, *argv);
                   lastsz = *ressz;
                   argv++;
                   argc--;
           }
 }  }
   
 static void  static void
 parse(struct curparse *curp, int fd,  parse(struct curparse *curp, int fd, const char *file)
                 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. */          /* Begin by parsing the file itself. */
   
         assert(file);          assert(file);
         assert(fd >= -1);          assert(fd >= -1);
   
         rc = mparse_readfd(curp->mp, fd, file);          rctmp = mparse_readfd(curp->mp, fd, file);
           if (rc < rctmp)
                   rc = rctmp;
   
         /* Stop immediately if the parse has failed. */  
   
         if (MANDOCLEVEL_FATAL <= rc)  
                 goto cleanup;  
   
         /*          /*
          * With -Wstop and warnings or errors of at least the requested           * With -Wstop and warnings or errors of at least the requested
          * level, do not produce output.           * 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). */          /* If unset, allocate output dev now (if applicable). */
   
         if ( ! (curp->outman && curp->outmdoc)) {          if ( ! (curp->outman && curp->outmdoc)) {
                 switch (curp->outtype) {                  switch (curp->outtype) {
                 case (OUTT_XHTML):                  case OUTT_HTML:
                         curp->outdata = xhtml_alloc(curp->outopts);                          curp->outdata = html_alloc(curp->mchars,
                               curp->outopts);
                           curp->outfree = html_free;
                         break;                          break;
                 case (OUTT_HTML):                  case OUTT_UTF8:
                         curp->outdata = html_alloc(curp->outopts);                          curp->outdata = utf8_alloc(curp->mchars,
                               curp->outopts);
                           curp->outfree = ascii_free;
                         break;                          break;
                 case (OUTT_ASCII):                  case OUTT_LOCALE:
                         curp->outdata = ascii_alloc(curp->outopts);                          curp->outdata = locale_alloc(curp->mchars,
                               curp->outopts);
                         curp->outfree = ascii_free;                          curp->outfree = ascii_free;
                         break;                          break;
                 case (OUTT_PDF):                  case OUTT_ASCII:
                         curp->outdata = pdf_alloc(curp->outopts);                          curp->outdata = ascii_alloc(curp->mchars,
                               curp->outopts);
                           curp->outfree = ascii_free;
                           break;
                   case OUTT_PDF:
                           curp->outdata = pdf_alloc(curp->mchars,
                               curp->outopts);
                         curp->outfree = pspdf_free;                          curp->outfree = pspdf_free;
                         break;                          break;
                 case (OUTT_PS):                  case OUTT_PS:
                         curp->outdata = ps_alloc(curp->outopts);                          curp->outdata = ps_alloc(curp->mchars,
                               curp->outopts);
                         curp->outfree = pspdf_free;                          curp->outfree = pspdf_free;
                         break;                          break;
                 default:                  default:
Line 345  parse(struct curparse *curp, int fd, 
Line 690  parse(struct curparse *curp, int fd, 
                 }                  }
   
                 switch (curp->outtype) {                  switch (curp->outtype) {
                 case (OUTT_HTML):                  case OUTT_HTML:
                         /* FALLTHROUGH */  
                 case (OUTT_XHTML):  
                         curp->outman = html_man;                          curp->outman = html_man;
                         curp->outmdoc = html_mdoc;                          curp->outmdoc = html_mdoc;
                         curp->outfree = html_free;  
                         break;                          break;
                 case (OUTT_TREE):                  case OUTT_TREE:
                         curp->outman = tree_man;                          curp->outman = tree_man;
                         curp->outmdoc = tree_mdoc;                          curp->outmdoc = tree_mdoc;
                         break;                          break;
                 case (OUTT_PDF):                  case OUTT_MAN:
                           curp->outmdoc = man_mdoc;
                           curp->outman = man_man;
                           break;
                   case OUTT_PDF:
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (OUTT_ASCII):                  case OUTT_ASCII:
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (OUTT_PS):                  case OUTT_UTF8:
                           /* FALLTHROUGH */
                   case OUTT_LOCALE:
                           /* FALLTHROUGH */
                   case OUTT_PS:
                         curp->outman = terminal_man;                          curp->outman = terminal_man;
                         curp->outmdoc = terminal_mdoc;                          curp->outmdoc = terminal_mdoc;
                         break;                          break;
Line 369  parse(struct curparse *curp, int fd, 
Line 719  parse(struct curparse *curp, int fd, 
                 }                  }
         }          }
   
         mparse_result(curp->mp, &mdoc, &man);          mparse_result(curp->mp, &man, NULL);
   
         /* Execute the out device, if it exists. */          /* 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);                  (*curp->outman)(curp->outdata, man);
         if (mdoc && curp->outmdoc)  }
                 (*curp->outmdoc)(curp->outdata, mdoc);  
   
  cleanup:  static void
   passthrough(const char *file, int fd, int synopsis_only)
   {
           const char       synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
           const char       synr[] = "SYNOPSIS";
   
         mparse_reset(curp->mp);          FILE            *stream;
           const char      *syscall;
           char            *line;
           size_t           len, off;
           ssize_t          nw;
           int              print;
   
         if (*level < rc)          fflush(stdout);
                 *level = rc;  
           if ((stream = fdopen(fd, "r")) == NULL) {
                   close(fd);
                   syscall = "fdopen";
                   goto fail;
           }
   
           print = 0;
           while ((line = fgetln(stream, &len)) != NULL) {
                   if (synopsis_only) {
                           if (print) {
                                   if ( ! isspace((unsigned char)*line))
                                           goto done;
                                   while (len &&
                                       isspace((unsigned char)*line)) {
                                           line++;
                                           len--;
                                   }
                           } else {
                                   if ((len == sizeof(synb) &&
                                        ! strncmp(line, synb, len - 1)) ||
                                       (len == sizeof(synr) &&
                                        ! strncmp(line, synr, len - 1)))
                                           print = 1;
                                   continue;
                           }
                   }
                   for (off = 0; off < len; off += nw)
                           if ((nw = write(STDOUT_FILENO, line + off,
                               len - off)) == -1 || nw == 0) {
                                   fclose(stream);
                                   syscall = "write";
                                   goto fail;
                           }
           }
   
           if (ferror(stream)) {
                   fclose(stream);
                   syscall = "fgetln";
                   goto fail;
           }
   
   done:
           fclose(stream);
           return;
   
   fail:
           fprintf(stderr, "%s: %s: SYSERR: %s: %s",
               progname, file, syscall, strerror(errno));
           if (rc < MANDOCLEVEL_SYSERR)
                   rc = MANDOCLEVEL_SYSERR;
 }  }
   
 static int  static int
 moptions(enum mparset *tflags, char *arg)  koptions(int *options, char *arg)
 {  {
   
         if (0 == strcmp(arg, "doc"))          if ( ! strcmp(arg, "utf-8")) {
                 *tflags = MPARSE_MDOC;                  *options |=  MPARSE_UTF8;
                   *options &= ~MPARSE_LATIN1;
           } else if ( ! strcmp(arg, "iso-8859-1")) {
                   *options |=  MPARSE_LATIN1;
                   *options &= ~MPARSE_UTF8;
           } else if ( ! strcmp(arg, "us-ascii")) {
                   *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
           } else {
                   fprintf(stderr, "%s: -K %s: Bad argument\n",
                       progname, arg);
                   return(0);
           }
           return(1);
   }
   
   static int
   moptions(int *options, char *arg)
   {
   
           if (arg == NULL)
                   /* nothing to do */;
           else if (0 == strcmp(arg, "doc"))
                   *options |= MPARSE_MDOC;
         else if (0 == strcmp(arg, "andoc"))          else if (0 == strcmp(arg, "andoc"))
                 *tflags = MPARSE_AUTO;                  /* nothing to do */;
         else if (0 == strcmp(arg, "an"))          else if (0 == strcmp(arg, "an"))
                 *tflags = MPARSE_MAN;                  *options |= MPARSE_MAN;
         else {          else {
                 fprintf(stderr, "%s: Bad argument\n", arg);                  fprintf(stderr, "%s: -m %s: Bad argument\n",
                       progname, arg);
                 return(0);                  return(0);
         }          }
   
Line 415  toptions(struct curparse *curp, char *arg)
Line 850  toptions(struct curparse *curp, char *arg)
                 curp->wlevel  = MANDOCLEVEL_WARNING;                  curp->wlevel  = MANDOCLEVEL_WARNING;
         } else if (0 == strcmp(arg, "tree"))          } else if (0 == strcmp(arg, "tree"))
                 curp->outtype = OUTT_TREE;                  curp->outtype = OUTT_TREE;
           else if (0 == strcmp(arg, "man"))
                   curp->outtype = OUTT_MAN;
         else if (0 == strcmp(arg, "html"))          else if (0 == strcmp(arg, "html"))
                 curp->outtype = OUTT_HTML;                  curp->outtype = OUTT_HTML;
           else if (0 == strcmp(arg, "utf8"))
                   curp->outtype = OUTT_UTF8;
           else if (0 == strcmp(arg, "locale"))
                   curp->outtype = OUTT_LOCALE;
         else if (0 == strcmp(arg, "xhtml"))          else if (0 == strcmp(arg, "xhtml"))
                 curp->outtype = OUTT_XHTML;                  curp->outtype = OUTT_HTML;
         else if (0 == strcmp(arg, "ps"))          else if (0 == strcmp(arg, "ps"))
                 curp->outtype = OUTT_PS;                  curp->outtype = OUTT_PS;
         else if (0 == strcmp(arg, "pdf"))          else if (0 == strcmp(arg, "pdf"))
                 curp->outtype = OUTT_PDF;                  curp->outtype = OUTT_PDF;
         else {          else {
                 fprintf(stderr, "%s: Bad argument\n", arg);                  fprintf(stderr, "%s: -T %s: Bad argument\n",
                       progname, arg);
                 return(0);                  return(0);
         }          }
   
Line 435  static int
Line 877  static int
 woptions(struct curparse *curp, char *arg)  woptions(struct curparse *curp, char *arg)
 {  {
         char            *v, *o;          char            *v, *o;
         const char      *toks[6];          const char      *toks[7];
   
         toks[0] = "stop";          toks[0] = "stop";
         toks[1] = "all";          toks[1] = "all";
         toks[2] = "warning";          toks[2] = "warning";
         toks[3] = "error";          toks[3] = "error";
         toks[4] = "fatal";          toks[4] = "unsupp";
         toks[5] = NULL;          toks[5] = "fatal";
           toks[6] = NULL;
   
         while (*arg) {          while (*arg) {
                 o = arg;                  o = arg;
                 switch (getsubopt(&arg, UNCONST(toks), &v)) {                  switch (getsubopt(&arg, UNCONST(toks), &v)) {
                 case (0):                  case 0:
                         curp->wstop = 1;                          curp->wstop = 1;
                         break;                          break;
                 case (1):                  case 1:
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (2):                  case 2:
                         curp->wlevel = MANDOCLEVEL_WARNING;                          curp->wlevel = MANDOCLEVEL_WARNING;
                         break;                          break;
                 case (3):                  case 3:
                         curp->wlevel = MANDOCLEVEL_ERROR;                          curp->wlevel = MANDOCLEVEL_ERROR;
                         break;                          break;
                 case (4):                  case 4:
                         curp->wlevel = MANDOCLEVEL_FATAL;                          curp->wlevel = MANDOCLEVEL_UNSUPP;
                         break;                          break;
                   case 5:
                           curp->wlevel = MANDOCLEVEL_BADARG;
                           break;
                 default:                  default:
                         fprintf(stderr, "-W%s: Bad argument\n", o);                          fprintf(stderr, "%s: -W %s: Bad argument\n",
                               progname, o);
                         return(0);                          return(0);
                 }                  }
         }          }
Line 471  woptions(struct curparse *curp, char *arg)
Line 918  woptions(struct curparse *curp, char *arg)
 }  }
   
 static void  static void
 mmsg(enum mandocerr t, enum mandoclevel lvl,  mmsg(enum mandocerr t, enum mandoclevel lvl,
                 const char *file, int line, int col, const char *msg)                  const char *file, int line, int col, const char *msg)
 {  {
           const char      *mparse_msg;
   
         fprintf(stderr, "%s:%d:%d: %s: %s",          fprintf(stderr, "%s: %s:", progname, file);
                         file, line, col + 1,  
                         mandoclevels[lvl], mandocerrs[t]);  
   
           if (line)
                   fprintf(stderr, "%d:%d:", line, col + 1);
   
           fprintf(stderr, " %s", mparse_strlevel(lvl));
   
           if (NULL != (mparse_msg = mparse_strerror(t)))
                   fprintf(stderr, ": %s", mparse_msg);
   
         if (msg)          if (msg)
                 fprintf(stderr, ": %s", msg);                  fprintf(stderr, ": %s", msg);
   
         fputc('\n', stderr);          fputc('\n', stderr);
   }
   
   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;
           int              fildes[2];
           int              argc;
           pid_t            pager_pid;
   
           if (pipe(fildes) == -1) {
                   fprintf(stderr, "%s: pipe: %s\n",
                       progname, strerror(errno));
                   return(0);
           }
   
           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);
                   }
                   close(fildes[1]);
                   signal(SIGPIPE, handle_sigpipe);
                   return(pager_pid);
           }
   
           /* The child process becomes the pager. */
   
           close(fildes[1]);
           if (dup2(fildes[0], STDIN_FILENO) == -1) {
                   fprintf(stderr, "%s: dup input: %s\n",
                       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 = "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",
               progname, strerror(errno));
           exit((int)MANDOCLEVEL_SYSERR);
 }  }
Legend:
Removed from v.1.159  
changed lines
  Added in v.1.235
CVSweb