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