version 1.7, 2009/03/23 09:42:43 |
version 1.54, 2010/03/27 10:10:10 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
.\" |
.\" |
.\" 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 |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" above copyright notice and this permission notice appear in all |
.\" copyright notice and this permission notice appear in all copies. |
.\" copies. |
|
.\" |
.\" |
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL |
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
.\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED |
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE |
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL |
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR |
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER |
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
.\" PERFORMANCE OF THIS SOFTWARE. |
|
.\" |
.\" |
.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 BSD manuals |
.Nd format and display UNIX manuals |
.\" SECTION |
. |
|
. |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mandoc |
.Nm mandoc |
.Op Fl V |
|
.Op Fl f Ns Ar option... |
.Op Fl f Ns Ar option... |
.Op Fl W Ns Ar err... |
.Op Fl m Ns Ar format |
|
.Op Fl O Ns Ar option... |
.Op Fl T Ns Ar output |
.Op Fl T Ns Ar output |
|
.Op Fl V |
|
.Op Fl W Ns Ar err... |
.Op Ar infile... |
.Op Ar infile... |
.\" SECTION |
. |
|
. |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility formats a BSD |
utility formats |
.Dq mdoc |
.Ux |
manual page for display. The arguments are as follows: |
manual pages for display. The arguments are as follows: |
.Bl -tag -width XXXXXXXXXXXX |
. |
.\" ITEM |
.Bl -tag -width Ds |
.It Fl f Ns Ar option... |
.It Fl f Ns Ar option... |
Override default compiler behaviour. See |
Comma-separated compiler options. See |
.Sx Compiler Options |
.Sx Compiler Options |
for details. |
for details. |
.\" ITEM |
. |
.It Fl T |
.It Fl m Ns Ar format |
|
Input format. See |
|
.Sx Input Formats |
|
for available formats. Defaults to |
|
.Fl m Ns Ar andoc . |
|
. |
|
.It Fl O Ns Ar option... |
|
Comma-separated output options. See |
|
.Sx Output Options |
|
for details. |
|
. |
|
.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. Defaults to |
.Fl T Ns Ar ascii . |
.Fl T Ns Ar ascii . |
.\" ITEM |
. |
.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... |
Print warning messages. May be set to |
Comma-separated warning options. Use |
.Fl W Ns Ar all |
.Fl W Ns Ar all |
for all warnings, |
to print warnings, |
.Ar compat |
.Fl W Ns Ar error |
for groff/troff-compatibility warnings, or |
for warnings to be considered errors and cause utility |
.Ar syntax |
termination. Multiple |
for syntax warnings. If |
|
.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 Ar error,all . |
.\" ITEM |
. |
.It Ar infile... |
.It Ar infile... |
Read input from zero or more |
Read input from zero or more |
.Ar infile . |
.Ar infile . |
Line 76 If unspecified, reads from stdin. If multiple files a |
|
Line 86 If unspecified, reads from stdin. If multiple files a |
|
.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 from stdin and prints 78-column backspace-encoded output to stdout |
reads |
as if |
.Xr mdoc 7 |
|
or |
|
.Xr man 7 |
|
text from stdin, implying |
|
.Fl m Ns Ar andoc , |
|
and produces |
.Fl T Ns Ar ascii |
.Fl T Ns Ar ascii |
were provided. |
output. |
.\" PARAGRAPH |
. |
.Pp |
.Pp |
.Ex -std mandoc |
.Ex -std mandoc |
.\" SUB-SECTION |
. |
.Ss Reserved Words |
. |
The reserved words described in |
.Ss Input Formats |
|
The |
|
.Nm |
|
utility accepts |
.Xr mdoc 7 |
.Xr mdoc 7 |
are handled according to the following rules: |
|
.Bl -enum -offset XXX |
|
.It |
|
Opening delimiters |
|
.Po |
|
.Sq \&( , |
|
.Sq \&[ , |
|
and |
and |
.Sq \&{ |
.Xr man 7 |
.Pc are not followed by whitespace. |
input with |
.It |
.Fl m Ns Ar doc |
Closing delimiters |
|
.Po |
|
.Sq \&. , |
|
.Sq \&, , |
|
.Sq \&; , |
|
.Sq \&: , |
|
.Sq \&? , |
|
.Sq \&! , |
|
.Sq \&) , |
|
.Sq \&] |
|
and |
and |
.Sq \&} |
.Fl m Ns Ar an , |
.Pc are not preceeded by whitespace. |
respectively. The |
.El |
.Xr mdoc 7 |
.\" PARAGRAPH |
format is |
|
.Em strongly |
|
recommended; |
|
.Xr man 7 |
|
should only be used for legacy manuals. |
|
. |
.Pp |
.Pp |
Note that reserved words only register as such as if they appear as |
A third option, |
standalone tokens, either in parsed lines or streams of text. Thus, the |
.Fl m Ns Ar andoc , |
following fragment: |
which is also the default, determines encoding on-the-fly: if the first |
.Bd -literal -offset XXXX |
non-comment macro is |
this self is not that of the waking , empirically real man |
.Sq \&Dd |
.Ed |
or |
.\" PARAGRAPH |
.Sq \&Dt , |
|
the |
|
.Xr mdoc 7 |
|
parser is used; otherwise, the |
|
.Xr man 7 |
|
parser is used. |
|
. |
.Pp |
.Pp |
\&...correctly adjusts the comma spacing to |
If multiple |
.Dq this self is not that of the waking , empirically real man . |
files are specified with |
However, if the comma were part of |
.Fl m Ns Ar andoc , |
.Dq ,empirically , |
each has its file-type determined this way. If multiple files are |
it would not. |
specified and |
.\" SUB-SECTION |
.Fl m Ns Ar doc |
|
or |
|
.Fl m Ns Ar 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: |
arguments (see |
.Bl -tag -width XXXXXXXXXXXX -offset XXXX |
.Sx OUTPUT ) : |
.It Ar ascii |
. |
|
.Bl -tag -width Ds |
|
.It Fl T Ns Ar 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. This is the default. See |
.It Ar tree |
.Sx ASCII Output . |
|
. |
|
.It Fl T Ns Ar html |
|
Produce strict HTML-4.01 output, with a sane default style. See |
|
.Sx HTML Output . |
|
. |
|
.It Fl T Ns Ar xhtml |
|
Produce strict XHTML-1.0 output, with a sane default style. See |
|
.Sx XHTML Output . |
|
. |
|
.It Fl T Ns Ar tree |
Produce an indented parse tree. |
Produce an indented parse tree. |
.It Ar lint |
. |
|
.It Fl T Ns Ar lint |
Parse only: produce no output. |
Parse only: produce no output. |
|
Implies |
|
.Fl W Ns Ar all |
|
and |
|
.Fl f Ns Ar strict . |
.El |
.El |
.\" SUB-SECTION |
. |
|
.Pp |
|
If multiple input files are specified, these will be processed by the |
|
corresponding filter in-order. |
|
. |
|
. |
.Ss Compiler Options |
.Ss Compiler Options |
Default compiler behaviour may be overriden with the |
Default compiler behaviour may be overridden with the |
.Fl f |
.Fl f |
flag. |
flag. |
.Bl -tag -width XXXXXXXXXXXX -offset XXXX |
. |
|
.Bl -tag -width Ds |
.It Fl f Ns Ar ign-scope |
.It Fl f Ns Ar ign-scope |
When rewinding the scope of a block macro, forces the compiler to ignore |
When rewinding the scope of a block macro, forces the compiler to ignore |
scope violations. This can seriously mangle the resulting tree. |
scope violations. This can seriously mangle the resulting tree. |
|
.Pq mdoc only |
|
. |
.It Fl f Ns Ar ign-escape |
.It Fl f Ns Ar ign-escape |
Ignore invalid escape sequences. |
Ignore invalid escape sequences. |
.It Fl f Ns Ar ign-macro |
This is the default, but the option can be used to override an earlier |
Ignore unknown macros at the start of input lines. |
.Fl f Ns Ar strict . |
|
. |
|
.It Fl f Ns Ar no-ign-escape |
|
Don't ignore invalid escape sequences. |
|
. |
|
.It Fl f Ns Ar no-ign-macro |
|
Do not ignore unknown macros at the start of input lines. |
|
. |
|
.It Fl f Ns Ar no-ign-chars |
|
Do not ignore disallowed characters. |
|
. |
|
.It Fl f Ns Ar strict |
|
Implies |
|
.Fl f Ns Ar no-ign-escape , |
|
.Fl f Ns Ar no-ign-macro |
|
and |
|
.Fl f Ns Ar no-ign-chars . |
|
. |
|
.It Fl f Ns Ar ign-errors |
|
Don't halt when encountering parse errors. Useful with |
|
.Fl T Ns Ar lint |
|
over a large set of manuals passed on the command line. |
.El |
.El |
.\" PARAGRAPH |
. |
|
. |
|
.Ss Output Options |
|
For the time being, only |
|
.Fl T Ns Ar html |
|
and |
|
.Fl T Ns Ar xhtml |
|
accepts output options: |
|
.Bl -tag -width Ds |
|
.It Fl O Ns Ar style=style.css |
|
The file |
|
.Ar style.css |
|
is used for an external style-sheet. This must be a valid absolute or |
|
relative URI. |
|
.It Fl O Ns Ar includes=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 Fl O Ns Ar man=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 |
|
.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. |
|
.El |
|
. |
|
. |
|
.Sh OUTPUT |
|
This section documents output details of |
|
.Nm . |
|
In general, output conforms to the traditional manual style of a header, |
|
a body composed of sections and sub-sections, and a footer. |
.Pp |
.Pp |
As with the |
The text style of output characters (non-macro characters, punctuation, |
.Fl W |
and white-space) is dictated by context. |
flag, multiple |
|
.Fl f |
|
options may be grouped and delimited with a comma. Using |
|
.Fl f Ns Ar ign-scope,ign-escape , |
|
for example, will try to ignore scope and character-escape errors. |
|
.\" SECTION |
|
.Sh EXAMPLES |
|
To page this manual page on the terminal: |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
.D1 % mandoc \-Wall,error mandoc.1 2>&1 | less |
White-space is generally stripped from input. This can be changed with |
.\" SECTION |
character escapes (specified in |
.Sh SEE ALSO |
.Xr mandoc_char 7 ) |
|
or literal modes (specified in |
.Xr mdoc 7 |
.Xr mdoc 7 |
.\" |
and |
.Sh AUTHORS |
.Xr man 7 ) . |
|
.Pp |
|
If non-macro punctuation is set apart from words, such as in the phrase |
|
.Dq to be \&, or not to be , |
|
it's processed by |
|
.Nm , |
|
regardless of output format, 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 white-space. |
|
. |
|
.Pp |
|
If the input is |
|
.Xr mdoc 7 , |
|
however, these rules are also applied to macro arguments when appropriate. |
|
. |
|
. |
|
.Ss ASCII Output |
|
Output produced by |
|
.Fl T Ns Ar ascii , |
|
which is the default, is rendered in standard 7-bit ASCII documented in |
|
.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. |
|
. |
|
. |
|
.Ss HTML Output |
|
Output produced by |
|
.Fl T Ns Ar html |
|
conforms to HTML-4.01 strict. |
|
.Pp |
|
Font styles and page structure are applied using CSS2. By default, no |
|
font style is applied to any text, although CSS2 is hard-coded to format |
|
the basic structure of output. |
|
.Pp |
The |
The |
.Nm |
.Pa example.style.css |
utility was written by |
file documents the range of styles applied to output and, if used, will |
.An Kristaps Dzonsons Aq kristaps@openbsd.org . |
cause rendered documents to appear as they do in |
.\" SECTION |
.Fl T Ns Ar ascii . |
.Sh CAVEATS |
|
The |
|
.Nm |
|
utility in |
|
.Fl T Ns Ar ascii |
|
mode doesn't yet know how to display the following: |
|
.Pp |
.Pp |
.Bl -bullet -compact |
Special characters are rendered in decimal-encoded UTF-8. |
.It |
. |
The \-hang |
. |
.Sq \&Bl |
.Ss XHTML Output |
list is not yet supported. |
Output produced by |
.El |
.Fl T Ns Ar xhtml |
|
conforms to XHTML-1.0 strict. |
.Pp |
.Pp |
Other macros still aren't supported by virtue of nobody complaining |
See |
about their absence. Please report any omissions: this is a work in |
.Sx HTML Output |
progress. |
for details; beyond generating XHTML tags instead of HTML tags, these |
|
output modes are identical. |
|
. |
|
. |
|
.Sh EXAMPLES |
|
To page manuals to the terminal: |
|
. |
.Pp |
.Pp |
The following list documents differences between traditional |
.D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less |
.Xr nroff 1 |
.D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less |
output and |
. |
.Nm : |
|
.Pp |
.Pp |
|
To produce HTML manuals with |
|
.Ar style.css |
|
as the style-sheet: |
|
.Pp |
|
.D1 % mandoc \-Thtml -Ostyle=style.css mdoc.7 > 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]` |
|
. |
|
. |
|
.Sh COMPATIBILITY |
|
This section summarises |
|
.Nm |
|
compatibility with |
|
.Xr groff 1 . |
|
Each input and output format is separately noted. |
|
. |
|
. |
|
.Ss ASCII Compatibility |
.Bl -bullet -compact |
.Bl -bullet -compact |
.It |
.It |
A list of display following |
The |
|
.Sq \e~ |
|
special character doesn't produce expected behaviour in |
|
.Fl T Ns Ar ascii . |
|
. |
|
.It |
|
The |
|
.Sq \&Bd \-literal |
|
and |
|
.Sq \&Bd \-unfilled |
|
macros of |
|
.Xr mdoc 7 |
|
in |
|
.Fl T Ns Ar 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 |
.Sq \&Ss |
.Sq \&Ss |
|
.Xr mdoc 7 |
|
macro in |
|
.Fl T Ns Ar 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 |
Special characters don't follow the current font style. |
The |
.\" LIST-ITEM |
.Sq \&na |
|
.Xr man 7 |
|
macro in |
|
.Fl T Ns Ar ascii |
|
has no effect. |
|
. |
.It |
.It |
The \-literal and \-unfilled |
Words aren't hyphenated. |
.Sq \&Bd |
. |
displays types are synonyms, as are \-filled and \-ragged. |
.It |
|
In normal mode (not a literal block), blocks of spaces aren't preserved, |
|
so double spaces following sentence closure are reduced to a single space; |
|
.Xr groff 1 |
|
retains spaces. |
|
. |
|
.It |
|
Sentences are unilaterally monospaced. |
.El |
.El |
|
. |
|
. |
|
.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 |
|
.Xr mandoc_char 7 , |
|
.Xr mdoc 7 , |
|
.Xr man 7 |
|
. |
|
.Sh AUTHORS |
|
The |
|
.Nm |
|
utility was written by |
|
.An Kristaps Dzonsons Aq kristaps@kth.se . |
|
. |
|
. |
|
.Sh CAVEATS |
|
The |
|
.Fl T Ns Ar html |
|
and |
|
.Fl T Ns Ar xhtml |
|
CSS2 styling used for |
|
.Fl m Ns Ar doc |
|
input lists does not render properly in older browsers, such as Internet |
|
Explorer 6 and earlier. |
|
. |
|
.Pp |
|
In |
|
.Fl T Ns Ar html |
|
and |
|
.Fl T Ns Ar 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, e.g., |
|
.Fl O Ns Ar style=really/long/link . |
|
. |
|
.Pp |
|
The |
|
.Fl T Ns Ar html |
|
and |
|
.Fl T Ns Ar 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 Ar an , |
|
such as |
|
.Sq br |
|
within an empty |
|
.Sq B , |
|
will confuse |
|
.Fl T Ns Ar html |
|
and |
|
.Fl T Ns Ar xhtml |
|
and cause them to forget the formatting of the prior next-line scope. |
|
. |
|
.Pp |
|
The |
|
.Sq i |
|
macro in |
|
.Fl m Ns Ar an |
|
should italicise all subsequent text if a line argument is not provided. |
|
This behaviour is not implemented. |
|
. |
|
The |
|
.Sq \(aq |
|
control character does not have the same |