1 /* $NetBSD: man.c,v 1.39 2009/10/07 08:30:31 cegger 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.39 2009/10/07 08:30:31 cegger Exp $"); 44 #endif 45 #endif /* not lint */ 46 47 #include <sys/param.h> 48 #include <sys/queue.h> 49 #include <sys/utsname.h> 50 51 #include <ctype.h> 52 #include <err.h> 53 #include <errno.h> 54 #include <fcntl.h> 55 #include <fnmatch.h> 56 #include <glob.h> 57 #include <signal.h> 58 #include <stdio.h> 59 #include <stdlib.h> 60 #include <string.h> 61 #include <unistd.h> 62 #include <util.h> 63 64 #include "manconf.h" 65 #include "pathnames.h" 66 67 #ifndef MAN_DEBUG 68 #define MAN_DEBUG 0 /* debug path output */ 69 #endif 70 71 /* 72 * manstate: structure collecting the current global state so we can 73 * easily identify it and pass it to helper functions in one arg. 74 */ 75 struct manstate { 76 /* command line flags */ 77 int all; /* -a: show all matches rather than first */ 78 int cat; /* -c: do not use a pager */ 79 char *conffile; /* -C: use alternate config file */ 80 int how; /* -h: show SYNOPSIS only */ 81 char *manpath; /* -M: alternate MANPATH */ 82 char *addpath; /* -m: add these dirs to front of manpath */ 83 char *pathsearch; /* -S: path of man must contain this string */ 84 char *sectionname; /* -s: limit search to a given man section */ 85 int where; /* -w: just show paths of all matching files */ 86 87 /* important tags from the config file */ 88 TAG *defaultpath; /* _default: default MANPATH */ 89 TAG *subdirs; /* _subdir: default subdir search list */ 90 TAG *suffixlist; /* _suffix: for files that can be cat()'d */ 91 TAG *buildlist; /* _build: for files that must be built */ 92 93 /* tags for internal use */ 94 TAG *intmp; /* _intmp: tmp files we must cleanup */ 95 TAG *missinglist; /* _missing: pages we couldn't find */ 96 TAG *mymanpath; /* _new_path: final version of MANPATH */ 97 TAG *section; /* <sec>: tag for m.sectionname */ 98 99 /* other misc stuff */ 100 const char *pager; /* pager to use */ 101 size_t pagerlen; /* length of the above */ 102 }; 103 104 /* 105 * prototypes 106 */ 107 static void build_page(char *, char **, struct manstate *); 108 static void cat(char *); 109 static const char *check_pager(const char *); 110 static int cleanup(void); 111 static void how(char *); 112 static void jump(char **, char *, char *); 113 static int manual(char *, struct manstate *, glob_t *); 114 static void onsig(int); 115 static void usage(void); 116 117 /* 118 * main function 119 */ 120 int 121 main(int argc, char **argv) 122 { 123 static struct manstate m = { 0 }; /* init to zero */ 124 int ch, abs_section, found; 125 const char *machine; 126 ENTRY *esubd, *epath; 127 char *p, **ap, *cmd, buf[MAXPATHLEN * 2]; 128 size_t len; 129 glob_t pg; 130 131 /* 132 * parse command line... 133 */ 134 while ((ch = getopt(argc, argv, "-aC:cfhkM:m:P:s:S:w")) != -1) 135 switch (ch) { 136 case 'a': 137 m.all = 1; 138 break; 139 case 'C': 140 m.conffile = optarg; 141 break; 142 case 'c': 143 case '-': /* XXX: '-' is a deprecated version of '-c' */ 144 m.cat = 1; 145 break; 146 case 'h': 147 m.how = 1; 148 break; 149 case 'm': 150 m.addpath = optarg; 151 break; 152 case 'M': 153 case 'P': /* -P for backward compatibility */ 154 m.manpath = strdup(optarg); 155 break; 156 /* 157 * The -f and -k options are backward compatible, 158 * undocumented ways of calling whatis(1) and apropos(1). 159 */ 160 case 'f': 161 jump(argv, "-f", "whatis"); 162 /* NOTREACHED */ 163 case 'k': 164 jump(argv, "-k", "apropos"); 165 /* NOTREACHED */ 166 case 's': 167 if (m.sectionname != NULL) 168 usage(); 169 m.sectionname = optarg; 170 break; 171 case 'S': 172 m.pathsearch = optarg; 173 break; 174 case 'w': 175 m.all = m.where = 1; 176 break; 177 case '?': 178 default: 179 usage(); 180 } 181 argc -= optind; 182 argv += optind; 183 184 if (!argc) 185 usage(); 186 187 /* 188 * read the configuration file and collect any other information 189 * we will need (machine type, pager, section [if specified 190 * without '-s'], and MANPATH through the environment). 191 */ 192 config(m.conffile); /* exits on error ... */ 193 194 if ((machine = getenv("MACHINE")) == NULL) { 195 struct utsname utsname; 196 197 if (uname(&utsname) == -1) { 198 perror("uname"); 199 exit(EXIT_FAILURE); 200 } 201 machine = utsname.machine; 202 } 203 204 if (!m.cat && !m.how && !m.where) { /* if we need a pager ... */ 205 if (!isatty(STDOUT_FILENO)) { 206 m.cat = 1; 207 } else { 208 if ((m.pager = getenv("PAGER")) != NULL && 209 m.pager[0] != '\0') 210 m.pager = check_pager(m.pager); 211 else 212 m.pager = _PATH_PAGER; 213 m.pagerlen = strlen(m.pager); 214 } 215 } 216 217 /* do we need to set m.section to a non-null value? */ 218 if (m.sectionname) { 219 220 m.section = gettag(m.sectionname, 0); /* -s must be a section */ 221 if (m.section == NULL) 222 errx(EXIT_FAILURE, "unknown section: %s", m.sectionname); 223 224 } else if (argc > 1) { 225 226 m.section = gettag(*argv, 0); /* might be a section? */ 227 if (m.section) { 228 argv++; 229 argc--; 230 } 231 232 } 233 234 if (m.manpath == NULL) 235 m.manpath = getenv("MANPATH"); /* note: -M overrides getenv */ 236 237 238 /* 239 * get default values from config file, plus create the tags we 240 * use for keeping internal state. make sure all our mallocs 241 * go through. 242 */ 243 /* from cfg file */ 244 m.defaultpath = gettag("_default", 1); 245 m.subdirs = gettag("_subdir", 1); 246 m.suffixlist = gettag("_suffix", 1); 247 m.buildlist = gettag("_build", 1); 248 /* internal use */ 249 m.mymanpath = gettag("_new_path", 1); 250 m.missinglist = gettag("_missing", 1); 251 m.intmp = gettag("_intmp", 1); 252 if (!m.defaultpath || !m.subdirs || !m.suffixlist || !m.buildlist || 253 !m.mymanpath || !m.missinglist || !m.intmp) 254 errx(EXIT_FAILURE, "malloc failed"); 255 256 /* 257 * are we using a section whose elements are all absolute paths? 258 * (we only need to look at the first entry on the section list, 259 * as config() will ensure that any additional entries will match 260 * the first one.) 261 */ 262 abs_section = (m.section != NULL && 263 !TAILQ_EMPTY(&m.section->entrylist) && 264 *(TAILQ_FIRST(&m.section->entrylist)->s) == '/'); 265 266 /* 267 * now that we have all the data we need, we must determine the 268 * manpath we are going to use to find the requested entries using 269 * the following steps... 270 * 271 * [1] if the user specified a section and that section's elements 272 * from the config file are all absolute paths, then we override 273 * defaultpath and -M/MANPATH with the section's absolute paths. 274 */ 275 if (abs_section) { 276 m.manpath = NULL; /* ignore -M/MANPATH */ 277 m.defaultpath = m.section; /* overwrite _default path */ 278 m.section = NULL; /* promoted to defaultpath */ 279 } 280 281 /* 282 * [2] section can now only be non-null if the user asked for 283 * a section and that section's elements did not have 284 * absolute paths. in this case we use the section's 285 * elements to override _subdir from the config file. 286 * 287 * after this step, we are done processing "m.section"... 288 */ 289 if (m.section) 290 m.subdirs = m.section; 291 292 /* 293 * [3] we need to setup the path we want to use (m.mymanpath). 294 * if the user gave us a path (m.manpath) use it, otherwise 295 * go with the default. in either case we need to append 296 * the subdir and machine spec to each element of the path. 297 * 298 * for absolute section paths that come from the config file, 299 * we only append the subdir spec if the path ends in 300 * a '/' --- elements that do not end in '/' are assumed to 301 * not have subdirectories. this is mainly for backward compat, 302 * but it allows non-subdir configs like: 303 * sect3 /usr/share/man/{old/,}cat3 304 * doc /usr/{pkg,share}/doc/{sendmail/op,sendmail/intro} 305 * 306 * note that we try and be careful to not put double slashes 307 * in the path (e.g. we want /usr/share/man/man1, not 308 * /usr/share/man//man1) because "more" will put the filename 309 * we generate in its prompt and the double slashes look ugly. 310 */ 311 if (m.manpath) { 312 313 /* note: strtok is going to destroy m.manpath */ 314 for (p = strtok(m.manpath, ":") ; p ; p = strtok(NULL, ":")) { 315 len = strlen(p); 316 if (len < 1) 317 continue; 318 TAILQ_FOREACH(esubd, &m.subdirs->entrylist, q) { 319 snprintf(buf, sizeof(buf), "%s%s%s{/%s,}", 320 p, (p[len-1] == '/') ? "" : "/", 321 esubd->s, machine); 322 if (addentry(m.mymanpath, buf, 0) < 0) 323 errx(EXIT_FAILURE, "malloc failed"); 324 } 325 } 326 327 } else { 328 329 TAILQ_FOREACH(epath, &m.defaultpath->entrylist, q) { 330 /* handle trailing "/" magic here ... */ 331 if (abs_section && 332 epath->s[epath->len - 1] != '/') { 333 334 (void)snprintf(buf, sizeof(buf), 335 "%s{/%s,}", epath->s, machine); 336 if (addentry(m.mymanpath, buf, 0) < 0) 337 errx(EXIT_FAILURE, "malloc failed"); 338 continue; 339 } 340 341 TAILQ_FOREACH(esubd, &m.subdirs->entrylist, q) { 342 snprintf(buf, sizeof(buf), "%s%s%s{/%s,}", 343 epath->s, 344 (epath->s[epath->len-1] == '/') ? "" 345 : "/", 346 esubd->s, machine); 347 if (addentry(m.mymanpath, buf, 0) < 0) 348 errx(EXIT_FAILURE, "malloc failed"); 349 } 350 } 351 352 } 353 354 /* 355 * [4] finally, prepend the "-m" m.addpath to mymanpath if it 356 * was specified. subdirs and machine are always applied to 357 * m.addpath. 358 */ 359 if (m.addpath) { 360 361 /* note: strtok is going to destroy m.addpath */ 362 for (p = strtok(m.addpath, ":") ; p ; p = strtok(NULL, ":")) { 363 len = strlen(p); 364 if (len < 1) 365 continue; 366 TAILQ_FOREACH(esubd, &m.subdirs->entrylist, q) { 367 snprintf(buf, sizeof(buf), "%s%s%s{/%s,}", 368 p, (p[len-1] == '/') ? "" : "/", 369 esubd->s, machine); 370 /* add at front */ 371 if (addentry(m.mymanpath, buf, 1) < 0) 372 errx(EXIT_FAILURE, "malloc failed"); 373 } 374 } 375 376 } 377 378 /* 379 * now m.mymanpath is complete! 380 */ 381 #if MAN_DEBUG 382 printf("mymanpath:\n"); 383 TAILQ_FOREACH(epath, &m.mymanpath->entrylist, q) { 384 printf("\t%s\n", epath->s); 385 } 386 #endif 387 388 /* 389 * start searching for matching files and format them if necessary. 390 * setup an interrupt handler so that we can ensure that temporary 391 * files go away. 392 */ 393 (void)signal(SIGINT, onsig); 394 (void)signal(SIGHUP, onsig); 395 (void)signal(SIGPIPE, onsig); 396 397 memset(&pg, 0, sizeof(pg)); 398 for (found = 0; *argv; ++argv) 399 if (manual(*argv, &m, &pg)) { 400 found = 1; 401 } 402 403 /* if nothing found, we're done. */ 404 if (!found) { 405 (void)cleanup(); 406 exit(EXIT_FAILURE); 407 } 408 409 /* 410 * handle the simple display cases first (m.cat, m.how, m.where) 411 */ 412 if (m.cat) { 413 for (ap = pg.gl_pathv; *ap != NULL; ++ap) { 414 if (**ap == '\0') 415 continue; 416 cat(*ap); 417 } 418 exit(cleanup()); 419 } 420 if (m.how) { 421 for (ap = pg.gl_pathv; *ap != NULL; ++ap) { 422 if (**ap == '\0') 423 continue; 424 how(*ap); 425 } 426 exit(cleanup()); 427 } 428 if (m.where) { 429 for (ap = pg.gl_pathv; *ap != NULL; ++ap) { 430 if (**ap == '\0') 431 continue; 432 (void)printf("%s\n", *ap); 433 } 434 exit(cleanup()); 435 } 436 437 /* 438 * normal case - we display things in a single command, so 439 * build a list of things to display. first compute total 440 * length of buffer we will need so we can malloc it. 441 */ 442 for (ap = pg.gl_pathv, len = m.pagerlen + 1; *ap != NULL; ++ap) { 443 if (**ap == '\0') 444 continue; 445 len += strlen(*ap) + 1; 446 } 447 if ((cmd = malloc(len)) == NULL) { 448 warn("malloc"); 449 (void)cleanup(); 450 exit(EXIT_FAILURE); 451 } 452 453 /* now build the command string... */ 454 p = cmd; 455 len = m.pagerlen; 456 memcpy(p, m.pager, len); 457 p += len; 458 *p++ = ' '; 459 for (ap = pg.gl_pathv; *ap != NULL; ++ap) { 460 if (**ap == '\0') 461 continue; 462 len = strlen(*ap); 463 memcpy(p, *ap, len); 464 p += len; 465 *p++ = ' '; 466 } 467 *--p = '\0'; 468 469 /* Use system(3) in case someone's pager is "pager arg1 arg2". */ 470 (void)system(cmd); 471 472 exit(cleanup()); 473 } 474 475 static int 476 manual_find_buildkeyword(char *escpage, const char *fmt, 477 struct manstate *mp, glob_t *pg, size_t cnt) 478 { 479 ENTRY *suffix; 480 int found; 481 char *p, buf[MAXPATHLEN]; 482 483 found = 0; 484 /* Try the _build key words next. */ 485 TAILQ_FOREACH(suffix, &mp->buildlist->entrylist, q) { 486 for (p = suffix->s; 487 *p != '\0' && !isspace((unsigned char)*p); 488 ++p) 489 continue; 490 if (*p == '\0') 491 continue; 492 493 *p = '\0'; 494 (void)snprintf(buf, sizeof(buf), fmt, escpage, suffix->s); 495 if (!fnmatch(buf, pg->gl_pathv[cnt], 0)) { 496 if (!mp->where) 497 build_page(p + 1, &pg->gl_pathv[cnt], mp); 498 *p = ' '; 499 found = 1; 500 break; 501 } 502 *p = ' '; 503 } 504 505 return found; 506 } 507 508 /* 509 * manual -- 510 * Search the manuals for the pages. 511 */ 512 static int 513 manual(char *page, struct manstate *mp, glob_t *pg) 514 { 515 ENTRY *suffix, *mdir; 516 int anyfound, error, found; 517 size_t cnt; 518 char *p, buf[MAXPATHLEN], *escpage, *eptr; 519 static const char escglob[] = "\\~?*{}[]"; 520 521 anyfound = 0; 522 523 /* 524 * Fixup page which may contain glob(3) special characters, e.g. 525 * the famous "No man page for [" FAQ. 526 */ 527 if ((escpage = malloc((2 * strlen(page)) + 1)) == NULL) { 528 warn("malloc"); 529 (void)cleanup(); 530 exit(EXIT_FAILURE); 531 } 532 533 p = page; 534 eptr = escpage; 535 536 while (*p) { 537 if (strchr(escglob, *p) != NULL) { 538 *eptr++ = '\\'; 539 *eptr++ = *p++; 540 } else 541 *eptr++ = *p++; 542 } 543 544 *eptr = '\0'; 545 546 /* 547 * If 'page' is given with a full or relative path 548 * then interpret it as a file specification. 549 */ 550 if ((page[0] == '/') || (page[0] == '.')) { 551 /* check if file actually exists */ 552 (void)strlcpy(buf, escpage, sizeof(buf)); 553 error = glob(buf, GLOB_APPEND | GLOB_BRACE | GLOB_NOSORT, NULL, pg); 554 if (error != 0) { 555 if (error == GLOB_NOMATCH) { 556 goto notfound; 557 } else { 558 errx(EXIT_FAILURE, "glob failed"); 559 } 560 } 561 562 if (pg->gl_matchc == 0) 563 goto notfound; 564 565 /* clip suffix for the suffix check below */ 566 p = strrchr(escpage, '.'); 567 if (p && p[0] == '.' && isdigit((unsigned char)p[1])) 568 p[0] = '\0'; 569 570 found = 0; 571 for (cnt = pg->gl_pathc - pg->gl_matchc; 572 cnt < pg->gl_pathc; ++cnt) 573 { 574 found = manual_find_buildkeyword(escpage, "%s%s", 575 mp, pg, cnt); 576 if (found) { 577 anyfound = 1; 578 if (!mp->all) { 579 /* Delete any other matches. */ 580 while (++cnt< pg->gl_pathc) 581 pg->gl_pathv[cnt] = ""; 582 break; 583 } 584 continue; 585 } 586 587 /* It's not a man page, forget about it. */ 588 pg->gl_pathv[cnt] = ""; 589 } 590 591 notfound: 592 if (!anyfound) { 593 if (addentry(mp->missinglist, page, 0) < 0) { 594 warn("malloc"); 595 (void)cleanup(); 596 exit(EXIT_FAILURE); 597 } 598 } 599 free(escpage); 600 return anyfound; 601 } 602 603 /* For each man directory in mymanpath ... */ 604 TAILQ_FOREACH(mdir, &mp->mymanpath->entrylist, q) { 605 606 /* 607 * use glob(3) to look in the filesystem for matching files. 608 * match any suffix here, as we will check that later. 609 */ 610 (void)snprintf(buf, sizeof(buf), "%s/%s.*", mdir->s, escpage); 611 if ((error = glob(buf, 612 GLOB_APPEND | GLOB_BRACE | GLOB_NOSORT, NULL, pg)) != 0) { 613 if (error == GLOB_NOMATCH) 614 continue; 615 else { 616 warn("globbing"); 617 (void)cleanup(); 618 exit(EXIT_FAILURE); 619 } 620 } 621 if (pg->gl_matchc == 0) 622 continue; 623 624 /* 625 * start going through the matches glob(3) just found and 626 * use m.pathsearch (if present) to filter out pages we 627 * don't want. then verify the suffix is valid, and build 628 * the page if we have a _build suffix. 629 */ 630 for (cnt = pg->gl_pathc - pg->gl_matchc; 631 cnt < pg->gl_pathc; ++cnt) { 632 633 /* filter on directory path name */ 634 if (mp->pathsearch) { 635 p = strstr(pg->gl_pathv[cnt], mp->pathsearch); 636 if (!p || strchr(p, '/') == NULL) { 637 pg->gl_pathv[cnt] = ""; /* zap! */ 638 continue; 639 } 640 } 641 642 /* 643 * Try the _suffix key words first. 644 * 645 * XXX 646 * Older versions of man.conf didn't have the suffix 647 * key words, it was assumed that everything was a .0. 648 * We just test for .0 first, it's fast and probably 649 * going to hit. 650 */ 651 (void)snprintf(buf, sizeof(buf), "*/%s.0", escpage); 652 if (!fnmatch(buf, pg->gl_pathv[cnt], 0)) 653 goto next; 654 655 found = 0; 656 TAILQ_FOREACH(suffix, &mp->suffixlist->entrylist, q) { 657 (void)snprintf(buf, 658 sizeof(buf), "*/%s%s", escpage, 659 suffix->s); 660 if (!fnmatch(buf, pg->gl_pathv[cnt], 0)) { 661 found = 1; 662 break; 663 } 664 } 665 if (found) 666 goto next; 667 668 /* Try the _build key words next. */ 669 found = manual_find_buildkeyword(escpage, "*/%s%s", 670 mp, pg, cnt); 671 if (found) { 672 next: anyfound = 1; 673 if (!mp->all) { 674 /* Delete any other matches. */ 675 while (++cnt< pg->gl_pathc) 676 pg->gl_pathv[cnt] = ""; 677 break; 678 } 679 continue; 680 } 681 682 /* It's not a man page, forget about it. */ 683 pg->gl_pathv[cnt] = ""; 684 } 685 686 if (anyfound && !mp->all) 687 break; 688 } 689 690 /* If not found, enter onto the missing list. */ 691 if (!anyfound) { 692 if (addentry(mp->missinglist, page, 0) < 0) { 693 warn("malloc"); 694 (void)cleanup(); 695 exit(EXIT_FAILURE); 696 } 697 } 698 699 free(escpage); 700 return anyfound; 701 } 702 703 /* 704 * build_page -- 705 * Build a man page for display. 706 */ 707 static void 708 build_page(char *fmt, char **pathp, struct manstate *mp) 709 { 710 static int warned; 711 int olddir, fd, n, tmpdirlen; 712 char *p, *b; 713 char buf[MAXPATHLEN], cmd[MAXPATHLEN], tpath[MAXPATHLEN]; 714 const char *tmpdir; 715 716 /* Let the user know this may take awhile. */ 717 if (!warned) { 718 warned = 1; 719 warnx("Formatting manual page..."); 720 } 721 722 /* 723 * Historically man chdir'd to the root of the man tree. 724 * This was used in man pages that contained relative ".so" 725 * directives (including other man pages for command aliases etc.) 726 * It even went one step farther, by examining the first line 727 * of the man page and parsing the .so filename so it would 728 * make hard(?) links to the cat'ted man pages for space savings. 729 * (We don't do that here, but we could). 730 */ 731 732 /* copy and find the end */ 733 for (b = buf, p = *pathp; (*b++ = *p++) != '\0';) 734 continue; 735 736 /* 737 * skip the last two path components, page name and man[n] ... 738 * (e.g. buf will be "/usr/share/man" and p will be "man1/man.1") 739 * we also save a pointer to our current directory so that we 740 * can fchdir() back to it. this allows relative MANDIR paths 741 * to work with multiple man pages... e.g. consider: 742 * cd /usr/share && man -M ./man cat ls 743 * when no "cat1" subdir files are present. 744 */ 745 olddir = -1; 746 for (--b, --p, n = 2; b != buf; b--, p--) 747 if (*b == '/') 748 if (--n == 0) { 749 *b = '\0'; 750 olddir = open(".", O_RDONLY); 751 (void) chdir(buf); 752 p++; 753 break; 754 } 755 756 757 /* advance fmt pass the suffix spec to the printf format string */ 758 for (; *fmt && isspace((unsigned char)*fmt); ++fmt) 759 continue; 760 761 /* 762 * Get a temporary file and build a version of the file 763 * to display. Replace the old file name with the new one. 764 */ 765 if ((tmpdir = getenv("TMPDIR")) == NULL) 766 tmpdir = _PATH_TMP; 767 tmpdirlen = strlen(tmpdir); 768 (void)snprintf(tpath, sizeof (tpath), "%s%s%s", tmpdir, 769 (tmpdirlen && tmpdir[tmpdirlen-1] == '/') ? "" : "/", TMPFILE); 770 if ((fd = mkstemp(tpath)) == -1) { 771 warn("%s", tpath); 772 (void)cleanup(); 773 exit(EXIT_FAILURE); 774 } 775 (void)snprintf(buf, sizeof(buf), "%s > %s", fmt, tpath); 776 (void)snprintf(cmd, sizeof(cmd), buf, p); 777 (void)system(cmd); 778 (void)close(fd); 779 if ((*pathp = strdup(tpath)) == NULL) { 780 warn("malloc"); 781 (void)cleanup(); 782 exit(EXIT_FAILURE); 783 } 784 785 /* Link the built file into the remove-when-done list. */ 786 if (addentry(mp->intmp, *pathp, 0) < 0) { 787 warn("malloc"); 788 (void)cleanup(); 789 exit(EXIT_FAILURE); 790 } 791 792 /* restore old directory so relative manpaths still work */ 793 if (olddir != -1) { 794 fchdir(olddir); 795 close(olddir); 796 } 797 } 798 799 /* 800 * how -- 801 * display how information 802 */ 803 static void 804 how(char *fname) 805 { 806 FILE *fp; 807 808 int lcnt, print; 809 char *p, buf[256]; 810 811 if (!(fp = fopen(fname, "r"))) { 812 warn("%s", fname); 813 (void)cleanup(); 814 exit(EXIT_FAILURE); 815 } 816 #define S1 "SYNOPSIS" 817 #define S2 "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS" 818 #define D1 "DESCRIPTION" 819 #define D2 "D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN" 820 for (lcnt = print = 0; fgets(buf, sizeof(buf), fp);) { 821 if (!strncmp(buf, S1, sizeof(S1) - 1) || 822 !strncmp(buf, S2, sizeof(S2) - 1)) { 823 print = 1; 824 continue; 825 } else if (!strncmp(buf, D1, sizeof(D1) - 1) || 826 !strncmp(buf, D2, sizeof(D2) - 1)) { 827 if (fp) 828 (void)fclose(fp); 829 return; 830 } 831 if (!print) 832 continue; 833 if (*buf == '\n') 834 ++lcnt; 835 else { 836 for(; lcnt; --lcnt) 837 (void)putchar('\n'); 838 for (p = buf; isspace((unsigned char)*p); ++p) 839 continue; 840 (void)fputs(p, stdout); 841 } 842 } 843 (void)fclose(fp); 844 } 845 846 /* 847 * cat -- 848 * cat out the file 849 */ 850 static void 851 cat(char *fname) 852 { 853 int fd, n; 854 char buf[2048]; 855 856 if ((fd = open(fname, O_RDONLY, 0)) < 0) { 857 warn("%s", fname); 858 (void)cleanup(); 859 exit(EXIT_FAILURE); 860 } 861 while ((n = read(fd, buf, sizeof(buf))) > 0) 862 if (write(STDOUT_FILENO, buf, n) != n) { 863 warn("write"); 864 (void)cleanup(); 865 exit(EXIT_FAILURE); 866 } 867 if (n == -1) { 868 warn("read"); 869 (void)cleanup(); 870 exit(EXIT_FAILURE); 871 } 872 (void)close(fd); 873 } 874 875 /* 876 * check_pager -- 877 * check the user supplied page information 878 */ 879 static const char * 880 check_pager(const char *name) 881 { 882 const char *p; 883 884 /* 885 * if the user uses "more", we make it "more -s"; watch out for 886 * PAGER = "mypager /usr/ucb/more" 887 */ 888 for (p = name; *p && !isspace((unsigned char)*p); ++p) 889 continue; 890 for (; p > name && *p != '/'; --p); 891 if (p != name) 892 ++p; 893 894 /* make sure it's "more", not "morex" */ 895 if (!strncmp(p, "more", 4) && (!p[4] || isspace((unsigned char)p[4]))){ 896 char *newname; 897 (void)asprintf(&newname, "%s %s", p, "-s"); 898 name = newname; 899 } 900 901 return name; 902 } 903 904 /* 905 * jump -- 906 * strip out flag argument and jump 907 */ 908 static void 909 jump(char **argv, char *flag, char *name) 910 { 911 char **arg; 912 913 argv[0] = name; 914 for (arg = argv + 1; *arg; ++arg) 915 if (!strcmp(*arg, flag)) 916 break; 917 for (; *arg; ++arg) 918 arg[0] = arg[1]; 919 execvp(name, argv); 920 (void)fprintf(stderr, "%s: Command not found.\n", name); 921 exit(EXIT_FAILURE); 922 } 923 924 /* 925 * onsig -- 926 * If signaled, delete the temporary files. 927 */ 928 static void 929 onsig(int signo) 930 { 931 932 (void)cleanup(); 933 934 (void)raise_default_signal(signo); 935 936 /* NOTREACHED */ 937 exit(EXIT_FAILURE); 938 } 939 940 /* 941 * cleanup -- 942 * Clean up temporary files, show any error messages. 943 */ 944 static int 945 cleanup(void) 946 { 947 TAG *intmpp, *missp; 948 ENTRY *ep; 949 int rval; 950 951 rval = EXIT_SUCCESS; 952 /* 953 * note that _missing and _intmp were created by main(), so 954 * gettag() cannot return NULL here. 955 */ 956 missp = gettag("_missing", 0); /* missing man pages */ 957 intmpp = gettag("_intmp", 0); /* tmp files we need to unlink */ 958 959 TAILQ_FOREACH(ep, &missp->entrylist, q) { 960 warnx("no entry for %s in the manual.", ep->s); 961 rval = EXIT_FAILURE; 962 } 963 964 TAILQ_FOREACH(ep, &intmpp->entrylist, q) 965 (void)unlink(ep->s); 966 967 return rval; 968 } 969 970 /* 971 * usage -- 972 * print usage message and die 973 */ 974 static void 975 usage(void) 976 { 977 (void)fprintf(stderr, "usage: %s [-acw|-h] [-C cfg] [-M path] " 978 "[-m path] [-S srch] [[-s] sect] name ...\n", getprogname()); 979 (void)fprintf(stderr, 980 "usage: %s -k [-C cfg] [-M path] [-m path] keyword ...\n", 981 getprogname()); 982 exit(EXIT_FAILURE); 983 } 984