mandoc/man.7 - diff

Return to man.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.7 between version 1.81 and 1.97

version 1.81, 2010/08/06 17:07:11

version 1.97, 2011/01/25 00:40:14

Line 53 Other lines are interpreted within the current state.

.Nm

documents may contain only graphable 7-bit ASCII characters, the

space character, and the tab character.

All manuals must have

.Ux

line termination.

.Pp

Blank lines are acceptable; where found, the output will assert a

vertical space.

.Pp

If the first character of a line is a space, that line is printed

with a leading newline.

.Ss Comments

Text following a

.Sq \e\*q ,

Line 219 Documents are generally structured as follows:

\&.TH FOO 1 2009-10-10

\&.SH NAME

\efBfoo\efR \e(en a description goes here

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

\&.\e\*q .SH LIBRARY

\&.\e\*q For sections 2 & 3 only.

\&.\e\*q Not used in OpenBSD.

\&.SH SYNOPSIS

\efBfoo\efR [\efB\e-options\efR] arguments...

\&.SH DESCRIPTION

The \efBfoo\efR utility processes files...

\&.\e\*q .SH IMPLEMENTATION NOTES

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

\&.\e\*q Not used in OpenBSD.

\&.\e\*q .SH RETURN VALUES

\&.\e\*q The next is for sections 1, 6, 7, & 8 only.

\&.\e\*q For sections 2, 3, & 9 only.

\&.\e\*q .SH ENVIRONMENT

\&.\e\*q For sections 1, 6, 7, & 8 only.

\&.\e\*q .SH FILES

\&.\e\*q The next is for sections 1 & 8 only.

\&.\e\*q .SH EXIT STATUS

\&.\e\*q For sections 1, 6, & 8 only.

\&.\e\*q .SH EXAMPLES

\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.

\&.\e\*q .SH DIAGNOSTICS

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

\&.\e\*q For sections 1, 4, 6, 7, & 8 only.

\&.\e\*q .SH ERRORS

\&.\e\*q For sections 2, 3, & 9 only.

\&.\e\*q .SH SEE ALSO

\&.\e\*q .BR foo ( 1 )

\&.\e\*q .SH STANDARDS

Line 246 The \efBfoo\efR utility processes files...

Line 248 The \efBfoo\efR utility processes files...

\&.\e\*q .SH CAVEATS

\&.\e\*q .SH BUGS

\&.\e\*q .SH SECURITY CONSIDERATIONS

\&.\e\*q Not used in OpenBSD.

.Ed

.Pp

The sections in a

Line 367 Thus, the following are equivalent:

Line 370 Thus, the following are equivalent:

\&.\ \ \ PP

.Ed

.Pp

To include space characters in macro arguments, arguments may be quoted;

see the

.Sq MACRO SYNTAX

section in the

.Xr roff 7

manual for details.

.Pp

The

.Nm

macros are classified by scope: line scope or block scope.

Line 411 The syntax is as follows:

Line 421 The syntax is as follows:

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

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

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

.\" .It Sx \&PD Ta n Ta current Ta compat

.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 \&

Line 421 The syntax is as follows:

Line 430 The syntax is as follows:

.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 \&i Ta n Ta current Ta compat

.It Sx \&ft Ta 1 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 \&r Ta 0 Ta current Ta compat

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

.\" .It Sx \&Sp Ta <1 Ta current Ta compat

.\" .It Sx \&Vb Ta <1 Ta current Ta compat

.\" .It Sx \&Ve Ta 0 Ta current Ta compat

.El

.Pp

Macros marked as

Line 509 The optional arguments specify which release it is fro

Line 514 The optional arguments specify which release it is fro

Text is rendered in bold face.

.Pp

See also

.Sx \&I ,

.Sx \&I

.Sx \&R ,

.Sx \&b ,

.Sx \&i ,

and

.Sx \&r .

.Sx \&R .

.Ss \&BI

Text is rendered alternately in bold face and italic.

Thus,

Line 532 Whitespace between arguments is omitted in output.

Line 534 Whitespace between arguments is omitted in output.

.Pp

Examples:

.Pp

.D1 \&.BI bold italic bold italic

.Dl \&.BI bold italic bold italic

.Pp

The output of this example will be emboldened

.Dq bold

Line 591 and

Line 593 and

Text is rendered in italics.

.Pp

See also

.Sx \&B ,

.Sx \&B

.Sx \&R ,

.Sx \&b ,

.Sx \&i ,

and

.Sx \&r .

.Sx \&R .

.Ss \&IB

Text is rendered alternately in italics and bold face.

Whitespace between arguments is omitted in output.

Line 692 and

Line 691 and

Text is rendered in roman (the default font).

.Pp

See also

.Sx \&I ,

.Sx \&I

.Sx \&B ,

.Sx \&b ,

.Sx \&i ,

and

.Sx \&r .

.Sx \&B .

.Ss \&RB

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

Whitespace between arguments is omitted in output.

Line 792 manual section.

Line 788 manual section.

.Pp

Examples:

.Pp

.D1 \&.TH CVS 5 "1992-02-12" GNU

.Dl \&.TH CVS 5 "1992-02-12" GNU

.Ss \&TP

Begin a paragraph where the head, if exceeding the indentation width, is

followed by a newline; if not, the body follows on the same line after a

Line 818 See also

Line 814 See also

.Sx \&P ,

and

.Sx \&PP .

.\" .

.\" .Ss \&PD

.\" Has no effect. Included for compatibility.

.\" .

.Ss \&UC

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

BSD releases.

Line 837 See also

Line 827 See also

.Ss \&fi

End literal mode begun by

.Sx \&nf .

.Ss \&i

.Ss \&ft

Italicise arguments.

Change the current font mode.

Synonym for

See

.Sx \&I .

.Sx Text Decoration

.Pp

for a listing of available font modes.

See also

.Sx \&B ,

.Sx \&I ,

.Sx \&R .

.Sx \&b ,

and

.Sx \&r .

.Ss \&in

Indent relative to the current indentation:

.Pp

Line 866 Begin literal mode: all subsequent free-form lines hav

Line 849 Begin literal mode: all subsequent free-form lines hav

line boundaries preserved.

May be ended by

.Sx \&fi .

.Ss \&r

Fonts and styles (bold face, italics) reset to roman (default font).

.Pp

See also

.Sx \&B ,

.Sx \&I ,

.Sx \&R ,

.Sx \&b ,

and

.Sx \&i .

.Ss \&sp

Insert vertical spaces into output with the following syntax:

.Bd -filled -offset indent

Line 894 Defaults to 1, if unspecified.

Line 867 Defaults to 1, if unspecified.

.Pp

See also

.Sx \&br .

.\" .Ss \&Sp

.\" A synonym for

.\" .Sx \&sp

.\" .Cm 0.5v .

.\" .

.\" .Ss \&Vb

.\" A synonym for

.\" .Sx \&nf .

.\" Accepts an argument (the height of the formatted space) which is

.\" disregarded.

.\" .

.\" .Ss \&Ve

.\" A synonym for

.\" .Sx \&fi .

.\" .

.Sh COMPATIBILITY

This section documents areas of questionable portability between

implementations of the

Line 917 language.

Line 875 language.

.Pp

.Bl -dash -compact

.It

The \es (font size), \em (font colour), and \eM (font filling colour)

font decoration escapes are all discarded in mandoc.

.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

The

.Sq \(aq

macro control character, in GNU troff (and prior troffs) suppresses a

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

.Sq \&.

control character.

.El

.Sh SEE ALSO

.Xr man 1 ,

.Xr mandoc 1 ,

.Xr mandoc_char 7

.Xr mandoc_char 7 ,

.Xr mdoc 7 ,

.Xr roff 7 ,

.Xr tbl 7

.Sh HISTORY

The

.Nm

CVSweb