version 1.96, 2011/10/06 23:05:55 |
version 1.105, 2014/06/23 22:03:30 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
|
.\" Copyright (c) 2012, 2014 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" 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 |
|
|
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mandoc |
.Nm mandoc |
.Op Fl V |
.Op Fl V |
|
.Sm off |
|
.Op Fl I Cm os Li = Ar name |
|
.Sm on |
.Op Fl m Ns Ar format |
.Op Fl m Ns Ar format |
.Op Fl O Ns Ar option |
.Op Fl O Ns Ar option |
.Op Fl T Ns Ar output |
.Op Fl T Ns Ar output |
|
|
utility formats |
utility formats |
.Ux |
.Ux |
manual pages for display. |
manual pages for display. |
|
.Pp |
|
By default, |
|
.Nm |
|
reads |
|
.Xr mdoc 7 |
|
or |
|
.Xr man 7 |
|
text from stdin, implying |
|
.Fl m Ns Cm andoc , |
|
and produces |
|
.Fl T Ns Cm ascii |
|
output. |
|
.Pp |
The arguments are as follows: |
The arguments are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
|
.Sm off |
|
.It Fl I Cm os Li = Ar name |
|
.Sm on |
|
Override the default operating system |
|
.Ar name |
|
for the |
|
.Xr mdoc 7 |
|
.Sq \&Os |
|
macro. |
.It Fl m Ns Ar format |
.It Fl m Ns Ar format |
Input format. |
Input format. |
See |
See |
Line 96 If multiple files are specified, |
|
Line 122 If multiple files are specified, |
|
.Nm |
.Nm |
will halt with the first failed parse. |
will halt with the first failed parse. |
.El |
.El |
.Pp |
|
By default, |
|
.Nm |
|
reads |
|
.Xr mdoc 7 |
|
or |
|
.Xr man 7 |
|
text from stdin, implying |
|
.Fl m Ns Cm andoc , |
|
and produces |
|
.Fl T Ns Cm ascii |
|
output. |
|
.Ss Input Formats |
.Ss Input Formats |
The |
The |
.Nm |
.Nm |
|
|
.Fl O |
.Fl O |
arguments are accepted: |
arguments are accepted: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
|
.It Cm indent Ns = Ns Ar indent |
|
The left margin for normal text is set to |
|
.Ar indent |
|
blank characters instead of the default of five for |
|
.Xr mdoc 7 |
|
and seven for |
|
.Xr man 7 . |
|
Increasing this is not recommended; it may result in degraded formatting, |
|
for example overfull lines or ugly line breaks. |
.It Cm width Ns = Ns Ar width |
.It Cm width Ns = Ns Ar width |
The output width is set to |
The output width is set to |
.Ar width , |
.Ar width , |
|
|
arguments are accepted: |
arguments are accepted: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Cm fragment |
.It Cm fragment |
Do not emit doctype, html, and body elements. |
Omit the |
|
.Aq !DOCTYPE |
|
declaration and the |
|
.Aq html , |
|
.Aq head , |
|
and |
|
.Aq body |
|
elements and only emit the subtree below the |
|
.Aq body |
|
element. |
The |
The |
.Cm style |
.Cm style |
argument shall be unused. |
argument will be ignored. |
This is useful when embedding manual content within existing documents. |
This is useful when embedding manual content within existing documents. |
.It Cm includes Ns = Ns Ar fmt |
.It Cm includes Ns = Ns Ar fmt |
The string |
The string |
Line 315 for font style specification and available command-lin |
|
Line 347 for font style specification and available command-lin |
|
Translate input format into |
Translate input format into |
.Xr man 7 |
.Xr man 7 |
output format. |
output format. |
This is useful for distributing manual sources to legancy systems |
This is useful for distributing manual sources to legacy systems |
lacking |
lacking |
.Xr mdoc 7 |
.Xr mdoc 7 |
formatters. |
formatters. |
|
|
If |
If |
.Xr mdoc 7 |
.Xr mdoc 7 |
is passed as input, it is translated into |
is passed as input, it is translated into |
.Xr man 7 ; |
.Xr man 7 . |
if the input format is |
If the input format is |
.Xr man 7 , |
.Xr man 7 , |
it is parsed and re-outputted. |
the input is copied to the output, expanding any |
In either case, the |
|
.Xr roff 7 |
.Xr roff 7 |
.Sq so |
.Sq so |
macros are processed prior to producing output. |
requests. |
|
The parser is also run, and as usual, the |
|
.Fl W |
|
level controls which |
|
.Sx DIAGNOSTICS |
|
are displayed before copying the input to the output. |
.Ss PDF Output |
.Ss PDF Output |
PDF-1.1 output may be generated by |
PDF-1.1 output may be generated by |
.Fl T Ns Cm pdf . |
.Fl T Ns Cm pdf . |
|
|
.Sh DIAGNOSTICS |
.Sh DIAGNOSTICS |
Standard error messages reporting parsing errors are prefixed by |
Standard error messages reporting parsing errors are prefixed by |
.Pp |
.Pp |
.Sm off |
.D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level : |
.D1 Ar file : line : column : \ level : |
|
.Sm on |
|
.Pp |
.Pp |
where the fields have the following meanings: |
where the fields have the following meanings: |
.Bl -tag -width "column" |
.Bl -tag -width "column" |
Line 482 points to the first character of the word. |
|
Line 516 points to the first character of the word. |
|
The message level, printed in capital letters. |
The message level, printed in capital letters. |
.El |
.El |
.Pp |
.Pp |
|
The |
|
.Ar line |
|
and |
|
.Ar column |
|
fields are omitted when meaningless. |
|
.Pp |
Message levels have the following meanings: |
Message levels have the following meanings: |
.Bl -tag -width "warning" |
.Bl -tag -width "warning" |
|
.It Cm syserr |
|
Opening or reading an input file failed, so the parser cannot |
|
even be started and no output is produced from that input file. |
.It Cm fatal |
.It Cm fatal |
The parser is unable to parse a given input file at all. |
The parser is unable to parse a given input file at all. |
No formatted output is produced from that input file. |
No formatted output is produced from that input file. |
|
|
The |
The |
.Nm |
.Nm |
utility may also print messages related to invalid command line arguments |
utility may also print messages related to invalid command line arguments |
or operating system errors, for example when memory is exhausted or |
or operating system errors, for example when memory is exhausted. |
input files cannot be read. |
Such messages may not carry the prefix described above. |
Such messages do not carry the prefix described above. |
|
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section summarises |
This section summarises |
.Nm |
.Nm |
Line 614 lists render similarly. |
|
Line 656 lists render similarly. |
|
The |
The |
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons , |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |
.Mt kristaps@bsd.lv . |
|
.Sh CAVEATS |
.Sh CAVEATS |
In |
In |
.Fl T Ns Cm html |
.Fl T Ns Cm html |