manvolnum

manvolnum — A reference volume number.

Synopsis

manvolnum ::=

Zero or more of:
- text
- replaceable
- Graphic inlines
  - inlinemediaobject
- Indexing inlines
  - indexterm (db.indexterm.endofrange)
  - indexterm (db.indexterm.singular)
  - indexterm (db.indexterm.startofrange)
- Linking inlines
- Ubiquitous inlines
  - abbrev
  - acronym
  - alt
  - anchor
  - annotation
  - biblioref
  - coref
  - date
  - emphasis (db._emphasis)
  - firstterm (db._firstterm)
  - footnote
  - footnoteref
  - foreignphrase (db._foreignphrase)
  - glossterm (db._glossterm)
  - indexterm (db.indexterm.endofrange)
  - indexterm (db.indexterm.singular)
  - indexterm (db.indexterm.startofrange)
  - inlinemediaobject
  - link
  - olink
  - phrase (db._phrase)
  - quote (db._quote)
  - remark
  - subscript
  - superscript
  - trademark
  - wordasword
  - xref

Attributes

Common attributes and common linking attributes.

No additional attributes.

Description

In a DocBook reference page, the manvolnum holds the number of the volume in which the refentry belongs.

The notion of a volume number is historical. UNIX manual pages (man pages), for which refentry was devised, were typically stored in three-ring binders. Each bound manual was a volume in a set and contained information about a particular class of things. For example, volume 1 was for user commands, and volume 8 was for administrator commands.

Volume numbers need not be strictly numerical; volume l frequently held manual pages for local additions to the system, and the X Window System manual pages had an x in the volume number: for example, 1x.

Processing expectations

The content of manvolnum is usually printed in parentheses after the element title or citation.

Attributes

Common attributes and common linking attributes.

any attribute: Any attribute in any other explicit namespace

Parents

These elements contain manvolnum: citerefentry, refmeta.

Children

The following elements occur in manvolnum: text, abbrev, acronym, alt, anchor, annotation, biblioref, coref, date, emphasis (db._emphasis), firstterm (db._firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), glossterm (db._glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), quote (db._quote), remark, replaceable, subscript, superscript, trademark, wordasword, xref.

Examples

1 |<article xmlns='http://docbook.org/ns/docbook'>
  |<title>Example manvolnum</title>
  | 
  |<para>For a further description of print formats, consult the
5 |<citerefentry><refentrytitle>printf</refentrytitle>
  |<manvolnum>3S</manvolnum></citerefentry> manual page.
  |</para>
  | 
  |</article>

For a further description of print formats, consult the printf(3S) manual page.