mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.155 and 1.176

version 1.155, 2015/02/23 13:31:03

version 1.176, 2017/03/04 17:17:34

Line 1

.\" $Id$

.\"

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

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

Line 24

.Sh SYNOPSIS

.Nm mandoc

.Op Fl acfhkl

.Sm off

.Op Fl I Cm os Ns = Ns Ar name

.Op Fl I Cm os Li = Ar name

.Op Fl K Ar encoding

.Sm on

.Op Fl K Ns Ar encoding

.Op Fl m Ns Ar format

.Op Fl O Ns Ar option

.Op Fl O Ar option

.Op Fl T Ns Ar output

.Op Fl T Ar output

.Op Fl W Ns Ar level

.Op Fl W Ar level

.Op Ar

.Sh DESCRIPTION

The

Line 49 or

Line 47 or

text from stdin, implying

.Fl m Ns Cm andoc ,

and produces

.Fl T Ns Cm locale

.Fl T Cm locale

output.

.Pp

The options are as follows:

Line 77 This overrides any earlier

Line 75 This overrides any earlier

and

.Fl l

options.

.Sm off

.It Fl h

.It Fl I Cm os Li = Ar name

Display only the SYNOPSIS lines.

.Sm on

Implies

.Fl c .

.It Fl I Cm os Ns = Ns Ar name

Override the default operating system

.Ar name

for the

Line 89 and for the

.Xr man 7

.Sq \&TH

macro.

.It Fl h

.It Fl K Ar encoding

Display only the SYNOPSIS lines.

Implies

.Fl c .

.It Fl K Ns Ar encoding

Specify the input encoding.

The supported

.Ar encoding

Line 102 arguments are

Line 98 arguments are

.Cm iso-8859-1 ,

and

.Cm utf-8 .

If not specified, autodetection uses the first match:

If not specified, autodetection uses the first match in the following

.Bl -tag -width iso-8859-1

list:

.It Cm utf-8

.Bl -enum

if the first three bytes of the input file

.It

are the UTF-8 byte order mark (BOM, 0xefbbbf)

If the first three bytes of the input file are the UTF-8 byte order

.It Ar encoding

mark (BOM, 0xefbbbf), input is interpreted as

if the first or second line of the input file matches the

.Cm utf-8 .

.It

If the first or second line of the input file matches the

.Sy emacs

mode line format

.Pp

.D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-

.It Cm utf-8

.Pp

if the first non-ASCII byte in the file introduces a valid UTF-8 sequence

then input is interpreted according to

.It Cm iso-8859-1

.Ar encoding .

otherwise

.It

If the first non-ASCII byte in the file introduces a valid UTF-8

sequence, input is interpreted as

.Cm utf-8 .

.It

Otherwise, input is interpreted as

.Cm iso-8859-1 .

.El

.It Fl k

A synonym for

Line 141 See

Line 145 See

for available formats.

Defaults to

.Fl m Ns Cm andoc .

.It Fl O Ns Ar option

.It Fl O Ar option

Comma-separated output options.

.It Fl T Ns Ar output

.It Fl T Ar output

Output format.

See

.Sx Output Formats

for available formats.

Defaults to

.Fl T Ns Cm locale .

.Fl T Cm locale .

.It Fl W Ns Ar level

.It Fl W Ar level

Specify the minimum message

.Ar level

to be reported on the standard error output and to affect the exit status.

Line 174 and

Line 178 and

for details.

.Pp

The special option

.Fl W Ns Cm stop

.Fl W Cm stop

tells

.Nm

to exit after parsing a file that causes warnings or errors of at least

Line 185 If both a

Line 189 If both a

and

.Cm stop

are requested, they can be joined with a comma, for example

.Fl W Ns Cm error , Ns Cm stop .

.Fl W Cm error , Ns Cm stop .

.It Ar file

Read input from zero or more files.

If unspecified, reads from stdin.

Line 254 The

Line 258 The

utility accepts the following

.Fl T

arguments, which correspond to output modes:

.Bl -tag -width "-Tlocale"

.Bl -tag -width "-T markdown"

.It Fl T Ns Cm ascii

.It Fl T Cm ascii

Produce 7-bit ASCII output.

