]> git.stg.codes - stg.git/blob - doc/xslt/params/man.copyright.section.enabled.xml
Added resetable service conf.
[stg.git] / doc / xslt / params / man.copyright.section.enabled.xml
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
22 <para>If the value of
23 <parameter>man.copyright.section.enabled</parameter> is non-zero
24 (the default), then a <literal>COPYRIGHT</literal> section is
25 generated near the end of each man page. The output of the
26 <literal>COPYRIGHT</literal> section is assembled from any
27 <tag>copyright</tag> and <tag>legalnotice</tag> metadata found in
28 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>copyright</tag> and
31 <tag>legalnotice</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.copyright.section.enabled</parameter> is zero, the
36 the auto-generated <literal>COPYRIGHT</literal> section is
37 suppressed.</para>
38
39 <para>Set the value of
40   <parameter>man.copyright.section.enabled</parameter> to zero if
41   you want to have a manually created <literal>COPYRIGHT</literal>
42   section in your source, and you want it to appear in output
43   instead of the auto-generated <literal>COPYRIGHT</literal>
44   section.</para>
45 </refsection>
46 </refentry>