mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.248 and 1.267

version 1.248, 2020/09/01 18:25:27

version 1.267, 2023/11/13 19:13:01

Line 1

.\" $OpenBSD$

.\" $Id$

.\"

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

Line 287 arguments are accepted:

.It Cm indent Ns = Ns Ar indent

The left margin for normal text is set to

.Ar indent

blank characters instead of the default of five for

blank characters instead of the default of five.

.Xr mdoc 7

and seven for

.Xr man 7 .

Increasing this is not recommended; it may result in degraded formatting,

for example overfull lines or ugly line breaks.

When output is to a pager on a terminal that is less than 66 columns

Line 301 Format

Line 298 Format

input files in

.Xr mdoc 7

output style.

Specifically, this suppresses the two additional blank lines near the

This prints the operating system name rather than the page title

top and the bottom of each page, and it implies

on the right side of the footer line.

.Fl O Cm indent Ns =5 .

One useful application is for checking that

.Fl T Cm man

output formats in the same way as the

Line 342 and may exceed the output width.

Line 338 and may exceed the output width.

Output produced by

.Fl T Cm html

conforms to HTML5 using optional self-closing tags.

Default styles use only CSS1.

Equations rendered from

.Xr eqn 7

blocks use MathML.

.Pp

The file

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

documents style-sheet classes available for customising output.

If a style-sheet is not specified with

.Fl O Cm style ,

.Fl T Cm html

defaults to simple output (via an embedded style-sheet)

readable in any graphical or text-based web

browser.

.Pp

Non-ASCII characters are rendered

as hexadecimal Unicode character references.

.Pp

Line 407 otherwise, the second format is used.

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

is used as an external stylesheet.

This must be a valid absolute or

relative URI.

.Pp

Using the file

.Pa mandoc.css

that is distributed with

.Nm

is recommended.

It provides an appearance similar to terminal output with some additional

features specific to

.Nm

HTML output, in particular making anchor locations that support

deep linking stand out visually by putting a dotted line under them,

providing tooltips showing the semantic function of elements (macro

names), providing some simple aspects of responsive web design, and

providing simple support for users who prefer a dark color scheme.

.Pp

Using a custom CSS file is possible, but writing it requires

proficiency in all of the languages HTML 5, CSS 4, and

.Xr mdoc 7

and familiarity with the

.Nm Ns -specific

classes used in

.Pa mandoc.css .

Besides, while the file

.Pa mandoc.css

is always adapted to the HTML output generated by the

.Nm

version it is distributed with, maintaining a custom CSS file usually

requires adaptations each time

.Nm

is upgraded to a new version.

.Pp

If a stylesheet is not specified with

.Fl O Cm style ,

.Fl T Cm html

embeds a minimal stylesheet into the HTML output, mostly to select

adequate font-style and font-weight attributes for various macros.

The result is readable in any graphical or text-based web browser,

but does not aim for looking similar to terminal output.

Instead, formatting is mostly left to browser defaults

and to user settings in the browser configuration.

.It Cm tag Ns Op = Ns Ar term

Same syntax and semantics as for

.Sx ASCII Output .

Line 487 Use

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

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

as the style-sheet:

as the stylesheet:

.Pp

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

.Pp

Line 766 Messages displayed by

Line 790 Messages displayed by

follow this format:

.Bd -ragged -offset indent

.Nm :

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

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

.Pq Ar os

.Ed

.Pp

Line 786 and

Line 810 and

strings are explained below.

The name of the

.Ar macro

triggering the message and its

triggering the message and its arguments are omitted where meaningless.

.Ar arguments

are omitted where meaningless.

The

.Ar os

operating system specifier is omitted for messages that are relevant

Line 835 message levels, the

Line 857 message levels, the

.Cm style

level tries to reduce the probability that issues go unnoticed,

so it may occasionally issue bogus suggestions.

Please use your good judgement to decide whether any particular

Use your judgement to decide whether any particular

.Cm style

suggestion really justifies a change to the input file.

.It Cm base

Line 922 generated by CVS

Line 944 generated by CVS

.Ic NetBSD

keyword substitution as conventionally used in these operating systems.

.It Sy "referenced manual not found"

.Pq mdoc

.Ic \&Xr

macro references a manual page that is not found in the base system.

The path to look for base system manuals is configurable at compile

time and defaults to

.Pa /usr/share/man : /usr/X11R6/man .

.El

.Ss Style suggestions

.Bl -ohang

Line 1016 list contains two consecutive

Line 1030 list contains two consecutive

entries describing the same

.Ic \&Er

number.

.It Sy "referenced manual not found"

.Pq mdoc

.Ic \&Xr

macro references a manual page that was not found.

When running with

.Fl W Cm base ,

the search is restricted to the base system, by default to

.Pa /usr/share/man : Ns Pa /usr/X11R6/man .

This path can be configured at compile time using the

.Dv MANPATH_BASE

