stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/man.th.extra2.max.length.xml

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