mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.106 and 1.116

version 1.106, 2014/08/08 01:50:59

version 1.116, 2014/10/10 08:44:24

Line 23

.Nd format and display UNIX manuals

.Sh SYNOPSIS

.Nm mandoc

.Op Fl V

.Op Fl acfhklV

.Sm off

.Op Fl I Cm os Li = Ar name

.Sm on

Line 51 and produces

.Fl T Ns Cm ascii

output.

.Pp

The arguments are as follows:

The options are as follows:

.Bl -tag -width Ds

.It Fl a

If the standard output is a terminal device and

.Fl c

is not specified, use

.Xr more 1

to paginate the output, just like

.Xr man 1

would.

.It Fl c

Copy the formatted manual pages to the standard output without using

.Xr more 1

to paginate them.

This is the default.

It can be specified to override

.Fl a .

.It Fl f

A synonym for

.Xr whatis 1 .

This overrides any earlier

.Fl k

and

.Fl l

options.

.Sm off

.It Fl I Cm os Li = Ar name

.Sm on

Line 62 for the

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 .

This overrides any earlier

.Fl f

and

.Fl l

options.

.It Fl l

A synonym for

.Fl a .

Also reverts any earlier

.Fl f

and

.Fl k

options.

.It Fl m Ns Ar format

Input format.

See

Line 122 If multiple files are specified,

Line 165 If multiple files are specified,

.Nm

will halt with the first failed parse.

.El

.Pp

.Fl f

and

.Fl k

mode,

.Nm

also supports the options

.Fl CMmOSsw

described in the

.Xr apropos 1

manual.

.Ss Input Formats

The

.Nm

Line 178 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 210 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 265 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 273 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 416 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

.Sh ENVIRONMENT

Output produced by

.Bl -tag -width MANPAGER

.Fl T Ns Cm xhtml

.It Ev MANPAGER

conforms to XHTML-1.0 strict.

Any non-empty value of the environment variable

.Pp

.Ev MANPAGER

See

will be used instead of the standard pagination program,

.Sx HTML Output

.Xr more 1 .

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

.It Ev PAGER

output modes are identical.

Specifies the pagination program to use when

.Ev MANPAGER

is not defined.

If neither PAGER nor MANPAGER is defined,

.Pa /usr/bin/more Fl s

will be used.

.El

.Sh EXIT STATUS

The

.Nm

Line 696 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 1026 macro has an invalid argument.

Line 1113 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 "invalid content in Rs block"

.Pq mdoc

Line 1044 or

Line 1138 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 1430 has no effect.

Line 1529 has no effect.

.It

Words aren't hyphenated.

.El

.Ss HTML/XHTML Compatibility

.Ss HTML Compatibility

.Bl -bullet -compact

.It

The

CVSweb