Annotation of src/usr.bin/man/man.1, Revision 1.18
1.18 ! millert 1: .\" $OpenBSD: man.1,v 1.17 2002/01/24 20:33:45 mickey 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.4 millert 32: .Dd March 9, 1998
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.4 millert 44: .Op Fl s Ar section
45: .Op Fl S Ar subsection
1.1 deraadt 46: .Op Ar section
1.8 aaron 47: .Ar name Op Ar ...
1.5 art 48: .Nm man
49: .Fl k Ar keyword
1.7 deraadt 50: .Nm man
1.6 deraadt 51: .Fl f Ar filename
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 .
60: .Pp
61: The options are as follows:
1.13 aaron 62: .Bl -tag -width Ds
1.7 deraadt 63: .It Fl k
1.8 aaron 64: Locate man pages matching
1.7 deraadt 65: .Ar keyword
66: in much the same way as
67: .Xr apropos 1
68: works (in fact, it runs
69: .Xr apropos 1
70: for you).
71: This can be used to find which man page applies to a particular subsystem
72: you are interested in, for instance
73: .Pp
1.11 deraadt 74: .Nm man Fl k Em mount
1.7 deraadt 75: .Pp
76: will list all man-pages which contain your
77: .Ar keyword
78: in the
79: .Em NAME
1.11 deraadt 80: line of the man page;
81: in this case a list much like this:
82: .Bd -literal -offset xx
83: amd (8) - automatically mount file systems
84: amq (8) - automounter query tool
85: mount (8) - mount file systems
86: mount, unmount (2) - mount or dismount a filesystem
87: mount_ados (8) - mount an AmigaDOS file system
88: mount_cd9660 (8) - mount an ISO-9660 filesystem
89: mount_ext2fs (8) - mount a ext2fs file system
90: mount_fdesc (8) - mount the file-descriptor file system
91: mount_ffs, mount_ufs (8) - mount a Berkeley Fast File System
92: mount_kernfs (8) - mount the /kern file system
93: mount_procfs (8) - mount the process file system
94: mount_umap (8) - sample file system layer
95: mount_union (8) - mount union filesystems
96: mount_xfs (8) - mount the xfs filesystem
97: mountd (8) - service remote NFS mount requests
98: newfs, mount_mfs (8) - construct a new file system
99: umount (8) - unmount file systems
100: \&...
101: .Ed
1.1 deraadt 102: .It Fl a
103: Display all of the manual pages for a specified
104: .Ar section
105: and
106: .Ar name
107: combination.
108: (Normally, only the first manual page found is displayed.)
1.8 aaron 109: .It Fl C Ar file
1.9 aaron 110: Use the specified
1.1 deraadt 111: .Ar file
112: instead of the default configuration file.
113: This permits users to configure their own manual environment.
114: See
115: .Xr man.conf 5
116: for a description of the contents of this file.
117: .It Fl c
118: Copy the manual page to the standard output instead of using
119: .Xr more 1
120: to paginate it.
121: This is done by default if the standard output is not a terminal device.
122: .It Fl h
123: Display only the
124: .Dq Tn SYNOPSIS
125: lines of the requested manual pages.
1.8 aaron 126: .It Fl M Ar path
1.1 deraadt 127: Override the list of standard directories which
1.9 aaron 128: .Nm
1.1 deraadt 129: searches for manual pages.
130: The supplied
131: .Ar path
1.9 aaron 132: must be a colon
133: .Pq Ql \&:
134: separated list of directories.
1.1 deraadt 135: This search path may also be set using the environment variable
136: .Ev MANPATH .
137: The subdirectories to be searched, and their search order,
1.9 aaron 138: is specified by the
139: .Dq _subdir
140: line in the
141: .Nm
1.1 deraadt 142: configuration file.
1.8 aaron 143: .It Fl m Ar path
1.1 deraadt 144: Augment the list of standard directories which
1.9 aaron 145: .Nm
1.1 deraadt 146: searches for manual pages.
147: The supplied
148: .Ar path
1.9 aaron 149: must be a colon
150: .Pq Ql \&:
151: separated list of directories.
1.1 deraadt 152: These directories will be searched before the standard directories or
153: the directories specified using the
154: .Fl M
155: option or the
156: .Ev MANPATH
157: environment variable.
158: The subdirectories to be searched, and their search order,
1.9 aaron 159: is specified by the
160: .Dq _subdir
161: line in the
162: .Nm
1.1 deraadt 163: configuration file.
1.8 aaron 164: .It Fl s Ar section
1.4 millert 165: Another way of specifying the section, for compatibility with
1.9 aaron 166: .Nm
1.4 millert 167: on other operating systems.
1.8 aaron 168: .It Fl S Ar subsection
1.12 aaron 169: Specifies the machine-dependent subsection.
170: This overrides the
1.4 millert 171: .Ev MACHINE
1.12 aaron 172: environment variable.
173: See the
1.9 aaron 174: .Sx ENVIRONMENT
175: section below.
1.1 deraadt 176: .It Fl w
177: List the pathnames of the manual pages which
1.9 aaron 178: .Nm
1.1 deraadt 179: would display for the specified
180: .Ar section
181: and
182: .Ar name
183: combination.
1.6 deraadt 184: .It Fl f
1.8 aaron 185: Locate man pages matching the
1.6 deraadt 186: .Ar command
187: in much the same way
188: .Xr whatis 1
189: works.
1.1 deraadt 190: .El
191: .Pp
192: The optional
193: .Ar section
194: argument restricts the directories that
1.9 aaron 195: .Nm
1.1 deraadt 196: will search.
197: The
1.9 aaron 198: .Nm
1.1 deraadt 199: configuration file (see
200: .Xr man.conf 5 )
201: specifies the possible
202: .Ar section
203: values that are currently available.
204: If only a single argument is specified or if the first argument is
205: not a valid section,
1.9 aaron 206: .Nm
1.1 deraadt 207: assumes that the argument is the name of a manual page to be displayed.
208: .Sh ENVIRONMENT
209: .Bl -tag -width MANPATHX
210: .It Ev MACHINE
211: As some manual pages are intended only for specific architectures,
1.9 aaron 212: .Nm
1.1 deraadt 213: searches any subdirectories,
214: with the same name as the current architecture,
215: in every directory which it searches.
216: Machine specific areas are checked before general areas.
217: The current machine type may be overridden by setting the environment
218: variable
219: .Ev MACHINE
220: to the name of a specific architecture.
221: .It Ev MANPATH
222: The standard search path used by
1.9 aaron 223: .Nm
1.1 deraadt 224: may be overridden by specifying a path in the
225: .Ev MANPATH
226: environment
227: variable.
1.9 aaron 228: The format of the path is a colon
229: .Pq Ql \&:
230: separated list of directories.
1.1 deraadt 231: The subdirectories to be searched as well as their search order
1.9 aaron 232: is specified by the
233: .Dq _subdir
234: line in the
235: .Nm
1.1 deraadt 236: configuration file.
237: .It Ev PAGER
1.10 pjanzen 238: Any non-null value of the environment variable
1.1 deraadt 239: .Ev PAGER
240: will be used instead of the standard pagination program,
241: .Xr more 1 .
242: .El
243: .Sh FILES
244: .Bl -tag -width /etc/man.conf -compact
245: .It Pa /etc/man.conf
1.8 aaron 246: default man configuration file
1.1 deraadt 247: .El
248: .Sh SEE ALSO
249: .Xr apropos 1 ,
250: .Xr whatis 1 ,
251: .Xr whereis 1 ,
252: .Xr man.conf 5
253: .Sh HISTORY
254: A
255: .Nm
256: command appeared in
1.17 mickey 257: .At v3 .
1.14 aaron 258: .Sh BUGS
259: The on-line manual pages are, by necessity, forgiving toward stupid
260: display devices, causing a few manual pages to be not as nicely formatted
261: 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