man.th.extra3.max.length.xml 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  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.extra3.max.length">
  7. <refmeta>
  8. <refentrytitle>man.th.extra3.max.length</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>man.th.extra3.max.length</refname>
  13. <refpurpose>Maximum length of extra3 in header/footer</refpurpose>
  14. </refnamediv>
  15. <refsynopsisdiv>
  16. <src:fragment xml:id="man.th.extra3.max.length.frag">
  17. <xsl:param name="man.th.extra3.max.length">30</xsl:param>
  18. </src:fragment>
  19. </refsynopsisdiv>
  20. <refsection><info><title>Description</title></info>
  21. <para>Specifies the maximum permitted length of the
  22. <literal>extra3</literal> part of the man-page <literal>.TH</literal>
  23. title line header/footer. If the <literal>extra3</literal> content
  24. exceeds the maxiumum specified, it is truncated down to the maximum
  25. permitted length.</para>
  26. <para>The content of the <literal>extra3</literal> field is usually
  27. displayed in the middle header of the page and is typically a "manual
  28. name"; for example, "GTK+ User's Manual" (from the
  29. <literal>gtk-options(7)</literal> man page).</para>
  30. <para>The default value for this parameter is reasonable but somewhat
  31. arbitrary. If you are processing pages with long "manual names" -- or
  32. especially if you are processing pages that have both long "title"
  33. parts (command/function, etc. names) <emphasis>and</emphasis> long
  34. manual names -- you may want to experiment with changing the value in
  35. order to achieve the correct aesthetic results.</para>
  36. </refsection>
  37. </refentry>