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