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