mandoc/man.7 - diff

Return to man.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.7 between version 1.125 and 1.138

version 1.125, 2014/03/17 06:57:48

version 1.138, 2018/08/16 23:43:37

Line 1

.\" $Id$

.\"

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

Line 106 file for a utility

\efBprogname\efR [\efB\e-options\efR] \efIfile ...\efR

\&.SH DESCRIPTION

The \efBfoo\efR utility processes files ...

\&.\e\(dq .Sh CONTEXT

\&.\e\(dq For section 9 functions only.

\&.\e\(dq .SH IMPLEMENTATION NOTES

\&.\e\(dq Not used in OpenBSD.

\&.\e\(dq .SH RETURN VALUES

Line 171 This expands upon the brief, one-line description in

Line 173 This expands upon the brief, one-line description in

.Em NAME .

It usually contains a break-down of the options (if documenting a

command).

.It Em CONTEXT

This section lists the contexts in which functions can be called in section 9.

The contexts are autoconf, process, or interrupt.

.It Em IMPLEMENTATION NOTES

Implementation-specific notes should be kept here.

This is useful when implementing standard functions that may have side

Line 261 in the alphabetical reference below.

Line 266 in the alphabetical reference below.

.It Sx TP Ta tagged paragraph: Op Ar width

.It Sx HP Ta hanged paragraph: Op Ar width

.It Sx PD Ta set vertical paragraph distance: Op Ar height

.It Sx \&br Ta force output line break in text mode (no arguments)

.It Sx \&sp Ta force vertical space: Op Ar height

.It Sx fi , nf Ta fill mode and no-fill mode (no arguments)

.It Sx in Ta additional indent: Op Ar width

.El

Line 270 in the alphabetical reference below.

Line 273 in the alphabetical reference below.

.Bl -column "PP, LP, P" description

.It Sx B Ta boldface font

.It Sx I Ta italic font

.It Sx R Ta roman (default) font

.It Sx SB Ta small boldface font

.It Sx SM Ta small roman font

.It Sx BI Ta alternate between boldface and italic fonts

Line 294 The optional arguments specify which release it is fro

Line 296 The optional arguments specify which release it is fro

Text is rendered in bold face.

.Pp

See also

.Sx \&I

.Sx \&I .

and

.Sx \&R .

.Ss \&BI

Text is rendered alternately in bold face and italic.

Thus,

Line 345 See also

and

.Sx \&IR .

.Ss \&DT

Has no effect.

Restore the default tabulator positions.

Included for compatibility.

They are at intervals of 0.5 inches.

This has no effect unless the tabulator positions were changed with the

.Xr roff 7

.Ic \&ta

request.

.Ss \&EE

This is a non-standard GNU extension, included only for compatibility.

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

Line 368 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 386 and

Line 390 and

Text is rendered in italics.

.Pp

See also

.Sx \&B

.Sx \&B .

and

.Sx \&R .

.Ss \&IB

Text is rendered alternately in italics and bold face.

Whitespace between arguments is omitted in output.

Line 408 and

Line 410 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 420 It's saved for later paragraph left-margins; if unspec

Line 422 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 459 See also

Line 461 See also

.Sx \&PP ,

and

.Sx \&TP .

.Ss \&ME

End a mailto block.

This is a non-standard GNU extension, included only for compatibility.

See

.Sx \&MT .

.Ss \&MT

Begin a mailto block.

This is a non-standard GNU extension, included only for compatibility.

It has the following syntax:

.Bd -literal -offset indent

.Pf \. Sx \&MT Ar address

link description to be shown

.Pf \. Sx ME

.Ed

.Ss \&OP

Optional command-line argument.

This is a non-standard GNU extension, included only for compatibility.

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 490 Specify the vertical space to be inserted before each

Line 506 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 525 See also

Line 541 See also

.Sx \&P ,

and

.Sx \&TP .

.Ss \&R

Text is rendered in roman (the default font).

.Pp

See also

.Sx \&I

and

.Sx \&B .

.Ss \&RB

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

Whitespace between arguments is omitted in output.

Line 550 and

Line 559 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 573 Temporarily reset the default left margin.

Line 602 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 602 The scope of a sub-section is closed by a subsequent s

Line 631 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 624 is empty or not specified, the current date is used.

Line 654 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 640 Subsequent output lines are indented.

Line 675 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 658 See also

Line 693 See also

.Sx \&P ,

and

.Sx \&PP .

.Ss \&TQ

.Sx \&TP ,

except that no vertical spacing is inserted before the paragraph.

This is a non-standard GNU extension and rarely used even by GNU

manual pages.

.Ss \&UC

Sets the volume for the footer for compatibility with man pages from

.Bx

Line 677 It has the following syntax:

Line 718 It has the following syntax:

link description to be shown

.Pf \. Sx UE

.Ed

.Ss \&br

Breaks the current line.

Consecutive invocations have no further effect.

.Pp

See also

.Sx \&sp .

.Ss \&fi

End literal mode begun by

.Sx \&nf .

.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 707 Literal mode is implicitly ended by

Line 740 Literal mode is implicitly ended by

.Sx \&SH

.Sx \&SS .

.Ss \&sp

Insert vertical spaces into output with the following syntax:

.Bd -filled -offset indent

.Pf \. Sx \&sp

.Op Cm height

.Ed

.Pp

The

.Cm height

argument is a scaling width as described in

.Xr roff 7 .

If 0, this is equivalent to the

.Sx \&br

macro.

Defaults to 1, if unspecified.

.Pp

See also

.Sx \&br .

.Sh MACRO SYNTAX

The

.Nm

Line 748 is equivalent to

Line 763 is equivalent to

.Sq \&.I foo .

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

raised.

.Sx \&br ,

.Sx \&sp ,

and

.Sx \&na .

.Pp

The syntax is as follows:

.Bd -literal -offset indent

Line 773 The syntax is as follows:

Line 784 The syntax is as follows:

.It Sx \&IR Ta n Ta current Ta \&

.It Sx \&OP Ta 0, 1 Ta current Ta compat

.It Sx \&PD Ta 1 Ta current Ta \&

.It Sx \&R Ta n Ta next-line Ta \&

.It Sx \&RB Ta n Ta current Ta \&

.It Sx \&RI Ta n Ta current Ta \&

.It Sx \&SB Ta n Ta next-line Ta \&

.It Sx \&SM Ta n Ta next-line Ta \&

.It Sx \&TH Ta >1, <6 Ta current Ta \&

.It Sx \&UC Ta <=1 Ta current Ta \&

.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

.Pp

Macros marked as

Line 867 until the end of the macro scope.

Line 874 until the end of the macro scope.

Note that macros like

.Sx \&BR

open and close a font scope for each argument.

.Sh COMPATIBILITY

This section documents areas of questionable portability between

implementations of the

.Nm

language.

.Pp

.Bl -dash -compact

.It

Do not depend on

.Sx \&SH

.Sx \&SS

to close out a literal context opened with

.Sx \&nf .

This behaviour may not be portable.

.It

In quoted literals, GNU troff allowed pair-wise double-quotes to produce

a standalone double-quote in formatted output.

It is not known whether this behaviour is exhibited by other formatters.

.It

troff suppresses a newline before

.Sq \(aq

macro output; in mandoc, it is an alias for the standard

.Sq \&.

control character.

.It

The

.Sq \eh

.Pq horizontal position ,

.Sq \ev

.Pq vertical position ,

.Sq \em

.Pq text colour ,

.Sq \eM

.Pq text filling colour ,

.Sq \ez

.Pq zero-length character ,

.Sq \ew

.Pq string length ,

.Sq \ek

.Pq horizontal position marker ,

.Sq \eo

.Pq text overstrike ,

and

.Sq \es

.Pq text size

escape sequences are all discarded in mandoc.

.It

The

.Sq \ef

scaling unit is accepted by mandoc, but rendered as the default unit.

.It

The

.Sx \&sp

macro does not accept negative values in mandoc.

In GNU troff, this would result in strange behaviour.

.It

In page header lines, GNU troff versions up to and including 1.21

only print

.Ar volume

names explicitly specified in the

.Sx \&TH

macro; mandoc and newer groff print the default volume name

corresponding to the

.Ar section

number when no

.Ar volume

is given, like in

.Xr mdoc 7 .

.El

.Pp

The

.Sx OP

macro is part of the extended

.Nm

macro set, and may not be portable to non-GNU troff implementations.

.Sh SEE ALSO

.Xr man 1 ,

.Xr mandoc 1 ,

CVSweb