source: BOOK/final-system/common/gettext.xml@ 36e8256

Last change on this file since 36e8256 was 67300de, checked in by Joe Ciccone <jciccone@…>, 16 years ago

Create a clfs-1.1 branch in preperation for a RC.

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