man.charmap.enabled.xml 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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.charmap.enabled">
  7. <refmeta>
  8. <refentrytitle>man.charmap.enabled</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>man.charmap.enabled</refname>
  13. <refpurpose>Apply character map before final output?</refpurpose>
  14. </refnamediv>
  15. <refsynopsisdiv>
  16. <src:fragment xml:id="man.charmap.enabled.frag">
  17. <xsl:param name="man.charmap.enabled" select="1"/>
  18. </src:fragment>
  19. </refsynopsisdiv>
  20. <refsection><info><title>Description</title></info>
  21. <para>If the value of the <parameter>man.charmap.enabled</parameter>
  22. parameter is non-zero, a "character map" is used to substitute certain
  23. Unicode symbols and special characters with appropriate roff/groff
  24. equivalents, just before writing each man-page file to the
  25. filesystem. If instead the value of
  26. <parameter>man.charmap.enabled</parameter> is zero, Unicode characters
  27. are passed through "as is".</para>
  28. <refsection><info><title>Details</title></info>
  29. <para>For converting certain Unicode symbols and special characters in
  30. UTF-8 or UTF-16 encoded XML source to appropriate groff/roff
  31. equivalents in man-page output, the DocBook XSL Stylesheets
  32. distribution includes a <link xlink:href="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl">roff character map</link> that is compliant with the <link xlink:href="http://www.w3.org/TR/xslt20/#character-maps">XSLT character
  33. map</link> format as detailed in the XSLT 2.0 specification. The map
  34. contains more than 800 character mappings and can be considered the
  35. standard roff character map for the distribution.</para>
  36. <para>You can use the <parameter>man.charmap.uri</parameter>
  37. parameter to specify a URI for the location for an alternate roff
  38. character map to use in place of the standard roff character map
  39. provided in the distribution.</para>
  40. <para>You can also use a subset of a character map. For details,
  41. see the <parameter>man.charmap.use.subset</parameter>,
  42. <parameter>man.charmap.subset.profile</parameter>, and
  43. <parameter>man.charmap.subset.profile.english</parameter>
  44. parameters.</para>
  45. </refsection>
  46. </refsection>
  47. </refentry>