1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>get.refentry.section</title><link rel="stylesheet" href="reference.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="../index.html" title="DocBook XSL Stylesheets: ReferenceDocumentation"><link rel="up" href="refentry.html" title="Common Refentry Metadata Template Reference"><link rel="prev" href="template.get.refentry.title.html" title="get.refentry.title"><link rel="next" href="template.get.refentry.date.html" title="get.refentry.date"><link rel="copyright" href="copyright.html" title="License"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">get.refentry.section</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="template.get.refentry.title.html">Prev</a></td><th width="60%" align="center">Common Refentry Metadata Template Reference</th><td width="20%" align="right"><a accesskey="n" href="template.get.refentry.date.html">Next</a></td></tr></table><hr></div><div class="refentry" title="get.refentry.section"><a name="template.get.refentry.section"></a><div class="titlepage"></div>
<div class="refnamediv"><h2>get.refentry.section</h2><p>
get.refentry.section
— Gets section metadata for a refentry
</p></div>
<div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2>
<pre class="synopsis"><xsl:template name="get.refentry.section">
<xsl:param name="refname"/>
<xsl:param name="quiet" select="0"/>
...
</xsl:template></pre>
</div>
<div class="refsect1" title="Description"><a name="id1458846"></a><h2>Description</h2>
<p>The <code class="literal">man(7)</code> man page describes this as "the
section number the man page should be placed in (e.g.,
<code class="literal">7</code>)". If we do not find a <a href="http://docbook.org/tdg5/en/html/manvolnum.html"><code class="sgmltag-element">manvolnum</code></a>
specified in the source, and we find that the <a href="http://docbook.org/tdg5/en/html/refentry.html"><code class="sgmltag-element">refentry</code></a> is
for a function, we use the section number <code class="literal">3</code>
["Library calls (functions within program libraries)"]; otherwise, we
default to using <code class="literal">1</code> ["Executable programs or shell
commands"].</p>
</div><div class="refsect1" title="Parameters"><a name="id1458883"></a><h2>Parameters</h2>
<div class="variablelist"><dl><dt><span class="term">refname</span></dt><dd>
<p>The first <a href="http://docbook.org/tdg5/en/html/refname.html"><code class="sgmltag-element">refname</code></a> in the refentry</p>
</dd><dt><span class="term">quiet</span></dt><dd>
<p>If non-zero, no "missing" message is emitted</p>
</dd></dl></div>
</div><div class="refsect1" title="Returns"><a name="id1458928"></a><h2>Returns</h2>
<p>Returns a string representing a section number.</p>
</div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="template.get.refentry.title.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="refentry.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="template.get.refentry.date.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">get.refentry.title</td><td width="20%" align="center"><a accesskey="h" href="../index.html">Home</a></td><td width="40%" align="right" valign="top">get.refentry.date</td></tr></table></div></body></html>
|