Annotation of src/usr.bin/man/man.1, Revision 1.10
1.10 ! pjanzen 1: .\" $OpenBSD: man.1,v 1.9 1999/06/05 01:21:33 aaron 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.
14: .\" 3. All advertising materials mentioning features or use of this software
15: .\" must display the following acknowledgement:
16: .\" This product includes software developed by the University of
17: .\" California, Berkeley and its contributors.
18: .\" 4. Neither the name of the University nor the names of its contributors
19: .\" may be used to endorse or promote products derived from this software
20: .\" without specific prior written permission.
21: .\"
22: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32: .\" SUCH DAMAGE.
33: .\"
34: .\" @(#)man.1 8.2 (Berkeley) 1/2/94
35: .\"
1.4 millert 36: .Dd March 9, 1998
1.1 deraadt 37: .Dt MAN 1
1.4 millert 38: .Os
1.1 deraadt 39: .Sh NAME
40: .Nm man
41: .Nd display the on-line manual pages
42: .Sh SYNOPSIS
43: .Nm man
44: .Op Fl achw
45: .Op Fl C Ar file
46: .Op Fl M Ar path
47: .Op Fl m Ar path
1.4 millert 48: .Op Fl s Ar section
49: .Op Fl S Ar subsection
1.1 deraadt 50: .Op Ar section
1.8 aaron 51: .Ar name Op Ar ...
1.5 art 52: .Nm man
53: .Fl k Ar keyword
1.7 deraadt 54: .Nm man
1.6 deraadt 55: .Fl f Ar filename
1.1 deraadt 56: .Sh DESCRIPTION
57: The
1.9 aaron 58: .Nm
1.1 deraadt 59: utility
60: displays the
61: .Bx
62: manual pages entitled
63: .Ar name .
64: .Pp
65: The options are as follows:
66: .Bl -tag -width indent
1.7 deraadt 67: .It Fl k
1.8 aaron 68: Locate man pages matching
1.7 deraadt 69: .Ar keyword
70: in much the same way as
71: .Xr apropos 1
72: works (in fact, it runs
73: .Xr apropos 1
74: for you).
75: This can be used to find which man page applies to a particular subsystem
76: you are interested in, for instance
77: .Pp
78: .Nm man Fl k Em compat
79: .Pp
80: will list all man-pages which contain your
81: .Ar keyword
82: in the
83: .Em NAME
84: line of the man page
85: (ie.
86: .Em Nm man - display the on-line manual pages
87: above).
1.1 deraadt 88: .It Fl a
89: Display all of the manual pages for a specified
90: .Ar section
91: and
92: .Ar name
93: combination.
94: (Normally, only the first manual page found is displayed.)
1.8 aaron 95: .It Fl C Ar file
1.9 aaron 96: Use the specified
1.1 deraadt 97: .Ar file
98: instead of the default configuration file.
99: This permits users to configure their own manual environment.
100: See
101: .Xr man.conf 5
102: for a description of the contents of this file.
103: .It Fl c
104: Copy the manual page to the standard output instead of using
105: .Xr more 1
106: to paginate it.
107: This is done by default if the standard output is not a terminal device.
108: .It Fl h
109: Display only the
110: .Dq Tn SYNOPSIS
111: lines of the requested manual pages.
1.8 aaron 112: .It Fl M Ar path
1.1 deraadt 113: Override the list of standard directories which
1.9 aaron 114: .Nm
1.1 deraadt 115: searches for manual pages.
116: The supplied
117: .Ar path
1.9 aaron 118: must be a colon
119: .Pq Ql \&:
120: separated list of directories.
1.1 deraadt 121: This search path may also be set using the environment variable
122: .Ev MANPATH .
123: The subdirectories to be searched, and their search order,
1.9 aaron 124: is specified by the
125: .Dq _subdir
126: line in the
127: .Nm
1.1 deraadt 128: configuration file.
1.8 aaron 129: .It Fl m Ar path
1.1 deraadt 130: Augment the list of standard directories which
1.9 aaron 131: .Nm
1.1 deraadt 132: searches for manual pages.
133: The supplied
134: .Ar path
1.9 aaron 135: must be a colon
136: .Pq Ql \&:
137: separated list of directories.
1.1 deraadt 138: These directories will be searched before the standard directories or
139: the directories specified using the
140: .Fl M
141: option or the
142: .Ev MANPATH
143: environment variable.
144: The subdirectories to be searched, and their search order,
1.9 aaron 145: is specified by the
146: .Dq _subdir
147: line in the
148: .Nm
1.1 deraadt 149: configuration file.
1.8 aaron 150: .It Fl s Ar section
1.4 millert 151: Another way of specifying the section, for compatibility with
1.9 aaron 152: .Nm
1.4 millert 153: on other operating systems.
1.8 aaron 154: .It Fl S Ar subsection
1.4 millert 155: Specifies the machine-dependent subsection. This overrides the
156: .Ev MACHINE
1.9 aaron 157: environment variable. See the
158: .Sx ENVIRONMENT
159: section below.
1.1 deraadt 160: .It Fl w
161: List the pathnames of the manual pages which
1.9 aaron 162: .Nm
1.1 deraadt 163: would display for the specified
164: .Ar section
165: and
166: .Ar name
167: combination.
1.6 deraadt 168: .It Fl f
1.8 aaron 169: Locate man pages matching the
1.6 deraadt 170: .Ar command
171: in much the same way
172: .Xr whatis 1
173: works.
1.1 deraadt 174: .El
175: .Pp
176: The optional
177: .Ar section
178: argument restricts the directories that
1.9 aaron 179: .Nm
1.1 deraadt 180: will search.
181: The
1.9 aaron 182: .Nm
1.1 deraadt 183: configuration file (see
184: .Xr man.conf 5 )
185: specifies the possible
186: .Ar section
187: values that are currently available.
188: If only a single argument is specified or if the first argument is
189: not a valid section,
1.9 aaron 190: .Nm
1.1 deraadt 191: assumes that the argument is the name of a manual page to be displayed.
192: .Sh ENVIRONMENT
193: .Bl -tag -width MANPATHX
194: .It Ev MACHINE
195: As some manual pages are intended only for specific architectures,
1.9 aaron 196: .Nm
1.1 deraadt 197: searches any subdirectories,
198: with the same name as the current architecture,
199: in every directory which it searches.
200: Machine specific areas are checked before general areas.
201: The current machine type may be overridden by setting the environment
202: variable
203: .Ev MACHINE
204: to the name of a specific architecture.
205: .It Ev MANPATH
206: The standard search path used by
1.9 aaron 207: .Nm
1.1 deraadt 208: may be overridden by specifying a path in the
209: .Ev MANPATH
210: environment
211: variable.
1.9 aaron 212: The format of the path is a colon
213: .Pq Ql \&:
214: separated list of directories.
1.1 deraadt 215: The subdirectories to be searched as well as their search order
1.9 aaron 216: is specified by the
217: .Dq _subdir
218: line in the
219: .Nm
1.1 deraadt 220: configuration file.
221: .It Ev PAGER
1.10 ! pjanzen 222: Any non-null value of the environment variable
1.1 deraadt 223: .Ev PAGER
224: will be used instead of the standard pagination program,
225: .Xr more 1 .
226: .El
227: .Sh FILES
228: .Bl -tag -width /etc/man.conf -compact
229: .It Pa /etc/man.conf
1.8 aaron 230: default man configuration file
1.1 deraadt 231: .El
232: .Sh SEE ALSO
233: .Xr apropos 1 ,
234: .Xr whatis 1 ,
235: .Xr whereis 1 ,
236: .Xr man.conf 5
237: .Sh BUGS
238: The on-line manual pages are, by necessity, forgiving toward stupid
1.2 deraadt 239: display devices, causing a few manual pages to be not as nicely formatted
1.1 deraadt 240: as their typeset counterparts.
241: .Sh HISTORY
242: A
243: .Nm
244: command appeared in
245: .At v6 .
![[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