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

Diff for /mandoc/main.c between version 1.2 and 1.300

version 1.2, 2009/03/19 16:18:36 version 1.300, 2017/07/20 15:26:41
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>   * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010-2012, 2014-2017 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   * purpose with or without fee is hereby granted, provided that the above
  * above copyright notice and this permission notice appear in all   * copyright notice and this permission notice appear in all copies.
  * copies.  
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * PERFORMANCE OF THIS SOFTWARE.  
  */   */
 #include <sys/stat.h>  #include "config.h"
   
   #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>  #include <err.h>
   #endif
   #include <errno.h>
 #include <fcntl.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 <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_xr.h"
   #include "roff.h"
 #include "mdoc.h"  #include "mdoc.h"
   #include "man.h"
   #include "tag.h"
   #include "main.h"
   #include "manconf.h"
   #include "mansearch.h"
   
 #define WARN_WALL         0x03          /* All-warnings mask. */  enum    outmode {
 #define WARN_WCOMPAT     (1 << 0)       /* Compatibility warnings. */          OUTMODE_DEF = 0,
 #define WARN_WSYNTAX     (1 << 1)       /* Syntax warnings. */          OUTMODE_FLN,
 #define WARN_WERR        (1 << 2)       /* Warnings->errors. */          OUTMODE_LST,
           OUTMODE_ALL,
           OUTMODE_ONE
   };
   
 enum outt {  enum    outt {
         OUTT_ASCII,          OUTT_ASCII = 0, /* -Tascii */
         OUTT_LATIN1,          OUTT_LOCALE,    /* -Tlocale */
         OUTT_UTF8,          OUTT_UTF8,      /* -Tutf8 */
         OUTT_TREE,          OUTT_TREE,      /* -Ttree */
         OUTT_LINT          OUTT_MAN,       /* -Tman */
           OUTT_HTML,      /* -Thtml */
           OUTT_MARKDOWN,  /* -Tmarkdown */
           OUTT_LINT,      /* -Tlint */
           OUTT_PS,        /* -Tps */
           OUTT_PDF        /* -Tpdf */
 };  };
   
 typedef int             (*out_run)(void *, const struct mdoc *);  struct  curparse {
 typedef void            (*out_free)(void *);          struct mparse    *mp;
           struct manoutput *outopts;      /* output options */
           void             *outdata;      /* data for output */
           char             *os_s;         /* operating system for display */
           int               wstop;        /* stop after a file with a warning */
           enum mandocerr    mmin;         /* ignore messages below this */
           enum mandoc_os    os_e;         /* check base system conventions */
           enum outt         outtype;      /* which output to use */
   };
   
 extern  char             *__progname;  
   
 extern  void             *ascii_alloc(void);  int                       mandocdb(int, char *[]);
 extern  void             *latin1_alloc(void);  
 extern  void             *utf8_alloc(void);  
 extern  int               terminal_run(void *, const struct mdoc *);  
 extern  int               tree_run(void *, const struct mdoc *);  
 extern  void              terminal_free(void *);  
   
 __dead  static void       version(void);  static  void              check_xr(const char *);
 __dead  static void       usage(void);  static  int               fs_lookup(const struct manpaths *,
 static  int               foptions(int *, char *);                                  size_t ipath, const char *,
 static  int               toptions(enum outt *, char *);                                  const char *, const char *,
 static  int               woptions(int *, char *);                                  struct manpage **, size_t *);
 static  int               merr(void *, int, int, const char *);  static  int               fs_search(const struct mansearch *,
 static  int               mwarn(void *, int, int,                                  const struct manpaths *, int, char**,
                                 enum mdoc_warn, const char *);                                  struct manpage **, size_t *);
 static  int               file(char **, size_t *, char **, size_t *,  static  int               koptions(int *, char *);
                                 const char *, struct mdoc *);  static  void              moptions(int *, char *);
 static  int               fdesc(char **, size_t *, char **, size_t *,  static  void              mmsg(enum mandocerr, enum mandoclevel,
                                 const char *, int, struct mdoc *);                                  const char *, int, int, const char *);
   static  void              outdata_alloc(struct curparse *);
   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  void              usage(enum argmode) __attribute__((__noreturn__));
   static  int               woptions(struct curparse *, char *);
   
   static  const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
   static  char              help_arg[] = "help";
   static  char             *help_argv[] = {help_arg, NULL};
   static  enum mandoclevel  rc;
   static  FILE             *mmsg_stream;
   
   
 int  int
 main(int argc, char *argv[])  main(int argc, char *argv[])
 {  {
         int              c, rc, fflags, wflags;          struct manconf   conf;
         struct mdoc_cb   cb;          struct mansearch search;
         struct mdoc     *mdoc;          struct curparse  curp;
         char            *buf, *line;          struct tag_files *tag_files;
         size_t           bufsz, linesz;          struct manpage  *res, *resp;
         void            *outdata;          const char      *progname, *sec, *thisarg;
         enum outt        outtype;          char            *conf_file, *defpaths, *auxpaths;
         out_run          outrun;          char            *oarg;
         out_free         outfree;          unsigned char   *uc;
           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;
   
         fflags = wflags = 0;  #if HAVE_PROGNAME
         outtype = OUTT_ASCII;          progname = getprogname();
   #else
           if (argc < 1)
                   progname = mandoc_strdup("mandoc");
           else if ((progname = strrchr(argv[0], '/')) == NULL)
                   progname = argv[0];
           else
                   ++progname;
           setprogname(progname);
   #endif
   
         /* LINTED */          if (strncmp(progname, "mandocdb", 8) == 0 ||
         while (-1 != (c = getopt(argc, argv, "f:VW:T:")))              strcmp(progname, BINM_MAKEWHATIS) == 0)
                   return mandocdb(argc, argv);
   
   #if HAVE_PLEDGE
           if (pledge("stdio rpath tmppath tty proc exec", NULL) == -1)
                   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";
           oarg = NULL;
   
           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.mmin = MANDOCERR_MAX;
           curp.outopts = &conf.output;
           options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
           mmsg_stream = stderr;
   
           use_pager = 1;
           tag_files = NULL;
           show_usage = 0;
           outmode = OUTMODE_DEF;
   
           while ((c = getopt(argc, argv,
               "aC:cfhI:iK:klM:m:O:S:s:T:VW:w")) != -1) {
                   if (c == 'i' && search.argmode == ARG_EXPR) {
                           optind--;
                           break;
                   }
                 switch (c) {                  switch (c) {
                 case ('f'):                  case 'a':
                         if ( ! foptions(&fflags, optarg))                          outmode = OUTMODE_ALL;
                                 return(0);  
                         break;                          break;
                 case ('T'):                  case 'C':
                         if ( ! toptions(&outtype, optarg))                          conf_file = optarg;
                                 return(0);  
                         break;                          break;
                 case ('W'):                  case 'c':
                         if ( ! woptions(&wflags, optarg))                          use_pager = 0;
                                 return(0);  
                         break;                          break;
                 case ('V'):                  case 'f':
                         version();                          search.argmode = ARG_WORD;
                         /* NOTREACHED */                          break;
                   case 'h':
                           conf.output.synopsisonly = 1;
                           use_pager = 0;
                           outmode = OUTMODE_ALL;
                           break;
                   case 'I':
                           if (strncmp(optarg, "os=", 3)) {
                                   warnx("-I %s: Bad argument", optarg);
                                   return (int)MANDOCLEVEL_BADARG;
                           }
                           if (curp.os_s != NULL) {
                                   warnx("-I %s: Duplicate argument", optarg);
                                   return (int)MANDOCLEVEL_BADARG;
                           }
                           curp.os_s = mandoc_strdup(optarg + 3);
                           break;
                   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':
                           oarg = optarg;
                           break;
                   case 'S':
                           search.arch = optarg;
                           break;
                   case 's':
                           search.sec = optarg;
                           break;
                   case 'T':
                           if ( ! toptions(&curp, optarg))
                                   return (int)MANDOCLEVEL_BADARG;
                           break;
                   case 'W':
                           if ( ! woptions(&curp, optarg))
                                   return (int)MANDOCLEVEL_BADARG;
                           break;
                   case 'w':
                           outmode = OUTMODE_FLN;
                           break;
                 default:                  default:
                         usage();                          show_usage = 1;
                         /* NOTREACHED */                          break;
                 }                  }
           }
   
         argc -= optind;          if (show_usage)
         argv += optind;                  usage(search.argmode);
   
           /* 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 (oarg != NULL) {
                   if (outmode == OUTMODE_LST)
                           search.outkey = oarg;
                   else {
                           while (oarg != NULL) {
                                   thisarg = oarg;
                                   if (manconf_output(&conf.output,
                                       strsep(&oarg, ","), 0) == 0)
                                           continue;
                                   warnx("-O %s: Bad argument", thisarg);
                                   return (int)MANDOCLEVEL_BADARG;
                           }
                   }
           }
   
           if (outmode == OUTMODE_FLN ||
               outmode == OUTMODE_LST ||
               !isatty(STDOUT_FILENO))
                   use_pager = 0;
   
   #if HAVE_PLEDGE
           if (!use_pager)
                   if (pledge("stdio rpath", NULL) == -1)
                           err((int)MANDOCLEVEL_SYSERR, "pledge");
   #endif
   
           /* Parse arguments. */
   
           if (argc > 0) {
                   argc -= optind;
                   argv += optind;
           }
           resp = NULL;
   
         /*          /*
          * Allocate the appropriate front-end.  Note that utf8, ascii           * Quirks for help(1)
          * and latin1 all resolve to the terminal front-end with           * and for a man(1) section argument without -s.
          * different encodings (see terminal.c).  Not all frontends have  
          * cleanup or alloc routines.  
          */           */
   
         switch (outtype) {          if (search.argmode == ARG_NAME) {
         case (OUTT_LATIN1):                  if (*progname == 'h') {
                 outdata = latin1_alloc();                          if (argc == 0) {
                 outrun = terminal_run;                                  argv = help_argv;
                 outfree = terminal_free;                                  argc = 1;
                 break;                          }
         case (OUTT_UTF8):                  } else if (argc > 1 &&
                 outdata = utf8_alloc();                      ((uc = (unsigned char *)argv[0]) != NULL) &&
                 outrun = terminal_run;                      ((isdigit(uc[0]) && (uc[1] == '\0' ||
                 outfree = terminal_free;                        (isalpha(uc[1]) && uc[2] == '\0'))) ||
                 break;                       (uc[0] == 'n' && uc[1] == '\0'))) {
         case (OUTT_TREE):                          search.sec = (char *)uc;
                 outdata = NULL;                          argv++;
                 outrun = tree_run;                          argc--;
                 outfree = NULL;                  }
                 break;                  if (search.arch == NULL)
         case (OUTT_LINT):                          search.arch = getenv("MACHINE");
                 outdata = NULL;  #ifdef MACHINE
                 outrun = NULL;                  if (search.arch == NULL)
                 outfree = NULL;                          search.arch = MACHINE;
                 break;  #endif
         default:  
                 outdata = ascii_alloc();  
                 outrun = terminal_run;  
                 outfree = terminal_free;  
                 break;  
         }          }
   
           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);
   
           mchars_alloc();
           curp.mp = mparse_alloc(options, curp.mmin, mmsg,
               curp.os_e, curp.os_s);
   
         /*          /*
          * All callbacks route into here, where we print them onto the           * Conditionally start up the lookaside buffer before parsing.
          * screen.  XXX - for now, no path for debugging messages.  
          */           */
           if (OUTT_MAN == curp.outtype)
                   mparse_keep(curp.mp);
   
         cb.mdoc_msg = NULL;          if (argc < 1) {
         cb.mdoc_err = merr;                  if (use_pager)
         cb.mdoc_warn = mwarn;                          tag_files = tag_init();
                   parse(&curp, STDIN_FILENO, "<stdin>");
           }
   
         buf = line = NULL;          while (argc > 0) {
         bufsz = linesz = 0;                  fd = mparse_open(curp.mp, resp != NULL ? resp->file : *argv);
                   if (fd != -1) {
                           if (use_pager) {
                                   tag_files = tag_init();
                                   use_pager = 0;
                           }
   
         mdoc = mdoc_alloc(&wflags, fflags, &cb);                          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);
   
         while (*argv) {                          if (argc > 1 && curp.outtype <= OUTT_UTF8) {
                 if ( ! file(&line, &linesz, &buf, &bufsz, *argv, mdoc))                                  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)
                         break;                          break;
                 if (outrun && ! (*outrun)(outdata, mdoc))  
                   if (resp != NULL)
                           resp++;
                   else
                           argv++;
                   if (--argc)
                           mparse_reset(curp.mp);
           }
   
           if (curp.outdata != NULL) {
                   switch (curp.outtype) {
                   case OUTT_HTML:
                           html_free(curp.outdata);
                         break;                          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;
                   }
           }
           mandoc_xr_free();
           mparse_free(curp.mp);
           mchars_free();
   
                 /* Reset the parser for another file. */  out:
                 mdoc_reset(mdoc);          if (search.argmode != ARG_FILE) {
                 argv++;                  manconf_free(&conf);
                   mansearch_free(res, sz);
         }          }
   
         rc = NULL == *argv;          free(curp.os_s);
   
         if (buf)          /*
                 free(buf);           * When using a pager, finish writing both temporary files,
         if (line)           * fork it, wait for the user to close it, and clean up.
                 free(line);           */
         if (outfree)  
                 (*outfree)(outdata);  
   
         mdoc_free(mdoc);          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 (;;) {
   
         return(rc ? EXIT_SUCCESS : EXIT_FAILURE);                          /* 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;
                           }
   
 __dead static void                          /* Once in the foreground, activate the pager. */
 version(void)  
 {  
   
         (void)printf("%s %s\n", __progname, VERSION);                          if (pager_pid) {
         exit(0);                                  (void)tcsetpgrp(tag_files->ofd, pager_pid);
         /* NOTREACHED */                                  kill(pager_pid, SIGCONT);
 }                          } else
                                   pager_pid = spawn_pager(tag_files);
   
                           /* Wait for the pager to stop or exit. */
   
 __dead static void                          while ((pid = waitpid(pager_pid, &status,
 usage(void)                              WUNTRACED)) == -1 && errno == EINTR)
 {                                  continue;
   
         (void)fprintf(stderr, "usage: %s\n", __progname);                          if (pid == -1) {
         exit(1);                                  warn("wait");
         /* NOTREACHED */                                  rc = MANDOCLEVEL_SYSERR;
                                   break;
                           }
                           if (!WIFSTOPPED(status))
                                   break;
   
                           signum = WSTOPSIG(status);
                   }
                   tag_unlink();
           }
   
           return (int)rc;
 }  }
   
   static void
   usage(enum argmode argmode)
   {
   
           switch (argmode) {
           case ARG_FILE:
                   fputs("usage: mandoc [-ac] [-I os=name] "
                       "[-K encoding] [-mdoc | -man] [-O options]\n"
                       "\t      [-T output] [-W level] [file ...]\n", stderr);
                   break;
           case ARG_NAME:
                   fputs("usage: man [-acfhklw] [-C file] [-M path] "
                       "[-m path] [-S subsection]\n"
                       "\t   [[-s] section] name ...\n", stderr);
                   break;
           case ARG_WORD:
                   fputs("usage: whatis [-afk] [-C file] "
                       "[-M path] [-m path] [-O outkey] [-S arch]\n"
                       "\t      [-s section] name ...\n", stderr);
                   break;
           case ARG_EXPR:
                   fputs("usage: apropos [-afk] [-C file] "
                       "[-M path] [-m path] [-O outkey] [-S arch]\n"
                       "\t       [-s section] expression ...\n", stderr);
                   break;
           }
           exit((int)MANDOCLEVEL_BADARG);
   }
   
 static int  static int
 file(char **ln, size_t *lnsz, char **buf, size_t *bufsz,  fs_lookup(const struct manpaths *paths, size_t ipath,
                 const char *file, struct mdoc *mdoc)          const char *sec, const char *arch, const char *name,
           struct manpage **res, size_t *ressz)
 {  {
         int              fd, c;          glob_t           globinfo;
           struct manpage  *page;
           char            *file;
           int              globres;
           enum form        form;
   
         if (-1 == (fd = open(file, O_RDONLY, 0))) {          form = FORM_SRC;
                 warn("%s", file);          mandoc_asprintf(&file, "%s/man%s/%s.%s",
                 return(0);              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);
   
         c = fdesc(ln, lnsz, buf, bufsz, file, fd, mdoc);          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);
           }
   
         if (-1 == close(fd))          mandoc_asprintf(&file, "%s/man%s/%s.[01-9]*",
                 warn("%s", file);              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)
                   goto found;
           if (res != NULL || ipath + 1 != paths->sz)
                   return 0;
   
         return(c);          mandoc_asprintf(&file, "%s.%s", name, sec);
           globres = access(file, R_OK);
           free(file);
           return globres != -1;
   
   found:
           warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
               name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
           if (res == NULL) {
                   free(file);
                   return 1;
           }
           *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 int  static int
 fdesc(char **lnp, size_t *lnsz, char **bufp, size_t *bufsz,  fs_search(const struct mansearch *cfg, const struct manpaths *paths,
                 const char *f, int fd, struct mdoc *mdoc)          int argc, char **argv, struct manpage **res, size_t *ressz)
 {  {
         size_t           sz;          const char *const sections[] =
         ssize_t          ssz;              {"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"};
         struct stat      st;          const size_t nsec = sizeof(sections)/sizeof(sections[0]);
         int              j, i, pos, lnn;  
         char            *ln, *buf;  
   
         buf = *bufp;          size_t           ipath, isec, lastsz;
         ln = *lnp;  
   
         /*          assert(cfg->argmode == ARG_NAME);
          * Two buffers: ln and buf.  buf is the input buffer, optimised  
          * for each file's block size.  ln is a line buffer.  Both  
          * growable, hence passed in by ptr-ptr.  
          */  
   
         if (-1 == fstat(fd, &st)) {          if (res != NULL)
                 warnx("%s", f);                  *res = NULL;
                 sz = BUFSIZ;          *ressz = lastsz = 0;
         } else          while (argc) {
                 sz = (unsigned)BUFSIZ > st.st_blksize ?                  for (ipath = 0; ipath < paths->sz; ipath++) {
                         (size_t)BUFSIZ : st.st_blksize;                          if (cfg->sec != NULL) {
                                   if (fs_lookup(paths, ipath, cfg->sec,
         if (sz > *bufsz) {                                      cfg->arch, *argv, res, ressz) &&
                 if (NULL == (buf = realloc(buf, sz)))                                      cfg->firstmatch)
                         err(1, "realloc");                                          return 1;
                 *bufp = buf;                          } else for (isec = 0; isec < nsec; isec++)
                 *bufsz = sz;                                  if (fs_lookup(paths, ipath, sections[isec],
                                       cfg->arch, *argv, res, ressz) &&
                                       cfg->firstmatch)
                                           return 1;
                   }
                   if (res != NULL && *ressz == lastsz)
                           warnx("No entry for %s in the manual.", *argv);
                   lastsz = *ressz;
                   argv++;
                   argc--;
         }          }
           return 0;
   }
   
   static void
   parse(struct curparse *curp, int fd, const char *file)
   {
           enum mandoclevel  rctmp;
           struct roff_man  *man;
   
           /* Begin by parsing the file itself. */
   
           assert(file);
           assert(fd >= 0);
   
           rctmp = mparse_readfd(curp->mp, fd, file);
           if (fd != STDIN_FILENO)
                   close(fd);
           if (rc < rctmp)
                   rc = rctmp;
   
         /*          /*
          * Fill buf with file blocksize and parse newlines into ln.           * With -Wstop and warnings or errors of at least the requested
            * level, do not produce output.
          */           */
   
         for (lnn = 1, pos = 0; ; ) {          if (rctmp != MANDOCLEVEL_OK && curp->wstop)
                 if (-1 == (ssz = read(fd, buf, sz))) {                  return;
                         warn("%s", f);  
                         return(0);          if (curp->outdata == NULL)
                 } else if (0 == ssz)                  outdata_alloc(curp);
   
           mparse_result(curp->mp, &man, NULL);
   
           /* Execute the out device, if it exists. */
   
           if (man == NULL)
                   return;
           mandoc_xr_reset();
           if (man->macroset == MACROSET_MDOC) {
                   if (curp->outtype != OUTT_TREE || !curp->outopts->noval)
                           mdoc_validate(man);
                   switch (curp->outtype) {
                   case OUTT_HTML:
                           html_mdoc(curp->outdata, man);
                         break;                          break;
                   case OUTT_TREE:
                           tree_mdoc(curp->outdata, man);
                           break;
                   case OUTT_MAN:
                           man_mdoc(curp->outdata, man);
                           break;
                   case OUTT_PDF:
                   case OUTT_ASCII:
                   case OUTT_UTF8:
                   case OUTT_LOCALE:
                   case OUTT_PS:
                           terminal_mdoc(curp->outdata, man);
                           break;
                   case OUTT_MARKDOWN:
                           markdown_mdoc(curp->outdata, man);
                           break;
                   default:
                           break;
                   }
           }
           if (man->macroset == MACROSET_MAN) {
                   if (curp->outtype != OUTT_TREE || !curp->outopts->noval)
                           man_validate(man);
                   switch (curp->outtype) {
                   case OUTT_HTML:
                           html_man(curp->outdata, man);
                           break;
                   case OUTT_TREE:
                           tree_man(curp->outdata, man);
                           break;
                   case OUTT_MAN:
                           man_man(curp->outdata, man);
                           break;
                   case OUTT_PDF:
                   case OUTT_ASCII:
                   case OUTT_UTF8:
                   case OUTT_LOCALE:
                   case OUTT_PS:
                           terminal_man(curp->outdata, man);
                           break;
                   default:
                           break;
                   }
           }
           if (curp->mmin < MANDOCERR_STYLE)
                   check_xr(file);
           mparse_updaterc(curp->mp, &rc);
   }
   
                 for (i = 0; i < (int)ssz; i++) {  static void
                         if (pos >= (int)*lnsz) {  check_xr(const char *file)
                                 *lnsz += 256; /* Step-size. */  {
                                 ln = realloc(ln, *lnsz);          static struct manpaths   paths;
                                 if (NULL == ln)          struct mansearch         search;
                                         err(1, "realloc");          struct mandoc_xr        *xr;
                                 *lnp = ln;          char                    *cp;
                         }          size_t                   sz;
   
                         if ('\n' != buf[i]) {          if (paths.sz == 0)
                                 ln[pos++] = buf[i];                  manpath_base(&paths);
                                 continue;  
                         }  
   
                         /* Check for CPP-escaped newline.  */          for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) {
                   if (xr->line == -1)
                           continue;
                   search.arch = NULL;
                   search.sec = xr->sec;
                   search.outkey = NULL;
                   search.argmode = ARG_NAME;
                   search.firstmatch = 1;
                   if (mansearch(&search, &paths, 1, &xr->name, NULL, &sz))
                           continue;
                   if (fs_search(&search, &paths, 1, &xr->name, NULL, &sz))
                           continue;
                   if (xr->count == 1)
                           mandoc_asprintf(&cp, "Xr %s %s", xr->name, xr->sec);
                   else
                           mandoc_asprintf(&cp, "Xr %s %s (%d times)",
                               xr->name, xr->sec, xr->count);
                   mmsg(MANDOCERR_XR_BAD, MANDOCLEVEL_STYLE,
                       file, xr->line, xr->pos + 1, cp);
                   free(cp);
           }
   }
   
                         if (pos > 0 && '\\' == ln[pos - 1]) {  static void
                                 for (j = pos - 1; j >= 0; j--)  outdata_alloc(struct curparse *curp)
                                         if ('\\' != ln[j])  {
                                                 break;          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;
           }
   }
   
                                 if ( ! ((pos - j) % 2)) {  static void
                                         pos--;  passthrough(const char *file, int fd, int synopsis_only)
                                         lnn++;  {
                                         continue;          const char       synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
           const char       synr[] = "SYNOPSIS";
   
           FILE            *stream;
           const char      *syscall;
           char            *line, *cp;
           size_t           linesz;
           ssize_t          len, written;
           int              print;
   
           line = NULL;
           linesz = 0;
   
           if (fflush(stdout) == EOF) {
                   syscall = "fflush";
                   goto fail;
           }
   
           if ((stream = fdopen(fd, "r")) == NULL) {
                   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;
                         }                          }
   
                         ln[pos] = 0;  
                         if ( ! mdoc_parseln(mdoc, lnn, ln))  
                                 return(0);  
                         lnn++;  
                         pos = 0;  
                 }                  }
                   for (; len > 0; len -= written) {
                           if ((written = write(STDOUT_FILENO, cp, len)) != -1)
                                   continue;
                           fclose(stream);
                           syscall = "write";
                           goto fail;
                   }
         }          }
   
         return(mdoc_endparse(mdoc));          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
   koptions(int *options, char *arg)
   {
   
           if ( ! strcmp(arg, "utf-8")) {
                   *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 void
   moptions(int *options, char *arg)
   {
   
           if (arg == NULL)
                   return;
           if (strcmp(arg, "doc") == 0)
                   *options |= MPARSE_MDOC;
           else if (strcmp(arg, "an") == 0)
                   *options |= MPARSE_MAN;
   }
   
 static int  static int
 toptions(enum outt *tflags, char *arg)  toptions(struct curparse *curp, char *arg)
 {  {
   
         if (0 == strcmp(arg, "ascii"))          if (0 == strcmp(arg, "ascii"))
                 *tflags = OUTT_ASCII;                  curp->outtype = OUTT_ASCII;
         else if (0 == strcmp(arg, "latin1"))          else if (0 == strcmp(arg, "lint")) {
                 *tflags = OUTT_LATIN1;                  curp->outtype = OUTT_LINT;
                   curp->mmin = MANDOCERR_BASE;
                   mmsg_stream = stdout;
           } else if (0 == strcmp(arg, "tree"))
                   curp->outtype = OUTT_TREE;
           else if (0 == strcmp(arg, "man"))
                   curp->outtype = OUTT_MAN;
           else if (0 == strcmp(arg, "html"))
                   curp->outtype = OUTT_HTML;
           else if (0 == strcmp(arg, "markdown"))
                   curp->outtype = OUTT_MARKDOWN;
         else if (0 == strcmp(arg, "utf8"))          else if (0 == strcmp(arg, "utf8"))
                 *tflags = OUTT_UTF8;                  curp->outtype = OUTT_UTF8;
         else if (0 == strcmp(arg, "lint"))          else if (0 == strcmp(arg, "locale"))
                 *tflags = OUTT_LINT;                  curp->outtype = OUTT_LOCALE;
         else if (0 == strcmp(arg, "tree"))          else if (0 == strcmp(arg, "ps"))
                 *tflags = OUTT_TREE;                  curp->outtype = OUTT_PS;
           else if (0 == strcmp(arg, "pdf"))
                   curp->outtype = OUTT_PDF;
         else {          else {
                 warnx("bad argument: -T%s", arg);                  warnx("-T %s: Bad argument", arg);
                 return(0);                  return 0;
         }          }
   
         return(1);          return 1;
 }  }
   
   
 /*  
  * Parse out the options for [-fopt...] setting compiler options.  These  
  * can be comma-delimited or called again.  
  */  
 static int  static int
 foptions(int *fflags, char *arg)  woptions(struct curparse *curp, char *arg)
 {  {
         char            *v;          char            *v, *o;
         char            *toks[4];          const char      *toks[11];
   
         toks[0] = "ign-scope";          toks[0] = "stop";
         toks[1] = "ign-escape";          toks[1] = "all";
         toks[2] = "ign-macro";          toks[2] = "base";
         toks[3] = NULL;          toks[3] = "style";
           toks[4] = "warning";
           toks[5] = "error";
           toks[6] = "unsupp";
           toks[7] = "fatal";
           toks[8] = "openbsd";
           toks[9] = "netbsd";
           toks[10] = NULL;
   
         while (*arg)          while (*arg) {
                 switch (getsubopt(&arg, toks, &v)) {                  o = arg;
                 case (0):                  switch (getsubopt(&arg, (char * const *)toks, &v)) {
                         *fflags |= MDOC_IGN_SCOPE;                  case 0:
                           curp->wstop = 1;
                         break;                          break;
                 case (1):                  case 1:
                         *fflags |= MDOC_IGN_ESCAPE;                  case 2:
                           curp->mmin = MANDOCERR_BASE;
                         break;                          break;
                 case (2):                  case 3:
                         *fflags |= MDOC_IGN_MACRO;                          curp->mmin = MANDOCERR_STYLE;
                         break;                          break;
                   case 4:
                           curp->mmin = MANDOCERR_WARNING;
                           break;
                   case 5:
                           curp->mmin = MANDOCERR_ERROR;
                           break;
                   case 6:
                           curp->mmin = MANDOCERR_UNSUPP;
                           break;
                   case 7:
                           curp->mmin = MANDOCERR_MAX;
                           break;
                   case 8:
                           curp->mmin = MANDOCERR_BASE;
                           curp->os_e = MANDOC_OS_OPENBSD;
                           break;
                   case 9:
                           curp->mmin = MANDOCERR_BASE;
                           curp->os_e = MANDOC_OS_NETBSD;
                           break;
                 default:                  default:
                         warnx("bad argument: -f%s", arg);                          warnx("-W %s: Bad argument", o);
                         return(0);                          return 0;
                 }                  }
           }
         return(1);          return 1;
 }  }
   
   static void
 /*  mmsg(enum mandocerr t, enum mandoclevel lvl,
  * Parse out the options for [-Werr...], which sets warning modes.                  const char *file, int line, int col, const char *msg)
  * These can be comma-delimited or called again.  
  */  
 static int  
 woptions(int *wflags, char *arg)  
 {  {
         char            *v;          const char      *mparse_msg;
         char            *toks[5];  
   
         toks[0] = "all";          fprintf(mmsg_stream, "%s: %s:", getprogname(),
         toks[1] = "compat";              file == NULL ? "<stdin>" : file);
         toks[2] = "syntax";  
         toks[3] = "error";  
         toks[4] = NULL;  
   
         while (*arg)          if (line)
                 switch (getsubopt(&arg, toks, &v)) {                  fprintf(mmsg_stream, "%d:%d:", line, col + 1);
                 case (0):  
                         *wflags |= WARN_WALL;  
                         break;  
                 case (1):  
                         *wflags |= WARN_WCOMPAT;  
                         break;  
                 case (2):  
                         *wflags |= WARN_WSYNTAX;  
                         break;  
                 case (3):  
                         *wflags |= WARN_WERR;  
                         break;  
                 default:  
                         warnx("bad argument: -W%s", arg);  
                         return(0);  
                 }  
   
         return(1);          fprintf(mmsg_stream, " %s", mparse_strlevel(lvl));
 }  
   
           if ((mparse_msg = mparse_strerror(t)) != NULL)
                   fprintf(mmsg_stream, ": %s", mparse_msg);
   
 /* ARGSUSED */          if (msg)
 static int                  fprintf(mmsg_stream, ": %s", msg);
 merr(void *arg, int line, int col, const char *msg)  
 {  
   
         warnx("error: %s (line %d, column %d)", msg, line, col);          fputc('\n', mmsg_stream);
         return(0);  
 }  }
   
   static pid_t
 static int  spawn_pager(struct tag_files *tag_files)
 mwarn(void *arg, int line, int col,  
                 enum mdoc_warn type, const char *msg)  
 {  {
         int              flags;          const struct timespec timeout = { 0, 100000000 };  /* 0.1s */
         char            *wtype;  #define MAX_PAGER_ARGS 16
           char            *argv[MAX_PAGER_ARGS];
           const char      *pager;
           char            *cp;
           size_t           cmdlen;
           int              argc;
           pid_t            pager_pid;
   
         flags = *(int *)arg;          pager = getenv("MANPAGER");
         wtype = NULL;          if (pager == NULL || *pager == '\0')
                   pager = getenv("PAGER");
           if (pager == NULL || *pager == '\0')
                   pager = "more -s";
           cp = mandoc_strdup(pager);
   
         switch (type) {          /*
         case (WARN_COMPAT):           * Parse the pager command into words.
                 wtype = "compat";           * Intentionally do not do anything fancy here.
                 if (flags & WARN_WCOMPAT)           */
   
           argc = 0;
           while (argc + 4 < MAX_PAGER_ARGS) {
                   argv[argc++] = cp;
                   cp = strchr(cp, ' ');
                   if (cp == NULL)
                         break;                          break;
                 return(1);                  *cp++ = '\0';
         case (WARN_SYNTAX):                  while (*cp == ' ')
                 wtype = "syntax";                          cp++;
                 if (flags & WARN_WSYNTAX)                  if (*cp == '\0')
                         break;                          break;
                 return(1);  
         }          }
   
         assert(wtype);          /* For less(1), use the tag file. */
         warnx("%s warning: %s (line %d, column %d)",  
                         wtype, msg, line, col);  
   
         if ( ! (flags & WARN_WERR))          if ((cmdlen = strlen(argv[0])) >= 4) {
                 return(1);                  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;
   
         warnx("%s: considering warnings as errors",          switch (pager_pid = fork()) {
                         __progname);          case -1:
         return(0);                  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.2  
changed lines
  Added in v.1.300
CVSweb