man.output.encoding.xml 2.1 KB

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