chapter06/gettext.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-gettext" role="wrap">
   9   <?dbhtml filename="gettext.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>gettext</productname>
  13     <productnumber>&gettext-version;</productnumber>
  14     <address>&gettext-url;</address>
  15   </sect1info>
  16
  17   <title>Gettext-&gettext-version;</title>
  18
  19   <indexterm zone="ch-system-gettext">
  20     <primary sortas="a-Gettext">Gettext</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The Gettext package contains utilities for internationalization and
  27     localization. These allow programs to be compiled with NLS (Native Language
  28     Support), enabling them to output messages in the user's native
  29     language.</para>
  30
  31     <segmentedlist>
  32       <segtitle>&buildtime;</segtitle>
  33       <segtitle>&diskspace;</segtitle>
  34
  35       <seglistitem>
  36         <seg>&gettext-ch6-sbu;</seg>
  37         <seg>&gettext-ch6-du;</seg>
  38       </seglistitem>
  39     </segmentedlist>
  40
  41   </sect2>
  42
  43   <sect2 role="installation">
  44     <title>Installation of Gettext</title>
  45
  46    <!-- this has been fixed in upstream gnulib, when a new version of
  47    gettext is released, please check #4055 to see if the change has been
  48    picked up in this package -->
  49    <para>First, suppress two invocations of test-lock which on some machines
  50    can loop forever:</para>
  51
  52 <screen><userinput remap="pre">sed -i '/^TESTS =/d' gettext-runtime/tests/Makefile.in &amp;&amp;
  53 sed -i 's/test-lock..EXEEXT.//' gettext-tools/gnulib-tests/Makefile.in</userinput></screen>
  54
  55     <para>Prepare Gettext for compilation:</para>
  56
  57 <screen><userinput remap="configure">./configure --prefix=/usr    \
  58             --disable-static \
  59             --docdir=/usr/share/doc/gettext-&gettext-version;</userinput></screen>
  60
  61     <para>Compile the package:</para>
  62
  63 <screen><userinput remap="make">make</userinput></screen>
  64
  65     <para>To test the results (this takes a long time, around 3 SBUs),
  66     issue:</para>
  67
  68 <screen><userinput remap="test">make check</userinput></screen>
  69
  70     <para>Install the package:</para>
  71
  72 <screen><userinput remap="install">make install
  73 chmod -v 0755 /usr/lib/preloadable_libintl.so</userinput></screen>
  74
  75   </sect2>
  76
  77   <sect2 id="contents-gettext" role="content">
  78     <title>Contents of Gettext</title>
  79
  80     <segmentedlist>
  81       <segtitle>Installed programs</segtitle>
  82       <segtitle>Installed libraries</segtitle>
  83       <segtitle>Installed directories</segtitle>
  84
  85       <seglistitem>
  86         <seg>autopoint, envsubst, gettext, gettext.sh,
  87         gettextize, msgattrib, msgcat, msgcmp, msgcomm, msgconv, msgen,
  88         msgexec, msgfilter, msgfmt, msggrep, msginit, msgmerge, msgunfmt, msguniq,
  89         ngettext, recode-sr-latin, and xgettext</seg>
  90         <seg>libasprintf.so, libgettextlib.so, libgettextpo.so,
  91         libgettextsrc.so, and preloadable_libintl.so</seg>
  92         <seg>/usr/lib/gettext, /usr/share/doc/gettext-&gettext-version;, and
  93         /usr/share/gettext</seg>
  94       </seglistitem>
  95     </segmentedlist>
  96
  97     <variablelist>
  98       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  99       <?dbfo list-presentation="list"?>
 100       <?dbhtml list-presentation="table"?>
 101
 102       <varlistentry id="autopoint">
 103         <term><command>autopoint</command></term>
 104         <listitem>
 105           <para>Copies standard Gettext infrastructure files into a source
 106           package</para>
 107           <indexterm zone="ch-system-gettext autopoint">
 108             <primary sortas="b-autopoint">autopoint</primary>
 109           </indexterm>
 110         </listitem>
 111       </varlistentry>
 112
 113       <varlistentry id="envsubst">
 114         <term><command>envsubst</command></term>
 115         <listitem>
 116           <para>Substitutes environment variables in shell format strings</para>
 117           <indexterm zone="ch-system-gettext envsubst">
 118             <primary sortas="b-envsubst">envsubst</primary>
 119           </indexterm>
 120         </listitem>
 121       </varlistentry>
 122
 123       <varlistentry id="gettext">
 124         <term><command>gettext</command></term>
 125         <listitem>
 126           <para>Translates a natural language message into the user's language
 127           by looking up the translation in a message catalog</para>
 128           <indexterm zone="ch-system-gettext gettext">
 129             <primary sortas="b-gettext">gettext</primary>
 130           </indexterm>
 131         </listitem>
 132       </varlistentry>
 133
 134       <varlistentry id="gettext.sh">
 135         <term><command>gettext.sh</command></term>
 136         <listitem>
 137           <para>Primarily serves as a shell function library for gettext</para>
 138           <indexterm zone="ch-system-gettext gettext.sh">
 139             <primary sortas="b-gettext.sh">gettext.sh</primary>
 140           </indexterm>
 141         </listitem>
 142       </varlistentry>
 143
 144       <varlistentry id="gettextize">
 145         <term><command>gettextize</command></term>
 146         <listitem>
 147           <para>Copies all standard Gettext files into the given top-level
 148           directory of a package to begin internationalizing it</para>
 149           <indexterm zone="ch-system-gettext gettextize">
 150             <primary sortas="b-gettextize">gettextize</primary>
 151           </indexterm>
 152         </listitem>
 153       </varlistentry>
 154
 155       <varlistentry id="msgattrib">
 156         <term><command>msgattrib</command></term>
 157         <listitem>
 158           <para>Filters the messages of a translation catalog according to their
 159           attributes and manipulates the attributes</para>
 160           <indexterm zone="ch-system-gettext msgattrib">
 161             <primary sortas="b-msgattrib">msgattrib</primary>
 162           </indexterm>
 163         </listitem>
 164       </varlistentry>
 165
 166       <varlistentry id="msgcat">
 167         <term><command>msgcat</command></term>
 168         <listitem>
 169           <para>Concatenates and merges the given
 170           <filename class="extension">.po</filename> files</para>
 171           <indexterm zone="ch-system-gettext msgcat">
 172             <primary sortas="b-msgcat">msgcat</primary>
 173           </indexterm>
 174         </listitem>
 175       </varlistentry>
 176
 177       <varlistentry id="msgcmp">
 178         <term><command>msgcmp</command></term>
 179         <listitem>
 180           <para>Compares two <filename class="extension">.po</filename>
 181           files to check that both contain the same set of msgid strings</para>
 182           <indexterm zone="ch-system-gettext msgcmp">
 183             <primary sortas="b-msgcmp">msgcmp</primary>
 184           </indexterm>
 185         </listitem>
 186       </varlistentry>
 187
 188       <varlistentry id="msgcomm">
 189         <term><command>msgcomm</command></term>
 190         <listitem>
 191           <para>Finds the messages that are common to the given
 192           <filename class="extension">.po</filename> files</para>
 193           <indexterm zone="ch-system-gettext msgcomm">
 194             <primary sortas="b-msgcomm">msgcomm</primary>
 195           </indexterm>
 196         </listitem>
 197       </varlistentry>
 198
 199       <varlistentry id="msgconv">
 200         <term><command>msgconv</command></term>
 201         <listitem>
 202           <para>Converts a translation catalog to a different character
 203           encoding</para>
 204           <indexterm zone="ch-system-gettext msgconv">
 205             <primary sortas="b-msgconv">msgconv</primary>
 206           </indexterm>
 207         </listitem>
 208       </varlistentry>
 209
 210       <varlistentry id="msgen">
 211         <term><command>msgen</command></term>
 212         <listitem>
 213           <para>Creates an English translation catalog</para>
 214           <indexterm zone="ch-system-gettext msgen">
 215             <primary sortas="b-msgen">msgen</primary>
 216           </indexterm>
 217         </listitem>
 218       </varlistentry>
 219
 220       <varlistentry id="msgexec">
 221         <term><command>msgexec</command></term>
 222         <listitem>
 223           <para>Applies a command to all translations of a translation
 224           catalog</para>
 225           <indexterm zone="ch-system-gettext msgexec">
 226             <primary sortas="b-msgexec">msgexec</primary>
 227           </indexterm>
 228         </listitem>
 229       </varlistentry>
 230
 231       <varlistentry id="msgfilter">
 232         <term><command>msgfilter</command></term>
 233         <listitem>
 234           <para>Applies a filter to all translations of a translation
 235           catalog</para>
 236           <indexterm zone="ch-system-gettext msgfilter">
 237             <primary sortas="b-msgfilter">msgfilter</primary>
 238           </indexterm>
 239         </listitem>
 240       </varlistentry>
 241
 242       <varlistentry id="msgfmt">
 243         <term><command>msgfmt</command></term>
 244         <listitem>
 245           <para>Generates a binary message catalog from a translation
 246           catalog</para>
 247           <indexterm zone="ch-system-gettext msgfmt">
 248             <primary sortas="b-msgfmt">msgfmt</primary>
 249           </indexterm>
 250         </listitem>
 251       </varlistentry>
 252
 253       <varlistentry id="msggrep">
 254         <term><command>msggrep</command></term>
 255         <listitem>
 256           <para>Extracts all messages of a translation catalog that match a
 257           given pattern or belong to some given source files</para>
 258           <indexterm zone="ch-system-gettext msggrep">
 259             <primary sortas="b-msggrep">msggrep</primary>
 260           </indexterm>
 261         </listitem>
 262       </varlistentry>
 263
 264       <varlistentry id="msginit">
 265         <term><command>msginit</command></term>
 266         <listitem>
 267           <para>Creates a new <filename class="extension">.po</filename> file,
 268           initializing the meta information with values from the user's
 269           environment</para>
 270           <indexterm zone="ch-system-gettext msginit">
 271             <primary sortas="b-msginit">msginit</primary>
 272           </indexterm>
 273         </listitem>
 274       </varlistentry>
 275
 276       <varlistentry id="msgmerge">
 277         <term><command>msgmerge</command></term>
 278         <listitem>
 279           <para>Combines two raw translations into a single file</para>
 280           <indexterm zone="ch-system-gettext msgmerge">
 281             <primary sortas="b-msgmerge">msgmerge</primary>
 282           </indexterm>
 283         </listitem>
 284       </varlistentry>
 285
 286       <varlistentry id="msgunfmt">
 287         <term><command>msgunfmt</command></term>
 288         <listitem>
 289           <para>Decompiles a binary message catalog into raw translation
 290           text</para>
 291           <indexterm zone="ch-system-gettext msgunfmt">
 292             <primary sortas="b-msgunfmt">msgunfmt</primary>
 293           </indexterm>
 294         </listitem>
 295       </varlistentry>
 296
 297       <varlistentry id="msguniq">
 298         <term><command>msguniq</command></term>
 299         <listitem>
 300           <para>Unifies duplicate translations in a translation catalog</para>
 301           <indexterm zone="ch-system-gettext msguniq">
 302             <primary sortas="b-msguniq">msguniq</primary>
 303           </indexterm>
 304         </listitem>
 305       </varlistentry>
 306
 307       <varlistentry id="ngettext">
 308         <term><command>ngettext</command></term>
 309         <listitem>
 310           <para>Displays native language translations of a textual message whose
 311           grammatical form depends on a number</para>
 312           <indexterm zone="ch-system-gettext ngettext">
 313             <primary sortas="b-ngettext">ngettext</primary>
 314           </indexterm>
 315         </listitem>
 316       </varlistentry>
 317
 318       <varlistentry id="recode-sr-latin">
 319         <term><command>recode-sr-latin</command></term>
 320         <listitem>
 321           <para>Recodes Serbian text from Cyrillic to Latin script</para>
 322           <indexterm zone="ch-system-gettext recode-sr-latin">
 323             <primary sortas="b-recode-sr-latin">recode-sr-latin</primary>
 324           </indexterm>
 325         </listitem>
 326       </varlistentry>
 327
 328       <varlistentry id="xgettext">
 329         <term><command>xgettext</command></term>
 330         <listitem>
 331           <para>Extracts the translatable message lines from the given source
 332           files to make the first translation template</para>
 333           <indexterm zone="ch-system-gettext xgettext">
 334             <primary sortas="b-xgettext">xgettext</primary>
 335           </indexterm>
 336         </listitem>
 337       </varlistentry>
 338
 339       <varlistentry id="libasprintf">
 340         <term><filename class="libraryfile">libasprintf</filename></term>
 341         <listitem>
 342           <para>defines the <emphasis>autosprintf</emphasis> class, which makes
 343           C formatted output routines usable in C++ programs, for use with the
 344           <emphasis>&lt;string&gt;</emphasis> strings and the
 345           <emphasis>&lt;iostream&gt;</emphasis> streams</para>
 346           <indexterm zone="ch-system-gettext libasprintf">
 347             <primary sortas="c-libasprintf">libasprintf</primary>
 348           </indexterm>
 349         </listitem>
 350       </varlistentry>
 351
 352       <varlistentry id="libgettextlib">
 353         <term><filename class="libraryfile">libgettextlib</filename></term>
 354         <listitem>
 355           <para>a private library containing common routines used by the
 356           various Gettext programs; these are not intended for general use</para>
 357           <indexterm zone="ch-system-gettext libgettextlib">
 358             <primary sortas="c-libgettextlib">libgettextlib</primary>
 359           </indexterm>
 360         </listitem>
 361       </varlistentry>
 362
 363       <varlistentry id="libgettextpo">
 364         <term><filename class="libraryfile">libgettextpo</filename></term>
 365         <listitem>
 366           <para>Used to write specialized programs that process
 367           <filename class="extension">.po</filename> files; this library is
 368           used when the standard applications shipped with Gettext (such as
 369           <command>msgcomm</command>, <command>msgcmp</command>,
 370           <command>msgattrib</command>, and <command>msgen</command>) will
 371           not suffice</para>
 372           <indexterm zone="ch-system-gettext libgettextpo">
 373             <primary sortas="c-libgettextpo">libgettextpo</primary>
 374           </indexterm>
 375         </listitem>
 376       </varlistentry>
 377
 378       <varlistentry id="libgettextsrc">
 379         <term><filename class="libraryfile">libgettextsrc</filename></term>
 380         <listitem>
 381           <para>A private library containing common routines used by the
 382           various Gettext programs; these are not intended for general use</para>
 383           <indexterm zone="ch-system-gettext libgettextsrc">
 384             <primary sortas="c-libgettextsrc">libgettextsrc</primary>
 385           </indexterm>
 386         </listitem>
 387       </varlistentry>
 388
 389       <varlistentry id="preloadable_libintl">
 390         <term><filename class="libraryfile">preloadable_libintl</filename></term>
 391         <listitem>
 392           <para>A library, intended to be used by LD_PRELOAD that assists
 393           <filename class="libraryfile">libintl</filename> in logging
 394           untranslated messages</para>
 395           <indexterm zone="ch-system-gettext preloadable_libintl">
 396             <primary sortas="c-preloadable_libintl">preloadable_libintl</primary>
 397           </indexterm>
 398         </listitem>
 399       </varlistentry>
 400     </variablelist>
 401
 402   </sect2>
 403
 404 </sect1>