DocBook documentation stub added

[stg.git] / doc / help / xslt / params / man.output.lang.in.name.enabled.xml

diff --git a/doc/help/xslt/params/man.output.lang.in.name.enabled.xml b/doc/help/xslt/params/man.output.lang.in.name.enabled.xml
new file mode 100644 (file)
index 0000000..1fed3c0
--- /dev/null
+++ b/doc/help/xslt/params/man.output.lang.in.name.enabled.xml
@@ -0,0 +1,50 @@
+<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.lang.in.name.enabled">
+<refmeta>
+<refentrytitle>man.output.lang.in.name.enabled</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.output.lang.in.name.enabled</refname>
+<refpurpose>Include $LANG value in man-page filename/pathname?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.output.lang.in.name.enabled.frag">
+<xsl:param name="man.output.lang.in.name.enabled" select="0"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+  <para>The <parameter>man.output.lang.in.name.enabled</parameter>
+  parameter specifies whether a <literal>$lang</literal> value is
+  included in man-page filenames and pathnames.</para>
+
+  <para>If the value of
+  <parameter>man.output.lang.in.name.enabled</parameter> is non-zero,
+  man-page files are output with the <literal>$lang</literal> value
+  included in their filenames or pathnames as follows;
+
+  <itemizedlist>
+    <listitem>
+      <para>if <parameter>man.output.subdirs.enabled</parameter> is
+      non-zero, each file is output to, e.g., a
+      <filename>man/<replaceable>$lang</replaceable>/man8/foo.8</filename>
+      pathname</para>
+    </listitem>
+    <listitem>
+      <para>if <parameter>man.output.subdirs.enabled</parameter> is
+      zero, each file is output with a
+      <literal>foo.<replaceable>$lang</replaceable>.8</literal>
+      filename</para>
+    </listitem>
+  </itemizedlist>
+  </para>
+
+</refsection>
+</refentry>