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