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