man.sh revision 222650
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 222650 2011-06-03 13:45:11Z 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 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 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" ;; 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 fi 381 382 if [ -n "$tflag" ]; then 383 pipeline="$pipeline | $TROFF" 384 else 385 pipeline="$pipeline | $NROFF | $PAGER" 386 fi 387 388 if [ $debug -gt 0 ]; then 389 decho "Command: $cattool $manpage | $pipeline" 390 ret=0 391 else 392 eval "$cattool $manpage | $pipeline" 393 ret=$? 394 fi 395} 396 397# Usage: man_find_and_display page 398# Search through the manpaths looking for the given page. 399man_find_and_display() { 400 local found_page locpath p path sect 401 402 # Check to see if it's a file. But only if it has a '/' in 403 # the filename. 404 case "$1" in 405 */*) if [ -f "$1" -a -r "$1" ]; then 406 decho "Found a usable page, displaying that" 407 unset use_cat 408 manpage="$1" 409 setup_cattool $manpage 410 if man_check_for_so $manpage $(dirname $manpage); then 411 found_page=yes 412 man_display_page 413 fi 414 return 415 fi 416 ;; 417 esac 418 419 IFS=: 420 for sect in $MANSECT; do 421 decho "Searching section $sect" 2 422 for path in $MANPATH; do 423 for locpath in $locpaths; do 424 p=$path/$locpath 425 p=${p%/.} # Rid ourselves of the trailing /. 426 427 # Check if there is a MACHINE specific manpath. 428 if find_file $p $sect $MACHINE "$1"; then 429 if man_check_for_so $manpage $p; then 430 found_page=yes 431 man_display_page 432 if [ -n "$aflag" ]; then 433 continue 2 434 else 435 return 436 fi 437 fi 438 fi 439 440 # Check if there is a MACHINE_ARCH 441 # specific manpath. 442 if find_file $p $sect $MACHINE_ARCH "$1"; then 443 if man_check_for_so $manpage $p; then 444 found_page=yes 445 man_display_page 446 if [ -n "$aflag" ]; then 447 continue 2 448 else 449 return 450 fi 451 fi 452 fi 453 454 # Check plain old manpath. 455 if find_file $p $sect '' "$1"; then 456 if man_check_for_so $manpage $p; then 457 found_page=yes 458 man_display_page 459 if [ -n "$aflag" ]; then 460 continue 2 461 else 462 return 463 fi 464 fi 465 fi 466 done 467 done 468 done 469 unset IFS 470 471 # Nothing? Well, we are done then. 472 if [ -z "$found_page" ]; then 473 echo "No manual entry for $1" >&2 474 ret=1 475 return 476 fi 477} 478 479# Usage: man_parse_args "$@" 480# Parses commandline options for man. 481man_parse_args() { 482 local IFS cmd_arg 483 484 while getopts 'M:P:S:adfhkm:op:tw' cmd_arg; do 485 case "${cmd_arg}" in 486 M) MANPATH=$OPTARG ;; 487 P) PAGER=$OPTARG ;; 488 S) MANSECT=$OPTARG ;; 489 a) aflag=aflag ;; 490 d) debug=$(( $debug + 1 )) ;; 491 f) fflag=fflag ;; 492 h) man_usage 0 ;; 493 k) kflag=kflag ;; 494 m) mflag=$OPTARG ;; 495 o) oflag=oflag ;; 496 p) MANROFFSEQ=$OPTARG ;; 497 t) tflag=tflag ;; 498 w) wflag=wflag ;; 499 *) man_usage ;; 500 esac 501 done >&2 502 503 shift $(( $OPTIND - 1 )) 504 505 # Check the args for incompatible options. 506 case "${fflag}${kflag}${tflag}${wflag}" in 507 fflagkflag*) echo "Incompatible options: -f and -k"; man_usage ;; 508 fflag*tflag*) echo "Incompatible options: -f and -t"; man_usage ;; 509 fflag*wflag) echo "Incompatible options: -f and -w"; man_usage ;; 510 *kflagtflag*) echo "Incompatible options: -k and -t"; man_usage ;; 511 *kflag*wflag) echo "Incompatible options: -k and -w"; man_usage ;; 512 *tflagwflag) echo "Incompatible options: -t and -w"; man_usage ;; 513 esac 514 515 # Short circuit for whatis(1) and apropos(1) 516 if [ -n "$fflag" ]; then 517 do_whatis "$@" 518 exit 519 fi 520 521 if [ -n "$kflag" ]; then 522 do_apropos "$@" 523 exit 524 fi 525 526 IFS=: 527 for sect in $man_default_sections; do 528 if [ "$sect" = "$1" ]; then 529 decho "Detected manual section as first arg: $1" 530 MANSECT="$1" 531 shift 532 break 533 fi 534 done 535 unset IFS 536 537 pages="$*" 538} 539 540# Usage: man_setup 541# Setup various trivial but essential variables. 542man_setup() { 543 # Setup machine and architecture variables. 544 if [ -n "$mflag" ]; then 545 MACHINE_ARCH=${mflag%%:*} 546 MACHINE=${mflag##*:} 547 fi 548 if [ -z "$MACHINE_ARCH" ]; then 549 MACHINE_ARCH=$($SYSCTL -n hw.machine_arch) 550 fi 551 if [ -z "$MACHINE" ]; then 552 MACHINE=$($SYSCTL -n hw.machine) 553 fi 554 decho "Using architecture: $MACHINE_ARCH:$MACHINE" 555 556 setup_pager 557 558 # Setup manual sections to search. 559 if [ -z "$MANSECT" ]; then 560 MANSECT=$man_default_sections 561 fi 562 decho "Using manual sections: $MANSECT" 563 564 build_manpath 565 man_setup_locale 566 man_setup_width 567} 568 569# Usage: man_setup_width 570# Set up page width. 571man_setup_width() { 572 local sizes 573 574 unset use_width 575 case "$MANWIDTH" in 576 [0-9]*) 577 if [ "$MANWIDTH" -gt 0 2>/dev/null ]; then 578 use_width=$MANWIDTH 579 fi 580 ;; 581 [Tt][Tt][Yy]) 582 if { sizes=$($STTY size 0>&3 2>/dev/null); } 3>&1; then 583 set -- $sizes 584 if [ $2 -gt 80 ]; then 585 use_width=$(($2-2)) 586 fi 587 fi 588 ;; 589 esac 590 if [ -n "$use_width" ]; then 591 decho "Using non-standard page width: ${use_width}" 592 else 593 decho 'Using standard page width' 594 fi 595} 596 597# Usage: man_setup_locale 598# Setup necessary locale variables. 599man_setup_locale() { 600 local lang_cc 601 602 locpaths='.' 603 man_charset='US-ASCII' 604 605 # Setup locale information. 606 if [ -n "$oflag" ]; then 607 decho 'Using non-localized manpages' 608 else 609 # Use the locale tool to give us the proper LC_CTYPE 610 eval $( $LOCALE ) 611 612 case "$LC_CTYPE" in 613 C) ;; 614 POSIX) ;; 615 [a-z][a-z]_[A-Z][A-Z]\.*) 616 lang_cc="${LC_CTYPE%.*}" 617 man_lang="${LC_CTYPE%_*}" 618 man_country="${lang_cc#*_}" 619 man_charset="${LC_CTYPE#*.}" 620 locpaths="$LC_CTYPE" 621 locpaths="$locpaths:$man_lang.$man_charset" 622 if [ "$man_lang" != "en" ]; then 623 locpaths="$locpaths:en.$man_charset" 624 fi 625 locpaths="$locpaths:." 626 ;; 627 *) echo 'Unknown locale, assuming C' >&2 628 ;; 629 esac 630 fi 631 632 decho "Using locale paths: $locpaths" 633} 634 635# Usage: man_usage [exitcode] 636# Display usage for the man utility. 637man_usage() { 638 echo 'Usage:' 639 echo ' man [-adho] [-t | -w] [-M manpath] [-P pager] [-S mansect]' 640 echo ' [-m arch[:machine]] [-p [eprtv]] [mansect] page [...]' 641 echo ' man -f page [...] -- Emulates whatis(1)' 642 echo ' man -k page [...] -- Emulates apropos(1)' 643 644 # When exit'ing with -h, it's not an error. 645 exit ${1:-1} 646} 647 648# Usage: parse_configs 649# Reads the end-user adjustable config files. 650parse_configs() { 651 local IFS file files 652 653 if [ -n "$parsed_configs" ]; then 654 return 655 fi 656 657 unset IFS 658 659 # Read the global config first in case the user wants 660 # to override config_local. 661 if [ -r "$config_global" ]; then 662 parse_file "$config_global" 663 fi 664 665 # Glob the list of files to parse. 666 set +f 667 files=$(echo $config_local) 668 set -f 669 670 for file in $files; do 671 if [ -r "$file" ]; then 672 parse_file "$file" 673 fi 674 done 675 676 parsed_configs='yes' 677} 678 679# Usage: parse_file file 680# Reads the specified config files. 681parse_file() { 682 local file line tstr var 683 684 file="$1" 685 decho "Parsing config file: $file" 686 while read line; do 687 decho " $line" 2 688 case "$line" in 689 \#*) decho " Comment" 3 690 ;; 691 MANPATH*) decho " MANPATH" 3 692 trim "${line#MANPATH}" 693 add_to_manpath "$tstr" 694 ;; 695 MANLOCALE*) decho " MANLOCALE" 3 696 trim "${line#MANLOCALE}" 697 manlocales="$manlocales:$tstr" 698 ;; 699 MANCONFIG*) decho " MANCONFIG" 3 700 trim "${line#MANCONFIG}" 701 config_local="$tstr" 702 ;; 703 # Set variables in the form of FOO_BAR 704 *_*[\ \ ]*) var="${line%%[\ \ ]*}" 705 trim "${line#$var}" 706 eval "$var=\"$tstr\"" 707 decho " Parsed $var" 3 708 ;; 709 esac 710 done < "$file" 711} 712 713# Usage: search_path 714# Traverse $PATH looking for manpaths. 715search_path() { 716 local IFS p path 717 718 decho "Searching PATH for man directories" 719 720 IFS=: 721 for path in $PATH; do 722 # Do a little special casing since the base manpages 723 # are in /usr/share/man instead of /usr/man or /man. 724 case "$path" in 725 /bin|/usr/bin) add_to_manpath "/usr/share/man" ;; 726 *) if add_to_manpath "$path/man"; then 727 : 728 elif add_to_manpath "$path/MAN"; then 729 : 730 else 731 case "$path" in 732 */bin) p="${path%/bin}/man" 733 add_to_manpath "$p" 734 ;; 735 *) ;; 736 esac 737 fi 738 ;; 739 esac 740 done 741 unset IFS 742 743 if [ -z "$manpath" ]; then 744 decho ' Unable to find any manpaths, using default' 745 manpath=$man_default_path 746 fi 747} 748 749# Usage: search_whatis cmd [arglist] 750# Do the heavy lifting for apropos/whatis 751search_whatis() { 752 local IFS bad cmd f good key keywords loc opt out path rval wlist 753 754 cmd="$1" 755 shift 756 757 whatis_parse_args "$@" 758 759 build_manpath 760 build_manlocales 761 setup_pager 762 763 if [ "$cmd" = "whatis" ]; then 764 opt="-w" 765 fi 766 767 f='whatis' 768 769 IFS=: 770 for path in $MANPATH; do 771 if [ \! -d "$path" ]; then 772 decho "Skipping non-existent path: $path" 2 773 continue 774 fi 775 776 if [ -f "$path/$f" -a -r "$path/$f" ]; then 777 decho "Found whatis: $path/$f" 778 wlist="$wlist $path/$f" 779 fi 780 781 for loc in $MANLOCALES; do 782 if [ -f "$path/$loc/$f" -a -r "$path/$loc/$f" ]; then 783 decho "Found whatis: $path/$loc/$f" 784 wlist="$wlist $path/$loc/$f" 785 fi 786 done 787 done 788 unset IFS 789 790 if [ -z "$wlist" ]; then 791 echo "$cmd: no whatis databases in $MANPATH" >&2 792 exit 1 793 fi 794 795 rval=0 796 for key in $keywords; do 797 out=$(grep -Ehi $opt -- "$key" $wlist) 798 if [ -n "$out" ]; then 799 good="$good\\n$out" 800 else 801 bad="$bad\\n$key: nothing appropriate" 802 rval=1 803 fi 804 done 805 806 # Strip leading carriage return. 807 good=${good#\\n} 808 bad=${bad#\\n} 809 810 if [ -n "$good" ]; then 811 echo -e "$good" | $PAGER 812 fi 813 814 if [ -n "$bad" ]; then 815 echo -e "$bad" >&2 816 fi 817 818 exit $rval 819} 820 821# Usage: setup_cattool page 822# Finds an appropriate decompressor based on extension 823setup_cattool() { 824 case "$1" in 825 *.bz) cattool='/usr/bin/bzcat' ;; 826 *.bz2) cattool='/usr/bin/bzcat' ;; 827 *.gz) cattool='/usr/bin/zcat' ;; 828 *.lzma) cattool='/usr/bin/lzcat' ;; 829 *.xz) cattool='/usr/bin/xzcat' ;; 830 *) cattool='/usr/bin/zcat -f' ;; 831 esac 832} 833 834# Usage: setup_pager 835# Correctly sets $PAGER 836setup_pager() { 837 # Setup pager. 838 if [ -z "$PAGER" ]; then 839 PAGER="more -s" 840 fi 841 decho "Using pager: $PAGER" 842} 843 844# Usage: trim string 845# Trims whitespace from beginning and end of a variable 846trim() { 847 tstr=$1 848 while true; do 849 case "$tstr" in 850 [\ \ ]*) tstr="${tstr##[\ \ ]}" ;; 851 *[\ \ ]) tstr="${tstr%%[\ \ ]}" ;; 852 *) break ;; 853 esac 854 done 855} 856 857# Usage: whatis_parse_args "$@" 858# Parse commandline args for whatis and apropos. 859whatis_parse_args() { 860 local cmd_arg 861 while getopts 'd' cmd_arg; do 862 case "${cmd_arg}" in 863 d) debug=$(( $debug + 1 )) ;; 864 *) whatis_usage ;; 865 esac 866 done >&2 867 868 shift $(( $OPTIND - 1 )) 869 870 keywords="$*" 871} 872 873# Usage: whatis_usage 874# Display usage for the whatis/apropos utility. 875whatis_usage() { 876 echo "usage: $cmd [-d] keyword [...]" 877 exit 1 878} 879 880 881 882# Supported commands 883do_apropos() { 884 search_whatis apropos "$@" 885} 886 887do_man() { 888 man_parse_args "$@" 889 if [ -z "$pages" ]; then 890 echo 'What manual page do you want?' >&2 891 exit 1 892 fi 893 man_setup 894 895 for page in $pages; do 896 decho "Searching for $page" 897 man_find_and_display "$page" 898 done 899 900 exit ${ret:-0} 901} 902 903do_manpath() { 904 manpath_parse_args "$@" 905 if [ -z "$qflag" ]; then 906 manpath_warnings 907 fi 908 if [ -n "$Lflag" ]; then 909 build_manlocales 910 echo $MANLOCALES 911 else 912 build_manpath 913 echo $MANPATH 914 fi 915 exit 0 916} 917 918do_whatis() { 919 search_whatis whatis "$@" 920} 921 922# User's PATH setting decides on the groff-suite to pick up. 923EQN=eqn 924NROFF='groff -S -P-ch -Wall -mtty-char -man' 925PIC=pic 926REFER=refer 927TBL=tbl 928TROFF='groff -S -man' 929VGRIND=vgrind 930 931LOCALE=/usr/bin/locale 932STTY=/bin/stty 933SYSCTL=/sbin/sysctl 934 935debug=0 936man_default_sections='1:1aout:8:2:3:n:4:5:6:7:9:l' 937man_default_path='/usr/share/man:/usr/share/openssl/man:/usr/local/man' 938cattool='/usr/bin/zcat -f' 939 940config_global='/etc/man.conf' 941 942# This can be overridden via a setting in /etc/man.conf. 943config_local='/usr/local/etc/man.d/*.conf' 944 945# Set noglobbing for now. I don't want spurious globbing. 946set -f 947 948case "$0" in 949*apropos) do_apropos "$@" ;; 950*manpath) do_manpath "$@" ;; 951*whatis) do_whatis "$@" ;; 952*) do_man "$@" ;; 953esac 954