mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.163 and 1.173

version 1.163, 2015/10/30 19:04:16

version 1.173, 2017/01/31 19:44:04

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 75 This overrides any earlier

and

.Fl l

options.

.It Fl h

Display only the SYNOPSIS lines.

Implies

.Fl c .

.It Fl I Cm os Ns = Ns Ar name

Override the default operating system

.Ar name

Line 85 and for the

Line 89 and for the

.Xr man 7

.Sq \&TH

macro.

.It Fl h

Display only the SYNOPSIS lines.

Implies

.Fl c .

.It Fl K Ar encoding

Specify the input encoding.

The supported

Line 349 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 Cm style ,

Line 498 Use

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.

Each output line shows one syntax tree node.

.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

Line 529 The input column number (starting at one).

Line 537 The input column number (starting at one).

A closing parenthesis if the node is a closing delimiter.

.It

A full stop if the node ends a sentence.

.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

.Sh ENVIRONMENT

Line 601 To page manuals to the terminal:

Line 615 To page manuals to the terminal:

.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 \-T html -O style=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

Line 809 This may confuse

Line 823 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 830 The NAME section contains plain text or macros other t

Line 846 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 1147 macro is immediately followed by an

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

Line 1357 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 1615 macro fails to specify the list type.

Line 1647 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 1804 as if they were a text line.

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

Line 1812 utility was written by

Line 1857 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 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 Cm style Ns = Ns Ar really/long/link .

CVSweb