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