mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

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

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

version 1.130, 2014/12/28 14:42:27

Line 27

.Sm off

.Op Fl I Cm os Li = Ar name

.Sm on

.Op Fl K Ns Ar encoding

.Op Fl m Ns Ar format

.Op Fl O Ns Ar option

.Op Fl T Ns Ar output

Line 48 or

Line 49 or

text from stdin, implying

.Fl m Ns Cm andoc ,

and produces

.Fl T Ns Cm ascii

.Fl T Ns Cm locale

output.

.Pp

The options are as follows:

Line 84 Override the default operating system

Line 85 Override the default operating system

for the

.Xr mdoc 7

.Sq \&Os

and for the

.Xr man 7

.Sq \&TH

macro.

.It Fl h

Display only the SYNOPSIS lines.

Implies

.Fl a .

.Fl c .

.It Fl K Ns Ar encoding

Specify the input encoding.

The supported

.Ar encoding

arguments are

.Cm us-ascii ,

.Cm iso-8859-1 ,

and

.Cm utf-8 .

If not specified, autodetection uses the first match:

.Bl -tag -width iso-8859-1

.It Cm utf-8

if the first three bytes of the input file

are the UTF-8 byte order mark (BOM, 0xefbbbf)

.It Ar encoding

if the first or second line of the input file matches the

.Sy emacs

mode line format

.Pp

.D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-

.It Cm utf-8

if the first non-ASCII byte in the file introduces a valid UTF-8 sequence

.It Cm iso-8859-1

otherwise

.El

.It Fl k

A synonym for

.Xr apropos 1 .

Line 120 See

Line 149 See

.Sx Output Formats

for available formats.

Defaults to

.Fl T Ns Cm ascii .

.Fl T Ns Cm locale .

.It Fl V

Print version and exit.

.It Fl W Ns Ar level

Line 229 arguments, which correspond to output modes:

Line 258 arguments, which correspond to output modes:

.Bl -tag -width "-Tlocale"

.It Fl T Ns Cm ascii

Produce 7-bit ASCII output.

This is the default.

See

.Sx ASCII Output .

.It Fl T Ns Cm html

Line 242 Implies

Line 270 Implies

.Fl W Ns Cm warning .

.It Fl T Ns Cm locale

Encode output using the current locale.

This is the default.

See

.Sx Locale Output .

.It Fl T Ns Cm man

Line 273 If multiple input files are specified, these will be p

Line 302 If multiple input files are specified, these will be p

corresponding filter in-order.

.Ss ASCII Output

Output produced by

.Fl T Ns Cm ascii ,

.Fl T Ns Cm ascii

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

is rendered in standard 7-bit ASCII documented in

.Xr ascii 7 .

.Pp

Font styles are applied by using back-spaced encoding such that an

Line 342 The following

Line 371 The following

arguments are accepted:

.Bl -tag -width Ds

.It Cm fragment

Omit the

Omit the <!DOCTYPE> declaration and the <html>, <head>, and <body>

.Aq !DOCTYPE

elements and only emit the subtree below the <body> element.

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.

Line 395 relative URI.

Line 416 relative URI.

.Ss Locale Output

Locale-depending output encoding is triggered with

.Fl T Ns Cm locale .

This is the default.

.Pp

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

Line 647 macro lacks the mandatory section argument.

Line 670 macro lacks the mandatory section argument.

The section number in a

.Ic \&Dt

line is invalid, but still used.

.It Sy "unknown manual volume or arch"

.Pq mdoc

The volume name in a

.Ic \&Dt

line is invalid, but still used.

The manual is assumed to be architecture-independent.

.It Sy "missing date, using today's date"

.Pq mdoc, man

The document was parsed as

Line 791 Probably, there are author names lacking markup.

Line 808 Probably, there are author names lacking markup.

See the

.Xr mdoc 7

manual for replacements.

.It Sy "macro neither callable nor escaped"

.Pq mdoc

The name of a macro that is not callable appears on a macro line.

It is printed verbatim.

If the intention is to call it, move it to its own line;

otherwise, escape it by prepending

.Sq \e& .

.It Sy "skipping paragraph macro"

.Xr mdoc 7

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

Line 935 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 1032 argument is invalid.

Line 1059 argument is invalid.

The default font

.Cm \efR

is used instead.

.It Sy "nothing follows prefix"

.Pq mdoc

.Ic \&Pf

macro has no argument, or only one argument and no macro follows

on the same input line.

This defeats its purpose; in particular, spacing is not suppressed

before the text or macros following on the next input line.

.It Sy "missing -std argument, adding it"

.Pq mdoc

Line 1046 The

Line 1081 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 1120 An argument of an

Line 1160 An argument of an

.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 1210 keeps the code more readable.

Line 1258 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 1222 keeps the code more readable.

Line 1269 keeps the code more readable.

.It "ignore data in cell"

.It "data block still open"

.It "ignoring extra data cells"

.It "ignoring macro in table"

.El

.Ss "Errors related to roff, mdoc, and man code"

.Bl -ohang

Line 1264 macro.

Line 1312 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 1290 block closing macro, a

Line 1341 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 1358 The indicated request or macro has too few or too many

Line 1411 The indicated request or macro has too few or too many

The syntax tree will contain the wrong number of arguments as given.

Formatting behaviour depends on the specific request or macro in question.

Note that the same message may also occur as a WARNING, see above.

.It Sy "NOT IMPLEMENTED: Bd -file"

.Pq mdoc

For security reasons, the

.Ic \&Bd

macro does not support the

.Fl file

argument.

By requesting the inclusion of a sensitive file, a malicious document

might otherwise trick a privileged user into inadvertently displaying

the file on the screen, revealing the file content to bystanders.

The argument is ignored including the file name following it.

.It Sy "missing list type, using -item"

.Pq mdoc

Line 1387 An

Line 1451 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 1414 or

Line 1483 or

.Ic \&PP

macro, an

.Xr eqn 7

.Ic \&EQ

.Ic \&EN

macro, or a

.Xr roff 7

Line 1439 cannot handle input files larger than its arbitrary si

Line 1510 cannot handle input files larger than its arbitrary si

of 2^31 bytes (2 Gigabytes).

Since useful manuals are always small, this is not a problem in practice.

Parsing is aborted as soon as the condition is detected.

.It Sy "NOT IMPLEMENTED: Bd -file"

.Pq mdoc

For security reasons, the

.Ic \&Bd

macro does not support the

.Fl file

argument.

By requesting the inclusion of a sensitive file, a malicious document

might otherwise trick a privileged user into inadvertently displaying

the file on the screen, revealing the file content to bystanders.

The parser exits immediately.

.It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"

.Pq roff

For security reasons,

CVSweb