refdescriptor

refdescriptor — A description of the topic of a reference page.

Synopsis

refdescriptor ::= [-]

Description

Reference pages (refentrys) are usually identified by a short, succinct topic name, such as the name of a function or command. The refname (or one of the refnames, in the case of a reference page that has several) is generally used as the topic name. When none of the refnames is appropriate, refdescriptor is used to specify the topic name.

A refdescriptor is unnecessary when an appropriate refname can be selected automatically. At least one refname is required, so refdescriptor cannot be used in place of a name, only in addition to it.

Processing expectations

May be formatted inline or as a displayed block, depending on context.

Formatting reference pages may require a fairly sophisticated processing system. Much of the meta-information about a reference page (its name, type, purpose, title, and classification) is stored in wrappers near the beginning of the refentry.

Common presentational features, such as titles and running heads, may require data from several of these wrappers plus some generated text. Other formatting often requires that these elements be reordered.

If a refdescriptor is present, it should be used for the short topic name. This name usually appears in the running header along with the manvolnum in print media. It may also appear in tables of contents and the index.

Parents

These elements contain refdescriptor: refnamediv.

Examples

See reference for an example using this element.

Last revised by Norman Walsh on (git hash: 4a070f84c9fc7bc85cf9f71d71fa54f4db18f973 a835fdf61c7f87ce1038e2869080d80ea67d3696)