doc/xslt/params/man.th.extra2.max.length.xml

   1 <refentry xmlns="http://docbook.org/ns/docbook"
   2           xmlns:xlink="http://www.w3.org/1999/xlink"
   3           xmlns:xi="http://www.w3.org/2001/XInclude"
   4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
   5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
   6           version="5.0" xml:id="man.th.extra2.max.length">
   7 <refmeta>
   8 <refentrytitle>man.th.extra2.max.length</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>man.th.extra2.max.length</refname>
  13 <refpurpose>Maximum length of extra2 in header/footer</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17 <src:fragment xml:id="man.th.extra2.max.length.frag">
  18 <xsl:param name="man.th.extra2.max.length">30</xsl:param>
  19 </src:fragment>
  20 </refsynopsisdiv>
  21
  22 <refsection><info><title>Description</title></info>
  23
  24 <para>Specifies the maximum permitted length of the
  25 <literal>extra2</literal> part of the man-page part of the
  26 <literal>.TH</literal> title line header/footer. If the
  27 <literal>extra2</literal> content exceeds the maxiumum specified, it
  28 is truncated down to the maximum permitted length.</para>
  29
  30 <para>The content of the <literal>extra2</literal> field is usually
  31 displayed in the left footer of the page and is typically "source"
  32 data indicating the software system or product that the item
  33 documented in the man page belongs to, often in the form
  34 <replaceable>Name</replaceable> <replaceable>Version</replaceable>;
  35 for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal>
  36 man page).</para>
  37
  38 <para>The default value for this parameter is reasonable but somewhat
  39 arbitrary. If you are processing pages with long "source" information,
  40 you may want to experiment with changing the value in order to achieve
  41 the correct aesthetic results.</para>
  42 </refsection>
  43 </refentry>