/
man.sh
executable file
·1310 lines (1164 loc) · 27.1 KB
/
man.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#! /bin/sh
#
# SPDX-License-Identifier: BSD-2-Clause-FreeBSD
#
# Copyright (c) 2010 Gordon Tetlow
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
# $FreeBSD$
# Usage: add_to_manpath path
# Adds a variable to manpath while ensuring we don't have duplicates.
# Returns true if we were able to add something. False otherwise.
add_to_manpath() {
case "$manpath" in
*:$1) decho " Skipping duplicate manpath entry $1" 2 ;;
$1:*) decho " Skipping duplicate manpath entry $1" 2 ;;
*:$1:*) decho " Skipping duplicate manpath entry $1" 2 ;;
*) if [ -d "$1" ]; then
decho " Adding $1 to manpath"
manpath="$manpath:$1"
return 0
fi
;;
esac
return 1
}
# Usage: build_manlocales
# Builds a correct MANLOCALES variable.
build_manlocales() {
# If the user has set manlocales, who are we to argue.
if [ -n "$MANLOCALES" ]; then
return
fi
parse_configs
# Trim leading colon
MANLOCALES=${manlocales#:}
decho "Available manual locales: $MANLOCALES"
}
# Usage: build_manpath
# Builds a correct MANPATH variable.
build_manpath() {
local IFS
# If the user has set a manpath, who are we to argue.
if [ -n "$MANPATH" ]; then
case "$MANPATH" in
*:) PREPEND_MANPATH=${MANPATH} ;;
:*) APPEND_MANPATH=${MANPATH} ;;
*::*)
PREPEND_MANPATH=${MANPATH%%::*}
APPEND_MANPATH=${MANPATH#*::}
;;
*) return ;;
esac
fi
if [ -n "$PREPEND_MANPATH" ]; then
IFS=:
for path in $PREPEND_MANPATH; do
add_to_manpath "$path"
done
unset IFS
fi
search_path
#ifdef __APPLE__
xcode_path
#endif
decho "Adding default manpath entries"
IFS=:
for path in $man_default_path; do
add_to_manpath "$path"
done
unset IFS
parse_configs
if [ -n "$APPEND_MANPATH" ]; then
IFS=:
for path in $APPEND_MANPATH; do
add_to_manpath "$path"
done
unset IFS
fi
# Trim leading colon
MANPATH=${manpath#:}
decho "Using manual path: $MANPATH"
}
# Usage: check_cat catglob
# Checks to see if a cat glob is available.
check_cat() {
if exists "$1"; then
use_cat=yes
catpage=$found
setup_cattool $catpage
decho " Found catpage $catpage"
return 0
else
return 1
fi
}
# Usage: check_man manglob catglob
# Given 2 globs, figures out if the manglob is available, if so, check to
# see if the catglob is also available and up to date.
check_man() {
if exists "$1"; then
# We have a match, check for a cat page
manpage=$found
setup_cattool $manpage
decho " Found manpage $manpage"
if [ -n "${use_width}" ]; then
# non-standard width
unset use_cat
decho " Skipping catpage: non-standard page width"
elif exists "$2" && is_newer $found $manpage; then
# cat page found and is newer, use that
use_cat=yes
catpage=$found
setup_cattool $catpage
decho " Using catpage $catpage"
else
# no cat page or is older
unset use_cat
decho " Skipping catpage: not found or old"
fi
return 0
fi
return 1
}
# Usage: decho "string" [debuglevel]
# Echoes to stderr string prefaced with -- if high enough debuglevel.
decho() {
if [ $debug -ge ${2:-1} ]; then
echo "-- $1" >&2
fi
}
# Usage: exists glob
# Returns true if glob resolves to a real file.
exists() {
local IFS
# Don't accidentally inherit callers IFS (breaks perl manpages)
unset IFS
# Use some globbing tricks in the shell to determine if a file
# exists or not.
set +f
set -- "$1" $1
set -f
if [ "$1" != "$2" -a -r "$2" ]; then
found="$2"
return 0
fi
return 1
}
# Usage: find_file path section subdir pagename
# Returns: true if something is matched and found.
# Search the given path/section combo for a given page.
find_file() {
local manroot catroot mann man0 catn cat0
manroot="$1/man$2"
catroot="$1/cat$2"
if [ -n "$3" ]; then
manroot="$manroot/$3"
catroot="$catroot/$3"
fi
if [ ! -d "$manroot" -a ! -d "$catroot" ]; then
return 1
fi
decho " Searching directory $manroot" 2
mann="$manroot/$4.$2*"
man0="$manroot/$4.0*"
catn="$catroot/$4.$2*"
cat0="$catroot/$4.0*"
# This is the behavior as seen by the original man utility.
# Let's not change that which doesn't seem broken.
if check_man "$mann" "$catn"; then
return 0
elif check_man "$man0" "$cat0"; then
return 0
elif check_cat "$catn"; then
return 0
elif check_cat "$cat0"; then
return 0
fi
return 1
}
# Usage: is_newer file1 file2
# Returns true if file1 is newer than file2 as calculated by mtime.
is_newer() {
if ! [ "$1" -ot "$2" ]; then
decho " mtime: $1 not older than $2" 3
return 0
else
decho " mtime: $1 older than $2" 3
return 1
fi
}
# Usage: manpath_parse_args "$@"
# Parses commandline options for manpath.
manpath_parse_args() {
local cmd_arg
OPTIND=1
while getopts 'Ldq' cmd_arg; do
case "${cmd_arg}" in
L) Lflag=Lflag ;;
d) debug=$(( $debug + 1 )) ;;
q) qflag=qflag ;;
*) manpath_usage ;;
esac
done >&2
}
# Usage: manpath_usage
# Display usage for the manpath(1) utility.
manpath_usage() {
echo 'usage: manpath [-Ldq]' >&2
exit 1
}
# Usage: manpath_warnings
# Display some warnings to stderr.
manpath_warnings() {
if [ -n "$Lflag" -a -n "$MANLOCALES" ]; then
echo "(Warning: MANLOCALES environment variable set)" >&2
fi
}
# Usage: man_check_for_so page path
# Returns: True if able to resolve the file, false if it ended in tears.
# Detects the presence of the .so directive and causes the file to be
# redirected to another source file.
man_check_for_so() {
local IFS line tstr
unset IFS
if [ -n "$catpage" ]; then
return 0
fi
# We need to loop to accommodate multiple .so directives.
while true
do
#ifdef __APPLE__
line=$($cattool "$manpage" | head -1)
#else
# line=$($cattool $manpage | head -1)
#endif
case "$line" in
.so*) trim "${line#.so}"
decho "$manpage includes $tstr"
# Glob and check for the file.
if ! check_man "$path/$tstr*" ""; then
decho " Unable to find $tstr"
return 1
fi
;;
*) break ;;
esac
done
return 0
}
#ifdef __APPLE__
# Usage: man_display_page path
#else
# Usage: man_display_page
#endif
# Display either the manpage or catpage depending on the use_cat variable
man_display_page() {
#ifdef __APPLE__
local IFS path pipeline testline
#else
# local IFS pipeline testline
#endif
# We are called with IFS set to colon. This causes really weird
# things to happen for the variables that have spaces in them.
unset IFS
#ifdef __APPLE__
path=$1
#endif
# If we are supposed to use a catpage and we aren't using troff(1)
# just zcat the catpage and we are done.
if [ -z "$tflag" -a -n "$use_cat" ]; then
if [ -n "$wflag" ]; then
echo "$catpage (source: $manpage)"
ret=0
else
if [ $debug -gt 0 ]; then
#ifdef __APPLE__
decho "Command: $cattool \"$catpage\" | $MANPAGER"
#else
# decho "Command: $cattool $catpage | $MANPAGER"
#endif
ret=0
else
#ifdef __APPLE__
eval "$cattool \"$catpage\" | $MANPAGER"
#else
# eval "$cattool $catpage | $MANPAGER"
#endif
ret=$?
fi
fi
return
fi
# Okay, we are using the manpage, do we just need to output the
# name of the manpage?
if [ -n "$wflag" ]; then
echo "$manpage"
ret=0
return
fi
if [ -n "$use_width" ]; then
mandoc_args="-O width=${use_width}"
fi
testline="mandoc -Tlint -Wunsupp >/dev/null 2>&1"
if [ -n "$tflag" ]; then
pipeline="mandoc -Tps $mandoc_args"
else
pipeline="mandoc $mandoc_args | $MANPAGER"
fi
#ifdef __APPLE__
if ! eval "$cattool \"$manpage\" | $testline" ;then
#else
# if ! eval "$cattool $manpage | $testline" ;then
#endif
if which -s groff; then
#ifdef __APPLE__
man_display_page_groff $path
#else
# man_display_page_groff
#endif
else
#ifdef __APPLE__
echo "This manpage is not compatible with mandoc(1) and might display incorrectly." >&2
# Leave sufficient time to note the above warning.
sleep 1
#else
# echo "This manpage needs groff(1) to be rendered" >&2
# echo "First install groff(1): " >&2
# echo "pkg install groff " >&2
# ret=1
#endif
fi
#ifndef __APPLE__
# return
#endif
fi
if [ $debug -gt 0 ]; then
#ifdef __APPLE__
decho "Command: cd $path && $cattool \"$manpage\" | $pipeline"
#else
# decho "Command: $cattool $manpage | $pipeline"
#endif
ret=0
else
#ifdef __APPLE__
(cd $path && eval "$cattool \"$manpage\" | $pipeline")
#else
# eval "$cattool $manpage | $pipeline"
#endif
ret=$?
fi
}
#ifdef __APPLE__
# Usage: man_display_page_groff path
#else
# Usage: man_display_page_groff
#endif
# Display the manpage using groff
man_display_page_groff() {
#ifdef __APPLE__
local IFS l nroff_dev path pipeline preproc_arg tool
#else
# local EQN NROFF PIC TBL TROFF REFER VGRIND
# local IFS l nroff_dev pipeline preproc_arg tool
#endif
#ifdef __APPLE__
path=$1
#endif
# So, we really do need to parse the manpage. First, figure out the
# device flag (-T) we have to pass to eqn(1) and groff(1). Then,
# setup the pipeline of commands based on the user's request.
# If the manpage is from a particular charset, we need to setup nroff
# to properly output for the correct device.
case "${manpage}" in
*.${man_charset}/*)
# I don't pretend to know this; I'm just copying from the
# previous version of man(1).
case "$man_charset" in
KOI8-R) nroff_dev="koi8-r" ;;
ISO8859-1) nroff_dev="latin1" ;;
ISO8859-15) nroff_dev="latin1" ;;
UTF-8) nroff_dev="utf8" ;;
*) nroff_dev="ascii" ;;
esac
NROFF="$NROFF -T$nroff_dev"
EQN="$EQN -T$nroff_dev"
# Iff the manpage is from the locale and not just the charset,
# then we need to define the locale string.
case "${manpage}" in
*/${man_lang}_${man_country}.${man_charset}/*)
NROFF="$NROFF -dlocale=$man_lang.$man_charset"
;;
*/${man_lang}.${man_charset}/*)
NROFF="$NROFF -dlocale=$man_lang.$man_charset"
;;
esac
# Allow language specific calls to override the default
# set of utilities.
l=$(echo $man_lang | tr [:lower:] [:upper:])
for tool in EQN NROFF PIC TBL TROFF REFER VGRIND; do
eval "$tool=\${${tool}_$l:-\$$tool}"
done
;;
*) NROFF="$NROFF -Tascii"
EQN="$EQN -Tascii"
;;
esac
if [ -z "$MANCOLOR" ]; then
NROFF="$NROFF -P-c"
fi
if [ -n "${use_width}" ]; then
NROFF="$NROFF -rLL=${use_width}n -rLT=${use_width}n"
fi
if [ -n "$MANROFFSEQ" ]; then
set -- -$MANROFFSEQ
OPTIND=1
while getopts 'egprtv' preproc_arg; do
case "${preproc_arg}" in
e) pipeline="$pipeline | $EQN" ;;
g) ;; # Ignore for compatibility.
p) pipeline="$pipeline | $PIC" ;;
r) pipeline="$pipeline | $REFER" ;;
t) pipeline="$pipeline | $TBL" ;;
v) pipeline="$pipeline | $VGRIND" ;;
*) usage ;;
esac
done
# Strip the leading " | " from the resulting pipeline.
pipeline="${pipeline#" | "}"
else
pipeline="$TBL"
fi
if [ -n "$tflag" ]; then
pipeline="$pipeline | $TROFF"
else
pipeline="$pipeline | $NROFF | $MANPAGER"
fi
if [ $debug -gt 0 ]; then
#ifdef __APPLE_
decho "Command: cd $path && $cattool \"$manpage\" | $pipeline"
#else
# decho "Command: $cattool $manpage | $pipeline"
#endif
ret=0
else
#ifdef __APPLE__
(cd $path && eval "$cattool \"$manpage\" | $pipeline")
#else
# eval "$cattool $manpage | $pipeline"
#endif
ret=$?
fi
}
# Usage: man_find_and_display page
# Search through the manpaths looking for the given page.
man_find_and_display() {
local found_page locpath p path sect
# Check to see if it's a file. But only if it has a '/' in
# the filename.
case "$1" in
*/*) if [ -f "$1" -a -r "$1" ]; then
decho "Found a usable page, displaying that"
unset use_cat
manpage="$1"
#ifdef __APPLE__
path=$(dirname "$manpage")
setup_cattool "$manpage"
if man_check_for_so "$manpage" "$path"; then
#else
# setup_cattool $manpage
# if man_check_for_so $manpage $(dirname $manpage); then
#endif
found_page=yes
#ifdef __APPLE__
manpage=$(realpath "$manpage")
man_display_page "$path"
#else
# man_display_page
#endif
fi
return
fi
;;
esac
IFS=:
for sect in $MANSECT; do
decho "Searching section $sect" 2
for path in $MANPATH; do
for locpath in $locpaths; do
p=$path/$locpath
p=${p%/.} # Rid ourselves of the trailing /.
# Check if there is a MACHINE specific manpath.
#ifndef __APPLE__
# if find_file $p $sect $MACHINE "$1"; then
# if man_check_for_so $manpage $p; then
# found_page=yes
# man_display_page
# if [ -n "$aflag" ]; then
# continue 2
# else
# return
# fi
# fi
# fi
#endif
# Check if there is a MACHINE_ARCH
# specific manpath.
#ifndef __APPLE__
# if find_file $p $sect $MACHINE_ARCH "$1"; then
# if man_check_for_so $manpage $p; then
# found_page=yes
# man_display_page
# if [ -n "$aflag" ]; then
# continue 2
# else
# return
# fi
# fi
# fi
#endif
# Check plain old manpath.
if find_file $p $sect '' "$1"; then
if man_check_for_so $manpage $p; then
found_page=yes
#ifdef __APPLE__
man_display_page $p
#else
# man_display_page
#endif
if [ -n "$aflag" ]; then
continue 2
else
return
fi
fi
fi
done
done
done
unset IFS
# Nothing? Well, we are done then.
if [ -z "$found_page" ]; then
echo "No manual entry for $1" >&2
ret=1
return
fi
}
# Usage: man_parse_args "$@"
# Parses commandline options for man.
man_parse_args() {
local IFS cmd_arg
OPTIND=1
#ifdef __APPLE__
while getopts 'C:M:P:S:adfhkm:op:tw' cmd_arg; do
#else
# while getopts 'M:P:S:adfhkm:op:tw' cmd_arg; do
#endif
case "${cmd_arg}" in
#ifdef __APPLE__
C) config_global=$OPTARG ;;
#endif
M) MANPATH=$OPTARG ;;
#ifdef __APPLE__
P) MANPAGER=$OPTARG; WHATISPAGER=$OPTARG ;;
#else
# P) MANPAGER=$OPTARG ;;
#endif
S) MANSECT=$OPTARG ;;
a) aflag=aflag ;;
d) debug=$(( $debug + 1 )) ;;
f) fflag=fflag ;;
h) man_usage 0 ;;
k) kflag=kflag ;;
#ifdef __APPLE__
m) ;;
#else
# m) mflag=$OPTARG ;;
#endif
o) oflag=oflag ;;
p) MANROFFSEQ=$OPTARG ;;
t) tflag=tflag ;;
w) wflag=wflag ;;
*) man_usage ;;
esac
done >&2
shift $(( $OPTIND - 1 ))
# Check the args for incompatible options.
case "${fflag}${kflag}${tflag}${wflag}" in
fflagkflag*) echo "Incompatible options: -f and -k"; man_usage ;;
fflag*tflag*) echo "Incompatible options: -f and -t"; man_usage ;;
fflag*wflag) echo "Incompatible options: -f and -w"; man_usage ;;
*kflagtflag*) echo "Incompatible options: -k and -t"; man_usage ;;
*kflag*wflag) echo "Incompatible options: -k and -w"; man_usage ;;
*tflagwflag) echo "Incompatible options: -t and -w"; man_usage ;;
esac
# Short circuit for whatis(1) and apropos(1)
if [ -n "$fflag" ]; then
do_whatis "$@"
exit
fi
if [ -n "$kflag" ]; then
do_apropos "$@"
exit
fi
IFS=:
for sect in $man_default_sections; do
if [ "$sect" = "$1" ]; then
decho "Detected manual section as first arg: $1"
MANSECT="$1"
shift
break
fi
done
unset IFS
#ifdef __APPLE__
# Convoluted to simplify later handling of these path args; just
# expanding $* into $pages won't DTRT, we'll break up args with internal
# spaces. Sidestep it entirely by instead shuffling the remainder of
# our args over into a newline-delimited $pages, which we can then
# process through with read.
nl=$'\n'
for i in $(seq 1 $#); do
eval page=\"\${${i}}\"
if [ "${i}" -gt 1 ]; then
pages="${pages}${nl}"
fi
pages="${pages}${page}"
done
#else
# pages="$*"
#endif
}
# Usage: man_setup
# Setup various trivial but essential variables.
man_setup() {
# Setup machine and architecture variables.
#ifndef __APPLE__
# if [ -n "$mflag" ]; then
# MACHINE_ARCH=${mflag%%:*}
# MACHINE=${mflag##*:}
# fi
# if [ -z "$MACHINE_ARCH" ]; then
# MACHINE_ARCH=$($SYSCTL -n hw.machine_arch)
# fi
# if [ -z "$MACHINE" ]; then
# MACHINE=$($SYSCTL -n hw.machine)
# fi
# decho "Using architecture: $MACHINE_ARCH:$MACHINE"
#endif
setup_pager
# Setup manual sections to search.
if [ -z "$MANSECT" ]; then
MANSECT=$man_default_sections
fi
decho "Using manual sections: $MANSECT"
build_manpath
man_setup_locale
man_setup_width
}
# Usage: man_setup_width
# Set up page width.
man_setup_width() {
local sizes
unset use_width
#ifdef __APPLE__
if [ -z "$MANWIDTH" -a -t 0 -a -t 1 ]; then
MANWIDTH=tty
fi
#endif
case "$MANWIDTH" in
[0-9]*)
if [ "$MANWIDTH" -gt 0 2>/dev/null ]; then
use_width=$MANWIDTH
fi
;;
[Tt][Tt][Yy])
if { sizes=$($STTY size 0>&3 2>/dev/null); } 3>&1; then
set -- $sizes
if [ $2 -gt 80 ]; then
use_width=$(($2-2))
fi
fi
;;
esac
if [ -n "$use_width" ]; then
decho "Using non-standard page width: ${use_width}"
else
decho 'Using standard page width'
fi
}
# Usage: man_setup_locale
# Setup necessary locale variables.
man_setup_locale() {
local lang_cc
local locstr
locpaths='.'
man_charset='US-ASCII'
# Setup locale information.
if [ -n "$oflag" ]; then
decho 'Using non-localized manpages'
else
# Use the locale tool to give us proper locale information
eval $( $LOCALE )
if [ -n "$LANG" ]; then
locstr=$LANG
else
locstr=$LC_CTYPE
fi
case "$locstr" in
C) ;;
C.UTF-8) ;;
POSIX) ;;
[a-z][a-z]_[A-Z][A-Z]\.*)
lang_cc="${locstr%.*}"
man_lang="${locstr%_*}"
man_country="${lang_cc#*_}"
man_charset="${locstr#*.}"
locpaths="$locstr"
locpaths="$locpaths:$man_lang.$man_charset"
if [ "$man_lang" != "en" ]; then
locpaths="$locpaths:en.$man_charset"
fi
locpaths="$locpaths:."
;;
*) echo 'Unknown locale, assuming C' >&2
;;
esac
fi
decho "Using locale paths: $locpaths"
}
# Usage: man_usage [exitcode]
# Display usage for the man utility.
man_usage() {
echo 'Usage:'
echo ' man [-adho] [-t | -w] [-M manpath] [-P pager] [-S mansect]'
echo ' [-m arch[:machine]] [-p [eprtv]] [mansect] page [...]'
echo ' man -f page [...] -- Emulates whatis(1)'
echo ' man -k page [...] -- Emulates apropos(1)'
#ifdef __APPLE__
# rdar://problem/86345977 - conformance failure, and returning failure
# from here is a valid approach that other utilities take as well.
exit 1
#else
# When exit'ing with -h, it's not an error.
# exit ${1:-1}
#endif
}
# Usage: parse_configs
# Reads the end-user adjustable config files.
parse_configs() {
local IFS file files
if [ -n "$parsed_configs" ]; then
return
fi
unset IFS
# Read the global config first in case the user wants
# to override config_local.
if [ -r "$config_global" ]; then
parse_file "$config_global"
fi
# Glob the list of files to parse.
set +f
files=$(echo $config_local)
set -f
for file in $files; do
if [ -r "$file" ]; then
parse_file "$file"
fi
done
parsed_configs='yes'
}
# Usage: parse_file file
# Reads the specified config files.
parse_file() {
local file line tstr var
file="$1"
decho "Parsing config file: $file"
while read line; do
decho " $line" 2
case "$line" in
\#*) decho " Comment" 3
;;
MANPATH*) decho " MANPATH" 3
trim "${line#MANPATH}"
add_to_manpath "$tstr"
;;
MANLOCALE*) decho " MANLOCALE" 3
trim "${line#MANLOCALE}"
manlocales="$manlocales:$tstr"
;;
MANCONFIG*) decho " MANCONFIG" 3
trim "${line#MANCONFIG}"
config_local="$tstr"
;;
#ifdef __APPLE__
MANSECT*) decho " MANSECT" 3
trim "${line#MANSECT}"
man_default_sections="$tstr"
;;
# Assume every other line describes a variable
*[\ \ ]*) var="${line%%[\ \ ]*}"
#else
# # Set variables in the form of FOO_BAR
# *_*[\ \ ]*) var="${line%%[\ \ ]*}"
#endif
trim "${line#$var}"
eval "$var=\"$tstr\""
decho " Parsed $var" 3
;;
esac
done < "$file"
}
#ifdef __APPLE__
xcode_path() {
local mpath xmanpaths
xmanpaths=$(xcode-select --show-manpaths 2>/dev/null)
if [ -n "$xmanpaths" ]; then
for mpath in $xmanpaths; do
add_to_manpath "$mpath"
done
fi
}
#endif
# Usage: search_path
# Traverse $PATH looking for manpaths.
search_path() {
local IFS p path
decho "Searching PATH for man directories"
IFS=:
for path in $PATH; do
if add_to_manpath "$path/man"; then
:
elif add_to_manpath "$path/MAN"; then
:
else
case "$path" in
*/bin) p="${path%/bin}/share/man"
add_to_manpath "$p"
p="${path%/bin}/man"
add_to_manpath "$p"
;;
esac
fi
done
unset IFS
if [ -z "$manpath" ]; then
decho ' Unable to find any manpaths, using default'
manpath=$man_default_path
fi
}
# Usage: search_whatis cmd [arglist]
# Do the heavy lifting for apropos/whatis
search_whatis() {
local IFS bad cmd f good key keywords loc opt out path rval wlist
#ifdef __APPLE__
local localwlist
#endif
cmd="$1"
shift
whatis_parse_args "$@"
build_manpath
build_manlocales
setup_pager
if [ "$cmd" = "whatis" ]; then
opt="-w"
fi
f='whatis'
#ifdef __APPLE__
localwlist=''
#endif