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.249

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

version 1.249, 2021/06/02 18:28:19

Line 1

.\" $Id$

.\" $OpenBSD$

.\"

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

.\" purpose with or without fee is hereby granted, provided that the above

Line 52 The options are as follows:

If the standard output is a terminal device and

.Fl c

is not specified, use

.Xr more 1

.Xr less 1

to paginate the output, just like

.Xr man 1

would.

.It Fl c

Copy the formatted manual pages to the standard output without using

.Xr more 1

.Xr less 1

to paginate them.

This is the default.

It can be specified to override

Line 222 reads from standard input.

.Pp

The options

.Fl fhklw

are also supported and are documented in man(1).

are also supported and are documented in

.Xr man 1 .

.Fl f

and

Line 256 where

Line 257 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 309 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 347 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 384 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 400 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 tag Ns Op = Ns Ar term

Same syntax and semantics as for

.Sx ASCII Output .

This is implemented by passing a

.Ic file://

URI ending in a fragment identifier to the pager

rather than passing merely a file name.

When using this argument, use a pager supporting such URIs, for example

.Bd -literal -offset 3n

MANPAGER='lynx -force_html' man -T html -O tag=MANPAGER man

MANPAGER='w3m -T text/html' man -T html -O tag=toc mandoc

.Ed

.Pp

Consequently, for HTML output, this argument does not work with

.Xr more 1

.Xr less 1 .

For example,

.Ql MANPAGER=less man -T html -O tag=toc mandoc

does not work because

.Xr less 1

does not support

.Ic file://

URIs.

.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 397 This is useful for distributing manual sources to lega

Line 467 This is useful for distributing manual sources to lega

lacking

.Xr mdoc 7

formatters.

Embedded

.Xr eqn 7

and

.Xr tbl 7

code is not supported.

.Pp

If the input format of a file is

.Xr man 7 ,

the input is copied to the output, expanding any

the input is copied to the output.

.Xr roff 7

.Ic so

requests.

The parser is also run, and as usual, the

.Fl W

level controls which

Line 582 It never affects the interpretation of input files.

Line 654 It never affects the interpretation of input files.

Any non-empty value of the environment variable

.Ev MANPAGER

is used instead of the standard pagination program,

.Xr more 1 ;

.Xr less 1 ;

see

.Xr man 1

for details.

Line 596 Specifies the pagination program to use when

Line 668 Specifies the pagination program to use when

.Ev MANPAGER

is not defined.

If neither PAGER nor MANPAGER is defined,

.Xr more 1

.Xr less 1

.Fl s

is used.

Only used if

.Fl a

Line 652 No input files have been read.

Line 723 No input files have been read.

.It 6

An operating system error occurred, for example exhaustion

of memory, file descriptors, or process table entries.

Such errors cause

Such errors may cause

.Nm

to exit at once, possibly in the middle of parsing or formatting a file.

.El

Line 667 To page manuals to the terminal:

Line 738 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 749 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 759 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 716 fields.

Line 803 fields.

.Pp

Message levels have the following meanings:

.Bl -tag -width "warning"

.It Cm syserr

An operating system error occurred.

There isn't necessarily anything wrong with the input files.

Output may all the same be missing or incomplete.

.It Cm badarg

Invalid command line arguments were specified.

No input files have been read and no output is produced.

.It Cm unsupp

An input file uses unsupported low-level

.Xr roff 7

Line 764 Messages of the

Line 858 Messages of the

.Cm error ,

and

.Cm unsupp

levels except those about non-existent or unreadable input files

levels are hidden unless their level, or a lower level, is requested using a

are hidden unless their level, or a lower level, is requested using a

.Fl W

option or

.Fl T Cm lint

Line 829 generated by CVS

Line 922 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 923 list contains two consecutive

Line 1008 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 1005 macro lacks the mandatory section argument.

Line 1119 macro lacks the mandatory section argument.

The section number in a

.Ic \&Dt

line is invalid, but still used.

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

.It Sy "filename/section mismatch"

.Pq mdoc , man

The name of the input file being processed is known and its file

name extension starts with a non-zero digit, but the

.Ic \&Dt

.Ic \&TH

macro contains a

.Ar section

argument that starts with a different non-zero digit.

The

.Ar section

argument is used as provided anyway.

Consider checking whether the file name or the argument need a correction.

.It Sy "missing date, using \(dq\(dq"

.Pq mdoc, man

The document was parsed as

.Xr mdoc 7

Line 1638 The meaning of blank input lines is only well-defined

Line 1766 The meaning of blank input lines is only well-defined

In fill mode, line breaks of text input lines are not supposed to be

significant.

However, for compatibility with groff, blank lines in fill mode

are replaced with

are formatted like

.Ic \&sp

requests.

To request a paragraph break, use

.Ic \&Pp

instead of a blank line.

.It Sy "tab in filled text"

.Pq mdoc , man

The meaning of tab characters is only well-defined in non-fill mode:

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

Line 1788 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 1802 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 1733 The invalid character is discarded.

Line 1871 The invalid character is discarded.

A table layout specification contains an opening parenthesis,

but no matching closing parenthesis.

The rest of the input line, starting from the parenthesis, has no effect.

.It Sy "ignoring excessive spacing in tbl layout"

.Pq tbl

A spacing modifier in a table layout is unreasonably large.

The default spacing of 3n is used instead.

.It Sy "tbl without any data cells"

.Pq tbl

A table does not contain any data cells.

Line 2135 implementations but not by

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

Line 2162 or

Line 2311 or

macro or of an undefined macro.

The macro is ignored, and its arguments are handled

as if they were a text line.

.El

.Ss Bad command line arguments

.Bl -ohang

.It Sy "bad command line argument"

The argument following one of the

.Fl IKMmOTW

command line options is invalid, or a

.Ar file

given as a command line argument cannot be opened.

.It Sy "duplicate command line argument"

The

.Fl I

command line option was specified twice.

.It Sy "option has a superfluous value"

An argument to the

.Fl O

option has a value but does not accept one.

.It Sy "missing option value"

An argument to the

.Fl O

option has no argument but requires one.

.It Sy "bad option value"

An argument to the

.Fl O

.Cm indent

.Cm width

option has an invalid value.

.It Sy "duplicate option value"

The same

.Fl O

option is specified more than once.

.It Sy "no such tag"

The

.Fl O Cm tag

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

manual pages.

.El

.Sh SEE ALSO

.Xr apropos 1 ,

CVSweb