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

Last change on this file since 713696e was cee2ca2, checked in by Joe Ciccone <jciccone@…>, 18 years ago

Went through and made sure that every package in the final system that needs both --build and --host has them.

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