version 1.23, 2009/06/25 10:51:55 |
version 1.74, 2010/08/07 17:46:39 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
.\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt MANDOC 1 |
.Dt MANDOC 1 |
.Os |
.Os |
.\" SECTION |
|
.Sh NAME |
.Sh NAME |
.Nm mandoc |
.Nm mandoc |
.Nd format and display UNIX manuals |
.Nd format and display UNIX manuals |
.\" SECTION |
|
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mandoc |
.Nm mandoc |
.Op Fl V |
.Op Fl V |
.Op Fl f Ns Ar option... |
.Op Fl f Ns Ar option |
.Op Fl m Ns Ar format |
.Op Fl m Ns Ar format |
.Op Fl W Ns Ar err... |
.Op Fl O Ns Ar option |
.Op Fl T Ns Ar output |
.Op Fl T Ns Ar output |
.Op Ar infile... |
.Op Fl W Ns Ar err |
.\" SECTION |
.Op Ar file... |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility formats |
utility formats |
.Ux |
.Ux |
manual pages for display. The arguments are as follows: |
manual pages for display. |
|
The arguments are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.\" ITEM |
.It Fl f Ns Ar option |
.It Fl f Ns Ar option... |
Comma-separated compiler options. |
Override default compiler behaviour. See |
See |
.Sx Compiler Options |
.Sx Compiler Options |
for details. |
for details. |
.\" ITEM |
|
.It Fl m Ns Ar format |
.It Fl m Ns Ar format |
Input format. See |
Input format. |
|
See |
.Sx Input Formats |
.Sx Input Formats |
for available formats. Defaults to |
for available formats. |
.Fl m Ns Ar andoc . |
Defaults to |
.\" ITEM |
.Fl m Ns Cm andoc . |
|
.It Fl O Ns Ar option |
|
Comma-separated output options. |
.It Fl T Ns Ar output |
.It Fl T Ns Ar output |
Output format. See |
Output format. |
|
See |
.Sx Output Formats |
.Sx Output Formats |
for available formats. Defaults to |
for available formats. |
.Fl T Ns Ar ascii . |
Defaults to |
.\" ITEM |
.Fl T Ns Cm ascii . |
.It Fl V |
.It Fl V |
Print version and exit. |
Print version and exit. |
.\" ITEM |
.It Fl W Ns Ar err |
.It Fl W Ns Ar err... |
Comma-separated warning options. |
Print warning messages. May be set to |
Use |
.Fl W Ns Ar all |
.Fl W Ns Cm all |
for all warnings, |
to print warnings, |
.Ar compat |
.Fl W Ns Cm error |
for groff/troff-compatibility warnings, or |
for warnings to be considered errors and cause utility |
.Ar syntax |
termination. |
for syntax warnings. If |
Multiple |
.Fl W Ns Ar error |
|
is specified, warnings are considered errors and cause utility |
|
termination. Multiple |
|
.Fl W |
.Fl W |
arguments may be comma-separated, such as |
arguments may be comma-separated, such as |
.Fl W Ns Ar error,all . |
.Fl W Ns Cm error , Ns Cm all . |
.\" ITEM |
.It Ar file |
.It Ar infile... |
Read input from zero or more files. |
Read input from zero or more |
If unspecified, reads from stdin. |
.Ar infile . |
If multiple files are specified, |
If unspecified, reads from stdin. If multiple files are specified, |
|
.Nm |
.Nm |
will halt with the first failed parse. |
will halt with the first failed parse. |
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
By default, |
By default, |
.Nm |
.Nm |
reads |
reads |
.Xr mdoc 7 |
.Xr mdoc 7 |
or |
or |
.Xr man 7 |
.Xr man 7 |
text from stdin, implying |
text from stdin, implying |
.Fl m Ns Ar andoc , |
.Fl m Ns Cm andoc , |
and prints 78-column backspace-encoded output to stdout as if |
and produces |
.Fl T Ns Ar ascii |
.Fl T Ns Cm ascii |
were provided. |
output. |
.\" PARAGRAPH |
|
.Pp |
.Pp |
.Ex -std mandoc |
.Ex -std mandoc |
.\" SUB-SECTION |
|
.Ss Punctuation and Spacing |
|
If punctuation is set apart from words, such as in the phrase |
|
.Dq to be \&, or not to be , |
|
it's processed by |
|
.Nm |
|
according to the following rules: opening punctuation |
|
.Po |
|
.Sq \&( , |
|
.Sq \&[ , |
|
and |
|
.Sq \&{ |
|
.Pc |
|
is not followed by a space; closing punctuation |
|
.Po |
|
.Sq \&. , |
|
.Sq \&, , |
|
.Sq \&; , |
|
.Sq \&: , |
|
.Sq \&? , |
|
.Sq \&! , |
|
.Sq \&) , |
|
.Sq \&] |
|
and |
|
.Sq \&} |
|
.Pc |
|
is not preceded by whitespace. |
|
.Pp |
|
If the input is |
|
.Xr mdoc 7 , |
|
these rules are also applied to macro arguments when appropriate. |
|
.Pp |
|
White-space, in non-literal (normal) mode, is stripped from input and |
|
replaced on output by a single space. Thus, if you wish to preserve |
|
multiple spaces, they must be space-escaped |
|
.Sq \e\ |
|
or used in a literal display mode, e.g., |
|
.Sq \&.Bd \-literal |
|
in |
|
.Xr mdoc 7 . |
|
.\" SUB-SECTION |
|
.Ss Input Formats |
.Ss Input Formats |
The |
The |
.Nm |
.Nm |
|
|
and |
and |
.Xr man 7 |
.Xr man 7 |
input with |
input with |
.Fl m Ns Ar doc |
.Fl m Ns Cm doc |
and |
and |
.Fl m Ns Ar an , |
.Fl m Ns Cm an , |
respectively. The |
respectively. |
|
The |
.Xr mdoc 7 |
.Xr mdoc 7 |
format is |
format is |
.Em strongly |
.Em strongly |
recommended; |
recommended; |
.Xr man 7 |
.Xr man 7 |
should only be used for legacy manuals. |
should only be used for legacy manuals. |
.Pp |
.Pp |
A third option, |
A third option, |
.Fl m Ns Ar andoc , |
.Fl m Ns Cm andoc , |
which is also the default, determines encoding on-the-fly: if the first |
which is also the default, determines encoding on-the-fly: if the first |
non-comment macro is |
non-comment macro is |
.Sq \&.Dd |
.Sq \&Dd |
or |
or |
.Sq \&.Dt , |
.Sq \&Dt , |
the |
the |
.Xr mdoc 7 |
.Xr mdoc 7 |
parser is used; otherwise, the |
parser is used; otherwise, the |
.Xr man 7 |
.Xr man 7 |
parser is used. |
parser is used. |
.Pp |
.Pp |
If multiple |
If multiple |
files are specified with |
files are specified with |
.Fl m Ns Ar andoc , |
.Fl m Ns Cm andoc , |
each has its file-type determined this way. If multiple files are |
each has its file-type determined this way. |
|
If multiple files are |
specified and |
specified and |
.Fl m Ns Ar doc |
.Fl m Ns Cm doc |
or |
or |
.Fl m Ns Ar an |
.Fl m Ns Cm an |
is specified, then this format is used exclusively. |
is specified, then this format is used exclusively. |
.\" .Pp |
.Ss Compiler Options |
.\" The following escape sequences are recognised, although the per-format |
Default |
.\" compiler may not allow certain sequences. |
.Xr mdoc 7 |
.\" .Bl -tag -width Ds -offset XXXX |
and |
.\" .It \efX |
.Xr man 7 |
.\" sets the font mode to X (B, I, R or P, where P resets the font) |
compilation behaviour may be overridden with the |
.\" .It \eX, \e(XX, \e[XN] |
.Fl f |
.\" queries the special-character table for a corresponding symbol |
flag. |
.\" .It \e*X, \e*(XX, \e*[XN] |
.Bl -tag -width Ds |
.\" deprecated special-character format |
.It Fl f Ns Cm ign-errors |
.\" .El |
When parsing multiple files, don't halt when one errors out. |
.\" SUB-SECTION |
Useful with |
|
.Fl T Ns Cm lint |
|
over a large set of manuals passed on the command line. |
|
.It Fl f Ns Cm ign-escape |
|
Ignore invalid escape sequences. |
|
This is the default, but the option can be used to override an earlier |
|
.Fl f Ns Cm strict . |
|
.It Fl f Ns Cm ign-scope |
|
When rewinding the scope of a block macro, forces the compiler to ignore |
|
scope violations. |
|
This can seriously mangle the resulting tree. |
|
.Pq mdoc only |
|
.It Fl f Ns Cm no-ign-escape |
|
Do not ignore invalid escape sequences. |
|
.It Fl f Ns Cm no-ign-macro |
|
Do not ignore unknown macros at the start of input lines. |
|
.It Fl f Ns Cm strict |
|
Implies |
|
.Fl f Ns Cm no-ign-escape |
|
and |
|
.Fl f Ns Cm no-ign-macro . |
|
.El |
.Ss Output Formats |
.Ss Output Formats |
The |
The |
.Nm |
.Nm |
utility accepts the following |
utility accepts the following |
.Fl T |
.Fl T |
arguments: |
arguments, which correspond to output modes: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl T Ns Ar ascii |
.It Fl T Ns Cm ascii |
Produce 7-bit ASCII output, backspace-encoded for bold and underline |
Produce 7-bit ASCII output, backspace-encoded for bold and underline |
styles. This is the default. |
styles. |
.It Fl T Ns Ar tree |
This is the default. |
Produce an indented parse tree. |
See |
.It Fl T Ns Ar lint |
.Sx ASCII Output . |
|
.It Fl T Ns Cm html |
|
Produce strict HTML-4.01 output, with a sane default style. |
|
See |
|
.Sx HTML Output . |
|
.It Fl T Ns Cm lint |
Parse only: produce no output. |
Parse only: produce no output. |
|
Implies |
|
.Fl W Ns Cm all |
|
and |
|
.Fl f Ns Cm strict . |
|
.It Fl T Ns Cm pdf |
|
Produce PDF output. |
|
See |
|
.Sx PDF Output . |
|
.It Fl T Ns Cm ps |
|
Produce PostScript output. |
|
See |
|
.Sx PostScript Output . |
|
.It Fl T Ns Cm tree |
|
Produce an indented parse tree. |
|
.It Fl T Ns Cm xhtml |
|
Produce strict XHTML-1.0 output, with a sane default style. |
|
See |
|
.Sx XHTML Output . |
.El |
.El |
.Pp |
.Pp |
If multiple input files are specified, these will be processed by the |
If multiple input files are specified, these will be processed by the |
corresponding filter in-order. |
corresponding filter in-order. |
.\" SUB-SECTION |
.Ss ASCII Output |
.Ss Compiler Options |
Output produced by |
Default compiler behaviour may be overriden with the |
.Fl T Ns Cm ascii , |
.Fl f |
which is the default, is rendered in standard 7-bit ASCII documented in |
flag. |
.Xr ascii 7 . |
|
.Pp |
|
Font styles are applied by using back-spaced encoding such that an |
|
underlined character |
|
.Sq c |
|
is rendered as |
|
.Sq _ Ns \e[bs] Ns c , |
|
where |
|
.Sq \e[bs] |
|
is the back-space character number 8. |
|
Emboldened characters are rendered as |
|
.Sq c Ns \e[bs] Ns c . |
|
.Pp |
|
The special characters documented in |
|
.Xr mandoc_char 7 |
|
are rendered best-effort in an ASCII equivalent. |
|
.Pp |
|
Output width is limited to 78 visible columns unless literal input lines |
|
exceed this limit. |
|
.Pp |
|
The following |
|
.Fl O |
|
arguments are accepted: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl f Ns Ar ign-scope |
.It Cm width Ns = Ns Ar width |
When rewinding the scope of a block macro, forces the compiler to ignore |
The output width is set to |
scope violations. This can seriously mangle the resulting tree. |
.Ar width , |
.Pq mdoc only |
which will normalise to \(>=60. |
.It Fl f Ns Ar no-ign-escape |
.El |
Don't ignore invalid escape sequences. |
.Ss HTML Output |
.It Fl f Ns Ar no-ign-macro |
Output produced by |
Do not ignore unknown macros at the start of input lines. |
.Fl T Ns Cm html |
.It Fl f Ns Ar no-ign-chars |
conforms to HTML-4.01 strict. |
Do not ignore disallowed characters. |
.Pp |
.It Fl f Ns Ar strict |
Font styles and page structure are applied using CSS2. |
Implies |
By default, no font style is applied to any text, |
.Fl f Ns Ar no-ign-escape , |
although CSS2 is hard-coded to format |
.Fl f Ns Ar no-ign-macro |
the basic structure of output. |
|
.Pp |
|
The |
|
.Pa example.style.css |
|
file documents the range of styles applied to output and, if used, will |
|
cause rendered documents to appear as they do in |
|
.Fl T Ns Cm ascii . |
|
.Pp |
|
Special characters are rendered in decimal-encoded UTF-8. |
|
.Pp |
|
The following |
|
.Fl O |
|
arguments are accepted: |
|
.Bl -tag -width Ds |
|
.It Cm includes Ns = Ns Ar fmt |
|
The string |
|
.Ar fmt , |
|
for example, |
|
.Ar ../src/%I.html , |
|
is used as a template for linked header files (usually via the |
|
.Sq \&In |
|
macro). |
|
Instances of |
|
.Sq \&%I |
|
are replaced with the include filename. |
|
The default is not to present a |
|
hyperlink. |
|
.It Cm man Ns = Ns Ar fmt |
|
The string |
|
.Ar fmt , |
|
for example, |
|
.Ar ../html%S/%N.%S.html , |
|
is used as a template for linked manuals (usually via the |
|
.Sq \&Xr |
|
macro). |
|
Instances of |
|
.Sq \&%N |
and |
and |
.Fl f Ns Ar no-ign-chars . |
.Sq %S |
|
are replaced with the linked manual's name and section, respectively. |
|
If no section is included, section 1 is assumed. |
|
The default is not to |
|
present a hyperlink. |
|
.It Cm style Ns = Ns Ar style.css |
|
The file |
|
.Ar style.css |
|
is used for an external style-sheet. |
|
This must be a valid absolute or |
|
relative URI. |
.El |
.El |
.\" PARAGRAPH |
.Ss PostScript Output |
|
PostScript |
|
.Qq Adobe-3.0 |
|
Level-2 pages may be generated by |
|
.Fl T Ns Cm ps . |
|
Output pages default to letter sized and are rendered in the Times font |
|
family, 11-point. |
|
Margins are calculated as 1/9 the page length and width. |
|
Line-height is 1.4m. |
.Pp |
.Pp |
As with the |
Special characters are rendered as in |
.Fl W |
.Sx ASCII Output . |
flag, multiple |
.Pp |
.Fl f |
The following |
options may be grouped and delimited with a comma. Using |
.Fl O |
.Fl f Ns Ar ign-scope,no-ign-escape , |
arguments are accepted: |
for example, will try to ignore scope and not ignore character-escape |
.Bl -tag -width Ds |
errors. |
.It Cm paper Ns = Ns Ar name |
.\" SECTION |
The paper size |
|
.Ar name |
|
may be one of |
|
.Ar a3 , |
|
.Ar a4 , |
|
.Ar a5 , |
|
.Ar legal , |
|
or |
|
.Ar letter . |
|
You may also manually specify dimensions as |
|
.Ar NNxNN , |
|
width by height in millimetres. |
|
If an unknown value is encountered, |
|
.Ar letter |
|
is used. |
|
.El |
|
.Ss PDF Output |
|
PDF-1.1 output may be generated by |
|
.Fl T Ns Cm pdf . |
|
See |
|
.Sx PostScript Output |
|
for |
|
.Fl O |
|
arguments and defaults. |
|
.Ss XHTML Output |
|
Output produced by |
|
.Fl T Ns Cm xhtml |
|
conforms to XHTML-1.0 strict. |
|
.Pp |
|
See |
|
.Sx HTML Output |
|
for details; beyond generating XHTML tags instead of HTML tags, these |
|
output modes are identical. |
.Sh EXAMPLES |
.Sh EXAMPLES |
To page manuals to the terminal: |
To page manuals to the terminal: |
.\" PARAGRAPH |
|
.Pp |
.Pp |
.D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less |
.D1 $ mandoc \-Wall,error \-fstrict mandoc.1 2\*(Gt&1 | less |
.D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less |
.D1 $ mandoc mandoc.1 mdoc.3 mdoc.7 | less |
.\" SECTION |
.Pp |
|
To produce HTML manuals with |
|
.Ar style.css |
|
as the style-sheet: |
|
.Pp |
|
.D1 $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html |
|
.Pp |
|
To check over a large set of manuals: |
|
.Pp |
|
.Dl $ mandoc \-Tlint \-fign-errors `find /usr/src -name \e*\e.[1-9]` |
|
.Pp |
|
To produce a series of PostScript manuals for A4 paper: |
|
.Pp |
|
.D1 $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section summarises |
This section summarises |
.Nm |
.Nm |
compatibility with |
compatibility with |
.Xr groff 1 . |
.Xr groff 1 . |
.Pp |
Each input and output format is separately noted. |
|
.Ss ASCII Compatibility |
.Bl -bullet -compact |
.Bl -bullet -compact |
.It |
.It |
A list or display following |
The |
.Sq \&.Ss |
.Sq \&Bd \-literal |
|
and |
|
.Sq \&Bd \-unfilled |
|
macros of |
|
.Xr mdoc 7 |
|
in |
|
.Fl T Ns Cm ascii |
|
are synonyms, as are \-filled and \-ragged. |
|
.It |
|
In |
|
.Xr groff 1 , |
|
the |
|
.Sq \&Pa |
|
.Xr mdoc 7 |
|
macro does not underline when scoped under an |
|
.Sq \&It |
|
in the FILES section. |
|
This behaves correctly in |
|
.Nm . |
|
.It |
|
A list or display following the |
|
.Sq \&Ss |
|
.Xr mdoc 7 |
|
macro in |
|
.Fl T Ns Cm ascii |
does not assert a prior vertical break, just as it doesn't with |
does not assert a prior vertical break, just as it doesn't with |
.Sq \&.Sh . |
.Sq \&Sh . |
.It |
.It |
The \-literal and \-unfilled |
The |
.Sq \&.Bd |
.Sq \&na |
displays types are synonyms, as are \-filled and \-ragged. |
.Xr man 7 |
|
macro in |
|
.Fl T Ns Cm ascii |
|
has no effect. |
.It |
.It |
Words aren't hyphenated. |
Words aren't hyphenated. |
.It |
.It |
In normal mode (not a literal block), blocks of spaces aren't preserved, |
Sentences are unilaterally monospaced. |
so double spaces following sentence closure are reduced to a single space |
|
.Pq Dq French spacing . |
|
.El |
.El |
.\" SECTION |
.Ss HTML/XHTML Compatibility |
|
.Bl -bullet -compact |
|
.It |
|
The |
|
.Sq \efP |
|
escape will revert the font to the previous |
|
.Sq \ef |
|
escape, not to the last rendered decoration, which is now dictated by |
|
CSS instead of hard-coded. |
|
It also will not span past the current scope, |
|
for the same reason. |
|
Note that in |
|
.Sx ASCII Output |
|
mode, this will work fine. |
|
.It |
|
The |
|
.Xr mdoc 7 |
|
.Sq \&Bl \-hang |
|
and |
|
.Sq \&Bl \-tag |
|
list types render similarly (no break following overreached left-hand |
|
side) due to the expressive constraints of HTML. |
|
.It |
|
The |
|
.Xr man 7 |
|
.Sq IP |
|
and |
|
.Sq TP |
|
lists render similarly. |
|
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
|
.Xr man 7 , |
.Xr mandoc_char 7 , |
.Xr mandoc_char 7 , |
.Xr mdoc 7 , |
.Xr mdoc 7 |
.Xr man 7 |
|
.\" SECTION |
|
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.An Kristaps Dzonsons Aq kristaps@bsd.lv . |
.\" SECTION |
|
.Sh CAVEATS |
.Sh CAVEATS |
The |
The |
.Nm |
.Fl T Ns Cm html |
utility doesn't yet know how to display \-hang lists. |
and |
|
.Fl T Ns Cm xhtml |
|
CSS2 styling used for |
|
.Fl m Ns Cm doc |
|
input lists does not render properly in older browsers, such as Internet |
|
Explorer 6 and earlier. |
.Pp |
.Pp |
Other macros still aren't supported by virtue of nobody complaining |
In |
about their absence. |
.Fl T Ns Cm html |
|
and |
|
.Fl T Ns Cm xhtml , |
|
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 Ns Cm style Ns = Ns Ar really/long/link . |
|
.Pp |
|
The |
|
.Fl T Ns Cm html |
|
and |
|
.Fl T Ns Cm xhtml |
|
output modes don't render the |
|
.Sq \es |
|
font size escape documented in |
|
.Xr mdoc 7 |
|
and |
|
.Xr man 7 . |
|
.Pp |
|
Nesting elements within next-line element scopes of |
|
.Fl m Ns Cm an , |
|
such as |
|
.Sq br |
|
within an empty |
|
.Sq B , |
|
will confuse |
|
.Fl T Ns Cm html |
|
and |
|
.Fl T Ns Cm xhtml |
|
and cause them to forget the formatting of the prior next-line scope. |
|
.Pp |
|
The |
|
.Sq i |
|
macro in |
|
.Fl m Ns Cm an |
|
should italicise all subsequent text if a line argument is not provided. |
|
This behaviour is not implemented. |
|
The |
|
.Sq \(aq |
|
control character is an alias for the standard macro control character |
|
and does not emit a line-break as stipulated in GNU troff. |