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