source: BOOK/final-system/common/gettext.xml@ 5f80049

sysvinit
Last change on this file since 5f80049 was b27081c4, checked in by Chris Staub <chris@…>, 9 years ago

Put one configure option per line

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