retire unstack & datasizes in favour of addr2line
[minix3.git] / usr.bin / man / man.c
blobb3cefd91b6a9e0c2228548f73ec926a3e9fa74e6
1 /* $NetBSD: man.c,v 1.60 2013/10/28 23:46:17 christos Exp $ */
3 /*
4 * Copyright (c) 1987, 1993, 1994, 1995
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
32 #include <sys/cdefs.h>
34 #ifndef lint
35 __COPYRIGHT("@(#) Copyright (c) 1987, 1993, 1994, 1995\
36 The Regents of the University of California. All rights reserved.");
37 #endif /* not lint */
39 #ifndef lint
40 #if 0
41 static char sccsid[] = "@(#)man.c 8.17 (Berkeley) 1/31/95";
42 #else
43 __RCSID("$NetBSD: man.c,v 1.60 2013/10/28 23:46:17 christos Exp $");
44 #endif
45 #endif /* not lint */
47 #include <sys/param.h>
48 #include <sys/queue.h>
49 #include <sys/stat.h>
50 #include <sys/utsname.h>
52 #include <ctype.h>
53 #include <err.h>
54 #include <errno.h>
55 #include <fcntl.h>
56 #include <fnmatch.h>
57 #include <glob.h>
58 #include <signal.h>
59 #include <stdio.h>
60 #include <stdlib.h>
61 #include <string.h>
62 #include <unistd.h>
63 #include <util.h>
64 #include <locale.h>
66 #include "manconf.h"
67 #include "pathnames.h"
69 #ifndef MAN_DEBUG
70 #define MAN_DEBUG 0 /* debug path output */
71 #endif
74 * manstate: structure collecting the current global state so we can
75 * easily identify it and pass it to helper functions in one arg.
77 struct manstate {
78 /* command line flags */
79 int all; /* -a: show all matches rather than first */
80 int cat; /* -c: do not use a pager */
81 char *conffile; /* -C: use alternate config file */
82 int how; /* -h: show SYNOPSIS only */
83 char *manpath; /* -M: alternate MANPATH */
84 char *addpath; /* -m: add these dirs to front of manpath */
85 char *pathsearch; /* -S: path of man must contain this string */
86 char *sectionname; /* -s: limit search to a given man section */
87 int where; /* -w: just show paths of all matching files */
88 int getpath; /* -p: print the path of directories containing man pages */
90 /* important tags from the config file */
91 TAG *defaultpath; /* _default: default MANPATH */
92 TAG *subdirs; /* _subdir: default subdir search list */
93 TAG *suffixlist; /* _suffix: for files that can be cat()'d */
94 TAG *buildlist; /* _build: for files that must be built */
96 /* tags for internal use */
97 TAG *intmp; /* _intmp: tmp files we must cleanup */
98 TAG *missinglist; /* _missing: pages we couldn't find */
99 TAG *mymanpath; /* _new_path: final version of MANPATH */
100 TAG *section; /* <sec>: tag for m.sectionname */
102 /* other misc stuff */
103 const char *pager; /* pager to use */
104 size_t pagerlen; /* length of the above */
105 const char *machine; /* machine */
106 const char *machclass; /* machine class */
110 * prototypes
112 static void build_page(const char *, char **, struct manstate *);
113 static void cat(const char *);
114 static const char *check_pager(const char *);
115 static int cleanup(void);
116 static void how(const char *);
117 static void jump(char **, const char *, const char *) __dead;
118 static int manual(char *, struct manstate *, glob_t *);
119 static void onsig(int) __dead;
120 static void usage(void) __dead;
121 static void addpath(struct manstate *, const char *, size_t, const char *);
122 static const char *getclass(const char *);
123 static void printmanpath(struct manstate *);
126 * main function
129 main(int argc, char **argv)
131 static struct manstate m;
132 int ch, abs_section, found;
133 ENTRY *esubd, *epath;
134 char *p, **ap, *cmd;
135 size_t len;
136 glob_t pg;
138 setprogname(argv[0]);
139 setlocale(LC_ALL, "");
141 * parse command line...
143 while ((ch = getopt(argc, argv, "-aC:cfhkM:m:P:ps:S:w")) != -1)
144 switch (ch) {
145 case 'a':
146 m.all = 1;
147 break;
148 case 'C':
149 m.conffile = optarg;
150 break;
151 case 'c':
152 case '-': /* XXX: '-' is a deprecated version of '-c' */
153 m.cat = 1;
154 break;
155 case 'h':
156 m.how = 1;
157 break;
158 case 'm':
159 m.addpath = optarg;
160 break;
161 case 'M':
162 case 'P': /* -P for backward compatibility */
163 m.manpath = strdup(optarg);
164 break;
165 case 'p':
166 m.getpath = 1;
167 break;
169 * The -f and -k options are backward compatible,
170 * undocumented ways of calling whatis(1) and apropos(1).
172 case 'f':
173 jump(argv, "-f", "whatis");
174 /* NOTREACHED */
175 case 'k':
176 jump(argv, "-k", "apropos");
177 /* NOTREACHED */
178 case 's':
179 if (m.sectionname != NULL)
180 usage();
181 m.sectionname = optarg;
182 break;
183 case 'S':
184 m.pathsearch = optarg;
185 break;
186 case 'w':
187 m.all = m.where = 1;
188 break;
189 case '?':
190 default:
191 usage();
193 argc -= optind;
194 argv += optind;
196 if (!m.getpath && !argc)
197 usage();
200 * read the configuration file and collect any other information
201 * we will need (machine type, pager, section [if specified
202 * without '-s'], and MANPATH through the environment).
204 config(m.conffile); /* exits on error ... */
206 if ((m.machine = getenv("MACHINE")) == NULL) {
207 struct utsname utsname;
209 if (uname(&utsname) == -1)
210 err(EXIT_FAILURE, "uname");
211 m.machine = utsname.machine;
214 m.machclass = getclass(m.machine);
216 if (!m.cat && !m.how && !m.where) { /* if we need a pager ... */
217 if (!isatty(STDOUT_FILENO)) {
218 m.cat = 1;
219 } else {
220 if ((m.pager = getenv("PAGER")) != NULL &&
221 m.pager[0] != '\0')
222 m.pager = check_pager(m.pager);
223 else
224 m.pager = _PATH_PAGER;
225 m.pagerlen = strlen(m.pager);
229 /* do we need to set m.section to a non-null value? */
230 if (m.sectionname) {
232 m.section = gettag(m.sectionname, 0); /* -s must be a section */
233 if (m.section == NULL)
234 errx(EXIT_FAILURE, "unknown section: %s", m.sectionname);
236 } else if (argc > 1) {
238 m.section = gettag(*argv, 0); /* might be a section? */
239 if (m.section) {
240 argv++;
241 argc--;
246 if (m.manpath == NULL)
247 m.manpath = getenv("MANPATH"); /* note: -M overrides getenv */
251 * get default values from config file, plus create the tags we
252 * use for keeping internal state. make sure all our mallocs
253 * go through.
255 /* from cfg file */
256 m.defaultpath = gettag("_default", 1);
257 m.subdirs = gettag("_subdir", 1);
258 m.suffixlist = gettag("_suffix", 1);
259 m.buildlist = gettag("_build", 1);
260 /* internal use */
261 m.mymanpath = gettag("_new_path", 1);
262 m.missinglist = gettag("_missing", 1);
263 m.intmp = gettag("_intmp", 1);
264 if (!m.defaultpath || !m.subdirs || !m.suffixlist || !m.buildlist ||
265 !m.mymanpath || !m.missinglist || !m.intmp)
266 errx(EXIT_FAILURE, "malloc failed");
269 * are we using a section whose elements are all absolute paths?
270 * (we only need to look at the first entry on the section list,
271 * as config() will ensure that any additional entries will match
272 * the first one.)
274 abs_section = (m.section != NULL &&
275 !TAILQ_EMPTY(&m.section->entrylist) &&
276 *(TAILQ_FIRST(&m.section->entrylist)->s) == '/');
279 * now that we have all the data we need, we must determine the
280 * manpath we are going to use to find the requested entries using
281 * the following steps...
283 * [1] if the user specified a section and that section's elements
284 * from the config file are all absolute paths, then we override
285 * defaultpath and -M/MANPATH with the section's absolute paths.
287 if (abs_section) {
288 m.manpath = NULL; /* ignore -M/MANPATH */
289 m.defaultpath = m.section; /* overwrite _default path */
290 m.section = NULL; /* promoted to defaultpath */
294 * [2] section can now only be non-null if the user asked for
295 * a section and that section's elements did not have
296 * absolute paths. in this case we use the section's
297 * elements to override _subdir from the config file.
299 * after this step, we are done processing "m.section"...
301 if (m.section)
302 m.subdirs = m.section;
305 * [3] we need to setup the path we want to use (m.mymanpath).
306 * if the user gave us a path (m.manpath) use it, otherwise
307 * go with the default. in either case we need to append
308 * the subdir and machine spec to each element of the path.
310 * for absolute section paths that come from the config file,
311 * we only append the subdir spec if the path ends in
312 * a '/' --- elements that do not end in '/' are assumed to
313 * not have subdirectories. this is mainly for backward compat,
314 * but it allows non-subdir configs like:
315 * sect3 /usr/share/man/{old/,}cat3
316 * doc /usr/{pkg,share}/doc/{sendmail/op,sendmail/intro}
318 * note that we try and be careful to not put double slashes
319 * in the path (e.g. we want /usr/share/man/man1, not
320 * /usr/share/man//man1) because "more" will put the filename
321 * we generate in its prompt and the double slashes look ugly.
323 if (m.manpath) {
325 /* note: strtok is going to destroy m.manpath */
326 for (p = strtok(m.manpath, ":") ; p ; p = strtok(NULL, ":")) {
327 len = strlen(p);
328 if (len < 1)
329 continue;
330 TAILQ_FOREACH(esubd, &m.subdirs->entrylist, q)
331 addpath(&m, p, len, esubd->s);
334 } else {
336 TAILQ_FOREACH(epath, &m.defaultpath->entrylist, q) {
337 /* handle trailing "/" magic here ... */
338 if (abs_section && epath->s[epath->len - 1] != '/') {
339 addpath(&m, "", 1, epath->s);
340 continue;
343 TAILQ_FOREACH(esubd, &m.subdirs->entrylist, q)
344 addpath(&m, epath->s, epath->len, esubd->s);
350 * [4] finally, prepend the "-m" m.addpath to mymanpath if it
351 * was specified. subdirs and machine are always applied to
352 * m.addpath.
354 if (m.addpath) {
356 /* note: strtok is going to destroy m.addpath */
357 for (p = strtok(m.addpath, ":") ; p ; p = strtok(NULL, ":")) {
358 len = strlen(p);
359 if (len < 1)
360 continue;
361 TAILQ_FOREACH(esubd, &m.subdirs->entrylist, q)
362 addpath(&m, p, len, esubd->s);
367 if (m.getpath)
368 printmanpath(&m);
371 * now m.mymanpath is complete!
373 #if MAN_DEBUG
374 printf("mymanpath:\n");
375 TAILQ_FOREACH(epath, &m.mymanpath->entrylist, q) {
376 printf("\t%s\n", epath->s);
378 #endif
381 * start searching for matching files and format them if necessary.
382 * setup an interrupt handler so that we can ensure that temporary
383 * files go away.
385 (void)signal(SIGINT, onsig);
386 (void)signal(SIGHUP, onsig);
387 (void)signal(SIGPIPE, onsig);
389 memset(&pg, 0, sizeof(pg));
390 for (found = 0; *argv; ++argv)
391 if (manual(*argv, &m, &pg)) {
392 found = 1;
395 /* if nothing found, we're done. */
396 if (!found) {
397 (void)cleanup();
398 exit(EXIT_FAILURE);
402 * handle the simple display cases first (m.cat, m.how, m.where)
404 if (m.cat) {
405 for (ap = pg.gl_pathv; *ap != NULL; ++ap) {
406 if (**ap == '\0')
407 continue;
408 cat(*ap);
410 exit(cleanup());
412 if (m.how) {
413 for (ap = pg.gl_pathv; *ap != NULL; ++ap) {
414 if (**ap == '\0')
415 continue;
416 how(*ap);
418 exit(cleanup());
420 if (m.where) {
421 for (ap = pg.gl_pathv; *ap != NULL; ++ap) {
422 if (**ap == '\0')
423 continue;
424 (void)printf("%s\n", *ap);
426 exit(cleanup());
430 * normal case - we display things in a single command, so
431 * build a list of things to display. first compute total
432 * length of buffer we will need so we can malloc it.
434 for (ap = pg.gl_pathv, len = m.pagerlen + 1; *ap != NULL; ++ap) {
435 if (**ap == '\0')
436 continue;
437 len += strlen(*ap) + 1;
439 if ((cmd = malloc(len)) == NULL) {
440 warn("malloc");
441 (void)cleanup();
442 exit(EXIT_FAILURE);
445 /* now build the command string... */
446 p = cmd;
447 len = m.pagerlen;
448 memcpy(p, m.pager, len);
449 p += len;
450 *p++ = ' ';
451 for (ap = pg.gl_pathv; *ap != NULL; ++ap) {
452 if (**ap == '\0')
453 continue;
454 len = strlen(*ap);
455 memcpy(p, *ap, len);
456 p += len;
457 *p++ = ' ';
459 *--p = '\0';
461 /* Use system(3) in case someone's pager is "pager arg1 arg2". */
462 (void)system(cmd);
464 exit(cleanup());
467 static int
468 manual_find_literalfile(struct manstate *mp, char **pv)
470 ENTRY *suffix;
471 int found;
472 char buf[MAXPATHLEN];
473 const char *p;
474 int suflen;
476 found = 0;
479 * Expand both '*' and suffix to force an actual
480 * match via fnmatch(3). Since the only match in pg
481 * is the literal file, the match is genuine.
484 TAILQ_FOREACH(suffix, &mp->buildlist->entrylist, q) {
485 for (p = suffix->s, suflen = 0;
486 *p != '\0' && !isspace((unsigned char)*p);
487 ++p)
488 ++suflen;
489 if (*p == '\0')
490 continue;
492 (void)snprintf(buf, sizeof(buf), "*%.*s", suflen, suffix->s);
494 if (!fnmatch(buf, *pv, 0)) {
495 if (!mp->where)
496 build_page(p + 1, pv, mp);
497 found = 1;
498 break;
502 return found;
505 static int
506 manual_find_buildkeyword(const char *prefix, const char *escpage,
507 struct manstate *mp, char **pv)
509 ENTRY *suffix;
510 int found;
511 char buf[MAXPATHLEN];
512 const char *p;
513 int suflen;
515 found = 0;
516 /* Try the _build keywords next. */
517 TAILQ_FOREACH(suffix, &mp->buildlist->entrylist, q) {
518 for (p = suffix->s, suflen = 0;
519 *p != '\0' && !isspace((unsigned char)*p);
520 ++p)
521 ++suflen;
522 if (*p == '\0')
523 continue;
525 (void)snprintf(buf, sizeof(buf), "%s%s%.*s",
526 prefix, escpage, suflen, suffix->s);
527 if (!fnmatch(buf, *pv, 0)) {
528 if (!mp->where)
529 build_page(p + 1, pv, mp);
530 found = 1;
531 break;
535 return found;
539 * manual --
540 * Search the manuals for the pages.
542 static int
543 manual(char *page, struct manstate *mp, glob_t *pg)
545 ENTRY *suffix, *mdir;
546 int anyfound, error, found;
547 size_t cnt;
548 char *p, buf[MAXPATHLEN], *escpage, *eptr;
549 static const char escglob[] = "\\~?*{}[]";
551 anyfound = 0;
554 * Fixup page which may contain glob(3) special characters, e.g.
555 * the famous "No man page for [" FAQ.
557 if ((escpage = malloc((2 * strlen(page)) + 1)) == NULL) {
558 warn("malloc");
559 (void)cleanup();
560 exit(EXIT_FAILURE);
563 p = page;
564 eptr = escpage;
566 while (*p) {
567 if (strchr(escglob, *p) != NULL) {
568 *eptr++ = '\\';
569 *eptr++ = *p++;
570 } else
571 *eptr++ = *p++;
574 *eptr = '\0';
577 * If 'page' contains a slash then it's
578 * interpreted as a file specification.
580 if (strchr(page, '/') != NULL) {
581 /* check if file actually exists */
582 (void)strlcpy(buf, escpage, sizeof(buf));
583 error = glob(buf, GLOB_APPEND | GLOB_BRACE | GLOB_NOSORT, NULL, pg);
584 if (error != 0) {
585 if (error == GLOB_NOMATCH) {
586 goto notfound;
587 } else {
588 errx(EXIT_FAILURE, "glob failed");
592 if (pg->gl_matchc == 0)
593 goto notfound;
595 /* literal file only yields one match */
596 cnt = pg->gl_pathc - pg->gl_matchc;
598 if (manual_find_literalfile(mp, &pg->gl_pathv[cnt])) {
599 anyfound = 1;
600 } else {
601 /* It's not a man page, forget about it. */
602 *pg->gl_pathv[cnt] = '\0';
605 notfound:
606 if (!anyfound) {
607 if (addentry(mp->missinglist, page, 0) < 0) {
608 warn("malloc");
609 (void)cleanup();
610 exit(EXIT_FAILURE);
613 free(escpage);
614 return anyfound;
617 /* For each man directory in mymanpath ... */
618 TAILQ_FOREACH(mdir, &mp->mymanpath->entrylist, q) {
621 * use glob(3) to look in the filesystem for matching files.
622 * match any suffix here, as we will check that later.
624 (void)snprintf(buf, sizeof(buf), "%s/%s.*", mdir->s, escpage);
625 if ((error = glob(buf,
626 GLOB_APPEND | GLOB_BRACE | GLOB_NOSORT, NULL, pg)) != 0) {
627 if (error == GLOB_NOMATCH)
628 continue;
629 else {
630 warn("globbing");
631 (void)cleanup();
632 exit(EXIT_FAILURE);
635 if (pg->gl_matchc == 0)
636 continue;
639 * start going through the matches glob(3) just found and
640 * use m.pathsearch (if present) to filter out pages we
641 * don't want. then verify the suffix is valid, and build
642 * the page if we have a _build suffix.
644 for (cnt = pg->gl_pathc - pg->gl_matchc;
645 cnt < pg->gl_pathc; ++cnt) {
647 /* filter on directory path name */
648 if (mp->pathsearch) {
649 p = strstr(pg->gl_pathv[cnt], mp->pathsearch);
650 if (!p || strchr(p, '/') == NULL) {
651 *pg->gl_pathv[cnt] = '\0'; /* zap! */
652 continue;
657 * Try the _suffix keywords first.
659 * XXX
660 * Older versions of man.conf didn't have the _suffix
661 * keywords, it was assumed that everything was a .0.
662 * We just test for .0 first, it's fast and probably
663 * going to hit.
665 (void)snprintf(buf, sizeof(buf), "*/%s.0", escpage);
666 if (!fnmatch(buf, pg->gl_pathv[cnt], 0))
667 goto next;
669 found = 0;
670 TAILQ_FOREACH(suffix, &mp->suffixlist->entrylist, q) {
671 (void)snprintf(buf,
672 sizeof(buf), "*/%s%s", escpage,
673 suffix->s);
674 if (!fnmatch(buf, pg->gl_pathv[cnt], 0)) {
675 found = 1;
676 break;
679 if (found)
680 goto next;
682 /* Try the _build keywords next. */
683 found = manual_find_buildkeyword("*/", escpage,
684 mp, &pg->gl_pathv[cnt]);
685 if (found) {
686 next: anyfound = 1;
687 if (!mp->all) {
688 /* Delete any other matches. */
689 while (++cnt< pg->gl_pathc)
690 *pg->gl_pathv[cnt] = '\0';
691 break;
693 continue;
696 /* It's not a man page, forget about it. */
697 *pg->gl_pathv[cnt] = '\0';
700 if (anyfound && !mp->all)
701 break;
704 /* If not found, enter onto the missing list. */
705 if (!anyfound) {
706 if (addentry(mp->missinglist, page, 0) < 0) {
707 warn("malloc");
708 (void)cleanup();
709 exit(EXIT_FAILURE);
713 free(escpage);
714 return anyfound;
718 * build_page --
719 * Build a man page for display.
721 static void
722 build_page(const char *fmt, char **pathp, struct manstate *mp)
724 static int warned;
725 int olddir, fd, n;
726 size_t tmpdirlen;
727 char *p, *b;
728 char buf[MAXPATHLEN], cmd[MAXPATHLEN], tpath[MAXPATHLEN];
729 const char *tmpdir;
731 /* Let the user know this may take awhile. */
732 if (!warned) {
733 warned = 1;
734 warnx("Formatting manual page...");
738 * Historically man chdir'd to the root of the man tree.
739 * This was used in man pages that contained relative ".so"
740 * directives (including other man pages for command aliases etc.)
741 * It even went one step farther, by examining the first line
742 * of the man page and parsing the .so filename so it would
743 * make hard(?) links to the cat'ted man pages for space savings.
744 * (We don't do that here, but we could).
747 /* copy and find the end */
748 for (b = buf, p = *pathp; (*b++ = *p++) != '\0';)
749 continue;
752 * skip the last two path components, page name and man[n] ...
753 * (e.g. buf will be "/usr/share/man" and p will be "man1/man.1")
754 * we also save a pointer to our current directory so that we
755 * can fchdir() back to it. this allows relative MANDIR paths
756 * to work with multiple man pages... e.g. consider:
757 * cd /usr/share && man -M ./man cat ls
758 * when no "cat1" subdir files are present.
760 olddir = -1;
761 for (--b, --p, n = 2; b != buf; b--, p--)
762 if (*b == '/')
763 if (--n == 0) {
764 *b = '\0';
765 olddir = open(".", O_RDONLY);
766 (void) chdir(buf);
767 p++;
768 break;
772 /* advance fmt past the suffix spec to the printf format string */
773 for (; *fmt && isspace((unsigned char)*fmt); ++fmt)
774 continue;
777 * Get a temporary file and build a version of the file
778 * to display. Replace the old file name with the new one.
780 if ((tmpdir = getenv("TMPDIR")) == NULL)
781 tmpdir = _PATH_TMP;
782 tmpdirlen = strlen(tmpdir);
783 (void)snprintf(tpath, sizeof (tpath), "%s%s%s", tmpdir,
784 (tmpdirlen > 0 && tmpdir[tmpdirlen-1] == '/') ? "" : "/", TMPFILE);
785 if ((fd = mkstemp(tpath)) == -1) {
786 warn("%s", tpath);
787 (void)cleanup();
788 exit(EXIT_FAILURE);
790 (void)snprintf(buf, sizeof(buf), "%s > %s", fmt, tpath);
791 (void)snprintf(cmd, sizeof(cmd), buf, p);
792 (void)system(cmd);
793 (void)close(fd);
794 if ((*pathp = strdup(tpath)) == NULL) {
795 warn("malloc");
796 (void)cleanup();
797 exit(EXIT_FAILURE);
800 /* Link the built file into the remove-when-done list. */
801 if (addentry(mp->intmp, *pathp, 0) < 0) {
802 warn("malloc");
803 (void)cleanup();
804 exit(EXIT_FAILURE);
807 /* restore old directory so relative manpaths still work */
808 if (olddir != -1) {
809 fchdir(olddir);
810 close(olddir);
815 * how --
816 * display how information
818 static void
819 how(const char *fname)
821 FILE *fp;
823 int lcnt, print;
824 char buf[256];
825 const char *p;
827 if (!(fp = fopen(fname, "r"))) {
828 warn("%s", fname);
829 (void)cleanup();
830 exit(EXIT_FAILURE);
832 #define S1 "SYNOPSIS"
833 #define S2 "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS"
834 #define D1 "DESCRIPTION"
835 #define D2 "D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN"
836 for (lcnt = print = 0; fgets(buf, sizeof(buf), fp);) {
837 if (!strncmp(buf, S1, sizeof(S1) - 1) ||
838 !strncmp(buf, S2, sizeof(S2) - 1)) {
839 print = 1;
840 continue;
841 } else if (!strncmp(buf, D1, sizeof(D1) - 1) ||
842 !strncmp(buf, D2, sizeof(D2) - 1)) {
843 if (fp)
844 (void)fclose(fp);
845 return;
847 if (!print)
848 continue;
849 if (*buf == '\n')
850 ++lcnt;
851 else {
852 for(; lcnt; --lcnt)
853 (void)putchar('\n');
854 for (p = buf; isspace((unsigned char)*p); ++p)
855 continue;
856 (void)fputs(p, stdout);
859 (void)fclose(fp);
863 * cat --
864 * cat out the file
866 static void
867 cat(const char *fname)
869 int fd;
870 ssize_t n;
871 char buf[2048];
873 if ((fd = open(fname, O_RDONLY, 0)) < 0) {
874 warn("%s", fname);
875 (void)cleanup();
876 exit(EXIT_FAILURE);
878 while ((n = read(fd, buf, sizeof(buf))) > 0)
879 if (write(STDOUT_FILENO, buf, (size_t)n) != n) {
880 warn("write");
881 (void)cleanup();
882 exit(EXIT_FAILURE);
884 if (n == -1) {
885 warn("read");
886 (void)cleanup();
887 exit(EXIT_FAILURE);
889 (void)close(fd);
893 * check_pager --
894 * check the user supplied page information
896 static const char *
897 check_pager(const char *name)
899 const char *p;
902 * if the user uses "more", we make it "more -s"; watch out for
903 * PAGER = "mypager /usr/ucb/more"
905 for (p = name; *p && !isspace((unsigned char)*p); ++p)
906 continue;
907 for (; p > name && *p != '/'; --p);
908 if (p != name)
909 ++p;
911 /* make sure it's "more", not "morex" */
912 if (!strncmp(p, "more", 4) && (!p[4] || isspace((unsigned char)p[4]))){
913 char *newname;
914 (void)asprintf(&newname, "%s %s", p, "-s");
915 name = newname;
918 return name;
922 * jump --
923 * strip out flag argument and jump
925 static void
926 jump(char **argv, const char *flag, const char *name)
928 char **arg;
930 argv[0] = __UNCONST(name);
931 for (arg = argv + 1; *arg; ++arg)
932 if (!strcmp(*arg, flag))
933 break;
934 for (; *arg; ++arg)
935 arg[0] = arg[1];
936 execvp(name, argv);
937 err(EXIT_FAILURE, "Cannot execute `%s'", name);
941 * onsig --
942 * If signaled, delete the temporary files.
944 static void
945 onsig(int signo)
948 (void)cleanup();
950 (void)raise_default_signal(signo);
952 /* NOTREACHED */
953 exit(EXIT_FAILURE);
957 * cleanup --
958 * Clean up temporary files, show any error messages.
960 static int
961 cleanup(void)
963 TAG *intmpp, *missp;
964 ENTRY *ep;
965 int rval;
967 rval = EXIT_SUCCESS;
969 * note that _missing and _intmp were created by main(), so
970 * gettag() cannot return NULL here.
972 missp = gettag("_missing", 0); /* missing man pages */
973 intmpp = gettag("_intmp", 0); /* tmp files we need to unlink */
975 TAILQ_FOREACH(ep, &missp->entrylist, q) {
976 warnx("no entry for %s in the manual.", ep->s);
977 rval = EXIT_FAILURE;
980 TAILQ_FOREACH(ep, &intmpp->entrylist, q)
981 (void)unlink(ep->s);
983 return rval;
986 static const char *
987 getclass(const char *machine)
989 char buf[BUFSIZ];
990 TAG *t;
991 snprintf(buf, sizeof(buf), "_%s", machine);
992 t = gettag(buf, 0);
993 return t != NULL && !TAILQ_EMPTY(&t->entrylist) ?
994 TAILQ_FIRST(&t->entrylist)->s : NULL;
997 static void
998 addpath(struct manstate *m, const char *dir, size_t len, const char *sub)
1000 char buf[2 * MAXPATHLEN + 1];
1001 (void)snprintf(buf, sizeof(buf), "%s%s%s{/%s,%s%s%s}",
1002 dir, (dir[len - 1] == '/') ? "" : "/", sub, m->machine,
1003 m->machclass ? "/" : "", m->machclass ? m->machclass : "",
1004 m->machclass ? "," : "");
1005 if (addentry(m->mymanpath, buf, 0) < 0)
1006 errx(EXIT_FAILURE, "malloc failed");
1010 * usage --
1011 * print usage message and die
1013 static void
1014 usage(void)
1016 (void)fprintf(stderr, "Usage: %s [-acw|-h] [-C cfg] [-M path] "
1017 "[-m path] [-S srch] [[-s] sect] name ...\n", getprogname());
1018 (void)fprintf(stderr,
1019 "Usage: %s -k [-C cfg] [-M path] [-m path] keyword ...\n",
1020 getprogname());
1021 (void)fprintf(stderr, "Usage: %s -p\n", getprogname());
1022 exit(EXIT_FAILURE);
1026 * printmanpath --
1027 * Prints a list of directories containing man pages.
1029 static void
1030 printmanpath(struct manstate *m)
1032 ENTRY *esubd;
1033 char *defaultpath = NULL; /* _default tag value from man.conf. */
1034 char *buf; /* for storing temporary values */
1035 char **ap;
1036 glob_t pg;
1037 struct stat sb;
1038 TAG *path = m->defaultpath;
1039 TAG *subdirs = m->subdirs;
1041 /* the tail queue is empty if no _default tag is defined in * man.conf */
1042 if (TAILQ_EMPTY(&path->entrylist))
1043 errx(EXIT_FAILURE, "Empty manpath");
1045 defaultpath = TAILQ_LAST(&path->entrylist, tqh)->s;
1047 if (glob(defaultpath, GLOB_BRACE | GLOB_NOSORT, NULL, &pg) != 0)
1048 err(EXIT_FAILURE, "glob failed");
1050 if (pg.gl_matchc == 0) {
1051 warnx("Default path in %s doesn't exist", _PATH_MANCONF);
1052 globfree(&pg);
1053 return;
1056 TAILQ_FOREACH(esubd, &subdirs->entrylist, q) {
1057 /* Drop cat page directory, only sources are relevant. */
1058 if (strncmp(esubd->s, "man", 3))
1059 continue;
1061 for (ap = pg.gl_pathv; *ap != NULL; ++ap) {
1062 if (asprintf(&buf, "%s%s", *ap, esubd->s) == -1)
1063 err(EXIT_FAILURE, "memory allocation error");
1064 /* Skip non-directories. */
1065 if (stat(buf, &sb) == 0 && S_ISDIR(sb.st_mode))
1066 printf("%s\n", buf);
1068 free(buf);
1071 globfree(&pg);