preprocessor macro.

When running with

.Fl W Cm style ,

the search is done along the full search path as described in the

.Xr man 1

manual page, respecting the

.Fl m

and

.Fl M

command line options, the

.Ev MANPATH

environment variable, the

.Xr man.conf 5

file and falling back to the default of

.Pa /usr/share/man : Ns Pa /usr/X11R6/man : Ns Pa /usr/local/man ,

also configurable at compile time using the

.Dv MANPATH_DEFAULT

preprocessor macro.

.It Sy "trailing delimiter"

.Pq mdoc

The last argument of an

Line 1045 An

Line 1088 An

request occurs even though the document already switched to no-fill mode

and did not switch back to fill mode yet.

It has no effect.

.It Sy "input text line longer than 80 bytes"

Consider breaking the input text line

at one of the blank characters before column 80.

.It Sy "verbatim \(dq--\(dq, maybe consider using \e(em"

.Pq mdoc

Even though the ASCII output device renders an em-dash as

Line 1245 The same standard section title occurs more than once.

Line 1291 The same standard section title occurs more than once.

A standard section header occurs in a section of the manual

where it normally isn't useful.

.It Sy "cross reference to self"

.Pq mdoc

.Pq mdoc , man

.Ic \&Xr

.Ic \&MR

macro refers to a name and section matching the section of the present

manual page and a name mentioned in an

.Ic \&Nm

Line 1450 A

Line 1498 A

.Ic \&Bl ,

.Ic \&D1 ,

.Ic \&Dl ,

.Ic \&MT ,

.Ic \&RS ,

.Ic \&UR

.Ic \&RS

block contains nothing in its body and will produce no output.

.It Sy "empty argument, using 0n"

.Pq mdoc

Line 1568 macro is immediately followed by an

Line 1614 macro is immediately followed by an

macro on the next input line.

Such an empty block does not produce any output.

.It Sy "missing section argument"

.Pq mdoc

.Pq mdoc , man

.Ic \&Xr

.Ic \&MR

macro lacks its second, section number argument.

The first argument, i.e. the name, is printed, but without subsequent

The first argument, i.e. the name, is printed, but without a section number.

parentheses.

In the case of

.Ic \&Xr ,

the parentheses are also omitted.

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

.Pq mdoc

Line 1730 request or a

Line 1780 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 1764 it is hard to predict which tab stop position the tab

Line 1823 it is hard to predict which tab stop position the tab

.Pq mdoc

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"

.It Sy "invalid escape sequence argument"

.Pq roff

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

The argument of an escape sequence is of an invalid form.

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

Invalid escape sequences are ignored.

a character escape sequence with an invalid name.

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 2058 and expands to the empty string.

Line 2104 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 2093 The first argument of a

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

.Pq mdoc , man

The first call to

.Ic \&Nm ,

or any call in the NAME section, lacks the required argument.

or any call in the NAME section, lacks the required argument, or

.Ic \&MR

is called without any argument.

.It Sy "uname(3) system call failed, using UNKNOWN"

.Pq mdoc

The

Line 2225 or a request of the

Line 2287 or a request of the

family with more than two arguments

.It

.Ic \&Dt

.Ic \&MR

with more than three arguments

.It

.Ic \&TH

Line 2238 with invalid arguments

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

.It Sy "invalid escape argument delimiter"

.Pq roff

An escape sequence that expects a numerical argument

attempts to employ one of the characters

.Qq " %&()*+-./0123456789:<=>"

as an argument delimiter.

The escape sequence is ignored including the invalid opening delimiter

and the rest of the argument may appear as output text.

While various characters can be used as argument delimiters,

using the apostrophe-quote character

.Pq Sq \(aq

is recommended for readability and robustness.

.El

.Ss Unsupported features

.Bl -ohang

.It Sy "input too large"

Line 2290 or

Line 2408 or

macro or of an undefined macro.

The macro is ignored, and its arguments are handled

as if they were a text line.

.It Sy "skipping tbl in -Tman mode"

.Pq mdoc , tbl

An input file contains the

.Ic \&TS

macro.

This message is only generated in

.Fl T Cm man

output mode, where

.Xr tbl 7

input is not supported.

.It Sy "skipping eqn in -Tman mode"

.Pq mdoc , eqn

An input file contains the

.Ic \&EQ

macro.

This message is only generated in

.Fl T Cm man

output mode, where

.Xr eqn 7

input is not supported.

.El

.Ss Bad command line arguments

.Bl -ohang

Line 2327 The

Line 2465 The

.Fl O Cm tag

option was specified but the tag was not found in any of the displayed

manual pages.

.It Sy "\-Tmarkdown unsupported for man(7) input"

.Pq man

The

.Fl T Cm markdown

option was specified but an input file uses the

.Xr man 7

language.

No output is produced for that input file.

.El

.Sh SEE ALSO

.Xr apropos 1 ,

CVSweb