Commit | Line | Data |
---|---|---|
a860ef9e KB |
1 | .\" Copyright (c) 1989, 1990 The Regents of the University of California. |
2 | .\" All rights reserved. | |
7400223d | 3 | .\" |
a860ef9e KB |
4 | .\" %sccs.include.redist.roff% |
5 | .\" | |
0fddc86d | 6 | .\" @(#)man.1 6.14 (Berkeley) %G% |
0076013a | 7 | .\" |
0fddc86d CL |
8 | .Dd |
9 | .Dt MAN 1 | |
10 | .Os BSD 4 | |
11 | .Sh NAME | |
12 | .Nm man | |
13 | .Nd display the on-line manual pages | |
14 | .Sh SYNOPSIS | |
15 | .Nm man | |
16 | .Op Fl achw | |
17 | .Op Fl M Ar path | |
18 | .Op Fl m Ar path | |
19 | .Op Ar section | |
20 | .Ar name Ar ... | |
21 | .Sh DESCRIPTION | |
22 | The | |
23 | .Nm man | |
24 | utility | |
25 | displays the | |
26 | .Bx | |
27 | manual pages entitled | |
28 | .Ar name . | |
29 | .Pp | |
0076013a | 30 | The options are as follows: |
0fddc86d CL |
31 | .Bl -tag -width indent |
32 | .It Fl a | |
0076013a | 33 | Display all of the manual pages for a specified |
0fddc86d | 34 | .Ar section |
011519cd | 35 | and |
0fddc86d | 36 | .Ar name |
011519cd | 37 | combination. |
0076013a | 38 | (Normally, only the first manual page found is displayed.) |
0fddc86d | 39 | .It Fl c |
0076013a | 40 | Copy the manual page to the standard output instead of using |
0fddc86d | 41 | .Xr more 1 |
0076013a KB |
42 | to paginate it. |
43 | This is done by default if the standard output is not a terminal device. | |
0fddc86d CL |
44 | .It Fl h |
45 | Display only the | |
46 | .Dq Tn SYNOPSIS | |
47 | lines of the requested manual pages. | |
48 | .It Fl M | |
011519cd | 49 | Override the list of standard directories which |
0fddc86d | 50 | .Nm man |
0076013a KB |
51 | searches for manual pages. |
52 | The supplied | |
0fddc86d | 53 | .Ar path |
0076013a | 54 | must be a colon (``:'') separated list of directories. |
ef1f0408 | 55 | This search path may also be set using the environment variable |
0fddc86d | 56 | .Ev MANPATH . |
a201b3c4 TH |
57 | The subdirectories to be searched as well as their search order |
58 | is specified by the ``_subdir'' line in the | |
0fddc86d | 59 | .Nm man |
a201b3c4 | 60 | configuration file. |
0fddc86d | 61 | .It Fl m |
011519cd | 62 | Augment the list of standard directories which |
0fddc86d | 63 | .Nm man |
0076013a KB |
64 | searches for manual pages. |
65 | The supplied | |
0fddc86d | 66 | .Ar path |
0076013a KB |
67 | must be a colon (``:'') separated list of directories. |
68 | These directories will be searched before the standard directories or | |
011519cd | 69 | the directories specified using the |
0fddc86d | 70 | .Fl M |
0076013a | 71 | option or the |
0fddc86d | 72 | .Ev MANPATH |
ef1f0408 | 73 | environment variable. |
0fddc86d | 74 | .It Fl w |
011519cd | 75 | List the pathnames of the manual pages which |
0fddc86d | 76 | .Nm man |
0076013a | 77 | would display for the specified |
0fddc86d | 78 | .Ar section |
011519cd | 79 | and |
0fddc86d | 80 | .Ar name |
011519cd | 81 | combination. |
0fddc86d CL |
82 | .El |
83 | .Pp | |
011519cd | 84 | The optional |
0fddc86d | 85 | .Ar section |
011519cd | 86 | restricts the directories that |
0fddc86d | 87 | .Nm man |
011519cd KB |
88 | will search. |
89 | The | |
0fddc86d | 90 | .Nm man |
011519cd | 91 | configuration file (see |
0fddc86d | 92 | .Xr man_conf 5 ) |
011519cd | 93 | specifies the possible |
0fddc86d | 94 | .Ar section |
011519cd KB |
95 | values that are currently available. |
96 | If only a single argument is specified or if the first argument is | |
97 | not a valid section, | |
0fddc86d | 98 | .Nm man |
011519cd | 99 | assumes that the argument is the name of a manual page to be displayed. |
0fddc86d CL |
100 | .Sh ENVIRONMENT |
101 | .Bl -tag -width MANPATHX | |
102 | .It Ev MACHINE | |
0076013a | 103 | As some manual pages are intended only for use on certain architectures, |
0fddc86d | 104 | .Nm man |
011519cd | 105 | searches certain directories applicable to the current machine. |
0fddc86d | 106 | Man's |
0076013a | 107 | determination of the current machine type may be overridden by setting |
0fddc86d CL |
108 | the environment variable |
109 | .Ev MACHINE | |
110 | to the name of an architecture (see | |
111 | .Xr machine 1 ) . | |
0076013a | 112 | Machine specific areas are checked before general areas. |
0fddc86d | 113 | .It Ev MANPATH |
0076013a | 114 | The standard search path used by |
0fddc86d CL |
115 | .Nm man |
116 | may be overridden by specifying a path in the | |
117 | .Ev MANPATH | |
118 | environment | |
011519cd | 119 | variable. |
0076013a | 120 | The format of the path is a colon (``:'') separated list of directories. |
a201b3c4 TH |
121 | The subdirectories to be searched as well as their search order |
122 | is specified by the ``_subdir'' line in the | |
0fddc86d | 123 | .Nm man |
a201b3c4 | 124 | configuration file. |
0fddc86d | 125 | .It Ev PAGER |
ef1f0408 | 126 | Any value of the environment variable |
0fddc86d | 127 | .Ev PAGER |
0076013a | 128 | will be used instead of the standard pagination program |
0fddc86d CL |
129 | .Xr more 1 . |
130 | .El | |
131 | .Sh FILES | |
132 | .Bl -tag -width /etc/man.conf -compact | |
133 | .It Pa /etc/man.conf | |
134 | man configuration file (see | |
135 | .Xr man_conf 5 ) | |
136 | .El | |
137 | .Sh SEE ALSO | |
138 | .Xr apropos 1 , | |
139 | .Xr machine 1 , | |
140 | .Xr whatis 1 , | |
141 | .Xr whereis 1 , | |
142 | .Xr man_conf 5 | |
143 | .Sh BUGS | |
0076013a KB |
144 | The on-line manual pages are, by necessity, forgiving toward stupid |
145 | display devices, causing some manual pages to not be as good as their | |
146 | typeset counterparts. | |
0fddc86d CL |
147 | .Sh HISTORY |
148 | A | |
149 | .Nm | |
150 | command appeared in | |
151 | .At v6 . |