mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.226 and 1.237

version 1.226, 2018/07/28 18:34:15

version 1.237, 2019/02/23 18:53:54

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

are rendered best-effort in an ASCII equivalent.

In particular, opening and closing

.Sq single quotes

are represented as characters number 0x60 and 0x27, respectively,

which agrees with all ASCII standards from 1965 to the latest

revision (2012) and which matches the traditional way in which

.Xr roff 7

formatters represent single quotes in ASCII output.

This correct ASCII rendering may look strange with modern

Unicode-compatible fonts because contrary to ASCII, Unicode uses

the code point U+0060 for the grave accent only, never for an opening

quote.

.Pp

The following

.Fl O

Line 290 One useful application is for checking that

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

If that argument is in

.Xr apropos 1

.Ar key Ns = Ns Ar val

format, only the

.Ar val

is used rather than the argument as a whole.

This is useful for commands like

.Ql man -akO tag Ic=ulimit

to search for a keyword and jump right to its definition

in the matching manual pages.

.It Cm width Ns = Ns Ar width

The output width is set to

.Ar width

Line 308 Equations rendered from

Line 346 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 383 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 399 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 712 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 723 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 733 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 1606 or

Line 1667 or

.Cm off .

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

empty, causing it to toggle the spacing mode.

.It Sy "argument contains two font escapes"

.Pq roff

The second argument of a

.Ic char

request contains more than one font escape sequence.

A wrong font may remain active after using the character.

.It Sy "unknown font, skipping request"

.Pq man , tbl

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

Line 1718 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 1664 and

Line 1732 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 1807 or

Line 1881 or

macro.

It may be mistyped or unsupported.

The request or macro is discarded including its arguments.

.It Sy "skipping request outside macro"

.Pq roff

.Ic shift

.Ic return

request occurs outside any macro definition and has no effect.

.It Sy "skipping insecure request"

.Pq roff

An input file attempted to run a shell command

Line 1916 When parsing for a request or a user-defined macro nam

Line 1997 When parsing for a request or a user-defined macro nam

only the escape sequence is discarded.

The characters preceding it are used as the request or macro name,

the characters following it are used as the arguments to the request or macro.

.It Sy "using macro argument outside macro"

.Pq roff

The escape sequence \e$ occurs outside any macro definition

and expands to the empty string.

.It Sy "argument number is not numeric"

.Pq roff

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

the escape sequence expands to the empty string.

.It Sy "NOT IMPLEMENTED: Bd -file"

.Pq mdoc

For security reasons, the

Line 1944 macro fails to specify the list type.

Line 2033 macro fails to specify the list type.

The argument of a

.Ic \&ce

request is not a number.

.It Sy "argument is not a character"

.Pq roff

The first argument of a

.Ic char

request is neither a single ASCII character

nor a single character escape sequence.

The request is ignored including all its arguments.

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

.Pq mdoc

The first call to

Line 1978 or

Line 2074 or

.Ic \&gsize

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

The invalid request or statement is ignored.

.It Sy "excessive shift"

.Pq roff

The argument of a

.Ic shift

request is larger than the number of arguments of the macro that is

currently being executed.

All macro arguments are deleted and \en(.$ is set to zero.

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

.Pq roff

For security reasons,

Line 2100 implementations but not by

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