mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.109 and 1.118

version 1.109, 2014/08/30 18:08:10

version 1.118, 2014/10/12 19:31:41

Line 23

.Nd format and display UNIX manuals

.Sh SYNOPSIS

.Nm mandoc

.Op Fl acfklV

.Op Fl acfhklV

.Sm off

.Op Fl I Cm os Li = Ar name

.Sm on

Line 85 for the

.Xr mdoc 7

.Sq \&Os

macro.

.It Fl h

Display only the SYNOPSIS lines.

Implies

.Fl a .

.It Fl k

A synonym for

.Xr apropos 1 .

Line 229 This is the default.

Line 233 This is the default.

See

.Sx ASCII Output .

.It Fl T Ns Cm html

Produce strict CSS1/HTML-4.01 output.

Produce HTML5, CSS1, and MathML output.

See

.Sx HTML Output .

.It Fl T Ns Cm lint

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

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

This is a synonym for

See

.Fl T Ns Cm html .

.Sx XHTML Output .

.El

.Pp

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

Line 316 which will normalise to \(>=60.

Line 319 which will normalise to \(>=60.

.Ss HTML Output

Output produced by

.Fl T Ns Cm html

conforms to HTML-4.01 strict.

conforms to HTML5 using optional self-closing tags.

Default styles use only CSS1.

Equations rendered from

.Xr eqn 7

blocks use MathML.

.Pp

The

.Pa example.style.css

Line 324 file documents style-sheet classes available for custo

Line 331 file documents style-sheet classes available for custo

If a style-sheet is not specified with

.Fl O Ns Ar style ,

.Fl T Ns Cm html

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

defaults to simple output (via an embedded style-sheet)

readable in any graphical or text-based web

browser.

.Pp

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

Line 467 to force a UTF\-8 locale.

Line 475 to force a UTF\-8 locale.

See

.Sx Locale Output

for details and options.

.Ss XHTML Output

Output produced by

.Fl T Ns Cm 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 ENVIRONMENT

.Bl -tag -width MANPAGER

.It Ev MANPAGER

Line 762 The same standard section title occurs more than once.

Line 761 The same standard section title occurs more than once.

.Pq mdoc

A standard section header occurs in a section of the manual

where it normally isn't useful.

.It Sy "unusual Xr order"

.Pq mdoc

In the SEE ALSO section, an

.Ic \&Xr

macro with a lower section number follows one with a higher number,

or two

.Ic \&Xr

macros refering to the same section are out of alphabetical order.

.It Sy "unusual Xr punctuation"

.Pq mdoc

In the SEE ALSO section, punctuation between two

.Ic \&Xr

macros differs from a single comma, or there is trailing punctuation

after the last

.Ic \&Xr

macro.

.It Sy "AUTHORS section without An macro"

.Pq mdoc

An AUTHORS sections contains no

.Ic \&An

macros, or only empty ones.

Probably, there are author names lacking markup.

.El

.Ss "Warnings related to macros and nesting"

.Bl -ohang

Line 890 The previous, interrupted macro is deleted from the pa

Line 911 The previous, interrupted macro is deleted from the pa

.Ss "Warnings related to missing arguments"

.Bl -ohang

.It Sy "skipping empty request"

.Pq roff

.Pq roff , eqn

The macro name is missing from a macro definition request.

The macro name is missing from a macro definition request,

or an

.Xr eqn 7

control statement or operation keyword lacks its required argument.

.It Sy "conditional request controls empty scope"

.Pq roff

A conditional request is only useful if any of the following

Line 1025 The

Line 1049 The

utility assumes

.Fl std

even when it is not specified, but other implementations may not.

.It Sy "missing eqn box, using \(dq\(dq"

.Pq eqn

A diacritic mark or a binary operator is found,

but there is nothing to the left of it.

An empty box is inserted.

.El

.Ss "Warnings related to bad macro arguments"

.Bl -ohang

Line 1092 macro has an invalid argument.

Line 1121 macro has an invalid argument.

It is used verbatim, with

.Qq "AT&T UNIX "

prefixed to it.

.It Sy "comma in function argument"

.Pq mdoc

An argument of an

.Ic \&Fa

.Ic \&Fn

macro contains a comma; it should probably be split into two arguments.

.It Sy "parenthesis in function name"

.Pq mdoc

The first argument of an

.Ic \&Fc

.Ic \&Fn

macro contains an opening or closing parenthesis; that's probably wrong,

parentheses are added automatically.

.It Sy "invalid content in Rs block"

.Pq mdoc

Line 1110 or

Line 1154 or

The invalid argument is moved out of the macro, which leaves the macro

empty, causing it to toggle the spacing mode.

.It Sy "unknown font, skipping request"

.Pq man

.Pq man , tbl

.Xr roff 7

.Ic \&ft

request has an invalid argument.

request or a

.Xr tbl 7

.Ic \&f

layout modifier has an unknown

.Ar font

argument.

.El

.Ss "Warnings related to plain text"

.Bl -ohang

Line 1177 keeps the code more readable.

Line 1226 keeps the code more readable.

.It "equation scope open on exit"

.It "overlapping equation scopes"

.It "unexpected end of equation"

.It "equation syntax error"

.El

.Ss "Errors related to tables"

.Bl -inset -compact

Line 1231 macro.

Line 1279 macro.

It may be mistyped or unsupported.

The request or macro is discarded including its arguments.

.It Sy "skipping item outside list"

.Pq mdoc

.Pq mdoc , eqn

.Ic \&It

macro occurs outside any

.Ic \&Bl

list.

list, or an

.Xr eqn 7

.Ic above

delimiter occurs outside any pile.

It is discarded including its arguments.

.It Sy "skipping column outside column list"

.Pq mdoc

Line 1257 block closing macro, a

Line 1308 block closing macro, a

.Ic \&RE

.Ic \&UE

macro, or the end of an equation, table, or

macro, an

.Xr eqn 7

right delimiter or closing brace, or the end of an equation, table, or

.Xr roff 7

conditional request is encountered but no matching block is open.

The offending request or macro is discarded.

Line 1354 An

Line 1407 An

.Ic \&St

macro has an unknown argument and is discarded.

.It Sy "skipping request without numeric argument"

.Pq roff

.Pq roff , eqn

.Ic \&it

request has a non-numeric or negative argument or no argument at all.

request or an

The invalid request is ignored.

.Xr eqn 7

.Ic \&size

.Ic \&gsize

statement has a non-numeric or negative argument or no argument at all.

The invalid request or statement is ignored.

.It Sy "skipping all arguments"

.Pq mdoc , man , eqn , roff

Line 1496 has no effect.

Line 1554 has no effect.

.It

Words aren't hyphenated.

.El

.Ss HTML/XHTML Compatibility

.Ss HTML Compatibility

.Bl -bullet -compact

.It

The

CVSweb