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

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

version 1.128, 2014/12/28 15:23:33

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

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

Line 879 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 895 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 916 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