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

clfs-3.0.0-systemdsystemd
Last change on this file since d4469fc was f698055a, checked in by Chris Staub <chris@…>, 10 years ago

Improve consistency in package installation lists, mainly removing 'and'

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