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
98
99
100
101
102
103
104
105
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>get.refentry.source</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.date.html" title="get.refentry.date"><link rel="next" href="template.get.refentry.source.name.html" title="get.refentry.source.name"><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.source</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="template.get.refentry.date.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.source.name.html">Next</a></td></tr></table><hr></div><div class="refentry" title="get.refentry.source"><a name="template.get.refentry.source"></a><div class="titlepage"></div>
<div class="refnamediv"><h2>get.refentry.source</h2><p>
get.refentry.source
— Gets source metadata for a refentry
</p></div>
<div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2>
<pre class="synopsis"><xsl:template name="get.refentry.source">
<xsl:param name="refname"/>
<xsl:param name="info"/>
<xsl:param name="prefs"/>
...
</xsl:template></pre>
</div>
<div class="refsect1" title="Description"><a name="id1459080"></a><h2>Description</h2>
<p>The <code class="literal">man(7)</code> man page describes this as "the
source of the command", and provides the following examples:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<p>For binaries, use something like: GNU, NET-2, SLS
Distribution, MCC Distribution.</p>
</li><li class="listitem">
<p>For system calls, use the version of the kernel that you are
currently looking at: Linux 0.99.11.</p>
</li><li class="listitem">
<p>For library calls, use the source of the function: GNU, BSD
4.3, Linux DLL 4.4.1.</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
"source", except that <code class="literal">solbook(5)</code> names it
"software" and describes it like this:
</p><div class="blockquote"><blockquote class="blockquote">
<p>This is the name of the software product that the topic
discussed on the reference page belongs to. For example UNIX
commands are part of the <code class="literal">SunOS x.x</code>
release.</p>
</blockquote></div><p>
</p>
<p>In practice, there are many pages that simply have a version
number in the "source" field. So, it looks like what we have is a
two-part field,
<em class="replaceable"><code>Name</code></em><em class="replaceable"><code>Version</code></em>,
where:
</p><div class="variablelist"><dl><dt><span class="term">Name</span></dt><dd>
<p>product name (e.g., BSD) or org. name (e.g., GNU)</p>
</dd><dt><span class="term">Version</span></dt><dd>
<p>version name</p>
</dd></dl></div><p>
Each part is optional. If the <em class="replaceable"><code>Name</code></em> is a
product name, then the <em class="replaceable"><code>Version</code></em> is probably
the version of the product. Or there may be no
<em class="replaceable"><code>Name</code></em>, in which case, if there is a
<em class="replaceable"><code>Version</code></em>, it is probably the version of the
item itself, not the product it is part of. Or, if the
<em class="replaceable"><code>Name</code></em> is an organization name, then there
probably will be no <em class="replaceable"><code>Version</code></em>.
</p>
</div><div class="refsect1" title="Parameters"><a name="id1459231"></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="id1459296"></a><h2>Returns</h2>
<p>Returns a <code class="sgmltag-element">source</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.date.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.source.name.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">get.refentry.date</td><td width="20%" align="center"><a accesskey="h" href="../index.html">Home</a></td><td width="40%" align="right" valign="top">get.refentry.source.name</td></tr></table></div></body></html>
|
