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
28 .Dd September 26, 2014
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.
61 The sections of the manual are:
62 .Bl -enum -offset indent -compact
65 General Commands Manual
71 Library Functions Manual
74 Kernel Interfaces Manual
83 Miscellaneous Information Manual
86 System Manager's Manual
89 Kernel Developer's Manual
95 .Bl -tag -width indent
97 Forces a specific colon separated manual path instead of the default
103 environment variable.
108 if color support is enabled, or
112 environment variable, which in turn overrides the
114 environment variable.
116 Restricts manual sections searched to the specified colon delimited list.
118 .Dq Li 1:8:2:3:n:4:5:6:7:9:l .
121 environment variable.
123 Display all manual pages instead of just the first found for each
127 Print extra debugging information.
128 Repeat for increased verbosity.
129 Does not display the manual page.
134 Display short help message and exit.
138 .It Fl m Ar arch Ns Op : Ns Ar machine
139 Override the default architecture and machine settings allowing lookup of
140 other platform specific manual pages.
142 .Sx IMPLEMENTATION NOTES
143 for how this option changes the default behavior.
148 environment variables.
150 Force use of non-localized manual pages.
152 .Sx IMPLEMENTATION NOTES
153 for how locale specific searches work.
155 .Ev LC_ALL , LC_CTYPE ,
158 environment variables.
160 Use the list of given preprocessors before running
164 Valid preprocessors arguments:
166 .Bl -tag -width indent -compact
181 environment variable.
183 Send manual page source through
185 allowing transformation of the manual pages to other formats.
187 Display the location of the manual page instead of the contents of
190 .Sh IMPLEMENTATION NOTES
191 .Ss Locale Specific Searches
194 utility supports manual pages in different locales.
195 The search behavior is dictated by the first of three
196 environment variables with a nonempty string:
197 .Ev LC_ALL , LC_CTYPE ,
202 will search for locale specific manual pages using the following logic:
204 .Bl -item -offset indent -compact
206 .Va lang Ns _ Ns Va country Ns . Ns Va charset
208 .Va lang Ns . Ns Va charset
210 .Li en Ns . Ns Va charset
218 will search the following paths when considering section 1 manual pages in
221 .Bl -item -offset indent -compact
223 .Pa /usr/share/man/ja_JP.eucJP/man1
225 .Pa /usr/share/man/ja.eucJP/man1
227 .Pa /usr/share/man/en.eucJP/man1
229 .Pa /usr/share/man/man1
231 .Ss Platform Specific Searches
234 utility supports platform specific manual pages.
235 The search behavior is dictated by the
241 environment variables.
251 will search the following paths when considering section 4 manual pages in
254 .Bl -item -offset indent -compact
256 .Pa /usr/share/man/man4/pc98
258 .Pa /usr/share/man/man4/i386
260 .Pa /usr/share/man/man4
262 .Ss Displaying Specific Manual Files
265 utility also supports displaying a specific manual page if passed a path
266 to the file as long as it contains a
270 The following environment variables affect the execution of
272 .Bl -tag -width ".Ev MANROFFSEQ"
273 .It Ev LC_ALL , LC_CTYPE , LANG
274 Used to find locale specific manual pages.
275 Valid values can be found by running the
279 .Sx IMPLEMENTATION NOTES
284 .It Ev MACHINE_ARCH , MACHINE
285 Used to find platform specific manual pages.
286 If unset, the output of
287 .Dq Li "sysctl hw.machine_arch"
289 .Dq Li "sysctl hw.machine"
290 is used respectively.
292 .Sx IMPLEMENTATION NOTES
298 Used to find the location of the manual files.
301 for additional information.
306 Used to determine the preprocessors for the manual source before running
310 If unset, defaults to
316 Restricts manual sections searched to the specified colon delimited list.
321 If set to a numeric value, used as the width manpages should be displayed.
322 Otherwise, if set to a special value
324 and output is to a terminal,
325 the pages may be displayed over the whole width of the screen.
327 If set, enables color support.
329 Program used to display files.
331 If unset, and color support is enabled,
335 If unset, and color support is disabled, then
338 If that has no value either,
343 .Bl -tag -width indent -compact
345 System configuration file.
346 .It Pa /usr/local/etc/man.d/*.conf
347 Local configuration files.