Annotation of mandoc/man.1, Revision 1.23
1.23 ! schwarze 1: .\" $Id: man.1,v 1.22 2017/03/17 17:24:41 schwarze Exp $
1.1 schwarze 2: .\"
3: .\" Copyright (c) 1989, 1990, 1993
4: .\" The Regents of the University of California. All rights reserved.
1.2 schwarze 5: .\" Copyright (c) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org>
1.22 schwarze 6: .\" Copyright (c) 2010, 2011, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 7: .\"
8: .\" Redistribution and use in source and binary forms, with or without
9: .\" modification, are permitted provided that the following conditions
10: .\" are met:
11: .\" 1. Redistributions of source code must retain the above copyright
12: .\" notice, this list of conditions and the following disclaimer.
13: .\" 2. Redistributions in binary form must reproduce the above copyright
14: .\" notice, this list of conditions and the following disclaimer in the
15: .\" documentation and/or other materials provided with the distribution.
16: .\" 3. Neither the name of the University nor the names of its contributors
17: .\" may be used to endorse or promote products derived from this software
18: .\" without specific prior written permission.
19: .\"
20: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30: .\" SUCH DAMAGE.
31: .\"
32: .\" @(#)man.1 8.2 (Berkeley) 1/2/94
33: .\"
1.23 ! schwarze 34: .Dd $Mdocdate: March 17 2017 $
1.1 schwarze 35: .Dt MAN 1
36: .Os
37: .Sh NAME
38: .Nm man
39: .Nd display manual pages
40: .Sh SYNOPSIS
41: .Nm man
1.13 schwarze 42: .Op Fl acfhklw
1.1 schwarze 43: .Op Fl C Ar file
1.8 schwarze 44: .Op Fl I Cm os Ns = Ns Ar name
45: .Op Fl K Ar encoding
1.1 schwarze 46: .Op Fl M Ar path
47: .Op Fl m Ar path
1.8 schwarze 48: .Op Fl O Ar option Ns = Ns Ar value
1.1 schwarze 49: .Op Fl S Ar subsection
50: .Op Fl s Ar section
1.8 schwarze 51: .Op Fl T Ar output
52: .Op Fl W Ar level
1.1 schwarze 53: .Op Ar section
54: .Ar name ...
55: .Sh DESCRIPTION
56: The
57: .Nm
58: utility
59: displays the
60: manual pages entitled
61: .Ar name .
62: Pages may be selected according to
63: a specific category
64: .Pq Ar section
65: or
66: machine architecture
67: .Pq Ar subsection .
68: .Pp
69: The options are as follows:
70: .Bl -tag -width Ds
71: .It Fl a
1.18 schwarze 72: Display all matching manual pages.
73: Normally, only the first page found is displayed.
1.1 schwarze 74: .It Fl C Ar file
75: Use the specified
76: .Ar file
77: instead of the default configuration file.
78: This permits users to configure their own manual environment.
79: See
80: .Xr man.conf 5
81: for a description of the contents of this file.
82: .It Fl c
83: Copy the manual page to the standard output instead of using
84: .Xr more 1
85: to paginate it.
86: This is done by default if the standard output is not a terminal device.
1.2 schwarze 87: .It Fl f
1.1 schwarze 88: A synonym for
89: .Xr whatis 1 .
1.2 schwarze 90: It searches for
91: .Ar name
92: in manual page names and displays the header lines from all matching pages.
93: The search is case insensitive and matches whole words only.
1.4 schwarze 94: This overrides any earlier
95: .Fl k
96: and
97: .Fl l
98: options.
1.20 schwarze 99: .It Fl h
100: Display only the SYNOPSIS lines of the requested manual pages.
101: Implies
102: .Fl a
103: and
104: .Fl c .
1.8 schwarze 105: .It Fl I Cm os Ns = Ns Ar name
106: Override the default operating system
107: .Ar name
108: for the
109: .Xr mdoc 7
110: .Ic \&Os
1.10 schwarze 111: and for the
112: .Xr man 7
113: .Ic \&TH
1.8 schwarze 114: macro.
115: .It Fl K Ar encoding
116: Specify the input encoding.
117: The supported
118: .Ar encoding
119: arguments are
120: .Cm us-ascii ,
121: .Cm iso-8859-1 ,
122: and
123: .Cm utf-8 .
124: By default, the encoding is automatically detected as described in the
125: .Xr mandoc 1
126: manual.
1.2 schwarze 127: .It Fl k
1.1 schwarze 128: A synonym for
129: .Xr apropos 1 .
1.2 schwarze 130: Instead of
131: .Ar name ,
132: an expression can be provided using the syntax described in the
133: .Xr apropos 1
134: manual.
135: By default, it displays the header lines of all matching pages.
1.4 schwarze 136: This overrides any earlier
137: .Fl f
138: and
139: .Fl l
140: options.
141: .It Fl l
142: A synonym for
143: .Xr mandoc 1
144: .Fl a .
145: The
146: .Ar name
147: arguments are interpreted as filenames.
148: No search is done and
149: .Ar file ,
150: .Ar path ,
151: .Ar section ,
152: and
153: .Ar subsection
154: are ignored.
155: This overrides any earlier
156: .Fl f ,
157: .Fl k ,
158: and
159: .Fl w
160: options.
1.1 schwarze 161: .It Fl M Ar path
162: Override the list of standard directories which
163: .Nm
164: searches for manual pages.
165: The supplied
166: .Ar path
167: must be a colon
168: .Pq Ql \&:
169: separated list of directories.
170: This search path may also be set using the environment variable
171: .Ev MANPATH .
172: .It Fl m Ar path
173: Augment the list of standard directories which
174: .Nm
175: searches for manual pages.
176: The supplied
177: .Ar path
178: must be a colon
179: .Pq Ql \&:
180: separated list of directories.
181: These directories will be searched before the standard directories or
182: the directories specified using the
183: .Fl M
184: option or the
185: .Ev MANPATH
186: environment variable.
1.8 schwarze 187: .It Fl O Ar option Ns = Ns Ar value
188: Comma-separated output options.
189: For each output format, the available options are described in the
190: .Xr mandoc 1
191: manual.
1.1 schwarze 192: .It Fl S Ar subsection
193: Restricts the directories that
194: .Nm
195: will search to those of a specific
196: .Xr machine 1
197: architecture.
198: .Ar subsection
199: is case insensitive.
200: .Pp
201: By default manual pages for all architectures are installed.
202: Therefore this option can be used to view pages for one
203: architecture whilst using another.
204: .Pp
205: This option overrides the
206: .Ev MACHINE
207: environment variable.
1.17 schwarze 208: .It Oo Fl s Oc Ar section
209: Only select manuals from the specified
210: .Ar section .
1.1 schwarze 211: The currently available sections are:
212: .Pp
213: .Bl -tag -width "localXXX" -offset indent -compact
214: .It 1
215: General commands
216: .Pq tools and utilities .
217: .It 2
218: System calls and error numbers.
219: .It 3
1.17 schwarze 220: Library functions.
1.1 schwarze 221: .It 3p
222: .Xr perl 1
223: programmer's reference guide.
224: .It 4
225: Device drivers.
226: .It 5
227: File formats.
228: .It 6
229: Games.
230: .It 7
1.17 schwarze 231: Miscellaneous information.
1.1 schwarze 232: .It 8
233: System maintenance and operation commands.
234: .It 9
235: Kernel internals.
236: .El
1.22 schwarze 237: .Pp
238: If not specified and a match is found in more than one section,
239: the first match is selected from the following list:
240: 1, 8, 6, 2, 3, 5, 7, 4, 9, 3p.
1.8 schwarze 241: .It Fl T Ar output
242: Select the output format.
243: The default is
244: .Cm locale .
245: The other output modes
246: .Cm ascii ,
247: .Cm html ,
248: .Cm lint ,
249: .Cm man ,
250: .Cm pdf ,
251: .Cm ps ,
252: .Cm tree ,
253: and
254: .Cm utf8
255: are described in the
256: .Xr mandoc 1
257: manual.
258: .It Fl W Ar level
259: Specify the minimum message
260: .Ar level
261: to be reported on the standard error output and to affect the exit status.
262: The
263: .Ar level
264: can be
1.12 schwarze 265: .Cm warning ,
266: .Cm error ,
1.8 schwarze 267: or
1.12 schwarze 268: .Cm unsupp ;
1.8 schwarze 269: .Cm all
270: is an alias for
271: .Cm warning .
1.11 schwarze 272: By default,
273: .Nm
274: is silent.
1.8 schwarze 275: See the
276: .Xr mandoc 1
277: manual for details.
1.1 schwarze 278: .It Fl w
279: List the pathnames of the manual pages which
280: .Nm
281: would display for the specified
282: .Ar section
283: and
284: .Ar name
285: combination.
286: .El
287: .Pp
1.2 schwarze 288: Guidelines for writing
1.1 schwarze 289: man pages can be found in
290: .Xr mdoc 7 .
291: .Pp
292: If both a formatted and an unformatted version of the same manual page,
293: for example
294: .Pa cat1/foo.0
295: and
296: .Pa man1/foo.1 ,
297: exist in the same directory, and at least one of them is selected,
298: only the newer one is used.
299: However, if both the
300: .Fl a
301: and the
302: .Fl w
303: options are specified, both file names are printed.
304: .Sh ENVIRONMENT
305: .Bl -tag -width MANPATHX
306: .It Ev MACHINE
307: As some manual pages are intended only for specific architectures,
308: .Nm
309: searches any subdirectories,
310: with the same name as the current architecture,
311: in every directory which it searches.
312: Machine specific areas are checked before general areas.
313: The current machine type may be overridden by setting the environment
314: variable
315: .Ev MACHINE
316: to the name of a specific architecture,
317: or with the
318: .Fl S
319: option.
320: .Ev MACHINE
321: is case insensitive.
322: .It Ev MANPAGER
323: Any non-empty value of the environment variable
324: .Ev MANPAGER
1.23 ! schwarze 325: is used instead of the standard pagination program,
1.1 schwarze 326: .Xr more 1 .
1.15 schwarze 327: If
328: .Xr less 1
329: is used, the interactive
330: .Ic :t
331: command can be used to go to the definitions of various terms, for
332: example command line options, command modifiers, internal commands,
1.19 schwarze 333: environment variables, function names, preprocessor macros,
334: .Xr errno 2
335: values, and some other emphasized words.
336: Some terms may have defining text at more than one place.
337: In that case, the
338: .Xr less 1
339: interactive commands
340: .Ic t
341: and
342: .Ic T
343: can be used to move to the next and to the previous place providing
344: information about the term last searched for with
345: .Ic :t .
1.1 schwarze 346: .It Ev MANPATH
347: The standard search path used by
348: .Nm
1.23 ! schwarze 349: may be changed by specifying a path in the
1.1 schwarze 350: .Ev MANPATH
1.23 ! schwarze 351: environment variable.
1.1 schwarze 352: The format of the path is a colon
353: .Pq Ql \&:
354: separated list of directories.
1.23 ! schwarze 355: Invalid paths, or paths without manual databases, are ignored.
! 356: Overridden by
! 357: .Fl M ,
! 358: ignored if
! 359: .Fl l
! 360: is specified.
! 361: .Pp
! 362: If
! 363: .Ev MANPATH
! 364: begins with a colon, it is appended to the default list;
! 365: if it ends with a colon, it is prepended to the default list;
! 366: or if it contains two adjacent colons,
! 367: the standard search path is inserted between the colons.
! 368: If none of these conditions are met, it overrides the
! 369: standard search path.
1.1 schwarze 370: .It Ev PAGER
371: Specifies the pagination program to use when
372: .Ev MANPAGER
373: is not defined.
374: If neither PAGER nor MANPAGER is defined,
1.14 schwarze 375: .Xr more 1
376: .Fl s
1.23 ! schwarze 377: is used.
! 378: Only used if
! 379: .Fl a
! 380: or
! 381: .Fl l
! 382: is specified.
1.1 schwarze 383: .El
384: .Sh FILES
385: .Bl -tag -width /etc/man.conf -compact
386: .It Pa /etc/man.conf
387: default man configuration file
388: .El
389: .Sh EXIT STATUS
390: .Ex -std man
391: .Sh SEE ALSO
392: .Xr apropos 1 ,
393: .Xr intro 1 ,
394: .Xr whatis 1 ,
395: .Xr whereis 1 ,
396: .Xr intro 2 ,
397: .Xr intro 3 ,
398: .Xr intro 4 ,
399: .Xr intro 5 ,
400: .Xr man.conf 5 ,
401: .Xr intro 6 ,
402: .Xr intro 7 ,
403: .Xr mdoc 7 ,
404: .Xr intro 8 ,
405: .Xr intro 9
406: .Sh STANDARDS
407: The
408: .Nm
409: utility is compliant with the
410: .St -p1003.1-2008
411: specification.
412: .Pp
413: The flags
1.13 schwarze 414: .Op Fl aCcfhIKlMmOSsTWw ,
1.1 schwarze 415: as well as the environment variables
416: .Ev MACHINE ,
417: .Ev MANPAGER ,
418: and
419: .Ev MANPATH ,
420: are extensions to that specification.
421: .Sh HISTORY
422: A
423: .Nm
424: command first appeared in
425: .At v3 .
426: .Pp
427: The
428: .Fl w
429: option first appeared in
430: .At v7 ;
431: .Fl f
432: and
433: .Fl k
434: in
435: .Bx 4 ;
436: .Fl M
437: in
438: .Bx 4.3 ;
439: .Fl a
440: in
441: .Bx 4.3 Tahoe ;
442: .Fl c
443: and
444: .Fl m
445: in
446: .Bx 4.3 Reno ;
447: .Fl h
448: in
449: .Bx 4.3 Net/2 ;
450: .Fl C
451: in
452: .Nx 1.0 ;
453: .Fl s
454: and
455: .Fl S
456: in
1.21 schwarze 457: .Ox 2.3 ;
458: and
459: .Fl I ,
460: .Fl K ,
461: .Fl l ,
462: .Fl O ,
463: and
464: .Fl W
465: in
466: .Ox 5.7 .
467: The
468: .Fl T
469: option first appeared in
470: .At III
471: and was also added in
472: .Ox 5.7 .
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to man.1 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc