2 .\" Copyright (c) 2010 Gordon Tetlow
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .Nd display online manual documentation pages
41 .Op Fl m Ar arch Ns Op : Ns Ar machine
54 utility finds and displays online manual documentation pages.
59 restricts the search to the specific section of the manual.
64 .Bl -tag -width indent
66 Forces a specific colon separated manual path instead of the default
77 if color support is enabled, or
81 environment variable, which in turn overrides the
85 Restricts manual sections searched to the specified colon delimited list.
87 .Dq Li 1:1aout:8:2:3:n:4:5:6:7:9:l .
92 Display all manual pages instead of just the first found for each
96 Print extra debugging information.
97 Repeat for increased verbosity.
98 Does not display the manual page.
103 Display short help message and exit.
107 .It Fl m Ar arch Ns Op : Ns Ar machine
108 Override the default architecture and machine settings allowing lookup of
109 other platform specific manual pages.
111 .Sx IMPLEMENTATION NOTES
112 for how this option changes the default behavior.
117 environment variables.
119 Force use of non-localized manual pages.
121 .Sx IMPLEMENTATION NOTES
122 for how locale specific searches work.
124 .Ev LC_ALL , LC_CTYPE ,
127 environment variables.
129 Use the list of given preprocessors before running
133 Valid preprocessors arguments:
135 .Bl -tag -width indent -compact
150 environment variable.
152 Send manual page source through
154 allowing transformation of the manual pages to other formats.
156 Display the location of the manual page instead of the contents of
159 .Sh IMPLEMENTATION NOTES
160 .Ss Locale Specific Searches
163 utility supports manual pages in different locales.
164 The search behavior is dictated by the first of three
165 environment variables with a nonempty string:
166 .Ev LC_ALL , LC_CTYPE ,
171 will search for locale specific manual pages using the following logic:
173 .Bl -item -offset indent -compact
175 .Va lang Ns _ Ns Va country Ns . Ns Va charset
177 .Va lang Ns . Ns Va charset
179 .Li en Ns . Ns Va charset
187 will search the following paths when considering section 1 manual pages in
190 .Bl -item -offset indent -compact
192 .Pa /usr/share/man/ja_JP.eucJP/man1
194 .Pa /usr/share/man/ja.eucJP/man1
196 .Pa /usr/share/man/en.eucJP/man1
198 .Pa /usr/share/man/man1
200 .Ss Platform Specific Searches
203 utility supports platform specific manual pages.
204 The search behavior is dictated by the
210 environment variables.
220 will search the following paths when considering section 4 manual pages in
223 .Bl -item -offset indent -compact
225 .Pa /usr/share/man/man4/pc98
227 .Pa /usr/share/man/man4/i386
229 .Pa /usr/share/man/man4
231 .Ss Displaying Specific Manual Files
234 utility also supports displaying a specific manual page if passed a path
235 to the file as long as it contains a
239 The following environment variables affect the execution of
241 .Bl -tag -width ".Ev MANROFFSEQ"
242 .It Ev LC_ALL , LC_CTYPE , LANG
243 Used to find locale specific manual pages.
244 Valid values can be found by running the
248 .Sx IMPLEMENTATION NOTES
253 .It Ev MACHINE_ARCH , MACHINE
254 Used to find platform specific manual pages.
255 If unset, the output of
256 .Dq Li "sysctl hw.machine_arch"
258 .Dq Li "sysctl hw.machine"
259 is used respectively.
261 .Sx IMPLEMENTATION NOTES
267 Used to find the location of the manual files.
270 for additional information.
275 Used to determine the preprocessors for the manual source before running
279 If unset, defaults to
285 Restricts manual sections searched to the specified colon delimited list.
290 If set to a numeric value, used as the width manpages should be displayed.
291 Otherwise, if set to a special value
293 and output is to a terminal,
294 the pages may be displayed over the whole width of the screen.
296 If set, enables color support.
298 Program used to display files.
300 If unset, and color support is enabled,
304 If unset, and color support is disabled, then
307 If that has no value either,
312 .Bl -tag -width indent -compact
314 System configuration file.
315 .It Pa /usr/local/etc/man.d/*.conf
316 Local configuration files.