source: final-system/common/gettext.xml@ f1acf6b

Last change on this file since f1acf6b was 0f06076, checked in by Jim Gifford <clfs@…>, 19 years ago

r3371@server (orig r1554): chris | 2006-05-10 14:03:44 -0700
Removed dependency info from individual package instructions

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