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 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>get.refentry.manual</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.version.html" title="get.refentry.version"><link rel="next" href="template.get.refentry.metadata.prefs.html" title="get.refentry.metadata.prefs"><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.manual</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="template.get.refentry.version.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.metadata.prefs.html">Next</a></td></tr></table><hr></div><div class="refentry" title="get.refentry.manual"><a name="template.get.refentry.manual"></a><div class="titlepage"></div>
<div class="refnamediv"><h2>get.refentry.manual</h2><p>
get.refentry.manual
— Gets source metadata for a refentry
</p></div>
<div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2>
<pre class="synopsis"><xsl:template name="get.refentry.manual">
<xsl:param name="refname"/>
<xsl:param name="info"/>
<xsl:param name="prefs"/>
...
</xsl:template></pre>
</div>
<div class="refsect1" title="Description"><a name="id1459582"></a><h2>Description</h2>
<p>The <code class="literal">man(7)</code> man page describes this as "the
title of the manual (e.g., <em class="citetitle">Linux Programmer's
Manual</em>)". Here are some examples from existing man pages:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<p><em class="citetitle">dpkg utilities</em>
(<span class="command"><strong>dpkg-name</strong></span>)</p>
</li><li class="listitem">
<p><em class="citetitle">User Contributed Perl Documentation</em>
(<span class="command"><strong>GET</strong></span>)</p>
</li><li class="listitem">
<p><em class="citetitle">GNU Development Tools</em>
(<span class="command"><strong>ld</strong></span>)</p>
</li><li class="listitem">
<p><em class="citetitle">Emperor Norton Utilities</em>
(<span class="command"><strong>ddate</strong></span>)</p>
</li><li class="listitem">
<p><em class="citetitle">Debian GNU/Linux manual</em>
(<span class="command"><strong>faked</strong></span>)</p>
</li><li class="listitem">
<p><em class="citetitle">GIMP Manual Pages</em>
(<span class="command"><strong>gimp</strong></span>)</p>
</li><li class="listitem">
<p><em class="citetitle">KDOC Documentation System</em>
(<span class="command"><strong>qt2kdoc</strong></span>)</p>
</li></ul></div><p>
</p>
<p>The <code class="literal">solbook(5)</code> man page describes
something very much like what <code class="literal">man(7)</code> calls
"manual", except that <code class="literal">solbook(5)</code> names it
"sectdesc" and describes it like this:
</p><div class="blockquote"><blockquote class="blockquote">
<p>This is the section title of the reference page; for
example <code class="literal">User Commands</code>.</p>
</blockquote></div><p>
</p>
</div><div class="refsect1" title="Parameters"><a name="id1459732"></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">info</span></dt><dd>
<p>A set of info nodes (from a <a href="http://docbook.org/tdg5/en/html/refentry.html"><code class="sgmltag-element">refentry</code></a>
element and its ancestors)</p>
</dd><dt><span class="term">prefs</span></dt><dd>
<p>A node containing users preferences (from global
stylesheet parameters)</p>
</dd></dl></div>
</div><div class="refsect1" title="Returns"><a name="id1459796"></a><h2>Returns</h2>
<p>Returns a <code class="sgmltag-element">manual</code> node.</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.version.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.metadata.prefs.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">get.refentry.version</td><td width="20%" align="center"><a accesskey="h" href="../index.html">Home</a></td><td width="40%" align="right" valign="top">get.refentry.metadata.prefs</td></tr></table></div></body></html>
|