mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.12 and 1.19

version 1.12, 2009/04/02 16:42:35

version 1.19, 2009/06/15 09:35:16

Line 1

.\" $Id$

.\"

.\" 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$

.Dt mandoc 1

.Dt MANDOC 1

.Os

.\" SECTION

.Sh NAME

Line 39 The

Line 37 The

utility formats

.Ux

manual pages for display. The arguments are as follows:

.Bl -tag -width XXXXXXXXXXXX

.Bl -tag -width Ds

.\" ITEM

.It Fl f Ns Ar option...

Override default compiler behaviour. See

.Sx Compiler Options

for details.

.\" ITEM

.It Fl m

.It Fl m Ns Ar format

Input format. See

.Sx Input Formats

for available formats. Defaults to

.Fl m Ns Ar andoc .

.\" ITEM

.It Fl T

.It Fl T Ns Ar output

Output format. See

.Sx Output Formats

for available formats. Defaults to

Line 100 were provided.

Line 98 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 126 Closing delimiters

Line 122 Closing delimiters

.Sq \&]

and

.Sq \&}

.Pc are not preceeded by whitespace.

.Pc

.El

is not preceded 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 165 should only be used for legacy manuals.

Line 150 should only be used for legacy manuals.

.Pp

A third option,

.Fl m Ns Ar andoc ,

which is also the default, determines encoding on-the-fly. If multiple

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

files are passed in, each has its file-type determined this way. If

non-comment macro is

multiple files are passed and

.Sq \&.Dd

.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 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

.\" .Pp

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

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

compiler may not allow certain sequences.

.\" compiler may not allow certain sequences.

.Bl -tag -width Ds -offset XXXX

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

.It \efX

.\" .It \efX

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

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

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

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

queries the special-character table for a corresponding symbol

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

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

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

deprecated special-character format

.\" deprecated special-character format

.El

.\" .El

.\" SUB-SECTION

.Ss Output Formats

The

Line 190 The

Line 188 The

utility accepts the following

.Fl T

arguments:

.Bl -tag -width XXXXXXXXXXXX -offset XXXX

.Bl -tag -width Ds

.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 XXXXXXXXXXXXXX -offset XXXX

.Bl -tag -width Ds

.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 231 options may be grouped and delimited with a comma. Us

Line 232 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

.\"

Line 244 To page this manual page on the terminal:

Line 248 To page this manual page on the terminal:

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq kristaps@openbsd.org .

.An Kristaps Dzonsons Aq kristaps@kth.se .

.\" SECTION

.Sh CAVEATS

The

CVSweb