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

Diff for /mandoc/main.c between version 1.169 and 1.280

version 1.169, 2014/01/06 00:53:33 version 1.280, 2017/01/27 13:47:10
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, 2012 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2010-2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>   * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * 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>
   #if HAVE_ERR
   #include <err.h>
   #endif
   #include <errno.h>
   #include <fcntl.h>
   #include <glob.h>
   #if HAVE_SANDBOX_INIT
   #include <sandbox.h>
   #endif
   #include <signal.h>
 #include <stdio.h>  #include <stdio.h>
 #include <stdint.h>  #include <stdint.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
   #include <time.h>
 #include <unistd.h>  #include <unistd.h>
   
   #include "mandoc_aux.h"
 #include "mandoc.h"  #include "mandoc.h"
 #include "main.h"  #include "roff.h"
 #include "mdoc.h"  #include "mdoc.h"
 #include "man.h"  #include "man.h"
   #include "tag.h"
   #include "main.h"
   #include "manconf.h"
   #include "mansearch.h"
   
 #if !defined(__GNUC__) || (__GNUC__ < 2)  enum    outmode {
 # if !defined(lint)          OUTMODE_DEF = 0,
 #  define __attribute__(x)          OUTMODE_FLN,
 # endif          OUTMODE_LST,
 #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */          OUTMODE_ALL,
           OUTMODE_INT,
           OUTMODE_ONE
   };
   
 typedef void            (*out_mdoc)(void *, const struct mdoc *);  
 typedef void            (*out_man)(void *, const struct man *);  
 typedef void            (*out_free)(void *);  
   
 enum    outt {  enum    outt {
         OUTT_ASCII = 0, /* -Tascii */          OUTT_ASCII = 0, /* -Tascii */
         OUTT_LOCALE,    /* -Tlocale */          OUTT_LOCALE,    /* -Tlocale */
Line 49  enum outt {
Line 67  enum outt {
         OUTT_TREE,      /* -Ttree */          OUTT_TREE,      /* -Ttree */
         OUTT_MAN,       /* -Tman */          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 59  struct curparse {
Line 76  struct curparse {
         struct mparse    *mp;          struct mparse    *mp;
         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_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 */          struct manoutput *outopts;      /* output options */
 };  };
   
 static  int               moptions(enum mparset *, char *);  
   int                       mandocdb(int, char *[]);
   
   static  int               fs_lookup(const struct manpaths *,
                                   size_t ipath, const char *,
                                   const char *, const char *,
                                   struct manpage **, size_t *);
   static  void              fs_search(const struct mansearch *,
                                   const struct manpaths *, int, char**,
                                   struct manpage **, size_t *);
   static  int               koptions(int *, char *);
   static  int               moptions(int *, 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              outdata_alloc(struct curparse *);
                                 const char *, enum mandoclevel *);  static  void              parse(struct curparse *, int, const char *);
   static  void              passthrough(const char *, int, int);
   static  pid_t             spawn_pager(struct tag_files *);
 static  int               toptions(struct curparse *, char *);  static  int               toptions(struct curparse *, char *);
 static  void              usage(void) __attribute__((noreturn));  static  void              usage(enum argmode) __attribute__((noreturn));
 static  void              version(void) __attribute__((noreturn));  
 static  int               woptions(struct curparse *, char *);  static  int               woptions(struct curparse *, char *);
   
 static  const char       *progname;  static  const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
   static  char              help_arg[] = "help";
   static  char             *help_argv[] = {help_arg, NULL};
   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;          struct tag_files *tag_files;
           const char      *progname;
           char            *auxpaths;
         char            *defos;          char            *defos;
           unsigned char   *uc;
           struct manpage  *res, *resp;
           char            *conf_file, *defpaths;
           const char      *sec;
           const char      *thisarg;
           size_t           i, sz;
           int              prio, best_prio;
           enum outmode     outmode;
           int              fd;
           int              show_usage;
           int              options;
           int              use_pager;
           int              status, signum;
           int              c;
           pid_t            pager_pid, tc_pgid, man_pgid, pid;
   
         progname = strrchr(argv[0], '/');  #if HAVE_PROGNAME
         if (progname == NULL)          progname = getprogname();
   #else
           if (argc < 1)
                   progname = mandoc_strdup("mandoc");
           else if ((progname = strrchr(argv[0], '/')) == NULL)
                 progname = argv[0];                  progname = argv[0];
         else          else
                 ++progname;                  ++progname;
           setprogname(progname);
   #endif
   
         memset(&curp, 0, sizeof(struct curparse));          if (strncmp(progname, "mandocdb", 8) == 0 ||
               strcmp(progname, BINM_MAKEWHATIS) == 0)
                   return mandocdb(argc, argv);
   
         type = MPARSE_AUTO;  #if HAVE_PLEDGE
         curp.outtype = OUTT_ASCII;          if (pledge("stdio rpath tmppath tty proc exec flock", NULL) == -1)
         curp.wlevel  = MANDOCLEVEL_FATAL;                  err((int)MANDOCLEVEL_SYSERR, "pledge");
   #endif
   
   #if HAVE_SANDBOX_INIT
           if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1)
                   errx((int)MANDOCLEVEL_SYSERR, "sandbox_init");
   #endif
   
           /* Search options. */
   
           memset(&conf, 0, sizeof(conf));
           conf_file = defpaths = NULL;
           auxpaths = NULL;
   
           memset(&search, 0, sizeof(struct mansearch));
           search.outkey = "Nd";
   
           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));
           curp.outtype = OUTT_LOCALE;
           curp.wlevel  = MANDOCLEVEL_BADARG;
           curp.outopts = &conf.output;
           options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
         defos = NULL;          defos = NULL;
   
         /* LINTED */          use_pager = 1;
         while (-1 != (c = getopt(argc, argv, "I:m:O:T:VW:")))          tag_files = NULL;
           show_usage = 0;
           outmode = OUTMODE_DEF;
   
           while (-1 != (c = getopt(argc, argv,
                           "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
                 switch (c) {                  switch (c) {
                 case ('I'):                  case 'a':
                           outmode = OUTMODE_ALL;
                           break;
                   case 'C':
                           conf_file = optarg;
                           break;
                   case 'c':
                           use_pager = 0;
                           break;
                   case 'f':
                           search.argmode = ARG_WORD;
                           break;
                   case 'h':
                           conf.output.synopsisonly = 1;
                           use_pager = 0;
                           outmode = OUTMODE_ALL;
                           break;
                   case 'I':
                         if (strncmp(optarg, "os=", 3)) {                          if (strncmp(optarg, "os=", 3)) {
                                 fprintf(stderr, "-I%s: Bad argument\n",                                  warnx("-I %s: Bad argument", optarg);
                                                 optarg);                                  return (int)MANDOCLEVEL_BADARG;
                                 return((int)MANDOCLEVEL_BADARG);  
                         }                          }
                         if (defos) {                          if (defos) {
                                 fprintf(stderr, "-I%s: Duplicate argument\n",                                  warnx("-I %s: Duplicate argument", optarg);
                                                 optarg);                                  return (int)MANDOCLEVEL_BADARG;
                                 return((int)MANDOCLEVEL_BADARG);  
                         }                          }
                         defos = mandoc_strdup(optarg + 3);                          defos = mandoc_strdup(optarg + 3);
                         break;                          break;
                 case ('m'):                  case 'i':
                         if ( ! moptions(&type, optarg))                          outmode = OUTMODE_INT;
                                 return((int)MANDOCLEVEL_BADARG);  
                         break;                          break;
                 case ('O'):                  case 'K':
                         (void)strlcat(curp.outopts, optarg, BUFSIZ);                          if ( ! koptions(&options, optarg))
                         (void)strlcat(curp.outopts, ",", BUFSIZ);                                  return (int)MANDOCLEVEL_BADARG;
                         break;                          break;
                 case ('T'):                  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) {
                                   thisarg = optarg;
                                   if (manconf_output(&conf.output,
                                       strsep(&optarg, ","), 0) == 0)
                                           continue;
                                   warnx("-O %s: Bad argument", thisarg);
                                   return (int)MANDOCLEVEL_BADARG;
                           }
                           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, defos, 0);          if (show_usage)
                   usage(search.argmode);
   
           /* Postprocess options. */
   
           if (outmode == OUTMODE_DEF) {
                   switch (search.argmode) {
                   case ARG_FILE:
                           outmode = OUTMODE_ALL;
                           use_pager = 0;
                           break;
                   case ARG_NAME:
                           outmode = OUTMODE_ONE;
                           break;
                   default:
                           outmode = OUTMODE_LST;
                           break;
                   }
           }
   
           if (outmode == OUTMODE_FLN ||
               outmode == OUTMODE_LST ||
               !isatty(STDOUT_FILENO))
                   use_pager = 0;
   
   #if HAVE_PLEDGE
           if (!use_pager)
                   if (pledge("stdio rpath flock", NULL) == -1)
                           err((int)MANDOCLEVEL_SYSERR, "pledge");
   #endif
   
           /* 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;
   
           /* man(1), whatis(1), apropos(1) */
   
           if (search.argmode != ARG_FILE) {
                   if (search.argmode == ARG_NAME &&
                       outmode == OUTMODE_ONE)
                           search.firstmatch = 1;
   
                   /* Access the mandoc database. */
   
                   manconf_parse(&conf, conf_file, defpaths, auxpaths);
                   if ( ! mansearch(&search, &conf.manpath,
                       argc, argv, &res, &sz))
                           usage(search.argmode);
   
                   if (sz == 0) {
                           if (search.argmode == ARG_NAME)
                                   fs_search(&search, &conf.manpath,
                                       argc, argv, &res, &sz);
                           else
                                   warnx("nothing appropriate");
                   }
   
                   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 = 20;
                   } 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. */
                                   sec = res[i].file;
                                   sec += strcspn(sec, "123456789");
                                   if (sec[0] == '\0')
                                           continue;
                                   prio = sec_prios[sec[0] - '1'];
                                   if (sec[1] != '/')
                                           prio += 10;
                                   if (prio >= best_prio)
                                           continue;
                                   best_prio = prio;
                                   resp = res + i;
                           }
                   }
   
                   /*
                    * 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 HAVE_PLEDGE
           if (use_pager) {
                   if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1)
                           err((int)MANDOCLEVEL_SYSERR, "pledge");
           } else {
                   if (pledge("stdio rpath", NULL) == -1)
                           err((int)MANDOCLEVEL_SYSERR, "pledge");
           }
   #endif
   
           if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths))
                   return (int)MANDOCLEVEL_BADARG;
   
           mchars_alloc();
           curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos);
   
           /*
          * Conditionally start up the lookaside buffer before parsing.           * Conditionally start up the lookaside buffer before parsing.
          */           */
         if (OUTT_MAN == curp.outtype)          if (OUTT_MAN == curp.outtype)
                 mparse_keep(curp.mp);                  mparse_keep(curp.mp);
   
         argc -= optind;          if (argc < 1) {
         argv += optind;                  if (use_pager)
                           tag_files = tag_init();
                   parse(&curp, STDIN_FILENO, "<stdin>");
           }
   
         rc = MANDOCLEVEL_OK;          while (argc > 0) {
                   fd = mparse_open(curp.mp, resp != NULL ? resp->file : *argv);
                   if (fd != -1) {
                           if (use_pager) {
                                   tag_files = tag_init();
                                   use_pager = 0;
                           }
   
         if (NULL == *argv)                          if (resp == NULL)
                 parse(&curp, STDIN_FILENO, "<stdin>", &rc);                                  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);
   
         while (*argv) {                          if (argc > 1 && curp.outtype <= OUTT_UTF8) {
                 parse(&curp, -1, *argv, &rc);                                  if (curp.outdata == NULL)
                                           outdata_alloc(&curp);
                                   terminal_sepline(curp.outdata);
                           }
                   } else if (rc < MANDOCLEVEL_ERROR)
                           rc = MANDOCLEVEL_ERROR;
   
                 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.outdata != NULL) {
                 (*curp.outfree)(curp.outdata);                  switch (curp.outtype) {
         if (curp.mp)                  case OUTT_HTML:
                 mparse_free(curp.mp);                          html_free(curp.outdata);
                           break;
                   case OUTT_UTF8:
                   case OUTT_LOCALE:
                   case OUTT_ASCII:
                           ascii_free(curp.outdata);
                           break;
                   case OUTT_PDF:
                   case OUTT_PS:
                           pspdf_free(curp.outdata);
                           break;
                   default:
                           break;
                   }
           }
           mparse_free(curp.mp);
           mchars_free();
   
   out:
           if (search.argmode != ARG_FILE) {
                   manconf_free(&conf);
                   mansearch_free(res, sz);
           }
   
         free(defos);          free(defos);
   
         return((int)rc);          /*
            * When using a pager, finish writing both temporary files,
            * fork it, wait for the user to close it, and clean up.
            */
   
           if (tag_files != NULL) {
                   fclose(stdout);
                   tag_write();
                   man_pgid = getpgid(0);
                   tag_files->tcpgid = man_pgid == getpid() ?
                       getpgid(getppid()) : man_pgid;
                   pager_pid = 0;
                   signum = SIGSTOP;
                   for (;;) {
   
                           /* Stop here until moved to the foreground. */
   
                           tc_pgid = tcgetpgrp(tag_files->ofd);
                           if (tc_pgid != man_pgid) {
                                   if (tc_pgid == pager_pid) {
                                           (void)tcsetpgrp(tag_files->ofd,
                                               man_pgid);
                                           if (signum == SIGTTIN)
                                                   continue;
                                   } else
                                           tag_files->tcpgid = tc_pgid;
                                   kill(0, signum);
                                   continue;
                           }
   
                           /* Once in the foreground, activate the pager. */
   
                           if (pager_pid) {
                                   (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. */
   
                           while ((pid = waitpid(pager_pid, &status,
                               WUNTRACED)) == -1 && errno == EINTR)
                                   continue;
   
                           if (pid == -1) {
                                   warn("wait");
                                   rc = MANDOCLEVEL_SYSERR;
                                   break;
                           }
                           if (!WIFSTOPPED(status))
                                   break;
   
                           signum = WSTOPSIG(status);
                   }
                   tag_unlink();
           }
   
           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              globres;
           enum form        form;
   
           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.[01-9]*",
               paths->paths[ipath], sec, name);
           globres = glob(file, 0, NULL, &globinfo);
           if (globres != 0 && globres != GLOB_NOMATCH)
                   warn("%s: glob", file);
           free(file);
           if (globres == 0)
                   file = mandoc_strdup(*globinfo.gl_pathv);
           globfree(&globinfo);
           if (globres != 0)
                   return 0;
   
   found:
           warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
               name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
           *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", "5", "7", "4", "9", "3p"};
           const size_t nsec = sizeof(sections)/sizeof(sections[0]);
   
         fprintf(stderr, "usage: %s "          size_t           ipath, isec, lastsz;
                         "[-V] "  
                         "[-Ios=name] "  
                         "[-mformat] "  
                         "[-Ooption] "  
                         "[-Toutput] "  
                         "[-Wlevel]\n"  
                         "\t      [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)
                           warnx("No entry for %s in the manual.", *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 >= 0);
   
         rc = mparse_readfd(curp->mp, fd, file);          rctmp = mparse_readfd(curp->mp, fd, file);
           if (fd != STDIN_FILENO)
                   close(fd);
           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 (curp->outdata == NULL)
                   outdata_alloc(curp);
   
         if ( ! (curp->outman && curp->outmdoc)) {          mparse_result(curp->mp, &man, NULL);
   
           /* Execute the out device, if it exists. */
   
           if (man == NULL)
                   return;
           if (man->macroset == MACROSET_MDOC) {
                   mdoc_validate(man);
                 switch (curp->outtype) {                  switch (curp->outtype) {
                 case (OUTT_XHTML):                  case OUTT_HTML:
                         curp->outdata = xhtml_alloc(curp->outopts);                          html_mdoc(curp->outdata, man);
                         curp->outfree = html_free;  
                         break;                          break;
                 case (OUTT_HTML):                  case OUTT_TREE:
                         curp->outdata = html_alloc(curp->outopts);                          tree_mdoc(curp->outdata, man);
                         curp->outfree = html_free;  
                         break;                          break;
                 case (OUTT_UTF8):                  case OUTT_MAN:
                         curp->outdata = utf8_alloc(curp->outopts);                          man_mdoc(curp->outdata, man);
                         curp->outfree = ascii_free;  
                         break;                          break;
                 case (OUTT_LOCALE):                  case OUTT_PDF:
                         curp->outdata = locale_alloc(curp->outopts);                  case OUTT_ASCII:
                         curp->outfree = ascii_free;                  case OUTT_UTF8:
                   case OUTT_LOCALE:
                   case OUTT_PS:
                           terminal_mdoc(curp->outdata, man);
                         break;                          break;
                 case (OUTT_ASCII):  
                         curp->outdata = ascii_alloc(curp->outopts);  
                         curp->outfree = ascii_free;  
                         break;  
                 case (OUTT_PDF):  
                         curp->outdata = pdf_alloc(curp->outopts);  
                         curp->outfree = pspdf_free;  
                         break;  
                 case (OUTT_PS):  
                         curp->outdata = ps_alloc(curp->outopts);  
                         curp->outfree = pspdf_free;  
                         break;  
                 default:                  default:
                         break;                          break;
                 }                  }
           }
           if (man->macroset == MACROSET_MAN) {
                   man_validate(man);
                 switch (curp->outtype) {                  switch (curp->outtype) {
                 case (OUTT_HTML):                  case OUTT_HTML:
                         /* FALLTHROUGH */                          html_man(curp->outdata, man);
                 case (OUTT_XHTML):  
                         curp->outman = html_man;  
                         curp->outmdoc = html_mdoc;  
                         break;                          break;
                 case (OUTT_TREE):                  case OUTT_TREE:
                         curp->outman = tree_man;                          tree_man(curp->outdata, man);
                         curp->outmdoc = tree_mdoc;  
                         break;                          break;
                 case (OUTT_MAN):                  case OUTT_MAN:
                         curp->outmdoc = man_mdoc;                          man_man(curp->outdata, man);
                         curp->outman = man_man;  
                         break;                          break;
                 case (OUTT_PDF):                  case OUTT_PDF:
                         /* FALLTHROUGH */                  case OUTT_ASCII:
                 case (OUTT_ASCII):                  case OUTT_UTF8:
                         /* FALLTHROUGH */                  case OUTT_LOCALE:
                 case (OUTT_UTF8):                  case OUTT_PS:
                         /* FALLTHROUGH */                          terminal_man(curp->outdata, man);
                 case (OUTT_LOCALE):  
                         /* FALLTHROUGH */  
                 case (OUTT_PS):  
                         curp->outman = terminal_man;  
                         curp->outmdoc = terminal_mdoc;  
                         break;                          break;
                 default:                  default:
                         break;                          break;
                 }                  }
         }          }
           mparse_updaterc(curp->mp, &rc);
   }
   
         mparse_result(curp->mp, &mdoc, &man);  static void
   outdata_alloc(struct curparse *curp)
   {
           switch (curp->outtype) {
           case OUTT_HTML:
                   curp->outdata = html_alloc(curp->outopts);
                   break;
           case OUTT_UTF8:
                   curp->outdata = utf8_alloc(curp->outopts);
                   break;
           case OUTT_LOCALE:
                   curp->outdata = locale_alloc(curp->outopts);
                   break;
           case OUTT_ASCII:
                   curp->outdata = ascii_alloc(curp->outopts);
                   break;
           case OUTT_PDF:
                   curp->outdata = pdf_alloc(curp->outopts);
                   break;
           case OUTT_PS:
                   curp->outdata = ps_alloc(curp->outopts);
                   break;
           default:
                   break;
           }
   }
   
         /* Execute the out device, if it exists. */  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";
   
         if (man && curp->outman)          FILE            *stream;
                 (*curp->outman)(curp->outdata, man);          const char      *syscall;
         if (mdoc && curp->outmdoc)          char            *line, *cp;
                 (*curp->outmdoc)(curp->outdata, mdoc);          size_t           linesz;
           ssize_t          len, written;
           int              print;
   
  cleanup:          line = NULL;
           linesz = 0;
   
         mparse_reset(curp->mp);          if (fflush(stdout) == EOF) {
                   syscall = "fflush";
                   goto fail;
           }
   
         if (*level < rc)          if ((stream = fdopen(fd, "r")) == NULL) {
                 *level = rc;                  close(fd);
                   syscall = "fdopen";
                   goto fail;
           }
   
           print = 0;
           while ((len = getline(&line, &linesz, stream)) != -1) {
                   cp = line;
                   if (synopsis_only) {
                           if (print) {
                                   if ( ! isspace((unsigned char)*cp))
                                           goto done;
                                   while (isspace((unsigned char)*cp)) {
                                           cp++;
                                           len--;
                                   }
                           } else {
                                   if (strcmp(cp, synb) == 0 ||
                                       strcmp(cp, synr) == 0)
                                           print = 1;
                                   continue;
                           }
                   }
                   for (; len > 0; len -= written) {
                           if ((written = write(STDOUT_FILENO, cp, len)) != -1)
                                   continue;
                           fclose(stream);
                           syscall = "write";
                           goto fail;
                   }
           }
   
           if (ferror(stream)) {
                   fclose(stream);
                   syscall = "getline";
                   goto fail;
           }
   
   done:
           free(line);
           fclose(stream);
           return;
   
   fail:
           free(line);
           warn("%s: SYSERR: %s", file, syscall);
           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 {
                   warnx("-K %s: Bad argument", 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);                  warnx("-m %s: Bad argument", arg);
                 return(0);                  return 0;
         }          }
   
         return(1);          return 1;
 }  }
   
 static int  static int
