source: BOOK/final-system/common/gettext.xml @ 686839b

clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 686839b was 686839b, checked in by William Harrington <kb0iic@…>, 10 years ago

Add screen tags around userinput test commands and remap userinput for test commands as remap="test".

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