Annotation of src/usr.bin/man/man.1, Revision 1.33
1.33 ! jmc 1: .\" $OpenBSD: man.1,v 1.32 2007/05/23 20:24:07 jmc Exp $
1.3 deraadt 2: .\"
1.1 deraadt 3: .\" Copyright (c) 1989, 1990, 1993
4: .\" The Regents of the University of California. All rights reserved.
5: .\"
6: .\" Redistribution and use in source and binary forms, with or without
7: .\" modification, are permitted provided that the following conditions
8: .\" are met:
9: .\" 1. Redistributions of source code must retain the above copyright
10: .\" notice, this list of conditions and the following disclaimer.
11: .\" 2. Redistributions in binary form must reproduce the above copyright
12: .\" notice, this list of conditions and the following disclaimer in the
13: .\" documentation and/or other materials provided with the distribution.
1.18 millert 14: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 15: .\" may be used to endorse or promote products derived from this software
16: .\" without specific prior written permission.
17: .\"
18: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28: .\" SUCH DAMAGE.
29: .\"
30: .\" @(#)man.1 8.2 (Berkeley) 1/2/94
31: .\"
1.28 jmc 32: .Dd May 19, 2007
1.1 deraadt 33: .Dt MAN 1
1.4 millert 34: .Os
1.1 deraadt 35: .Sh NAME
36: .Nm man
37: .Nd display the on-line manual pages
38: .Sh SYNOPSIS
39: .Nm man
40: .Op Fl achw
41: .Op Fl C Ar file
42: .Op Fl M Ar path
43: .Op Fl m Ar path
1.21 jmc 44: .Op Fl S Ar subsection
1.4 millert 45: .Op Fl s Ar section
1.1 deraadt 46: .Op Ar section
1.8 aaron 47: .Ar name Op Ar ...
1.5 art 48: .Nm man
1.21 jmc 49: .Fl f Ar command
50: .Nm man
1.5 art 51: .Fl k Ar keyword
1.1 deraadt 52: .Sh DESCRIPTION
53: The
1.9 aaron 54: .Nm
1.1 deraadt 55: utility
56: displays the
57: .Bx
58: manual pages entitled
59: .Ar name .
1.33 ! jmc 60: Pages may be selected according to
! 61: a specific category
! 62: .Pq Ar section
! 63: or
! 64: machine architecture
! 65: .Pq Ar subsection .
1.1 deraadt 66: .Pp
67: The options are as follows:
1.13 aaron 68: .Bl -tag -width Ds
1.21 jmc 69: .It Fl a
70: Display all of the manual pages for a specified
71: .Ar section
72: and
73: .Ar name
74: combination.
1.29 jmc 75: Normally, only the first manual page found is displayed.
1.21 jmc 76: .It Fl C Ar file
77: Use the specified
78: .Ar file
79: instead of the default configuration file.
80: This permits users to configure their own manual environment.
81: See
82: .Xr man.conf 5
83: for a description of the contents of this file.
84: .It Fl c
85: Copy the manual page to the standard output instead of using
86: .Xr more 1
87: to paginate it.
88: This is done by default if the standard output is not a terminal device.
89: .It Fl f Ar command
1.30 jmc 90: A synonym for
91: .Xr whatis 1 .
92: It looks up a given command and
93: gives the header line from the manual page.
1.21 jmc 94: .It Fl h
95: Display only the
96: .Dq SYNOPSIS
97: lines of the requested manual pages.
98: .It Fl k Ar keyword
1.30 jmc 99: A synonym for
100: .Xr apropos 1 .
101: It shows which manual pages contain instances of any of the given
102: keywords in their title line.
1.7 deraadt 103: .Ar keyword
1.30 jmc 104: is case insensitive.
1.7 deraadt 105: .Pp
1.30 jmc 106: For instance,
107: to list all man pages which contain
1.27 jmc 108: .Dq mount
1.7 deraadt 109: in the
1.21 jmc 110: .Dq NAME
1.30 jmc 111: line of the man page:
112: .Pp
113: .Dl $ man -k mount
114: .Pp
115: Which would produce a list much like this:
1.19 jmc 116: .Bd -literal
1.27 jmc 117: amd (8) \(en automatically mount file systems
118: amq (8) \(en automounter query tool
119: domountroothooks (9) \(en run all mountroot hooks
120: exports (5) \(en define remote mount points for NFS mount requests
121: getfsstat (2) \(en get list of all mounted file systems
122: getmntinfo (3) \(en get information about mounted file systems
123: mount (8) \(en mount file systems
124: mount, unmount (2) \(en mount or dismount a filesystem
125: mount_ados (8) \(en mount an AmigaDOS file system
126: mount_cd9660 (8) \(en mount an ISO-9660 filesystem
127: mount_ext2fs (8) \(en mount an ext2fs file system
128: mount_ffs (8) \(en mount a Berkeley Fast File System
129: mount_msdos (8) \(en mount an MS-DOS file system
130: mount_nfs (8) \(en mount NFS file systems
131: mount_ntfs (8) \(en mount an NTFS file system
132: mount_portal (8) \(en mount the portal daemon
133: mount_procfs (8) \(en mount the process file system
134: mount_udf (8) \(en mount a UDF filesystem
135: mount_xfs (8) \(en mount the xfs filesystem
136: mountd (8) \(en service remote NFS mount requests
1.11 deraadt 137: \&...
138: .Ed
1.8 aaron 139: .It Fl M Ar path
1.1 deraadt 140: Override the list of standard directories which
1.9 aaron 141: .Nm
1.1 deraadt 142: searches for manual pages.
143: The supplied
144: .Ar path
1.9 aaron 145: must be a colon
146: .Pq Ql \&:
147: separated list of directories.
1.1 deraadt 148: This search path may also be set using the environment variable
149: .Ev MANPATH .
150: The subdirectories to be searched, and their search order,
1.21 jmc 151: are specified by the
1.9 aaron 152: .Dq _subdir
153: line in the
154: .Nm
1.1 deraadt 155: configuration file.
1.8 aaron 156: .It Fl m Ar path
1.1 deraadt 157: Augment the list of standard directories which
1.9 aaron 158: .Nm
1.1 deraadt 159: searches for manual pages.
160: The supplied
161: .Ar path
1.9 aaron 162: must be a colon
163: .Pq Ql \&:
164: separated list of directories.
1.1 deraadt 165: These directories will be searched before the standard directories or
166: the directories specified using the
167: .Fl M
168: option or the
169: .Ev MANPATH
170: environment variable.
171: The subdirectories to be searched, and their search order,
1.21 jmc 172: are specified by the
1.9 aaron 173: .Dq _subdir
174: line in the
175: .Nm
1.1 deraadt 176: configuration file.
1.8 aaron 177: .It Fl S Ar subsection
1.28 jmc 178: Restricts the directories that
179: .Nm
180: will search to those of a specific machine architecture.
1.31 jmc 181: By default manual pages for all architectures are installed.
182: Therefore this option can be used to view pages for one
183: architecture whilst using another.
184: .Pp
1.28 jmc 185: Overrides the
1.4 millert 186: .Ev MACHINE
1.31 jmc 187: environment variable;
188: see also the
1.9 aaron 189: .Sx ENVIRONMENT
190: section below.
1.33 ! jmc 191: .It Xo
! 192: .Op Fl s
1.1 deraadt 193: .Ar section
1.33 ! jmc 194: .Xc
! 195: Restricts the directories that
1.9 aaron 196: .Nm
1.28 jmc 197: will search to a specific section.
1.19 jmc 198: The currently available sections are:
199: .Pp
1.32 jmc 200: .Bl -tag -width "localXXX" -offset indent -compact
1.19 jmc 201: .It 1
202: General commands
203: .Pq tools and utilities .
204: .It 2
205: System calls and error numbers.
206: .It 3
207: Libraries.
208: .It 3p
209: .Xr perl 1
210: programmer's reference guide.
211: .It 4
212: Device drivers.
213: .It 5
214: File formats.
215: .It 6
216: Games.
217: .It 7
218: Miscellaneous.
219: .It 8
220: System maintenance and operation commands.
221: .It 9
222: Kernel internals.
1.32 jmc 223: .It X11
224: An alias for X11R6.
225: .It X11R6
226: X Window System.
227: .It local
228: Pages located in
229: .Pa /usr/local .
1.19 jmc 230: .El
231: .Pp
1.1 deraadt 232: The
1.9 aaron 233: .Nm
1.28 jmc 234: configuration file,
235: .Xr man.conf 5 ,
1.1 deraadt 236: specifies the possible
237: .Ar section
1.19 jmc 238: values, and their search order.
1.32 jmc 239: Additional sections may be specified.
1.33 ! jmc 240: .It Fl w
! 241: List the pathnames of the manual pages which
! 242: .Nm
! 243: would display for the specified
! 244: .Ar section
! 245: and
! 246: .Ar name
! 247: combination.
! 248: .El
1.22 jmc 249: .Pp
250: Guidelines for
251: .Ox
252: man pages can be found in
253: .Xr mdoc 7 .
254: A full tutorial for writing man pages is provided in
255: .Xr mdoc.samples 7 .
1.1 deraadt 256: .Sh ENVIRONMENT
257: .Bl -tag -width MANPATHX
258: .It Ev MACHINE
259: As some manual pages are intended only for specific architectures,
1.9 aaron 260: .Nm
1.1 deraadt 261: searches any subdirectories,
262: with the same name as the current architecture,
263: in every directory which it searches.
264: Machine specific areas are checked before general areas.
265: The current machine type may be overridden by setting the environment
266: variable
267: .Ev MACHINE
1.28 jmc 268: to the name of a specific architecture,
269: or with the
270: .Fl S
271: option.
1.20 millert 272: .It Ev MANPAGER
273: Any non-null value of the environment variable
274: .Ev MANPAGER
275: will be used instead of the standard pagination program,
276: .Xr more 1 .
1.1 deraadt 277: .It Ev MANPATH
278: The standard search path used by
1.9 aaron 279: .Nm
1.1 deraadt 280: may be overridden by specifying a path in the
281: .Ev MANPATH
282: environment
283: variable.
1.9 aaron 284: The format of the path is a colon
285: .Pq Ql \&:
286: separated list of directories.
1.21 jmc 287: The subdirectories to be searched, as well as their search order,
288: are specified by the
1.9 aaron 289: .Dq _subdir
290: line in the
291: .Nm
1.1 deraadt 292: configuration file.
293: .It Ev PAGER
1.20 millert 294: Specifies the pagination program to use when
295: .Ev MANPAGER
296: is not defined.
1.1 deraadt 297: .El
298: .Sh FILES
299: .Bl -tag -width /etc/man.conf -compact
300: .It Pa /etc/man.conf
1.8 aaron 301: default man configuration file
1.1 deraadt 302: .El
303: .Sh SEE ALSO
304: .Xr apropos 1 ,
1.19 jmc 305: .Xr intro 1 ,
1.1 deraadt 306: .Xr whatis 1 ,
307: .Xr whereis 1 ,
1.19 jmc 308: .Xr intro 2 ,
309: .Xr intro 3 ,
310: .Xr intro 4 ,
311: .Xr intro 5 ,
312: .Xr man.conf 5 ,
313: .Xr intro 6 ,
314: .Xr intro 7 ,
1.22 jmc 315: .Xr mdoc 7 ,
316: .Xr mdoc.samples 7 ,
1.19 jmc 317: .Xr intro 8 ,
318: .Xr intro 9
1.1 deraadt 319: .Sh HISTORY
320: A
321: .Nm
322: command appeared in
1.17 mickey 323: .At v3 .
1.14 aaron 324: .Sh BUGS
325: The on-line manual pages are, by necessity, forgiving toward stupid
326: display devices, causing a few manual pages to be not as nicely formatted
327: as their typeset counterparts.
![[BACK]](/icons/back.gif){kind=icon}
Return to man.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / man