mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.83 and 1.92

version 1.83, 2010/12/20 13:57:49

version 1.92, 2011/09/18 14:14:15

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 above

Line 27

.Op Fl O Ns Ar option

.Op Fl T Ns Ar output

.Op Fl W Ns Ar level

.Op Ar file...

.Op Ar

.Sh DESCRIPTION

The

.Nm

Line 158 utility accepts the following

.Fl T

arguments, which correspond to output modes:

.Bl -tag -width Ds

.It Fl T Ns Cm utf8

Encode output in the UTF\-8 multi-byte format.

See

.Sx UTF\-8 Output .

.It Fl T Ns Cm locale

Encode output using the current locale.

See

.Sx Locale Output .

.It Fl T Ns Cm ascii

Produce 7-bit ASCII output.

This is the default.

Line 171 See

Line 179 See

Parse only: produce no output.

Implies

.Fl W Ns Cm warning .

.It Fl T Ns Cm man

Produce output in

.Xr man 7

format; only useful when applied to

.Fl m Ns Cm doc

input.

.It Fl T Ns Cm pdf

Produce PDF output.

See

Line 189 See

Line 203 See

.Pp

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

corresponding filter in-order.

.Ss UTF\-8 Output

Use

.Fl T Ns Cm utf8

to force a UTF\-8 locale.

See

.Sx Locale Output

for details and options.

.Ss Locale Output

Locale-depending output encoding is triggered with

.Fl T Ns Cm locale .

This option is not available on all systems: systems without locale

support, or those whose internal representation is not natively UCS-4,

will fall back to

.Fl T Ns Cm ascii .

See

.Sx ASCII Output

for font style specification and available command-line arguments.

.Ss ASCII Output

Output produced by

.Fl T Ns Cm ascii ,

Line 209 Emboldened characters are rendered as

Line 240 Emboldened characters are rendered as

The special characters documented in

.Xr mandoc_char 7

are rendered best-effort in an ASCII equivalent.

If no equivalent is found,

.Sq \&?

is used instead.

.Pp

Output width is limited to 78 visible columns unless literal input lines

exceed this limit.

Line 236 If a style-sheet is not specified with

Line 270 If a style-sheet is not specified with

defaults to simple output readable in any graphical or text-based web

browser.

.Pp

Special characters are rendered in decimal-encoded UTF-8.

Special characters are rendered in decimal-encoded UTF\-8.

.Pp

The following

.Fl O

Line 389 To check over a large set of manuals:

Line 423 To check over a large set of manuals:

To produce a series of PostScript manuals for A4 paper:

.Pp

.Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps

.Pp

Convert a modern

.Xr mdoc 7

manual to the older

.Xr man 7

format, for use on systems lacking an

.Xr mdoc 7

parser:

.Pp

.Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man

.Sh DIAGNOSTICS

Standard error messages reporting parsing errors are prefixed by

.Pp

Line 460 Each input and output format is separately noted.

Line 504 Each input and output format is separately noted.

.Ss ASCII Compatibility

.Bl -bullet -compact

.It

Unrenderable unicode codepoints specified with

.Sq \e[uNNNN]

escapes are printed as

.Sq \&?

in mandoc.

In GNU troff, these raise an error.

.It

The

.Sq \&Bd \-literal

and

Line 470 in

Line 521 in

.Fl T Ns Cm ascii

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

.It

In GNU troff, the

In historic GNU troff, the

.Sq \&Pa

.Xr mdoc 7

macro does not underline when scoped under an

Line 495 macro in

Line 546 macro in

has no effect.

.It

Words aren't hyphenated.

.It

Sentences are unilaterally monospaced.

.El

.Ss HTML/XHTML Compatibility

.Bl -bullet -compact

Line 529 and

Line 578 and

lists render similarly.

.El

.Sh SEE ALSO

.Xr eqn 7 ,

.Xr man 7 ,

.Xr mandoc_char 7 ,

.Xr mdoc 7

.Xr mdoc 7 ,

.Xr roff 7 ,

.Xr tbl 7

.Sh AUTHORS

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq kristaps@bsd.lv .

.An Kristaps Dzonsons ,

.Mt kristaps@bsd.lv .

.Sh CAVEATS

.Fl T Ns Cm html

CVSweb