]> git.stg.codes - stg.git/blob - doc/xslt/params/man.output.subdirs.enabled.xml
Minor ChangeLog fix
[stg.git] / doc / xslt / params / man.output.subdirs.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.output.subdirs.enabled">
7 <refmeta>
8 <refentrytitle>man.output.subdirs.enabled</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>man.output.subdirs.enabled</refname>
13 <refpurpose>Output man-page files in subdirectories within base output directory?</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="man.output.subdirs.enabled.frag">
18 <xsl:param name="man.output.subdirs.enabled" select="1"/>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>The <parameter>man.output.subdirs.enabled</parameter> parameter
25 controls whether man-pages files are output in subdirectories within
26 the base directory specified by the directory specified by the
27 <parameter>man.output.base.dir</parameter> parameter.</para>
28
29 <note>
30   <para>The values of the <parameter>man.output.base.dir</parameter>
31   and <parameter>man.output.subdirs.enabled</parameter> parameters are
32   used only if the value of
33   <parameter>man.output.in.separate.dir</parameter> parameter is
34   non-zero. If the value of the
35   <parameter>man.output.in.separate.dir</parameter> is zero, man-page
36   files are not output in a separate directory.</para>
37 </note>
38
39 </refsection>
40 </refentry>