mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.127 and 1.131

version 1.127, 2010/06/27 13:30:51

version 1.131, 2010/07/05 13:12:32

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 478 they are separated by a vertical space, unless in the

Line 479 they are separated by a vertical space, unless in the

and

.Sx \&Ft ,

which are always separated by vertical space.

.Pp

When text and macros following an

.Sx \&Nm

macro starting an input line span multiple output lines,

all output lines but the first will be indented to align

with the text immediately following the

.Sx \&Nm

macro, up to the next

.Sx \&Nm ,

.Sx \&Sx ,

.Sx \&Ss

macro or the end of an enclosing block, whichever comes first.

.It Em DESCRIPTION

This expands upon the brief, one-line description in

.Em NAME .

Line 672 has multiple heads.

Line 686 has multiple heads.

.It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope

.It Sx \&It Ta \&No Ta Yes Ta closed by Sx \&It , Sx \&El

.It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh

.It Sx \&Nm Ta \&No Ta Yes Ta closed by Sx \&Nm , Sx \&Sh , Sx \&Ss

.It Sx \&Sh Ta \&No Ta \&No Ta closed by Sx \&Sh

.It Sx \&Ss Ta \&No Ta \&No Ta closed by Sx \&Sh , Sx \&Ss

.El

.Pp

Note that the

.Sx \&Nm

macro is a

.Sx Block full-implicit

macro only when invoked as the first macro

in a

.Em SYNOPSIS

section line, else it is

.Sx In-line .

.Ss Block partial-explicit

Like block full-explicit, but also with single-line scope.

Each has at least a body and, in limited circumstances, a head

Line 1039 Closes a

Line 1064 Closes a

block. Does not have any tail arguments.

.Ss \&Bd

Begins a display block.

Its syntax is as follows:

.Bd -ragged -offset indent

.Pf \. Sx \&Bd

.Fl type

.Op Fl offset Ar width

.Op Fl compact

.Ed

.Pp

A display is collection of macros or text which may be collectively

offset or justified in a manner different from that

of the enclosing context.

Line 1063 Centre-justify each line.

Line 1096 Centre-justify each line.

The type must be provided first.

Secondary arguments are as follows:

.Bl -tag -width 12n -offset indent

.It Fl offset Ar width

.It Fl offset Ar val

Offset by the value of

.Ar width ,

.Ar val ,

which is interpreted as one of the following, specified in order:

.Bl -item

.It

Line 1076 the width of standard indentation;

Line 1109 the width of standard indentation;

twice

.Ar indent ;

.Ar left ,

which has no effect ;

which has no effect;

.Ar right ,

which justifies to the right margin; and

.Ar center ,

Line 1097 As the calculated string length of the opaque string.

Line 1130 As the calculated string length of the opaque string.

If not provided an argument, it will be ignored.

.It Fl compact

Do not assert a vertical space before the block.

.It Fl file Ar file

Prepend the file

.Ar file

before any text or macros within the block.

.El

.Pp

Examples:

Line 1115 See also

Line 1144 See also

and

.Sx \&Dl .

.Ss \&Bf

Change the font mode for a scoped block of text.

Its syntax is as follows:

.Bd -ragged -offset indent

.Pf \. Sx \&Bf

.Oo

.Fl emphasis | literal | symbolic |

.Cm \&Em | \&Li | \&Sy

.Oc

.Ed

.Pp

The

.Fl emphasis

and

.Cm \&Em

argument are equivalent, as are

.Fl symbolic

and

.Cm \&Sy,

and

.Fl literal

and

.Cm \&Li .

Without an argument, this macro does nothing.

The font mode continues until broken by a new font mode in a nested

scope or

.Sx \&Ef

is encountered.

.Pp