version 1.26, 2017/03/25 12:46:36 |
version 1.30, 2017/08/09 12:49:04 |
|
|
.Nm man |
.Nm man |
.Op Fl acfhklw |
.Op Fl acfhklw |
.Op Fl C Ar file |
.Op Fl C Ar file |
.Op Fl I Cm os Ns = Ns Ar name |
|
.Op Fl K Ar encoding |
|
.Op Fl M Ar path |
.Op Fl M Ar path |
.Op Fl m Ar path |
.Op Fl m Ar path |
.Op Fl O Ar option Ns = Ns Ar value |
|
.Op Fl S Ar subsection |
.Op Fl S Ar subsection |
.Op Fl s Ar section |
.Op Oo Fl s Oc Ar section |
.Op Fl T Ar output |
|
.Op Fl W Ar level |
|
.Op Ar section |
|
.Ar name ... |
.Ar name ... |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
Line 84 Copy the manual page to the standard output instead of |
|
Line 78 Copy the manual page to the standard output instead of |
|
.Xr more 1 |
.Xr more 1 |
to paginate it. |
to paginate it. |
This is done by default if the standard output is not a terminal device. |
This is done by default if the standard output is not a terminal device. |
|
.Pp |
|
When using |
|
.Fl c , |
|
most terminal devices are unable to show the markup. |
|
To print the output of |
|
.Nm |
|
to the terminal with markup but without using a pager, pipe it to |
|
.Xr ul 1 . |
|
To remove the markup, pipe the output to |
|
.Xr col 1 |
|
.Fl b |
|
instead. |
.It Fl f |
.It Fl f |
A synonym for |
A synonym for |
.Xr whatis 1 . |
.Xr whatis 1 . |
|
|
.Ar name |
.Ar name |
in manual page names and displays the header lines from all matching pages. |
in manual page names and displays the header lines from all matching pages. |
The search is case insensitive and matches whole words only. |
The search is case insensitive and matches whole words only. |
This overrides any earlier |
|
.Fl k |
|
and |
|
.Fl l |
|
options. |
|
.It Fl h |
.It Fl h |
Display only the SYNOPSIS lines of the requested manual pages. |
Display only the SYNOPSIS lines of the requested manual pages. |
Implies |
Implies |
Line 111 an expression can be provided using the syntax describ |
|
Line 112 an expression can be provided using the syntax describ |
|
.Xr apropos 1 |
.Xr apropos 1 |
manual. |
manual. |
By default, it displays the header lines of all matching pages. |
By default, it displays the header lines of all matching pages. |
This overrides any earlier |
|
.Fl f |
|
and |
|
.Fl l |
|
options. |
|
.It Fl l |
.It Fl l |
A synonym for |
A synonym for |
.Xr mandoc 1 |
.Xr mandoc 1 |
Line 127 No search is done and |
|
Line 123 No search is done and |
|
.Ar file , |
.Ar file , |
.Ar path , |
.Ar path , |
.Ar section , |
.Ar section , |
|
.Ar subsection , |
and |
and |
.Ar subsection |
|
are ignored. |
|
This overrides any earlier |
|
.Fl f , |
|
.Fl k , |
|
and |
|
.Fl w |
.Fl w |
options. |
are ignored. |
.It Fl M Ar path |
.It Fl M Ar path |
Override the list of standard directories which |
Override the list of standard directories which |
.Nm |
.Nm |
|
|
.Fl IKOTW |
.Fl IKOTW |
are also supported and are documented in |
are also supported and are documented in |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
|
The options |
|
.Fl fkl |
|
are mutually exclusive and override each other. |
.Pp |
.Pp |
Guidelines for writing |
Guidelines for writing |
man pages can be found in |
man pages can be found in |
Line 280 environment variable. |
|
Line 274 environment variable. |
|
The format of the path is a colon |
The format of the path is a colon |
.Pq Ql \&: |
.Pq Ql \&: |
separated list of directories. |
separated list of directories. |
Invalid paths, or paths without manual databases, are ignored. |
Invalid paths are ignored. |
Overridden by |
Overridden by |
.Fl M , |
.Fl M , |
ignored if |
ignored if |
|
|
for details. |
for details. |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr apropos 1 , |
.Xr apropos 1 , |
.Xr intro 1 , |
.Xr col 1 , |
|
.Xr mandoc 1 , |
|
.Xr ul 1 , |
.Xr whereis 1 , |
.Xr whereis 1 , |
.Xr intro 2 , |
|
.Xr intro 3 , |
|
.Xr intro 4 , |
|
.Xr intro 5 , |
|
.Xr man.conf 5 , |
.Xr man.conf 5 , |
.Xr intro 6 , |
.Xr mdoc 7 |
.Xr intro 7 , |
|
.Xr mdoc 7 , |
|
.Xr intro 8 , |
|
.Xr intro 9 |
|
.Sh STANDARDS |
.Sh STANDARDS |
The |
The |
.Nm |
.Nm |