Fixed typo in transliterate rule

[yaz-moved-to-github.git] / doc / yaz-icu-man.xml

diff --git a/doc/yaz-icu-man.xml b/doc/yaz-icu-man.xml
index 90d78c6..10a5d29 100644 (file)
--- a/doc/yaz-icu-man.xml
+++ b/doc/yaz-icu-man.xml
@@ -8,8 +8,7 @@
      <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
-<!-- $Id: yaz-icu-man.xml,v 1.1 2007-11-12 11:13:05 adam Exp $ -->
-<refentry id="zoomsh">
+<refentry id="yaz-icu">
  <refentryinfo>
   <productname>YAZ</productname>
   <productnumber>&version;</productnumber>
@@ -31,6 +30,7 @@
    <arg choice="opt" rep="repeat">commands</arg>
    <arg>-c <replaceable>config</replaceable></arg>
    <arg>-p <replaceable>opt</replaceable></arg>
+   <arg>-s</arg>
    <arg>-x</arg>
   </cmdsynopsis>
  </refsynopsisdiv>
@@ -59,14 +59,22 @@
       If <replaceable>type</replaceable> is <literal>c</literal>
       then ICU converters are printed. 
       If <replaceable>type</replaceable> is <literal>l</literal>
-      available locates are printed.
+      available locales are printed.
       If <replaceable>type</replaceable> is <literal>t</literal>
       available transliterators are printed.
      </para></listitem>
    </varlistentry>
 
    <varlistentry>
-    <term>-x <replaceable>config</replaceable></term>
+    <term>-s</term>
+    <listitem><para>
+      Specifies that output should include sort key as well. Note that
+      sort key differs between ICU versions.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-x</term>
     <listitem><para>
       Specifies that output should be XML based rather than
       "text" based.
@@ -147,10 +155,20 @@
     <varlistentry>
      <term>transform</term>
      <listitem><para>
-       Specifies an ICU transform rule. The rule attribute is the
-       custom transformation rule to be used. This is a text based format
-       which is offered by the ICU transform system. See
-       <ulink url="&url.icu.transform;">ICU Transforms</ulink> for
+       Specifies an ICU transform rule using a transliterator
+       Identifier.
+       The rule attribute is the transliterator Identifier.
+       See  <ulink url="&url.icu.transform;">ICU Transforms</ulink> for
+       more information.
+      </para></listitem>
+    </varlistentry>
+    
+    <varlistentry>
+     <term>transliterate</term>
+     <listitem><para>
+       Specifies a rule-based transliterator.
+       The rule attribute is the custom transformation rule to be used.
+       See <ulink url="&url.icu.transform;">ICU Transforms</ulink> for
        more information.
       </para></listitem>
     </varlistentry>
@@ -218,6 +236,7 @@
   <transform rule="[:Control:] Any-Remove"/>
   <tokenize rule="w"/>
   <transform rule="[[:WhiteSpace:][:Punctuation:]] Remove"/>
+  <transliterate rule="xy > z"/>
   <display/>
   <casemap rule="l"/>
 </icu_chain>