version 1.169, 2017/01/10 12:53:07 |
version 1.186, 2017/05/17 22:43:56 |
|
|
.Os |
.Os |
.Sh NAME |
.Sh NAME |
.Nm mandoc |
.Nm mandoc |
.Nd format and display UNIX manuals |
.Nd format manual pages |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mandoc |
.Nm mandoc |
.Op Fl acfhkl |
.Op Fl ac |
.Op Fl I Cm os Ns = Ns Ar name |
.Op Fl I Cm os Ns = Ns Ar name |
.Op Fl K Ar encoding |
.Op Fl K Ar encoding |
.Op Fl m Ns Ar format |
.Op Fl mdoc | man |
.Op Fl O Ar option |
.Op Fl O Ar options |
.Op Fl T Ar output |
.Op Fl T Ar output |
.Op Fl W Ar level |
.Op Fl W Ar level |
.Op Ar |
.Op Ar |
|
|
.Xr mdoc 7 |
.Xr mdoc 7 |
or |
or |
.Xr man 7 |
.Xr man 7 |
text from stdin, implying |
text from stdin and produces |
.Fl m Ns Cm andoc , |
|
and produces |
|
.Fl T Cm locale |
.Fl T Cm locale |
output. |
output. |
.Pp |
.Pp |
Line 67 to paginate them. |
|
Line 65 to paginate them. |
|
This is the default. |
This is the default. |
It can be specified to override |
It can be specified to override |
.Fl a . |
.Fl a . |
.It Fl f |
|
A synonym for |
|
.Xr whatis 1 . |
|
This overrides any earlier |
|
.Fl k |
|
and |
|
.Fl l |
|
options. |
|
.It Fl h |
|
Display only the SYNOPSIS lines. |
|
Implies |
|
.Fl c . |
|
.It Fl I Cm os Ns = Ns Ar name |
.It Fl I Cm os Ns = Ns Ar name |
Override the default operating system |
Override the default operating system |
.Ar name |
.Ar name |
for the |
for the |
.Xr mdoc 7 |
.Xr mdoc 7 |
.Sq \&Os |
.Ic \&Os |
and for the |
and for the |
.Xr man 7 |
.Xr man 7 |
.Sq \&TH |
.Ic \&TH |
macro. |
macro. |
.It Fl K Ar encoding |
.It Fl K Ar encoding |
Specify the input encoding. |
Specify the input encoding. |
|
|
.Cm iso-8859-1 , |
.Cm iso-8859-1 , |
and |
and |
.Cm utf-8 . |
.Cm utf-8 . |
If not specified, autodetection uses the first match: |
If not specified, autodetection uses the first match in the following |
.Bl -tag -width iso-8859-1 |
list: |
.It Cm utf-8 |
.Bl -enum |
if the first three bytes of the input file |
.It |
are the UTF-8 byte order mark (BOM, 0xefbbbf) |
If the first three bytes of the input file are the UTF-8 byte order |
.It Ar encoding |
mark (BOM, 0xefbbbf), input is interpreted as |
if the first or second line of the input file matches the |
.Cm utf-8 . |
|
.It |
|
If the first or second line of the input file matches the |
.Sy emacs |
.Sy emacs |
mode line format |
mode line format |
.Pp |
.Pp |
.D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*- |
.D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*- |
.It Cm utf-8 |
.Pp |
if the first non-ASCII byte in the file introduces a valid UTF-8 sequence |
then input is interpreted according to |
.It Cm iso-8859-1 |
.Ar encoding . |
otherwise |
.It |
|
If the first non-ASCII byte in the file introduces a valid UTF-8 |
|
sequence, input is interpreted as |
|
.Cm utf-8 . |
|
.It |
|
Otherwise, input is interpreted as |
|
.Cm iso-8859-1 . |
.El |
.El |
.It Fl k |
.It Fl mdoc | man |
A synonym for |
With |
.Xr apropos 1 . |
.Fl mdoc , |
This overrides any earlier |
all input files are interpreted as |
.Fl f |
.Xr mdoc 7 . |
and |
With |
.Fl l |
.Fl man , |
options. |
all input files are interpreted as |
.It Fl l |
.Xr man 7 . |
A synonym for |
By default, the input language is automatically detected for each file: |
.Fl a . |
if the the first macro is |
Also reverts any earlier |
.Ic \&Dd |
.Fl f |
or |
and |
.Ic \&Dt , |
.Fl k |
the |
options. |
.Xr mdoc 7 |
.It Fl m Ns Ar format |
parser is used; otherwise, the |
Input format. |
.Xr man 7 |
See |
parser is used. |
.Sx Input Formats |
With other arguments, |
for available formats. |
.Fl m |
Defaults to |
is silently ignored. |
.Fl m Ns Cm andoc . |
.It Fl O Ar options |
.It Fl O Ar option |
|
Comma-separated output options. |
Comma-separated output options. |
.It Fl T Ar output |
.It Fl T Ar output |
Output format. |
Output format. |
Line 153 to be reported on the standard error output and to aff |
|
Line 146 to be reported on the standard error output and to aff |
|
The |
The |
.Ar level |
.Ar level |
can be |
can be |
|
.Cm style , |
.Cm warning , |
.Cm warning , |
.Cm error , |
.Cm error , |
or |
or |
.Cm unsupp ; |
.Cm unsupp ; |
.Cm all |
.Cm all |
is an alias for |
is an alias for |
.Cm warning . |
.Cm style . |
By default, |
By default, |
.Nm |
.Nm |
is silent. |
is silent. |
Line 190 If multiple files are specified, |
|
Line 184 If multiple files are specified, |
|
will halt with the first failed parse. |
will halt with the first failed parse. |
.El |
.El |
.Pp |
.Pp |
|
The options |
|
.Fl fhklw |
|
are also supported and are documented in man(1). |
In |
In |
.Fl f |
.Fl f |
and |
and |
|
|
mode, |
mode, |
.Nm |
.Nm |
also supports the options |
also supports the options |
.Fl CMmOSsw |
.Fl CMmOSs |
described in the |
described in the |
.Xr apropos 1 |
.Xr apropos 1 |
manual. |
manual. |
.Ss Input Formats |
The options |
The |
.Fl fkl |
.Nm |
are mutually exclusive and override each other. |
utility accepts |
|
.Xr mdoc 7 |
|
and |
|
.Xr man 7 |
|
input with |
|
.Fl m Ns Cm doc |
|
and |
|
.Fl m Ns Cm an , |
|
respectively. |
|
The |
|
.Xr mdoc 7 |
|
format is |
|
.Em strongly |
|
recommended; |
|
.Xr man 7 |
|
should only be used for legacy manuals. |
|
.Pp |
|
A third option, |
|
.Fl m Ns Cm andoc , |
|
which is also the default, determines encoding on-the-fly: if the first |
|
non-comment macro is |
|
.Sq \&Dd |
|
or |
|
.Sq \&Dt , |
|
the |
|
.Xr mdoc 7 |
|
parser is used; otherwise, the |
|
.Xr man 7 |
|
parser is used. |
|
.Pp |
|
If multiple |
|
files are specified with |
|
.Fl m Ns Cm andoc , |
|
each has its file-type determined this way. |
|
If multiple files are |
|
specified and |
|
.Fl m Ns Cm doc |
|
or |
|
.Fl m Ns Cm an |
|
is specified, then this format is used exclusively. |
|
.Ss Output Formats |
.Ss Output Formats |
The |
The |
.Nm |
.Nm |
utility accepts the following |
utility accepts the following |
.Fl T |
.Fl T |
arguments, which correspond to output modes: |
arguments, which correspond to output modes: |
.Bl -tag -width "-T locale" |
.Bl -tag -width "-T markdown" |
.It Fl T Cm ascii |
.It Fl T Cm ascii |
Produce 7-bit ASCII output. |
Produce 7-bit ASCII output. |
See |
See |
|
|
format output. |
format output. |
See |
See |
.Sx Man Output . |
.Sx Man Output . |
|
.It Fl T Cm markdown |
|
Produce output in |
|
.Sy markdown |
|
format. |
|
See |
|
.Sx Markdown Output . |
.It Fl T Cm pdf |
.It Fl T Cm pdf |
Produce PDF output. |
Produce PDF output. |
See |
See |
|
|
for example, |
for example, |
.Ar ../src/%I.html , |
.Ar ../src/%I.html , |
is used as a template for linked header files (usually via the |
is used as a template for linked header files (usually via the |
.Sq \&In |
.Ic \&In |
macro). |
macro). |
Instances of |
Instances of |
.Sq \&%I |
.Sq \&%I |
|
|
for example, |
for example, |
.Ar ../html%S/%N.%S.html , |
.Ar ../html%S/%N.%S.html , |
is used as a template for linked manuals (usually via the |
is used as a template for linked manuals (usually via the |
.Sq \&Xr |
.Ic \&Xr |
macro). |
macro). |
Instances of |
Instances of |
.Sq \&%N |
.Sq \&%N |
Line 436 If the input format is |
|
Line 399 If the input format is |
|
.Xr man 7 , |
.Xr man 7 , |
the input is copied to the output, expanding any |
the input is copied to the output, expanding any |
.Xr roff 7 |
.Xr roff 7 |
.Sq so |
.Ic so |
requests. |
requests. |
The parser is also run, and as usual, the |
The parser is also run, and as usual, the |
.Fl W |
.Fl W |
level controls which |
level controls which |
.Sx DIAGNOSTICS |
.Sx DIAGNOSTICS |
are displayed before copying the input to the output. |
are displayed before copying the input to the output. |
|
.Ss Markdown Output |
|
Translate |
|
.Xr mdoc 7 |
|
input to the |
|
.Sy markdown |
|
format conforming to |
|
.Lk http://daringfireball.net/projects/markdown/syntax.text\ |
|
"John Gruber's 2004 specification" . |
|
The output also almost conforms to the |
|
.Lk http://commonmark.org/ CommonMark |
|
specification. |
|
.Pp |
|
The character set used for the markdown output is ASCII. |
|
Non-ASCII characters are encoded as HTML entities. |
|
Since that is not possible in literal font contexts, because these |
|
are rendered as code spans and code blocks in the markdown output, |
|
non-ASCII characters are transliterated to ASCII approximations in |
|
these contexts. |
|
.Pp |
|
Markdown is a very weak markup language, so all semantic markup is |
|
lost, and even part of the presentational markup may be lost. |
|
Do not use this as an intermediate step in converting to HTML; |
|
instead, use |
|
.Fl T Cm html |
|
directly. |
|
.Pp |
|
The |
|
.Xr man 7 , |
|
.Xr tbl 7 , |
|
and |
|
.Xr eqn 7 |
|
input languages are not supported by |
|
.Fl T Cm markdown |
|
output mode. |
.Ss PDF Output |
.Ss PDF Output |
PDF-1.1 output may be generated by |
PDF-1.1 output may be generated by |
.Fl T Cm pdf . |
.Fl T Cm pdf . |
|
|
to show a human readable representation of the syntax tree. |
to show a human readable representation of the syntax tree. |
It is useful for debugging the source code of manual pages. |
It is useful for debugging the source code of manual pages. |
The exact format is subject to change, so don't write parsers for it. |
The exact format is subject to change, so don't write parsers for it. |
Each output line shows one syntax tree node. |
.Pp |
|
The first paragraph shows meta data found in the |
|
.Xr mdoc 7 |
|
prologue, on the |
|
.Xr man 7 |
|
.Ic \&TH |
|
line, or the fallbacks used. |
|
.Pp |
|
In the tree dump, each output line shows one syntax tree node. |
Child nodes are indented with respect to their parent node. |
Child nodes are indented with respect to their parent node. |
The columns are: |
The columns are: |
.Pp |
.Pp |
Line 530 A closing parenthesis if the node is a closing delimit |
|
Line 535 A closing parenthesis if the node is a closing delimit |
|
.It |
.It |
A full stop if the node ends a sentence. |
A full stop if the node ends a sentence. |
.It |
.It |
|
BROKEN if the node is a block broken by another block. |
|
.It |
NOSRC if the node is not in the input file, |
NOSRC if the node is not in the input file, |
but automatically generated from macros. |
but automatically generated from macros. |
.It |
.It |
Line 537 NOPRT if the node is not supposed to generate output |
|
Line 544 NOPRT if the node is not supposed to generate output |
|
for any output format. |
for any output format. |
.El |
.El |
.El |
.El |
|
.Pp |
|
The following |
|
.Fl O |
|
argument is accepted: |
|
.Bl -tag -width Ds |
|
.It Cm noval |
|
Skip validation and show the unvalidated syntax tree. |
|
This can help to find out whether a given behaviour is caused by |
|
the parser or by the validator. |
|
Meta data is not available in this case. |
|
.El |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Bl -tag -width MANPAGER |
.Bl -tag -width MANPAGER |
.It Ev MANPAGER |
.It Ev MANPAGER |
Any non-empty value of the environment variable |
Any non-empty value of the environment variable |
.Ev MANPAGER |
.Ev MANPAGER |
will be used instead of the standard pagination program, |
is used instead of the standard pagination program, |
.Xr more 1 . |
.Xr more 1 ; |
|
see |
|
.Xr man 1 |
|
for details. |
|
Only used if |
|
.Fl a |
|
or |
|
.Fl l |
|
is specified. |
.It Ev PAGER |
.It Ev PAGER |
Specifies the pagination program to use when |
Specifies the pagination program to use when |
.Ev MANPAGER |
.Ev MANPAGER |
|
|
If neither PAGER nor MANPAGER is defined, |
If neither PAGER nor MANPAGER is defined, |
.Xr more 1 |
.Xr more 1 |
.Fl s |
.Fl s |
will be used. |
is used. |
|
Only used if |
|
.Fl a |
|
or |
|
.Fl l |
|
is specified. |
.El |
.El |
.Sh EXIT STATUS |
.Sh EXIT STATUS |
The |
The |
|
|
.Pp |
.Pp |
.Bl -tag -width Ds -compact |
.Bl -tag -width Ds -compact |
.It 0 |
.It 0 |
No warnings or errors occurred, or those that did were ignored because |
No style suggestions, warnings or errors occurred, or those that |
they were lower than the requested |
did were ignored because they were lower than the requested |
.Ar level . |
.Ar level . |
|
.It 1 |
|
At least one style suggestion occurred, but no warning or error, and |
|
.Fl W Cm style |
|
was specified. |
.It 2 |
.It 2 |
At least one warning occurred, but no error, and |
At least one warning occurred, but no error, and |
.Fl W Cm warning |
.Fl W Cm warning |
|
or |
|
.Fl W Cm style |
was specified. |
was specified. |
.It 3 |
.It 3 |
At least one parsing error occurred, |
At least one parsing error occurred, |
but no unsupported feature was encountered, and |
but no unsupported feature was encountered, and |
.Fl W Cm error |
.Fl W Cm error |
or |
or a lower |
.Fl W Cm warning |
.Ar level |
was specified. |
was requested. |
.It 4 |
.It 4 |
At least one unsupported feature was encountered, and |
At least one unsupported feature was encountered, and |
.Fl W Cm unsupp , |
.Fl W Cm unsupp |
.Fl W Cm error |
or a lower |
or |
.Ar level |
.Fl W Cm warning |
was requested. |
was specified. |
|
.It 5 |
.It 5 |
Invalid command line arguments were specified. |
Invalid command line arguments were specified. |
No input files have been read. |
No input files have been read. |
Line 684 rendering can be produced. |
|
Line 720 rendering can be produced. |
|
Documents causing warnings may render poorly when using other |
Documents causing warnings may render poorly when using other |
formatting tools instead of |
formatting tools instead of |
.Nm . |
.Nm . |
|
.It Cm style |
|
An input file uses dubious or discouraged style. |
|
This is not a complaint about the syntax, and probably neither |
|
formatting nor portability are in danger. |
|
While great care is taken to avoid false positives on the higher |
|
message levels, the |
|
.Cm style |
|
level tries to reduce the probability that issues go unnoticed, |
|
so it may occasionally issue bogus suggestions. |
|
Please use your good judgement to decide whether any particular |
|
.Cm style |
|
suggestion really justifies a change to the input file. |
.El |
.El |
.Pp |
.Pp |
Messages of the |
Messages of the |
|
.Cm style , |
.Cm warning , |
.Cm warning , |
.Cm error , |
.Cm error , |
and |
and |
|
|
.Ic \&Nd |
.Ic \&Nd |
macro lacks the required argument. |
macro lacks the required argument. |
The title line of the manual will end after the dash. |
The title line of the manual will end after the dash. |
|
.It Sy "description line outside NAME section" |
|
.Pq mdoc |
|
An |
|
.Ic \&Nd |
|
macro appears outside the NAME section. |
|
The arguments are printed anyway and the following text is used for |
|
.Xr apropos 1 , |
|
but none of that behaviour is portable. |
.It Sy "sections out of conventional order" |
.It Sy "sections out of conventional order" |
.Pq mdoc |
.Pq mdoc |
A standard section occurs after another section it usually precedes. |
A standard section occurs after another section it usually precedes. |
|
|
.Ic \&Bl |
.Ic \&Bl |
.Fl offset |
.Fl offset |
or |
or |
.Fl width. |
.Fl width . |
.It Sy "missing display type, using -ragged" |
.It Sy "missing display type, using -ragged" |
.Pq mdoc |
.Pq mdoc |
The |
The |
Line 1349 it is hard to predict which tab stop position the tab |
|
Line 1406 it is hard to predict which tab stop position the tab |
|
Whitespace at the end of input lines is almost never semantically |
Whitespace at the end of input lines is almost never semantically |
significant \(em but in the odd case where it might be, it is |
significant \(em but in the odd case where it might be, it is |
extremely confusing when reviewing and maintaining documents. |
extremely confusing when reviewing and maintaining documents. |
|
.It Sy "new sentence, new line" |
|
.Pq mdoc |
|
A new sentence starts in the middle of a text line. |
|
Start it on a new input line to help formatters produce correct spacing. |
.It Sy "bad comment style" |
.It Sy "bad comment style" |
.Pq roff |
.Pq roff |
Comment lines start with a dot, a backslash, and a double-quote character. |
Comment lines start with a dot, a backslash, and a double-quote character. |
Line 1824 as if they were a text line. |
|
Line 1885 as if they were a text line. |
|
.Xr mdoc 7 , |
.Xr mdoc 7 , |
.Xr roff 7 , |
.Xr roff 7 , |
.Xr tbl 7 |
.Xr tbl 7 |
|
.Sh HISTORY |
|
The |
|
.Nm |
|
utility first appeared in |
|
.Ox 4.8 . |
|
The option |
|
.Fl I |
|
appeared in |
|
.Ox 5.2 , |
|
and |
|
.Fl aCcfhKklMSsw |
|
in |
|
.Ox 5.7 . |
.Sh AUTHORS |
.Sh AUTHORS |
.An -nosplit |
.An -nosplit |
The |
The |
Line 1832 utility was written by |
|
Line 1906 utility was written by |
|
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv |
and is maintained by |
and is maintained by |
.An Ingo Schwarze Aq Mt schwarze@openbsd.org . |
.An Ingo Schwarze Aq Mt schwarze@openbsd.org . |
.Sh BUGS |
|
In |
|
.Fl T Cm html , |
|
the maximum size of an element attribute is determined by |
|
.Dv BUFSIZ , |
|
which is usually 1024 bytes. |
|
Be aware of this when setting long link |
|
formats such as |
|
.Fl O Cm style Ns = Ns Ar really/long/link . |
|