mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.254 and 1.259

version 1.254, 2022/02/08 18:27:45

version 1.259, 2022/06/05 13:54:09

Line 1

.\" $OpenBSD$

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

Line 487 Use

to translate

.Xr mdoc 7

input to the markdown format conforming to

.Lk http://daringfireball.net/projects/markdown/syntax.text\

.Lk https://daringfireball.net/projects/markdown/syntax.text\

"John Gruber's 2004 specification" .

The output also almost conforms to the

.Lk http://commonmark.org/ CommonMark

.Lk https://commonmark.org/ CommonMark

specification.

.Pp

The character set used for the markdown output is ASCII.

Line 735 output mode implies

.Sh EXAMPLES

To page manuals to the terminal:

.Pp

.Dl $ mandoc -l mandoc.1 man.1 apropos.1 makewhatis.8

.Dl $ mandoc -a mandoc.1 man.1 apropos.1 makewhatis.8

.Pp

To produce HTML manuals with

.Pa /usr/share/misc/mandoc.css

Line 1754 request or a

layout modifier has an unknown

.Ar font

argument.

.It Sy "ignoring distance argument"

.Pq roff

In addition to the margin character, an

.Ic \&mc

request has a second argument supposed to represent a distance, but the

.Nm

implementation of

.Ic \&mc

always ignores the second argument.

.It Sy "odd number of characters in request"

.Pq roff

Line 1790 A new sentence starts in the middle of a text line.

Line 1799 A new sentence starts in the middle of a text line.

Start it on a new input line to help formatters produce correct spacing.

.It Sy "invalid escape sequence"

.Pq roff

An escape sequence has an invalid opening argument delimiter, lacks the

An escape sequence has an invalid opening argument delimiter

closing argument delimiter, the argument is of an invalid form, or it is

or the argument is of an invalid form.

a character escape sequence with an invalid name.

Invalid escape sequences are ignored.

If the argument is incomplete,

.Ic \e*

and

.Ic \en

expand to an empty string,

.Ic \eB

to the digit

.Sq 0 ,

and

.Ic \ew

to the length of the incomplete argument.

All other invalid escape sequences are ignored.

.It Sy "undefined escape, printing literally"

.Pq roff

In an escape sequence, the first character

Line 2082 and expands to the empty string.

Line 2079 and expands to the empty string.

.Pq roff

The argument of the escape sequence \e$ is not a digit;

the escape sequence expands to the empty string.

.It Sy "negative argument, using 0"

.Pq roff

.Ic \&shift

request has a negative argument

or an argument that is negative due to integer overflow.

Macro argument numbering remains unchanged.

.It Sy "NOT IMPLEMENTED: Bd -file"

.Pq mdoc

For security reasons, the

Line 2117 The first argument of a

Line 2121 The first argument of a

request is neither a single ASCII character

nor a single character escape sequence.

The request is ignored including all its arguments.

.It Sy "skipping unusable escape sequence"

.Pq roff

The first argument of an

.Ic mc

request is neither a single ASCII character

nor a single character escape sequence.

All arguments are ignored and printing of a margin character is disabled.

.It Sy "missing manual name, using \(dq\(dq"

.Pq mdoc

The first call to

Line 2261 or

Line 2272 or

with invalid arguments

.El

The excess arguments are ignored.

.El

.Ss "Errors related to escape sequences"

.Bl -ohang

.It Sy "incomplete escape sequence"

.Pq roff

The end of the input line is encountered

while parsing the argument of an escape sequence.

In this case,

.Ic \e*

and

.Ic \en

expand to an empty string,

.Ic \eB

to the digit

.Sq 0 ,

and

.Ic \ew

to the length of the incomplete argument.

All other incomplete escape sequences are ignored.

.It Sy "invalid special character"

.Pq roff

A special character escape sequence is invalid,

for example a Unicode sequence pointing to a surrogate

or beyond the Unicode range, a \e[char...] escape sequence

representing a control character or pointing beyond the

.Vt unsigned char

range, or an invalid variable-length form

of a single-byte character escape sequence, for example writing

.Qq \e[e]

.Qq \e[~]

instead of

.Qq \ee

.Qq \e~ ,

respectively.

The escape sequence is ignored.

.It Sy "unknown special character"

.Pq roff

The name given in a special character escape sequence is not known to

.Nm .

The escape sequence is ignored.

.El

.Ss Unsupported features

.Bl -ohang

CVSweb