Annotation of src/usr.bin/man/man.1, Revision 1.6
1.6 ! deraadt 1: .\" $OpenBSD: man.1,v 1.5 1998/07/20 00:19:10 art 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
51: .Ar name Ar ...
1.5 art 52: .Nm man
53: .Fl k Ar keyword
1.6 ! deraadt 54: .Fl f Ar filename
1.1 deraadt 55: .Sh DESCRIPTION
56: The
57: .Nm man
58: utility
59: displays the
60: .Bx
61: manual pages entitled
62: .Ar name .
63: .Pp
64: The options are as follows:
65: .Bl -tag -width indent
66: .It Fl a
67: Display all of the manual pages for a specified
68: .Ar section
69: and
70: .Ar name
71: combination.
72: (Normally, only the first manual page found is displayed.)
73: .It Fl C
74: Use the specified
75: .Ar file
76: instead of the default configuration file.
77: This permits users to configure their own manual environment.
78: See
79: .Xr man.conf 5
80: for a description of the contents of this file.
81: .It Fl c
82: Copy the manual page to the standard output instead of using
83: .Xr more 1
84: to paginate it.
85: This is done by default if the standard output is not a terminal device.
86: .It Fl h
87: Display only the
88: .Dq Tn SYNOPSIS
89: lines of the requested manual pages.
90: .It Fl M
91: Override the list of standard directories which
92: .Nm man
93: searches for manual pages.
94: The supplied
95: .Ar path
96: must be a colon (``:'') separated list of directories.
97: This search path may also be set using the environment variable
98: .Ev MANPATH .
99: The subdirectories to be searched, and their search order,
100: is specified by the ``_subdir'' line in the
101: .Nm man
102: configuration file.
103: .It Fl m
104: Augment the list of standard directories which
105: .Nm man
106: searches for manual pages.
107: The supplied
108: .Ar path
109: must be a colon (``:'') separated list of directories.
110: These directories will be searched before the standard directories or
111: the directories specified using the
112: .Fl M
113: option or the
114: .Ev MANPATH
115: environment variable.
116: The subdirectories to be searched, and their search order,
117: is specified by the ``_subdir'' line in the
118: .Nm man
119: configuration file.
1.4 millert 120: .It Fl s
121: Another way of specifying the section, for compatibility with
122: .Nm man
123: on other operating systems.
124: .It Fl S
125: Specifies the machine-dependent subsection. This overrides the
126: .Ev MACHINE
127: environment variable. See the ``ENVIRONMENT'' section below.
1.1 deraadt 128: .It Fl w
129: List the pathnames of the manual pages which
130: .Nm man
131: would display for the specified
132: .Ar section
133: and
134: .Ar name
135: combination.
1.5 art 136: .It Fl k
1.6 ! deraadt 137: Locate manpages matching
1.5 art 138: .Ar keyword
1.6 ! deraadt 139: in much the same way as
! 140: .Xr apropos 1
! 141: works (in fact, it runs
! 142: .Xr apropos 1
! 143: for you).
! 144: .It Fl f
! 145: Locate manpages matching the
! 146: .Ar command
! 147: in much the same way
! 148: .Xr whatis 1
! 149: works.
1.1 deraadt 150: .El
151: .Pp
152: The optional
153: .Ar section
154: argument restricts the directories that
155: .Nm man
156: will search.
157: The
158: .Nm man
159: configuration file (see
160: .Xr man.conf 5 )
161: specifies the possible
162: .Ar section
163: values that are currently available.
164: If only a single argument is specified or if the first argument is
165: not a valid section,
166: .Nm man
167: assumes that the argument is the name of a manual page to be displayed.
168: .Sh ENVIRONMENT
169: .Bl -tag -width MANPATHX
170: .It Ev MACHINE
171: As some manual pages are intended only for specific architectures,
172: .Nm man
173: searches any subdirectories,
174: with the same name as the current architecture,
175: in every directory which it searches.
176: Machine specific areas are checked before general areas.
177: The current machine type may be overridden by setting the environment
178: variable
179: .Ev MACHINE
180: to the name of a specific architecture.
181: .It Ev MANPATH
182: The standard search path used by
183: .Nm man
184: may be overridden by specifying a path in the
185: .Ev MANPATH
186: environment
187: variable.
188: The format of the path is a colon (``:'') separated list of directories.
189: The subdirectories to be searched as well as their search order
190: is specified by the ``_subdir'' line in the
191: .Nm man
192: configuration file.
193: .It Ev PAGER
194: Any value of the environment variable
195: .Ev PAGER
196: will be used instead of the standard pagination program,
197: .Xr more 1 .
198: .El
199: .Sh FILES
200: .Bl -tag -width /etc/man.conf -compact
201: .It Pa /etc/man.conf
202: default man configuration file.
203: .El
204: .Sh SEE ALSO
205: .Xr apropos 1 ,
206: .Xr whatis 1 ,
207: .Xr whereis 1 ,
208: .Xr man.conf 5
209: .Sh BUGS
210: The on-line manual pages are, by necessity, forgiving toward stupid
1.2 deraadt 211: display devices, causing a few manual pages to be not as nicely formatted
1.1 deraadt 212: as their typeset counterparts.
213: .Sh HISTORY
214: A
215: .Nm
216: command appeared in
217: .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