Return to man.1 CVS log | Up to [cvsweb.bsd.lv] / mandoc |
version 1.5, 2014/09/03 05:22:45 | version 1.13, 2015/02/16 16:23:54 | ||
---|---|---|---|
|
|
||
.\" Copyright (c) 1989, 1990, 1993 | .\" Copyright (c) 1989, 1990, 1993 | ||
.\" The Regents of the University of California. All rights reserved. | .\" The Regents of the University of California. All rights reserved. | ||
.\" Copyright (c) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org> | .\" Copyright (c) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org> | ||
.\" Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org> | .\" Copyright (c) 2010, 2011, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org> | ||
.\" | .\" | ||
.\" Redistribution and use in source and binary forms, with or without | .\" Redistribution and use in source and binary forms, with or without | ||
.\" modification, are permitted provided that the following conditions | .\" modification, are permitted provided that the following conditions | ||
|
|
||
.Nd display manual pages | .Nd display manual pages | ||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||
.Nm man | .Nm man | ||
.Op Fl acfhklVw | .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 Fl s Ar section | ||
.Op Fl T Ar output | |||
.Op Fl W Ar level | |||
.Op Ar section | .Op Ar section | ||
.Ar name ... | .Ar name ... | ||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||
|
|
||
and | and | ||
.Fl l | .Fl l | ||
options. | options. | ||
.It Fl I Cm os Ns = Ns Ar name | |||
Override the default operating system | |||
.Ar name | |||
for the | |||
.Xr mdoc 7 | |||
.Ic \&Os | |||
and for the | |||
.Xr man 7 | |||
.Ic \&TH | |||
macro. | |||
.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 | ||
.Fl a . | .Fl a | ||
and | |||
.Fl c . | |||
.It Fl K Ar encoding | |||
Specify the input encoding. | |||
The supported | |||
.Ar encoding | |||
arguments are | |||
.Cm us-ascii , | |||
.Cm iso-8859-1 , | |||
and | |||
.Cm utf-8 . | |||
By default, the encoding is automatically detected as described in the | |||
.Xr mandoc 1 | |||
manual. | |||
.It Fl k | .It Fl k | ||
A synonym for | A synonym for | ||
.Xr apropos 1 . | .Xr apropos 1 . | ||
|
|
||
line in the | line in the | ||
.Nm | .Nm | ||
configuration file. | configuration file. | ||
.It Fl O Ar option Ns = Ns Ar value | |||
Comma-separated output options. | |||
For each output format, the available options are described in the | |||
.Xr mandoc 1 | |||
manual. | |||
.It Fl S Ar subsection | .It Fl S Ar subsection | ||
Restricts the directories that | Restricts the directories that | ||
.Nm | .Nm | ||
|
|
||
.Ar section | .Ar section | ||
values, and their search order. | values, and their search order. | ||
Additional sections may be specified. | Additional sections may be specified. | ||
.It Fl V | .It Fl T Ar output | ||
Print version and exit. | Select the output format. | ||
The default is | |||
.Cm locale . | |||
The other output modes | |||
.Cm ascii , | |||
.Cm html , | |||
.Cm lint , | |||
.Cm man , | |||
.Cm pdf , | |||
.Cm ps , | |||
.Cm tree , | |||
and | |||
.Cm utf8 | |||
are described in the | |||
.Xr mandoc 1 | |||
manual. | |||
.It Fl W Ar level | |||
Specify the minimum message | |||
.Ar level | |||
to be reported on the standard error output and to affect the exit status. | |||
The | |||
.Ar level | |||
can be | |||
.Cm warning , | |||
.Cm error , | |||
or | |||
.Cm unsupp ; | |||
.Cm all | |||
is an alias for | |||
.Cm warning . | |||
By default, | |||
.Nm | |||
is silent. | |||
See the | |||
.Xr mandoc 1 | |||
manual for details. | |||
.It Fl w | .It Fl w | ||
List the pathnames of the manual pages which | List the pathnames of the manual pages which | ||
.Nm | .Nm | ||
|
|
||
combination. | combination. | ||
.El | .El | ||
.Pp | .Pp | ||
The | |||
.Nm | |||
utility also supports the options | |||
.Fl IOTW | |||
described in the | |||
.Xr mandoc 1 | |||
manual. | |||
.Pp | |||
Guidelines for writing | Guidelines for writing | ||
man pages can be found in | man pages can be found in | ||
.Xr mdoc 7 . | .Xr mdoc 7 . | ||
|
|
||
specification. | specification. | ||
.Pp | .Pp | ||
The flags | The flags | ||
.Op Fl aCcfhMmSsw , | .Op Fl aCcfhIKlMmOSsTWw , | ||
as well as the environment variables | as well as the environment variables | ||
.Ev MACHINE , | .Ev MACHINE , | ||
.Ev MANPAGER , | .Ev MANPAGER , |