| <refentry xmlns="http://docbook.org/ns/docbook" |
| xmlns:xlink="http://www.w3.org/1999/xlink" |
| xmlns:xi="http://www.w3.org/2001/XInclude" |
| xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" |
| xmlns:xsl="http://www.w3.org/1999/XSL/Transform" |
| version="5.0" xml:id="man.charmap.enabled"> |
| <refmeta> |
| <refentrytitle>man.charmap.enabled</refentrytitle> |
| <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> |
| </refmeta> |
| <refnamediv> |
| <refname>man.charmap.enabled</refname> |
| <refpurpose>Apply character map before final output?</refpurpose> |
| </refnamediv> |
| |
| <refsynopsisdiv> |
| <src:fragment xml:id="man.charmap.enabled.frag"> |
| <xsl:param name="man.charmap.enabled" select="1"/> |
| </src:fragment> |
| </refsynopsisdiv> |
| |
| <refsection><info><title>Description</title></info> |
| |
| <para>If the value of the <parameter>man.charmap.enabled</parameter> |
| parameter is non-zero, a "character map" is used to substitute certain |
| Unicode symbols and special characters with appropriate roff/groff |
| equivalents, just before writing each man-page file to the |
| filesystem. If instead the value of |
| <parameter>man.charmap.enabled</parameter> is zero, Unicode characters |
| are passed through "as is".</para> |
| |
| <refsection><info><title>Details</title></info> |
| |
| <para>For converting certain Unicode symbols and special characters in |
| UTF-8 or UTF-16 encoded XML source to appropriate groff/roff |
| equivalents in man-page output, the DocBook XSL Stylesheets |
| 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 |
| map</link> format as detailed in the XSLT 2.0 specification. The map |
| contains more than 800 character mappings and can be considered the |
| standard roff character map for the distribution.</para> |
| |
| <para>You can use the <parameter>man.charmap.uri</parameter> |
| parameter to specify a URI for the location for an alternate roff |
| character map to use in place of the standard roff character map |
| provided in the distribution.</para> |
| |
| <para>You can also use a subset of a character map. For details, |
| see the <parameter>man.charmap.use.subset</parameter>, |
| <parameter>man.charmap.subset.profile</parameter>, and |
| <parameter>man.charmap.subset.profile.english</parameter> |
| parameters.</para> |
| |
| </refsection> |
| </refsection> |
| </refentry> |