DocBook documentation stub added

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

diff --git a/doc/help/xslt/params/man.output.encoding.xml b/doc/help/xslt/params/man.output.encoding.xml
new file mode 100644 (file)
index 0000000..7154bc8
--- /dev/null
+++ b/doc/help/xslt/params/man.output.encoding.xml
@@ -0,0 +1,53 @@
+<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.encoding">
+<refmeta>
+<refentrytitle>man.output.encoding</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>man.output.encoding</refname>
+<refpurpose>Encoding used for man-page output</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="man.output.encoding.frag">
+<xsl:param name="man.output.encoding">UTF-8</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>This parameter specifies the encoding to use for files generated
+by the manpages stylesheet. Not all processors support specification
+of this parameter.</para>
+
+<important>
+  <para>If the value of the <parameter>man.charmap.enabled</parameter>
+  parameter is non-zero (the default), keeping the
+  <parameter>man.output.encoding</parameter> parameter at its default
+  value (<literal>UTF-8</literal>) or setting it to
+  <literal>UTF-16</literal> <emphasis role="bold">does not cause your
+  man pages to be output in raw UTF-8 or UTF-16</emphasis> -- because
+  any Unicode characters for which matches are found in the enabled
+  character map will be replaced with roff escape sequences before the
+  final man-page files are generated.</para>
+
+  <para>So if you want to generate "real" UTF-8 man pages, without any
+  character substitution being performed on your content, you need to
+  set <parameter>man.charmap.enabled</parameter> to zero (which will
+  completely disable character-map processing). </para>
+
+  <para>You may also need to set
+  <parameter>man.charmap.enabled</parameter> to zero if you want to
+  output man pages in an encoding other than <literal>UTF-8</literal>
+  or <literal>UTF-16</literal>. Character-map processing is based on
+  Unicode character values and may not work with other output
+  encodings.</para>
+</important>
+
+</refsection>
+</refentry>