mandoc/man.7 - diff

Return to man.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.7 between version 1.5 and 1.16

version 1.5, 2009/03/26 23:01:26

version 1.16, 2009/06/25 10:48:21

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

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

.\" above copyright notice and this permission notice appear in all

.\" copyright notice and this permission notice appear in all copies.

.\" copies.

.\"

.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL

.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES

.\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED

.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE

.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR

.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL

.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES

.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR

.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN

.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER

.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF

.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR

.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

.\" PERFORMANCE OF THIS SOFTWARE.

.\"

.Dd $Mdocdate$

.Dt man 7

.Dt MAN 7

.Os

.\" SECTION

.Sh NAME

Line 29 The

Line 27 The

.Nm man

language was historically used to format

.Ux

manuals. In this reference document, we describe the syntax and

manuals. This reference document describes the syntax and structure of

structure of the

this language.

.Nm

language.

.Pp

.Em \&Do not ever

.Em \&Do not

use

.Nm

to write your manuals. Use the

Line 56 Other lines are interpreted within the current state.

Line 52 Other lines are interpreted within the current state.

.\" SECTION

.Sh INPUT ENCODING

.Nm

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

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

space character

.Sq \ .

.Sq \ ,

and tabs

.Sq \et .

All manuals must have

.Ux

.Sq \en

Line 74 escape is common in historical

Line 72 escape is common in historical

documents; if encountered at the end of a word, it ensures that the

subsequent word isn't off-set by whitespace.

.\" SUB-SECTION

.Ss Comments

Anything following a

.Sq \e"

delimiter is considered a comment (unless the

.Sq \e

itself has been escaped) and is ignored to the end of line.

Furthermore, a macro line with only a control character

.Sq \. ,

optionally followed by whitespace, is ignored.

.\" SUB-SECTION

.Ss Special Characters

Special character sequences begin with the escape character

.Sq \e

Line 88 or a single one-character sequence.

Line 96 or a single one-character sequence.

Characters may alternatively be escaped by a slash-asterisk,

.Sq \e* ,

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

.Pp

The

.Xr mdoc 7

contains a table of all available escapes.

.\" 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 ,

.Sq \&. ,

Line 138 foo

Line 155 foo

.Ed

.Pp

is equivalent to

.Sq \&.RI foo .

If two consecutive lines exhibit the latter behaviour,

an error is raised. Thus, the following is not acceptable:

.Bd -literal -offset indent

Line 151 The

Line 168 The

.Sq \&.TP

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

the behaviour.

.\" PARAGRAPH

.\" SECTION

.Sh MACROS

This section contains a complete list of all

.Nm

Line 180 macros and corresponding number of arguments.

Line 197 macros and corresponding number of arguments.

.It \&.IR Ta n

.It \&.RI Ta n

.El

.Pp

Although not historically part of the

.Nm

system, the following macros are also supported:

.Pp

.Bl -column "MacroX" "Arguments" -compact -offset indent

.It Em Macro Ta Em Arguments

.It \&.br Ta 0

.It \&.i Ta n

.El

.Pp

These follow the same calling conventions as the above

.Nm

macros.

.\" SECTION

.Sh SEE ALSO

.Xr mandoc 1

.Xr mandoc 1 ,

.Xr mandoc_char 7

.\" SECTION

.Sh AUTHORS

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq kristaps@openbsd.org .

.An Kristaps Dzonsons Aq kristaps@kth.se .

.\" SECTION

.Sh CAVEATS

Do not use this language. Use

CVSweb