See

.Sx ASCII Output .

.It Fl T Ns Cm html

.It Fl T Cm html

Produce HTML5, CSS1, and MathML output.

See

.Sx HTML Output .

.It Fl T Ns Cm lint

.It Fl T Cm lint

Parse only: produce no output.

Implies

.Fl W Ns Cm warning .

.Fl W Cm warning .

.It Fl T Ns Cm locale

.It Fl T Cm locale

Encode output using the current locale.

This is the default.

See

.Sx Locale Output .

.It Fl T Ns Cm man

.It Fl T Cm man

Produce

.Xr man 7

format output.

See

.Sx Man Output .

.It Fl T Ns Cm pdf

.It Fl T Cm markdown

Produce output in

.Sy markdown

format.

See

.Sx Markdown Output .

.It Fl T Cm pdf

Produce PDF output.

See

.Sx PDF Output .

.It Fl T Ns Cm ps

.It Fl T Cm ps

Produce PostScript output.

See

.Sx PostScript Output .

.It Fl T Ns Cm tree

.It Fl T Cm tree

Produce an indented parse tree.

.It Fl T Ns Cm utf8

See

.Sx Syntax tree output .

.It Fl T Cm utf8

Encode output in the UTF\-8 multi-byte format.

See

.Sx UTF\-8 Output .

.It Fl T Ns Cm xhtml

.It Fl T Cm xhtml

This is a synonym for

.Fl T Ns Cm html .

.Fl T Cm html .

.El

.Pp

If multiple input files are specified, these will be processed by the

corresponding filter in-order.

.Ss ASCII Output

Output produced by

.Fl T Ns Cm ascii

.Fl T Cm ascii

is rendered in standard 7-bit ASCII documented in

.Xr ascii 7 .

.Pp

