blob: c9a101228d4d4d82db09682ab0af9b33416d6d42 [file] [log] [blame]
<refentry xmlns=""
version="5.0" xml:id="">
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
<refpurpose>Specifies profile for refentry "source name" data</refpurpose>
<src:fragment xml:id="">
<xsl:param name="">
<para>The value of <parameter></parameter>
is a string representing an XPath expression. It is evaluated at
run-time and used only if
<parameter></parameter> is
non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic
"hard coded" into the stylesheets is used.</para>
<para>A "source name" is one part of a (potentially) two-part
<replaceable>Name</replaceable> <replaceable>Version</replaceable>
"source" field. In man pages, it is usually displayed in the left
footer of the page. It typically indicates the software system or
product that the item documented in the man page belongs to. The
<literal>man(7)</literal> man page describes it as "the source of
the command", and provides the following examples:
<para>For binaries, use something like: GNU, NET-2, SLS
Distribution, MCC Distribution.</para>
<para>For system calls, use the version of the kernel that you
are currently looking at: Linux 0.99.11.</para>
<para>For library calls, use the source of the function: GNU, BSD
4.3, Linux DLL 4.4.1.</para>
<para>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,
<replaceable>Name</replaceable> <replaceable>Version</replaceable>,
<para>product name (e.g., BSD) or org. name (e.g., GNU)</para>
<para>version number</para>
Each part is optional. If the <replaceable>Name</replaceable> is a
product name, then the <replaceable>Version</replaceable> is probably
the version of the product. Or there may be no
<replaceable>Name</replaceable>, in which case, if there is a
<replaceable>Version</replaceable>, it is probably the version
of the item itself, not the product it is part of. Or, if the
<replaceable>Name</replaceable> is an organization name, then there
probably will be no <replaceable>Version</replaceable>.</para>