mandoc/mdoc.7 - diff

Return to mdoc.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.7 between version 1.107 and 1.110

version 1.107, 2010/05/15 07:01:51

version 1.110, 2010/05/26 10:39:35

Line 347 file:

\&.Sh NAME

\&.Nm foo

\&.Nd a description goes here

\&.\e\*q The next is for sections 2 & 3 only.

\&.\e\*q The next is for sections 2, 3, & 9 only.

\&.\e\*q .Sh LIBRARY

\&.

\&.Sh SYNOPSIS

Line 409 and

.Sx \&Nd .

.It Em LIBRARY

The name of the library containing the documented material, which is

assumed to be a function in a section 2 or 3 manual.

assumed to be a function in a section 2, 3, or 9 manual.

The syntax for this is as follows:

.Bd -literal -offset indent

\&.Lb libarm

Line 731 Note that the

macro is a

.Sx Block partial-implicit

only when invoked as the first macro

in a SYNOPSIS section line, else it is

in a

.Em SYNOPSIS

section line, else it is

.Sx In-line .

.Ss In-line

Closed by

Line 1644 and

Line 1646 and

.Ss \&In

.Ss \&It

.Ss \&Lb

Specify a library.

The calling syntax is as follows:

.Pp

.D1 \. Ns Sx \&Lb Cm library

.Pp

The

.Cm library

parameter may be a system library, such as

.Cm libz

.Cm libpam ,

in which case a small library description is printed next to the linker

invocation; or a custom library, in which case the library name is

printed in quotes.

This is most commonly used in the

.Em SYNOPSIS

section as described in

.Sx MANUAL STRUCTURE .

.Pp

Examples:

.D1 \&.Lb libz

.D1 \&.Lb mdoc

.Ss \&Li

.Ss \&Lk

Format a hyperlink.

Line 1796 line.

Line 1820 line.

.Ss \&Sy

.Ss \&Tn

.Ss \&Ud

Prints out

.Dq currently under development.

.Ss \&Ux

Format the UNIX name.

Accepts no argument.

CVSweb