ccl2rpn: Conversion to regexp-1 terms (trunc=102).

[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 f488504..7c016bf 100644 (file)
--- a/doc/yaz-icu-man.xml
+++ b/doc/yaz-icu-man.xml
@@ -1,5 +1,5 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
 [
      <!ENTITY % local SYSTEM "local.ent">
      %local;
@@ -12,11 +12,13 @@
  <refentryinfo>
   <productname>YAZ</productname>
   <productnumber>&version;</productnumber>
+  <info><orgname>Index Data</orgname></info>
  </refentryinfo>
  
  <refmeta>
   <refentrytitle>yaz-icu</refentrytitle>
   <manvolnum>1</manvolnum>
+  <refmiscinfo class="manual">Commands</refmiscinfo>
  </refmeta>
  
  <refnamediv>
@@ -27,10 +29,11 @@
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>yaz-icu</command>
-   <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>
+   <arg choice="opt">infile</arg>
   </cmdsynopsis>
  </refsynopsisdiv>
  
@@ -39,6 +42,17 @@
    <command>yaz-icu</command> is utility which demonstrates 
    the ICU chain module of yaz. (<filename>yaz/icu.h</filename>).
   </para>
+  <para>
+    The utility can be used in two ways. It may read some text
+    using an XML configuration for configuring ICU and show text analysis.
+    This mode is triggered by option <literal>-c</literal> which specififies
+    the configuration to be used. The input file is read from standard
+    input or from a file if <literal>infile</literal> is specified.
+  </para>
+  <para>
+    The utility may also show ICU information. This is triggered by
+    option <literal>-p</literal>.
+  </para>
  </refsect1>
 
  <refsect1><title>OPTIONS</title>
@@ -65,7 +79,15 @@
    </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.
@@ -146,10 +168,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>
@@ -217,6 +249,7 @@
   <transform rule="[:Control:] Any-Remove"/>
   <tokenize rule="w"/>
   <transform rule="[[:WhiteSpace:][:Punctuation:]] Remove"/>
+  <transliterate rule="xy > z"/>
   <display/>
   <casemap rule="l"/>
 </icu_chain>