stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/man.output.encoding.xml

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