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