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.130

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

version 1.130, 2015/01/24 02:14:46

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 364 Begin a paragraph whose initial output line is left-ju

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 408 and

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

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 465 This is a non-standard GNU extension, included only fo

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

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 550 and

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 573 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 602 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 624 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 640 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 689 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.

Line 711 or

Line 742 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 868 Note that macros like

Line 899 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

This section mentions some areas of questionable portability between

implementations of the

.Nm

language.

More incompatibilities exist.

.Pp

.Bl -dash -compact

.It

Line 883 to close out a literal context opened with

Line 915 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

Line 939 is given, like in

Line 936 is given, like in

.El

.Pp

The

.Sx OP

.Sx EE ,

macro is part of the extended

.Sx EX ,

.Sx OP ,

.Sx UE ,

and

.Sx UR

macros are part of the GNU extended

.Nm

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

.Sh SEE ALSO

CVSweb