mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

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

version 1.7, 2009/03/23 09:42:43

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

Line 22

.\" SECTION

.Sh NAME

.Nm mandoc

.Nd format and display BSD manuals

.Nd format and display UNIX manuals

.\" SECTION

.Sh SYNOPSIS

.Nm mandoc

.Op Fl V

.Op Fl f Ns Ar option...

.Op Fl m Ns Ar format

.Op Fl W Ns Ar err...

.Op Fl T Ns Ar output

.Op Ar infile...

Line 35

Line 36

.Sh DESCRIPTION

The

.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

.It Fl f Ns Ar option...

Line 45 Override default compiler behaviour. See

Line 46 Override default compiler behaviour. See

.Sx Compiler Options

for details.

.\" ITEM

.It Fl m

Input format. See

.Sx Input Formats

for available formats. Defaults to

.Fl m Ns Ar doc .

.\" ITEM

.It Fl T

Output format. See

.Sx Output Formats

Line 80 will halt with the first failed parse.

Line 87 will halt with the first failed parse.

.Pp

By default,

.Nm

reads from stdin and prints 78-column backspace-encoded output to stdout

reads

as if

.Xr mdoc 7

text from stdin, implying

.Fl m Ns Ar mdoc ,

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

.Fl T Ns Ar ascii

were provided.

.\" PARAGRAPH

.Pp

.Ex -std mandoc

.\" SUB-SECTION

.Ss Reserved Words

.Ss Reserved Words (mdoc only)

The reserved words described in

.Xr mdoc 7

are handled according to the following rules:

Line 132 However, if the comma were part of

Line 142 However, if the comma were part of

.Dq ,empirically ,

it would not.

.\" SUB-SECTION

.Ss Input Formats

The

.Nm

utility accepts

.Xr mdoc 7

and

.Xr man 7

input with

.Fl m Ns Ar doc

and

.Fl m Ns Ar an ,

respectively. The

.Xr mdoc 7

format is

.Em strongly

recommended;

.Xr man 7

should only be used for legacy manuals.

.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

.Nm

Line 156 flag.

Line 196 flag.

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

.Pq mdoc only

.It Fl f Ns Ar ign-escape

Ignore invalid escape sequences.

.It Fl f Ns Ar ign-macro

Line 178 To page this manual page on the terminal:

Line 219 To page this manual page on the terminal:

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

.\" SECTION

.Sh SEE ALSO

.Xr mdoc 7

.Xr mdoc 7 ,

.Xr man 7

.\"

.Sh AUTHORS

The

Line 196 mode doesn't yet know how to display the following:

Line 238 mode doesn't yet know how to display the following:

.Bl -bullet -compact

.It

The \-hang

.Sq \&Bl

.Sq \&.Bl

list is not yet supported.

.El

.Pp

Line 212 output and

Line 254 output and

.Bl -bullet -compact

.It

A list of display following

.Sq \&Ss

.Sq \&.Ss

does not assert a prior vertical break, just as it doesn't with

.Sq \&Sh .

.Sq \&.Sh .

.It

Special characters don't follow the current font style.

.\" LIST-ITEM

.It

The \-literal and \-unfilled

.Sq \&Bd

.Sq \&.Bd

displays types are synonyms, as are \-filled and \-ragged.

.El

CVSweb