mandoc/man.7 - diff

Return to man.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.7 between version 1.15 and 1.19

version 1.15, 2009/06/22 13:09:17

version 1.19, 2009/07/14 15:56:44

Line 27 The

.Nm man

language was historically used to format

.Ux

manuals. This reference document describes the syntax and structure of

manuals. This reference document describes its syntax, structure, and

this language.

usage.

.Pp

.Em \&Do not

.Bf Em

use

Do not use

.Nm

to write your manuals. Use the

to write your manuals.

.Ef

Use the

.Xr mdoc 7

language, instead.

.\" PARAGRAPH

Line 53 Other lines are interpreted within the current state.

Line 55 Other lines are interpreted within the current state.

.Sh INPUT ENCODING

.Nm

documents may contain only graphable 7-bit ASCII characters, the

space character

space character, and the tabs character. All manuals must have

.Sq \ ,

and tabs

.Sq \et .

All manuals must have

.Ux

.Sq \en

line termination.

.Pp

Blank lines are acceptable; where found, the output will assert a

Line 95 or a single one-character sequence.

Line 92 or a single one-character sequence.

.Pp

Characters may alternatively be escaped by a slash-asterisk,

.Sq \e* ,

with the same combinations as described above. This form is deprecated.

with the same combinations as described above.

.Pp

Terms may also be text-decorated using the

.Sq \ef

escape followed by a text-decoration letter: B (bold), I, (italic), or P

and R (Roman, or reset).

.\" SUB-SECTION

.Ss Whitespace

Unless specifically escaped, consecutive blocks of whitespace are pruned

from input. These are later re-added, if applicable, by a front-end

utility such as

.Xr mandoc 1 .

.\" SECTION

.Sh STRUCTURE

Each

.Nm

document must contain contains at least the

.Sq \&.TH

macro describing the document's section and title. It may occur

anywhere in the document, although conventionally, it appears as the

first macro.

.Pp

Beyond the

.Sq \&.TH ,

at least one macro or text node must appear in the document.

.\" SECTION

.Sh SYNTAX

Macros are one to three three characters in length and begin with a

control character ,

Line 156 The

Line 177 The

macro is similar, but does not need an empty argument line to trigger

the behaviour.

.\" SECTION

.Sh STRUCTURE

Each

.Nm

document must contain contains at least the

.Sq \&.TH

macro describing the document's section and title. It may occur

anywhere in the document, although conventionally, it appears as the

first macro.

.Pp

Beyond the

.Sq \&.TH ,

at least one macro or text node must appear in the document.

.\" SECTION

.Sh MACROS

This section contains a complete list of all

.Nm

Line 211 system, the following macros are also supported:

Line 219 system, the following macros are also supported:

These follow the same calling conventions as the above

.Nm

macros.

.\" SECTION

.Sh COMPATIBILITY

See

.Xr mdoc 7

for groff compatibility notes.

.\" SECTION

.Sh SEE ALSO

.Xr mandoc 1 ,

CVSweb