man.sh revision 222638
1#! /bin/sh 2# 3# Copyright (c) 2010 Gordon Tetlow 4# All rights reserved. 5# 6# Redistribution and use in source and binary forms, with or without 7# modification, are permitted provided that the following conditions 8# are met: 9# 1. Redistributions of source code must retain the above copyright 10# notice, this list of conditions and the following disclaimer. 11# 2. Redistributions in binary form must reproduce the above copyright 12# notice, this list of conditions and the following disclaimer in the 13# documentation and/or other materials provided with the distribution. 14# 15# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25# SUCH DAMAGE. 26# 27# $FreeBSD: head/usr.bin/man/man.sh 222638 2011-06-03 05:56:52Z ru $ 28 29# Usage: add_to_manpath path 30# Adds a variable to manpath while ensuring we don't have duplicates. 31# Returns true if we were able to add something. False otherwise. 32add_to_manpath() { 33 case "$manpath" in 34 *:$1) decho " Skipping duplicate manpath entry $1" 2 ;; 35 $1:*) decho " Skipping duplicate manpath entry $1" 2 ;; 36 *:$1:*) decho " Skipping duplicate manpath entry $1" 2 ;; 37 *) if [ -d "$1" ]; then 38 decho " Adding $1 to manpath" 39 manpath="$manpath:$1" 40 return 0 41 fi 42 ;; 43 esac 44 45 return 1 46} 47 48# Usage: build_manlocales 49# Builds a correct MANLOCALES variable. 50build_manlocales() { 51 # If the user has set manlocales, who are we to argue. 52 if [ -n "$MANLOCALES" ]; then 53 return 54 fi 55 56 parse_configs 57 58 # Trim leading colon 59 MANLOCALES=${manlocales#:} 60 61 decho "Available manual locales: $MANLOCALES" 62} 63 64# Usage: build_manpath 65# Builds a correct MANPATH variable. 66build_manpath() { 67 local IFS 68 69 # If the user has set a manpath, who are we to argue. 70 if [ -n "$MANPATH" ]; then 71 return 72 fi 73 74 search_path 75 76 decho "Adding default manpath entries" 77 IFS=: 78 for path in $man_default_path; do 79 add_to_manpath "$path" 80 done 81 unset IFS 82 83 parse_configs 84 85 # Trim leading colon 86 MANPATH=${manpath#:} 87 88 decho "Using manual path: $MANPATH" 89} 90 91# Usage: check_cat catglob 92# Checks to see if a cat glob is available. 93check_cat() { 94 if exists "$1"; then 95 use_cat=yes 96 catpage=$found 97 setup_cattool $catpage 98 decho " Found catpage $catpage" 99 return 0 100 else 101 return 1 102 fi 103} 104 105# Usage: check_man manglob catglob 106# Given 2 globs, figures out if the manglob is available, if so, check to 107# see if the catglob is also available and up to date. 108check_man() { 109 if exists "$1"; then 110 # We have a match, check for a cat page 111 manpage=$found 112 setup_cattool $manpage 113 decho " Found manpage $manpage" 114 115 if [ -n "${use_width}" ]; then 116 # non-standard width 117 unset use_cat 118 decho " Skipping catpage: non-standard page width" 119 elif exists "$2" && is_newer $found $manpage; then 120 # cat page found and is newer, use that 121 use_cat=yes 122 catpage=$found 123 setup_cattool $catpage 124 decho " Using catpage $catpage" 125 else 126 # no cat page or is older 127 unset use_cat 128 decho " Skipping catpage: not found or old" 129 fi 130 return 0 131 fi 132 133 return 1 134} 135 136# Usage: decho "string" [debuglevel] 137# Echoes to stderr string prefaced with -- if high enough debuglevel. 138decho() { 139 if [ $debug -ge ${2:-1} ]; then 140 echo "-- $1" >&2 141 fi 142} 143 144# Usage: exists glob 145# Returns true if glob resolves to a real file. 146exists() { 147 local IFS 148 149 # Don't accidentally inherit callers IFS (breaks perl manpages) 150 unset IFS 151 152 # Use some globbing tricks in the shell to determine if a file 153 # exists or not. 154 set +f 155 set -- "$1" $1 156 set -f 157 158 if [ "$1" != "$2" -a -r "$2" ]; then 159 found="$2" 160 return 0 161 fi 162 163 return 1 164} 165 166# Usage: find_file path section subdir pagename 167# Returns: true if something is matched and found. 168# Search the given path/section combo for a given page. 169find_file() { 170 local manroot catroot mann man0 catn cat0 171 172 manroot="$1/man$2" 173 catroot="$1/cat$2" 174 if [ -n "$3" ]; then 175 manroot="$manroot/$3" 176 catroot="$catroot/$3" 177 fi 178 179 if [ ! -d "$manroot" ]; then 180 return 1 181 fi 182 decho " Searching directory $manroot" 2 183 184 mann="$manroot/$4.$2*" 185 man0="$manroot/$4.0*" 186 catn="$catroot/$4.$2*" 187 cat0="$catroot/$4.0*" 188 189 # This is the behavior as seen by the original man utility. 190 # Let's not change that which doesn't seem broken. 191 if check_man "$mann" "$catn"; then 192 return 0 193 elif check_man "$man0" "$cat0"; then 194 return 0 195 elif check_cat "$catn"; then 196 return 0 197 elif check_cat "$cat0"; then 198 return 0 199 fi 200 201 return 1 202} 203 204# Usage: is_newer file1 file2 205# Returns true if file1 is newer than file2 as calculated by mtime. 206is_newer() { 207 if ! [ "$1" -ot "$2" ]; then 208 decho " mtime: $1 not older than $2" 3 209 return 0 210 else 211 decho " mtime: $1 older than $2" 3 212 return 1 213 fi 214} 215 216# Usage: manpath_parse_args "$@" 217# Parses commandline options for manpath. 218manpath_parse_args() { 219 local cmd_arg 220 221 while getopts 'Ldq' cmd_arg; do 222 case "${cmd_arg}" in 223 L) Lflag=Lflag ;; 224 d) debug=$(( $debug + 1 )) ;; 225 q) qflag=qflag ;; 226 *) manpath_usage ;; 227 esac 228 done >&2 229} 230 231# Usage: manpath_usage 232# Display usage for the manpath(1) utility. 233manpath_usage() { 234 echo 'usage: manpath [-Ldq]' >&2 235 exit 1 236} 237 238# Usage: manpath_warnings 239# Display some warnings to stderr. 240manpath_warnings() { 241 if [ -z "$Lflag" -a -n "$MANPATH" ]; then 242 echo "(Warning: MANPATH environment variable set)" >&2 243 fi 244 245 if [ -n "$Lflag" -a -n "$MANLOCALES" ]; then 246 echo "(Warning: MANLOCALES environment variable set)" >&2 247 fi 248} 249 250# Usage: man_check_for_so page path 251# Returns: True if able to resolve the file, false if it ended in tears. 252# Detects the presence of the .so directive and causes the file to be 253# redirected to another source file. 254man_check_for_so() { 255 local IFS line tstr 256 257 unset IFS 258 259 # We need to loop to accommodate multiple .so directives. 260 while true 261 do 262 line=$($cattool $manpage | head -1) 263 case "$line" in 264 .so*) trim "${line#.so}" 265 decho "$manpage includes $tstr" 266 # Glob and check for the file. 267 if ! check_man "$path/$tstr*" ""; then 268 decho " Unable to find $tstr" 269 return 1 270 fi 271 ;; 272 *) break ;; 273 esac 274 done 275 276 return 0 277} 278 279# Usage: man_display_page 280# Display either the manpage or catpage depending on the use_cat variable 281man_display_page() { 282 local EQN COL NROFF PIC TBL TROFF REFER VGRIND 283 local IFS l nroff_dev pipeline preproc_arg tool 284 285 # We are called with IFS set to colon. This causes really weird 286 # things to happen for the variables that have spaces in them. 287 unset IFS 288 289 # If we are supposed to use a catpage and we aren't using troff(1) 290 # just zcat the catpage and we are done. 291 if [ -z "$tflag" -a -n "$use_cat" ]; then 292 if [ -n "$wflag" ]; then 293 echo "$catpage (source: $manpage)" 294 ret=0 295 else 296 if [ $debug -gt 0 ]; then 297 decho "Command: $cattool $catpage | $PAGER" 298 ret=0 299 else 300 eval "$cattool $catpage | $PAGER" 301 ret=$? 302 fi 303 fi 304 return 305 fi 306 307 # Okay, we are using the manpage, do we just need to output the 308 # name of the manpage? 309 if [ -n "$wflag" ]; then 310 echo "$manpage" 311 ret=0 312 return 313 fi 314 315 # So, we really do need to parse the manpage. First, figure out the 316 # device flag (-T) we have to pass to eqn(1) and groff(1). Then, 317 # setup the pipeline of commands based on the user's request. 318 319 # If the manpage is from a particular charset, we need to setup nroff 320 # to properly output for the correct device. 321 case "${manpage}" in 322 *.${man_charset}/*) 323 # I don't pretend to know this; I'm just copying from the 324 # previous version of man(1). 325 case "$man_charset" in 326 KOI8-R) nroff_dev="koi8-r" ;; 327 ISO8859-1) nroff_dev="latin1" ;; 328 ISO8859-15) nroff_dev="latin1" ;; 329 UTF-8) nroff_dev="utf8" ;; 330 *) nroff_dev="ascii" ;; 331 esac 332 333 NROFF="$NROFF -T$nroff_dev" 334 EQN="$EQN -T$nroff_dev" 335 336 # Iff the manpage is from the locale and not just the charset, 337 # then we need to define the locale string. 338 case "${manpage}" in 339 */${man_lang}_${man_country}.${man_charset}/*) 340 NROFF="$NROFF -dlocale=$man_lang.$man_charset" 341 ;; 342 */${man_lang}.${man_charset}/*) 343 NROFF="$NROFF -dlocale=$man_lang.$man_charset" 344 ;; 345 esac 346 347 # Allow language specific calls to override the default 348 # set of utilities. 349 l=$(echo $man_lang | tr [:lower:] [:upper:]) 350 for tool in EQN COL NROFF PIC TBL TROFF REFER VGRIND; do 351 eval "$tool=\${${tool}_$l:-\$$tool}" 352 done 353 ;; 354 *) NROFF="$NROFF -Tascii" 355 EQN="$EQN -Tascii" 356 ;; 357 esac 358 359 if [ -n "${use_width}" ]; then 360 NROFF="$NROFF -rLL=${use_width}n -rLT=${use_width}n" 361 fi 362 363 if [ -n "$MANROFFSEQ" ]; then 364 set -- -$MANROFFSEQ 365 while getopts 'egprtv' preproc_arg; do 366 case "${preproc_arg}" in 367 e) pipeline="$pipeline | $EQN" ;; 368 g) ;; # Ignore for compatability. 369 p) pipeline="$pipeline | $PIC" ;; 370 r) pipeline="$pipeline | $REFER" ;; 371 t) pipeline="$pipeline | $TBL"; use_col=yes ;; 372 v) pipeline="$pipeline | $VGRIND" ;; 373 *) usage ;; 374 esac 375 done 376 # Strip the leading " | " from the resulting pipeline. 377 pipeline="${pipeline#" | "}" 378 else 379 pipeline="$TBL" 380 use_col=yes 381 fi 382 383 if [ -n "$tflag" ]; then 384 pipeline="$pipeline | $TROFF" 385 else 386 pipeline="$pipeline | $NROFF" 387 388 if [ -n "$use_col" ]; then 389 pipeline="$pipeline | $COL" 390 fi 391 392 pipeline="$pipeline | $PAGER" 393 fi 394 395 if [ $debug -gt 0 ]; then 396 decho "Command: $cattool $manpage | $pipeline" 397 ret=0 398 else 399 eval "$cattool $manpage | $pipeline" 400 ret=$? 401 fi 402} 403 404# Usage: man_find_and_display page 405# Search through the manpaths looking for the given page. 406man_find_and_display() { 407 local found_page locpath p path sect 408 409 # Check to see if it's a file. But only if it has a '/' in 410 # the filename. 411 case "$1" in 412 */*) if [ -f "$1" -a -r "$1" ]; then 413 decho "Found a usable page, displaying that" 414 unset use_cat 415 manpage="$1" 416 setup_cattool $manpage 417 if man_check_for_so $manpage $(dirname $manpage); then 418 found_page=yes 419 man_display_page 420 fi 421 return 422 fi 423 ;; 424 esac 425 426 IFS=: 427 for sect in $MANSECT; do 428 decho "Searching section $sect" 2 429 for path in $MANPATH; do 430 for locpath in $locpaths; do 431 p=$path/$locpath 432 p=${p%/.} # Rid ourselves of the trailing /. 433 434 # Check if there is a MACHINE specific manpath. 435 if find_file $p $sect $MACHINE "$1"; then 436 if man_check_for_so $manpage $p; then 437 found_page=yes 438 man_display_page 439 if [ -n "$aflag" ]; then 440 continue 2 441 else 442 return 443 fi 444 fi 445 fi 446 447 # Check if there is a MACHINE_ARCH 448 # specific manpath. 449 if find_file $p $sect $MACHINE_ARCH "$1"; then 450 if man_check_for_so $manpage $p; then 451 found_page=yes 452 man_display_page 453 if [ -n "$aflag" ]; then 454 continue 2 455 else 456 return 457 fi 458 fi 459 fi 460 461 # Check plain old manpath. 462 if find_file $p $sect '' "$1"; then 463 if man_check_for_so $manpage $p; then 464 found_page=yes 465 man_display_page 466 if [ -n "$aflag" ]; then 467 continue 2 468 else 469 return 470 fi 471 fi 472 fi 473 done 474 done 475 done 476 unset IFS 477 478 # Nothing? Well, we are done then. 479 if [ -z "$found_page" ]; then 480 echo "No manual entry for $1" >&2 481 ret=1 482 return 483 fi 484} 485 486# Usage: man_parse_args "$@" 487# Parses commandline options for man. 488man_parse_args() { 489 local IFS cmd_arg 490 491 while getopts 'M:P:S:adfhkm:op:tw' cmd_arg; do 492 case "${cmd_arg}" in 493 M) MANPATH=$OPTARG ;; 494 P) PAGER=$OPTARG ;; 495 S) MANSECT=$OPTARG ;; 496 a) aflag=aflag ;; 497 d) debug=$(( $debug + 1 )) ;; 498 f) fflag=fflag ;; 499 h) man_usage 0 ;; 500 k) kflag=kflag ;; 501 m) mflag=$OPTARG ;; 502 o) oflag=oflag ;; 503 p) MANROFFSEQ=$OPTARG ;; 504 t) tflag=tflag ;; 505 w) wflag=wflag ;; 506 *) man_usage ;; 507 esac 508 done >&2 509 510 shift $(( $OPTIND - 1 )) 511 512 # Check the args for incompatible options. 513 case "${fflag}${kflag}${tflag}${wflag}" in 514 fflagkflag*) echo "Incompatible options: -f and -k"; man_usage ;; 515 fflag*tflag*) echo "Incompatible options: -f and -t"; man_usage ;; 516 fflag*wflag) echo "Incompatible options: -f and -w"; man_usage ;; 517 *kflagtflag*) echo "Incompatible options: -k and -t"; man_usage ;; 518 *kflag*wflag) echo "Incompatible options: -k and -w"; man_usage ;; 519 *tflagwflag) echo "Incompatible options: -t and -w"; man_usage ;; 520 esac 521 522 # Short circuit for whatis(1) and apropos(1) 523 if [ -n "$fflag" ]; then 524 do_whatis "$@" 525 exit 526 fi 527 528 if [ -n "$kflag" ]; then 529 do_apropos "$@" 530 exit 531 fi 532 533 IFS=: 534 for sect in $man_default_sections; do 535 if [ "$sect" = "$1" ]; then 536 decho "Detected manual section as first arg: $1" 537 MANSECT="$1" 538 shift 539 break 540 fi 541 done 542 unset IFS 543 544 pages="$*" 545} 546 547# Usage: man_setup 548# Setup various trivial but essential variables. 549man_setup() { 550 # Setup machine and architecture variables. 551 if [ -n "$mflag" ]; then 552 MACHINE_ARCH=${mflag%%:*} 553 MACHINE=${mflag##*:} 554 fi 555 if [ -z "$MACHINE_ARCH" ]; then 556 MACHINE_ARCH=$($SYSCTL -n hw.machine_arch) 557 fi 558 if [ -z "$MACHINE" ]; then 559 MACHINE=$($SYSCTL -n hw.machine) 560 fi 561 decho "Using architecture: $MACHINE_ARCH:$MACHINE" 562 563 setup_pager 564 565 # Setup manual sections to search. 566 if [ -z "$MANSECT" ]; then 567 MANSECT=$man_default_sections 568 fi 569 decho "Using manual sections: $MANSECT" 570 571 build_manpath 572 man_setup_locale 573 man_setup_width 574} 575 576# Usage: man_setup_width 577# Set up page width. 578man_setup_width() { 579 local sizes 580 581 unset use_width 582 case "$MANWIDTH" in 583 [0-9]*) 584 if [ "$MANWIDTH" -gt 0 2>/dev/null ]; then 585 use_width=$MANWIDTH 586 fi 587 ;; 588 [Tt][Tt][Yy]) 589 if { sizes=$($STTY size 0>&3 2>/dev/null); } 3>&1; then 590 set -- $sizes 591 if [ $2 -gt 80 ]; then 592 use_width=$(($2-2)) 593 fi 594 fi 595 ;; 596 esac 597 if [ -n "$use_width" ]; then 598 decho "Using non-standard page width: ${use_width}" 599 else 600 decho 'Using standard page width' 601 fi 602} 603 604# Usage: man_setup_locale 605# Setup necessary locale variables. 606man_setup_locale() { 607 local lang_cc 608 609 locpaths='.' 610 man_charset='US-ASCII' 611 612 # Setup locale information. 613 if [ -n "$oflag" ]; then 614 decho 'Using non-localized manpages' 615 else 616 # Use the locale tool to give us the proper LC_CTYPE 617 eval $( $LOCALE ) 618 619 case "$LC_CTYPE" in 620 C) ;; 621 POSIX) ;; 622 [a-z][a-z]_[A-Z][A-Z]\.*) 623 lang_cc="${LC_CTYPE%.*}" 624 man_lang="${LC_CTYPE%_*}" 625 man_country="${lang_cc#*_}" 626 man_charset="${LC_CTYPE#*.}" 627 locpaths="$LC_CTYPE" 628 locpaths="$locpaths:$man_lang.$man_charset" 629 if [ "$man_lang" != "en" ]; then 630 locpaths="$locpaths:en.$man_charset" 631 fi 632 locpaths="$locpaths:." 633 ;; 634 *) echo 'Unknown locale, assuming C' >&2 635 ;; 636 esac 637 fi 638 639 decho "Using locale paths: $locpaths" 640} 641 642# Usage: man_usage [exitcode] 643# Display usage for the man utility. 644man_usage() { 645 echo 'Usage:' 646 echo ' man [-adho] [-t | -w] [-M manpath] [-P pager] [-S mansect]' 647 echo ' [-m arch[:machine]] [-p [eprtv]] [mansect] page [...]' 648 echo ' man -f page [...] -- Emulates whatis(1)' 649 echo ' man -k page [...] -- Emulates apropos(1)' 650 651 # When exit'ing with -h, it's not an error. 652 exit ${1:-1} 653} 654 655# Usage: parse_configs 656# Reads the end-user adjustable config files. 657parse_configs() { 658 local IFS file files 659 660 if [ -n "$parsed_configs" ]; then 661 return 662 fi 663 664 unset IFS 665 666 # Read the global config first in case the user wants 667 # to override config_local. 668 if [ -r "$config_global" ]; then 669 parse_file "$config_global" 670 fi 671 672 # Glob the list of files to parse. 673 set +f 674 files=$(echo $config_local) 675 set -f 676 677 for file in $files; do 678 if [ -r "$file" ]; then 679 parse_file "$file" 680 fi 681 done 682 683 parsed_configs='yes' 684} 685 686# Usage: parse_file file 687# Reads the specified config files. 688parse_file() { 689 local file line tstr var 690 691 file="$1" 692 decho "Parsing config file: $file" 693 while read line; do 694 decho " $line" 2 695 case "$line" in 696 \#*) decho " Comment" 3 697 ;; 698 MANPATH*) decho " MANPATH" 3 699 trim "${line#MANPATH}" 700 add_to_manpath "$tstr" 701 ;; 702 MANLOCALE*) decho " MANLOCALE" 3 703 trim "${line#MANLOCALE}" 704 manlocales="$manlocales:$tstr" 705 ;; 706 MANCONFIG*) decho " MANCONFIG" 3 707 trim "${line#MANCONFIG}" 708 config_local="$tstr" 709 ;; 710 # Set variables in the form of FOO_BAR 711 *_*[\ \ ]*) var="${line%%[\ \ ]*}" 712 trim "${line#$var}" 713 eval "$var=\"$tstr\"" 714 decho " Parsed $var" 3 715 ;; 716 esac 717 done < "$file" 718} 719 720# Usage: search_path 721# Traverse $PATH looking for manpaths. 722search_path() { 723 local IFS p path 724 725 decho "Searching PATH for man directories" 726 727 IFS=: 728 for path in $PATH; do 729 # Do a little special casing since the base manpages 730 # are in /usr/share/man instead of /usr/man or /man. 731 case "$path" in 732 /bin|/usr/bin) add_to_manpath "/usr/share/man" ;; 733 *) if add_to_manpath "$path/man"; then 734 : 735 elif add_to_manpath "$path/MAN"; then 736 : 737 else 738 case "$path" in 739 */bin) p="${path%/bin}/man" 740 add_to_manpath "$p" 741 ;; 742 *) ;; 743 esac 744 fi 745 ;; 746 esac 747 done 748 unset IFS 749 750 if [ -z "$manpath" ]; then 751 decho ' Unable to find any manpaths, using default' 752 manpath=$man_default_path 753 fi 754} 755 756# Usage: search_whatis cmd [arglist] 757# Do the heavy lifting for apropos/whatis 758search_whatis() { 759 local IFS bad cmd f good key keywords loc opt out path rval wlist 760 761 cmd="$1" 762 shift 763 764 whatis_parse_args "$@" 765 766 build_manpath 767 build_manlocales 768 setup_pager 769 770 if [ "$cmd" = "whatis" ]; then 771 opt="-w" 772 fi 773 774 f='whatis' 775 776 IFS=: 777 for path in $MANPATH; do 778 if [ \! -d "$path" ]; then 779 decho "Skipping non-existent path: $path" 2 780 continue 781 fi 782 783 if [ -f "$path/$f" -a -r "$path/$f" ]; then 784 decho "Found whatis: $path/$f" 785 wlist="$wlist $path/$f" 786 fi 787 788 for loc in $MANLOCALES; do 789 if [ -f "$path/$loc/$f" -a -r "$path/$loc/$f" ]; then 790 decho "Found whatis: $path/$loc/$f" 791 wlist="$wlist $path/$loc/$f" 792 fi 793 done 794 done 795 unset IFS 796 797 if [ -z "$wlist" ]; then 798 echo "$cmd: no whatis databases in $MANPATH" >&2 799 exit 1 800 fi 801 802 rval=0 803 for key in $keywords; do 804 out=$(grep -Ehi $opt -- "$key" $wlist) 805 if [ -n "$out" ]; then 806 good="$good\\n$out" 807 else 808 bad="$bad\\n$key: nothing appropriate" 809 rval=1 810 fi 811 done 812 813 # Strip leading carriage return. 814 good=${good#\\n} 815 bad=${bad#\\n} 816 817 if [ -n "$good" ]; then 818 echo -e "$good" | $PAGER 819 fi 820 821 if [ -n "$bad" ]; then 822 echo -e "$bad" >&2 823 fi 824 825 exit $rval 826} 827 828# Usage: setup_cattool page 829# Finds an appropriate decompressor based on extension 830setup_cattool() { 831 case "$1" in 832 *.bz) cattool='/usr/bin/bzcat' ;; 833 *.bz2) cattool='/usr/bin/bzcat' ;; 834 *.gz) cattool='/usr/bin/zcat' ;; 835 *.lzma) cattool='/usr/bin/lzcat' ;; 836 *.xz) cattool='/usr/bin/xzcat' ;; 837 *) cattool='/usr/bin/zcat -f' ;; 838 esac 839} 840 841# Usage: setup_pager 842# Correctly sets $PAGER 843setup_pager() { 844 # Setup pager. 845 if [ -z "$PAGER" ]; then 846 PAGER="more -s" 847 fi 848 decho "Using pager: $PAGER" 849} 850 851# Usage: trim string 852# Trims whitespace from beginning and end of a variable 853trim() { 854 tstr=$1 855 while true; do 856 case "$tstr" in 857 [\ \ ]*) tstr="${tstr##[\ \ ]}" ;; 858 *[\ \ ]) tstr="${tstr%%[\ \ ]}" ;; 859 *) break ;; 860 esac 861 done 862} 863 864# Usage: whatis_parse_args "$@" 865# Parse commandline args for whatis and apropos. 866whatis_parse_args() { 867 local cmd_arg 868 while getopts 'd' cmd_arg; do 869 case "${cmd_arg}" in 870 d) debug=$(( $debug + 1 )) ;; 871 *) whatis_usage ;; 872 esac 873 done >&2 874 875 shift $(( $OPTIND - 1 )) 876 877 keywords="$*" 878} 879 880# Usage: whatis_usage 881# Display usage for the whatis/apropos utility. 882whatis_usage() { 883 echo "usage: $cmd [-d] keyword [...]" 884 exit 1 885} 886 887 888 889# Supported commands 890do_apropos() { 891 search_whatis apropos "$@" 892} 893 894do_man() { 895 man_parse_args "$@" 896 if [ -z "$pages" ]; then 897 echo 'What manual page do you want?' >&2 898 exit 1 899 fi 900 man_setup 901 902 for page in $pages; do 903 decho "Searching for $page" 904 man_find_and_display "$page" 905 done 906 907 exit ${ret:-0} 908} 909 910do_manpath() { 911 manpath_parse_args "$@" 912 if [ -z "$qflag" ]; then 913 manpath_warnings 914 fi 915 if [ -n "$Lflag" ]; then 916 build_manlocales 917 echo $MANLOCALES 918 else 919 build_manpath 920 echo $MANPATH 921 fi 922 exit 0 923} 924 925do_whatis() { 926 search_whatis whatis "$@" 927} 928 929# User's PATH setting decides on the groff-suite to pick up. 930EQN=eqn 931NROFF='groff -S -P-c -Wall -mtty-char -man' 932PIC=pic 933REFER=refer 934TBL=tbl 935TROFF='groff -S -man' 936VGRIND=vgrind 937 938COL=/usr/bin/col 939LOCALE=/usr/bin/locale 940STTY=/bin/stty 941SYSCTL=/sbin/sysctl 942 943debug=0 944man_default_sections='1:1aout:8:2:3:n:4:5:6:7:9:l' 945man_default_path='/usr/share/man:/usr/share/openssl/man:/usr/local/man' 946cattool='/usr/bin/zcat -f' 947 948config_global='/etc/man.conf' 949 950# This can be overridden via a setting in /etc/man.conf. 951config_local='/usr/local/etc/man.d/*.conf' 952 953# Set noglobbing for now. I don't want spurious globbing. 954set -f 955 956case "$0" in 957*apropos) do_apropos "$@" ;; 958*manpath) do_manpath "$@" ;; 959*whatis) do_whatis "$@" ;; 960*) do_man "$@" ;; 961esac 962