mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.11 and 1.14

version 1.11, 2009/03/26 16:44:22

version 1.14, 2009/04/12 19:19:57

Line 17

.\" PERFORMANCE OF THIS SOFTWARE.

.\"

.Dd $Mdocdate$

.Dt mandoc 1

.Dt MANDOC 1

.Os

.\" SECTION

.Sh NAME

Line 50 for details.

Input format. See

.Sx Input Formats

for available formats. Defaults to

.Fl m Ns Ar doc .

.Fl m Ns Ar andoc .

.\" ITEM

.It Fl T

Output format. See

Line 89 By default,

.Nm

reads

.Xr mdoc 7

.Xr man 7

text from stdin, implying

.Fl m Ns Ar mdoc ,

.Fl m Ns Ar andoc ,

and prints 78-column backspace-encoded output to stdout as if

.Fl T Ns Ar ascii

were provided.

Line 98 were provided.

Line 100 were provided.

.Pp

.Ex -std mandoc

.\" SUB-SECTION

.Ss Reserved Words (mdoc only)

.Ss Punctuation

The reserved words described in

If punctuation is set apart from words, such as in the phrase

.Xr mdoc 7

.Dq to be \&, or not to be ,

are handled according to the following rules:

it's processed by

.Bl -enum -offset XXX

.Nm

.It

according to the following rules. Opening punctuation

Opening delimiters

.Po

.Sq \&( ,

.Sq \&[ ,

and

.Sq \&{

.Pc are not followed by whitespace.

.Pc

.It

is not followed by a space. Closing punctuation

Closing delimiters

.Po

.Sq \&. ,

.Sq \&, ,

Line 124 Closing delimiters

.Sq \&]

and

.Sq \&}

.Pc are not preceeded by whitespace.

.Pc

.El

is not preceeded by whitespace.

.\" PARAGRAPH

.Pp

Note that reserved words only register as such as if they appear as

If the input is

standalone tokens, either in parsed lines or streams of text. Thus, the

.Xr mdoc 7 ,

following fragment:

these rules are also applied to macro arguments when appropriate.

.Bd -literal -offset XXXX

this self is not that of the waking , empirically real man

.Ed

.\" PARAGRAPH

.Pp

\&...correctly adjusts the comma spacing to

.Dq this self is not that of the waking , empirically real man .

However, if the comma were part of

.Dq ,empirically ,

it would not.

.\" SUB-SECTION

.Ss Input Formats

The

Line 161 recommended;

Line 150 recommended;

.Xr man 7

should only be used for legacy manuals.

.Pp

The following escape sequences are recognised, although the per-format

A third option,

compiler may not allow certain sequences.

.Fl m Ns Ar andoc ,

.Bl -tag -width Ds -offset XXXX

which is also the default, determines encoding on-the-fly: if the first

.It \efX

non-comment macro is

sets the font mode to X (B, I, R or P, where P resets the font)

.Sq \&.Dd

.It \eX, \e(XX, \e[XN]

queries the special-character table for a corresponding symbol

.Sq \&.Dt ,

.It \e*X, \e*(XX, \e*[XN]

the

deprecated special-character format

.Xr mdoc 7

.El

parser is used; otherwise, the

.Xr man 7

parser is used.

.Pp

If multiple

files are specified with

.Fl m Ns Ar andoc ,

each has its file-type determined this way. If multiple files are

specified and

.Fl m Ns Ar doc

.Fl m Ns Ar an

is specified, then this format is used exclusively.

.\" .Pp

.\" The following escape sequences are recognised, although the per-format

.\" compiler may not allow certain sequences.

.\" .Bl -tag -width Ds -offset XXXX

.\" .It \efX

.\" sets the font mode to X (B, I, R or P, where P resets the font)

.\" .It \eX, \e(XX, \e[XN]

.\" queries the special-character table for a corresponding symbol

.\" .It \e*X, \e*(XX, \e*[XN]

.\" deprecated special-character format

.\" .El

.\" SUB-SECTION

.Ss Output Formats

The

Line 178 The

Line 190 The

utility accepts the following

.Fl T

arguments:

.Bl -tag -width XXXXXXXXXXXX -offset XXXX

.Bl -tag -width XXXXXXXXXXXX

.It Ar ascii

.It Fl T Ns Ar ascii

Produce 7-bit ASCII output, backspace-encoded for bold and underline

styles. This is the default.

.It Ar tree

.It Fl T Ns Ar tree

Produce an indented parse tree.

.It Ar lint

.It Fl T Ns Ar lint

Parse only: produce no output.

.El

.Pp

If multiple input files are specified, these will be processed by the

corresponding filter in-order.

.\" SUB-SECTION

.Ss Compiler Options

Default compiler behaviour may be overriden with the

.Fl f

flag.

.Bl -tag -width XXXXXXXXXXXX -offset XXXX

.Bl -tag -width XXXXXXXXXXXXXX

.It Fl f Ns Ar ign-scope

When rewinding the scope of a block macro, forces the compiler to ignore

scope violations. This can seriously mangle the resulting tree.

Line 200 scope violations. This can seriously mangle the resul

Line 215 scope violations. This can seriously mangle the resul

.It Fl f Ns Ar ign-escape

Ignore invalid escape sequences.

.It Fl f Ns Ar ign-macro

Ignore unknown macros at the start of input lines.

Ignore unknown macros at the start of input lines (default for

.Xr man 7

parsing).

.It Fl f Ns Ar no-ign-macro

Do not ignore unknown macros at the start of input lines (default for

.Xr mdoc 7

parsing).

.El

.\" PARAGRAPH

.Pp

Line 213 options may be grouped and delimited with a comma. Us

Line 234 options may be grouped and delimited with a comma. Us

for example, will try to ignore scope and character-escape errors.

.\" SECTION

.Sh EXAMPLES

To page this manual page on the terminal:

To page manuals to the terminal:

.\" PARAGRAPH

.Pp

.D1 % mandoc \-Wall,error mandoc.1 2>&1 | less

.Pp

.D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less

.\" SECTION

.Sh SEE ALSO

.Xr mandoc_char 7 ,

.Xr mdoc 7 ,

.Xr man 7

.\"

CVSweb