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