Capitalized the start of a sentence in the bucket section of cataloging.

[Evergreen-DocBook.git] / stylesheets / evergreen_docbook_files / docbook-xsl-1.75.2 / manpages / param.xml

<?xml version="1.0" encoding="ASCII"?>\r
<book version="5.0">\r
  <info>\r
    <title>Manpages Parameter Reference</title>\r
    <releaseinfo role="meta">\r
      $Id: param.xweb 8235 2009-02-09 16:22:14Z xmldoc $\r
    </releaseinfo>\r
    <author>\r
      <orgname>The DocBook Project</orgname>\r
    </author>\r
    <copyright>\r
      <year>2005-2007</year>\r
      <holder>The DocBook Project</holder>\r
    </copyright>\r
    <abstract>\r
      <para>This is reference documentation for all user-configurable\r
      parameters in the DocBook XSL "manpages" stylesheet (for\r
      generating groff/nroff output). Note that the manpages\r
      stylesheet is a customization layer of the DocBook XSL HTML\r
      stylesheet. Therefore, you can also use a number of <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="../html/">HTML stylesheet parameters</link>\r
      to control manpages output (in addition to the\r
      manpages-specific parameters listed in this section).</para>\r
    </abstract>\r
  </info>\r
  <reference xml:id="general">\r
  <title>Hyphenation, justification, and breaking</title>\r
<refentry version="5.0" xml:id="man.hyphenate">\r
<refmeta>\r
<refentrytitle>man.hyphenate</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.hyphenate</refname>\r
<refpurpose>Enable hyphenation?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.hyphenate.frag">\r
&lt;xsl:param name="man.hyphenate"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If non-zero, hyphenation is enabled.</para>\r
\r
<note>\r
<para>The default value for this parameter is zero because groff is\r
not particularly smart about how it does hyphenation; it can end up\r
hyphenating a lot of things that you don't want hyphenated. To\r
mitigate that, the default behavior of the stylesheets is to suppress\r
hyphenation of computer inlines, filenames, and URLs. (You can\r
override the default behavior by setting non-zero values for the\r
<parameter>man.hyphenate.urls</parameter>,\r
<parameter>man.hyphenate.filenames</parameter>, and\r
<parameter>man.hyphenate.computer.inlines</parameter> parameters.) But\r
the best way is still to just globally disable hyphenation, as the\r
stylesheets do by default.</para>\r
\r
<para>The only good reason to enabled hyphenation is if you have also\r
enabled justification (which is disabled by default). The reason is\r
that justified text can look very bad unless you also hyphenate it; to\r
quote the <quote>Hypenation</quote> node from the groff info page:\r
\r
<blockquote>\r
  <para><emphasis>Since the odds are not great for finding a set of\r
  words, for every output line, which fit nicely on a line without\r
  inserting excessive amounts of space between words, 'gtroff'\r
  hyphenates words so that it can justify lines without inserting too\r
  much space between words.</emphasis></para>\r
