xref: /freebsd/usr.bin/man/man.sh (revision deeff310cce78623330780cf726c8ee3777fbc81)
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
115c535eb59SGordon Tetlow		if exists "$2" && is_newer $found $manpage; then
116c535eb59SGordon Tetlow			# cat page found and is newer, use that
117c535eb59SGordon Tetlow			use_cat=yes
118c535eb59SGordon Tetlow			catpage=$found
11957cd9717SGordon Tetlow			setup_cattool $catpage
120c535eb59SGordon Tetlow			decho "    Using catpage $catpage"
121c535eb59SGordon Tetlow		else
122c535eb59SGordon Tetlow			# no cat page or is older
123c535eb59SGordon Tetlow			unset use_cat
124c535eb59SGordon Tetlow			decho "    Skipping catpage: not found or old"
125c535eb59SGordon Tetlow		fi
126c535eb59SGordon Tetlow		return 0
127c535eb59SGordon Tetlow	fi
128c535eb59SGordon Tetlow
129c535eb59SGordon Tetlow	return 1
130c535eb59SGordon Tetlow}
131c535eb59SGordon Tetlow
132c535eb59SGordon Tetlow# Usage: decho "string" [debuglevel]
133c535eb59SGordon Tetlow# Echoes to stderr string prefaced with -- if high enough debuglevel.
134c535eb59SGordon Tetlowdecho() {
135c535eb59SGordon Tetlow	if [ $debug -ge ${2:-1} ]; then
136c535eb59SGordon Tetlow		echo "-- $1" >&2
137c535eb59SGordon Tetlow	fi
138c535eb59SGordon Tetlow}
139c535eb59SGordon Tetlow
140c535eb59SGordon Tetlow# Usage: exists glob
141c535eb59SGordon Tetlow# Returns true if glob resolves to a real file.
142c535eb59SGordon Tetlowexists() {
143c535eb59SGordon Tetlow	local IFS
144c535eb59SGordon Tetlow
145c535eb59SGordon Tetlow	# Don't accidentally inherit callers IFS (breaks perl manpages)
146c535eb59SGordon Tetlow	unset IFS
147c535eb59SGordon Tetlow
148c535eb59SGordon Tetlow	# Use some globbing tricks in the shell to determine if a file
149c535eb59SGordon Tetlow	# exists or not.
150c535eb59SGordon Tetlow	set +f
151c535eb59SGordon Tetlow	set -- "$1" $1
152c535eb59SGordon Tetlow	set -f
153c535eb59SGordon Tetlow
154c535eb59SGordon Tetlow	if [ "$1" != "$2" -a -r "$2" ]; then
155c535eb59SGordon Tetlow		found="$2"
156c535eb59SGordon Tetlow		return 0
157c535eb59SGordon Tetlow	fi
158c535eb59SGordon Tetlow
159c535eb59SGordon Tetlow	return 1
160c535eb59SGordon Tetlow}
161c535eb59SGordon Tetlow
162c535eb59SGordon Tetlow# Usage: find_file path section subdir pagename
163c535eb59SGordon Tetlow# Returns: true if something is matched and found.
164c535eb59SGordon Tetlow# Search the given path/section combo for a given page.
165c535eb59SGordon Tetlowfind_file() {
166c535eb59SGordon Tetlow	local manroot catroot mann man0 catn cat0
167c535eb59SGordon Tetlow
168c535eb59SGordon Tetlow	manroot="$1/man$2"
169c535eb59SGordon Tetlow	catroot="$1/cat$2"
170c535eb59SGordon Tetlow	if [ -n "$3" ]; then
171c535eb59SGordon Tetlow		manroot="$manroot/$3"
172c535eb59SGordon Tetlow		catroot="$catroot/$3"
173c535eb59SGordon Tetlow	fi
174c535eb59SGordon Tetlow
175c535eb59SGordon Tetlow	if [ ! -d "$manroot" ]; then
176c535eb59SGordon Tetlow		return 1
177c535eb59SGordon Tetlow	fi
178c535eb59SGordon Tetlow	decho "  Searching directory $manroot" 2
179c535eb59SGordon Tetlow
180c535eb59SGordon Tetlow	mann="$manroot/$4.$2*"
181c535eb59SGordon Tetlow	man0="$manroot/$4.0*"
182c535eb59SGordon Tetlow	catn="$catroot/$4.$2*"
183c535eb59SGordon Tetlow	cat0="$catroot/$4.0*"
184c535eb59SGordon Tetlow
185c535eb59SGordon Tetlow	# This is the behavior as seen by the original man utility.
186c535eb59SGordon Tetlow	# Let's not change that which doesn't seem broken.
187c535eb59SGordon Tetlow	if check_man "$mann" "$catn"; then
188c535eb59SGordon Tetlow		return 0
189c535eb59SGordon Tetlow	elif check_man "$man0" "$cat0"; then
190c535eb59SGordon Tetlow		return 0
191c535eb59SGordon Tetlow	elif check_cat "$catn"; then
192c535eb59SGordon Tetlow		return 0
193c535eb59SGordon Tetlow	elif check_cat "$cat0"; then
194c535eb59SGordon Tetlow		return 0
195c535eb59SGordon Tetlow	fi
196c535eb59SGordon Tetlow
197c535eb59SGordon Tetlow	return 1
198c535eb59SGordon Tetlow}
199c535eb59SGordon Tetlow
200c535eb59SGordon Tetlow# Usage: is_newer file1 file2
201c535eb59SGordon Tetlow# Returns true if file1 is newer than file2 as calculated by mtime.
202c535eb59SGordon Tetlowis_newer() {
2039b61837aSUlrich Spörlein	if ! [ "$1" -ot "$2" ]; then
2049b61837aSUlrich Spörlein		decho "    mtime: $1 not older than $2" 3
205c535eb59SGordon Tetlow		return 0
206c535eb59SGordon Tetlow	else
207c535eb59SGordon Tetlow		decho "    mtime: $1 older than $2" 3
208c535eb59SGordon Tetlow		return 1
209c535eb59SGordon Tetlow	fi
210c535eb59SGordon Tetlow}
211c535eb59SGordon Tetlow
212c535eb59SGordon Tetlow# Usage: manpath_parse_args "$@"
213c535eb59SGordon Tetlow# Parses commandline options for manpath.
214c535eb59SGordon Tetlowmanpath_parse_args() {
215c535eb59SGordon Tetlow	local cmd_arg
216c535eb59SGordon Tetlow
217c535eb59SGordon Tetlow	while getopts 'Ldq' cmd_arg; do
218c535eb59SGordon Tetlow		case "${cmd_arg}" in
219c535eb59SGordon Tetlow		L)	Lflag=Lflag ;;
220c535eb59SGordon Tetlow		d)	debug=$(( $debug + 1 )) ;;
221c535eb59SGordon Tetlow		q)	qflag=qflag ;;
222c535eb59SGordon Tetlow		*)	manpath_usage ;;
223c535eb59SGordon Tetlow		esac
224c535eb59SGordon Tetlow	done >&2
225c535eb59SGordon Tetlow}
226c535eb59SGordon Tetlow
227c535eb59SGordon Tetlow# Usage: manpath_usage
228c535eb59SGordon Tetlow# Display usage for the manpath(1) utility.
229c535eb59SGordon Tetlowmanpath_usage() {
230c535eb59SGordon Tetlow	echo 'usage: manpath [-Ldq]' >&2
231c535eb59SGordon Tetlow	exit 1
232c535eb59SGordon Tetlow}
233c535eb59SGordon Tetlow
234c535eb59SGordon Tetlow# Usage: manpath_warnings
235c535eb59SGordon Tetlow# Display some warnings to stderr.
236c535eb59SGordon Tetlowmanpath_warnings() {
237c535eb59SGordon Tetlow	if [ -z "$Lflag" -a -n "$MANPATH" ]; then
238c535eb59SGordon Tetlow		echo "(Warning: MANPATH environment variable set)" >&2
239c535eb59SGordon Tetlow	fi
240c535eb59SGordon Tetlow
241c535eb59SGordon Tetlow	if [ -n "$Lflag" -a -n "$MANLOCALES" ]; then
242c535eb59SGordon Tetlow		echo "(Warning: MANLOCALES environment variable set)" >&2
243c535eb59SGordon Tetlow	fi
244c535eb59SGordon Tetlow}
245c535eb59SGordon Tetlow
24657cd9717SGordon Tetlow# Usage: man_check_for_so page path
24757cd9717SGordon Tetlow# Returns: True if able to resolve the file, false if it ended in tears.
24857cd9717SGordon Tetlow# Detects the presence of the .so directive and causes the file to be
24957cd9717SGordon Tetlow# redirected to another source file.
25057cd9717SGordon Tetlowman_check_for_so() {
25157cd9717SGordon Tetlow	local IFS line tstr
25257cd9717SGordon Tetlow
25357cd9717SGordon Tetlow	unset IFS
25457cd9717SGordon Tetlow
25557cd9717SGordon Tetlow	# We need to loop to accommodate multiple .so directives.
25657cd9717SGordon Tetlow	while true
25757cd9717SGordon Tetlow	do
25857cd9717SGordon Tetlow		line=$($cattool $manpage | head -1)
25957cd9717SGordon Tetlow		case "$line" in
26057cd9717SGordon Tetlow		.so*)	trim "${line#.so}"
26157cd9717SGordon Tetlow			decho "$manpage includes $tstr"
26257cd9717SGordon Tetlow			# Glob and check for the file.
26357cd9717SGordon Tetlow			if ! check_man "$path/$tstr*" ""; then
26457cd9717SGordon Tetlow				decho "  Unable to find $tstr"
26557cd9717SGordon Tetlow				return 1
26657cd9717SGordon Tetlow			fi
26757cd9717SGordon Tetlow			;;
26857cd9717SGordon Tetlow		*)	break ;;
26957cd9717SGordon Tetlow		esac
27057cd9717SGordon Tetlow	done
27157cd9717SGordon Tetlow
27257cd9717SGordon Tetlow	return 0
27357cd9717SGordon Tetlow}
27457cd9717SGordon Tetlow
275c535eb59SGordon Tetlow# Usage: man_display_page
276c535eb59SGordon Tetlow# Display either the manpage or catpage depending on the use_cat variable
277c535eb59SGordon Tetlowman_display_page() {
278c535eb59SGordon Tetlow	local EQN COL NROFF PIC TBL TROFF REFER VGRIND
279c535eb59SGordon Tetlow	local IFS l nroff_dev pipeline preproc_arg tool
280c535eb59SGordon Tetlow
281c535eb59SGordon Tetlow	# We are called with IFS set to colon. This causes really weird
282c535eb59SGordon Tetlow	# things to happen for the variables that have spaces in them.
283c535eb59SGordon Tetlow	unset IFS
284c535eb59SGordon Tetlow
285c535eb59SGordon Tetlow	# If we are supposed to use a catpage and we aren't using troff(1)
286c535eb59SGordon Tetlow	# just zcat the catpage and we are done.
287c535eb59SGordon Tetlow	if [ -z "$tflag" -a -n "$use_cat" ]; then
288c535eb59SGordon Tetlow		if [ -n "$wflag" ]; then
289c535eb59SGordon Tetlow			echo "$catpage (source: $manpage)"
290c535eb59SGordon Tetlow			ret=0
291c535eb59SGordon Tetlow		else
292c535eb59SGordon Tetlow			if [ $debug -gt 0 ]; then
29357cd9717SGordon Tetlow				decho "Command: $cattool $catpage | $PAGER"
294c535eb59SGordon Tetlow				ret=0
295c535eb59SGordon Tetlow			else
29657cd9717SGordon Tetlow				eval "$cattool $catpage | $PAGER"
297c535eb59SGordon Tetlow				ret=$?
298c535eb59SGordon Tetlow			fi
299c535eb59SGordon Tetlow		fi
300c535eb59SGordon Tetlow		return
301c535eb59SGordon Tetlow	fi
302c535eb59SGordon Tetlow
303c535eb59SGordon Tetlow	# Okay, we are using the manpage, do we just need to output the
304c535eb59SGordon Tetlow	# name of the manpage?
305c535eb59SGordon Tetlow	if [ -n "$wflag" ]; then
306c535eb59SGordon Tetlow		echo "$manpage"
307c535eb59SGordon Tetlow		ret=0
308c535eb59SGordon Tetlow		return
309c535eb59SGordon Tetlow	fi
310c535eb59SGordon Tetlow
311c535eb59SGordon Tetlow	# So, we really do need to parse the manpage. First, figure out the
312c535eb59SGordon Tetlow	# device flag (-T) we have to pass to eqn(1) and groff(1). Then,
313c535eb59SGordon Tetlow	# setup the pipeline of commands based on the user's request.
314c535eb59SGordon Tetlow
315*deeff310SGordon Tetlow	# If the manpage is from a particular charset, we need to setup nroff
316*deeff310SGordon Tetlow	# to properly output for the correct device.
317*deeff310SGordon Tetlow	case "${manpage}" in
318*deeff310SGordon Tetlow	*.${man_charset}/*)
319c535eb59SGordon Tetlow		# I don't pretend to know this; I'm just copying from the
320c535eb59SGordon Tetlow		# previous version of man(1).
321c535eb59SGordon Tetlow		case "$man_charset" in
322c535eb59SGordon Tetlow		KOI8-R)		nroff_dev="koi8-r" ;;
323c535eb59SGordon Tetlow		ISO8859-1)	nroff_dev="latin1" ;;
324c535eb59SGordon Tetlow		ISO8859-15)	nroff_dev="latin1" ;;
325c535eb59SGordon Tetlow		UTF-8)		nroff_dev="utf8" ;;
326c535eb59SGordon Tetlow		*)		nroff_dev="ascii" ;;
327c535eb59SGordon Tetlow		esac
328c535eb59SGordon Tetlow
329*deeff310SGordon Tetlow		NROFF="$NROFF -T$nroff_dev"
330c535eb59SGordon Tetlow		EQN="$EQN -T$nroff_dev"
331c535eb59SGordon Tetlow
332*deeff310SGordon Tetlow		# Iff the manpage is from the locale and not just the charset,
333*deeff310SGordon Tetlow		# then we need to define the locale string.
334*deeff310SGordon Tetlow		case "${manpage}" in
335*deeff310SGordon Tetlow		*/${man_lang}_${man_country}.${man_charset}/*)
336*deeff310SGordon Tetlow			NROFF="$NROFF -dlocale=$man_lang.$man_charset"
337*deeff310SGordon Tetlow			;;
338*deeff310SGordon Tetlow		*/${man_lang}.${man_charset}/*)
339*deeff310SGordon Tetlow			NROFF="$NROFF -dlocale=$man_lang.$man_charset"
340*deeff310SGordon Tetlow			;;
341*deeff310SGordon Tetlow		esac
342*deeff310SGordon Tetlow
343c535eb59SGordon Tetlow		# Allow language specific calls to override the default
344c535eb59SGordon Tetlow		# set of utilities.
345c535eb59SGordon Tetlow		l=$(echo $man_lang | tr [:lower:] [:upper:])
346c535eb59SGordon Tetlow		for tool in EQN COL NROFF PIC TBL TROFF REFER VGRIND; do
347c535eb59SGordon Tetlow			eval "$tool=\${${tool}_$l:-\$$tool}"
348c535eb59SGordon Tetlow		done
349c535eb59SGordon Tetlow		;;
350c535eb59SGordon Tetlow	*)	NROFF="$NROFF -Tascii"
351c535eb59SGordon Tetlow		EQN="$EQN -Tascii"
352c535eb59SGordon Tetlow		;;
353c535eb59SGordon Tetlow	esac
354c535eb59SGordon Tetlow
355c535eb59SGordon Tetlow	if [ -n "$MANROFFSEQ" ]; then
356c535eb59SGordon Tetlow		set -- -$MANROFFSEQ
357c535eb59SGordon Tetlow		while getopts 'egprtv' preproc_arg; do
358c535eb59SGordon Tetlow			case "${preproc_arg}" in
359c535eb59SGordon Tetlow			e)	pipeline="$pipeline | $EQN" ;;
360c535eb59SGordon Tetlow			g)	;; # Ignore for compatability.
361c535eb59SGordon Tetlow			p)	pipeline="$pipeline | $PIC" ;;
362c535eb59SGordon Tetlow			r)	pipeline="$pipeline | $REFER" ;;
363c535eb59SGordon Tetlow			t)	pipeline="$pipeline | $TBL"; use_col=yes ;;
364c535eb59SGordon Tetlow			v)	pipeline="$pipeline | $VGRIND" ;;
365c535eb59SGordon Tetlow			*)	usage ;;
366c535eb59SGordon Tetlow			esac
367c535eb59SGordon Tetlow		done
368c535eb59SGordon Tetlow		# Strip the leading " | " from the resulting pipeline.
369c535eb59SGordon Tetlow		pipeline="${pipeline#" | "}"
370c535eb59SGordon Tetlow	else
371c535eb59SGordon Tetlow		pipeline="$TBL"
372c535eb59SGordon Tetlow		use_col=yes
373c535eb59SGordon Tetlow	fi
374c535eb59SGordon Tetlow
375c535eb59SGordon Tetlow	if [ -n "$tflag" ]; then
376c535eb59SGordon Tetlow		pipeline="$pipeline | $TROFF"
377c535eb59SGordon Tetlow	else
378c535eb59SGordon Tetlow		pipeline="$pipeline | $NROFF"
379c535eb59SGordon Tetlow
380c535eb59SGordon Tetlow		if [ -n "$use_col" ]; then
381c535eb59SGordon Tetlow			pipeline="$pipeline | $COL"
382c535eb59SGordon Tetlow		fi
383c535eb59SGordon Tetlow
384c535eb59SGordon Tetlow		pipeline="$pipeline | $PAGER"
385c535eb59SGordon Tetlow	fi
386c535eb59SGordon Tetlow
387c535eb59SGordon Tetlow	if [ $debug -gt 0 ]; then
38857cd9717SGordon Tetlow		decho "Command: $cattool $manpage | $pipeline"
389c535eb59SGordon Tetlow		ret=0
390c535eb59SGordon Tetlow	else
39157cd9717SGordon Tetlow		eval "$cattool $manpage | $pipeline"
392c535eb59SGordon Tetlow		ret=$?
393c535eb59SGordon Tetlow	fi
394c535eb59SGordon Tetlow}
395c535eb59SGordon Tetlow
396c535eb59SGordon Tetlow# Usage: man_find_and_display page
397c535eb59SGordon Tetlow# Search through the manpaths looking for the given page.
398c535eb59SGordon Tetlowman_find_and_display() {
399c535eb59SGordon Tetlow	local found_page locpath p path sect
400c535eb59SGordon Tetlow
4013d9127f1SGordon Tetlow	# Check to see if it's a file. But only if it has a '/' in
4023d9127f1SGordon Tetlow	# the filename.
4033d9127f1SGordon Tetlow	case "$1" in
4043d9127f1SGordon Tetlow	*/*)	if [ -f "$1" -a -r "$1" ]; then
4053d9127f1SGordon Tetlow			decho "Found a usable page, displaying that"
4063d9127f1SGordon Tetlow			unset use_cat
4073d9127f1SGordon Tetlow			manpage="$1"
40857cd9717SGordon Tetlow			setup_cattool $manpage
40957cd9717SGordon Tetlow			if man_check_for_so $manpage $(dirname $manpage); then
41057cd9717SGordon Tetlow				found_page=yes
4113d9127f1SGordon Tetlow				man_display_page
41257cd9717SGordon Tetlow			fi
4133d9127f1SGordon Tetlow			return
4143d9127f1SGordon Tetlow		fi
4153d9127f1SGordon Tetlow		;;
4163d9127f1SGordon Tetlow	esac
4173d9127f1SGordon Tetlow
418c535eb59SGordon Tetlow	IFS=:
419c535eb59SGordon Tetlow	for sect in $MANSECT; do
420c535eb59SGordon Tetlow		decho "Searching section $sect" 2
421c535eb59SGordon Tetlow		for path in $MANPATH; do
422c535eb59SGordon Tetlow			for locpath in $locpaths; do
423c535eb59SGordon Tetlow				p=$path/$locpath
424c535eb59SGordon Tetlow				p=${p%/.} # Rid ourselves of the trailing /.
425c535eb59SGordon Tetlow
426c535eb59SGordon Tetlow				# Check if there is a MACHINE specific manpath.
427c535eb59SGordon Tetlow				if find_file $p $sect $MACHINE "$1"; then
42857cd9717SGordon Tetlow					if man_check_for_so $manpage $p; then
429c535eb59SGordon Tetlow						found_page=yes
430c535eb59SGordon Tetlow						man_display_page
4311d7c660aSGordon Tetlow						if [ -n "$aflag" ]; then
4321d7c660aSGordon Tetlow							continue 2
4331d7c660aSGordon Tetlow						else
434c535eb59SGordon Tetlow							return
435c535eb59SGordon Tetlow						fi
436c535eb59SGordon Tetlow					fi
43757cd9717SGordon Tetlow				fi
438c535eb59SGordon Tetlow
439c535eb59SGordon Tetlow				# Check if there is a MACHINE_ARCH
440c535eb59SGordon Tetlow				# specific manpath.
441c535eb59SGordon Tetlow				if find_file $p $sect $MACHINE_ARCH "$1"; then
44257cd9717SGordon Tetlow					if man_check_for_so $manpage $p; then
443c535eb59SGordon Tetlow						found_page=yes
444c535eb59SGordon Tetlow						man_display_page
4451d7c660aSGordon Tetlow						if [ -n "$aflag" ]; then
4461d7c660aSGordon Tetlow							continue 2
4471d7c660aSGordon Tetlow						else
448c535eb59SGordon Tetlow							return
449c535eb59SGordon Tetlow						fi
450c535eb59SGordon Tetlow					fi
45157cd9717SGordon Tetlow				fi
452c535eb59SGordon Tetlow
453c535eb59SGordon Tetlow				# Check plain old manpath.
454c535eb59SGordon Tetlow				if find_file $p $sect '' "$1"; then
45557cd9717SGordon Tetlow					if man_check_for_so $manpage $p; then
456c535eb59SGordon Tetlow						found_page=yes
457c535eb59SGordon Tetlow						man_display_page
4581d7c660aSGordon Tetlow						if [ -n "$aflag" ]; then
4591d7c660aSGordon Tetlow							continue 2
4601d7c660aSGordon Tetlow						else
461c535eb59SGordon Tetlow							return
462c535eb59SGordon Tetlow						fi
463c535eb59SGordon Tetlow					fi
46457cd9717SGordon Tetlow				fi
465c535eb59SGordon Tetlow			done
466c535eb59SGordon Tetlow		done
467c535eb59SGordon Tetlow	done
468c535eb59SGordon Tetlow	unset IFS
469c535eb59SGordon Tetlow
470c535eb59SGordon Tetlow	# Nothing? Well, we are done then.
471c535eb59SGordon Tetlow	if [ -z "$found_page" ]; then
472c535eb59SGordon Tetlow		echo "No manual entry for $1" >&2
473c535eb59SGordon Tetlow		ret=1
474c535eb59SGordon Tetlow		return
475c535eb59SGordon Tetlow	fi
476c535eb59SGordon Tetlow}
477c535eb59SGordon Tetlow
478c535eb59SGordon Tetlow# Usage: man_parse_args "$@"
479c535eb59SGordon Tetlow# Parses commandline options for man.
480c535eb59SGordon Tetlowman_parse_args() {
481c535eb59SGordon Tetlow	local IFS cmd_arg
482c535eb59SGordon Tetlow
483c535eb59SGordon Tetlow	while getopts 'M:P:S:adfhkm:op:tw' cmd_arg; do
484c535eb59SGordon Tetlow		case "${cmd_arg}" in
485c535eb59SGordon Tetlow		M)	MANPATH=$OPTARG ;;
486c535eb59SGordon Tetlow		P)	PAGER=$OPTARG ;;
487c535eb59SGordon Tetlow		S)	MANSECT=$OPTARG ;;
488c535eb59SGordon Tetlow		a)	aflag=aflag ;;
489c535eb59SGordon Tetlow		d)	debug=$(( $debug + 1 )) ;;
490c535eb59SGordon Tetlow		f)	fflag=fflag ;;
491c535eb59SGordon Tetlow		h)	man_usage 0 ;;
492c535eb59SGordon Tetlow		k)	kflag=kflag ;;
493c535eb59SGordon Tetlow		m)	mflag=$OPTARG ;;
494c535eb59SGordon Tetlow		o)	oflag=oflag ;;
495c535eb59SGordon Tetlow		p)	MANROFFSEQ=$OPTARG ;;
496c535eb59SGordon Tetlow		t)	tflag=tflag ;;
497c535eb59SGordon Tetlow		w)	wflag=wflag ;;
498c535eb59SGordon Tetlow		*)	man_usage ;;
499c535eb59SGordon Tetlow		esac
500c535eb59SGordon Tetlow	done >&2
501c535eb59SGordon Tetlow
502c535eb59SGordon Tetlow	shift $(( $OPTIND - 1 ))
503c535eb59SGordon Tetlow
504c535eb59SGordon Tetlow	# Check the args for incompatible options.
505c535eb59SGordon Tetlow	case "${fflag}${kflag}${tflag}${wflag}" in
506c535eb59SGordon Tetlow	fflagkflag*)	echo "Incompatible options: -f and -k"; man_usage ;;
507c535eb59SGordon Tetlow	fflag*tflag*)	echo "Incompatible options: -f and -t"; man_usage ;;
508c535eb59SGordon Tetlow	fflag*wflag)	echo "Incompatible options: -f and -w"; man_usage ;;
509c535eb59SGordon Tetlow	*kflagtflag*)	echo "Incompatible options: -k and -t"; man_usage ;;
510c535eb59SGordon Tetlow	*kflag*wflag)	echo "Incompatible options: -k and -w"; man_usage ;;
511c535eb59SGordon Tetlow	*tflagwflag)	echo "Incompatible options: -t and -w"; man_usage ;;
512c535eb59SGordon Tetlow	esac
513c535eb59SGordon Tetlow
514c535eb59SGordon Tetlow	# Short circuit for whatis(1) and apropos(1)
515c535eb59SGordon Tetlow	if [ -n "$fflag" ]; then
516c535eb59SGordon Tetlow		do_whatis "$@"
517c535eb59SGordon Tetlow		exit
518c535eb59SGordon Tetlow	fi
519c535eb59SGordon Tetlow
520c535eb59SGordon Tetlow	if [ -n "$kflag" ]; then
521c535eb59SGordon Tetlow		do_apropos "$@"
522c535eb59SGordon Tetlow		exit
523c535eb59SGordon Tetlow	fi
524c535eb59SGordon Tetlow
525c535eb59SGordon Tetlow	IFS=:
526c535eb59SGordon Tetlow	for sect in $man_default_sections; do
527c535eb59SGordon Tetlow		if [ "$sect" = "$1" ]; then
528c535eb59SGordon Tetlow			decho "Detected manual section as first arg: $1"
529c535eb59SGordon Tetlow			MANSECT="$1"
530c535eb59SGordon Tetlow			shift
531c535eb59SGordon Tetlow			break
532c535eb59SGordon Tetlow		fi
533c535eb59SGordon Tetlow	done
534c535eb59SGordon Tetlow	unset IFS
535c535eb59SGordon Tetlow
536c535eb59SGordon Tetlow	pages="$*"
537c535eb59SGordon Tetlow}
538c535eb59SGordon Tetlow
539c535eb59SGordon Tetlow# Usage: man_setup
540c535eb59SGordon Tetlow# Setup various trivial but essential variables.
541c535eb59SGordon Tetlowman_setup() {
542c535eb59SGordon Tetlow	# Setup machine and architecture variables.
543c535eb59SGordon Tetlow	if [ -n "$mflag" ]; then
544c535eb59SGordon Tetlow		MACHINE_ARCH=${mflag%%:*}
545c535eb59SGordon Tetlow		MACHINE=${mflag##*:}
546c535eb59SGordon Tetlow	fi
547c535eb59SGordon Tetlow	if [ -z "$MACHINE_ARCH" ]; then
54882db8a5eSGordon Tetlow		MACHINE_ARCH=$($SYSCTL -n hw.machine_arch)
549c535eb59SGordon Tetlow	fi
550c535eb59SGordon Tetlow	if [ -z "$MACHINE" ]; then
55182db8a5eSGordon Tetlow		MACHINE=$($SYSCTL -n hw.machine)
552c535eb59SGordon Tetlow	fi
553c535eb59SGordon Tetlow	decho "Using architecture: $MACHINE_ARCH:$MACHINE"
554c535eb59SGordon Tetlow
555c535eb59SGordon Tetlow	setup_pager
556c535eb59SGordon Tetlow
557c535eb59SGordon Tetlow	# Setup manual sections to search.
558c535eb59SGordon Tetlow	if [ -z "$MANSECT" ]; then
559c535eb59SGordon Tetlow		MANSECT=$man_default_sections
560c535eb59SGordon Tetlow	fi
561c535eb59SGordon Tetlow	decho "Using manual sections: $MANSECT"
562c535eb59SGordon Tetlow
563c535eb59SGordon Tetlow	build_manpath
564c535eb59SGordon Tetlow	man_setup_locale
565c535eb59SGordon Tetlow}
566c535eb59SGordon Tetlow
567c535eb59SGordon Tetlow# Usage: man_setup_locale
568c535eb59SGordon Tetlow# Setup necessary locale variables.
569c535eb59SGordon Tetlowman_setup_locale() {
570*deeff310SGordon Tetlow	local lang_cc
571*deeff310SGordon Tetlow
572*deeff310SGordon Tetlow	locpaths='.'
573*deeff310SGordon Tetlow	man_charset='US-ASCII'
574*deeff310SGordon Tetlow
575c535eb59SGordon Tetlow	# Setup locale information.
576c535eb59SGordon Tetlow	if [ -n "$oflag" ]; then
577*deeff310SGordon Tetlow		decho 'Using non-localized manpages'
578*deeff310SGordon Tetlow	else
579*deeff310SGordon Tetlow		# Use the locale tool to give us the proper LC_CTYPE
580*deeff310SGordon Tetlow		eval $( $LOCALE )
581c535eb59SGordon Tetlow
582*deeff310SGordon Tetlow		case "$LC_CTYPE" in
583*deeff310SGordon Tetlow		C)		;;
584*deeff310SGordon Tetlow		POSIX)		;;
585*deeff310SGordon Tetlow		[a-z][a-z]_[A-Z][A-Z]\.*)
586*deeff310SGordon Tetlow				lang_cc="${LC_CTYPE%.*}"
587*deeff310SGordon Tetlow				man_lang="${LC_CTYPE%_*}"
588*deeff310SGordon Tetlow				man_country="${lang_cc#*_}"
589*deeff310SGordon Tetlow				man_charset="${LC_CTYPE#*.}"
590*deeff310SGordon Tetlow				locpaths="$LC_CTYPE"
591c535eb59SGordon Tetlow				locpaths="$locpaths:$man_lang.$man_charset"
592c535eb59SGordon Tetlow				if [ "$man_lang" != "en" ]; then
593c535eb59SGordon Tetlow					locpaths="$locpaths:en.$man_charset"
594c535eb59SGordon Tetlow				fi
595c535eb59SGordon Tetlow				locpaths="$locpaths:."
596*deeff310SGordon Tetlow				;;
597*deeff310SGordon Tetlow		*)		echo 'Unknown locale, assuming C' >&2
598*deeff310SGordon Tetlow				;;
599*deeff310SGordon Tetlow		esac
600c535eb59SGordon Tetlow	fi
601*deeff310SGordon Tetlow
602c535eb59SGordon Tetlow	decho "Using locale paths: $locpaths"
603c535eb59SGordon Tetlow}
604c535eb59SGordon Tetlow
605c535eb59SGordon Tetlow# Usage: man_usage [exitcode]
606c535eb59SGordon Tetlow# Display usage for the man utility.
607c535eb59SGordon Tetlowman_usage() {
608c535eb59SGordon Tetlow	echo 'Usage:'
609c535eb59SGordon Tetlow	echo ' man [-adho] [-t | -w] [-M manpath] [-P pager] [-S mansect]'
610c535eb59SGordon Tetlow	echo '     [-m arch[:machine]] [-p [eprtv]] [mansect] page [...]'
611c535eb59SGordon Tetlow	echo ' man -f page [...] -- Emulates whatis(1)'
612c535eb59SGordon Tetlow	echo ' man -k page [...] -- Emulates apropos(1)'
613c535eb59SGordon Tetlow
614c535eb59SGordon Tetlow	# When exit'ing with -h, it's not an error.
615c535eb59SGordon Tetlow	exit ${1:-1}
616c535eb59SGordon Tetlow}
617c535eb59SGordon Tetlow
618c535eb59SGordon Tetlow# Usage: parse_configs
619c535eb59SGordon Tetlow# Reads the end-user adjustable config files.
620c535eb59SGordon Tetlowparse_configs() {
621c535eb59SGordon Tetlow	local IFS file files
622c535eb59SGordon Tetlow
623c535eb59SGordon Tetlow	if [ -n "$parsed_configs" ]; then
624c535eb59SGordon Tetlow		return
625c535eb59SGordon Tetlow	fi
626c535eb59SGordon Tetlow
627c535eb59SGordon Tetlow	unset IFS
628c535eb59SGordon Tetlow
629c535eb59SGordon Tetlow	# Read the global config first in case the user wants
630c535eb59SGordon Tetlow	# to override config_local.
631c535eb59SGordon Tetlow	if [ -r "$config_global" ]; then
632c535eb59SGordon Tetlow		parse_file "$config_global"
633c535eb59SGordon Tetlow	fi
634c535eb59SGordon Tetlow
635c535eb59SGordon Tetlow	# Glob the list of files to parse.
636c535eb59SGordon Tetlow	set +f
637c535eb59SGordon Tetlow	files=$(echo $config_local)
638c535eb59SGordon Tetlow	set -f
639c535eb59SGordon Tetlow
640c535eb59SGordon Tetlow	for file in $files; do
641c535eb59SGordon Tetlow		if [ -r "$file" ]; then
642c535eb59SGordon Tetlow			parse_file "$file"
643c535eb59SGordon Tetlow		fi
644c535eb59SGordon Tetlow	done
645c535eb59SGordon Tetlow
646c535eb59SGordon Tetlow	parsed_configs='yes'
647c535eb59SGordon Tetlow}
648c535eb59SGordon Tetlow
649c535eb59SGordon Tetlow# Usage: parse_file file
650c535eb59SGordon Tetlow# Reads the specified config files.
651c535eb59SGordon Tetlowparse_file() {
652c535eb59SGordon Tetlow	local file line tstr var
653c535eb59SGordon Tetlow
654c535eb59SGordon Tetlow	file="$1"
655c535eb59SGordon Tetlow	decho "Parsing config file: $file"
656c535eb59SGordon Tetlow	while read line; do
657c535eb59SGordon Tetlow		decho "  $line" 2
658c535eb59SGordon Tetlow		case "$line" in
659c535eb59SGordon Tetlow		\#*)		decho "    Comment" 3
660c535eb59SGordon Tetlow				;;
661c535eb59SGordon Tetlow		MANPATH*)	decho "    MANPATH" 3
662c535eb59SGordon Tetlow				trim "${line#MANPATH}"
663c535eb59SGordon Tetlow				add_to_manpath "$tstr"
664c535eb59SGordon Tetlow				;;
665c535eb59SGordon Tetlow		MANLOCALE*)	decho "    MANLOCALE" 3
666c535eb59SGordon Tetlow				trim "${line#MANLOCALE}"
667c535eb59SGordon Tetlow				manlocales="$manlocales:$tstr"
668c535eb59SGordon Tetlow				;;
669c535eb59SGordon Tetlow		MANCONFIG*)	decho "    MANCONFIG" 3
670c535eb59SGordon Tetlow				trim "${line#MANCONF}"
671c535eb59SGordon Tetlow				config_local="$tstr"
672c535eb59SGordon Tetlow				;;
673c535eb59SGordon Tetlow		# Set variables in the form of FOO_BAR
674c535eb59SGordon Tetlow		*_*[\ \	]*)	var="${line%%[\ \	]*}"
675c535eb59SGordon Tetlow				trim "${line#$var}"
676c535eb59SGordon Tetlow				eval "$var=\"$tstr\""
677c535eb59SGordon Tetlow				decho "    Parsed $var" 3
678c535eb59SGordon Tetlow				;;
679c535eb59SGordon Tetlow		esac
680c535eb59SGordon Tetlow	done < "$file"
681c535eb59SGordon Tetlow}
682c535eb59SGordon Tetlow
683c535eb59SGordon Tetlow# Usage: search_path
684c535eb59SGordon Tetlow# Traverse $PATH looking for manpaths.
685c535eb59SGordon Tetlowsearch_path() {
686c535eb59SGordon Tetlow	local IFS p path
687c535eb59SGordon Tetlow
688c535eb59SGordon Tetlow	decho "Searching PATH for man directories"
689c535eb59SGordon Tetlow
690c535eb59SGordon Tetlow	IFS=:
691c535eb59SGordon Tetlow	for path in $PATH; do
692c535eb59SGordon Tetlow		# Do a little special casing since the base manpages
693c535eb59SGordon Tetlow		# are in /usr/share/man instead of /usr/man or /man.
694c535eb59SGordon Tetlow		case "$path" in
695c535eb59SGordon Tetlow		/bin|/usr/bin)	add_to_manpath "/usr/share/man" ;;
696c535eb59SGordon Tetlow		*)	if add_to_manpath "$path/man"; then
697c535eb59SGordon Tetlow				:
698c535eb59SGordon Tetlow			elif add_to_manpath "$path/MAN"; then
699c535eb59SGordon Tetlow				:
700c535eb59SGordon Tetlow			else
701c535eb59SGordon Tetlow				case "$path" in
702c535eb59SGordon Tetlow				*/bin)	p="${path%/bin}/man"
703c535eb59SGordon Tetlow					add_to_manpath "$p"
704c535eb59SGordon Tetlow					;;
705c535eb59SGordon Tetlow				*)	;;
706c535eb59SGordon Tetlow				esac
707c535eb59SGordon Tetlow			fi
708c535eb59SGordon Tetlow			;;
709c535eb59SGordon Tetlow		esac
710c535eb59SGordon Tetlow	done
711c535eb59SGordon Tetlow	unset IFS
712c535eb59SGordon Tetlow
713c535eb59SGordon Tetlow	if [ -z "$manpath" ]; then
714c535eb59SGordon Tetlow		decho '  Unable to find any manpaths, using default'
715c535eb59SGordon Tetlow		manpath=$man_default_path
716c535eb59SGordon Tetlow	fi
717c535eb59SGordon Tetlow}
718c535eb59SGordon Tetlow
719c535eb59SGordon Tetlow# Usage: search_whatis cmd [arglist]
720c535eb59SGordon Tetlow# Do the heavy lifting for apropos/whatis
721c535eb59SGordon Tetlowsearch_whatis() {
722c535eb59SGordon Tetlow	local IFS bad cmd f good key keywords loc opt out path rval wlist
723c535eb59SGordon Tetlow
724c535eb59SGordon Tetlow	cmd="$1"
725c535eb59SGordon Tetlow	shift
726c535eb59SGordon Tetlow
727c535eb59SGordon Tetlow	whatis_parse_args "$@"
728c535eb59SGordon Tetlow
729c535eb59SGordon Tetlow	build_manpath
730c535eb59SGordon Tetlow	build_manlocales
731c535eb59SGordon Tetlow	setup_pager
732c535eb59SGordon Tetlow
733c535eb59SGordon Tetlow	if [ "$cmd" = "whatis" ]; then
734c535eb59SGordon Tetlow		opt="-w"
735c535eb59SGordon Tetlow	fi
736c535eb59SGordon Tetlow
737c535eb59SGordon Tetlow	f='whatis'
738c535eb59SGordon Tetlow
739c535eb59SGordon Tetlow	IFS=:
740c535eb59SGordon Tetlow	for path in $MANPATH; do
741c535eb59SGordon Tetlow		if [ \! -d "$path" ]; then
742c535eb59SGordon Tetlow			decho "Skipping non-existent path: $path" 2
743c535eb59SGordon Tetlow			continue
744c535eb59SGordon Tetlow		fi
745c535eb59SGordon Tetlow
746c535eb59SGordon Tetlow		if [ -f "$path/$f" -a -r "$path/$f" ]; then
747c535eb59SGordon Tetlow			decho "Found whatis: $path/$f"
748c535eb59SGordon Tetlow			wlist="$wlist $path/$f"
749c535eb59SGordon Tetlow		fi
750c535eb59SGordon Tetlow
751c535eb59SGordon Tetlow		for loc in $MANLOCALES; do
752c535eb59SGordon Tetlow			if [ -f "$path/$loc/$f" -a -r "$path/$loc/$f" ]; then
753c535eb59SGordon Tetlow				decho "Found whatis: $path/$loc/$f"
754c535eb59SGordon Tetlow				wlist="$wlist $path/$loc/$f"
755c535eb59SGordon Tetlow			fi
756c535eb59SGordon Tetlow		done
757c535eb59SGordon Tetlow	done
758c535eb59SGordon Tetlow	unset IFS
759c535eb59SGordon Tetlow
760c535eb59SGordon Tetlow	if [ -z "$wlist" ]; then
761c535eb59SGordon Tetlow		echo "$cmd: no whatis databases in $MANPATH" >&2
762c535eb59SGordon Tetlow		exit 1
763c535eb59SGordon Tetlow	fi
764c535eb59SGordon Tetlow
765c535eb59SGordon Tetlow	rval=0
766c535eb59SGordon Tetlow	for key in $keywords; do
767c535eb59SGordon Tetlow		out=$(grep -Ehi $opt -- "$key" $wlist)
768c535eb59SGordon Tetlow		if [ -n "$out" ]; then
769c535eb59SGordon Tetlow			good="$good\\n$out"
770c535eb59SGordon Tetlow		else
771c535eb59SGordon Tetlow			bad="$bad\\n$key: nothing appropriate"
772c535eb59SGordon Tetlow			rval=1
773c535eb59SGordon Tetlow		fi
774c535eb59SGordon Tetlow	done
775c535eb59SGordon Tetlow
776c535eb59SGordon Tetlow	# Strip leading carriage return.
777c535eb59SGordon Tetlow	good=${good#\\n}
778c535eb59SGordon Tetlow	bad=${bad#\\n}
779c535eb59SGordon Tetlow
780c535eb59SGordon Tetlow	if [ -n "$good" ]; then
78100e05e69SGordon Tetlow		echo -e "$good" | $PAGER
782c535eb59SGordon Tetlow	fi
783c535eb59SGordon Tetlow
784c535eb59SGordon Tetlow	if [ -n "$bad" ]; then
78500e05e69SGordon Tetlow		echo -e "$bad" >&2
786c535eb59SGordon Tetlow	fi
787c535eb59SGordon Tetlow
788c535eb59SGordon Tetlow	exit $rval
789c535eb59SGordon Tetlow}
790c535eb59SGordon Tetlow
79157cd9717SGordon Tetlow# Usage: setup_cattool page
79257cd9717SGordon Tetlow# Finds an appropriate decompressor based on extension
79357cd9717SGordon Tetlowsetup_cattool() {
79457cd9717SGordon Tetlow	case "$1" in
79557cd9717SGordon Tetlow	*.bz)	cattool='/usr/bin/bzcat' ;;
79657cd9717SGordon Tetlow	*.bz2)	cattool='/usr/bin/bzcat' ;;
79757cd9717SGordon Tetlow	*.gz)	cattool='/usr/bin/zcat' ;;
79857cd9717SGordon Tetlow	*.lzma)	cattool='/usr/bin/lzcat' ;;
79957cd9717SGordon Tetlow	*.xz)	cattool='/usr/bin/xzcat' ;;
80057cd9717SGordon Tetlow	*)	cattool='/usr/bin/zcat -f' ;;
80157cd9717SGordon Tetlow	esac
80257cd9717SGordon Tetlow}
80357cd9717SGordon Tetlow
804c535eb59SGordon Tetlow# Usage: setup_pager
805c535eb59SGordon Tetlow# Correctly sets $PAGER
806c535eb59SGordon Tetlowsetup_pager() {
807c535eb59SGordon Tetlow	# Setup pager.
808c535eb59SGordon Tetlow	if [ -z "$PAGER" ]; then
809c535eb59SGordon Tetlow		PAGER="more -s"
810c535eb59SGordon Tetlow	fi
811c535eb59SGordon Tetlow	decho "Using pager: $PAGER"
812c535eb59SGordon Tetlow}
813c535eb59SGordon Tetlow
814c535eb59SGordon Tetlow# Usage: trim string
815c535eb59SGordon Tetlow# Trims whitespace from beginning and end of a variable
816c535eb59SGordon Tetlowtrim() {
817c535eb59SGordon Tetlow	tstr=$1
818c535eb59SGordon Tetlow	while true; do
819c535eb59SGordon Tetlow		case "$tstr" in
820c535eb59SGordon Tetlow		[\ \	]*)	tstr="${tstr##[\ \	]}" ;;
821c535eb59SGordon Tetlow		*[\ \	])	tstr="${tstr%%[\ \	]}" ;;
822c535eb59SGordon Tetlow		*)		break ;;
823c535eb59SGordon Tetlow		esac
824c535eb59SGordon Tetlow	done
825c535eb59SGordon Tetlow}
826c535eb59SGordon Tetlow
827c535eb59SGordon Tetlow# Usage: whatis_parse_args "$@"
828c535eb59SGordon Tetlow# Parse commandline args for whatis and apropos.
829c535eb59SGordon Tetlowwhatis_parse_args() {
830c535eb59SGordon Tetlow	local cmd_arg
831c535eb59SGordon Tetlow	while getopts 'd' cmd_arg; do
832c535eb59SGordon Tetlow		case "${cmd_arg}" in
833c535eb59SGordon Tetlow		d)	debug=$(( $debug + 1 )) ;;
834c535eb59SGordon Tetlow		*)	whatis_usage ;;
835c535eb59SGordon Tetlow		esac
836c535eb59SGordon Tetlow	done >&2
837c535eb59SGordon Tetlow
838c535eb59SGordon Tetlow	shift $(( $OPTIND - 1 ))
839c535eb59SGordon Tetlow
840c535eb59SGordon Tetlow	keywords="$*"
841c535eb59SGordon Tetlow}
842c535eb59SGordon Tetlow
843c535eb59SGordon Tetlow# Usage: whatis_usage
844c535eb59SGordon Tetlow# Display usage for the whatis/apropos utility.
845c535eb59SGordon Tetlowwhatis_usage() {
846c535eb59SGordon Tetlow	echo "usage: $cmd [-d] keyword [...]"
847c535eb59SGordon Tetlow	exit 1
848c535eb59SGordon Tetlow}
849c535eb59SGordon Tetlow
850c535eb59SGordon Tetlow
851c535eb59SGordon Tetlow
852c535eb59SGordon Tetlow# Supported commands
853c535eb59SGordon Tetlowdo_apropos() {
854c535eb59SGordon Tetlow	search_whatis apropos "$@"
855c535eb59SGordon Tetlow}
856c535eb59SGordon Tetlow
857c535eb59SGordon Tetlowdo_man() {
858c535eb59SGordon Tetlow	man_parse_args "$@"
859c535eb59SGordon Tetlow	if [ -z "$pages" ]; then
860c535eb59SGordon Tetlow		echo 'What manual page do you want?' >&2
861c535eb59SGordon Tetlow		exit 1
862c535eb59SGordon Tetlow	fi
863c535eb59SGordon Tetlow	man_setup
864c535eb59SGordon Tetlow
865c535eb59SGordon Tetlow	for page in $pages; do
866c535eb59SGordon Tetlow		decho "Searching for $page"
867c535eb59SGordon Tetlow		man_find_and_display "$page"
868c535eb59SGordon Tetlow	done
869c535eb59SGordon Tetlow
870c535eb59SGordon Tetlow	exit ${ret:-0}
871c535eb59SGordon Tetlow}
872c535eb59SGordon Tetlow
873c535eb59SGordon Tetlowdo_manpath() {
874c535eb59SGordon Tetlow	manpath_parse_args "$@"
875c535eb59SGordon Tetlow	if [ -z "$qflag" ]; then
876c535eb59SGordon Tetlow		manpath_warnings
877c535eb59SGordon Tetlow	fi
878c535eb59SGordon Tetlow	if [ -n "$Lflag" ]; then
879c535eb59SGordon Tetlow		build_manlocales
880c535eb59SGordon Tetlow		echo $MANLOCALES
881c535eb59SGordon Tetlow	else
882c535eb59SGordon Tetlow		build_manpath
883c535eb59SGordon Tetlow		echo $MANPATH
884c535eb59SGordon Tetlow	fi
885c535eb59SGordon Tetlow	exit 0
886c535eb59SGordon Tetlow}
887c535eb59SGordon Tetlow
888c535eb59SGordon Tetlowdo_whatis() {
889c535eb59SGordon Tetlow	search_whatis whatis "$@"
890c535eb59SGordon Tetlow}
891c535eb59SGordon Tetlow
892c535eb59SGordon TetlowEQN=/usr/bin/eqn
893c535eb59SGordon TetlowCOL=/usr/bin/col
894*deeff310SGordon TetlowLOCALE=/usr/bin/locale
895c535eb59SGordon TetlowNROFF='/usr/bin/groff -S -Wall -mtty-char -man'
896c535eb59SGordon TetlowPIC=/usr/bin/pic
89782db8a5eSGordon TetlowSYSCTL=/sbin/sysctl
898c535eb59SGordon TetlowTBL=/usr/bin/tbl
899c535eb59SGordon TetlowTROFF='/usr/bin/groff -S -man'
900c535eb59SGordon TetlowREFER=/usr/bin/refer
901c535eb59SGordon TetlowVGRIND=/usr/bin/vgrind
902c535eb59SGordon Tetlow
903c535eb59SGordon Tetlowdebug=0
904c535eb59SGordon Tetlowman_default_sections='1:1aout:8:2:3:n:4:5:6:7:9:l'
905c535eb59SGordon Tetlowman_default_path='/usr/share/man:/usr/share/openssl/man:/usr/local/man'
90657cd9717SGordon Tetlowcattool='/usr/bin/zcat -f'
907c535eb59SGordon Tetlow
908c535eb59SGordon Tetlowconfig_global='/etc/man.conf'
909c535eb59SGordon Tetlow
910c535eb59SGordon Tetlow# This can be overridden via a setting in /etc/man.conf.
911c535eb59SGordon Tetlowconfig_local='/usr/local/etc/man.d/*.conf'
912c535eb59SGordon Tetlow
913c535eb59SGordon Tetlow# Set noglobbing for now. I don't want spurious globbing.
914c535eb59SGordon Tetlowset -f
915c535eb59SGordon Tetlow
916c535eb59SGordon Tetlowcase "$0" in
917c535eb59SGordon Tetlow*apropos)	do_apropos "$@" ;;
918c535eb59SGordon Tetlow*manpath)	do_manpath "$@" ;;
919c535eb59SGordon Tetlow*whatis)	do_whatis "$@" ;;
920c535eb59SGordon Tetlow*)		do_man "$@" ;;
921c535eb59SGordon Tetlowesac
922