man.copyright.section.enabled.xml 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  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.copyright.section.enabled">
  7. <refmeta>
  8. <refentrytitle>man.copyright.section.enabled</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>man.copyright.section.enabled</refname>
  13. <refpurpose>Display auto-generated COPYRIGHT section?</refpurpose>
  14. </refnamediv>
  15. <refsynopsisdiv>
  16. <src:fragment xml:id="man.copyright.section.enabled.frag">
  17. <xsl:param name="man.copyright.section.enabled">1</xsl:param>
  18. </src:fragment>
  19. </refsynopsisdiv>
  20. <refsection><info><title>Description</title></info>
  21. <para>If the value of
  22. <parameter>man.copyright.section.enabled</parameter> is non-zero
  23. (the default), then a <literal>COPYRIGHT</literal> section is
  24. generated near the end of each man page. The output of the
  25. <literal>COPYRIGHT</literal> section is assembled from any
  26. <tag>copyright</tag> and <tag>legalnotice</tag> metadata found in
  27. the contents of the child <tag>info</tag> or
  28. <tag>refentryinfo</tag> (if any) of the <tag>refentry</tag>
  29. itself, or from any <tag>copyright</tag> and
  30. <tag>legalnotice</tag> metadata that may appear in <tag>info</tag>
  31. contents of any ancestors of the <tag>refentry</tag>.</para>
  32. <para>If the value of
  33. <parameter>man.copyright.section.enabled</parameter> is zero, the
  34. the auto-generated <literal>COPYRIGHT</literal> section is
  35. suppressed.</para>
  36. <para>Set the value of
  37. <parameter>man.copyright.section.enabled</parameter> to zero if
  38. you want to have a manually created <literal>COPYRIGHT</literal>
  39. section in your source, and you want it to appear in output
  40. instead of the auto-generated <literal>COPYRIGHT</literal>
  41. section.</para>
  42. </refsection>
  43. </refentry>