Commit | Line | Data |
---|---|---|
371bcb36 RM |
1 | .\" Copyright (c) 1989, 1990 The Regents of the University of California. |
2 | .\" All rights reserved. | |
3 | .\" | |
4 | .\" Redistribution and use in source and binary forms, with or without | |
5 | .\" modification, are permitted provided that the following conditions | |
6 | .\" are met: | |
7 | .\" 1. Redistributions of source code must retain the above copyright | |
8 | .\" notice, this list of conditions and the following disclaimer. | |
9 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
10 | .\" notice, this list of conditions and the following disclaimer in the | |
11 | .\" documentation and/or other materials provided with the distribution. | |
12 | .\" 3. All advertising materials mentioning features or use of this software | |
13 | .\" must display the following acknowledgement: | |
14 | .\" This product includes software developed by the University of | |
15 | .\" California, Berkeley and its contributors. | |
16 | .\" 4. Neither the name of the University nor the names of its contributors | |
17 | .\" may be used to endorse or promote products derived from this software | |
18 | .\" without specific prior written permission. | |
19 | .\" | |
20 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
21 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
22 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
24 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
26 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
27 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
28 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
30 | .\" SUCH DAMAGE. | |
31 | .\" | |
32 | .\" @(#)man.1 6.14 (Berkeley) 4/29/91 | |
33 | .\" | |
34 | .Dd April 29, 1991 | |
35 | .Dt MAN 1 | |
36 | .Os BSD 4 | |
37 | .Sh NAME | |
38 | .Nm man | |
39 | .Nd display the on-line manual pages | |
40 | .Sh SYNOPSIS | |
41 | .Nm man | |
42 | .Op Fl achw | |
43 | .Op Fl M Ar path | |
44 | .Op Fl m Ar path | |
45 | .Op Ar section | |
46 | .Ar name Ar ... | |
47 | .Sh DESCRIPTION | |
48 | The | |
49 | .Nm man | |
50 | utility | |
51 | displays the | |
52 | .Bx | |
53 | manual pages entitled | |
54 | .Ar name . | |
55 | .Pp | |
56 | The options are as follows: | |
57 | .Bl -tag -width indent | |
58 | .It Fl a | |
59 | Display all of the manual pages for a specified | |
60 | .Ar section | |
61 | and | |
62 | .Ar name | |
63 | combination. | |
64 | (Normally, only the first manual page found is displayed.) | |
65 | .It Fl c | |
66 | Copy the manual page to the standard output instead of using | |
67 | .Xr more 1 | |
68 | to paginate it. | |
69 | This is done by default if the standard output is not a terminal device. | |
70 | .It Fl h | |
71 | Display only the | |
72 | .Dq Tn SYNOPSIS | |
73 | lines of the requested manual pages. | |
74 | .It Fl M | |
75 | Override the list of standard directories which | |
76 | .Nm man | |
77 | searches for manual pages. | |
78 | The supplied | |
79 | .Ar path | |
80 | must be a colon (``:'') separated list of directories. | |
81 | This search path may also be set using the environment variable | |
82 | .Ev MANPATH . | |
83 | The subdirectories to be searched as well as their search order | |
84 | is specified by the ``_subdir'' line in the | |
85 | .Nm man | |
86 | configuration file. | |
87 | .It Fl m | |
88 | Augment the list of standard directories which | |
89 | .Nm man | |
90 | searches for manual pages. | |
91 | The supplied | |
92 | .Ar path | |
93 | must be a colon (``:'') separated list of directories. | |
94 | These directories will be searched before the standard directories or | |
95 | the directories specified using the | |
96 | .Fl M | |
97 | option or the | |
98 | .Ev MANPATH | |
99 | environment variable. | |
100 | .It Fl w | |
101 | List the pathnames of the manual pages which | |
102 | .Nm man | |
103 | would display for the specified | |
104 | .Ar section | |
105 | and | |
106 | .Ar name | |
107 | combination. | |
108 | .El | |
109 | .Pp | |
110 | The optional | |
111 | .Ar section | |
112 | restricts the directories that | |
113 | .Nm man | |
114 | will search. | |
115 | The | |
116 | .Nm man | |
117 | configuration file (see | |
118 | .Xr man_conf 5 ) | |
119 | specifies the possible | |
120 | .Ar section | |
121 | values that are currently available. | |
122 | If only a single argument is specified or if the first argument is | |
123 | not a valid section, | |
124 | .Nm man | |
125 | assumes that the argument is the name of a manual page to be displayed. | |
126 | .Sh ENVIRONMENT | |
127 | .Bl -tag -width MANPATHX | |
128 | .It Ev MACHINE | |
129 | As some manual pages are intended only for use on certain architectures, | |
130 | .Nm man | |
131 | searches certain directories applicable to the current machine. | |
132 | Man's | |
133 | determination of the current machine type may be overridden by setting | |
134 | the environment variable | |
135 | .Ev MACHINE | |
136 | to the name of an architecture (see | |
137 | .Xr machine 1 ) . | |
138 | Machine specific areas are checked before general areas. | |
139 | .It Ev MANPATH | |
140 | The standard search path used by | |
141 | .Nm man | |
142 | may be overridden by specifying a path in the | |
143 | .Ev MANPATH | |
144 | environment | |
145 | variable. | |
146 | The format of the path is a colon (``:'') separated list of directories. | |
147 | The subdirectories to be searched as well as their search order | |
148 | is specified by the ``_subdir'' line in the | |
149 | .Nm man | |
150 | configuration file. | |
151 | .It Ev PAGER | |
152 | Any value of the environment variable | |
153 | .Ev PAGER | |
154 | will be used instead of the standard pagination program | |
155 | .Xr more 1 . | |
156 | .El | |
157 | .Sh FILES | |
158 | .Bl -tag -width /etc/man.conf -compact | |
159 | .It Pa /etc/man.conf | |
160 | man configuration file (see | |
161 | .Xr man_conf 5 ) | |
162 | .El | |
163 | .Sh SEE ALSO | |
164 | .Xr apropos 1 , | |
165 | .Xr machine 1 , | |
166 | .Xr whatis 1 , | |
167 | .Xr whereis 1 , | |
168 | .Xr man_conf 5 | |
169 | .Sh BUGS | |
170 | The on-line manual pages are, by necessity, forgiving toward stupid | |
171 | display devices, causing some manual pages to not be as good as their | |
172 | typeset counterparts. | |
173 | .Sh HISTORY | |
174 | A | |
175 | .Nm | |
176 | command appeared in | |
177 | .At v6 . |