mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.86 and 1.100

version 1.86, 2011/05/17 12:22:15

version 1.100, 2011/12/25 19:35:44

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

utility formats

.Ux

manual pages for display.

.Pp

By default,

.Nm

reads

.Xr mdoc 7

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

.Bl -tag -width Ds

.It Fl m Ns Ar format

Line 96 If multiple files are specified,

Line 109 If multiple files are specified,

.Nm

will halt with the first failed parse.

.El

.Pp

By default,

.Nm

reads

.Xr mdoc 7

.Xr man 7

text from stdin, implying

.Fl m Ns Cm andoc ,

and produces

.Fl T Ns Cm ascii

output.

.Ss Input Formats

The

.Nm

Line 157 The

Line 158 The

utility accepts the following

.Fl T

arguments, which correspond to output modes:

.Bl -tag -width Ds

.Bl -tag -width "-Tlocale"

.It Fl T Ns Cm ascii

Produce 7-bit ASCII output.

This is the default.

Line 171 See

Line 172 See

Parse only: produce no output.

Implies

.Fl W Ns Cm warning .

.It Fl T Ns Cm locale

Encode output using the current locale.

See

.Sx Locale Output .

.It Fl T Ns Cm man

Produce

.Xr man 7

format output.

See

.Sx Man Output .

.It Fl T Ns Cm pdf

Produce PDF output.

See

Line 181 See

Line 192 See

.Sx PostScript Output .

.It Fl T Ns Cm tree

Produce an indented parse tree.

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

Produce strict CSS1/XHTML-1.0 output.

See

Line 209 Emboldened characters are rendered as

Line 224 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 217 The following

Line 235 The following

.Fl O

arguments are accepted:

.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

The output width is set to

.Ar width ,

Line 236 If a style-sheet is not specified with

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

arguments are accepted:

.Bl -tag -width Ds

.It Cm fragment

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

.Cm style

argument will be ignored.

This is useful when embedding manual content within existing documents.

.It Cm includes Ns = Ns Ar fmt

The string

.Ar fmt ,

Line 278 is used for an external style-sheet.

Line 320 is used for an external style-sheet.

This must be a valid absolute or

relative URI.

.El

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

Translate input format into

.Xr man 7

output format.

This is useful for distributing manual sources to legancy systems

lacking

.Xr mdoc 7

formatters.

.Pp

.Xr mdoc 7

is passed as input, it is translated into

.Xr man 7 .

If the input format is

.Xr man 7 ,

the input is copied to the output, expanding any

.Xr roff 7

.Sq so

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

PDF-1.1 output may be generated by

.Fl T Ns Cm pdf .

See

.Sx PostScript Output

for

.Fl O

arguments and defaults.

.Ss PostScript Output

PostScript

.Qq Adobe-3.0

Line 312 If an unknown value is encountered,

Line 396 If an unknown value is encountered,

.Ar letter

is used.

.El

.Ss PDF Output

.Ss UTF\-8 Output

PDF-1.1 output may be generated by

Use

.Fl T Ns Cm pdf .

.Fl T Ns Cm utf8

to force a UTF\-8 locale.

See

.Sx PostScript Output

.Sx Locale Output

for

for details and options.

.Fl O

arguments and defaults.

.Ss XHTML Output

Output produced by

.Fl T Ns Cm xhtml

Line 389 To check over a large set of manuals:

Line 472 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 553 Each input and output format is separately noted.

.Ss ASCII Compatibility

.Bl -bullet -compact

.It

Unicode codepoints specified with

Unrenderable unicode codepoints specified with

.Sq \e[uNNNN]

escapes are printed as

.Sq \&?

Line 544 lists render similarly.

Line 637 lists render similarly.

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