mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.48 and 1.53

version 1.48, 2009/11/16 09:52:47

version 1.53, 2010/03/25 07:28:16

Line 167 styles. This is the default. See

Produce strict HTML-4.01 output, with a sane default style. See

.Sx HTML Output .

.It Fl T Ns Ar xhtml

Produce strict XHTML-1.0 output, with a sane default style. See

.Sx XHTML Output .

.It Fl T Ns Ar tree

Produce an indented parse tree.

.It Fl T Ns Ar lint

Parse only: produce no output.

Implies

.Fl W Ns Ar all

and

.Fl f Ns Ar strict .

.El

.Pp

Line 221 over a large set of manuals passed on the command line

Line 229 over a large set of manuals passed on the command line

.Ss Output Options

For the time being, only

.Fl T Ns Ar html

and

.Fl T Ns Ar xhtml

accepts output options:

.Bl -tag -width Ds

.It Fl O Ns Ar style=style.css

Line 231 relative URI.

Line 241 relative URI.

.It Fl O Ns Ar includes=fmt

The string

.Ar fmt ,

for example,

.Ar ../src/%I.html ,

is used as a template for linked header files (usually via the

.Sq \&In

Line 242 hyperlink.

Line 252 hyperlink.

.It Fl O Ns Ar man=fmt

The string

.Ar fmt ,

for example,

.Ar ../html%S/%N.%S.html ,

is used as a template for linked manuals (usually via the

.Sq \&Xr

Line 260 present a hyperlink.

Line 270 present a hyperlink.

This section documents output details of

.Nm .

In general, output conforms to the traditional manual style of a header,

a body composed of sections and sub-sections, and a footer.

.Pp

The text style of output characters (non-macro characters, punctuation,

and white-space) is dictated by context.

Line 307 however, these rules are also applied to macro argumen

Line 317 however, these rules are also applied to macro argumen

.Ss ASCII Output

Output produced by

.Fl T Ns Ar ascii ,

which is the default, is rendered in standard 7-bit ASCII documented in

.Xr ascii 7 .

Line 333 exceed this limit.

Line 343 exceed this limit.

.Ss HTML Output

Output produced by

.Fl T Ns Ar html

comforms to HTML-4.01 strict.

conforms to HTML-4.01 strict.

.Pp

Font styles and page structure are applied using CSS2. By default, no

font style is applied to any text, although CSS2 is hard-coded to format

Line 348 cause rendered documents to appear as they do in

Line 358 cause rendered documents to appear as they do in

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

.Ss XHTML Output

Output produced by

.Fl T Ns Ar xhtml

conforms to XHTML-1.0 strict.

.Pp

See

.Sx HTML Output

for details; beyond generating XHTML tags instead of HTML tags, these

output modes are identical.

.Sh EXAMPLES

To page manuals to the terminal:

Line 379 Each input and output format is separately noted.

Line 400 Each input and output format is separately noted.

.Ss ASCII Compatibility

.Bl -bullet -compact

.It

The

.Sq \e~

special character doesn't produce expected behaviour in

.Fl T Ns Ar ascii .

.It

The

.Sq \&Bd \-literal

and

.Sq \&Bd \-unfilled

macros of

.Xr mdoc 7

Line 396 in

Line 417 in

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

.It

.Xr groff 1 ,

the

.Sq \&Pa

Line 437 Sentences are unilaterally monospaced.

Line 458 Sentences are unilaterally monospaced.

.El

.Ss HTML Compatibility

.Ss HTML/XHTML Compatibility

.Bl -bullet -compact

.It

The

Line 446 escape will revert the font to the previous

Line 467 escape will revert the font to the previous

.Sq \ef

escape, not to the last rendered decoration, which is now dictated by

CSS instead of hard-coded. It also will not span past the current

scope, for the same reason. Note that in

.Sx ASCII Output

mode, this will work fine.

.It

Line 483 utility was written by

Line 504 utility was written by

.Sh CAVEATS

The

.Fl T Ns Ar html

and

.Fl T Ns Ar xhtml

CSS2 styling used for

.Fl m Ns Ar doc

input lists does not render properly in brain-dead browsers, such as

input lists does not render properly in older browsers, such as Internet

Internet Explorer 6 and earlier.

Explorer 6 and earlier.

.Pp

.Fl T Ns Ar html ,

.Fl T Ns Ar html

and

.Fl T Ns Ar xhtml ,

the maximum size of an element attribute is determined by

.Dv BUFSIZ ,

which is usually 1024 bytes. Be aware of this when setting long link

Line 498 formats, e.g.,

Line 523 formats, e.g.,

.Pp

The

.Fl T Ns Ar html

output mode doesn't render the

and

.Fl T Ns Ar xhtml

output modes don't render the

.Sq \es

font size escape documented in

.Xr mdoc 7

and

.Xr man 7 .

.Pp

Nesting elements within next-line element scopes of

.Fl m Ns Ar an ,

such as

.Sq br

within an empty

.Sq B ,

will confuse

.Fl T Ns Ar html

and

.Fl T Ns Ar xhtml

and cause them to forget the formatting of the prior next-line scope.

.Pp

The

.Sq i

macro in

.Fl m Ns Ar an

should italicise all subsequent text if a line argument is not provided.

This behaviour is not implemented.

CVSweb