mandoc/man.7 - diff

Return to man.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.7 between version 1.119 and 1.130

version 1.119, 2013/07/13 19:41:16

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

Line 1

.\" $Id$

.\"

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

.\" purpose with or without fee is hereby granted, provided that the above

Line 97 file for a utility

Line 98 file for a utility

.Bd -literal -offset indent

\&.TH PROGNAME 1 2009-10-10

\&.SH NAME

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

\efBprogname\efR \e(en one line about what it does

\&.\e\(dq .SH LIBRARY

\&.\e\(dq For sections 2 & 3 only.

\&.\e\(dq For sections 2, 3, and 9 only.

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

\&.SH SYNOPSIS

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

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

\&.SH DESCRIPTION

The \efBfoo\efR utility processes files...

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

\&.\e\(dq For sections 2, 3, & 9 only.

\&.\e\(dq For sections 2, 3, and 9 function return values only.

\&.\e\(dq .SH ENVIRONMENT

\&.\e\(dq For sections 1, 6, 7, & 8 only.

\&.\e\(dq For sections 1, 6, 7, and 8 only.

\&.\e\(dq .SH FILES

\&.\e\(dq .SH EXIT STATUS

\&.\e\(dq For sections 1, 6, & 8 only.

\&.\e\(dq For sections 1, 6, and 8 only.

\&.\e\(dq .SH EXAMPLES

\&.\e\(dq .SH DIAGNOSTICS

\&.\e\(dq For sections 1, 4, 6, 7, & 8 only.

\&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.

\&.\e\(dq .SH ERRORS

\&.\e\(dq For sections 2, 3, & 9 only.

\&.\e\(dq For sections 2, 3, 4, and 9 errno settings only.

\&.\e\(dq .SH SEE ALSO

\&.\e\(dq .BR foo ( 1 )

\&.\e\(dq .BR foobar ( 1 )

\&.\e\(dq .SH STANDARDS

\&.\e\(dq .SH HISTORY

\&.\e\(dq .SH AUTHORS

Line 170 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 196 well-tested invocations.

Line 202 well-tested invocations.

Make sure that examples work properly!

.It Em DIAGNOSTICS

Documents error conditions.

This is most useful in section 4 manuals.

In section 4 and 9 manuals, these are usually messages

printed by the kernel to the console and to the kernel log.

In section 1, 6, 7, and 8, these are usually messages

printed by userland programs to the standard error output.

.Pp

Historically, this section was used in place of

.Em EXIT STATUS

for manuals in sections 1, 6, and 8; however, this practise is

discouraged.

.It Em ERRORS

Documents error handling in sections 2, 3, and 9.

Documents

.Xr errno 2

settings in sections 2, 3, 4, and 9.

.It Em SEE ALSO

References other manuals with related topics.

This section should exist for most manuals.

Line 280 For the scoping of individual macros, see

Line 292 For the scoping of individual macros, see

.Sx MACRO SYNTAX .

.Ss \&AT

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

.Tn AT&T UNIX

.At

releases.

The optional arguments specify which release it is from.

.Ss \&B

Line 357 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 401 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 413 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 458 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 483 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 543 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 566 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 595 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 617 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 633 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 653 and

Line 691 and

.Sx \&PP .

.Ss \&UC

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

BSD releases.

.Bx

releases.

The optional first argument specifies which release it is from.

.Ss \&UE

End a uniform resource identifier block.

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

See

.Sx \&UE .

.Ss \&UR

Begin a uniform resource identifier block.

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

It has the following syntax:

.Bd -literal -offset indent

.Pf \. Sx \&UR Ar uri

link description to be shown

.Pf \. Sx UE

.Ed

.Ss \&br

Breaks the current line.

Consecutive invocations have no further effect.

Line 664 See also

Line 717 See also

.Ss \&fi

End literal mode begun by

.Sx \&nf .

.Ss \&ft

Change the current font mode.

See

.Sx Text Decoration

for a listing of available font modes.

.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 694 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 749 The syntax is as follows:

Line 797 The syntax is as follows:

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

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

.It Sx \&DT Ta 0 Ta current Ta \&

.It Sx \&EE Ta 0 Ta current Ta compat

.It Sx \&EX Ta 0 Ta current Ta compat

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

Line 762 The syntax is as follows:

Line 813 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 \&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

Line 822 implicitly closed, is syntactically incorrect.

Line 872 implicitly closed, is syntactically incorrect.

.It Sx \&SH Ta >0 Ta next-line Ta section Ta \&

.It Sx \&SS Ta >0 Ta next-line Ta sub-section Ta \&

.It Sx \&TP Ta n Ta next-line Ta paragraph Ta \&

.It Sx \&UE Ta 0 Ta current Ta none Ta compat

.It Sx \&UR Ta 1 Ta current Ta part Ta compat

.El

.Pp

Macros marked

Line 847 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 862 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 918 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