Line 343 which will normalise to \(>=58.

Line 355 which will normalise to \(>=58.

.El

.Ss HTML Output

Output produced by

.Fl T Ns Cm html

.Fl T Cm html

conforms to HTML5 using optional self-closing tags.

Default styles use only CSS1.

Equations rendered from

Line 351 Equations rendered from

Line 363 Equations rendered from

blocks use MathML.

.Pp

The

.Pa example.style.css

.Pa mandoc.css

file documents style-sheet classes available for customising output.

If a style-sheet is not specified with

.Fl O Ns Ar style ,

.Fl O Cm style ,

.Fl T Ns Cm html

.Fl T Cm html

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

readable in any graphical or text-based web

browser.

Line 411 relative URI.

Line 423 relative URI.

.El

.Ss Locale Output

Locale-depending output encoding is triggered with

.Fl T Ns Cm locale .

.Fl T Cm locale .

This is the default.

.Pp

This option is not available on all systems: systems without locale

support, or those whose internal representation is not natively UCS-4,

will fall back to

.Fl T Ns Cm ascii .

.Fl T Cm ascii .

See

.Sx ASCII Output

for font style specification and available command-line arguments.

Line 445 The parser is also run, and as usual, the

Line 457 The parser is also run, and as usual, the

level controls which

.Sx DIAGNOSTICS

are displayed before copying the input to the output.

.Ss Markdown Output

Translate

.Xr mdoc 7

input to the

.Sy markdown

format conforming to

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

"John Gruber's 2004 specification" .

.Pp

Markdown is a very weak markup language, so all semantic markup is

lost, and even part of the presentational markup may be lost.

Do not use this as an intermediate step in converting to HTML;

instead, use

.Fl T Cm html

directly.

.Pp

The

.Xr man 7 ,

.Xr tbl 7 ,

and

.Xr eqn 7

input languages are not supported by

.Fl T Cm markdown

output mode.

.Ss PDF Output

PDF-1.1 output may be generated by

.Fl T Ns Cm pdf .

.Fl T Cm pdf .

See

.Sx PostScript Output

for

Line 457 arguments and defaults.

Line 493 arguments and defaults.

PostScript

.Qq Adobe-3.0

Level-2 pages may be generated by

.Fl T Ns Cm ps .

.Fl T Cm ps .

Output pages default to letter sized and are rendered in the Times font

family, 11-point.

Margins are calculated as 1/9 the page length and width.

Line 489 is used.

Line 525 is used.

.El

.Ss UTF\-8 Output

Use

.Fl T Ns Cm utf8

.Fl T Cm utf8

to force a UTF\-8 locale.

See

.Sx Locale Output

for details and options.

.Ss Syntax tree output

Use

.Fl T Cm tree

to show a human readable representation of the syntax tree.

It is useful for debugging the source code of manual pages.

The exact format is subject to change, so don't write parsers for it.

.Pp

The first paragraph shows meta data found in the

.Xr mdoc 7

prologue, on the

.Xr man 7

.Ic \&TH

line, or the fallbacks used.

.Pp

In the tree dump, each output line shows one syntax tree node.

Child nodes are indented with respect to their parent node.

The columns are:

.Pp

.Bl -enum -compact

.It

For macro nodes, the macro name; for text and

.Xr tbl 7

nodes, the content.

There is a special format for

.Xr eqn 7

nodes.

.It

Node type (text, elem, block, head, body, body-end, tail, tbl, eqn).

.It

Flags:

.Bl -dash -compact

.It

An opening parenthesis if the node is an opening delimiter.

.It

An asterisk if the node starts a new input line.

.It

The input line number (starting at one).

.It

A colon.

.It

The input column number (starting at one).

.It

A closing parenthesis if the node is a closing delimiter.

.It

A full stop if the node ends a sentence.

.It

BROKEN if the node is a block broken by another block.

.It

NOSRC if the node is not in the input file,

but automatically generated from macros.

.It

NOPRT if the node is not supposed to generate output

for any output format.

.El

.Pp

The following

.Fl O

argument is accepted:

.Bl -tag -width Ds

.It Cm noval

Skip validation and show the unvalidated syntax tree.

This can help to find out whether a given behaviour is caused by

the parser or by the validator.

Meta data is not available in this case.

.El

.Sh ENVIRONMENT

.Bl -tag -width MANPAGER

.It Ev MANPAGER

Line 506 Specifies the pagination program to use when

Line 608 Specifies the pagination program to use when

.Ev MANPAGER

is not defined.

If neither PAGER nor MANPAGER is defined,

.Pa /usr/bin/more Fl s

.Xr more 1

.Fl s

will be used.

.El

.Sh EXIT STATUS

Line 525 they were lower than the requested

Line 628 they were lower than the requested

.Ar level .

.It 2

At least one warning occurred, but no error, and

.Fl W Ns Cm warning

.Fl W Cm warning

was specified.

.It 3

At least one parsing error occurred,

but no unsupported feature was encountered, and

.Fl W Ns Cm error

.Fl W Cm error

.Fl W Ns Cm warning

.Fl W Cm warning

was specified.

.It 4

At least one unsupported feature was encountered, and

.Fl W Ns Cm unsupp ,

.Fl W Cm unsupp ,

.Fl W Ns Cm error

.Fl W Cm error

.Fl W Ns Cm warning

.Fl W Cm warning

was specified.

.It 5

Invalid command line arguments were specified.

Line 553 to exit at once, possibly in the middle of parsing or

Line 656 to exit at once, possibly in the middle of parsing or

.El

.Pp

Note that selecting

.Fl T Ns Cm lint

.Fl T Cm lint

output mode implies

.Fl W Ns Cm warning .

.Fl W Cm warning .

.Sh EXAMPLES

To page manuals to the terminal:

.Pp

.Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less

.Dl $ mandoc \-W all,stop mandoc.1 2\*(Gt&1 | less

.Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less

.Pp

To produce HTML manuals with

.Ar style.css

.Pa mandoc.css

as the style-sheet:

.Pp

.Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html

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

.Pp

To check over a large set of manuals:

.Pp

.Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]`

.Dl $ mandoc \-T lint \(gafind /usr/src -name \e*\e.[1-9]\(ga

.Pp

To produce a series of PostScript manuals for A4 paper:

.Pp

.Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps

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

.Pp

Convert a modern

.Xr mdoc 7

Line 584 format, for use on systems lacking an

Line 687 format, for use on systems lacking an

.Xr mdoc 7

parser:

.Pp

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

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

.Sh DIAGNOSTICS

Messages displayed by

.Nm

Line 651 levels except those about non-existent or unreadable i

Line 754 levels except those about non-existent or unreadable i

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

.Fl W

option or

.Fl T Ns Cm lint

.Fl T Cm lint

output mode.

.Ss Warnings related to the document prologue

.Bl -ohang

Line 771 This may confuse

Line 874 This may confuse

.Xr makewhatis 8

and

.Xr apropos 1 .

.It Sy "NAME section without name"

.It Sy "NAME section without Nm before Nd"

.Pq mdoc

The NAME section does not contain any

.Ic \&Nm

child macro.

child macro before the first

.Ic \&Nd

macro.

.It Sy "NAME section without description"

.Pq mdoc

The NAME section lacks the mandatory

Line 792 The NAME section contains plain text or macros other t

Line 897 The NAME section contains plain text or macros other t

.Ic \&Nm

and

.Ic \&Nd .

.It Sy "missing comma before name"

.Pq mdoc

The NAME section contains an

.Ic \&Nm

macro that is neither the first one nor preceded by a comma.

.It Sy "missing description line, using \(dq\(dq"

.Pq mdoc

The

Line 817 In the SEE ALSO section, an

Line 927 In the SEE ALSO section, an

macro with a lower section number follows one with a higher number,

or two

.Ic \&Xr

macros refering to the same section are out of alphabetical order.

macros referring to the same section are out of alphabetical order.

.It Sy "unusual Xr punctuation"

.Pq mdoc

In the SEE ALSO section, punctuation between two

Line 937 list block contains text or macros before the first

Line 1047 list block contains text or macros before the first

.Ic \&It

macro.

The offending children are moved before the beginning of the list.

.It Sy ".Vt block has child macro"

.Pq mdoc

The

.Ic \&Vt

macro supports plain text arguments only.

Formatting may be ugly and semantic searching

for the affected content might not work.

.It Sy "fill mode already enabled, skipping"

.Pq man

Line 1116 macro is immediately followed by an

Line 1219 macro is immediately followed by an

.Ic \&Re

macro on the next input line.

Such an empty block does not produce any output.

.It Sy "missing section argument"

.Pq mdoc

.Ic \&Xr

macro lacks its second, section number argument.

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

parentheses.

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

.Pq mdoc

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

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

Whitespace at the end of input lines is almost never semantically

significant \(em but in the odd case where it might be, it is

extremely confusing when reviewing and maintaining documents.

.It Sy "new sentence, new line"

.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 "bad comment style"

.Pq roff

Comment lines start with a dot, a backslash, and a double-quote character.

Line 1569 By requesting the inclusion of a sensitive file, a mal

Line 1683 By requesting the inclusion of a sensitive file, a mal

might otherwise trick a privileged user into inadvertently displaying

the file on the screen, revealing the file content to bystanders.

The argument is ignored including the file name following it.

.It Sy "skipping display without arguments"

.Pq mdoc

.Ic \&Bd

block macro does not have any arguments.

The block is discarded, and the block content is displayed in

whatever mode was active before the block.

.It Sy "missing list type, using -item"

.Pq mdoc

Line 1577 macro fails to specify the list type.

Line 1698 macro fails to specify the list type.

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

.Pq mdoc

The first call to

.Ic \&Nm

.Ic \&Nm ,

lacks the required argument.

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

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

.Pq mdoc

The

Line 1766 as if they were a text line.

Line 1887 as if they were a text line.

.Xr mdoc 7 ,

.Xr roff 7 ,

.Xr tbl 7

.Sh HISTORY

The

.Nm

utility first appeared in

.Ox 4.8 .

The option

.Fl I

appeared in

.Ox 5.2 ,

and

.Fl aCcfhKklMSsw

.Ox 5.7 .

.Sh AUTHORS

.An -nosplit

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv

and is maintained by

.An Ingo Schwarze Aq Mt schwarze@openbsd.org .

.Sh BUGS

.Fl T Ns Cm html ,

the maximum size of an element attribute is determined by

.Dv BUFSIZ ,

which is usually 1024 bytes.

Be aware of this when setting long link

formats such as

.Fl O Ns Cm style Ns = Ns Ar really/long/link .

CVSweb