man.th.extra2.suppress.xml 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  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.suppress">
  7. <refmeta>
  8. <refentrytitle>man.th.extra2.suppress</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>man.th.extra2.suppress</refname>
  13. <refpurpose>Suppress extra2 part of header/footer?</refpurpose>
  14. </refnamediv>
  15. <refsynopsisdiv>
  16. <src:fragment xml:id="man.th.extra2.suppress.frag">
  17. <xsl:param name="man.th.extra2.suppress">0</xsl:param></src:fragment>
  18. </refsynopsisdiv>
  19. <refsection><info><title>Description</title></info>
  20. <para>If the value of <parameter>man.th.extra2.suppress</parameter> is
  21. non-zero, then the <literal>extra2</literal> part of the
  22. <literal>.TH</literal> title line header/footer is suppressed.</para>
  23. <para>The content of the <literal>extra2</literal> field is usually
  24. displayed in the left footer of the page and is typically "source"
  25. data, often in the form
  26. <replaceable>Name</replaceable> <replaceable>Version</replaceable>;
  27. for example, "GTK+ 1.2" (from the <literal>gtk-options(7)</literal>
  28. man page).</para>
  29. <note>
  30. <para>You can use the
  31. <parameter>refentry.source.name.suppress</parameter> and
  32. <parameter>refentry.version.suppress</parameter> parameters to
  33. independently suppress the <replaceable>Name</replaceable> and
  34. <replaceable>Version</replaceable> parts of the
  35. <literal>extra2</literal> field.</para>
  36. </note>
  37. </refsection>
  38. </refentry>