[docbook-checkins] CVS: xsl/params man.charmap.subset.profile.xml,1.2,1.3 man.output.encoding.xml,1.2,1.3

[Michael S. <xm...@us...>]

Update of /cvsroot/docbook/xsl/params
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv23786

Modified Files:
	man.charmap.subset.profile.xml man.output.encoding.xml 
Log Message:
Doc tweaks


Index: man.charmap.subset.profile.xml
===================================================================
RCS file: /cvsroot/docbook/xsl/params/man.charmap.subset.profile.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -U2 -r1.2 -r1.3
--- man.charmap.subset.profile.xml	23 Jun 2005 05:30:07 -0000	1.2
+++ man.charmap.subset.profile.xml	23 Jun 2005 06:45:36 -0000	1.3
@@ -40,6 +40,7 @@
 character map.</para>
 
-<para>The attributes supported in the standard roff character map
-included in the distribution are:
+<para>The attributes supported in the <ulink url="<ulink
+url="http://docbook.sourceforge.net/snapshot/xsl/manpages/charmap.groff.xsl"
+>standard roff character map included in the distribution</ulink> are:
 <variablelist>
   <varlistentry>

Index: man.output.encoding.xml
===================================================================
RCS file: /cvsroot/docbook/xsl/params/man.output.encoding.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -U2 -r1.2 -r1.3
--- man.output.encoding.xml	23 Jun 2005 06:01:19 -0000	1.2
+++ man.output.encoding.xml	23 Jun 2005 06:45:36 -0000	1.3
@@ -20,13 +20,27 @@
 of this parameter.</para>
 
-<warning>
-  <para>If you set a value for the
-  <parameter>man.output.encoding</parameter> parameter that is other
-  than <literal>UTF-8</literal> or <literal>UTF-16</literal>, you may
-  also need to also disable character-map processing, by setting the
-  value of the <parameter>man.charmap.enabled</parameter> parameter to
-  zero. Character-map processing is based on Unicode character values
-  may not work with other output encodings</para>
-</warning>
+<important>
+  <para>If the value of the <parameter>man.charmap.enabled</parameter>
+  parameter is non-zero (the default), keeping the
+  <parameter>man.output.encoding</parameter> parameter at its default
+  value (<literal>UTF-8</literal>) or setting it to
+  <literal>UTF-16</literal> <emphasis role="bold" >does not cause your
+  man pages to be output in raw UTF-8 or UTF-16</emphasis> -- because
+  any Unicode characters for which matches are found in the enabled
+  character map will be replaced with roff escape sequences before the
+  final man-page files are generated.</para>
+
+  <para>So if you want to generate "real" UTF-8 man pages, without any
+  character substitution being performed on your content, you need to
+  set <parameter>man.charmap.enabled</parameter> to zero (which will
+  completely disable character-map processing). </para>
+
+  <para>You may also need to set
+  <parameter>man.charmap.enabled</parameter> to zero if you want to
+  output man pages in an encoding other than <literal>UTF-8</literal>
+  or <literal>UTF-16</literal>. Character-map processing is based on
+  Unicode character values and may not work with other output
+  encodings.</para>
+</important>
 
 </refsect1>