</blockquote>\r
\r
So, if you set a non-zero value for the\r
<parameter>man.justify</parameter> parameter (to enable\r
justification), then you should probably also set a non-zero value for\r
<parameter>man.hyphenate</parameter> (to enable hyphenation).</para>\r
</note>\r
\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.hyphenate.urls">\r
<refmeta>\r
<refentrytitle>man.hyphenate.urls</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.hyphenate.urls</refname>\r
<refpurpose>Hyphenate URLs?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.hyphenate.urls.frag">\r
&lt;xsl:param name="man.hyphenate.urls"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If zero (the default), hyphenation is suppressed for output of\r
the <tag>ulink</tag> <tag class="attribute">url</tag> attribute.</para>\r
\r
<note>\r
  <para>If hyphenation is already turned off globally (that is, if\r
  <parameter>man.hyphenate</parameter> is zero, setting\r
  <parameter>man.hyphenate.urls</parameter> is not necessary.</para>\r
</note>\r
\r
<para>If <parameter>man.hyphenate.urls</parameter> is non-zero, URLs\r
will not be treated specially and are subject to hyphenation just like\r
other words.</para>\r
\r
<note>\r
  <para>If you are thinking about setting a non-zero value for\r
  <parameter>man.hyphenate.urls</parameter> in order to make long\r
  URLs break across lines, you'd probably be better off\r
  experimenting with setting the\r
  <parameter>man.break.after.slash</parameter> parameter first. That\r
  will cause long URLs to be broken after slashes.</para>\r
</note>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.hyphenate.filenames">\r
<refmeta>\r
<refentrytitle>man.hyphenate.filenames</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.hyphenate.filenames</refname>\r
<refpurpose>Hyphenate filenames?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.hyphenate.filenames.frag">\r
&lt;xsl:param name="man.hyphenate.filenames"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If zero (the default), hyphenation is suppressed for\r
<tag>filename</tag> output.</para>\r
\r
<note>\r
  <para>If hyphenation is already turned off globally (that is, if\r
  <parameter>man.hyphenate</parameter> is zero, setting\r
  <parameter>man.hyphenate.filenames</parameter> is not\r
  necessary.</para>\r
</note>\r
\r
<para>If <parameter>man.hyphenate.filenames</parameter> is non-zero,\r
filenames will not be treated specially and are subject to hyphenation\r
just like other words.</para>\r
\r
<note>\r
  <para>If you are thinking about setting a non-zero value for\r
  <parameter>man.hyphenate.filenames</parameter> in order to make long\r
  filenames/pathnames break across lines, you'd probably be better off\r
  experimenting with setting the\r
  <parameter>man.break.after.slash</parameter> parameter first. That\r
  will cause long pathnames to be broken after slashes.</para>\r
</note>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.hyphenate.computer.inlines">\r
<refmeta>\r
<refentrytitle>man.hyphenate.computer.inlines</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.hyphenate.computer.inlines</refname>\r
<refpurpose>Hyphenate computer inlines?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.hyphenate.computer.inlines.frag">\r
&lt;xsl:param name="man.hyphenate.computer.inlines"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If zero (the default), hyphenation is suppressed for\r
<quote>computer inlines</quote> such as environment variables,\r
constants, etc. This parameter current affects output of the following\r
elements:\r
<simplelist type="inline">\r
  \r
  <member><tag>classname</tag></member>\r
  <member><tag>constant</tag></member>\r
  <member><tag>envar</tag></member>\r
  <member><tag>errorcode</tag></member>\r
  <member><tag>option</tag></member>\r
  <member><tag>replaceable</tag></member>\r
  <member><tag>userinput</tag></member>\r
  <member><tag>type</tag></member>\r
  <member><tag>varname</tag></member>\r
</simplelist>\r
</para>\r
\r
<note>\r
  <para>If hyphenation is already turned off globally (that is, if\r
  <parameter>man.hyphenate</parameter> is zero, setting the\r
  <parameter>man.hyphenate.computer.inlines</parameter> is not\r
  necessary.</para>\r
</note>\r
\r
<para>If <parameter>man.hyphenate.computer.inlines</parameter> is\r
non-zero, computer inlines will not be treated specially and will be\r
hyphenated like other words when needed.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.justify">\r
<refmeta>\r
<refentrytitle>man.justify</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.justify</refname>\r
<refpurpose>Justify text to both right and left margins?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.justify.frag">\r
&lt;xsl:param name="man.justify"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If non-zero, text is justified to both the right and left\r
margins (or, in roff terminology, "adjusted and filled" to both the\r
right and left margins). If zero (the default), text is adjusted to\r
the left margin only -- producing what is traditionally called\r
"ragged-right" text.</para>\r
\r
<note>\r
<para>The default value for this parameter is zero because justified\r
text looks good only when it is also hyphenated. Without hyphenation,\r
excessive amounts of space often end up getting between words, in\r
order to "pad" lines out to align on the right margin.</para>\r
\r
<para>The problem is that groff is not particularly smart about how it\r
does hyphenation; it can end up hyphenating a lot of things that you\r
don't want hyphenated. So, disabling both justification and\r
hyphenation ensures that hyphens won't get inserted where you don't\r
want to them, and you don't end up with lines containing excessive\r
amounts of space between words.</para>\r
\r
<para>However, if do you decide to set a non-zero value for the\r
<parameter>man.justify</parameter> parameter (to enable\r
justification), then you should probably also set a non-zero value for\r
<parameter>man.hyphenate</parameter> (to enable hyphenation).</para>\r
\r
<para>Yes, these default settings run counter to how most existing man\r
pages are formatted. But there are some notable exceptions, such as\r
the <literal>perl</literal> man pages.</para>\r
</note>\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.break.after.slash">\r
<refmeta>\r
<refentrytitle>man.break.after.slash</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.break.after.slash</refname>\r
<refpurpose>Enable line-breaking after slashes?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.break.after.slash.frag">\r
&lt;xsl:param name="man.break.after.slash"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If non-zero, line-breaking after slashes is enabled. This is\r
mainly useful for causing long URLs or pathnames/filenames to be\r
broken up or "wrapped" across lines (though it also has the side\r
effect of sometimes causing relatively short URLs and pathnames to be\r
broken up across lines too).</para>\r
\r
<para>If zero (the default), line-breaking after slashes is\r
disabled. In that case, strings containing slashes (for example, URLs\r
or filenames) are not broken across lines, even if they exceed the\r
maximum column widith.</para>\r
\r
<warning>\r
  <para>If you set a non-zero value for this parameter, check your\r
  man-page output carefuly afterwards, in order to make sure that the\r
  setting has not introduced an excessive amount of breaking-up of URLs\r
  or pathnames. If your content contains mostly short URLs or\r
  pathnames, setting a non-zero value for\r
  <parameter>man.break.after.slash</parameter> will probably result in\r
  in a significant number of relatively short URLs and pathnames being\r
  broken across lines, which is probably not what you want.</para>\r
</warning>\r
\r
</refsection>\r
</refentry>\r
\r
  </reference>\r
  <reference xml:id="indent">\r
  <title>Indentation</title>\r
<refentry version="5.0" xml:id="man.indent.width">\r
<refmeta>\r
<refentrytitle>man.indent.width</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">length</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.indent.width</refname>\r
<refpurpose>Specifies width used for adjusted indents</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.indent.width.frag">\r
&lt;xsl:param name="man.indent.width"&gt;4&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
<para>The <parameter>man.indent.width</parameter> parameter specifies\r
the width used for adjusted indents. The value of\r
<parameter>man.indent.width</parameter> is used for indenting of\r
lists, verbatims, headings, and elsewhere, depending on whether the\r
values of certain <literal>man.indent.*</literal> boolean parameters\r
are non-zero.</para>\r
\r
<para>The value of <parameter>man.indent.width</parameter> should\r
include a valid roff measurement unit (for example,\r
<literal>n</literal> or <literal>u</literal>). The default value of\r
<literal>4n</literal> specifies a 4-en width; when viewed on a\r
console, that amounts to the width of four characters. For details\r
about roff measurment units, see the <literal>Measurements</literal>\r
node in the groff info page.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.indent.refsect">\r
<refmeta>\r
<refentrytitle>man.indent.refsect</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.indent.refsect</refname>\r
<refpurpose>Adjust indentation of refsect* and refsection?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.indent.refsect.frag">\r
&lt;xsl:param name="man.indent.refsect" select="0"&gt;&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of <parameter>man.indent.refsect</parameter> is\r
non-zero, the width of the left margin for\r
<tag>refsect1</tag>, <tag>refsect2</tag> and\r
<tag>refsect3</tag> contents and titles (and first-level,\r
second-level, and third-level nested\r
<tag>refsection</tag>instances) is adjusted by the value of\r
the <parameter>man.indent.width</parameter> parameter. With\r
<parameter>man.indent.width</parameter> set to its default value of\r
<literal>3n</literal>, the main results are that:\r
\r
<itemizedlist>\r
  <listitem>\r
    <para>contents of <tag>refsect1</tag> are output with a\r
    left margin of three characters instead the roff default of seven\r
    or eight characters</para>\r
  </listitem>\r
  <listitem>\r
    <para>contents of <tag>refsect2</tag> are displayed in\r
    console output with a left margin of six characters instead the of\r
    the roff default of seven characters</para>\r
  </listitem>\r
  <listitem>\r
    <para> the contents of <tag>refsect3</tag> and nested\r
    <tag>refsection</tag> instances are adjusted\r
    accordingly.</para>\r
  </listitem>\r
</itemizedlist>\r
\r
If instead the value of <parameter>man.indent.refsect</parameter> is\r
zero, no margin adjustment is done for <literal>refsect*</literal>\r
output.</para>\r
\r
<tip>\r
  <para>If your content is primarly comprised of\r
  <tag>refsect1</tag> and <tag>refsect2</tag> content\r
  (or the <tag>refsection</tag> equivalent)&#160;&#8211; with few or\r
  no <tag>refsect3</tag> or lower nested sections , you may be\r
  able to &#8220;conserve&#8221; space in your output by setting\r
  <parameter>man.indent.refsect</parameter> to a non-zero value. Doing\r
  so will &#8220;squeeze&#8221; the left margin in such as way as to provide an\r
  additional four characters of &#8220;room&#8221; per line in\r
  <tag>refsect1</tag> output. That extra room may be useful\r
  if, for example, you have many verbatim sections with long lines in\r
  them.</para>\r
</tip>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.indent.blurbs">\r
<refmeta>\r
<refentrytitle>man.indent.blurbs</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.indent.blurbs</refname>\r
<refpurpose>Adjust indentation of blurbs?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.indent.blurbs.frag">\r
&lt;xsl:param name="man.indent.blurbs" select="1"&gt;&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of <parameter>man.indent.blurbs</parameter> is\r
non-zero, the width of the left margin for\r
<tag>authorblurb</tag>, <tag>personblurb</tag>, and\r
<tag>contrib</tag> output is set to the value of the\r
<parameter>man.indent.width</parameter> parameter\r
(<literal>3n</literal> by default). If instead the value of\r
<parameter>man.indent.blurbs</parameter> is zero, the built-in roff\r
default width (<literal>7.2n</literal>) is used.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.indent.lists">\r
<refmeta>\r
<refentrytitle>man.indent.lists</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.indent.lists</refname>\r
<refpurpose>Adjust indentation of lists?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.indent.lists.frag">\r
&lt;xsl:param name="man.indent.lists" select="1"&gt;&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of <parameter>man.indent.lists</parameter> is\r
non-zero, the width of the left margin for list items in\r
<tag>itemizedlist</tag>,\r
<tag>orderedlist</tag>,\r
<tag>variablelist</tag> output (and output of some other\r
lists) is set to the value of the\r
<parameter>man.indent.width</parameter> parameter\r
(<literal>4n</literal> by default). If instead the value of\r
<parameter>man.indent.lists</parameter> is zero, the built-in roff\r
default width (<literal>7.2n</literal>) is used.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.indent.verbatims">\r
<refmeta>\r
<refentrytitle>man.indent.verbatims</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.indent.verbatims</refname>\r
<refpurpose>Adjust indentation of verbatims?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.indent.verbatims.frag">\r
&lt;xsl:param name="man.indent.verbatims" select="1"&gt;&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of <parameter>man.indent.verbatims</parameter> is\r
non-zero, the width of the left margin for output of verbatim\r
environments (<tag>programlisting</tag>,\r
<tag>screen</tag>, and so on) is set to the value of the\r
<parameter>man.indent.width</parameter> parameter\r
(<literal>3n</literal> by default). If instead the value of\r
<parameter>man.indent.verbatims</parameter> is zero, the built-in roff\r
default width (<literal>7.2n</literal>) is used.</para>\r
\r
</refsection>\r
</refentry>\r
\r
  </reference>\r
  <reference xml:id="fonts">\r
  <title>Fonts</title>\r
<refentry version="5.0" xml:id="man.font.funcprototype">\r
<refmeta>\r
<refentrytitle>man.font.funcprototype</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.font.funcprototype</refname>\r
<refpurpose>Specifies font for funcprototype output</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.font.funcprototype.frag">\r
  &lt;xsl:param name="man.font.funcprototype"&gt;BI&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>The <parameter>man.font.funcprototype</parameter> parameter\r
specifies the font for <tag>funcprototype</tag> output. It\r
should be a valid roff font name, such as <literal>BI</literal> or\r
<literal>B</literal>.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.font.funcsynopsisinfo">\r
<refmeta>\r
<refentrytitle>man.font.funcsynopsisinfo</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.font.funcsynopsisinfo</refname>\r
<refpurpose>Specifies font for funcsynopsisinfo output</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.font.funcsynopsisinfo.frag">\r
  &lt;xsl:param name="man.font.funcsynopsisinfo"&gt;B&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>The <parameter>man.font.funcsynopsisinfo</parameter> parameter\r
specifies the font for <tag>funcsynopsisinfo</tag> output. It\r
should be a valid roff font name, such as <literal>B</literal> or\r
<literal>I</literal>.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.font.links">\r
<refmeta>\r
<refentrytitle>man.font.links</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.font.links</refname>\r
<refpurpose>Specifies font for links</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.font.links.frag">\r
&lt;xsl:param name="man.font.links"&gt;B&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>The <parameter>man.font.links</parameter> parameter\r
specifies the font for output of links (<tag>ulink</tag> instances\r
and any instances of any element with an <tag class="attribute">xlink:href</tag> attribute).</para>\r
\r
<para>The value of <parameter>man.font.links</parameter> must be\r
  either <literal>B</literal> or <literal>I</literal>, or empty. If\r
the value is empty, no font formatting is applied to links.</para>\r
\r
<para>If you set <parameter>man.endnotes.are.numbered</parameter> and/or\r
<parameter>man.endnotes.list.enabled</parameter> to zero (disabled), then\r
you should probably also set an empty value for\r
<parameter>man.font.links</parameter>. But if\r
<parameter>man.endnotes.are.numbered</parameter> is non-zero (enabled),\r
you should probably keep\r
<parameter>man.font.links</parameter> set to\r
<literal>B</literal> or <literal>I</literal><footnote><para>The\r
    main purpose of applying a font format to links in most output\r
formats it to indicate that the formatted text is\r
&#8220;clickable&#8221;; given that links rendered in man pages are\r
not &#8220;real&#8221; hyperlinks that users can click on, it might\r
seem like there is never a good reason to have font formatting for\r
link contents in man output.</para>\r
<para>In fact, if you suppress the\r
display of inline link references (by setting\r
<parameter>man.endnotes.are.numbered</parameter> to zero), there is no\r
good reason to apply font formatting to links. However, if\r
<parameter>man.endnotes.are.numbered</parameter> is non-zero, having\r
font formatting for links (arguably) serves a purpose: It provides\r
&#8220;context&#8221; information about exactly what part of the text\r
is being &#8220;annotated&#8221; by the link. Depending on how you\r
mark up your content, that context information may or may not\r
have value.</para></footnote>.</para>\r
</refsection>\r
\r
<refsection><info><title>Related Parameters</title></info>\r
  <para><parameter>man.endnotes.list.enabled</parameter>,\r
    <parameter>man.endnotes.are.numbered</parameter></para>\r
</refsection>\r
\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.font.table.headings">\r
<refmeta>\r
<refentrytitle>man.font.table.headings</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.font.table.headings</refname>\r
<refpurpose>Specifies font for table headings</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.font.table.headings.frag">\r
  &lt;xsl:param name="man.font.table.headings"&gt;B&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>The <parameter>man.font.table.headings</parameter> parameter\r
specifies the font for <tag>table</tag> headings. It should be\r
a valid roff font, such as <literal>B</literal> or\r
<literal>I</literal>.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.font.table.title">\r
<refmeta>\r
<refentrytitle>man.font.table.title</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.font.table.title</refname>\r
<refpurpose>Specifies font for table headings</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.font.table.title.frag">\r
  &lt;xsl:param name="man.font.table.title"&gt;B&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>The <parameter>man.font.table.title</parameter> parameter\r
specifies the font for <tag>table</tag> titles. It should be\r
a valid roff font, such as <literal>B</literal> or\r
<literal>I</literal>.</para>\r
\r
</refsection>\r
</refentry>\r
\r
  </reference>\r
  <reference xml:id="synopsis">\r
  <title>SYNOPSIS section</title>\r
<refentry version="5.0" xml:id="man.funcsynopsis.style">\r
<refmeta>\r
<refentrytitle>man.funcsynopsis.style</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>\r
<refmiscinfo class="other" otherclass="value">ansi</refmiscinfo>\r
<refmiscinfo class="other" otherclass="value">kr</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.funcsynopsis.style</refname>\r
<refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpose>\r
</refnamediv>\r
<refsynopsisdiv>\r
<programlisting xml:id="man.funcsynopsis.style.frag">&lt;xsl:param name="man.funcsynopsis.style"&gt;ansi&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
<refsection><info><title>Description</title></info>\r
<para>If <parameter>man.funcsynopsis.style</parameter> is\r
<literal>ansi</literal>, ANSI-style function synopses are\r
generated for a <tag>funcsynopsis</tag>, otherwise K&amp;R-style\r
function synopses are generated.</para>\r
</refsection>\r
</refentry>\r
\r
  </reference>\r
  <reference xml:id="authors">\r
  <title>AUTHORS and COPYRIGHT sections</title>\r
  <refentry version="5.0" xml:id="man.authors.section.enabled">\r
<refmeta>\r
<refentrytitle>man.authors.section.enabled</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.authors.section.enabled</refname>\r
<refpurpose>Display auto-generated AUTHORS section?</refpurpose>\r
</refnamediv>\r
<refsynopsisdiv>\r
<programlisting xml:id="man.authors.section.enabled.frag">\r
&lt;xsl:param name="man.authors.section.enabled"&gt;1&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of\r
<parameter>man.authors.section.enabled</parameter> is non-zero\r
(the default), then an <literal>AUTHORS</literal> section is\r
generated near the end of each man page. The output of the\r
<literal>AUTHORS</literal> section is assembled from any\r
<tag>author</tag>, <tag>editor</tag>, and <tag>othercredit</tag>\r
metadata found in the contents of the child <tag>info</tag> or\r
<tag>refentryinfo</tag> (if any) of the <tag>refentry</tag>\r
itself, or from any <tag>author</tag>, <tag>editor</tag>, and\r
<tag>othercredit</tag> metadata that may appear in <tag>info</tag>\r
contents of any ancestors of the <tag>refentry</tag>.</para>\r
\r
<para>If the value of\r
<parameter>man.authors.section.enabled</parameter> is zero, the\r
the auto-generated <literal>AUTHORS</literal> section is\r
suppressed.</para>\r
\r
<para>Set the value of\r
  <parameter>man.authors.section.enabled</parameter> to zero if\r
  you want to have a manually created <literal>AUTHORS</literal>\r
  section in your source, and you want it to appear in output\r
  instead of the auto-generated <literal>AUTHORS</literal>\r
  section.</para>\r
</refsection>\r
</refentry>\r
\r
  <refentry version="5.0" xml:id="man.copyright.section.enabled">\r
<refmeta>\r
<refentrytitle>man.copyright.section.enabled</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.copyright.section.enabled</refname>\r
<refpurpose>Display auto-generated COPYRIGHT section?</refpurpose>\r
</refnamediv>\r
<refsynopsisdiv>\r
<programlisting xml:id="man.copyright.section.enabled.frag">\r
&lt;xsl:param name="man.copyright.section.enabled"&gt;1&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of\r
<parameter>man.copyright.section.enabled</parameter> is non-zero\r
(the default), then a <literal>COPYRIGHT</literal> section is\r
generated near the end of each man page. The output of the\r
<literal>COPYRIGHT</literal> section is assembled from any\r
<tag>copyright</tag> and <tag>legalnotice</tag> metadata found in\r
the contents of the child <tag>info</tag> or\r
<tag>refentryinfo</tag> (if any) of the <tag>refentry</tag>\r
itself, or from any <tag>copyright</tag> and\r
<tag>legalnotice</tag> metadata that may appear in <tag>info</tag>\r
contents of any ancestors of the <tag>refentry</tag>.</para>\r
\r
<para>If the value of\r
<parameter>man.copyright.section.enabled</parameter> is zero, the\r
the auto-generated <literal>COPYRIGHT</literal> section is\r
suppressed.</para>\r
\r
<para>Set the value of\r
  <parameter>man.copyright.section.enabled</parameter> to zero if\r
  you want to have a manually created <literal>COPYRIGHT</literal>\r
  section in your source, and you want it to appear in output\r
  instead of the auto-generated <literal>COPYRIGHT</literal>\r
  section.</para>\r
</refsection>\r
</refentry>\r
\r
  </reference>\r
  <reference xml:id="endnotes">\r
  <title>Endnotes and link handling</title>\r
<refentry version="5.0" xml:id="man.endnotes.list.enabled">\r
<refmeta>\r
<refentrytitle>man.endnotes.list.enabled</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.endnotes.list.enabled</refname>\r
<refpurpose>Display endnotes list at end of man page?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.endnotes.list.enabled.frag">\r
&lt;xsl:param name="man.endnotes.list.enabled"&gt;1&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of <parameter>man.endnotes.list.enabled</parameter> is\r
non-zero (the default), then an endnotes list is added to the end of\r
the output man page.</para>\r
\r
<para>If the value of <parameter>man.endnotes.list.enabled</parameter> is\r
zero, the list is suppressed &#8212; unless link numbering is enabled (that\r
is, if <parameter>man.endnotes.are.numbered</parameter> is non-zero), in\r
which case, that setting overrides the\r
<parameter>man.endnotes.list.enabled</parameter> setting, and the\r
endnotes list is still displayed. The reason is that inline\r
numbering of notesources associated with endnotes only makes sense\r
if a (numbered) list of endnotes is also generated.</para>\r
\r
<note>\r
  <para>Leaving\r
  <parameter>man.endnotes.list.enabled</parameter> at its default\r
  (non-zero) value ensures that no &#8220;out of line&#8221; information (such\r
  as the URLs for hyperlinks and images) gets lost in your\r
  man-page output. It just gets &#8220;rearranged&#8221;.</para>\r
  <para>So if you&#8217;re thinking about disabling endnotes listing by\r
    setting the value of\r
    <parameter>man.endnotes.list.enabled</parameter> to zero:\r
    Before you do so, first take some time to carefully consider\r
    the information needs and experiences of your users. The &#8220;out\r
    of line&#8221; information has value even if the presentation of it\r
    in text output is not as interactive as it may be in other\r
    output formats.</para>\r
  <para>As far as the specific case of URLs: Even though the URLs\r
    displayed in text output may not be &#8220;real&#8221; (clickable)\r
    hyperlinks, many X terminals have convenience features for\r
    recognizing URLs and can, for example, present users with\r
    an options to open a URL in a browser with the user clicks on\r
    the URL is a terminal window. And short of those, users with X\r
    terminals can always manually cut and paste the URLs into a web\r
    browser.</para>\r
  <para>Also, note that various &#8220;man to html&#8221; tools, such as the\r
    widely used <command><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://users.actrix.gen.nz/michael/vhman2html.html">man2html</link></command> (<literal>VH-Man2html</literal>)\r
    application, automatically mark up URLs with <literal>a@href</literal> markup\r
  during conversion &#8212; resulting in &#8220;real&#8221; hyperlinks in HTML\r
  output from those tools.</para>\r
</note>\r
\r
<para>To &#8220;turn off&#8221; numbering of endnotes in the\r
endnotes list, set <parameter>man.endnotes.are.numbered</parameter>\r
to zero. The endnotes list will\r
still be displayed; it will just be displayed without the\r
numbers<footnote><para>It can still make sense to have\r
the list of endnotes displayed even if you have endnotes numbering turned\r
off. In that case, your endnotes list basically becomes a &#8220;list\r
of references&#8221; without any association with specific text in\r
your document. This is probably the best option if you find the inline\r
endnotes numbering obtrusive. Your users will still have access to all the &#8220;out of line&#8221;\r
such as URLs for hyperlinks.</para></footnote>\r
</para>\r
\r
<para>The default heading for the endnotes list is\r
<literal>NOTES</literal>. To change that, set a non-empty\r
value for the <parameter>man.endnotes.list.heading</parameter>\r
parameter.</para>\r
\r
<para>In the case of notesources that are links: Along with the\r
URL for each link, the endnotes list includes the contents of the\r
link. The list thus includes only non-empty<footnote>\r
\r
<para>A &#8220;non-empty&#8221; link is one that looks like\r
this:<literallayout class="monospaced">  &lt;ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"&gt;manpages&lt;/ulink&gt;</literallayout>\r
an &#8220;empty link&#8221; is on that looks like this:<literallayout class="monospaced">  &lt;ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"/&gt;</literallayout>\r
</para></footnote> links.\r
\r
Empty links are never included, and never numbered. They are simply\r
displayed inline, without any numbering.</para>\r
\r
<para>In addition, if there are multiple instances of links in a\r
<tag>refentry</tag> that have the same URL, the URL is listed only\r
once. The contents listed for that link in the endnotes list are\r
the contents of the first link which has that URL.</para>\r
\r
<para>If you disable endnotes listing, you should probably also set\r
<parameter>man.links.are.underlined</parameter> to zero (to disable\r
link underlining).</para>\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.endnotes.list.heading">\r
<refmeta>\r
<refentrytitle>man.endnotes.list.heading</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.endnotes.list.heading</refname>\r
<refpurpose>Specifies an alternate name for endnotes list</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.endnotes.list.heading.frag">\r
&lt;xsl:param name="man.endnotes.list.heading"&gt;&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of the\r
<parameter>man.endnotes.are.numbered</parameter> parameter\r
and/or the <parameter>man.endnotes.list.enabled</parameter>\r
parameter is non-zero (the defaults for both are non-zero), a\r
numbered list of endnotes is generated near the end of each man\r
page. The default heading for the list of endnotes is the\r
equivalent of the English word <literal>NOTES</literal> in\r
the current locale. To cause an alternate heading to be displayed,\r
set a non-empty value for the\r
<parameter>man.endnotes.list.heading</parameter> parameter &#8212;\r
for example, <literal>REFERENCES</literal>.</para>\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.endnotes.are.numbered">\r
<refmeta>\r
<refentrytitle>man.endnotes.are.numbered</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.endnotes.are.numbered</refname>\r
<refpurpose>Number endnotes?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.endnotes.are.numbered.frag">\r
&lt;xsl:param name="man.endnotes.are.numbered"&gt;1&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of <parameter>man.endnotes.are.numbered</parameter> is\r
non-zero (the default), then for each non-empty<footnote>\r
<para>A &#8220;non-empty&#8221; notesource is one that looks like\r
this:<literallayout class="monospaced">  &lt;ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"&gt;manpages&lt;/ulink&gt;</literallayout>\r
an &#8220;empty&#8221; notesource is on that looks like this:<literallayout class="monospaced">  &lt;ulink url="http://docbook.sf.net/snapshot/xsl/doc/manpages/"/&gt;</literallayout>\r
</para></footnote> &#8220;notesource&#8221;:\r
\r
<itemizedlist>\r
  <listitem>\r
    <para>a number (in square brackets) is displayed inline after the\r
    rendered inline contents (if any) of the notesource</para>\r
  </listitem>\r
  <listitem>\r
    <para>the contents of the notesource are included in a\r
      numbered list of endnotes that is generated at the end of\r
      each man page; the number for each endnote corresponds to\r
      the inline number for the notesource with which it is\r
      associated</para>\r
  </listitem>\r
</itemizedlist>\r
The default heading for the list of endnotes is\r
<literal>NOTES</literal>. To output a different heading, set a value\r
for the <parameter>man.endnotes.section.heading</parameter>\r
parameter.</para>\r
\r
<note>\r
  <para>The endnotes list is also displayed (but without\r
    numbers) if the value of\r
    <parameter>man.endnotes.list.enabled</parameter> is\r
    non-zero.</para>\r
</note>\r
\r
\r
<para>If the value of <parameter>man.endnotes.are.numbered</parameter> is\r
zero, numbering of endnotess is suppressed; only inline\r
contents (if any) of the notesource are displayed inline.\r
<important>\r
  <para>If you are thinking about disabling endnote numbering by setting\r
  the value of <parameter>man.endnotes.are.numbered</parameter> to zero,\r
  before you do so, first take some time to carefully\r
  consider the information needs and experiences of your users. The\r
  square-bracketed numbers displayed inline after notesources may seem\r
  obstrusive and aesthetically unpleasing<footnote><para>As far as notesources that are links, ytou might\r
  think it would be better to just display URLs for non-empty\r
  links inline, after their content, rather than displaying\r
  square-bracketed numbers all over the place. But it's not better. In\r
  fact, it's not even practical, because many (most) URLs for links\r
  are too long to be displayed inline. They end up overflowing the\r
  right margin. You can set a non-zero value for\r
  <parameter>man.break.after.slash</parameter> parameter to deal with\r
  that, but it could be argued that what you end up with is at least\r
  as ugly, and definitely more obstrusive, then having short\r
  square-bracketed numbers displayed inline.</para></footnote>,\r
\r
  but in a text-only output format, the\r
  numbered-notesources/endnotes-listing mechanism is the only\r
  practical way to handle this kind of content.</para>\r
\r
  <para>Also, users of &#8220;text based&#8221; browsers such as\r
  <command>lynx</command> will already be accustomed to seeing inline\r
  numbers for links. And various "man to html" applications, such as\r
  the widely used <command><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://users.actrix.gen.nz/michael/vhman2html.html">man2html</link></command> (<literal>VH-Man2html</literal>)\r
  application, can automatically turn URLs into "real" HTML hyperlinks\r
  in output. So leaving <parameter>man.endnotes.are.numbered</parameter>\r
  at its default (non-zero) value ensures that no information is\r
  lost in your man-page output. It just gets\r
  &#8220;rearranged&#8221;.</para>\r
</important>\r
</para>\r
<para>The handling of empty links is not affected by this\r
parameter. Empty links are handled simply by displaying their URLs\r
inline. Empty links are never auto-numbered.</para>\r
\r
<para>If you disable endnotes numbering, you should probably also set\r
<parameter>man.font.links</parameter> to an empty value (to\r
disable font formatting for links.</para>\r
</refsection>\r
\r
<refsection><info><title>Related Parameters</title></info>\r
  <para><parameter>man.endnotes.list.enabled</parameter>,\r
    <parameter>man.font.links</parameter></para>\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.base.url.for.relative.links">\r
  <refmeta>\r
    <refentrytitle>man.base.url.for.relative.links</refentrytitle>\r
    <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
  </refmeta>\r
  <refnamediv>\r
    <refname>man.base.url.for.relative.links</refname>\r
    <refpurpose>Specifies a base URL for relative links</refpurpose>\r
  </refnamediv>\r
\r
  <refsynopsisdiv>\r
    <programlisting xml:id="man.base.url.for.relative.links.frag">&lt;xsl:param name="man.base.url.for.relative.links"&gt;[set $man.base.url.for.relative.links]/&lt;/xsl:param&gt;</programlisting>\r
  </refsynopsisdiv>\r
\r
  <refsection><info><title>Description</title></info>\r
\r
    <para>For any &#8220;notesource&#8221; listed in the auto-generated\r
      &#8220;NOTES&#8221; section of output man pages (which is generated when\r
      the value of the\r
      <parameter>man.endnotes.list.enabled</parameter> parameter\r
      is non-zero), if the notesource is a link source with a\r
      relative URI, the URI is displayed in output with the value\r
      of the\r
      <parameter>man.base.url.for.relative.links</parameter>\r
      parameter prepended to the value of the link URI.</para>\r
\r
    <note>\r
      <para>A link source is an notesource that references an\r
        external resource:\r
        <itemizedlist>\r
          <listitem>\r
            <para>a <tag>ulink</tag> element with a <tag class="attribute">url</tag> attribute</para>\r
          </listitem>\r
          <listitem>\r
            <para>any element with an <tag class="attribute">xlink:href</tag> attribute</para>\r
          </listitem>\r
          <listitem>\r
            <para>an <tag>imagedata</tag>, <tag>audiodata</tag>, or\r
              <tag>videodata</tag> element</para>\r
          </listitem>\r
        </itemizedlist>\r
      </para>\r
    </note>\r
\r
    <para>If you use relative URIs in link sources in your DocBook\r
      <tag>refentry</tag> source, and you leave\r
      <parameter>man.base.url.for.relative.links</parameter>\r
      unset, the relative links will appear &#8220;as is&#8221; in the &#8220;Notes&#8221;\r
      section of any man-page output generated from your source.\r
      That&#8217;s probably not what you want, because such relative\r
      links are only usable in the context of HTML output. So, to\r
      make the links meaningful and usable in the context of\r
      man-page output, set a value for\r
      <parameter>man.base.url.for.relative.links</parameter> that\r
      points to the online version of HTML output generated from\r
      your DocBook <tag>refentry</tag> source. For\r
      example:\r
      <programlisting>&lt;xsl:param name="man.base.url.for.relative.links"\r
        &gt;http://www.kernel.org/pub/software/scm/git/docs/&lt;/xsl:param&gt;</programlisting>\r
    </para>\r
\r
  </refsection>\r
\r
  <refsection><info><title>Related Parameters</title></info>\r
    <para><parameter>man.endnotes.list.enabled</parameter></para>\r
  </refsection>\r
\r
</refentry>\r
\r
  </reference>\r
  <reference xml:id="lists">\r
  <title>Lists</title>\r
<refentry version="5.0" xml:id="man.segtitle.suppress">\r
<refmeta>\r
<refentrytitle>man.segtitle.suppress</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.segtitle.suppress</refname>\r
<refpurpose>Suppress display of segtitle contents?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.segtitle.suppress.frag">\r
&lt;xsl:param name="man.segtitle.suppress" select="0"&gt;&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of <parameter>man.segtitle.suppress</parameter> is\r
non-zero, then display of <tag>segtitle</tag> contents is\r
suppressed in output.</para>\r
\r
</refsection>\r
</refentry>\r
\r
  </reference>\r
  <reference xml:id="charmap">\r
  <title>Character/string substitution</title>\r
<refentry version="5.0" xml:id="man.charmap.enabled">\r
<refmeta>\r
<refentrytitle>man.charmap.enabled</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.charmap.enabled</refname>\r
<refpurpose>Apply character map before final output?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.charmap.enabled.frag">\r
&lt;xsl:param name="man.charmap.enabled" select="1"&gt;&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of the <parameter>man.charmap.enabled</parameter>\r
parameter is non-zero, a "character map" is used to substitute certain\r
Unicode symbols and special characters with appropriate roff/groff\r
equivalents, just before writing each man-page file to the\r
filesystem. If instead the value of\r
<parameter>man.charmap.enabled</parameter> is zero, Unicode characters\r
are passed through "as is".</para>\r
\r
<refsection><info><title>Details</title></info>\r
\r
<para>For converting certain Unicode symbols and special characters in\r
UTF-8 or UTF-16 encoded XML source to appropriate groff/roff\r
equivalents in man-page output, the DocBook XSL Stylesheets\r
distribution includes a <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">roff character map</link> that is compliant with the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character\r
map</link> format as detailed in the XSLT 2.0 specification. The map\r
contains more than 800 character mappings and can be considered the\r
standard roff character map for the distribution.</para>\r
\r
<para>You can use the <parameter>man.charmap.uri</parameter>\r
parameter to specify a URI for the location for an alternate roff\r
character map to use in place of the standard roff character map\r
provided in the distribution.</para>\r
\r
<para>You can also use a subset of a character map. For details,\r
see the <parameter>man.charmap.use.subset</parameter>,\r
<parameter>man.charmap.subset.profile</parameter>, and\r
<parameter>man.charmap.subset.profile.english</parameter>\r
parameters.</para>\r
\r
</refsection>\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.charmap.uri">\r
<refmeta>\r
<refentrytitle>man.charmap.uri</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.charmap.uri</refname>\r
<refpurpose>URI for custom roff character map</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.charmap.uri.frag">\r
&lt;xsl:param name="man.charmap.uri"&gt;&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>For converting certain Unicode symbols and special characters in\r
UTF-8 or UTF-16 encoded XML source to appropriate groff/roff\r
equivalents in man-page output, the DocBook XSL Stylesheets\r
distribution includes an <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character\r
map</link>. That character map can be considered the standard roff\r
character map for the distribution.</para>\r
\r
<para>If the value of the <parameter>man.charmap.uri</parameter>\r
parameter is non-empty, that value is used as the URI for the location\r
for an alternate roff character map to use in place of the standard\r
roff character map provided in the distribution.</para>\r
\r
<warning>\r
<para>Do not set a value for <parameter>man.charmap.uri</parameter>\r
unless you have a custom roff character map that differs from the\r
standard one provided in the distribution.</para>\r
</warning>\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.charmap.use.subset">\r
<refmeta>\r
<refentrytitle>man.charmap.use.subset</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.charmap.use.subset</refname>\r
<refpurpose>Use subset of character map instead of full map?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.charmap.use.subset.frag">\r
&lt;xsl:param name="man.charmap.use.subset" select="1"&gt;&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of the\r
<parameter>man.charmap.use.subset</parameter> parameter is non-zero,\r
a subset of the roff character map is used instead of the full roff\r
character map. The profile of the subset used is determined either\r
by the value of the\r
<parameter>man.charmap.subset.profile</parameter>\r
parameter (if the source is not in English) or the\r
<parameter>man.charmap.subset.profile.english</parameter>\r
parameter (if the source is in English).</para>\r
\r
<note>\r
  <para>You may want to experiment with setting a non-zero value of\r
  <parameter>man.charmap.use.subset</parameter>, so that the full\r
  character map is used. Depending on which XSLT engine you run,\r
  setting a non-zero value for\r
  <parameter>man.charmap.use.subset</parameter> may significantly\r
  increase the time needed to process your documents. Or it may\r
  not. For example, if you set it and run it with xsltproc, it seems\r
  to dramatically increase processing time; on the other hand, if you\r
  set it and run it with Saxon, it does not seem to increase\r
  processing time nearly as much.</para>\r
\r
  <para>If processing time is not a important concern and/or you can\r
  tolerate the increase in processing time imposed by using the full\r
  character map, set <parameter>man.charmap.use.subset</parameter> to\r
  zero.</para>\r
</note>\r
\r
<refsection><info><title>Details</title></info>\r
\r
<para>For converting certain Unicode symbols and special characters in\r
UTF-8 or UTF-16 encoded XML source to appropriate groff/roff\r
equivalents in man-page output, the DocBook XSL Stylesheets\r
distribution includes a <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">roff character map</link> that is compliant with the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character\r
map</link> format as detailed in the XSLT 2.0 specification. The map\r
contains more than 800 character mappings and can be considered the\r
standard roff character map for the distribution.</para>\r
\r
<note>\r
<para>You can use the <parameter>man.charmap.uri</parameter>\r
parameter to specify a URI for the location for an alternate roff\r
character map to use in place of the standard roff character map\r
provided in the distribution.</para>\r
</note>\r
\r
<para>Because it is not terrifically efficient to use the standard\r
800-character character map in full -- and for most (or all) users,\r
never necessary to use it in full -- the DocBook XSL Stylesheets\r
support a mechanism for using, within any given character map, a\r
subset of character mappings instead of the full set. You can use the\r
<parameter>man.charmap.subset.profile</parameter> or\r
<parameter>man.charmap.subset.profile.english</parameter>\r
parameter to tune the profile of that subset to use.</para>\r
\r
</refsection>\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.charmap.subset.profile">\r
<refmeta>\r
<refentrytitle>man.charmap.subset.profile</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.charmap.subset.profile</refname>\r
<refpurpose>Profile of character map subset</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.charmap.subset.profile.frag">\r
&lt;xsl:param name="man.charmap.subset.profile"&gt;\r
@*[local-name() = 'block'] = 'Miscellaneous Technical' or\r
(@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and\r
 (@*[local-name() = 'class'] = 'symbols' or\r
  @*[local-name() = 'class'] = 'letters')\r
) or\r
@*[local-name() = 'block'] = 'Latin Extended-A'\r
or\r
(@*[local-name() = 'block'] = 'General Punctuation' and\r
 (@*[local-name() = 'class'] = 'spaces' or\r
  @*[local-name() = 'class'] = 'dashes' or\r
  @*[local-name() = 'class'] = 'quotes' or\r
  @*[local-name() = 'class'] = 'bullets'\r
 )\r
) or\r
@*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or\r
@*[local-name() = 'name'] = 'WORD JOINER' or\r
@*[local-name() = 'name'] = 'SERVICE MARK' or\r
@*[local-name() = 'name'] = 'TRADE MARK SIGN' or\r
@*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE'\r
&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of the\r
<parameter>man.charmap.use.subset</parameter> parameter is non-zero,\r
and your DocBook source is not written in English (that\r
  is, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root element\r
  in your DocBook source or on the first <tag>refentry</tag>\r
  element in your source has a value other than\r
  <literal>en</literal>), then the character-map subset specified\r
  by the <parameter>man.charmap.subset.profile</parameter>\r
  parameter is used instead of the full roff character map.</para>\r
\r
<para>Otherwise, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root\r
  element in your DocBook\r
  source or on the first <tag>refentry</tag> element in your source\r
  has the value <literal>en</literal> or if it has no <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute, then the character-map\r
  subset specified by the\r
  <parameter>man.charmap.subset.profile.english</parameter>\r
  parameter is used instead of\r
  <parameter>man.charmap.subset.profile</parameter>.</para>\r
\r
<para>The difference between the two subsets is that\r
  <parameter>man.charmap.subset.profile</parameter> provides\r
  mappings for characters in Western European languages that are\r
  not part of the Roman (English) alphabet (ASCII character set).</para>\r
\r
<para>The value of <parameter>man.charmap.subset.profile</parameter>\r
is a string representing an XPath expression that matches attribute\r
names and values for <tag namespace="http://docbook.sf.net/xmlns/unichar/1.0">output-character</tag>\r
elements in the character map.</para>\r
\r
<para>The attributes supported in the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">standard roff character map included in the distribution</link> are:\r
<variablelist>\r
  <varlistentry>\r
    <term>character</term>\r
    <listitem>\r
      <simpara>a raw Unicode character or numeric Unicode\r
      character-entity value (either in decimal or hex); all\r
      characters have this attribute</simpara>\r
    </listitem>\r
  </varlistentry>\r
  <varlistentry>\r
    <term>name</term>\r
    <listitem>\r
      <simpara>a standard full/long ISO/Unicode character name (e.g.,\r
      "OHM SIGN"); all characters have this attribute</simpara>\r
    </listitem>\r
  </varlistentry>\r
  <varlistentry>\r
    <term>block</term>\r
    <listitem>\r
      <simpara>a standard Unicode "block" name (e.g., "General\r
      Punctuation"); all characters have this attribute. For the full\r
      list of Unicode block names supported in the standard roff\r
      character map, see <xref linkend="BlocksAndClasses"/>.</simpara>\r
    </listitem>\r
  </varlistentry>\r
  <varlistentry>\r
    <term>class</term>\r
    <listitem>\r
      <simpara>a class of characters (e.g., "spaces"). Not all\r
      characters have this attribute; currently, it is used only with\r
      certain characters within the "C1 Controls And Latin-1\r
      Supplement" and "General Punctuation" blocks. For details, see\r
      <xref linkend="BlocksAndClasses"/>.</simpara>\r
    </listitem>\r
  </varlistentry>\r
  <varlistentry>\r
    <term>entity</term>\r
    <listitem>\r
      <simpara>an ISO entity name (e.g., "ohm"); not all characters\r
      have this attribute, because not all characters have ISO entity\r
      names; for example, of the 800 or so characters in the standard\r
      roff character map included in the distribution, only around 300\r
      have ISO entity names.\r
      </simpara>\r
    </listitem>\r
  </varlistentry>\r
  <varlistentry>\r
    <term>string</term>\r
    <listitem>\r
      <simpara>a string representing an roff/groff escape-code (with\r
      "@esc@" used in place of the backslash), or a simple ASCII\r
      string; all characters in the roff character map have this\r
      attribute</simpara>\r
    </listitem>\r
  </varlistentry>\r
</variablelist>\r
</para>\r
<para>The value of <parameter>man.charmap.subset.profile</parameter>\r
is evaluated as an XPath expression at run-time to select a portion of\r
the roff character map to use. You can tune the subset used by adding\r
or removing parts. For example, if you need to use a wide range of\r
mathematical operators in a document, and you want to have them\r
converted into roff markup properly, you might add the following:\r
\r
<literallayout class="monospaced">  @*[local-name() = 'block'] ='MathematicalOperators' </literallayout>\r
\r
That will cause a additional set of around 67 additional "math"\r
characters to be converted into roff markup. </para>\r
\r
<note>\r
<para>Depending on which XSLT engine you use, either the EXSLT\r
<function>dyn:evaluate</function> extension function (for xsltproc or\r
Xalan) or <function>saxon:evaluate</function> extension function (for\r
Saxon) are used to dynamically evaluate the value of\r
<parameter>man.charmap.subset.profile</parameter> at run-time. If you\r
don't use xsltproc, Saxon, Xalan -- or some other XSLT engine that\r
supports <function>dyn:evaluate</function> -- you must either set the\r
value of the <parameter>man.charmap.use.subset</parameter> parameter\r
to zero and process your documents using the full character map\r
instead, or set the value of the\r
<parameter>man.charmap.enabled</parameter> parameter to zero instead\r
(so that character-map processing is disabled completely.</para>\r
</note>\r
\r
<para>An alternative to using\r
<parameter>man.charmap.subset.profile</parameter> is to create your\r
own custom character map, and set the value of\r
<parameter>man.charmap.uri</parameter> to the URI/filename for\r
that. If you use a custom character map, you will probably want to\r
include in it just the characters you want to use, and so you will\r
most likely also want to set the value of\r
<parameter>man.charmap.use.subset</parameter> to zero.</para>\r
<para>You can create a\r
custom character map by making a copy of the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">standard roff character map</link> provided in the distribution, and\r
then adding to, changing, and/or deleting from that.</para>\r
\r
<caution>\r
<para>If you author your DocBook XML source in UTF-8 or UTF-16\r
encoding and aren't sure what OSes or environments your man-page\r
output might end up being viewed on, and not sure what version of\r
nroff/groff those environments might have, you should be careful about\r
what Unicode symbols and special characters you use in your source and\r
what parts you add to the value of\r
<parameter>man.charmap.subset.profile</parameter>.</para>\r
<para>Many of the escape codes used are specific to groff and using\r
them may not provide the expected output on an OS or environment that\r
uses nroff instead of groff.</para>\r
<para>On the other hand, if you intend for your man-page output to be\r
viewed only on modern systems (for example, GNU/Linux systems, FreeBSD\r
systems, or Cygwin environments) that have a good, up-to-date groff,\r
then you can safely include a wide range of Unicode symbols and\r
special characters in your UTF-8 or UTF-16 encoded DocBook XML source\r
and add any of the supported Unicode block names to the value of\r
<parameter>man.charmap.subset.profile</parameter>.</para>\r
</caution>\r
\r
\r
<para>For other details, see the documentation for the\r
<parameter>man.charmap.use.subset</parameter> parameter.</para>\r
\r
<refsection xml:id="BlocksAndClasses"><info><title>Supported Unicode block names and "class" values</title></info>\r
  \r
\r
  <para>Below is the full list of Unicode block names and "class"\r
  values supported in the standard roff stylesheet provided in the\r
  distribution, along with a description of which codepoints from the\r
  Unicode range corresponding to that block name or block/class\r
  combination are supported.</para>\r
\r
  <itemizedlist>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=C1%20Controls%20and%20Latin-1%20Supplement%20(Latin-1%20Supplement)">C1 Controls And Latin-1 Supplement (Latin-1 Supplement)</link> (x00a0 to x00ff)\r
      <itemizedlist><info><title>class values</title></info>\r
        \r
        <listitem>\r
          <para>symbols</para>\r
        </listitem>\r
        <listitem>\r
          <para>letters</para>\r
        </listitem>\r
      </itemizedlist></para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Latin%20Extended-A">Latin Extended-A</link> (x0100 to x017f, partial)</para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Spacing%20Modifier%20Letters">Spacing Modifier Letters</link> (x02b0 to x02ee, partial)</para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Greek%20and%20Coptic">Greek and Coptic</link> (x0370 to x03ff, partial)</para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=General%20Punctuation">General Punctuation</link> (x2000 to x206f, partial)\r
      <itemizedlist><info><title>class values</title></info>\r
        \r
        <listitem>\r
          <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;start=8192&amp;end=8203">spaces</link></para>\r
        </listitem>\r
        <listitem>\r
          <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;start=8208&amp;end=8213">dashes</link></para>\r
        </listitem>\r
        <listitem>\r
          <para>quotes</para>\r
        </listitem>\r
        <listitem>\r
          <para>daggers</para>\r
        </listitem>\r
        <listitem>\r
          <para>bullets</para>\r
        </listitem>\r
        <listitem>\r
          <para>leaders</para>\r
        </listitem>\r
        <listitem>\r
          <para>primes</para>\r
        </listitem>\r
      </itemizedlist>\r
      </para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Superscripts%20and%20Subscripts">Superscripts and Subscripts</link> (x2070 to x209f)</para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Currency%20Symbols">Currency Symbols</link> (x20a0 to x20b1)</para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Letterlike%20Symbols">Letterlike Symbols</link> (x2100 to x214b)</para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Number%20Forms">Number Forms</link> (x2150 to x218f)</para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Arrows">Arrows</link> (x2190 to x21ff, partial)</para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Mathematical%20Operators">Mathematical Operators</link> (x2200 to x22ff, partial)</para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Control%20Pictures">Control Pictures</link> (x2400 to x243f)</para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Enclosed%20Alphanumerics">Enclosed Alphanumerics</link> (x2460 to x24ff)</para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Geometric%20Shapes">Geometric Shapes</link> (x25a0 to x25f7, partial)</para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Miscellaneous%20Symbols">Miscellaneous Symbols</link> (x2600 to x26ff, partial)</para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Dingbats">Dingbats</link> (x2700 to x27be, partial)</para>\r
    </listitem>\r
    <listitem>\r
      <para><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://zvon.org/other/charSearch/PHP/search.php?searchType=103&amp;id=Alphabetic%20Presentation%20Forms">Alphabetic Presentation Forms</link> (xfb00 to xfb04 only)</para>\r
    </listitem>\r
  </itemizedlist>\r
</refsection>\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.charmap.subset.profile.english">\r
<refmeta>\r
<refentrytitle>man.charmap.subset.profile.english</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.charmap.subset.profile.english</refname>\r
<refpurpose>Profile of character map subset</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.charmap.subset.profile.english.frag">\r
&lt;xsl:param name="man.charmap.subset.profile.english"&gt;\r
@*[local-name() = 'block'] = 'Miscellaneous Technical' or\r
(@*[local-name() = 'block'] = 'C1 Controls And Latin-1 Supplement (Latin-1 Supplement)' and\r
 @*[local-name() = 'class'] = 'symbols')\r
or\r
(@*[local-name() = 'block'] = 'General Punctuation' and\r
 (@*[local-name() = 'class'] = 'spaces' or\r
  @*[local-name() = 'class'] = 'dashes' or\r
  @*[local-name() = 'class'] = 'quotes' or\r
  @*[local-name() = 'class'] = 'bullets'\r
 )\r
) or\r
@*[local-name() = 'name'] = 'HORIZONTAL ELLIPSIS' or\r
@*[local-name() = 'name'] = 'WORD JOINER' or\r
@*[local-name() = 'name'] = 'SERVICE MARK' or\r
@*[local-name() = 'name'] = 'TRADE MARK SIGN' or\r
@*[local-name() = 'name'] = 'ZERO WIDTH NO-BREAK SPACE'\r
&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of the\r
  <parameter>man.charmap.use.subset</parameter> parameter is\r
  non-zero, and your DocBook source is written in English (that\r
  is, if its <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute on the root element\r
  in your DocBook source or on the first <tag>refentry</tag>\r
  element in your source has the value <literal>en</literal> or if\r
  it has no <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute), then the\r
  character-map subset specified by the\r
  <parameter>man.charmap.subset.profile.english</parameter>\r
  parameter is used instead of the full roff character map.</para>\r
\r
<para>Otherwise, if the <tag class="attribute">lang</tag> or <tag class="attribute">xml:lang</tag> attribute\r
  on the root element in your DocBook source or on the first\r
  <tag>refentry</tag> element in your source has a value other\r
  than <literal>en</literal>, then the character-map subset\r
  specified by the\r
  <parameter>man.charmap.subset.profile</parameter> parameter is\r
  used instead of\r
  <parameter>man.charmap.subset.profile.english</parameter>.</para>\r
\r
<para>The difference between the two subsets is that\r
  <parameter>man.charmap.subset.profile</parameter> provides\r
  mappings for characters in Western European languages that are\r
  not part of the Roman (English) alphabet (ASCII character set).</para>\r
\r
<para>The value of <parameter>man.charmap.subset.profile.english</parameter>\r
is a string representing an XPath expression that matches attribute\r
names and values for <tag namespace="http://docbook.sf.net/xmlns/unichar/1.0">output-character</tag> elements in the character map.</para>\r
\r
<para>For other details, see the documentation for the\r
<parameter>man.charmap.subset.profile.english</parameter> and\r
<parameter>man.charmap.use.subset</parameter> parameters.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.string.subst.map.local.pre">\r
<refmeta>\r
<refentrytitle>man.string.subst.map.local.pre</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.string.subst.map.local.pre</refname>\r
<refpurpose>Specifies &#8220;local&#8221; string substitutions</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.string.subst.map.local.pre.frag">\r
  &lt;xsl:param name="man.string.subst.map.local.pre"&gt;&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>Use the <parameter>man.string.subst.map.local.pre</parameter>\r
parameter to specify any &#8220;local&#8221; string substitutions to perform over\r
the entire roff source for each man page <emphasis>before</emphasis>\r
performing the string substitutions specified by the <parameter>man.string.subst.map</parameter> parameter.</para>\r
\r
<para>For details about the format of this parameter, see the\r
documentation for the <parameter>man.string.subst.map</parameter>\r
parameter.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.string.subst.map">\r
<refmeta>\r
<refentrytitle>man.string.subst.map</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.string.subst.map</refname>\r
<refpurpose>Specifies a set of string substitutions</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.string.subst.map.frag">\r
&lt;xsl:param name="man.string.subst.map"&gt;\r
\r
  &lt;!-- * remove no-break marker at beginning of line (stylesheet artifact) --&gt; \r
  &lt;ss:substitution oldstring="&#9618;&#9600;" newstring="&#9618;"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * replace U+2580 no-break marker (stylesheet-added) w/ no-break space --&gt;\r
  &lt;ss:substitution oldstring="&#9600;" newstring="\ "&gt;&lt;/ss:substitution&gt;\r
\r
  &lt;!-- ==================================================================== --&gt;\r
\r
  &lt;!-- * squeeze multiple newlines before a roff request  --&gt;\r
  &lt;ss:substitution oldstring="\r
\r
." newstring="\r
."&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * remove any .sp instances that directly precede a .PP  --&gt;\r
  &lt;ss:substitution oldstring=".sp\r
.PP" newstring=".PP"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * remove any .sp instances that directly follow a .PP  --&gt;\r
  &lt;ss:substitution oldstring=".sp\r
.sp" newstring=".sp"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * squeeze multiple .sp instances into a single .sp--&gt;\r
  &lt;ss:substitution oldstring=".PP\r
.sp" newstring=".PP"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * squeeze multiple newlines after start of no-fill (verbatim) env. --&gt;\r
  &lt;ss:substitution oldstring=".nf\r
\r
" newstring=".nf\r
"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * squeeze multiple newlines after REstoring margin --&gt;\r
  &lt;ss:substitution oldstring=".RE\r
\r
" newstring=".RE\r
"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * U+2591 is a marker we add before and after every Parameter in --&gt;\r
  &lt;!-- * Funcprototype output --&gt;\r
  &lt;ss:substitution oldstring="&#9617;" newstring=" "&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * U+2592 is a marker we add for the newline before output of &lt;sbr&gt;; --&gt;\r
  &lt;ss:substitution oldstring="&#9618;" newstring="\r
"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * --&gt;\r
  &lt;!-- * Now deal with some other characters that are added by the --&gt;\r
  &lt;!-- * stylesheets during processing. --&gt;\r
  &lt;!-- * --&gt;\r
  &lt;!-- * bullet --&gt;\r
  &lt;ss:substitution oldstring="&#8226;" newstring="\(bu"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * left double quote --&gt;\r
  &lt;ss:substitution oldstring="&#8220;" newstring="\(lq"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * right double quote --&gt;\r
  &lt;ss:substitution oldstring="&#8221;" newstring="\(rq"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * left single quote --&gt;\r
  &lt;ss:substitution oldstring="&#8216;" newstring="\(oq"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * right single quote --&gt;\r
  &lt;ss:substitution oldstring="&#8217;" newstring="\(cq"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * copyright sign --&gt;\r
  &lt;ss:substitution oldstring="&#169;" newstring="\(co"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * registered sign --&gt;\r
  &lt;ss:substitution oldstring="&#174;" newstring="\(rg"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * ...servicemark... --&gt;\r
  &lt;!-- * There is no groff equivalent for it. --&gt;\r
  &lt;ss:substitution oldstring="&#8480;" newstring="(SM)"&gt;&lt;/ss:substitution&gt;\r
  &lt;!-- * ...trademark... --&gt;\r
  &lt;!-- * We don't do "\(tm" because for console output, --&gt;\r
  &lt;!-- * groff just renders that as "tm"; that is: --&gt;\r
  &lt;!-- * --&gt;\r
  &lt;!-- *   Product&amp;#x2122; -&gt; Producttm --&gt;\r
  &lt;!-- * --&gt;\r
  &lt;!-- * So we just make it to "(TM)" instead; thus: --&gt;\r
  &lt;!-- * --&gt;\r
  &lt;!-- *   Product&amp;#x2122; -&gt; Product(TM) --&gt;\r
  &lt;ss:substitution oldstring="&#8482;" newstring="(TM)"&gt;&lt;/ss:substitution&gt;\r
\r
&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>The <parameter>man.string.subst.map</parameter> parameter\r
contains <link linkend="map">a map</link> that specifies a set of\r
string substitutions to perform over the entire roff source for each\r
man page, either just before generating final man-page output (that\r
is, before writing man-page files to disk) or, if the value of the\r
<parameter>man.charmap.enabled</parameter> parameter is non-zero,\r
before applying the roff character map.</para>\r
\r
<para>You can use <parameter>man.string.subst.map</parameter> as a\r
&#8220;lightweight&#8221; character map to perform &#8220;essential&#8221; substitutions --\r
that is, substitutions that are <emphasis>always</emphasis> performed,\r
even if the value of the <parameter>man.charmap.enabled</parameter>\r
parameter is zero. For example, you can use it to replace quotation\r
marks or other special characters that are generated by the DocBook\r
XSL stylesheets for a particular locale setting (as opposed to those\r
characters that are actually in source XML documents), or to replace\r
any special characters that may be automatically generated by a\r
particular customization of the DocBook XSL stylesheets.</para>\r
\r
<warning>\r
  <para>Do you not change value of the\r
  <parameter>man.string.subst.map</parameter> parameter unless you are\r
  sure what you are doing. First consider adding your\r
  string-substitution mappings to either or both of the following\r
  parameters:\r
  <variablelist>\r
    <varlistentry>\r
      <term><parameter>man.string.subst.map.local.pre</parameter></term>\r
      <listitem><para>applied before\r
      <parameter>man.string.subst.map</parameter></para></listitem>\r
    </varlistentry>\r
    <varlistentry>\r
      <term><parameter>man.string.subst.map.local.post</parameter></term>\r
      <listitem><para>applied after\r
      <parameter>man.string.subst.map</parameter></para></listitem>\r
    </varlistentry>\r
  </variablelist>\r
  By default, both of those parameters contain no\r
  string substitutions. They are intended as a means for you to\r
  specify your own local string-substitution mappings.</para>\r
\r
  <para>If you remove any of default mappings from the value of the\r
  <parameter>man.string.subst.map</parameter> parameter, you are\r
  likely to end up with broken output. And be very careful about adding\r
  anything to it; it&#8217;s used for doing string substitution over the\r
  entire roff source of each man page &#8211; it causes target strings to be\r
  replaced in roff requests and escapes, not just in the visible\r
  contents of the page.</para>\r
\r
</warning>\r
\r
<refsection xml:id="map">\r
  <info>\r
    <title>Contents of the substitution map</title>\r
  </info>\r
  <para>The string-substitution map contains one or more\r
  <tag>ss:substitution</tag> elements, each of which has two\r
  attributes:\r
  <variablelist>\r
    <varlistentry>\r
      <term>oldstring</term>\r
      <listitem>\r
        <simpara>string to replace</simpara>\r
      </listitem>\r
    </varlistentry>\r
    <varlistentry>\r
      <term>newstring</term>\r
      <listitem>\r
        <simpara>string with which to replace <tag class="attribute">oldstring</tag></simpara>\r
      </listitem>\r
    </varlistentry>\r
  </variablelist>\r
  It may also include XML comments (that is, delimited with\r
  "<literal>&lt;!--</literal>" and "<literal>--&gt;</literal>").\r
  </para>\r
</refsection>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.string.subst.map.local.post">\r
<refmeta>\r
<refentrytitle>man.string.subst.map.local.post</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.string.subst.map.local.post</refname>\r
<refpurpose>Specifies &#8220;local&#8221; string substitutions</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.string.subst.map.local.post.frag">\r
&lt;xsl:param name="man.string.subst.map.local.post"&gt;&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>Use the <parameter>man.string.subst.map.local.post</parameter>\r
parameter to specify any &#8220;local&#8221; string substitutions to perform over\r
the entire roff source for each man page <emphasis>after</emphasis>\r
performing the string substitutions specified by the <parameter>man.string.subst.map</parameter> parameter.</para>\r
\r
<para>For details about the format of this parameter, see the\r
documentation for the <parameter>man.string.subst.map</parameter>\r
parameter.</para>\r
\r
</refsection>\r
</refentry>\r
\r
  </reference>\r
  <reference xml:id="refmeta">\r
  <title>Refentry metadata gathering</title>\r
<refentry version="5.0" xml:id="refentry.meta.get.quietly">\r
<refmeta>\r
<refentrytitle>refentry.meta.get.quietly</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>refentry.meta.get.quietly</refname>\r
<refpurpose>Suppress notes and warnings when gathering refentry metadata?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="refentry.meta.get.quietly.frag">\r
&lt;xsl:param name="refentry.meta.get.quietly" select="0"&gt;&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If zero (the default), notes and warnings about &#8220;missing&#8221; markup\r
are generated during gathering of refentry metadata. If non-zero, the\r
metadata is gathered &#8220;quietly&#8221; -- that is, the notes and warnings are\r
suppressed.</para>\r
\r
<tip>\r
  <para>If you are processing a large amount of <tag>refentry</tag>\r
  content, you may be able to speed up processing significantly by\r
  setting a non-zero value for\r
  <parameter>refentry.meta.get.quietly</parameter>.</para>\r
</tip>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="refentry.date.profile">\r
<refmeta>\r
<refentrytitle>refentry.date.profile</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>refentry.date.profile</refname>\r
<refpurpose>Specifies profile for refentry "date" data</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="refentry.date.profile.frag">\r
&lt;xsl:param name="refentry.date.profile"&gt;\r
  (($info[//date])[last()]/date)[1]|\r
  (($info[//pubdate])[last()]/pubdate)[1]\r
&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>The value of <parameter>refentry.date.profile</parameter> is a\r
string representing an XPath expression. It is evaluated at run-time\r
and used only if <parameter>refentry.date.profile.enabled</parameter>\r
is non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering\r
logic "hard coded" into the stylesheets is used.</para>\r
\r
<para> The <literal>man(7)</literal> man page describes this content\r
as "the date of the last revision". In man pages, it is the content\r
that is usually displayed in the center footer.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="refentry.date.profile.enabled">\r
<refmeta>\r
<refentrytitle>refentry.date.profile.enabled</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>refentry.date.profile.enabled</refname>\r
<refpurpose>Enable refentry "date" profiling?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="refentry.date.profile.enabled.frag">\r
&lt;xsl:param name="refentry.date.profile.enabled"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of\r
<parameter>refentry.date.profile.enabled</parameter> is non-zero, then\r
during <tag>refentry</tag> metadata gathering, the info profile\r
specified by the customizable\r
<parameter>refentry.date.profile</parameter> parameter is used.</para>\r
\r
<para>If instead the value of\r
<parameter>refentry.date.profile.enabled</parameter> is zero (the\r
default), then "hard coded" logic within the DocBook XSL stylesheets\r
is used for gathering <tag>refentry</tag> "date" data.</para>\r
\r
<para>If you find that the default <tag>refentry</tag>\r
metadata-gathering behavior is causing incorrect "date" data to show\r
up in your output, then consider setting a non-zero value for\r
<parameter>refentry.date.profile.enabled</parameter> and adjusting the\r
value of <parameter>refentry.date.profile</parameter> to cause correct\r
data to be gathered. </para>\r
\r
<para>Note that the terms "source" and "date" have special meanings in\r
this context. For details, see the documentation for the\r
<parameter>refentry.date.profile</parameter> parameter.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="refentry.manual.profile">\r
<refmeta>\r
<refentrytitle>refentry.manual.profile</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>refentry.manual.profile</refname>\r
<refpurpose>Specifies profile for refentry "manual" data</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="refentry.manual.profile.frag">\r
&lt;xsl:param name="refentry.manual.profile"&gt;\r
  (($info[//title])[last()]/title)[1]|\r
  ../title/node()\r
&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>The value of <parameter>refentry.manual.profile</parameter> is\r
a string representing an XPath expression. It is evaluated at\r
run-time and used only if\r
<parameter>refentry.manual.profile.enabled</parameter> is\r
non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic\r
"hard coded" into the stylesheets is used.</para>\r
\r
<para>In man pages, this content is usually displayed in the middle of\r
the header of the page. The <literal>man(7)</literal> man page\r
describes this as "the title of the manual (e.g., <citetitle>Linux\r
Programmer's Manual</citetitle>)". Here are some examples from\r
existing man pages:\r
<itemizedlist>\r
  <listitem>\r
    <para><citetitle>dpkg utilities</citetitle>\r
    (<command>dpkg-name</command>)</para>\r
  </listitem>\r
  <listitem>\r
    <para><citetitle>User Contributed Perl Documentation</citetitle>\r
    (<command>GET</command>)</para>\r
  </listitem>\r
  <listitem>\r
    <para><citetitle>GNU Development Tools</citetitle>\r
    (<command>ld</command>)</para>\r
  </listitem>\r
  <listitem>\r
    <para><citetitle>Emperor Norton Utilities</citetitle>\r
    (<command>ddate</command>)</para>\r
  </listitem>\r
  <listitem>\r
    <para><citetitle>Debian GNU/Linux manual</citetitle>\r
    (<command>faked</command>)</para>\r
  </listitem>\r
  <listitem>\r
    <para><citetitle>GIMP Manual Pages</citetitle>\r
    (<command>gimp</command>)</para>\r
  </listitem>\r
  <listitem>\r
    <para><citetitle>KDOC Documentation System</citetitle>\r
    (<command>qt2kdoc</command>)</para>\r
  </listitem>\r
</itemizedlist>\r
</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="refentry.manual.profile.enabled">\r
<refmeta>\r
<refentrytitle>refentry.manual.profile.enabled</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>refentry.manual.profile.enabled</refname>\r
<refpurpose>Enable refentry "manual" profiling?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="refentry.manual.profile.enabled.frag">\r
&lt;xsl:param name="refentry.manual.profile.enabled"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of\r
<parameter>refentry.manual.profile.enabled</parameter> is\r
non-zero, then during <tag>refentry</tag> metadata gathering, the info\r
profile specified by the customizable\r
<parameter>refentry.manual.profile</parameter> parameter is\r
used.</para>\r
\r
<para>If instead the value of\r
<parameter>refentry.manual.profile.enabled</parameter> is zero (the\r
default), then "hard coded" logic within the DocBook XSL stylesheets\r
is used for gathering <tag>refentry</tag> "manual" data.</para>\r
\r
<para>If you find that the default <tag>refentry</tag>\r
metadata-gathering behavior is causing incorrect "manual" data to show\r
up in your output, then consider setting a non-zero value for\r
<parameter>refentry.manual.profile.enabled</parameter> and adjusting\r
the value of <parameter>refentry.manual.profile</parameter> to cause\r
correct data to be gathered. </para>\r
\r
<para>Note that the term "manual" has a special meanings in this\r
context. For details, see the documentation for the\r
<parameter>refentry.manual.profile</parameter> parameter.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="refentry.source.name.suppress">\r
<refmeta>\r
<refentrytitle>refentry.source.name.suppress</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>refentry.source.name.suppress</refname>\r
<refpurpose>Suppress "name" part of refentry "source" contents?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="refentry.source.name.suppress.frag">\r
&lt;xsl:param name="refentry.source.name.suppress"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of\r
<parameter>refentry.source.name.suppress</parameter> is non-zero, then\r
during <tag>refentry</tag> metadata gathering, no "source name" data\r
is added to the <tag>refentry</tag> "source" contents. Instead (unless\r
<parameter>refentry.version.suppress</parameter> is also non-zero),\r
only "version" data is added to the "source" contents.</para>\r
\r
<para>If you find that the <tag>refentry</tag> metadata gathering\r
mechanism is causing unwanted "source name" data to show up in your\r
output -- for example, in the footer (or possibly header) of a man\r
page -- then you might consider setting a non-zero value for\r
<parameter>refentry.source.name.suppress</parameter>.</para>\r
\r
<para>Note that the terms "source", "source name", and "version" have\r
special meanings in this context. For details, see the documentation\r
for the <parameter>refentry.source.name.profile</parameter>\r
parameter.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="refentry.source.name.profile">\r
<refmeta>\r
<refentrytitle>refentry.source.name.profile</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>refentry.source.name.profile</refname>\r
<refpurpose>Specifies profile for refentry "source name" data</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="refentry.source.name.profile.frag">\r
&lt;xsl:param name="refentry.source.name.profile"&gt;\r
  (($info[//productname])[last()]/productname)[1]|\r
  (($info[//corpname])[last()]/corpname)[1]|\r
  (($info[//corpcredit])[last()]/corpcredit)[1]|\r
  (($info[//corpauthor])[last()]/corpauthor)[1]|\r
  (($info[//orgname])[last()]/orgname)[1]|\r
  (($info[//publishername])[last()]/publishername)[1]\r
&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>The value of <parameter>refentry.source.name.profile</parameter>\r
is a string representing an XPath expression. It is evaluated at\r
run-time and used only if\r
<parameter>refentry.source.name.profile.enabled</parameter> is\r
non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic\r
"hard coded" into the stylesheets is used.</para>\r
\r
<para>A "source name" is one part of a (potentially) two-part\r
<replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>\r
"source" field. In man pages, it is usually displayed in the left\r
footer of the page. It typically indicates the software system or\r
product that the item documented in the man page belongs to. The\r
<literal>man(7)</literal> man page describes it as "the source of\r
the command", and provides the following examples:\r
<itemizedlist>\r
  <listitem>\r
    <para>For binaries, use something like: GNU, NET-2, SLS\r
    Distribution, MCC Distribution.</para>\r
  </listitem>\r
  <listitem>\r
    <para>For system calls, use the version of the kernel that you\r
    are currently looking at: Linux 0.99.11.</para>\r
  </listitem>\r
  <listitem>\r
    <para>For library calls, use the source of the function: GNU, BSD\r
    4.3, Linux DLL 4.4.1.</para>\r
  </listitem>\r
</itemizedlist>\r
</para>\r
\r
<para>In practice, there are many pages that simply have a Version\r
number in the "source" field. So, it looks like what we have is a\r
two-part field,\r
<replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>,\r
where:\r
<variablelist>\r
  <varlistentry>\r
    <term>Name</term>\r
    <listitem>\r
      <para>product name (e.g., BSD) or org. name (e.g., GNU)</para>\r
    </listitem>\r
  </varlistentry>\r
  <varlistentry>\r
    <term>Version</term>\r
    <listitem>\r
      <para>version number</para>\r
    </listitem>\r
  </varlistentry>\r
</variablelist>\r
Each part is optional. If the <replaceable>Name</replaceable> is a\r
product name, then the <replaceable>Version</replaceable> is probably\r
the version of the product. Or there may be no\r
<replaceable>Name</replaceable>, in which case, if there is a\r
<replaceable>Version</replaceable>, it is probably the version\r
of the item itself, not the product it is part of. Or, if the\r
<replaceable>Name</replaceable> is an organization name, then there\r
probably will be no <replaceable>Version</replaceable>.</para>\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="refentry.source.name.profile.enabled">\r
<refmeta>\r
<refentrytitle>refentry.source.name.profile.enabled</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>refentry.source.name.profile.enabled</refname>\r
<refpurpose>Enable refentry "source name" profiling?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="refentry.source.name.profile.enabled.frag">\r
&lt;xsl:param name="refentry.source.name.profile.enabled"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of\r
<parameter>refentry.source.name.profile.enabled</parameter> is\r
non-zero, then during <tag>refentry</tag> metadata gathering, the info\r
profile specified by the customizable\r
<parameter>refentry.source.name.profile</parameter> parameter is\r
used.</para>\r
\r
<para>If instead the value of\r
<parameter>refentry.source.name.profile.enabled</parameter> is zero (the\r
default), then "hard coded" logic within the DocBook XSL stylesheets\r
is used for gathering <tag>refentry</tag> "source name" data.</para>\r
\r
<para>If you find that the default <tag>refentry</tag>\r
metadata-gathering behavior is causing incorrect "source name" data to\r
show up in your output, then consider setting a non-zero value for\r
<parameter>refentry.source.name.profile.enabled</parameter> and\r
adjusting the value of\r
<parameter>refentry.source.name.profile</parameter> to cause correct\r
data to be gathered. </para>\r
\r
<para>Note that the terms "source" and "source name" have special\r
meanings in this context. For details, see the documentation for the\r
<parameter>refentry.source.name.profile</parameter> parameter.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="refentry.version.suppress">\r
<refmeta>\r
<refentrytitle>refentry.version.suppress</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>refentry.version.suppress</refname>\r
<refpurpose>Suppress "version" part of refentry "source" contents?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="refentry.version.suppress.frag">\r
&lt;xsl:param name="refentry.version.suppress"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of <parameter>refentry.version.suppress</parameter>\r
is non-zero, then during <tag>refentry</tag> metadata gathering, no\r
"version" data is added to the <tag>refentry</tag> "source"\r
contents. Instead (unless\r
<parameter>refentry.source.name.suppress</parameter> is also\r
non-zero), only "source name" data is added to the "source"\r
contents.</para>\r
\r
<para>If you find that the <tag>refentry</tag> metadata gathering\r
mechanism is causing unwanted "version" data to show up in your output\r
-- for example, in the footer (or possibly header) of a man page --\r
then you might consider setting a non-zero value for\r
<parameter>refentry.version.suppress</parameter>.</para>\r
\r
<para>Note that the terms "source", "source name", and "version" have\r
special meanings in this context. For details, see the documentation\r
for the <parameter>refentry.source.name.profile</parameter>\r
parameter.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="refentry.version.profile">\r
<refmeta>\r
<refentrytitle>refentry.version.profile</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>refentry.version.profile</refname>\r
<refpurpose>Specifies profile for refentry "version" data</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="refentry.version.profile.frag">\r
&lt;xsl:param name="refentry.version.profile"&gt;\r
  (($info[//productnumber])[last()]/productnumber)[1]|\r
  (($info[//edition])[last()]/edition)[1]|\r
  (($info[//releaseinfo])[last()]/releaseinfo)[1]\r
&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>The value of <parameter>refentry.version.profile</parameter> is\r
a string representing an XPath expression. It is evaluated at\r
run-time and used only if\r
<parameter>refentry.version.profile.enabled</parameter> is\r
non-zero. Otherwise, the <tag>refentry</tag> metadata-gathering logic\r
"hard coded" into the stylesheets is used.</para>\r
\r
<para>A "source.name" is one part of a (potentially) two-part\r
<replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>\r
"source" field. For more details, see the documentation for the\r
<parameter>refentry.source.name.profile</parameter> parameter.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="refentry.version.profile.enabled">\r
<refmeta>\r
<refentrytitle>refentry.version.profile.enabled</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>refentry.version.profile.enabled</refname>\r
<refpurpose>Enable refentry "version" profiling?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="refentry.version.profile.enabled.frag">\r
&lt;xsl:param name="refentry.version.profile.enabled"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of\r
<parameter>refentry.version.profile.enabled</parameter> is\r
non-zero, then during <tag>refentry</tag> metadata gathering, the info\r
profile specified by the customizable\r
<parameter>refentry.version.profile</parameter> parameter is\r
used.</para>\r
\r
<para>If instead the value of\r
<parameter>refentry.version.profile.enabled</parameter> is zero (the\r
default), then "hard coded" logic within the DocBook XSL stylesheets\r
is used for gathering <tag>refentry</tag> "version" data.</para>\r
\r
<para>If you find that the default <tag>refentry</tag>\r
metadata-gathering behavior is causing incorrect "version" data to show\r
up in your output, then consider setting a non-zero value for\r
<parameter>refentry.version.profile.enabled</parameter> and adjusting\r
the value of <parameter>refentry.version.profile</parameter> to cause\r
correct data to be gathered. </para>\r
\r
<para>Note that the terms "source" and "version" have special\r
meanings in this context. For details, see the documentation for the\r
<parameter>refentry.version.profile</parameter> parameter.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="refentry.manual.fallback.profile">\r
<refmeta>\r
<refentrytitle>refentry.manual.fallback.profile</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>refentry.manual.fallback.profile</refname>\r
<refpurpose>Specifies profile of "fallback" for refentry "manual" data</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="refentry.manual.fallback.profile.frag">\r
&lt;xsl:param name="refentry.manual.fallback.profile"&gt;\r
refmeta/refmiscinfo[not(@class = 'date')][1]/node()&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>The value of\r
<parameter>refentry.manual.fallback.profile</parameter> is a string\r
representing an XPath expression. It is evaluated at run-time and\r
used only if no "manual" data can be found by other means (that is,\r
either using the <tag>refentry</tag> metadata-gathering logic "hard\r
coded" in the stylesheets, or the value of\r
<parameter>refentry.manual.profile</parameter>, if it is\r
enabled).</para>\r
\r
<important>\r
<para>Depending on which XSLT engine you run, either the EXSLT\r
<function>dyn:evaluate</function> extension function (for xsltproc or\r
Xalan) or <function>saxon:evaluate</function> extension function (for\r
Saxon) are used to dynamically evaluate the value of\r
<parameter>refentry.manual.fallback.profile</parameter> at\r
run-time. If you don't use xsltproc, Saxon, Xalan -- or some other\r
XSLT engine that supports <function>dyn:evaluate</function> -- you\r
must manually disable fallback processing by setting an empty value\r
for the <parameter>refentry.manual.fallback.profile</parameter>\r
parameter.</para>\r
</important>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="refentry.source.fallback.profile">\r
<refmeta>\r
<refentrytitle>refentry.source.fallback.profile</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>refentry.source.fallback.profile</refname>\r
<refpurpose>Specifies profile of "fallback" for refentry "source" data</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="refentry.source.fallback.profile.frag">\r
&lt;xsl:param name="refentry.source.fallback.profile"&gt;\r
refmeta/refmiscinfo[not(@class = 'date')][1]/node()&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>The value of\r
<parameter>refentry.source.fallback.profile</parameter> is a string\r
representing an XPath expression. It is evaluated at run-time and used\r
only if no "source" data can be found by other means (that is, either\r
using the <tag>refentry</tag> metadata-gathering logic "hard coded" in\r
the stylesheets, or the value of the\r
<parameter>refentry.source.name.profile</parameter> and\r
<parameter>refentry.version.profile</parameter> parameters, if those\r
are enabled).</para>\r
\r
<important>\r
<para>Depending on which XSLT engine you run, either the EXSLT\r
<function>dyn:evaluate</function> extension function (for xsltproc or\r
Xalan) or <function>saxon:evaluate</function> extension function (for\r
Saxon) are used to dynamically evaluate the value of\r
<parameter>refentry.source.fallback.profile</parameter> at\r
run-time. If you don't use xsltproc, Saxon, Xalan -- or some other\r
XSLT engine that supports <function>dyn:evaluate</function> -- you\r
must manually disable fallback processing by setting an empty value\r
for the <parameter>refentry.source.fallback.profile</parameter>\r
parameter.</para>\r
</important>\r
\r
</refsection>\r
</refentry>\r
\r
  </reference>\r
  <reference xml:id="th">\r
  <title>Page header/footer</title>\r
<refentry version="5.0" xml:id="man.th.extra1.suppress">\r
<refmeta>\r
<refentrytitle>man.th.extra1.suppress</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.th.extra1.suppress</refname>\r
<refpurpose>Suppress extra1 part of header/footer?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.th.extra1.suppress.frag">\r
&lt;xsl:param name="man.th.extra1.suppress"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of <parameter>man.th.extra1.suppress</parameter> is\r
non-zero, then the <literal>extra1</literal> part of the\r
<literal>.TH</literal> title line header/footer is suppressed.</para>\r
\r
<para>The content of the <literal>extra1</literal> field is almost\r
always displayed in the center footer of the page and is, universally,\r
a date.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.th.extra2.suppress">\r
<refmeta>\r
<refentrytitle>man.th.extra2.suppress</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.th.extra2.suppress</refname>\r
<refpurpose>Suppress extra2 part of header/footer?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.th.extra2.suppress.frag">\r
&lt;xsl:param name="man.th.extra2.suppress"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of <parameter>man.th.extra2.suppress</parameter> is\r
non-zero, then the <literal>extra2</literal> part of the\r
<literal>.TH</literal> title line header/footer is suppressed.</para>\r
\r
<para>The content of the <literal>extra2</literal> field is usually\r
displayed in the left footer of the page and is typically "source"\r
data, often in the form\r
<replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>;\r
for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal>\r
man page).</para>\r
\r
<note>\r
  <para>You can use the\r
  <parameter>refentry.source.name.suppress</parameter> and\r
  <parameter>refentry.version.suppress</parameter> parameters to\r
  independently suppress the <replaceable>Name</replaceable> and\r
  <replaceable>Version</replaceable> parts of the\r
  <literal>extra2</literal> field.</para>\r
</note>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.th.extra3.suppress">\r
<refmeta>\r
<refentrytitle>man.th.extra3.suppress</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.th.extra3.suppress</refname>\r
<refpurpose>Suppress extra3 part of header/footer?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.th.extra3.suppress.frag">\r
&lt;xsl:param name="man.th.extra3.suppress"&gt;0&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of <parameter>man.th.extra3.suppress</parameter> is\r
non-zero, then the <literal>extra3</literal> part of the\r
<literal>.TH</literal> title line header/footer is\r
suppressed.</para>\r
\r
<para>The content of the <literal>extra3</literal> field is usually\r
displayed in the middle header of the page and is typically a "manual\r
name"; for example, "GTK+ User's Manual" (from the\r
<literal>gtk-options(7)</literal> man page).</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.th.title.max.length">\r
<refmeta>\r
<refentrytitle>man.th.title.max.length</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.th.title.max.length</refname>\r
<refpurpose>Maximum length of title in header/footer</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.th.title.max.length.frag">\r
&lt;xsl:param name="man.th.title.max.length"&gt;20&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>Specifies the maximum permitted length of the title part of the\r
man-page <literal>.TH</literal> title line header/footer. If the title\r
exceeds the maxiumum specified, it is truncated down to the maximum\r
permitted length.</para>\r
\r
<refsection><info><title>Details</title></info>\r
  \r
\r
<para>Every man page generated using the DocBook stylesheets has a\r
title line, specified using the <literal>TH</literal> roff\r
macro. Within that title line, there is always, at a minimum, a title,\r
followed by a section value (representing a man "section" -- usually\r
just a number).</para>\r
\r
<para>The title and section are displayed, together, in the visible\r
header of each page. Where in the header they are displayed depends on\r
OS the man page is viewed on, and on what version of nroff/groff/man\r
is used for viewing the page. But, at a minimum and across all\r
systems, the title and section are displayed on the right-hand column\r
of the header. On many systems -- those with a modern groff, including\r
Linux systems -- they are displayed twice: both in the left and right\r
columns of the header.</para>\r
\r
<para>So if the length of the title exceeds a certain percentage of\r
the column width in which the page is viewed, the left and right\r
titles can end up overlapping, making them unreadable, or breaking to\r
another line, which doesn't look particularly good.</para>\r
\r
<para>So the stylesheets provide the\r
<parameter>man.th.title.max.length</parameter> parameter as a means\r
for truncating titles that exceed the maximum length that can be\r
viewing properly in a page header.</para>\r
\r
<para>The default value is reasonable but somewhat arbitrary. If you\r
have pages with long titles, you may want to experiment with changing\r
the value in order to achieve the correct aesthetic results.</para>\r
</refsection>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.th.extra2.max.length">\r
<refmeta>\r
<refentrytitle>man.th.extra2.max.length</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.th.extra2.max.length</refname>\r
<refpurpose>Maximum length of extra2 in header/footer</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.th.extra2.max.length.frag">\r
&lt;xsl:param name="man.th.extra2.max.length"&gt;30&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>Specifies the maximum permitted length of the\r
<literal>extra2</literal> part of the man-page part of the\r
<literal>.TH</literal> title line header/footer. If the\r
<literal>extra2</literal> content exceeds the maxiumum specified, it\r
is truncated down to the maximum permitted length.</para>\r
\r
<para>The content of the <literal>extra2</literal> field is usually\r
displayed in the left footer of the page and is typically "source"\r
data indicating the software system or product that the item\r
documented in the man page belongs to, often in the form\r
<replaceable>Name</replaceable>&#160;<replaceable>Version</replaceable>;\r
for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal>\r
man page).</para>\r
\r
<para>The default value for this parameter is reasonable but somewhat\r
arbitrary. If you are processing pages with long "source" information,\r
you may want to experiment with changing the value in order to achieve\r
the correct aesthetic results.</para>\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.th.extra3.max.length">\r
<refmeta>\r
<refentrytitle>man.th.extra3.max.length</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.th.extra3.max.length</refname>\r
<refpurpose>Maximum length of extra3 in header/footer</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.th.extra3.max.length.frag">\r
&lt;xsl:param name="man.th.extra3.max.length"&gt;30&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>Specifies the maximum permitted length of the\r
<literal>extra3</literal> part of the man-page <literal>.TH</literal>\r
title line header/footer. If the <literal>extra3</literal> content\r
exceeds the maxiumum specified, it is truncated down to the maximum\r
permitted length.</para>\r
\r
<para>The content of the <literal>extra3</literal> field is usually\r
displayed in the middle header of the page and is typically a "manual\r
name"; for example, "GTK+ User's Manual" (from the\r
<literal>gtk-options(7)</literal> man page).</para>\r
\r
<para>The default value for this parameter is reasonable but somewhat\r
arbitrary. If you are processing pages with long "manual names" -- or\r
especially if you are processing pages that have both long "title"\r
parts (command/function, etc. names) <emphasis>and</emphasis> long\r
manual names -- you may want to experiment with changing the value in\r
order to achieve the correct aesthetic results.</para>\r
</refsection>\r
</refentry>\r
\r
  </reference>\r
  <reference xml:id="output">\r
  <title>Output</title>\r
<refentry version="5.0" xml:id="man.output.manifest.enabled">\r
  <refmeta>\r
    <refentrytitle>man.output.manifest.enabled</refentrytitle>\r
    <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
  </refmeta>\r
  <refnamediv>\r
    <refname>man.output.manifest.enabled</refname>\r
    <refpurpose>Generate a manifest file?</refpurpose>\r
  </refnamediv>\r
\r
  <refsynopsisdiv>\r
    <programlisting xml:id="man.output.manifest.enabled.frag">&lt;xsl:param name="man.output.manifest.enabled" select="0"&gt;&lt;/xsl:param&gt;</programlisting>\r
  </refsynopsisdiv>\r
\r
  <refsection><info><title>Description</title></info>\r
\r
    <para>If non-zero, a list of filenames for man pages generated by\r
    the stylesheet transformation is written to the file named by the\r
    <parameter>man.output.manifest.filename</parameter> parameter.</para>\r
\r
  </refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.output.manifest.filename">\r
  <refmeta>\r
    <refentrytitle>man.output.manifest.filename</refentrytitle>\r
    <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
  </refmeta>\r
  <refnamediv>\r
    <refname>man.output.manifest.filename</refname>\r
    <refpurpose>Name of manifest file</refpurpose>\r
  </refnamediv>\r
\r
  <refsynopsisdiv>\r
    <programlisting xml:id="man.output.manifest.filename.frag">&lt;xsl:param name="man.output.manifest.filename"&gt;MAN.MANIFEST&lt;/xsl:param&gt;</programlisting>\r
  </refsynopsisdiv>\r
\r
  <refsection><info><title>Description</title></info>\r
\r
    <para>The <parameter>man.output.manifest.filename</parameter> parameter\r
    specifies the name of the file to which the manpages manifest file\r
    is written (if the value of the\r
    <parameter>man.output.manifest.enabled</parameter> parameter is\r
    non-zero).</para>\r
\r
  </refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.output.in.separate.dir">\r
<refmeta>\r
<refentrytitle>man.output.in.separate.dir</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.output.in.separate.dir</refname>\r
<refpurpose>Output man-page files in separate output directory?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.output.in.separate.dir.frag">\r
&lt;xsl:param name="man.output.in.separate.dir" select="0"&gt;&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of <literal>man.output.in.separate.dir</literal>\r
parameter is non-zero, man-page files are output in a separate\r
directory, specified by the <parameter>man.output.base.dir</parameter>\r
parameter; otherwise, if the value of\r
<literal>man.output.in.separate.dir</literal> is zero, man-page files\r
are not output in a separate directory.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.output.lang.in.name.enabled">\r
<refmeta>\r
<refentrytitle>man.output.lang.in.name.enabled</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.output.lang.in.name.enabled</refname>\r
<refpurpose>Include $LANG value in man-page filename/pathname?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.output.lang.in.name.enabled.frag">\r
&lt;xsl:param name="man.output.lang.in.name.enabled" select="0"&gt;&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
  <para>The <parameter>man.output.lang.in.name.enabled</parameter>\r
  parameter specifies whether a <literal>$lang</literal> value is\r
  included in man-page filenames and pathnames.</para>\r
\r
  <para>If the value of\r
  <parameter>man.output.lang.in.name.enabled</parameter> is non-zero,\r
  man-page files are output with the <literal>$lang</literal> value\r
  included in their filenames or pathnames as follows;\r
\r
  <itemizedlist>\r
    <listitem>\r
      <para>if <parameter>man.output.subdirs.enabled</parameter> is\r
      non-zero, each file is output to, e.g., a\r
      <filename>man/<replaceable>$lang</replaceable>/man8/foo.8</filename>\r
      pathname</para>\r
    </listitem>\r
    <listitem>\r
      <para>if <parameter>man.output.subdirs.enabled</parameter> is\r
      zero, each file is output with a\r
      <literal>foo.<replaceable>$lang</replaceable>.8</literal>\r
      filename</para>\r
    </listitem>\r
  </itemizedlist>\r
  </para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.output.base.dir">\r
<refmeta>\r
<refentrytitle>man.output.base.dir</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.output.base.dir</refname>\r
<refpurpose>Specifies separate output directory</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.output.base.dir.frag">&lt;xsl:param name="man.output.base.dir"&gt;man/&lt;/xsl:param&gt;</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>The <parameter>man.output.base.dir</parameter> parameter\r
specifies the base directory into which man-page files are output. The\r
<parameter>man.output.subdirs.enabled</parameter> parameter controls\r
whether the files are output in subdirectories within the base\r
directory.</para>\r
\r
<note>\r
  <para>The values of the <parameter>man.output.base.dir</parameter>\r
  and <parameter>man.output.subdirs.enabled</parameter> parameters are\r
  used only if the value of\r
  <parameter>man.output.in.separate.dir</parameter> parameter is\r
  non-zero. If the value of the\r
  <parameter>man.output.in.separate.dir</parameter> is zero, man-page\r
  files are not output in a separate directory.</para>\r
</note>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.output.subdirs.enabled">\r
<refmeta>\r
<refentrytitle>man.output.subdirs.enabled</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.output.subdirs.enabled</refname>\r
<refpurpose>Output man-page files in subdirectories within base output directory?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.output.subdirs.enabled.frag">\r
&lt;xsl:param name="man.output.subdirs.enabled" select="1"&gt;&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>The <parameter>man.output.subdirs.enabled</parameter> parameter\r
controls whether man-pages files are output in subdirectories within\r
the base directory specified by the directory specified by the\r
<parameter>man.output.base.dir</parameter> parameter.</para>\r
\r
<note>\r
  <para>The values of the <parameter>man.output.base.dir</parameter>\r
  and <parameter>man.output.subdirs.enabled</parameter> parameters are\r
  used only if the value of\r
  <parameter>man.output.in.separate.dir</parameter> parameter is\r
  non-zero. If the value of the\r
  <parameter>man.output.in.separate.dir</parameter> is zero, man-page\r
  files are not output in a separate directory.</para>\r
</note>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.output.quietly">\r
<refmeta>\r
<refentrytitle>man.output.quietly</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.output.quietly</refname>\r
<refpurpose>Suppress filename messages emitted when generating output?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.output.quietly.frag">\r
&lt;xsl:param name="man.output.quietly" select="0"&gt;&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If zero (the default), for each man-page file created, a message\r
with the name of the file is emitted. If non-zero, the files are\r
output "quietly" -- that is, the filename messages are\r
suppressed.</para>\r
\r
<tip>\r
  <para>If you are processing a large amount of <tag>refentry</tag>\r
  content, you may be able to speed up processing significantly by\r
  setting a non-zero value for\r
  <parameter>man.output.quietly</parameter>.</para>\r
</tip>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.output.encoding">\r
<refmeta>\r
<refentrytitle>man.output.encoding</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.output.encoding</refname>\r
<refpurpose>Encoding used for man-page output</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.output.encoding.frag">\r
&lt;xsl:param name="man.output.encoding"&gt;UTF-8&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>This parameter specifies the encoding to use for files generated\r
by the manpages stylesheet. Not all processors support specification\r
of this parameter.</para>\r
\r
<important>\r
  <para>If the value of the <parameter>man.charmap.enabled</parameter>\r
  parameter is non-zero (the default), keeping the\r
  <parameter>man.output.encoding</parameter> parameter at its default\r
  value (<literal>UTF-8</literal>) or setting it to\r
  <literal>UTF-16</literal> <emphasis role="bold">does not cause your\r
  man pages to be output in raw UTF-8 or UTF-16</emphasis> -- because\r
  any Unicode characters for which matches are found in the enabled\r
  character map will be replaced with roff escape sequences before the\r
  final man-page files are generated.</para>\r
\r
  <para>So if you want to generate "real" UTF-8 man pages, without any\r
  character substitution being performed on your content, you need to\r
  set <parameter>man.charmap.enabled</parameter> to zero (which will\r
  completely disable character-map processing). </para>\r
\r
  <para>You may also need to set\r
  <parameter>man.charmap.enabled</parameter> to zero if you want to\r
  output man pages in an encoding other than <literal>UTF-8</literal>\r
  or <literal>UTF-16</literal>. Character-map processing is based on\r
  Unicode character values and may not work with other output\r
  encodings.</para>\r
</important>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.output.better.ps.enabled">\r
<refmeta>\r
<refentrytitle>man.output.better.ps.enabled</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.output.better.ps.enabled</refname>\r
<refpurpose>Enable enhanced print/PostScript output?</refpurpose>\r
</refnamediv>\r
<refsynopsisdiv>\r
<programlisting xml:id="man.output.better.ps.enabled.frag">\r
&lt;xsl:param name="man.output.better.ps.enabled"&gt;0&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of the\r
<parameter>man.output.better.ps.enabled</parameter> parameter is\r
non-zero, certain markup is embedded in each generated man page\r
such that PostScript output from the <command>man -Tps</command>\r
command for that page will include a number of enhancements\r
designed to improve the quality of that output.</para>\r
\r
<para>If <parameter>man.output.better.ps.enabled</parameter> is\r
zero (the default), no such markup is embedded in generated man\r
pages, and no enhancements are included in the PostScript\r
output generated from those man pages by the <command>man\r
 -Tps</command> command.</para>\r
\r
<warning>\r
  <para>The enhancements provided by this parameter rely on\r
    features that are specific to groff (GNU troff) and that are\r
    not part of &#8220;classic&#8221; AT&amp;T troff or any of its\r
    derivatives. Therefore, any man pages you generate with this\r
    parameter enabled will be readable only on systems on which\r
    the groff (GNU troff) program is installed, such as GNU/Linux\r
    systems. The pages <emphasis role="bold">will not not be\r
      readable on systems on with the classic troff (AT&amp;T\r
      troff) command is installed</emphasis>.</para>\r
</warning>\r
\r
<para>The value of this parameter only affects PostScript output\r
  generated from the <command>man</command> command. It has no\r
  effect on output generated using the FO backend.</para>\r
\r
<tip>\r
  <para>You can generate PostScript output for any man page by\r
    running the following command:</para>\r
  <programlisting>  man <replaceable>FOO</replaceable> -Tps &gt; <replaceable>FOO</replaceable>.ps</programlisting>\r
  <para>You can then generate PDF output by running the following\r
    command:</para>\r
  <programlisting>  ps2pdf <replaceable>FOO</replaceable>.ps</programlisting>\r
</tip>\r
\r
</refsection>\r
</refentry>\r
\r
  </reference>\r
  <reference xml:id="other">\r
  <title>Other</title>\r
<refentry version="5.0" xml:id="man.table.footnotes.divider">\r
<refmeta>\r
<refentrytitle>man.table.footnotes.divider</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.table.footnotes.divider</refname>\r
<refpurpose>Specifies divider string that appears before table footnotes</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.table.footnotes.divider.frag">\r
&lt;xsl:param name="man.table.footnotes.divider"&gt;----&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>In each table that contains footenotes, the string specified by\r
the <parameter>man.table.footnotes.divider</parameter> parameter is\r
output before the list of footnotes for the table.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.subheading.divider.enabled">\r
<refmeta>\r
<refentrytitle>man.subheading.divider.enabled</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.subheading.divider.enabled</refname>\r
<refpurpose>Add divider comment to roff source before/after subheadings?</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.subheading.divider.enabled.frag">\r
&lt;xsl:param name="man.subheading.divider.enabled"&gt;0&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of the\r
<parameter>man.subheading.divider.enabled</parameter> parameter is\r
non-zero, the contents of the\r
<parameter>man.subheading.divider</parameter> parameter are used to\r
add a "divider" before and after subheadings in the roff\r
output. <emphasis role="bold">The divider is not visisble in the\r
rendered man page</emphasis>; it is added as a comment, in the source,\r
simply for the purpose of increasing reability of the source.</para>\r
\r
<para>If <parameter>man.subheading.divider.enabled</parameter> is zero\r
(the default), the subheading divider is suppressed.</para>\r
\r
</refsection>\r
</refentry>\r
\r
<refentry version="5.0" xml:id="man.subheading.divider">\r
<refmeta>\r
<refentrytitle>man.subheading.divider</refentrytitle>\r
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
</refmeta>\r
<refnamediv>\r
<refname>man.subheading.divider</refname>\r
<refpurpose>Specifies string to use as divider comment before/after subheadings</refpurpose>\r
</refnamediv>\r
\r
<refsynopsisdiv>\r
<programlisting xml:id="man.subheading.divider.frag">\r
&lt;xsl:param name="man.subheading.divider"&gt;========================================================================&lt;/xsl:param&gt;\r
</programlisting>\r
</refsynopsisdiv>\r
\r
<refsection><info><title>Description</title></info>\r
\r
<para>If the value of the\r
<parameter>man.subheading.divider.enabled</parameter> parameter is\r
non-zero, the contents of the\r
<parameter>man.subheading.divider</parameter> parameter are used to\r
add a "divider" before and after subheadings in the roff\r
output. <emphasis role="bold">The divider is not visisble in the\r
rendered man page</emphasis>; it is added as a comment, in the source,\r
simply for the purpose of increasing reability of the source.</para>\r
\r
<para>If <parameter>man.subheading.divider.enabled</parameter> is zero\r
(the default), the subheading divider is suppressed.</para>\r
\r
</refsection>\r
</refentry>\r
\r
  </reference>\r
  <appendix xml:id="stylesheet">\r
    <title>The Stylesheet</title>\r
\r
    <para>The <filename>param.xsl</filename> stylesheet is just a\r
    wrapper around all of these parameters.</para>\r
\r
    <programlisting xml:id="top">\r
&lt;xsl:stylesheet exclude-result-prefixes="src" version="1.0"&gt;\r
\r
&lt;!-- This file is generated from param.xweb --&gt;\r
\r
&lt;!-- ********************************************************************\r
     $Id: param.xweb 8235 2009-02-09 16:22:14Z xmldoc $\r
     ********************************************************************\r
\r
     This file is part of the XSL DocBook Stylesheet distribution.\r
     See ../README or http://docbook.sf.net/release/xsl/current/ for\r
     copyright and other information.\r
\r
     ******************************************************************** --&gt;\r
\r
&lt;src:fragref linkend="man.authors.section.enabled.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.break.after.slash.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.base.url.for.relative.links.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.charmap.enabled.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.charmap.subset.profile.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.charmap.subset.profile.english.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.charmap.uri.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.charmap.use.subset.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.copyright.section.enabled.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.endnotes.are.numbered.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.endnotes.list.enabled.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.endnotes.list.heading.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.font.funcprototype.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.font.funcsynopsisinfo.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.font.links.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.font.table.headings.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.font.table.title.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.funcsynopsis.style.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.hyphenate.computer.inlines.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.hyphenate.filenames.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.hyphenate.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.hyphenate.urls.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.indent.blurbs.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.indent.lists.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.indent.refsect.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.indent.verbatims.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.indent.width.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.justify.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.output.base.dir.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.output.encoding.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.output.in.separate.dir.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.output.lang.in.name.enabled.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.output.manifest.enabled.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.output.manifest.filename.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.output.better.ps.enabled.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.output.quietly.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.output.subdirs.enabled.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.segtitle.suppress.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.string.subst.map.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.string.subst.map.local.post.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.string.subst.map.local.pre.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.subheading.divider.enabled.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.subheading.divider.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.table.footnotes.divider.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.th.extra1.suppress.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.th.extra2.max.length.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.th.extra2.suppress.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.th.extra3.max.length.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.th.extra3.suppress.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="man.th.title.max.length.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="refentry.date.profile.enabled.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="refentry.date.profile.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="refentry.manual.fallback.profile.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="refentry.manual.profile.enabled.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="refentry.manual.profile.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="refentry.meta.get.quietly.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="refentry.source.fallback.profile.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="refentry.source.name.profile.enabled.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="refentry.source.name.profile.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="refentry.source.name.suppress.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="refentry.version.profile.enabled.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="refentry.version.profile.frag"&gt;&lt;/src:fragref&gt;\r
&lt;src:fragref linkend="refentry.version.suppress.frag"&gt;&lt;/src:fragref&gt;\r
&lt;/xsl:stylesheet&gt;\r
    </programlisting>\r
\r
  </appendix>\r
</book>\r