man.c revision 1.49 1 /* $NetBSD: man.c,v 1.49 2013/07/18 16:01:25 christos Exp $ */
2
3 /*
4 * Copyright (c) 1987, 1993, 1994, 1995
5 * The Regents of the University of California. All rights reserved.
6 *
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.
18 *
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.
30 */
31
32 #include <sys/cdefs.h>
33
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 */
38
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.49 2013/07/18 16:01:25 christos Exp $");
44 #endif
45 #endif /* not lint */
46
47 #include <sys/param.h>
48 #include <sys/queue.h>
49 #include <sys/stat.h>
50 #include <sys/utsname.h>
51
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>
65
66 #include "manconf.h"
67 #include "pathnames.h"
68
69 #ifndef MAN_DEBUG
70 #define MAN_DEBUG 0 /* debug path output */
71 #endif
72
73 /*
74 * manstate: structure collecting the current global state so we can
75 * easily identify it and pass it to helper functions in one arg.
76 */
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 */
89
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 */
95
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 */
101
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 */
107 };
108
109 /*
110 * prototypes
111 */
112 static void build_page(char *, char **, struct manstate *);
113 static void cat(char *);
114 static const char *check_pager(const char *);
115 static int cleanup(void);
116 static void how(char *);
117 static void jump(char **, const char *, const char *);
118 static int manual(char *, struct manstate *, glob_t *);
119 static void onsig(int);
120 static void usage(void) __attribute__((__noreturn__));
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 *);
124
125 /*
126 * main function
127 */
128 int
129 main(int argc, char **argv)
130 {
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;
137
138 setprogname(argv[0]);
139 setlocale(LC_ALL, "");
140 /*
141 * parse command line...
142 */
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;
168 /*
169 * The -f and -k options are backward compatible,
170 * undocumented ways of calling whatis(1) and apropos(1).
171 */
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();
192 }
193 argc -= optind;
194 argv += optind;
195
196 if (!m.getpath && !argc)
197 usage();
198
199 /*
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).
203 */
204 config(m.conffile); /* exits on error ... */
205
206 if ((m.machine = getenv("MACHINE")) == NULL) {
207 struct utsname utsname;
208
209 if (uname(&utsname) == -1)
210 err(EXIT_FAILURE, "uname");
211 m.machine = utsname.machine;
212 }
213
214 m.machclass = getclass(m.machine);
215
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);
226 }
227 }
228
229 /* do we need to set m.section to a non-null value? */
230 if (m.sectionname) {
231
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);
235
236 } else if (argc > 1) {
237
238 m.section = gettag(*argv, 0); /* might be a section? */
239 if (m.section) {
240 argv++;
241 argc--;
242 }
243
244 }
245
246 if (m.manpath == NULL)
247 m.manpath = getenv("MANPATH"); /* note: -M overrides getenv */
248
249
250 /*
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.
254 */
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");
267
268 /*
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.)
273 */
274 abs_section = (m.section != NULL &&
275 !TAILQ_EMPTY(&m.section->entrylist) &&
276 *(TAILQ_FIRST(&m.section->entrylist)->s) == '/');
277
278 /*
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...
282 *
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.
286 */
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 */
291 }
292
293 /*
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.
298 *
299 * after this step, we are done processing "m.section"...
300 */
301 if (m.section)
302 m.subdirs = m.section;
303
304 /*
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.
309 *
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}
317 *
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.
322 */
323 if (m.manpath) {
324
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);
332 }
333
334 } else {
335
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;
341 }
342
343 TAILQ_FOREACH(esubd, &m.subdirs->entrylist, q)
344 addpath(&m, epath->s, epath->len, esubd->s);
345 }
346
347 }
348
349 /*
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.
353 */
354 if (m.addpath) {
355
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);
363 }
364
365 }
366
367 if (m.getpath)
368 printmanpath(&m);
369
370 /*
371 * now m.mymanpath is complete!
372 */
373 #if MAN_DEBUG
374 printf("mymanpath:\n");
375 TAILQ_FOREACH(epath, &m.mymanpath->entrylist, q) {
376 printf("\t%s\n", epath->s);
377 }
378 #endif
379
380 /*
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.
384 */
385 (void)signal(SIGINT, onsig);
386 (void)signal(SIGHUP, onsig);
387 (void)signal(SIGPIPE, onsig);
388
389 memset(&pg, 0, sizeof(pg));
390 for (found = 0; *argv; ++argv)
391 if (manual(*argv, &m, &pg)) {
392 found = 1;
393 }
394
395 /* if nothing found, we're done. */
396 if (!found) {
397 (void)cleanup();
398 exit(EXIT_FAILURE);
399 }
400
401 /*
402 * handle the simple display cases first (m.cat, m.how, m.where)
403 */
404 if (m.cat) {
405 for (ap = pg.gl_pathv; *ap != NULL; ++ap) {
406 if (**ap == '\0')
407 continue;
408 cat(*ap);
409 }
410 exit(cleanup());
411 }
412 if (m.how) {
413 for (ap = pg.gl_pathv; *ap != NULL; ++ap) {
414 if (**ap == '\0')
415 continue;
416 how(*ap);
417 }
418 exit(cleanup());
419 }
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);
425 }
426 exit(cleanup());
427 }
428
429 /*
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.
433 */
434 for (ap = pg.gl_pathv, len = m.pagerlen + 1; *ap != NULL; ++ap) {
435 if (**ap == '\0')
436 continue;
437 len += strlen(*ap) + 1;
438 }
439 if ((cmd = malloc(len)) == NULL) {
440 warn("malloc");
441 (void)cleanup();
442 exit(EXIT_FAILURE);
443 }
444
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++ = ' ';
458 }
459 *--p = '\0';
460
461 /* Use system(3) in case someone's pager is "pager arg1 arg2". */
462 (void)system(cmd);
463
464 exit(cleanup());
465 }
466
467 static void
468 fixstring(char *buf, size_t len, const char *fmt, const char *str)
469 {
470 const char *ptr = strstr(fmt, "%s");
471 size_t l;
472 if (ptr == NULL) {
473 strlcpy(buf, fmt, len);
474 return;
475 }
476 l = (size_t)(ptr - fmt) + 1;
477 strlcpy(buf, fmt, MIN(l, len));
478 strlcat(buf, str, len);
479 strlcat(buf, ptr + 2, len);
480 }
481
482 static int
483 manual_find_buildkeyword(char *escpage, const char *fmt,
484 struct manstate *mp, glob_t *pg, size_t cnt)
485 {
486 ENTRY *suffix;
487 int found;
488 char *p, buf[MAXPATHLEN];
489
490 found = 0;
491 /* Try the _build key words next. */
492 TAILQ_FOREACH(suffix, &mp->buildlist->entrylist, q) {
493 for (p = suffix->s;
494 *p != '\0' && !isspace((unsigned char)*p);
495 ++p)
496 continue;
497 if (*p == '\0')
498 continue;
499
500 *p = '\0';
501 fixstring(buf, sizeof(buf), fmt, escpage);
502 if (!fnmatch(buf, pg->gl_pathv[cnt], 0)) {
503 if (!mp->where)
504 build_page(p + 1, &pg->gl_pathv[cnt], mp);
505 *p = ' ';
506 found = 1;
507 break;
508 }
509 *p = ' ';
510 }
511
512 return found;
513 }
514
515 /*
516 * manual --
517 * Search the manuals for the pages.
518 */
519 static int
520 manual(char *page, struct manstate *mp, glob_t *pg)
521 {
522 ENTRY *suffix, *mdir;
523 int anyfound, error, found;
524 size_t cnt;
525 char *p, buf[MAXPATHLEN], *escpage, *eptr;
526 static const char escglob[] = "\\~?*{}[]";
527
528 anyfound = 0;
529
530 /*
531 * Fixup page which may contain glob(3) special characters, e.g.
532 * the famous "No man page for [" FAQ.
533 */
534 if ((escpage = malloc((2 * strlen(page)) + 1)) == NULL) {
535 warn("malloc");
536 (void)cleanup();
537 exit(EXIT_FAILURE);
538 }
539
540 p = page;
541 eptr = escpage;
542
543 while (*p) {
544 if (strchr(escglob, *p) != NULL) {
545 *eptr++ = '\\';
546 *eptr++ = *p++;
547 } else
548 *eptr++ = *p++;
549 }
550
551 *eptr = '\0';
552
553 /*
554 * If 'page' is given with a full or relative path
555 * then interpret it as a file specification.
556 */
557 if ((page[0] == '/') || (page[0] == '.')) {
558 /* check if file actually exists */
559 (void)strlcpy(buf, escpage, sizeof(buf));
560 error = glob(buf, GLOB_APPEND | GLOB_BRACE | GLOB_NOSORT, NULL, pg);
561 if (error != 0) {
562 if (error == GLOB_NOMATCH) {
563 goto notfound;
564 } else {
565 errx(EXIT_FAILURE, "glob failed");
566 }
567 }
568
569 if (pg->gl_matchc == 0)
570 goto notfound;
571
572 /* clip suffix for the suffix check below */
573 p = strrchr(escpage, '.');
574 if (p && p[0] == '.' && isdigit((unsigned char)p[1]))
575 p[0] = '\0';
576
577 found = 0;
578 for (cnt = pg->gl_pathc - pg->gl_matchc;
579 cnt < pg->gl_pathc; ++cnt)
580 {
581 found = manual_find_buildkeyword(escpage, "%s%s",
582 mp, pg, cnt);
583 if (found) {
584 anyfound = 1;
585 if (!mp->all) {
586 /* Delete any other matches. */
587 while (++cnt< pg->gl_pathc)
588 *pg->gl_pathv[cnt] = '\0';
589 break;
590 }
591 continue;
592 }
593
594 /* It's not a man page, forget about it. */
595 *pg->gl_pathv[cnt] = '\0';
596 }
597
598 notfound:
599 if (!anyfound) {
600 if (addentry(mp->missinglist, page, 0) < 0) {
601 warn("malloc");
602 (void)cleanup();
603 exit(EXIT_FAILURE);
604 }
605 }
606 free(escpage);
607 return anyfound;
608 }
609
610 /* For each man directory in mymanpath ... */
611 TAILQ_FOREACH(mdir, &mp->mymanpath->entrylist, q) {
612
613 /*
614 * use glob(3) to look in the filesystem for matching files.
615 * match any suffix here, as we will check that later.
616 */
617 (void)snprintf(buf, sizeof(buf), "%s/%s.*", mdir->s, escpage);
618 if ((error = glob(buf,
619 GLOB_APPEND | GLOB_BRACE | GLOB_NOSORT, NULL, pg)) != 0) {
620 if (error == GLOB_NOMATCH)
621 continue;
622 else {
623 warn("globbing");
624 (void)cleanup();
625 exit(EXIT_FAILURE);
626 }
627 }
628 if (pg->gl_matchc == 0)
629 continue;
630
631 /*
632 * start going through the matches glob(3) just found and
633 * use m.pathsearch (if present) to filter out pages we
634 * don't want. then verify the suffix is valid, and build
635 * the page if we have a _build suffix.
636 */
637 for (cnt = pg->gl_pathc - pg->gl_matchc;
638 cnt < pg->gl_pathc; ++cnt) {
639
640 /* filter on directory path name */
641 if (mp->pathsearch) {
642 p = strstr(pg->gl_pathv[cnt], mp->pathsearch);
643 if (!p || strchr(p, '/') == NULL) {
644 *pg->gl_pathv[cnt] = '\0'; /* zap! */
645 continue;
646 }
647 }
648
649 /*
650 * Try the _suffix key words first.
651 *
652 * XXX
653 * Older versions of man.conf didn't have the suffix
654 * key words, it was assumed that everything was a .0.
655 * We just test for .0 first, it's fast and probably
656 * going to hit.
657 */
658 (void)snprintf(buf, sizeof(buf), "*/%s.0", escpage);
659 if (!fnmatch(buf, pg->gl_pathv[cnt], 0))
660 goto next;
661
662 found = 0;
663 TAILQ_FOREACH(suffix, &mp->suffixlist->entrylist, q) {
664 (void)snprintf(buf,
665 sizeof(buf), "*/%s%s", escpage,
666 suffix->s);
667 if (!fnmatch(buf, pg->gl_pathv[cnt], 0)) {
668 found = 1;
669 break;
670 }
671 }
672 if (found)
673 goto next;
674
675 /* Try the _build key words next. */
676 found = manual_find_buildkeyword(escpage, "*/%s%s",
677 mp, pg, cnt);
678 if (found) {
679 next: anyfound = 1;
680 if (!mp->all) {
681 /* Delete any other matches. */
682 while (++cnt< pg->gl_pathc)
683 *pg->gl_pathv[cnt] = '\0';
684 break;
685 }
686 continue;
687 }
688
689 /* It's not a man page, forget about it. */
690 *pg->gl_pathv[cnt] = '\0';
691 }
692
693 if (anyfound && !mp->all)
694 break;
695 }
696
697 /* If not found, enter onto the missing list. */
698 if (!anyfound) {
699 if (addentry(mp->missinglist, page, 0) < 0) {
700 warn("malloc");
701 (void)cleanup();
702 exit(EXIT_FAILURE);
703 }
704 }
705
706 free(escpage);
707 return anyfound;
708 }
709
710 /*
711 * build_page --
712 * Build a man page for display.
713 */
714 static void
715 build_page(char *fmt, char **pathp, struct manstate *mp)
716 {
717 static int warned;
718 int olddir, fd, n;
719 size_t tmpdirlen;
720 char *p, *b;
721 char buf[MAXPATHLEN], cmd[MAXPATHLEN], tpath[MAXPATHLEN];
722 const char *tmpdir;
723
724 /* Let the user know this may take awhile. */
725 if (!warned) {
726 warned = 1;
727 warnx("Formatting manual page...");
728 }
729
730 /*
731 * Historically man chdir'd to the root of the man tree.
732 * This was used in man pages that contained relative ".so"
733 * directives (including other man pages for command aliases etc.)
734 * It even went one step farther, by examining the first line
735 * of the man page and parsing the .so filename so it would
736 * make hard(?) links to the cat'ted man pages for space savings.
737 * (We don't do that here, but we could).
738 */
739
740 /* copy and find the end */
741 for (b = buf, p = *pathp; (*b++ = *p++) != '\0';)
742 continue;
743
744 /*
745 * skip the last two path components, page name and man[n] ...
746 * (e.g. buf will be "/usr/share/man" and p will be "man1/man.1")
747 * we also save a pointer to our current directory so that we
748 * can fchdir() back to it. this allows relative MANDIR paths
749 * to work with multiple man pages... e.g. consider:
750 * cd /usr/share && man -M ./man cat ls
751 * when no "cat1" subdir files are present.
752 */
753 olddir = -1;
754 for (--b, --p, n = 2; b != buf; b--, p--)
755 if (*b == '/')
756 if (--n == 0) {
757 *b = '\0';
758 olddir = open(".", O_RDONLY);
759 (void) chdir(buf);
760 p++;
761 break;
762 }
763
764
765 /* advance fmt pass the suffix spec to the printf format string */
766 for (; *fmt && isspace((unsigned char)*fmt); ++fmt)
767 continue;
768
769 /*
770 * Get a temporary file and build a version of the file
771 * to display. Replace the old file name with the new one.
772 */
773 if ((tmpdir = getenv("TMPDIR")) == NULL)
774 tmpdir = _PATH_TMP;
775 tmpdirlen = strlen(tmpdir);
776 (void)snprintf(tpath, sizeof (tpath), "%s%s%s", tmpdir,
777 (tmpdirlen && tmpdir[tmpdirlen-1] == '/') ? "" : "/", TMPFILE);
778 if ((fd = mkstemp(tpath)) == -1) {
779 warn("%s", tpath);
780 (void)cleanup();
781 exit(EXIT_FAILURE);
782 }
783 (void)snprintf(buf, sizeof(buf), "%s > %s", fmt, tpath);
784 fixstring(cmd, sizeof(cmd), buf, p);
785 (void)system(cmd);
786 (void)close(fd);
787 if ((*pathp = strdup(tpath)) == NULL) {
788 warn("malloc");
789 (void)cleanup();
790 exit(EXIT_FAILURE);
791 }
792
793 /* Link the built file into the remove-when-done list. */
794 if (addentry(mp->intmp, *pathp, 0) < 0) {
795 warn("malloc");
796 (void)cleanup();
797 exit(EXIT_FAILURE);
798 }
799
800 /* restore old directory so relative manpaths still work */
801 if (olddir != -1) {
802 fchdir(olddir);
803 close(olddir);
804 }
805 }
806
807 /*
808 * how --
809 * display how information
810 */
811 static void
812 how(char *fname)
813 {
814 FILE *fp;
815
816 int lcnt, print;
817 char *p, buf[256];
818
819 if (!(fp = fopen(fname, "r"))) {
820 warn("%s", fname);
821 (void)cleanup();
822 exit(EXIT_FAILURE);
823 }
824 #define S1 "SYNOPSIS"
825 #define S2 "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS"
826 #define D1 "DESCRIPTION"
827 #define D2 "D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN"
828 for (lcnt = print = 0; fgets(buf, sizeof(buf), fp);) {
829 if (!strncmp(buf, S1, sizeof(S1) - 1) ||
830 !strncmp(buf, S2, sizeof(S2) - 1)) {
831 print = 1;
832 continue;
833 } else if (!strncmp(buf, D1, sizeof(D1) - 1) ||
834 !strncmp(buf, D2, sizeof(D2) - 1)) {
835 if (fp)
836 (void)fclose(fp);
837 return;
838 }
839 if (!print)
840 continue;
841 if (*buf == '\n')
842 ++lcnt;
843 else {
844 for(; lcnt; --lcnt)
845 (void)putchar('\n');
846 for (p = buf; isspace((unsigned char)*p); ++p)
847 continue;
848 (void)fputs(p, stdout);
849 }
850 }
851 (void)fclose(fp);
852 }
853
854 /*
855 * cat --
856 * cat out the file
857 */
858 static void
859 cat(char *fname)
860 {
861 int fd;
862 ssize_t n;
863 char buf[2048];
864
865 if ((fd = open(fname, O_RDONLY, 0)) < 0) {
866 warn("%s", fname);
867 (void)cleanup();
868 exit(EXIT_FAILURE);
869 }
870 while ((n = read(fd, buf, sizeof(buf))) > 0)
871 if (write(STDOUT_FILENO, buf, (size_t)n) != n) {
872 warn("write");
873 (void)cleanup();
874 exit(EXIT_FAILURE);
875 }
876 if (n == -1) {
877 warn("read");
878 (void)cleanup();
879 exit(EXIT_FAILURE);
880 }
881 (void)close(fd);
882 }
883
884 /*
885 * check_pager --
886 * check the user supplied page information
887 */
888 static const char *
889 check_pager(const char *name)
890 {
891 const char *p;
892
893 /*
894 * if the user uses "more", we make it "more -s"; watch out for
895 * PAGER = "mypager /usr/ucb/more"
896 */
897 for (p = name; *p && !isspace((unsigned char)*p); ++p)
898 continue;
899 for (; p > name && *p != '/'; --p);
900 if (p != name)
901 ++p;
902
903 /* make sure it's "more", not "morex" */
904 if (!strncmp(p, "more", 4) && (!p[4] || isspace((unsigned char)p[4]))){
905 char *newname;
906 (void)asprintf(&newname, "%s %s", p, "-s");
907 name = newname;
908 }
909
910 return name;
911 }
912
913 /*
914 * jump --
915 * strip out flag argument and jump
916 */
917 static void
918 jump(char **argv, const char *flag, const char *name)
919 {
920 char **arg;
921
922 argv[0] = __UNCONST(name);
923 for (arg = argv + 1; *arg; ++arg)
924 if (!strcmp(*arg, flag))
925 break;
926 for (; *arg; ++arg)
927 arg[0] = arg[1];
928 execvp(name, argv);
929 err(EXIT_FAILURE, "Cannot execute `%s'", name);
930 }
931
932 /*
933 * onsig --
934 * If signaled, delete the temporary files.
935 */
936 static void
937 onsig(int signo)
938 {
939
940 (void)cleanup();
941
942 (void)raise_default_signal(signo);
943
944 /* NOTREACHED */
945 exit(EXIT_FAILURE);
946 }
947
948 /*
949 * cleanup --
950 * Clean up temporary files, show any error messages.
951 */
952 static int
953 cleanup(void)
954 {
955 TAG *intmpp, *missp;
956 ENTRY *ep;
957 int rval;
958
959 rval = EXIT_SUCCESS;
960 /*
961 * note that _missing and _intmp were created by main(), so
962 * gettag() cannot return NULL here.
963 */
964 missp = gettag("_missing", 0); /* missing man pages */
965 intmpp = gettag("_intmp", 0); /* tmp files we need to unlink */
966
967 TAILQ_FOREACH(ep, &missp->entrylist, q) {
968 warnx("no entry for %s in the manual.", ep->s);
969 rval = EXIT_FAILURE;
970 }
971
972 TAILQ_FOREACH(ep, &intmpp->entrylist, q)
973 (void)unlink(ep->s);
974
975 return rval;
976 }
977
978 static const char *
979 getclass(const char *machine)
980 {
981 char buf[BUFSIZ];
982 TAG *t;
983 snprintf(buf, sizeof(buf), "_%s", machine);
984 t = gettag(buf, 0);
985 return t != NULL && !TAILQ_EMPTY(&t->entrylist) ?
986 TAILQ_FIRST(&t->entrylist)->s : NULL;
987 }
988
989 static void
990 addpath(struct manstate *m, const char *dir, size_t len, const char *sub)
991 {
992 char buf[2 * MAXPATHLEN + 1];
993 (void)snprintf(buf, sizeof(buf), "%s%s%s{/%s,%s%s%s}",
994 dir, (dir[len - 1] == '/') ? "" : "/", sub, m->machine,
995 m->machclass ? "/" : "", m->machclass ? m->machclass : "",
996 m->machclass ? "," : "");
997 if (addentry(m->mymanpath, buf, 0) < 0)
998 errx(EXIT_FAILURE, "malloc failed");
999 }
1000
1001 /*
1002 * usage --
1003 * print usage message and die
1004 */
1005 static void
1006 usage(void)
1007 {
1008 (void)fprintf(stderr, "Usage: %s [-acw|-h] [-C cfg] [-M path] "
1009 "[-m path] [-S srch] [[-s] sect] name ...\n", getprogname());
1010 (void)fprintf(stderr,
1011 "Usage: %s -k [-C cfg] [-M path] [-m path] keyword ...\n",
1012 getprogname());
1013 (void)fprintf(stderr, "Usage: %s -p\n", getprogname());
1014 exit(EXIT_FAILURE);
1015 }
1016
1017 /*
1018 * printmanpath --
1019 * Prints a list of directories containing man pages.
1020 */
1021 static void
1022 printmanpath(struct manstate *m)
1023 {
1024 ENTRY *esubd;
1025 char *defaultpath = NULL; /* _default tag value from man.conf. */
1026 char *buf; /* for storing temporary values */
1027 char **ap;
1028 glob_t pg;
1029 struct stat sb;
1030 TAG *path = m->defaultpath;
1031 TAG *subdirs = m->subdirs;
1032
1033 /* the tail queue is empty if no _default tag is defined in * man.conf */
1034 if (TAILQ_EMPTY(&path->entrylist))
1035 errx(EXIT_FAILURE, "Empty manpath");
1036
1037 defaultpath = TAILQ_LAST(&path->entrylist, tqh)->s;
1038
1039 if (glob(defaultpath, GLOB_BRACE | GLOB_NOSORT, NULL, &pg) != 0)
1040 err(EXIT_FAILURE, "glob failed");
1041
1042 if (pg.gl_matchc == 0) {
1043 warnx("Default path in %s doesn't exist", _PATH_MANCONF);
1044 globfree(&pg);
1045 return;
1046 }
1047
1048 TAILQ_FOREACH(esubd, &subdirs->entrylist, q) {
1049 /* Drop cat page directory, only sources are relevant. */
1050 if (strncmp(esubd->s, "man", 3))
1051 continue;
1052
1053 for (ap = pg.gl_pathv; *ap != NULL; ++ap) {
1054 if (asprintf(&buf, "%s%s", *ap, esubd->s) == -1)
1055 err(EXIT_FAILURE, "memory allocation error");
1056 /* Skip non-directories. */
1057 if (stat(buf, &sb) == 0 && S_ISDIR(sb.st_mode))
1058 printf("%s\n", buf);
1059
1060 free(buf);
1061 }
1062 }
1063 globfree(&pg);
1064 }
1065