mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.37 and 1.44

version 1.37, 2009/09/21 13:06:13

version 1.44, 2009/10/26 04:15:42

Line 28

.Nm mandoc

.Op Fl f Ns Ar option...

.Op Fl m Ns Ar format

.Op Fl o Ns Ar option...

.Op Fl O Ns Ar option...

.Op Fl T Ns Ar output

.Op Fl V

.Op Fl W Ns Ar err...

Line 54 Input format. See

for available formats. Defaults to

.Fl m Ns Ar andoc .

.It Fl o Ns Ar format

.It Fl O Ns Ar option...

Comma-separated output options. See

.Sx Output Options

for details.

Line 255 For the time being, only

.Fl T Ns Ar html

is the only mode with output options:

.Bl -tag -width Ds

.It Fl o Ns Ar style=style.css

.It Fl O Ns Ar style=style.css

The file

.Ar style.css

is used for an external style-sheet. This must be a valid absolute or

relative URI.

.It Fl o Ns Ar base=http://base/

.It Fl O Ns Ar includes=fmt

The URL

The string

.Ar http://base/

.Ar fmt ,

is used as a base URL for all relative links. This is useful when

for example,

linking between documents via the

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

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

.Sq \&In

macro). Instances of

.Sq \&%I

are replaced with the include filename. The default is not to present a

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

macro.

macro). Instances of

.Sq \&%N

and

.Sq %S

are replaced with the linked manual's name and section, respectively.

If no section is included, section 1 is assumed. The default is not to

present a hyperlink.

.El

.Sh EXAMPLES

Line 277 To page manuals to the terminal:

Line 295 To page manuals to the terminal:

.D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less

.Pp

To produce HTML manuals with

.Ar style.css

as the style-sheet:

.Pp

.D1 % mandoc \-Thtml -ostyle=style.css mdoc.7 > mdoc.7.html

.Pp

To check over a large set of manuals:

.Pp

Line 350 retains spaces.

Line 374 retains spaces.

.It

Sentences are unilaterally monospaced.

.El

.Ss HTML output

.Bl -bullet -compact

.It

The

.Xr mdoc 7

.Sq \&Bl \-hang

and

.Sq \&Bl \-tag

list types render similarly (no break following overreached left-hand

side) due to the expressive constraints of HTML.

.It

The

.Xr man 7

.Sq IP

and

.Sq TP

lists render similarly.

.El

.\" SECTION

.Sh SEE ALSO

.Xr mandoc_char 7 ,

.Xr mdoc 7 ,

.Xr man 7

.\" SECTION

.Sh AUTHORS

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq kristaps@kth.se .

.Sh CAVEATS

.Fl T Ns Ar html ,

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

formats with

.Fl O Ns Ar man=fmt .

CVSweb