mandoc/man.7 - diff

Return to man.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

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

version 1.127, 2014/06/22 16:39:45

version 1.131, 2015/01/24 02:41:49

Line 1

.\" $Id$

.\"

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

Line 369 Begin a paragraph whose initial output line is left-ju

subsequent output lines are indented, with the following syntax:

.Bd -filled -offset indent

.Pf \. Sx \&HP

.Op Cm width

.Op Ar width

.Ed

.Pp

The

.Cm width

.Ar width

argument is a

.Xr roff 7

scaling width.

Line 413 and

Begin an indented paragraph with the following syntax:

.Bd -filled -offset indent

.Pf \. Sx \&IP

.Op Cm head Op Cm width

.Op Ar head Op Ar width

.Ed

.Pp

The

.Cm width

.Ar width

argument is a

.Xr roff 7

scaling width defining the left margin.

Line 425 It's saved for later paragraph left-margins; if unspec

default width is used.

.Pp

The

.Cm head

.Ar head

argument is used as a leading term, flushed to the left margin.

This is useful for bulleted paragraphs and so on.

.Pp

Line 470 This is a non-standard GNU extension, included only fo

It has the following syntax:

.Bd -filled -offset indent

.Pf \. Sx \&OP

.Cm key Op Cm value

.Ar key Op Ar value

.Ed

.Pp

The

.Cm key

.Ar key

is usually a command-line flag and

.Cm value

.Ar value

its argument.

.Ss \&P

Synonym for

Line 495 Specify the vertical space to be inserted before each

The syntax is as follows:

.Bd -filled -offset indent

.Pf \. Sx \&PD

.Op Cm height

.Op Ar height

.Ed

.Pp

The

.Cm height

.Ar height

argument is a

.Xr roff 7

scaling width.

Line 555 and

.Ss \&RE

Explicitly close out the scope of a prior

.Sx \&RS .

The default left margin is restored to the state of the original

The default left margin is restored to the state before that

.Sx \&RS

invocation.

.Pp

The syntax is as follows:

.Bd -filled -offset indent

.Pf \. Sx \&RE

.Op Ar level

.Ed

.Pp

Without an argument, the most recent

.Sx \&RS

block is closed out.

.Ar level

is 1, all open

.Sx \&RS

blocks are closed out.

Otherwise,

.Ar level No \(mi 1

nested

.Sx \&RS

blocks remain open.

.Ss \&RI

Text is rendered alternately in roman (the default font) and italics.

Whitespace between arguments is omitted in output.

Line 578 Temporarily reset the default left margin.

Line 598 Temporarily reset the default left margin.

This has the following syntax:

.Bd -filled -offset indent

.Pf \. Sx \&RS

.Op Cm width

.Op Ar width

.Ed

.Pp

The

.Cm width

.Ar width

argument is a

.Xr roff 7

scaling width.

Line 607 The scope of a sub-section is closed by a subsequent s

Line 627 The scope of a sub-section is closed by a subsequent s

section, or end of file.

The paragraph left-margin width is reset to the default.

.Ss \&TH

Sets the title of the manual page with the following syntax:

Sets the title of the manual page for use in the page header

and footer with the following syntax:

.Bd -filled -offset indent

.Pf \. Sx \&TH

.Ar title section date

Line 629 is empty or not specified, the current date is used.

Line 650 is empty or not specified, the current date is used.

The optional

.Ar source

string specifies the organisation providing the utility.

When unspecified,

.Xr mandoc 1

uses its

.Fl Ios

argument.

The

.Ar volume

string replaces the default rendered volume, which is dictated by the

Line 645 Subsequent output lines are indented.

Line 671 Subsequent output lines are indented.

The syntax is as follows:

.Bd -filled -offset indent

.Pf \. Sx \&TP

.Op Cm width

.Op Ar width

.Ed

.Pp

The

.Cm width

.Ar width

argument is a

.Xr roff 7

scaling width.

Line 694 End literal mode begun by

Line 720 End literal mode begun by

.Ss \&in

Indent relative to the current indentation:

.Pp

.D1 Pf \. Sx \&in Op Cm width

.D1 Pf \. Sx \&in Op Ar width

.Pp

.Cm width

.Ar width

is signed, the new offset is relative.

Otherwise, it is absolute.

This value is reset upon the next paragraph, section, or sub-section.

.Ss \&na

Don't align to the right margin.

.Ss \&nf

Begin literal mode: all subsequent free-form lines have their end of

line boundaries preserved.

Line 716 or

Line 740 or

Insert vertical spaces into output with the following syntax:

.Bd -filled -offset indent

.Pf \. Sx \&sp

.Op Cm height

.Op Ar height

.Ed

.Pp

The

.Cm height

.Ar height

argument is a scaling width as described in

.Xr roff 7 .

If 0, this is equivalent to the

Line 754 is equivalent to

Line 778 is equivalent to

If next-line macros are invoked consecutively, only the last is used.

If a next-line macro is followed by a non-next-line macro, an error is

raised, except for

.Sx \&br ,

.Sx \&br

.Sx \&sp ,

and

.Sx \&na .

.Sx \&sp .

.Pp

The syntax is as follows:

.Bd -literal -offset indent

Line 788 The syntax is as follows:

Line 811 The syntax is as follows:

.It Sx \&br Ta 0 Ta current Ta compat

.It Sx \&fi Ta 0 Ta current Ta compat

.It Sx \&in Ta 1 Ta current Ta compat

.It Sx \&na Ta 0 Ta current Ta compat

.It Sx \&nf Ta 0 Ta current Ta compat

.It Sx \&sp Ta 1 Ta current Ta compat

.El

CVSweb