source: clfs-sysroot/BOOK/final-system/common/gettext.xml @ 586feb7

Last change on this file since 586feb7 was 586feb7, checked in by Joe Ciccone <jciccone@…>, 16 years ago

Updated the bootscripts package and make LFS to CLFS updates.

  • Property mode set to 100644
File size: 13.7 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3  "http://www.oasis-open.org/docbook/xml/4.4/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  <title>Gettext-&gettext-version;</title>
12
13  <indexterm zone="ch-system-gettext">
14    <primary sortas="a-Gettext">Gettext</primary>
15  </indexterm>
16
17  <sect2 role="package">
18    <title/>
19
20    <para>The Gettext package contains utilities for internationalization
21    and localization. These allow programs to be compiled with NLS (Native
22    Language Support), enabling them to output messages in the user's native
23    language.</para>
24
25  </sect2>
26
27  <sect2 role="installation">
28    <title>Installation of Gettext</title>
29
30    <para os="a">Prepare Gettext for compilation:</para>
31
32<screen os="b"><userinput>./configure --prefix=/usr --host=${CLFS_TARGET}</userinput></screen>
33
34    <para os="c">Compile the package:</para>
35
36<screen os="d"><userinput>make</userinput></screen>
37
38    <para os="e">Install the package:</para>
39
40<screen os="f"><userinput>make DESTDIR=${CLFS} install</userinput></screen>
41
42  </sect2>
43
44  <sect2 id="contents-gettext" role="content">
45    <title>Contents of Gettext</title>
46
47    <segmentedlist>
48      <segtitle>Installed programs</segtitle>
49      <segtitle>Installed libraries</segtitle>
50
51      <seglistitem>
52        <seg>autopoint, config.charset, config.rpath, envsubst, gettext, gettext.sh,
53        gettextize, hostname, msgattrib, msgcat, msgcmp, msgcomm, msgconv, msgen,
54        msgexec, msgfilter, msgfmt, msggrep, msginit, msgmerge, msgunfmt, msguniq,
55        ngettext, and xgettext</seg>
56        <seg>libasprintf.[a,so], libgettextlib.so, libgettextpo.[a,so], and
57        libgettextsrc.so</seg>
58      </seglistitem>
59    </segmentedlist>
60
61    <variablelist>
62      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
63      <?dbfo list-presentation="list"?>
64      <?dbhtml list-presentation="table"?>
65
66      <varlistentry id="autopoint">
67        <term><command>autopoint</command></term>
68        <listitem>
69          <para>Copies standard Gettext infrastructure files into a source
70          package</para>
71          <indexterm zone="ch-system-gettext autopoint">
72            <primary sortas="b-autopoint">autopoint</primary>
73          </indexterm>
74        </listitem>
75      </varlistentry>
76
77      <varlistentry id="config.charset">
78        <term><command>config.charset</command></term>
79        <listitem>
80          <para>Outputs a system-dependent table of character encoding
81          aliases</para>
82          <indexterm zone="ch-system-gettext config.charset">
83            <primary sortas="b-config.charset">config.charset</primary>
84          </indexterm>
85        </listitem>
86      </varlistentry>
87
88      <varlistentry id="config.rpath">
89        <term><command>config.rpath</command></term>
90        <listitem>
91          <para>Outputs a system-dependent set of variables, describing how
92          to set the runtime search path of shared libraries in an
93          executable</para>
94          <indexterm zone="ch-system-gettext config.rpath">
95            <primary sortas="b-config.rpath">config.rpath</primary>
96          </indexterm>
97        </listitem>
98      </varlistentry>
99
100      <varlistentry id="envsubst">
101        <term><command>envsubst</command></term>
102        <listitem>
103          <para>Substitutes environment variables in shell format strings</para>
104          <indexterm zone="ch-system-gettext envsubst">
105            <primary sortas="b-envsubst">envsubst</primary>
106          </indexterm>
107        </listitem>
108      </varlistentry>
109
110      <varlistentry id="gettext">
111        <term><command>gettext</command></term>
112        <listitem>
113          <para>Translates a natural language message into the user's language
114          by looking up the translation in a message catalog</para>
115          <indexterm zone="ch-system-gettext gettext">
116            <primary sortas="b-gettext">gettext</primary>
117          </indexterm>
118        </listitem>
119      </varlistentry>
120
121      <varlistentry id="gettext.sh">
122        <term><command>gettext.sh</command></term>
123        <listitem>
124          <para>Primarily serves as a shell function library for gettext</para>
125          <indexterm zone="ch-system-gettext gettext.sh">
126            <primary sortas="b-gettext.sh">gettext.sh</primary>
127          </indexterm>
128        </listitem>
129      </varlistentry>
130
131      <varlistentry id="gettextize">
132        <term><command>gettextize</command></term>
133        <listitem>
134          <para>Copies all standard Gettext files into the given top-level
135          directory of a package to begin internationalizing it</para>
136          <indexterm zone="ch-system-gettext gettextize">
137            <primary sortas="b-gettextize">gettextize</primary>
138          </indexterm>
139        </listitem>
140      </varlistentry>
141
142      <varlistentry id="hostname-gettext">
143        <term><command>hostname</command></term>
144        <listitem>
145          <para>Displays a network hostname in various forms</para>
146          <indexterm zone="ch-system-gettext hostname-gettext">
147            <primary sortas="b-hostname-gettext">hostname</primary>
148          </indexterm>
149        </listitem>
150      </varlistentry>
151
152      <varlistentry id="msgattrib">
153        <term><command>msgattrib</command></term>
154        <listitem>
155          <para>Filters the messages of a translation catalog according to their
156          attributes and manipulates the attributes</para>
157          <indexterm zone="ch-system-gettext msgattrib">
158            <primary sortas="b-msgattrib">msgattrib</primary>
159          </indexterm>
160        </listitem>
161      </varlistentry>
162
163      <varlistentry id="msgcat">
164        <term><command>msgcat</command></term>
165        <listitem>
166          <para>Concatenates and merges the given
167          <filename class="extension">.po</filename> files</para>
168          <indexterm zone="ch-system-gettext msgcat">
169            <primary sortas="b-msgcat">msgcat</primary>
170          </indexterm>
171        </listitem>
172      </varlistentry>
173
174      <varlistentry id="msgcmp">
175        <term><command>msgcmp</command></term>
176        <listitem>
177          <para>Compares two <filename class="extension">.po</filename>
178          files to check that both contain the same set of msgid strings</para>
179          <indexterm zone="ch-system-gettext msgcmp">
180            <primary sortas="b-msgcmp">msgcmp</primary>
181          </indexterm>
182        </listitem>
183      </varlistentry>
184
185      <varlistentry id="msgcomm">
186        <term><command>msgcomm</command></term>
187        <listitem>
188          <para>Finds the messages that are common to to the given
189          <filename class="extension">.po</filename> files</para>
190          <indexterm zone="ch-system-gettext msgcomm">
191            <primary sortas="b-msgcomm">msgcomm</primary>
192          </indexterm>
193        </listitem>
194      </varlistentry>
195
196      <varlistentry id="msgconv">
197        <term><command>msgconv</command></term>
198        <listitem>
199          <para>Converts a translation catalog to a different character
200          encoding</para>
201          <indexterm zone="ch-system-gettext msgconv">
202            <primary sortas="b-msgconv">msgconv</primary>
203          </indexterm>
204        </listitem>
205      </varlistentry>
206
207      <varlistentry id="msgen">
208        <term><command>msgen</command></term>
209        <listitem>
210          <para>Creates an English translation catalog</para>
211          <indexterm zone="ch-system-gettext msgen">
212            <primary sortas="b-msgen">msgen</primary>
213          </indexterm>
214        </listitem>
215      </varlistentry>
216
217      <varlistentry id="msgexec">
218        <term><command>msgexec</command></term>
219        <listitem>
220          <para>Applies a command to all translations of a translation
221          catalog</para>
222          <indexterm zone="ch-system-gettext msgexec">
223            <primary sortas="b-msgexec">msgexec</primary>
224          </indexterm>
225        </listitem>
226      </varlistentry>
227
228      <varlistentry id="msgfilter">
229        <term><command>msgfilter</command></term>
230        <listitem>
231          <para>Applies a filter to all translations of a translation
232          catalog</para>
233          <indexterm zone="ch-system-gettext msgfilter">
234            <primary sortas="b-msgfilter">msgfilter</primary>
235          </indexterm>
236        </listitem>
237      </varlistentry>
238
239      <varlistentry id="msgfmt">
240        <term><command>msgfmt</command></term>
241        <listitem>
242          <para>Generates a binary message catalog from a translation
243          catalog</para>
244          <indexterm zone="ch-system-gettext msgfmt">
245            <primary sortas="b-msgfmt">msgfmt</primary>
246          </indexterm>
247        </listitem>
248      </varlistentry>
249
250      <varlistentry id="msggrep">
251        <term><command>msggrep</command></term>
252        <listitem>
253          <para>Extracts all messages of a translation catalog that match a
254          given pattern or belong to some given source files</para>
255          <indexterm zone="ch-system-gettext msggrep">
256            <primary sortas="b-msggrep">msggrep</primary>
257          </indexterm>
258        </listitem>
259      </varlistentry>
260
261      <varlistentry id="msginit">
262        <term><command>msginit</command></term>
263        <listitem>
264          <para>Creates a new <filename class="extension">.po</filename> file,
265          initializing the meta information with values from the user's
266          environment</para>
267          <indexterm zone="ch-system-gettext msginit">
268            <primary sortas="b-msginit">msginit</primary>
269          </indexterm>
270        </listitem>
271      </varlistentry>
272
273      <varlistentry id="msgmerge">
274        <term><command>msgmerge</command></term>
275        <listitem>
276          <para>Combines two raw translations into a single file</para>
277          <indexterm zone="ch-system-gettext msgmerge">
278            <primary sortas="b-msgmerge">msgmerge</primary>
279          </indexterm>
280        </listitem>
281      </varlistentry>
282
283      <varlistentry id="msgunfmt">
284        <term><command>msgunfmt</command></term>
285        <listitem>
286          <para>Decompiles a binary message catalog into raw translation
287          text</para>
288          <indexterm zone="ch-system-gettext msgunfmt">
289            <primary sortas="b-msgunfmt">msgunfmt</primary>
290          </indexterm>
291        </listitem>
292      </varlistentry>
293
294      <varlistentry id="msguniq">
295        <term><command>msguniq</command></term>
296        <listitem>
297          <para>Unifies duplicate translations in a translation catalog</para>
298          <indexterm zone="ch-system-gettext msguniq">
299            <primary sortas="b-msguniq">msguniq</primary>
300          </indexterm>
301        </listitem>
302      </varlistentry>
303
304      <varlistentry id="ngettext">
305        <term><command>ngettext</command></term>
306        <listitem>
307          <para>Displays native language translations of a textual message whose
308          grammatical form depends on a number</para>
309          <indexterm zone="ch-system-gettext ngettext">
310            <primary sortas="b-ngettext">ngettext</primary>
311          </indexterm>
312        </listitem>
313      </varlistentry>
314
315      <varlistentry id="xgettext">
316        <term><command>xgettext</command></term>
317        <listitem>
318          <para>Extracts the translatable message lines from the given source
319          files to make the first translation template</para>
320          <indexterm zone="ch-system-gettext xgettext">
321            <primary sortas="b-xgettext">xgettext</primary>
322          </indexterm>
323        </listitem>
324      </varlistentry>
325
326      <varlistentry id="libasprintf">
327        <term><filename class="libraryfile">libasprintf</filename></term>
328        <listitem>
329          <para>defines the <emphasis>autosprintf</emphasis> class, which makes
330          C formatted output routines usable in C++ programs, for use with the
331          <emphasis>&lt;string&gt;</emphasis> strings and the
332          <emphasis>&lt;iostream&gt;</emphasis> streams</para>
333          <indexterm zone="ch-system-gettext libasprintf">
334            <primary sortas="c-libasprintf">libasprintf</primary>
335          </indexterm>
336        </listitem>
337      </varlistentry>
338
339      <varlistentry id="libgettextlib">
340        <term><filename class="libraryfile">libgettextlib</filename></term>
341        <listitem>
342          <para>a private library containing common routines used by the
343          various Gettext programs; these are not intended for general use</para>
344          <indexterm zone="ch-system-gettext libgettextlib">
345            <primary sortas="c-libgettextlib">libgettextlib</primary>
346          </indexterm>
347        </listitem>
348      </varlistentry>
349
350      <varlistentry id="libgettextpo">
351        <term><filename class="libraryfile">libgettextpo</filename></term>
352        <listitem>
353          <para>Used to write specialized programs that process
354          <filename class="extension">.po</filename> files; this library is
355          used when the standard applications shipped with Gettext (such as
356          <command>msgcomm</command>, <command>msgcmp</command>,
357          <command>msgattrib</command>, and <command>msgen</command>) will
358          not suffice</para>
359          <indexterm zone="ch-system-gettext libgettextpo">
360            <primary sortas="c-libgettextpo">libgettextpo</primary>
361          </indexterm>
362        </listitem>
363      </varlistentry>
364
365      <varlistentry id="libgettextsrc">
366        <term><filename class="libraryfile">libgettextsrc</filename></term>
367        <listitem>
368          <para>A private library containing common routines used by the
369          various Gettext programs; these are not intended for general use</para>
370          <indexterm zone="ch-system-gettext libgettextsrc">
371            <primary sortas="c-libgettextsrc">libgettextsrc</primary>
372          </indexterm>
373        </listitem>
374      </varlistentry>
375
376    </variablelist>
377
378  </sect2>
379
380</sect1>
Note: See TracBrowser for help on using the repository browser.