BOOK/chapter08/intltool.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   4   <!ENTITY % general-entities SYSTEM "../general.ent">
   5   %general-entities;
   6 ]>
   7
   8 <sect1 id="ch-system-intltool" role="wrap">
   9   <?dbhtml filename="intltool.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>intltool</productname>
  13     <productnumber>&intltool-version;</productnumber>
  14     <address>&intltool-url;</address>
  15   </sect1info>
  16
  17   <title>Intltool-&intltool-version;</title>
  18
  19   <indexterm zone="ch-system-intltool">
  20     <primary sortas="a-Intltool">Intltool</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The Intltool is an internationalization tool used for extracting
  27     translatable strings from source files.</para>
  28
  29     <segmentedlist>
  30       <segtitle>&buildtime;</segtitle>
  31       <segtitle>&diskspace;</segtitle>
  32
  33       <seglistitem>
  34         <seg>&intltool-fin-sbu;</seg>
  35         <seg>&intltool-fin-du;</seg>
  36       </seglistitem>
  37     </segmentedlist>
  38
  39   </sect2>
  40
  41   <sect2 role="installation">
  42     <title>Installation of Intltool</title>
  43
  44     <para>First fix a warning that is caused by perl-5.22 and later:</para>
  45
  46 <screen><userinput remap="pre">sed -i 's:\\\${:\\\$\\{:' intltool-update.in</userinput></screen>
  47
  48     <note><para>The above regular expression looks unusual because of all the
  49     backslashes.  What it does is add a backslash before the right brace
  50     character in the sequence '\${' resulting in '\$\{'.</para></note>
  51
  52     <para>Prepare Intltool for compilation:</para>
  53
  54 <screen><userinput remap="configure">./configure --prefix=/usr</userinput></screen>
  55
  56     <para>Compile the package:</para>
  57
  58 <screen><userinput remap="make">make</userinput></screen>
  59
  60     <para>To test the results, issue:</para>
  61
  62 <screen><userinput remap="test">make check</userinput></screen>
  63
  64     <para>Install the package:</para>
  65
  66 <screen><userinput remap="install">make install
  67 install -v -Dm644 doc/I18N-HOWTO /usr/share/doc/intltool-&intltool-version;/I18N-HOWTO</userinput></screen>
  68
  69   </sect2>
  70
  71   <sect2 id="contents-intltool" role="content">
  72     <title>Contents of Intltool</title>
  73
  74     <segmentedlist>
  75       <segtitle>Installed programs</segtitle>
  76       <segtitle>Installed directories</segtitle>
  77
  78       <seglistitem>
  79         <seg>intltool-extract, intltool-merge, intltool-prepare,
  80         intltool-update, and intltoolize</seg>
  81         <seg>/usr/share/doc/intltool-&intltool-version; and
  82         /usr/share/intltool</seg>
  83       </seglistitem>
  84     </segmentedlist>
  85
  86     <variablelist>
  87       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  88       <?dbfo list-presentation="list"?>
  89       <?dbhtml list-presentation="table"?>
  90
  91       <varlistentry id="intltoolize">
  92         <term><command>intltoolize</command></term>
  93         <listitem>
  94           <para>Prepares a package to use intltool</para>
  95           <indexterm zone="ch-system-intltool intltoolize">
  96             <primary sortas="b-intltoolize">intltoolize</primary>
  97           </indexterm>
  98         </listitem>
  99       </varlistentry>
 100
 101       <varlistentry id="intltool-extract">
 102         <term><command>intltool-extract</command></term>
 103         <listitem>
 104           <para>Generates header files that can be read by <command>gettext</command></para>
 105           <indexterm zone="ch-system-intltool intltool-extract">
 106             <primary sortas="b-intltool-extract">intltool-extract</primary>
 107           </indexterm>
 108         </listitem>
 109       </varlistentry>
 110
 111       <varlistentry id="intltool-merge">
 112         <term><command>intltool-merge</command></term>
 113         <listitem>
 114           <para>Merges translated strings into various file types</para>
 115           <indexterm zone="ch-system-intltool intltool-merge">
 116             <primary sortas="b-intltool-merge">intltool-merge</primary>
 117           </indexterm>
 118         </listitem>
 119       </varlistentry>
 120
 121       <varlistentry id="intltool-prepare">
 122         <term><command>intltool-prepare</command></term>
 123         <listitem>
 124           <para>Updates pot files and merges them with translation files</para>
 125           <indexterm zone="ch-system-intltool intltool-prepare">
 126             <primary sortas="b-intltool-prepare">intltool-prepare</primary>
 127           </indexterm>
 128         </listitem>
 129       </varlistentry>
 130
 131       <varlistentry id="intltool-update">
 132         <term><command>intltool-update</command></term>
 133         <listitem>
 134           <para>Updates the po template files and merges them with the translations</para>
 135           <indexterm zone="ch-system-intltool intltool-update">
 136             <primary sortas="b-intltool-update">intltool-update</primary>
 137           </indexterm>
 138         </listitem>
 139       </varlistentry>
 140
 141     </variablelist>
 142
 143   </sect2>
 144
 145 </sect1>