Commit | Line | Data |
---|---|---|
ef1f0408 CL |
1 | .\" Copyright (c) 1989, 1990 Regents of the University of California. |
2 | .\" All rights reserved. The Berkeley software License Agreement | |
3 | .\" specifies the terms and conditions for redistribution. | |
7400223d | 4 | .\" |
a201b3c4 | 5 | .\" @(#)man.1 6.11 (Berkeley) %G% |
0076013a | 6 | .\" |
ef1f0408 | 7 | .TH MAN 1 "%Q" |
7400223d KM |
8 | .UC 4 |
9 | .SH NAME | |
0076013a | 10 | man \- display the on-line manual pages |
7400223d | 11 | .SH SYNOPSIS |
0076013a KB |
12 | .nf |
13 | .ft B | |
011519cd | 14 | man [ -acw ] [ -M path ] [ -m path ] [ section ] name ... |
0076013a KB |
15 | .ft R |
16 | .fi | |
7400223d | 17 | .SH DESCRIPTION |
0076013a | 18 | .I Man |
011519cd KB |
19 | displays the UNIX manual pages entitled |
20 | .IR name . | |
7400223d | 21 | .PP |
0076013a KB |
22 | The options are as follows: |
23 | .TP | |
011519cd | 24 | a |
0076013a | 25 | Display all of the manual pages for a specified |
011519cd KB |
26 | .I section |
27 | and | |
28 | .I name | |
29 | combination. | |
0076013a KB |
30 | (Normally, only the first manual page found is displayed.) |
31 | .TP | |
011519cd | 32 | c |
0076013a | 33 | Copy the manual page to the standard output instead of using |
011519cd | 34 | .IR more (1) |
0076013a KB |
35 | to paginate it. |
36 | This is done by default if the standard output is not a terminal device. | |
37 | .TP | |
011519cd KB |
38 | M |
39 | Override the list of standard directories which | |
0076013a KB |
40 | .I man |
41 | searches for manual pages. | |
42 | The supplied | |
43 | .I path | |
44 | must be a colon (``:'') separated list of directories. | |
ef1f0408 | 45 | This search path may also be set using the environment variable |
0076013a | 46 | .IR MANPATH . |
a201b3c4 TH |
47 | The subdirectories to be searched as well as their search order |
48 | is specified by the ``_subdir'' line in the | |
49 | .I man | |
50 | configuration file. | |
0076013a | 51 | .TP |
011519cd KB |
52 | m |
53 | Augment the list of standard directories which | |
0076013a KB |
54 | .I man |
55 | searches for manual pages. | |
56 | The supplied | |
57 | .I path | |
58 | must be a colon (``:'') separated list of directories. | |
59 | These directories will be searched before the standard directories or | |
011519cd | 60 | the directories specified using the |
0076013a KB |
61 | .I M |
62 | option or the | |
63 | .I MANPATH | |
ef1f0408 | 64 | environment variable. |
0076013a KB |
65 | .TP |
66 | .I w | |
011519cd | 67 | List the pathnames of the manual pages which |
0076013a KB |
68 | .I man |
69 | would display for the specified | |
011519cd KB |
70 | .I section |
71 | and | |
72 | .I name | |
73 | combination. | |
09683da9 | 74 | .PP |
011519cd KB |
75 | The optional |
76 | .I section | |
77 | restricts the directories that | |
78 | .I man | |
79 | will search. | |
80 | The | |
0076013a | 81 | .I man |
011519cd | 82 | configuration file (see |
a201b3c4 | 83 | .IR man_conf (5)) |
011519cd KB |
84 | specifies the possible |
85 | .I section | |
86 | values that are currently available. | |
87 | If only a single argument is specified or if the first argument is | |
88 | not a valid section, | |
0076013a | 89 | .I man |
011519cd | 90 | assumes that the argument is the name of a manual page to be displayed. |
ef1f0408 | 91 | .SH ENVIRONMENT |
0076013a | 92 | .TP |
0076013a KB |
93 | MACHINE |
94 | As some manual pages are intended only for use on certain architectures, | |
95 | .I man | |
011519cd | 96 | searches certain directories applicable to the current machine. |
0076013a KB |
97 | .I Man's |
98 | determination of the current machine type may be overridden by setting | |
ef1f0408 | 99 | the environment variable MACHINE to the name of an architecture (see |
011519cd | 100 | .IR machine (1)). |
0076013a KB |
101 | Machine specific areas are checked before general areas. |
102 | .TP | |
011519cd | 103 | MANPATH |
0076013a KB |
104 | The standard search path used by |
105 | .I man | |
ef1f0408 | 106 | may be overridden by specifying a path in the MANPATH environment |
011519cd | 107 | variable. |
0076013a | 108 | The format of the path is a colon (``:'') separated list of directories. |
a201b3c4 TH |
109 | The subdirectories to be searched as well as their search order |
110 | is specified by the ``_subdir'' line in the | |
111 | .I man | |
112 | configuration file. | |
0076013a | 113 | .TP |
0076013a | 114 | PAGER |
ef1f0408 | 115 | Any value of the environment variable |
0076013a KB |
116 | .I PAGER |
117 | will be used instead of the standard pagination program | |
118 | .IR more (1). | |
7400223d | 119 | .SH FILES |
a201b3c4 TH |
120 | /etc/man.conf man configuration file (see |
121 | .IR man_conf (5)) | |
0076013a | 122 | .SH "SEE ALSO" |
a201b3c4 | 123 | apropos(1), machine(1), whatis(1), whereis(1), man_conf(5) |
7400223d | 124 | .SH BUGS |
0076013a KB |
125 | The on-line manual pages are, by necessity, forgiving toward stupid |
126 | display devices, causing some manual pages to not be as good as their | |
127 | typeset counterparts. |