doc/xslt/params/man.output.encoding.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.encoding">
   7 <refmeta>
   8 <refentrytitle>man.output.encoding</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>man.output.encoding</refname>
  13 <refpurpose>Encoding used for man-page output</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17 <src:fragment xml:id="man.output.encoding.frag">
  18 <xsl:param name="man.output.encoding">UTF-8</xsl:param>
  19 </src:fragment>
  20 </refsynopsisdiv>
  21
  22 <refsection><info><title>Description</title></info>
  23
  24 <para>This parameter specifies the encoding to use for files generated
  25 by the manpages stylesheet. Not all processors support specification
  26 of this parameter.</para>
  27
  28 <important>
  29   <para>If the value of the <parameter>man.charmap.enabled</parameter>
  30   parameter is non-zero (the default), keeping the
  31   <parameter>man.output.encoding</parameter> parameter at its default
  32   value (<literal>UTF-8</literal>) or setting it to
  33   <literal>UTF-16</literal> <emphasis role="bold">does not cause your
  34   man pages to be output in raw UTF-8 or UTF-16</emphasis> -- because
  35   any Unicode characters for which matches are found in the enabled
  36   character map will be replaced with roff escape sequences before the
  37   final man-page files are generated.</para>
  38
  39   <para>So if you want to generate "real" UTF-8 man pages, without any
  40   character substitution being performed on your content, you need to
  41   set <parameter>man.charmap.enabled</parameter> to zero (which will
  42   completely disable character-map processing). </para>
  43
  44   <para>You may also need to set
  45   <parameter>man.charmap.enabled</parameter> to zero if you want to
  46   output man pages in an encoding other than <literal>UTF-8</literal>
  47   or <literal>UTF-16</literal>. Character-map processing is based on
  48   Unicode character values and may not work with other output
  49   encodings.</para>
  50 </important>
  51
  52 </refsection>
  53 </refentry>