    |
DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha) |
| |
DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha) |
manvolnum — A reference volume number
manvolnum ::= ![[-]](graphics/down.gif)
![[+]](graphics/right.gif)
phrase (db._phrase)replaceable
altanchorannotationbibliorefindexterm (db.indexterm.endofrange)indexterm (db.indexterm.singular)indexterm (db.indexterm.startofrange)inlinemediaobjectlinkolinkremarksubscriptsuperscriptxrefIn 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.
The content of manvolnum is usually printed in parentheses after the element title or citation.
The following elements occur in manvolnum: text, alt, anchor, annotation, biblioref, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), remark, replaceable, subscript, superscript, xref.
<article xmlns='http://docbook.org/ns/docbook'> <title>Example manvolnum</title> <para>For a further description of print formats, consult the <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.
| |
|
|
| locator | |
markup |