Line 349  toptions(struct curparse *curp, char *arg)
Line 948  toptions(struct curparse *curp, char *arg)
         else if (0 == strcmp(arg, "locale"))          else if (0 == strcmp(arg, "locale"))
                 curp->outtype = OUTT_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);                  warnx("-T %s: Bad argument", arg);
                 return(0);                  return 0;
         }          }
   
         return(1);          return 1;
 }  }
   
 static int  static int
 woptions(struct curparse *curp, char *arg)  woptions(struct curparse *curp, char *arg)
 {  {
         char            *v, *o;          char            *v, *o;
         const char      *toks[6];          const char      *toks[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, (char * const *)toks, &v)) {
                 case (0):                  case 0:
                         curp->wstop = 1;                          curp->wstop = 1;
                         break;                          break;
                 case (1):                  case 1:
                         /* FALLTHROUGH */                  case 2:
                 case (2):  
                         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);                          warnx("-W %s: Bad argument", o);
                         return(0);                          return 0;
                 }                  }
         }          }
   
         return(1);          return 1;
 }  }
   
 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:", getprogname(),
                         file, line, col + 1,              file == NULL ? "<stdin>" : file);
                         mparse_strlevel(lvl),  
                         mparse_strerror(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 pid_t
   spawn_pager(struct tag_files *tag_files)
   {
           const struct timespec timeout = { 0, 100000000 };  /* 0.1s */
   #define MAX_PAGER_ARGS 16
           char            *argv[MAX_PAGER_ARGS];
           const char      *pager;
           char            *cp;
           size_t           cmdlen;
           int              argc;
           pid_t            pager_pid;
   
           pager = getenv("MANPAGER");
           if (pager == NULL || *pager == '\0')
                   pager = getenv("PAGER");
           if (pager == NULL || *pager == '\0')
                   pager = "more -s";
           cp = mandoc_strdup(pager);
   
           /*
            * Parse the pager command into words.
            * Intentionally do not do anything fancy here.
            */
   
           argc = 0;
           while (argc + 4 < MAX_PAGER_ARGS) {
                   argv[argc++] = cp;
                   cp = strchr(cp, ' ');
                   if (cp == NULL)
                           break;
                   *cp++ = '\0';
                   while (*cp == ' ')
                           cp++;
                   if (*cp == '\0')
                           break;
           }
   
           /* For less(1), use the tag file. */
   
           if ((cmdlen = strlen(argv[0])) >= 4) {
                   cp = argv[0] + cmdlen - 4;
                   if (strcmp(cp, "less") == 0) {
                           argv[argc++] = mandoc_strdup("-T");
                           argv[argc++] = tag_files->tfn;
                   }
           }
           argv[argc++] = tag_files->ofn;
           argv[argc] = NULL;
   
           switch (pager_pid = fork()) {
           case -1:
                   err((int)MANDOCLEVEL_SYSERR, "fork");
           case 0:
                   break;
           default:
                   (void)setpgid(pager_pid, 0);
                   (void)tcsetpgrp(tag_files->ofd, pager_pid);
   #if HAVE_PLEDGE
                   if (pledge("stdio rpath tmppath tty proc", NULL) == -1)
                           err((int)MANDOCLEVEL_SYSERR, "pledge");
   #endif
                   tag_files->pager_pid = pager_pid;
                   return pager_pid;
           }
   
           /* The child process becomes the pager. */
   
           if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
                   err((int)MANDOCLEVEL_SYSERR, "pager stdout");
           close(tag_files->ofd);
           close(tag_files->tfd);
   
           /* Do not start the pager before controlling the terminal. */
   
           while (tcgetpgrp(STDOUT_FILENO) != getpid())
                   nanosleep(&timeout, NULL);
   
           execvp(argv[0], argv);
           err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
 }  }
Legend:
Removed from v.1.169  
changed lines
  Added in v.1.280
CVSweb