gettext.xml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  3. <!ENTITY % general-entities SYSTEM "../general.ent">
  4. <!ENTITY % patches-entities SYSTEM "../patches.ent">
  5. %general-entities;
  6. %patches-entities;
  7. ]>
  8. <sect1 id="ch-system-gettext" role="wrap">
  9. <title>Gettext-&gettext-version;</title>
  10. <?dbhtml filename="gettext.html"?>
  11. <indexterm zone="ch-system-gettext"><primary sortas="a-Gettext">Gettext</primary></indexterm>
  12. <sect2 role="package"><title/>
  13. <para>The Gettext package contains utilities for internationalization and
  14. localization. These allow programs to be compiled with NLS, enabling them
  15. to output messages in the user's native language.</para>
  16. <segmentedlist>
  17. <segtitle>&buildtime;</segtitle>
  18. <segtitle>&diskspace;</segtitle>
  19. <seglistitem><seg>1.2 SBU</seg><seg>46.4 MB</seg></seglistitem>
  20. </segmentedlist>
  21. <segmentedlist>
  22. <segtitle>&dependencies;</segtitle>
  23. <seglistitem><seg>Bash, Binutils, Bison, Coreutils,
  24. Diffutils, Gawk, GCC, Glibc, Grep, Make, and Sed</seg></seglistitem>
  25. </segmentedlist>
  26. </sect2>
  27. <sect2 role="installation">
  28. <title>Installation of Gettext</title>
  29. <para>Prepare Gettext for compilation:</para>
  30. <screen><userinput>./configure --prefix=/usr</userinput></screen>
  31. <para>Compile the package:</para>
  32. <screen><userinput>make</userinput></screen>
  33. <para>To test the results, issue:
  34. <userinput>make check</userinput>. This takes a very long time, around
  35. 7 SBUs.</para>
  36. <para>Install the package:</para>
  37. <screen><userinput>make install</userinput></screen>
  38. </sect2>
  39. <sect2 id="contents-gettext" role="content"><title>Contents of Gettext</title>
  40. <segmentedlist>
  41. <segtitle>Installed programs</segtitle>
  42. <segtitle>Installed libraries</segtitle>
  43. <seglistitem><seg>autopoint, config.charset, config.rpath, envsubst, gettext,
  44. gettextize, hostname, msgattrib, msgcat, msgcmp, msgcomm, msgconv, msgen,
  45. msgexec, msgfilter, msgfmt, msggrep, msginit, msgmerge, msgunfmt, msguniq,
  46. ngettext, and xgettext</seg>
  47. <seg>libasprintf[a,so], libgettextlib.so, libgettextpo[a,so] and libgettextsrc.so</seg></seglistitem>
  48. </segmentedlist>
  49. <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
  50. <?dbfo list-presentation="list"?>
  51. <?dbhtml list-presentation="table"?>
  52. <varlistentry id="autopoint">
  53. <term><command>autopoint</command></term>
  54. <listitem>
  55. <para>Copies standard Gettext infrastructure files into a source package</para>
  56. <indexterm zone="ch-system-gettext autopoint"><primary sortas="b-autopoint">autopoint</primary></indexterm>
  57. </listitem>
  58. </varlistentry>
  59. <varlistentry id="config.charset">
  60. <term><command>config.charset</command></term>
  61. <listitem>
  62. <para>Outputs a system-dependent table of character encoding aliases</para>
  63. <indexterm zone="ch-system-gettext config.charset"><primary sortas="b-config.charset">config.charset</primary></indexterm>
  64. </listitem>
  65. </varlistentry>
  66. <varlistentry id="config.rpath">
  67. <term><command>config.rpath</command></term>
  68. <listitem>
  69. <para>Outputs a system-dependent set of variables, describing how to set the
  70. runtime search path of shared libraries in an executable</para>
  71. <indexterm zone="ch-system-gettext config.rpath"><primary sortas="b-config.rpath">config.rpath</primary></indexterm>
  72. </listitem>
  73. </varlistentry>
  74. <varlistentry id="envsubst">
  75. <term><command>envsubst</command></term>
  76. <listitem>
  77. <para>Substitutes environment variables in shell format strings</para>
  78. <indexterm zone="ch-system-gettext envsubst"><primary sortas="b-envsubst">envsubst</primary></indexterm>
  79. </listitem>
  80. </varlistentry>
  81. <varlistentry id="gettext">
  82. <term><command>gettext</command></term>
  83. <listitem>
  84. <para>Translates a natural language message into the user's language
  85. by looking up the translation in a message catalog</para>
  86. <indexterm zone="ch-system-gettext gettext"><primary sortas="b-gettext">gettext</primary></indexterm>
  87. </listitem>
  88. </varlistentry>
  89. <varlistentry id="gettextize">
  90. <term><command>gettextize</command></term>
  91. <listitem>
  92. <para>Copies all standard Gettext files into the given top-level
  93. directory of a package to begin internationalizing it</para>
  94. <indexterm zone="ch-system-gettext gettextize"><primary sortas="b-gettextize">gettextize</primary></indexterm>
  95. </listitem>
  96. </varlistentry>
  97. <varlistentry id="hostname-gettext">
  98. <term><command>hostname</command></term>
  99. <listitem>
  100. <para>Displays a network hostname in various forms</para>
  101. <indexterm zone="ch-system-gettext hostname-gettext"><primary sortas="b-hostname-gettext">hostname</primary></indexterm>
  102. </listitem>
  103. </varlistentry>
  104. <varlistentry id="msgattrib">
  105. <term><command>msgattrib</command></term>
  106. <listitem>
  107. <para>Filters the messages of a translation catalog according to their
  108. attributes and manipulates the attributes</para>
  109. <indexterm zone="ch-system-gettext msgattrib"><primary sortas="b-msgattrib">msgattrib</primary></indexterm>
  110. </listitem>
  111. </varlistentry>
  112. <varlistentry id="msgcat">
  113. <term><command>msgcat</command></term>
  114. <listitem>
  115. <para>Concatenates and merges the given <filename class="extension">.po</filename> files</para>
  116. <indexterm zone="ch-system-gettext msgcat"><primary sortas="b-msgcat">msgcat</primary></indexterm>
  117. </listitem>
  118. </varlistentry>
  119. <varlistentry id="msgcmp">
  120. <term><command>msgcmp</command></term>
  121. <listitem>
  122. <para>Compares two <filename class="extension">.po</filename>
  123. files to check that both contain the same set of msgid strings</para>
  124. <indexterm zone="ch-system-gettext msgcmp"><primary sortas="b-msgcmp">msgcmp</primary></indexterm>
  125. </listitem>
  126. </varlistentry>
  127. <varlistentry id="msgcomm">
  128. <term><command>msgcomm</command></term>
  129. <listitem>
  130. <para>Finds the messages that are common to
  131. to the given <filename class="extension">.po</filename> files</para>
  132. <indexterm zone="ch-system-gettext msgcomm"><primary sortas="b-msgcomm">msgcomm</primary></indexterm>
  133. </listitem>
  134. </varlistentry>
  135. <varlistentry id="msgconv">
  136. <term><command>msgconv</command></term>
  137. <listitem>
  138. <para>Converts a translation catalog to a different character encoding</para>
  139. <indexterm zone="ch-system-gettext msgconv"><primary sortas="b-msgconv">msgconv</primary></indexterm>
  140. </listitem>
  141. </varlistentry>
  142. <varlistentry id="msgen">
  143. <term><command>msgen</command></term>
  144. <listitem>
  145. <para>Creates an English translation catalog</para>
  146. <indexterm zone="ch-system-gettext msgen"><primary sortas="b-msgen">msgen</primary></indexterm>
  147. </listitem>
  148. </varlistentry>
  149. <varlistentry id="msgexec">
  150. <term><command>msgexec</command></term>
  151. <listitem>
  152. <para>Applies a command to all translations of a translation catalog</para>
  153. <indexterm zone="ch-system-gettext msgexec"><primary sortas="b-msgexec">msgexec</primary></indexterm>
  154. </listitem>
  155. </varlistentry>
  156. <varlistentry id="msgfilter">
  157. <term><command>msgfilter</command></term>
  158. <listitem>
  159. <para>Applies a filter to all translations of a translation catalog</para>
  160. <indexterm zone="ch-system-gettext msgfilter"><primary sortas="b-msgfilter">msgfilter</primary></indexterm>
  161. </listitem>
  162. </varlistentry>
  163. <varlistentry id="msgfmt">
  164. <term><command>msgfmt</command></term>
  165. <listitem>
  166. <para>Generates a binary message catalog from from a translation catalog</para>
  167. <indexterm zone="ch-system-gettext msgfmt"><primary sortas="b-msgfmt">msgfmt</primary></indexterm>
  168. </listitem>
  169. </varlistentry>
  170. <varlistentry id="msggrep">
  171. <term><command>msggrep</command></term>
  172. <listitem>
  173. <para>Extracts all messages of a translation catalog that match a
  174. given pattern or belong to some given source files</para>
  175. <indexterm zone="ch-system-gettext msggrep"><primary sortas="b-msggrep">msggrep</primary></indexterm>
  176. </listitem>
  177. </varlistentry>
  178. <varlistentry id="msginit">
  179. <term><command>msginit</command></term>
  180. <listitem>
  181. <para>Creates a new <filename class="extension">.po</filename> file, initializing the meta
  182. information with values from the user's environment</para>
  183. <indexterm zone="ch-system-gettext msginit"><primary sortas="b-msginit">msginit</primary></indexterm>
  184. </listitem>
  185. </varlistentry>
  186. <varlistentry id="msgmerge">
  187. <term><command>msgmerge</command></term>
  188. <listitem>
  189. <para>Combines two raw translations into a single file</para>
  190. <indexterm zone="ch-system-gettext msgmerge"><primary sortas="b-msgmerge">msgmerge</primary></indexterm>
  191. </listitem>
  192. </varlistentry>
  193. <varlistentry id="msgunfmt">
  194. <term><command>msgunfmt</command></term>
  195. <listitem>
  196. <para>Decompiles a binary message catalog into raw translation text</para>
  197. <indexterm zone="ch-system-gettext msgunfmt"><primary sortas="b-msgunfmt">msgunfmt</primary></indexterm>
  198. </listitem>
  199. </varlistentry>
  200. <varlistentry id="msguniq">
  201. <term><command>msguniq</command></term>
  202. <listitem>
  203. <para>Unifies duplicate translations in a translation catalog</para>
  204. <indexterm zone="ch-system-gettext msguniq"><primary sortas="b-msguniq">msguniq</primary></indexterm>
  205. </listitem>
  206. </varlistentry>
  207. <varlistentry id="ngettext">
  208. <term><command>ngettext</command></term>
  209. <listitem>
  210. <para>Displays native language translations of a textual message whose
  211. grammatical form depends on a number</para>
  212. <indexterm zone="ch-system-gettext ngettext"><primary sortas="b-ngettext">ngettext</primary></indexterm>
  213. </listitem>
  214. </varlistentry>
  215. <varlistentry id="xgettext">
  216. <term><command>xgettext</command></term>
  217. <listitem>
  218. <para>Extracts the translatable message lines from the given source
  219. files to make the first translation template</para>
  220. <indexterm zone="ch-system-gettext xgettext"><primary sortas="b-xgettext">xgettext</primary></indexterm>
  221. </listitem>
  222. </varlistentry>
  223. <varlistentry id="libasprintf">
  224. <term><filename class="libraryfile">libasprintf</filename></term>
  225. <listitem>
  226. <para>defines the <emphasis>autosprintf</emphasis> class, which makes
  227. C formatted output routines usable in C++ programs, for use with the
  228. <emphasis>&lt;string&gt;</emphasis> strings and the
  229. <emphasis>&lt;iostream&gt;</emphasis> streams</para>
  230. <indexterm zone="ch-system-gettext libasprintf"><primary sortas="c-libasprintf">libasprintf</primary></indexterm>
  231. </listitem>
  232. </varlistentry>
  233. <varlistentry id="libgettextlib">
  234. <term><filename class="libraryfile">libgettextlib</filename></term>
  235. <listitem>
  236. <para>a private library containing common routines used by the various Gettext
  237. programs; these are not intended for general use</para>
  238. <indexterm zone="ch-system-gettext libgettextlib"><primary sortas="c-libgettextlib">libgettextlib</primary></indexterm>
  239. </listitem>
  240. </varlistentry>
  241. <varlistentry id="libgettextpo">
  242. <term><filename class="libraryfile">libgettextpo</filename></term>
  243. <listitem>
  244. <para>Used to write specialized programs that process <filename
  245. class="extension">.po</filename> files; this library is used when the
  246. standard applications shipped with Gettext (such as
  247. <command>msgcomm</command>, <command>msgcmp</command>,
  248. <command>msgattrib</command>, and <command>msgen</command>) will not
  249. suffice</para>
  250. <indexterm zone="ch-system-gettext libgettextpo"><primary sortas="c-libgettextpo">libgettextpo</primary></indexterm>
  251. </listitem>
  252. </varlistentry>
  253. <varlistentry id="libgettextsrc">
  254. <term><filename class="libraryfile">libgettextsrc</filename></term>
  255. <listitem>
  256. <para>A private library containing common routines used by the various Gettext
  257. programs; these are not intended for general use</para>
  258. <indexterm zone="ch-system-gettext libgettextsrc"><primary sortas="c-libgettextsrc">libgettextsrc</primary></indexterm>
  259. </listitem>
  260. </varlistentry>
  261. </variablelist>
  262. </sect2>
  263. </sect1>