DocBook documentation stub added

[stg.git] / doc / help / xslt / params / man.output.subdirs.enabled.xml

diff --git a/doc/help/xslt/params/man.output.subdirs.enabled.xml b/doc/help/xslt/params/man.output.subdirs.enabled.xml
new file mode 100644 (file)
index 0000000..876b94e
--- /dev/null
+++ b/doc/help/xslt/params/man.output.subdirs.enabled.xml
@@ -0,0 +1,40 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="man.output.subdirs.enabled">
+<refmeta>
+<refentrytitle>man.output.subdirs.enabled</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.output.subdirs.enabled</refname>
+<refpurpose>Output man-page files in subdirectories within base output directory?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.output.subdirs.enabled.frag">
+<xsl:param name="man.output.subdirs.enabled" select="1"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>The <parameter>man.output.subdirs.enabled</parameter> parameter
+controls whether man-pages files are output in subdirectories within
+the base directory specified by the directory specified by the
+<parameter>man.output.base.dir</parameter> parameter.</para>
+
+<note>
+  <para>The values of the <parameter>man.output.base.dir</parameter>
+  and <parameter>man.output.subdirs.enabled</parameter> parameters are
+  used only if the value of
+  <parameter>man.output.in.separate.dir</parameter> parameter is
+  non-zero. If the value of the
+  <parameter>man.output.in.separate.dir</parameter> is zero, man-page
+  files are not output in a separate directory.</para>
+</note>
+
+</refsection>
+</refentry>