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

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

Added a sysroot wrapper.
Updated the build variables section of the book, each package uses its own.

  • Property mode set to 100644
File size: 14.1 KB
Line 
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 <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 &env-target;
28
29 <sect2 role="installation">
30 <title>Installation of Gettext</title>
31
32 <para os="c1">When Cross Compiling the configure script does not
33 run a select few tests, Set the values manually:</para>
34
35<screen os="c2"><userinput>cat &gt; config.cache &lt;&lt; EOF
36am_cv_func_iconv_works=yes
37gl_cv_func_wcwidth_works=yes
38gt_cv_func_printf_posix=yes
39gt_cv_int_divbyzero_sigfpe=yes
40EOF</userinput></screen>
41
42 <para os="a">Prepare Gettext for compilation:</para>
43
44<screen os="b"><userinput>./configure --build=${CLFS_HOST} --host=${CLFS_TARGET} \
45 --prefix=/usr --cache-file=config.cache</userinput></screen>
46
47 <para os="c">Compile the package:</para>
48
49<screen os="d"><userinput>make</userinput></screen>
50
51 <para os="e">Install the package:</para>
52
53<screen os="f"><userinput>make DESTDIR=${CLFS} install</userinput></screen>
54
55 </sect2>
56
57 <sect2 id="contents-gettext" role="content">
58 <title>Contents of Gettext</title>
59
60 <segmentedlist>
61 <segtitle>Installed programs</segtitle>
62 <segtitle>Installed libraries</segtitle>
63
64 <seglistitem>
65 <seg>autopoint, config.charset, config.rpath, envsubst, gettext, gettext.sh,
66 gettextize, hostname, msgattrib, msgcat, msgcmp, msgcomm, msgconv, msgen,
67 msgexec, msgfilter, msgfmt, msggrep, msginit, msgmerge, msgunfmt, msguniq,
68 ngettext, and xgettext</seg>
69 <seg>libasprintf.[a,so], libgettextlib.so, libgettextpo.[a,so], and
70 libgettextsrc.so</seg>
71 </seglistitem>
72 </segmentedlist>
73
74 <variablelist>
75 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
76 <?dbfo list-presentation="list"?>
77 <?dbhtml list-presentation="table"?>
78
79 <varlistentry id="autopoint">
80 <term><command>autopoint</command></term>
81 <listitem>
82 <para>Copies standard Gettext infrastructure files into a source
83 package</para>
84 <indexterm zone="ch-system-gettext autopoint">
85 <primary sortas="b-autopoint">autopoint</primary>
86 </indexterm>
87 </listitem>
88 </varlistentry>
89
90 <varlistentry id="config.charset">
91 <term><command>config.charset</command></term>
92 <listitem>
93 <para>Outputs a system-dependent table of character encoding
94 aliases</para>
95 <indexterm zone="ch-system-gettext config.charset">
96 <primary sortas="b-config.charset">config.charset</primary>
97 </indexterm>
98 </listitem>
99 </varlistentry>
100
101 <varlistentry id="config.rpath">
102 <term><command>config.rpath</command></term>
103 <listitem>
104 <para>Outputs a system-dependent set of variables, describing how
105 to set the runtime search path of shared libraries in an
106 executable</para>
107 <indexterm zone="ch-system-gettext config.rpath">
108 <primary sortas="b-config.rpath">config.rpath</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="hostname-gettext">
156 <term><command>hostname</command></term>
157 <listitem>
158 <para>Displays a network hostname in various forms</para>
159 <indexterm zone="ch-system-gettext hostname-gettext">
160 <primary sortas="b-hostname-gettext">hostname</primary>
161 </indexterm>
162 </listitem>
163 </varlistentry>
164
165 <varlistentry id="msgattrib">
166 <term><command>msgattrib</command></term>
167 <listitem>
168 <para>Filters the messages of a translation catalog according to their
169 attributes and manipulates the attributes</para>
170 <indexterm zone="ch-system-gettext msgattrib">
171 <primary sortas="b-msgattrib">msgattrib</primary>
172 </indexterm>
173 </listitem>
174 </varlistentry>
175
176 <varlistentry id="msgcat">
177 <term><command>msgcat</command></term>
178 <listitem>
179 <para>Concatenates and merges the given
180 <filename class="extension">.po</filename> files</para>
181 <indexterm zone="ch-system-gettext msgcat">
182 <primary sortas="b-msgcat">msgcat</primary>
183 </indexterm>
184 </listitem>
185 </varlistentry>
186
187 <varlistentry id="msgcmp">
188 <term><command>msgcmp</command></term>
189 <listitem>
190 <para>Compares two <filename class="extension">.po</filename>
191 files to check that both contain the same set of msgid strings</para>
192 <indexterm zone="ch-system-gettext msgcmp">
193 <primary sortas="b-msgcmp">msgcmp</primary>
194 </indexterm>
195 </listitem>
196 </varlistentry>
197
198 <varlistentry id="msgcomm">
199 <term><command>msgcomm</command></term>
200 <listitem>
201 <para>Finds the messages that are common to to the given
202 <filename class="extension">.po</filename> files</para>
203 <indexterm zone="ch-system-gettext msgcomm">
204 <primary sortas="b-msgcomm">msgcomm</primary>
205 </indexterm>
206 </listitem>
207 </varlistentry>
208
209 <varlistentry id="msgconv">
210 <term><command>msgconv</command></term>
211 <listitem>
212 <para>Converts a translation catalog to a different character
213 encoding</para>
214 <indexterm zone="ch-system-gettext msgconv">
215 <primary sortas="b-msgconv">msgconv</primary>
216 </indexterm>
217 </listitem>
218 </varlistentry>
219
220 <varlistentry id="msgen">
221 <term><command>msgen</command></term>
222 <listitem>
223 <para>Creates an English translation catalog</para>
224 <indexterm zone="ch-system-gettext msgen">
225 <primary sortas="b-msgen">msgen</primary>
226 </indexterm>
227 </listitem>
228 </varlistentry>
229
230 <varlistentry id="msgexec">
231 <term><command>msgexec</command></term>
232 <listitem>
233 <para>Applies a command to all translations of a translation
234 catalog</para>
235 <indexterm zone="ch-system-gettext msgexec">
236 <primary sortas="b-msgexec">msgexec</primary>
237 </indexterm>
238 </listitem>
239 </varlistentry>
240
241 <varlistentry id="msgfilter">
242 <term><command>msgfilter</command></term>
243 <listitem>
244 <para>Applies a filter to all translations of a translation
245 catalog</para>
246 <indexterm zone="ch-system-gettext msgfilter">
247 <primary sortas="b-msgfilter">msgfilter</primary>
248 </indexterm>
249 </listitem>
250 </varlistentry>
251
252 <varlistentry id="msgfmt">
253 <term><command>msgfmt</command></term>
254 <listitem>
255 <para>Generates a binary message catalog from a translation
256 catalog</para>
257 <indexterm zone="ch-system-gettext msgfmt">
258 <primary sortas="b-msgfmt">msgfmt</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="msggrep">
264 <term><command>msggrep</command></term>
265 <listitem>
266 <para>Extracts all messages of a translation catalog that match a
267 given pattern or belong to some given source files</para>
268 <indexterm zone="ch-system-gettext msggrep">
269 <primary sortas="b-msggrep">msggrep</primary>
270 </indexterm>
271 </listitem>
272 </varlistentry>
273
274 <varlistentry id="msginit">
275 <term><command>msginit</command></term>
276 <listitem>
277 <para>Creates a new <filename class="extension">.po</filename> file,
278 initializing the meta information with values from the user's
279 environment</para>
280 <indexterm zone="ch-system-gettext msginit">
281 <primary sortas="b-msginit">msginit</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="msgmerge">
287 <term><command>msgmerge</command></term>
288 <listitem>
289 <para>Combines two raw translations into a single file</para>
290 <indexterm zone="ch-system-gettext msgmerge">
291 <primary sortas="b-msgmerge">msgmerge</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="msgunfmt">
297 <term><command>msgunfmt</command></term>
298 <listitem>
299 <para>Decompiles a binary message catalog into raw translation
300 text</para>
301 <indexterm zone="ch-system-gettext msgunfmt">
302 <primary sortas="b-msgunfmt">msgunfmt</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="msguniq">
308 <term><command>msguniq</command></term>
309 <listitem>
310 <para>Unifies duplicate translations in a translation catalog</para>
311 <indexterm zone="ch-system-gettext msguniq">
312 <primary sortas="b-msguniq">msguniq</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="ngettext">
318 <term><command>ngettext</command></term>
319 <listitem>
320 <para>Displays native language translations of a textual message whose
321 grammatical form depends on a number</para>
322 <indexterm zone="ch-system-gettext ngettext">
323 <primary sortas="b-ngettext">ngettext</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 </variablelist>
390
391 </sect2>
392
393</sect1>
Note: See TracBrowser for help on using the repository browser.