3 # Copyright (c) 2010 Gordon Tetlow
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
9 # 1. Redistributions of source code must retain the above copyright
10 # notice, this list of conditions and the following disclaimer.
11 # 2. Redistributions in binary form must reproduce the above copyright
12 # notice, this list of conditions and the following disclaimer in the
13 # documentation and/or other materials provided with the distribution.
15 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 # ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 # Usage: add_to_manpath path
30 # Adds a variable to manpath while ensuring we don't have duplicates.
31 # Returns true if we were able to add something. False otherwise.
34 *:$1) decho " Skipping duplicate manpath entry $1" 2 ;;
35 $1:*) decho " Skipping duplicate manpath entry $1" 2 ;;
36 *:$1:*) decho " Skipping duplicate manpath entry $1" 2 ;;
37 *) if [ -d "$1" ]; then
38 decho " Adding $1 to manpath"
48 # Usage: build_manlocales
49 # Builds a correct MANLOCALES variable.
51 # If the user has set manlocales, who are we to argue.
52 if [ -n "$MANLOCALES" ]; then
59 MANLOCALES=${manlocales#:}
61 decho "Available manual locales: $MANLOCALES"
64 # Usage: build_manpath
65 # Builds a correct MANPATH variable.
69 # If the user has set a manpath, who are we to argue.
70 if [ -n "$MANPATH" ]; then
76 decho "Adding default manpath entries"
78 for path in $man_default_path; do
79 add_to_manpath "$path"
88 decho "Using manual path: $MANPATH"
91 # Usage: check_cat catglob
92 # Checks to see if a cat glob is available.
97 setup_cattool $catpage
98 decho " Found catpage $catpage"
105 # Usage: check_man manglob catglob
106 # Given 2 globs, figures out if the manglob is available, if so, check to
107 # see if the catglob is also available and up to date.
110 # We have a match, check for a cat page
112 setup_cattool $manpage
113 decho " Found manpage $manpage"
115 if [ -n "${use_width}" ]; then
118 decho " Skipping catpage: non-standard page width"
119 elif exists "$2" && is_newer $found $manpage; then
120 # cat page found and is newer, use that
123 setup_cattool $catpage
124 decho " Using catpage $catpage"
126 # no cat page or is older
128 decho " Skipping catpage: not found or old"
136 # Usage: decho "string" [debuglevel]
137 # Echoes to stderr string prefaced with -- if high enough debuglevel.
139 if [ $debug -ge ${2:-1} ]; then
145 # Returns true if glob resolves to a real file.
149 # Don't accidentally inherit callers IFS (breaks perl manpages)
152 # Use some globbing tricks in the shell to determine if a file
158 if [ "$1" != "$2" -a -r "$2" ]; then
166 # Usage: find_file path section subdir pagename
167 # Returns: true if something is matched and found.
168 # Search the given path/section combo for a given page.
170 local manroot catroot mann man0 catn cat0
175 manroot="$manroot/$3"
176 catroot="$catroot/$3"
179 if [ ! -d "$manroot" -a ! -d "$catroot" ]; then
182 decho " Searching directory $manroot" 2
184 mann="$manroot/$4.$2*"
185 man0="$manroot/$4.0*"
186 catn="$catroot/$4.$2*"
187 cat0="$catroot/$4.0*"
189 # This is the behavior as seen by the original man utility.
190 # Let's not change that which doesn't seem broken.
191 if check_man "$mann" "$catn"; then
193 elif check_man "$man0" "$cat0"; then
195 elif check_cat "$catn"; then
197 elif check_cat "$cat0"; then
204 # Usage: is_newer file1 file2
205 # Returns true if file1 is newer than file2 as calculated by mtime.
207 if ! [ "$1" -ot "$2" ]; then
208 decho " mtime: $1 not older than $2" 3
211 decho " mtime: $1 older than $2" 3
216 # Usage: manpath_parse_args "$@"
217 # Parses commandline options for manpath.
218 manpath_parse_args() {
221 while getopts 'Ldq' cmd_arg; do
224 d) debug=$(( $debug + 1 )) ;;
231 # Usage: manpath_usage
232 # Display usage for the manpath(1) utility.
234 echo 'usage: manpath [-Ldq]' >&2
238 # Usage: manpath_warnings
239 # Display some warnings to stderr.
241 if [ -z "$Lflag" -a -n "$MANPATH" ]; then
242 echo "(Warning: MANPATH environment variable set)" >&2
245 if [ -n "$Lflag" -a -n "$MANLOCALES" ]; then
246 echo "(Warning: MANLOCALES environment variable set)" >&2
250 # Usage: man_check_for_so page path
251 # Returns: True if able to resolve the file, false if it ended in tears.
252 # Detects the presence of the .so directive and causes the file to be
253 # redirected to another source file.
258 if [ -n "$catpage" ]; then
262 # We need to loop to accommodate multiple .so directives.
265 line=$($cattool $manpage | head -1)
267 .so*) trim "${line#.so}"
268 decho "$manpage includes $tstr"
269 # Glob and check for the file.
270 if ! check_man "$path/$tstr*" ""; then
271 decho " Unable to find $tstr"
282 # Usage: man_display_page
283 # Display either the manpage or catpage depending on the use_cat variable
285 local EQN NROFF PIC TBL TROFF REFER VGRIND
286 local IFS l nroff_dev pipeline preproc_arg tool
288 # We are called with IFS set to colon. This causes really weird
289 # things to happen for the variables that have spaces in them.
292 # If we are supposed to use a catpage and we aren't using troff(1)
293 # just zcat the catpage and we are done.
294 if [ -z "$tflag" -a -n "$use_cat" ]; then
295 if [ -n "$wflag" ]; then
296 echo "$catpage (source: $manpage)"
299 if [ $debug -gt 0 ]; then
300 decho "Command: $cattool $catpage | $MANPAGER"
303 eval "$cattool $catpage | $MANPAGER"
310 # Okay, we are using the manpage, do we just need to output the
311 # name of the manpage?
312 if [ -n "$wflag" ]; then
318 # So, we really do need to parse the manpage. First, figure out the
319 # device flag (-T) we have to pass to eqn(1) and groff(1). Then,
320 # setup the pipeline of commands based on the user's request.
322 # If the manpage is from a particular charset, we need to setup nroff
323 # to properly output for the correct device.
326 # I don't pretend to know this; I'm just copying from the
327 # previous version of man(1).
328 case "$man_charset" in
329 KOI8-R) nroff_dev="koi8-r" ;;
330 ISO8859-1) nroff_dev="latin1" ;;
331 ISO8859-15) nroff_dev="latin1" ;;
332 UTF-8) nroff_dev="utf8" ;;
333 *) nroff_dev="ascii" ;;
336 NROFF="$NROFF -T$nroff_dev"
337 EQN="$EQN -T$nroff_dev"
339 # Iff the manpage is from the locale and not just the charset,
340 # then we need to define the locale string.
342 */${man_lang}_${man_country}.${man_charset}/*)
343 NROFF="$NROFF -dlocale=$man_lang.$man_charset"
345 */${man_lang}.${man_charset}/*)
346 NROFF="$NROFF -dlocale=$man_lang.$man_charset"
350 # Allow language specific calls to override the default
352 l=$(echo $man_lang | tr [:lower:] [:upper:])
353 for tool in EQN NROFF PIC TBL TROFF REFER VGRIND; do
354 eval "$tool=\${${tool}_$l:-\$$tool}"
357 *) NROFF="$NROFF -Tascii"
362 if [ -z "$MANCOLOR" ]; then
366 if [ -n "${use_width}" ]; then
367 NROFF="$NROFF -rLL=${use_width}n -rLT=${use_width}n"
370 if [ -n "$MANROFFSEQ" ]; then
372 while getopts 'egprtv' preproc_arg; do
373 case "${preproc_arg}" in
374 e) pipeline="$pipeline | $EQN" ;;
375 g) ;; # Ignore for compatibility.
376 p) pipeline="$pipeline | $PIC" ;;
377 r) pipeline="$pipeline | $REFER" ;;
378 t) pipeline="$pipeline | $TBL" ;;
379 v) pipeline="$pipeline | $VGRIND" ;;
383 # Strip the leading " | " from the resulting pipeline.
384 pipeline="${pipeline#" | "}"
389 if [ -n "$tflag" ]; then
390 pipeline="$pipeline | $TROFF"
392 pipeline="$pipeline | $NROFF | $MANPAGER"
395 if [ $debug -gt 0 ]; then
396 decho "Command: $cattool $manpage | $pipeline"
399 eval "$cattool $manpage | $pipeline"
404 # Usage: man_find_and_display page
405 # Search through the manpaths looking for the given page.
406 man_find_and_display() {
407 local found_page locpath p path sect
409 # Check to see if it's a file. But only if it has a '/' in
412 */*) if [ -f "$1" -a -r "$1" ]; then
413 decho "Found a usable page, displaying that"
416 setup_cattool $manpage
417 if man_check_for_so $manpage $(dirname $manpage); then
427 for sect in $MANSECT; do
428 decho "Searching section $sect" 2
429 for path in $MANPATH; do
430 for locpath in $locpaths; do
432 p=${p%/.} # Rid ourselves of the trailing /.
434 # Check if there is a MACHINE specific manpath.
435 if find_file $p $sect $MACHINE "$1"; then
436 if man_check_for_so $manpage $p; then
439 if [ -n "$aflag" ]; then
447 # Check if there is a MACHINE_ARCH
449 if find_file $p $sect $MACHINE_ARCH "$1"; then
450 if man_check_for_so $manpage $p; then
453 if [ -n "$aflag" ]; then
461 # Check plain old manpath.
462 if find_file $p $sect '' "$1"; then
463 if man_check_for_so $manpage $p; then
466 if [ -n "$aflag" ]; then
478 # Nothing? Well, we are done then.
479 if [ -z "$found_page" ]; then
480 echo "No manual entry for $1" >&2
486 # Usage: man_parse_args "$@"
487 # Parses commandline options for man.
491 while getopts 'M:P:S:adfhkm:op:tw' cmd_arg; do
493 M) MANPATH=$OPTARG ;;
494 P) MANPAGER=$OPTARG ;;
495 S) MANSECT=$OPTARG ;;
497 d) debug=$(( $debug + 1 )) ;;
503 p) MANROFFSEQ=$OPTARG ;;
510 shift $(( $OPTIND - 1 ))
512 # Check the args for incompatible options.
513 case "${fflag}${kflag}${tflag}${wflag}" in
514 fflagkflag*) echo "Incompatible options: -f and -k"; man_usage ;;
515 fflag*tflag*) echo "Incompatible options: -f and -t"; man_usage ;;
516 fflag*wflag) echo "Incompatible options: -f and -w"; man_usage ;;
517 *kflagtflag*) echo "Incompatible options: -k and -t"; man_usage ;;
518 *kflag*wflag) echo "Incompatible options: -k and -w"; man_usage ;;
519 *tflagwflag) echo "Incompatible options: -t and -w"; man_usage ;;
522 # Short circuit for whatis(1) and apropos(1)
523 if [ -n "$fflag" ]; then
528 if [ -n "$kflag" ]; then
534 for sect in $man_default_sections; do
535 if [ "$sect" = "$1" ]; then
536 decho "Detected manual section as first arg: $1"
548 # Setup various trivial but essential variables.
550 # Setup machine and architecture variables.
551 if [ -n "$mflag" ]; then
552 MACHINE_ARCH=${mflag%%:*}
555 if [ -z "$MACHINE_ARCH" ]; then
556 MACHINE_ARCH=$($SYSCTL -n hw.machine_arch)
558 if [ -z "$MACHINE" ]; then
559 MACHINE=$($SYSCTL -n hw.machine)
561 decho "Using architecture: $MACHINE_ARCH:$MACHINE"
565 # Setup manual sections to search.
566 if [ -z "$MANSECT" ]; then
567 MANSECT=$man_default_sections
569 decho "Using manual sections: $MANSECT"
576 # Usage: man_setup_width
584 if [ "$MANWIDTH" -gt 0 2>/dev/null ]; then
589 if { sizes=$($STTY size 0>&3 2>/dev/null); } 3>&1; then
591 if [ $2 -gt 80 ]; then
597 if [ -n "$use_width" ]; then
598 decho "Using non-standard page width: ${use_width}"
600 decho 'Using standard page width'
604 # Usage: man_setup_locale
605 # Setup necessary locale variables.
610 man_charset='US-ASCII'
612 # Setup locale information.
613 if [ -n "$oflag" ]; then
614 decho 'Using non-localized manpages'
616 # Use the locale tool to give us the proper LC_CTYPE
622 [a-z][a-z]_[A-Z][A-Z]\.*)
623 lang_cc="${LC_CTYPE%.*}"
624 man_lang="${LC_CTYPE%_*}"
625 man_country="${lang_cc#*_}"
626 man_charset="${LC_CTYPE#*.}"
628 locpaths="$locpaths:$man_lang.$man_charset"
629 if [ "$man_lang" != "en" ]; then
630 locpaths="$locpaths:en.$man_charset"
632 locpaths="$locpaths:."
634 *) echo 'Unknown locale, assuming C' >&2
639 decho "Using locale paths: $locpaths"
642 # Usage: man_usage [exitcode]
643 # Display usage for the man utility.
646 echo ' man [-adho] [-t | -w] [-M manpath] [-P pager] [-S mansect]'
647 echo ' [-m arch[:machine]] [-p [eprtv]] [mansect] page [...]'
648 echo ' man -f page [...] -- Emulates whatis(1)'
649 echo ' man -k page [...] -- Emulates apropos(1)'
651 # When exit'ing with -h, it's not an error.
655 # Usage: parse_configs
656 # Reads the end-user adjustable config files.
660 if [ -n "$parsed_configs" ]; then
666 # Read the global config first in case the user wants
667 # to override config_local.
668 if [ -r "$config_global" ]; then
669 parse_file "$config_global"
672 # Glob the list of files to parse.
674 files=$(echo $config_local)
677 for file in $files; do
678 if [ -r "$file" ]; then
686 # Usage: parse_file file
687 # Reads the specified config files.
689 local file line tstr var
692 decho "Parsing config file: $file"
696 \#*) decho " Comment" 3
698 MANPATH*) decho " MANPATH" 3
699 trim "${line#MANPATH}"
700 add_to_manpath "$tstr"
702 MANLOCALE*) decho " MANLOCALE" 3
703 trim "${line#MANLOCALE}"
704 manlocales="$manlocales:$tstr"
706 MANCONFIG*) decho " MANCONFIG" 3
707 trim "${line#MANCONFIG}"
710 # Set variables in the form of FOO_BAR
711 *_*[\ \ ]*) var="${line%%[\ \ ]*}"
713 eval "$var=\"$tstr\""
714 decho " Parsed $var" 3
721 # Traverse $PATH looking for manpaths.
725 decho "Searching PATH for man directories"
728 for path in $PATH; do
729 # Do a little special casing since the base manpages
730 # are in /usr/share/man instead of /usr/man or /man.
732 /bin|/usr/bin) add_to_manpath "/usr/share/man" ;;
733 *) if add_to_manpath "$path/man"; then
735 elif add_to_manpath "$path/MAN"; then
739 */bin) p="${path%/bin}/man"
750 if [ -z "$manpath" ]; then
751 decho ' Unable to find any manpaths, using default'
752 manpath=$man_default_path
756 # Usage: search_whatis cmd [arglist]
757 # Do the heavy lifting for apropos/whatis
759 local IFS bad cmd f good key keywords loc opt out path rval wlist
764 whatis_parse_args "$@"
770 if [ "$cmd" = "whatis" ]; then
777 for path in $MANPATH; do
778 if [ \! -d "$path" ]; then
779 decho "Skipping non-existent path: $path" 2
783 if [ -f "$path/$f" -a -r "$path/$f" ]; then
784 decho "Found whatis: $path/$f"
785 wlist="$wlist $path/$f"
788 for loc in $MANLOCALES; do
789 if [ -f "$path/$loc/$f" -a -r "$path/$loc/$f" ]; then
790 decho "Found whatis: $path/$loc/$f"
791 wlist="$wlist $path/$loc/$f"
797 if [ -z "$wlist" ]; then
798 echo "$cmd: no whatis databases in $MANPATH" >&2
803 for key in $keywords; do
804 out=$(grep -Ehi $opt -- "$key" $wlist)
805 if [ -n "$out" ]; then
808 bad="$bad\\n$key: nothing appropriate"
813 # Strip leading carriage return.
817 if [ -n "$good" ]; then
818 echo -e "$good" | $MANPAGER
821 if [ -n "$bad" ]; then
828 # Usage: setup_cattool page
829 # Finds an appropriate decompressor based on extension
832 *.bz) cattool='/usr/bin/bzcat' ;;
833 *.bz2) cattool='/usr/bin/bzcat' ;;
834 *.gz) cattool='/usr/bin/zcat' ;;
835 *.lzma) cattool='/usr/bin/lzcat' ;;
836 *.xz) cattool='/usr/bin/xzcat' ;;
837 *) cattool='/usr/bin/zcat -f' ;;
842 # Correctly sets $MANPAGER
845 if [ -z "$MANPAGER" ]; then
846 if [ -n "$MANCOLOR" ]; then
849 if [ -n "$PAGER" ]; then
856 decho "Using pager: $MANPAGER"
860 # Trims whitespace from beginning and end of a variable
865 [\ \ ]*) tstr="${tstr##[\ \ ]}" ;;
866 *[\ \ ]) tstr="${tstr%%[\ \ ]}" ;;
872 # Usage: whatis_parse_args "$@"
873 # Parse commandline args for whatis and apropos.
874 whatis_parse_args() {
876 while getopts 'd' cmd_arg; do
878 d) debug=$(( $debug + 1 )) ;;
883 shift $(( $OPTIND - 1 ))
888 # Usage: whatis_usage
889 # Display usage for the whatis/apropos utility.
891 echo "usage: $cmd [-d] keyword [...]"
899 search_whatis apropos "$@"
904 if [ -z "$pages" ]; then
905 echo 'What manual page do you want?' >&2
910 for page in $pages; do
911 decho "Searching for $page"
912 man_find_and_display "$page"
919 manpath_parse_args "$@"
920 if [ -z "$qflag" ]; then
923 if [ -n "$Lflag" ]; then
934 search_whatis whatis "$@"
937 # User's PATH setting decides on the groff-suite to pick up.
939 NROFF='groff -S -P-h -Wall -mtty-char -man'
943 TROFF='groff -S -man'
946 LOCALE=/usr/bin/locale
951 man_default_sections='1:8:2:3:n:4:5:6:7:9:l'
952 man_default_path='/usr/share/man:/usr/share/openssl/man:/usr/local/man'
953 cattool='/usr/bin/zcat -f'
955 config_global='/etc/man.conf'
957 # This can be overridden via a setting in /etc/man.conf.
958 config_local='/usr/local/etc/man.d/*.conf'
960 # Set noglobbing for now. I don't want spurious globbing.
964 *apropos) do_apropos "$@" ;;
965 *manpath) do_manpath "$@" ;;
966 *whatis) do_whatis "$@" ;;