mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.228 and 1.235

version 1.228, 2018/08/25 16:53:38

version 1.235, 2018/12/28 00:15:11

Line 256 where

is the back-space character number 8.

Emboldened characters are rendered as

.Sq c Ns \e[bs] Ns c .

This markup is typically converted to appropriate terminal sequences by

the pager or

.Xr ul 1 .

To remove the markup, pipe the output to

.Xr col 1

.Fl b

instead.

.Pp

The special characters documented in

.Xr mandoc_char 7

Line 290 One useful application is for checking that

Line 297 One useful application is for checking that

output formats in the same way as the

.Xr mdoc 7

source it was generated from.

.It Cm tag Ns Op = Ns Ar term

If the formatted manual page is opened in a pager,

go to the definition of the

.Ar term

rather than showing the manual page from the beginning.

If no

.Ar term

is specified, reuse the first command line argument that is not a

.Ar section

number.

This is useful when it is the name of a manual page,

in particular the name of a library function.

.It Cm width Ns = Ns Ar width

The output width is set to

.Ar width

Line 308 Equations rendered from

Line 327 Equations rendered from

.Xr eqn 7

blocks use MathML.

.Pp

The

The file

.Pa mandoc.css

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

file documents style-sheet classes available for customising output.

documents style-sheet classes available for customising output.

If a style-sheet is not specified with

.Fl O Cm style ,

.Fl T Cm html

Line 345 Instances of

Line 364 Instances of

are replaced with the include filename.

The default is not to present a

hyperlink.

.It Cm man Ns = Ns Ar fmt

.It Cm man Ns = Ns Ar fmt Ns Op ; Ns Ar fmt

The string

.Ar fmt ,

for example,

Line 361 are replaced with the linked manual's name and section

Line 380 are replaced with the linked manual's name and section

If no section is included, section 1 is assumed.

The default is not to

present a hyperlink.

If two formats are given and a file

.Ar %N.%S

exists in the current directory, the first format is used;

otherwise, the second format is used.

.It Cm style Ns = Ns Ar style.css

The file

.Ar style.css

is used for an external style-sheet.

This must be a valid absolute or

relative URI.

.It Cm toc

If an input file contains at least two non-standard sections,

print a table of contents near the beginning of the output.

.El

.Ss Locale Output

By default,

Line 667 To page manuals to the terminal:

Line 693 To page manuals to the terminal:

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

.Pp

To produce HTML manuals with

.Pa mandoc.css

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

as the style-sheet:

.Pp

.Dl $ mandoc \-T html -O style=mandoc.css mdoc.7 \*(Gt mdoc.7.html

.Dl $ mandoc \-T html -O style=/usr/share/misc/mandoc.css mdoc.7 > mdoc.7.html

.Pp

To check over a large set of manuals:

.Pp

Line 678 To check over a large set of manuals:

Line 704 To check over a large set of manuals:

.Pp

To produce a series of PostScript manuals for A4 paper:

.Pp

.Dl $ mandoc \-T ps \-O paper=a4 mdoc.7 man.7 \*(Gt manuals.ps

.Dl $ mandoc \-T ps \-O paper=a4 mdoc.7 man.7 > manuals.ps

.Pp

Convert a modern

.Xr mdoc 7

Line 688 format, for use on systems lacking an

Line 714 format, for use on systems lacking an

.Xr mdoc 7

parser:

.Pp

.Dl $ mandoc \-T man foo.mdoc \*(Gt foo.man

.Dl $ mandoc \-T man foo.mdoc > foo.man

.Sh DIAGNOSTICS

Messages displayed by

.Nm

follow this format:

.Bd -ragged -offset indent

.Nm :

.Ar file : Ns Ar line : Ns Ar column : level : message : macro args

.Ar file : Ns Ar line : Ns Ar column : level : message : macro arguments

.Pq Ar os

.Ed

.Pp

Line and column numbers start at 1.

The first three fields identify the

.Ar file

name,

.Ar line

number, and

.Ar column

number of the input file where the message was triggered.

The line and column numbers start at 1.

Both are omitted for messages referring to an input file as a whole.

Macro names and arguments are omitted where meaningless.

All

.Ar level

and

.Ar message

strings are explained below.

The name of the

.Ar macro

triggering the message and its

.Ar arguments

are omitted where meaningless.

The

.Ar os

operating system specifier is omitted for messages that are relevant

Line 1657 Start it on a new input line to help formatters produc

Line 1699 Start it on a new input line to help formatters produc

.It Sy "invalid escape sequence"

.Pq roff

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

closing argument delimiter, or the argument has too few characters.

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

a character escape sequence with an invalid name.

If the argument is incomplete,

.Ic \e*

and

Line 1670 and

Line 1713 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

right after the leading backslash is invalid.

That character is printed literally,

which is equivalent to ignoring the backslash.

.It Sy "undefined string, using \(dq\(dq"

.Pq roff

If a string is used without being defined before,

Line 2135 implementations but not by

Line 2184 implementations but not by

.Nm

was found in an input file.

It is replaced by a question mark.

.It Sy "unsupported escape sequence"

.Pq roff

An input file contains an escape sequence supported by GNU troff

or Heirloom troff but not by

.Nm ,

and it is likely that this will cause information loss

or considerable misformatting.

.It Sy "unsupported roff request"

.Pq roff

An input file contains a

CVSweb