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
|
.\" Man page for manpath
.\"
.\" Copyright (C), 1995, Graeme W. Wilford. (Wilf.)
.\"
.\" You may distribute under the terms of the GNU General Public
.\" License as specified in the COPYING file that comes with the
.\" man-db distribution.
.\"
.\" Sun Jan 22 22:15:17 GMT 1995 Wilf. (G.Wilford@ee.surrey.ac.uk)
.\"
.pc
.TH %thmanpath% 1 "%date%" "%version%" "Manual pager utils"
.SH NAME
%manpath% \- determine search path for manual pages
.SH SYNOPSIS
.B %manpath%
.RB [\| \-qgdc?V \|]
.RB [\| \-m
.IR system \|[\|,.\|.\|.\|]\|]
.RB [\| \-C
.IR file \|]
.SH DESCRIPTION
If
.RB $ MANPATH
is set,
.B %manpath%
will simply display its contents and issue a warning.
If not,
.B %manpath%
will determine a suitable manual page hierarchy search path and display the
results.
The colon-delimited path is determined using information gained from the
man-db configuration file -
.RI ( "%manpath_config_file%" )
and the user's environment.
.SH OPTIONS
.TP
.if !'po4a'hide' .BR \-q ", " \-\-quiet
Do not issue warnings.
.TP
.if !'po4a'hide' .BR \-d ", " \-\-debug
Print debugging information.
.TP
.if !'po4a'hide' .BR \-c ", " \-\-catpath
Produce a catpath as opposed to a manpath.
Once the manpath is determined,
each path element is converted to its relative catpath.
.TP
.if !'po4a'hide' .BR \-g ", " \-\-global
Produce a manpath consisting of all paths named as `global' within the
man-db configuration file.
.\"
.\" Due to the rather silly limit of 6 args per request in some `native'
.\" *roff compilers, we have do the following to get the two-line
.\" hanging tag on one line. .PP to begin a new paragraph, then the
.\" tag, then .RS (start relative indent), the text, finally .RE
.\" (end relative indent).
.\"
.PP
.B \-m
.I system\c
\|[\|,.\|.\|.\|]\|,
.BI \-\-systems= system\c
\|[\|,.\|.\|.\|]
.RS
If this system has access to other operating system's manual hierarchies,
this option can be used to include them in the output of
.BR %manpath% .
To include NewOS's manual page hierarchies use the option
.B \-m
.BR NewOS .
The
.I system
specified can be a combination of comma delimited operating system names.
To include the native operating system's manual page hierarchies,
the system name
.B man
must be included in the argument string.
This option will override the
.RB $ SYSTEM
environment variable.
.RE
.TP
.BI \-C\ file \fR,\ \fB\-\-config\-file= file
Use this user configuration file rather than the default of
.IR ~/.manpath .
.TP
.if !'po4a'hide' .BR \-? ", " \-\-help
Print a help message and exit.
.TP
.if !'po4a'hide' .BR \-\-usage
Print a short usage message and exit.
.TP
.if !'po4a'hide' .BR \-V ", " \-\-version
Display version information.
.SH ENVIRONMENT
.TP
.if !'po4a'hide' .B MANPATH
If
.RB $ MANPATH
is set,
.B %manpath%
displays its value rather than determining it on the fly.
If
.RB $ MANPATH
is prefixed by a colon, then the value of the variable is appended
to the list determined from the content of the configuration files.
If the colon comes at the end of the value in the variable, then the
determined list is appended to the content of the variable.
If the value of the variable contains a double colon
.RB ( :: ),
then the determined list is inserted in the middle of the value, between
the two colons.
.TP
.if !'po4a'hide' .B SYSTEM
If
.RB $ SYSTEM
is set, it will have the same effect as if it had been specified as the
argument to the
.B \-m
option.
.SH FILES
.TP \w'%manpath_config_file%'u+2n
.if !'po4a'hide' .I %manpath_config_file%
man-db configuration file.
.SH "SEE ALSO"
.if !'po4a'hide' .BR %apropos% (1),
.if !'po4a'hide' .BR %man% (1),
.if !'po4a'hide' .BR %whatis% (1)
.SH AUTHOR
.nf
.if !'po4a'hide' Wilf. (G.Wilford@ee.surrey.ac.uk).
.if !'po4a'hide' Fabrizio Polacco (fpolacco@debian.org).
.if !'po4a'hide' Colin Watson (cjwatson@debian.org).
.fi
|
