From: Bruno Haible Date: Mon, 25 Jul 2005 11:14:10 +0000 (+0000) Subject: Regenerated. X-Git-Tag: v0.15~472 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c96dc4bbd104ac3cb452ab362a5901e8cc3a6f8f;p=thirdparty%2Fgettext.git Regenerated. --- diff --git a/gettext-tools/doc/gettext_1.html b/gettext-tools/doc/gettext_1.html index c153870fd..ff66cb9b4 100644 --- a/gettext-tools/doc/gettext_1.html +++ b/gettext-tools/doc/gettext_1.html @@ -1,12 +1,12 @@ + from gettext.texi on 21 July 2005 --> GNU gettext utilities - 1 Introduction -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

@@ -176,7 +176,7 @@ by which the programs are untied from calling only English strings or other English specific habits, and connected to generic ways of doing the same, instead. Program developers may use various techniques to internationalize their programs. Some of these have been standardized. -GNU gettext offers one of these standards. See section 10 The Programmer's View. +GNU gettext offers one of these standards. See section 11 The Programmer's View.

@@ -503,7 +503,7 @@ which are meant to be translatable, and those which are untranslatable. This tedious job can be done a little more comfortably using emacs PO mode, but you can use any means familiar to you for modifying your C sources. Beside this some other simple, standard changes are needed to -properly initialize the translation library. See section 3 Preparing Program Sources, for +properly initialize the translation library. See section 4 Preparing Program Sources, for more information about all this.

@@ -557,10 +557,10 @@ contains all original program strings. It has sets of pointers to exactly where in C sources each string is used. All translations are set to empty. The letter t in `.pot´ marks this as a Template PO file, not yet oriented towards any particular language. -See section 4.1 Invoking the xgettext Program, for more details about how one calls the +See section 5.1 Invoking the xgettext Program, for more details about how one calls the xgettext program. If you are really lazy, you might be interested at working a lot more right away, and preparing the -whole distribution setup (see section 12 The Maintainer's View). By doing so, you +whole distribution setup (see section 13 The Maintainer's View). By doing so, you spare yourself typing the xgettext command, as make should now generate the proper things automatically for you! @@ -569,7 +569,7 @@ should now generate the proper things automatically for you! The first time through, there is no `lang.po´ yet, so the msgmerge step may be skipped and replaced by a mere copy of `package.pot´ to `lang.po´, where lang -represents the target language. See section 5 Creating a New PO File for details. +represents the target language. See section 6 Creating a New PO File for details.

@@ -577,7 +577,7 @@ Then comes the initial translation of messages. Translation in itself is a whole matter, still exclusively meant for humans, and whose complexity far overwhelms the level of this manual. Nevertheless, a few hints are given in some other chapter of this -manual (see section 11 The Translator's View). You will also find there indications +manual (see section 12 The Translator's View). You will also find there indications about how to contact translating teams, or becoming part of them, for sharing your translating concerns with others who target the same native language. @@ -587,21 +587,21 @@ native language. While adding the translated messages into the `lang.po´ PO file, if you do not have Emacs handy, you are on your own for ensuring that your efforts fully respect the PO file format, and quoting -conventions (see section 2.2 The Format of PO Files). This is surely not an impossible task, +conventions (see section 3 The Format of PO Files). This is surely not an impossible task, as this is the way many people have handled PO files already for Uniforum or Solaris. On the other hand, by using PO mode in Emacs, most details of PO file format are taken care of for you, but you have to acquire some familiarity with PO mode itself. Besides main PO mode commands -(see section 2.3 Main PO mode Commands), you should know how to move between entries -(see section 2.4 Entry Positioning), and how to handle untranslated entries -(see section 6.4 Untranslated Entries). +(see section 8.3.2 Main PO mode Commands), you should know how to move between entries +(see section 8.3.3 Entry Positioning), and how to handle untranslated entries +(see section 8.3.7 Untranslated Entries).

If some common translations have already been saved into a compendium PO file, translators may use PO mode for initializing untranslated entries from the compendium, and also save selected translations into -the compendium, updating it (see section 6.11 Using Translation Compendia). Compendium files +the compendium, updating it (see section 8.3.14 Using Translation Compendia). Compendium files are meant to be exchanged between members of a given translation team.

@@ -647,8 +647,8 @@ out of recent C sources. The refreshing operation adjusts all references to C source locations for strings, since these strings move as programs are modified. Also, msgmerge comments out as obsolete, in `lang.po´, those already translated entries -which are no longer used in the program sources (see section 6.5 Obsolete Entries). It finally discovers new strings and inserts them in -the resulting PO file as untranslated entries (see section 6.4 Untranslated Entries). See section 6.1 Invoking the msgmerge Program, for more information about what +which are no longer used in the program sources (see section 8.3.8 Obsolete Entries). It finally discovers new strings and inserts them in +the resulting PO file as untranslated entries (see section 8.3.7 Untranslated Entries). See section 7.1 Invoking the msgmerge Program, for more information about what msgmerge really does.

@@ -678,7 +678,7 @@ distribution. Once the PO file is complete and dependable, the msgfmt program is used for turning the PO file into a machine-oriented format, which may yield efficient retrieval of translations by the programs of the -package, whenever needed at runtime (see section 8.3 The Format of GNU MO Files). See section 8.1 Invoking the msgfmt Program, for more information about all modes of execution +package, whenever needed at runtime (see section 10.3 The Format of GNU MO Files). See section 10.1 Invoking the msgfmt Program, for more information about all modes of execution for the msgfmt program.

@@ -688,7 +688,7 @@ with the GNU gettext library, usually through the operation of make, given a suitable `Makefile´ exists for the project, and the resulting executable is installed somewhere users will find it. The MO files themselves should also be properly installed. Given the -appropriate environment variables are set (see section 9.3 Magic for End Users), the +appropriate environment variables are set (see section 2.2 Magic for End Users), the program should localize itself automatically, whenever it executes.

@@ -698,6 +698,6 @@ steps outlined above.

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_10.html b/gettext-tools/doc/gettext_10.html index 497c0738c..965b3dbcb 100644 --- a/gettext-tools/doc/gettext_10.html +++ b/gettext-tools/doc/gettext_10.html @@ -1,1502 +1,868 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - 10 The Programmer's View +GNU gettext utilities - 10 Producing Binary MO Files -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

10 The Programmer's View

10 Producing Binary MO Files

-One aim of the current message catalog implementation provided by -GNU gettext was to use the system's message catalog handling, if the -installer wishes to do so. So we perhaps should first take a look at -the solutions we know about. The people in the POSIX committee did not -manage to agree on one of the semi-official standards which we'll -describe below. In fact they couldn't agree on anything, so they decided -only to include an example of an interface. The major Unix vendors -are split in the usage of the two most important specifications: X/Open's -catgets vs. Uniforum's gettext interface. We'll describe them both and -later explain our solution of this dilemma. - -

- - - -

10.1 About `catgets`

- - -

-The catgets implementation is defined in the X/Open Portability -Guide, Volume 3, XSI Supplementary Definitions, Chapter 5. But the -process of creating this standard seemed to be too slow for some of -the Unix vendors so they created their implementations on preliminary -versions of the standard. Of course this leads again to problems while -writing platform independent programs: even the usage of catgets -does not guarantee a unique interface. - -

-Another, personal comment on this that only a bunch of committee members -could have made this interface. They never really tried to program -using this interface. It is a fast, memory-saving implementation, an -user can happily live with it. But programmers hate it (at least I and -some others do...) - -

-But we must not forget one point: after all the trouble with transfering -the rights on Unix(tm) they at last came to X/Open, the very same who -published this specification. This leads me to making the prediction -that this interface will be in future Unix standards (e.g. Spec1170) and -therefore part of all Unix implementation (implementations, which are -allowed to wear this name). - -

- - - -

10.1.1 The Interface

- - -

-The interface to the catgets implementation consists of three -functions which correspond to those used in file access: catopen -to open the catalog for using, catgets for accessing the message -tables, and catclose for closing after work is done. Prototypes -for the functions and the needed definitions are in the -<nl_types.h> header file. - -

- -catopen is used like in this: - -

- -

-nl_catd catd = catopen ("catalog_name", 0);
-

- -

-The function takes as the argument the name of the catalog. This usual -refers to the name of the program or the package. The second parameter -is not further specified in the standard. I don't even know whether it -is implemented consistently among various systems. So the common advice -is to use 0 as the value. The return value is a handle to the -message catalog, equivalent to handles to file returned by open. - -

- -This handle is of course used in the catgets function which can -be used like this: - -

- -

-char *translation = catgets (catd, set_no, msg_id, "original string");
-

- -

-The first parameter is this catalog descriptor. The second parameter -specifies the set of messages in this catalog, in which the message -described by msg_id is obtained. catgets therefore uses a -three-stage addressing: - -

- -

-catalog name => set number => message ID => translation
-

- -

-The fourth argument is not used to address the translation. It is given -as a default value in case when one of the addressing stages fail. One -important thing to remember is that although the return type of catgets -is char * the resulting string must not be changed. It -should better be const char *, but the standard is published in -1988, one year before ANSI C. - -

- -The last of these functions is used and behaves as expected: - -

- -

-catclose (catd);
-

- -

-After this no catgets call using the descriptor is legal anymore. - -

- - -

10.1.2 Problems with the `catgets` Interface?!

- - -

-Now that this description seemed to be really easy -- where are the -problems we speak of? In fact the interface could be used in a -reasonable way, but constructing the message catalogs is a pain. The -reason for this lies in the third argument of catgets: the unique -message ID. This has to be a numeric value for all messages in a single -set. Perhaps you could imagine the problems keeping such a list while -changing the source code. Add a new message here, remove one there. Of -course there have been developed a lot of tools helping to organize this -chaos but one as the other fails in one aspect or the other. We don't -want to say that the other approach has no problems but they are far -more easy to manage. - -

- - -

10.2 About `gettext`

- - -

-The definition of the gettext interface comes from a Uniforum -proposal. It was submitted there by Sun, who had implemented the -gettext function in SunOS 4, around 1990. Nowadays, the -gettext interface is specified by the OpenI18N standard. - -

-The main point about this solution is that it does not follow the -method of normal file handling (open-use-close) and that it does not -burden the programmer with so many tasks, especially the unique key handling. -Of course here also a unique key is needed, but this key is the message -itself (how long or short it is). See section 10.3 Comparing the Two Interfaces for a more -detailed comparison of the two methods. - -

-The following section contains a rather detailed description of the -interface. We make it that detailed because this is the interface -we chose for the GNU gettext Library. Programmers interested -in using this library will be interested in this description. - -

- - - -

10.2.1 The Interface

- - -

-The minimal functionality an interface must have is a) to select a -domain the strings are coming from (a single domain for all programs is -not reasonable because its construction and maintenance is difficult, -perhaps impossible) and b) to access a string in a selected domain. - -

-This is principally the description of the gettext interface. It -has a global domain which unqualified usages reference. Of course this -domain is selectable by the user. - -

- -

-char *textdomain (const char *domain_name);
-

- -

-This provides the possibility to change or query the current status of -the current global domain of the LC_MESSAGE category. The -argument is a null-terminated string, whose characters must be legal in -the use in filenames. If the domain_name argument is NULL, -the function returns the current value. If no value has been set -before, the name of the default domain is returned: messages. -Please note that although the return value of textdomain is of -type char * no changing is allowed. It is also important to know -that no checks of the availability are made. If the name is not -available you will see this by the fact that no translations are provided. - -

-To use a domain set by textdomain the function - -

- -

-char *gettext (const char *msgid);
-

- -

-is to be used. This is the simplest reasonable form one can imagine. -The translation of the string msgid is returned if it is available -in the current domain. If it is not available, the argument itself is -returned. If the argument is NULL the result is undefined. - -

-One thing which should come into mind is that no explicit dependency to -the used domain is given. The current value of the domain for the -LC_MESSAGES locale is used. If this changes between two -executions of the same gettext call in the program, both calls -reference a different message catalog. - -

-For the easiest case, which is normally used in internationalized -packages, once at the beginning of execution a call to textdomain -is issued, setting the domain to a unique name, normally the package -name. In the following code all strings which have to be translated are -filtered through the gettext function. That's all, the package speaks -your language. - -

- - -

10.2.2 Solving Ambiguities

- - - - -

-While this single name domain works well for most applications there -might be the need to get translations from more than one domain. Of -course one could switch between different domains with calls to -textdomain, but this is really not convenient nor is it fast. A -possible situation could be one case subject to discussion during this -writing: all -error messages of functions in the set of common used functions should -go into a separate domain error. By this mean we would only need -to translate them once. -Another case are messages from a library, as these have to be -independent of the current domain set by the application. - -

-For this reasons there are two more functions to retrieve strings: - -

- -

-char *dgettext (const char *domain_name, const char *msgid);
-char *dcgettext (const char *domain_name, const char *msgid,
-                 int category);
-

- -

-Both take an additional argument at the first place, which corresponds -to the argument of textdomain. The third argument of -dcgettext allows to use another locale but LC_MESSAGES. -But I really don't know where this can be useful. If the -domain_name is NULL or category has an value beside -the known ones, the result is undefined. It should also be noted that -this function is not part of the second known implementation of this -function family, the one found in Solaris. - -

-A second ambiguity can arise by the fact, that perhaps more than one -domain has the same name. This can be solved by specifying where the -needed message catalog files can be found. - -

- -

-char *bindtextdomain (const char *domain_name,
-                      const char *dir_name);
-

- -

-Calling this function binds the given domain to a file in the specified -directory (how this file is determined follows below). Especially a -file in the systems default place is not favored against the specified -file anymore (as it would be by solely using textdomain). A -NULL pointer for the dir_name parameter returns the binding -associated with domain_name. If domain_name itself is -NULL nothing happens and a NULL pointer is returned. Here -again as for all the other functions is true that none of the return -value must be changed! - -

-It is important to remember that relative path names for the -dir_name parameter can be trouble. Since the path is always -computed relative to the current directory different results will be -achieved when the program executes a chdir command. Relative -paths should always be avoided to avoid dependencies and -unreliabilities. - -

- - -

10.2.3 Locating Message Catalog Files

- - -

-Because many different languages for many different packages have to be -stored we need some way to add these information to file message catalog -files. The way usually used in Unix environments is have this encoding -in the file name. This is also done here. The directory name given in -bindtextdomains second argument (or the default directory), -followed by the value and name of the locale and the domain name are -concatenated: -

- -

-dir_name/locale/LC_category/domain_name.mo
-

- -

-The default value for dir_name is system specific. For the GNU -library, and for packages adhering to its conventions, it's: - -

-/usr/local/share/locale
-

- -

-locale is the value of the locale whose name is this -LC_category. For gettext and dgettext this -LC_category is always LC_MESSAGES.(3) -The value of the locale is determined through -setlocale (LC_category, NULL). -(4) -dcgettext specifies the locale category by the third argument. - -

- - -

10.2.4 How to specify the output character set `gettext` uses

- - - -

-gettext not only looks up a translation in a message catalog. It -also converts the translation on the fly to the desired output character -set. This is useful if the user is working in a different character set -than the translator who created the message catalog, because it avoids -distributing variants of message catalogs which differ only in the -character set. - -

-The output character set is, by default, the value of nl_langinfo -(CODESET), which depends on the LC_CTYPE part of the current -locale. But programs which store strings in a locale independent way -(e.g. UTF-8) can request that gettext and related functions -return the translations in that encoding, by use of the -bind_textdomain_codeset function. - -

-Note that the msgid argument to gettext is not subject to -character set conversion. Also, when gettext does not find a -translation for msgid, it returns msgid unchanged -- -independently of the current output character set. It is therefore -recommended that all msgids be US-ASCII strings. - -

Function: char * bind_textdomain_codeset (const char *domainname, const char *codeset) -

-The bind_textdomain_codeset function can be used to specify the -output character set for message catalogs for domain domainname. -The codeset argument must be a valid codeset name which can be used -for the iconv_open function, or a null pointer. - -

-If the codeset parameter is the null pointer, -bind_textdomain_codeset returns the currently selected codeset -for the domain with the name domainname. It returns NULL if -no codeset has yet been selected. - -

-The bind_textdomain_codeset function can be used several times. -If used multiple times with the same domainname argument, the -later call overrides the settings made by the earlier one. - -

-The bind_textdomain_codeset function returns a pointer to a -string containing the name of the selected codeset. The string is -allocated internally in the function and must not be changed by the -user. If the system went out of core during the execution of -bind_textdomain_codeset, the return value is NULL and the -global variable errno is set accordingly. -

- -

10.1 Invoking the `msgfmt` Program

10.2.5 Additional functions for plural forms

- - -

-The functions of the gettext family described so far (and all the -catgets functions as well) have one problem in the real world -which have been neglected completely in all existing approaches. What -is meant here is the handling of plural forms. - -

-Looking through Unix source code before the time anybody thought about -internationalization (and, sadly, even afterwards) one can often find -code similar to the following: - -

- -

-   printf ("%d file%s deleted", n, n == 1 ? "" : "s");
-

- -

-After the first complaints from people internationalizing the code people -either completely avoided formulations like this or used strings like -"file(s)". Both look unnatural and should be avoided. First -tries to solve the problem correctly looked like this: - -

- -

-   if (n == 1)
-     printf ("%d file deleted", n);
-   else
-     printf ("%d files deleted", n);
-

- -

-But this does not solve the problem. It helps languages where the -plural form of a noun is not simply constructed by adding an `s' but -that is all. Once again people fell into the trap of believing the -rules their language is using are universal. But the handling of plural -forms differs widely between the language families. For example, -Rafal Maszkowski <rzm@mat.uni.torun.pl> reports: - -

- -

-
-In Polish we use e.g. plik (file) this way: + +
-1 plik
-2,3,4 pliki
-5-21 pliko'w
-22-24 pliki
-25-31 pliko'w
+msgfmt [option] filename.po ...
 
-and so on (o' means 8859-2 oacute which should be rather okreska, -similar to aogonek). -

- -

-There are two things which can differ between languages (and even inside -language families); - -

- -

- -The form how plural forms are built differs. This is a problem with -languages which have many irregularities. German, for instance, is a -drastic case. Though English and German are part of the same language -family (Germanic), the almost regular forming of plural noun forms -(appending an `s') is hardly found in German. - -
- -The number of plural forms differ. This is somewhat surprising for -those who only have experiences with Romanic and Germanic languages -since here the number is the same (there are two). - -But other language families have only one form or many forms. More -information on this in an extra section. -

- -

-The consequence of this is that application writers should not try to -solve the problem in their code. This would be localization since it is -only usable for certain, hardcoded language environments. Instead the -extended gettext interface should be used. + +The msgfmt programs generates a binary message catalog from a textual +translation description.

-These extra functions are taking instead of the one key string two -strings and a numerical argument. The idea behind this is that using -the numerical argument and the first string as a key, the implementation -can select using rules specified by the translator the right plural -form. The two string arguments then will be used to provide a return -value in case no message catalog is found (similar to the normal -gettext behavior). In this case the rules for Germanic language -is used and it is assumed that the first string argument is the singular -form, the second the plural form. -

-This has the consequence that programs without language catalogs can -display the correct strings only if the program itself is written using -a Germanic language. This is a limitation but since the GNU C library -(as well as the GNU gettext package) are written as part of the -GNU package and the coding standards for the GNU project require program -being written in English, this solution nevertheless fulfills its -purpose. -

Function: char * ngettext (const char *msgid1, const char *msgid2, unsigned long int n) -

-The ngettext function is similar to the gettext function -as it finds the message catalogs in the same way. But it takes two -extra arguments. The msgid1 parameter must contain the singular -form of the string to be converted. It is also used as the key for the -search in the catalog. The msgid2 parameter is the plural form. -The parameter n is used to determine the plural form. If no -message catalog is found msgid1 is returned if n == 1, -otherwise msgid2. +

10.1.1 Input file location

-An example for the use of this function is: - -

- -

-printf (ngettext ("%d file removed", "%d files removed", n), n);
-

- -

-Please note that the numeric value n has to be passed to the -printf function as well. It is not sufficient to pass it only to -ngettext. -

- -

Function: char * dngettext (const char *domain, const char *msgid1, const char *msgid2, unsigned long int n) -: -The dngettext is similar to the dgettext function in the -way the message catalog is selected. The difference is that it takes -two extra parameter to provide the correct plural form. These two -parameters are handled in the same way ngettext handles them. -

- -

Function: char * dcngettext (const char *domain, const char *msgid1, const char *msgid2, unsigned long int n, int category) -: -The dcngettext is similar to the dcgettext function in the -way the message catalog is selected. The difference is that it takes -two extra parameter to provide the correct plural form. These two -parameters are handled in the same way ngettext handles them. -

- -

-Now, how do these functions solve the problem of the plural forms? -Without the input of linguists (which was not available) it was not -possible to determine whether there are only a few different forms in -which plural forms are formed or whether the number can increase with -every new supported language. - -

-Therefore the solution implemented is to allow the translator to specify -the rules of how to select the plural form. Since the formula varies -with every language this is the only viable solution except for -hardcoding the information in the code (which still would require the -possibility of extensions to not prevent the use of new languages). - -

- - - -The information about the plural form selection has to be stored in the -header entry of the PO file (the one with the empty msgid string). -The plural form information looks like this: - -

- -

-Plural-Forms: nplurals=2; plural=n == 1 ? 0 : 1;
-

- -

-The nplurals value must be a decimal number which specifies how -many different plural forms exist for this language. The string -following plural is an expression which is using the C language -syntax. Exceptions are that no negative numbers are allowed, numbers -must be decimal, and the only variable allowed is n. This -expression will be evaluated whenever one of the functions -ngettext, dngettext, or dcngettext is called. The -numeric value passed to these functions is then substituted for all uses -of the variable n in the expression. The resulting value then -must be greater or equal to zero and smaller than the value given as the -value of nplurals. - -

- -The following rules are known at this point. The language with families -are listed. But this does not necessarily mean the information can be -generalized for the whole family (as can be easily seen in the table -below).(5) - -

Only one form: +

`filename.po ...´

-Some languages only require one single form. There is no distinction -between the singular and plural form. An appropriate header entry -would look like this: - - -

-Plural-Forms: nplurals=1; plural=0;
-

- -Languages with this property include: - -

Finno-Ugric family -: -Hungarian -
Asian family +
`-D directory´: -Japanese, Korean, Vietnamese -
Turkic/Altaic family -: -Turkish -

- -

Two forms, singular used for one only +

`--directory=directory´

-This is the form used in most existing programs since it is what English -is using. A header entry would look like this: - - -

-Plural-Forms: nplurals=2; plural=n != 1;
-

+ + +Add directory to the list of directories. Source files are +searched relative to this list of directories. The resulting `.po´ +file will be written relative to the current directory, though. -(Note: this uses the feature of C expressions that boolean expressions -have to value zero or one.) - -Languages with this property include: - -

Germanic family -: -Danish, Dutch, English, Faroese, German, Norwegian, Swedish -
Finno-Ugric family -: -Estonian, Finnish -
Latin/Greek family -: -Greek -
Semitic family -: -Hebrew -
Romanic family -: -Italian, Portuguese, Spanish -
Artificial -: -Esperanto

Two forms, singular used for zero and one -

-Exceptional case in the language family. The header entry would be: - - -

-Plural-Forms: nplurals=2; plural=n>1;
-

- -Languages with this property include: - -

Romanic family -: -French, Brazilian Portuguese -

- -

Three forms, special case for zero -

-The header entry would be: +

+If an input file is `-´, standard input is read. +

-Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n != 0 ? 1 : 2;
-

-Languages with this property include: +

10.1.2 Operation mode

Baltic family +
`-j´: -Latvian -

- -

Three forms, special cases for one and two +

`--java´

-The header entry would be: - + + + +Java mode: generate a Java ResourceBundle class. -

-Plural-Forms: nplurals=3; plural=n==1 ? 0 : n==2 ? 1 : 2;
-

`--java2´ +

+ +Like --java, and assume Java2 (JDK 1.2 or higher). -Languages with this property include: +

`--csharp´ +

+ + +C# mode: generate a .NET .dll file containing a subclass of +GettextResourceSet. -

`--csharp-resources´ +: + + +C# resources mode: generate a .NET `.resources´ file. -
Celtic +
`--tcl´: -Gaeilge (Irish) -

+ + +Tcl mode: generate a tcl/msgcat `.msg´ file. -

Three forms, special case for numbers ending in 1[2-9] +

`--qt´

-The header entry would look like this: + + +Qt mode: generate a Qt `.qm´ file. +

-Plural-Forms: nplurals=3; \
-    plural=n%10==1 && n%100!=11 ? 0 : \
-           n%10>=2 && (n%100<10 || n%100>=20) ? 1 : 2;
-

-Languages with this property include: + +

10.1.3 Output file location

Baltic family +
`-o file´: -Lithuanian -

`--output-file=file´ +

+ + +Write output to specified file. -

Three forms, special cases for numbers ending in 1 and 2, 3, 4, except those ending in 1[1-4] +

`--strict´

-The header entry would look like this: + +Direct the program to work strictly following the Uniforum/Sun +implementation. Currently this only affects the naming of the output +file. If this option is not given the name of the output file is the +same as the domain name. If the strict Uniforum mode is enabled the +suffix `.mo´ is added to the file name if it is not already +present. +We find this behaviour of Sun's implementation rather silly and so by +default this mode is not selected. -

-Plural-Forms: nplurals=3; \
-    plural=n%10==1 && n%100!=11 ? 0 : \
-           n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;
-

+ + +

+If the output file is `-´, output is written to standard output. + +

-Languages with this property include: + +

10.1.4 Output file location in Java mode

Slavic family +
`-r resource´: -Croatian, Serbian, Russian, Ukrainian -

`--resource=resource´ +

+ + +Specify the resource name. -

Three forms, special cases for 1 and 2, 3, 4 +

`-l locale´ +

`--locale=locale´

-The header entry would look like this: + + +Specify the locale name, either a language specification of the form ll +or a combined language and country specification of the form ll_CC. +

`-d directory´ +

+ +Specify the base directory of classes directory hierarchy. -

-Plural-Forms: nplurals=3; \
-    plural=(n==1) ? 0 : (n>=2 && n<=4) ? 1 : 2;
-

+ + +

+The class name is determined by appending the locale name to the resource name, +separated with an underscore. The `-d´ option is mandatory. The class +is written under the specified directory. + +

-Languages with this property include: + +

10.1.5 Output file location in C# mode

Slavic family +
`-r resource´: -Slovak, Czech -

`--resource=resource´ +

+ + +Specify the resource name. -

Three forms, special case for one and some numbers ending in 2, 3, or 4 +

`-l locale´ +

`--locale=locale´

-The header entry would look like this: + + +Specify the locale name, either a language specification of the form ll +or a combined language and country specification of the form ll_CC. +

`-d directory´ +

+ +Specify the base directory for locale dependent `.dll´ files. -

-Plural-Forms: nplurals=3; \
-    plural=n==1 ? 0 : \
-           n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;
-

+ + +

+The `-l´ and `-d´ options are mandatory. The `.dll´ file is +written in a subdirectory of the specified directory whose name depends on the +locale. + +

-Languages with this property include: + +

10.1.6 Output file location in Tcl mode

Slavic family +
`-l locale´: -Polish -

`--locale=locale´ +

+ + +Specify the locale name, either a language specification of the form ll +or a combined language and country specification of the form ll_CC. -

Four forms, special case for one and all numbers ending in 02, 03, or 04 +

`-d directory´

-The header entry would look like this: + +Specify the base directory of `.msg´ message catalogs. + + +

+The `-l´ and `-d´ options are mandatory. The `.msg´ file is +written in the specified directory. + +

-Plural-Forms: nplurals=4; \
-    plural=n%100==1 ? 0 : n%100==2 ? 1 : n%100==3 || n%100==4 ? 2 : 3;
-

-Languages with this property include: +

10.1.7 Input file syntax

Slavic family +
`-P´: -Slovenian -

- +

`--properties-input´ +

+ + +Assume the input files are Java ResourceBundles in Java .properties +syntax, not in PO file syntax. +

`--stringtable-input´ +

+ +Assume the input files are NeXTstep/GNUstep localized resource files in +.strings syntax, not in PO file syntax. + -

10.2.6 How to use `gettext` in GUI programs

- - - -

-One place where the gettext functions, if used normally, have big -problems is within programs with graphical user interfaces (GUIs). The -problem is that many of the strings which have to be translated are very -short. They have to appear in pull-down menus which restricts the -length. But strings which are not containing entire sentences or at -least large fragments of a sentence may appear in more than one -situation in the program but might have different translations. This is -especially true for the one-word strings which are frequently used in -GUI programs. -

-As a consequence many people say that the gettext approach is -wrong and instead catgets should be used which indeed does not -have this problem. But there is a very simple and powerful method to -handle these kind of problems with the gettext functions. +

10.1.8 Input file interpretation

-As as example consider the following fictional situation. A GUI program -has a menu bar with the following entries: +

`-c´ +

`--check´ +

+ + +Perform all the checks implied by --check-format, --check-header, +--check-domain. -

-+------------+------------+--------------------------------------+
-| File       | Printer    |                                      |
-+------------+------------+--------------------------------------+
-| Open     | | Select   |
-| New      | | Open     |
-+----------+ | Connect  |
-             +----------+
-

`--check-format´ +

+ + +Check language dependent format strings. + +If the string represents a format string used in a +printf-like function both strings should have the same number of +`%´ format specifiers, with matching types. If the flag +c-format or possible-c-format appears in the special +comment #, for this entry a check is performed. For example, the +check will diagnose using `%.*s´ against `%s´, or `%d´ +against `%s´, or `%d´ against `%x´. It can even handle +positional parameters. + +Normally the xgettext program automatically decides whether a +string is a format string or not. This algorithm is not perfect, +though. It might regard a string as a format string though it is not +used in a printf-like function and so msgfmt might report +errors where there are none. + +To solve this problem the programmer can dictate the decision to the +xgettext program (see section 15.3.1 C Format Strings). The translator should not +consider removing the flag from the #, line. This "fix" would be +reversed again as soon as msgmerge is called the next time. + +

`--check-header´ +

+ +Verify presence and contents of the header entry. See section 6.2 Filling in the Header Entry, +for a description of the various fields in the header entry. -

-To have the strings File, Printer, Open, -New, Select, and Connect translated there has to be -at some point in the code a call to a function of the gettext -family. But in two places the string passed into the function would be -Open. The translations might not be the same and therefore we -are in the dilemma described above. +

`--check-domain´ +

+ +Check for conflicts between domain directives and the --output-file +option -

-One solution to this problem is to artificially enlengthen the strings -to make them unambiguous. But what would the program do if no -translation is available? The enlengthened string is not what should be -printed. So we should use a little bit modified version of the functions. +

`-C´ +

`--check-compatibility´ +

+ + + +Check that GNU msgfmt behaves like X/Open msgfmt. This will give an error +when attempting to use the GNU extensions. -

-To enlengthen the strings a uniform method should be used. E.g., in the -example above the strings could be chosen as +

`--check-accelerators[=char]´ +

+ + + + +Check presence of keyboard accelerators for menu items. This is based on +the convention used in some GUIs that a keyboard accelerator in a menu +item string is designated by an immediately preceding `&´ character. +Sometimes a keyboard accelerator is also called "keyboard mnemonic". +This check verifies that if the untranslated string has exactly one +`&´ character, the translated string has exactly one `&´ as well. +If this option is given with a char argument, this char should +be a non-alphanumeric character and is used as keyboard accelerator mark +instead of `&´. + +

`-f´ +

`--use-fuzzy´ +

+ + + +Use fuzzy entries in output. Note that using this option is usually wrong, +because fuzzy messages are exactly those which have not been validated by +a human translator. -

-Menu|File
-Menu|Printer
-Menu|File|Open
-Menu|File|New
-Menu|Printer|Select
-Menu|Printer|Open
-Menu|Printer|Connect
-

-Now all the strings are different and if now instead of gettext -the following little wrapper function is used, everything works just -fine: -

- +

10.1.9 Output details

-  char *
-  sgettext (const char *msgid)
-  {
-    char *msgval = gettext (msgid);
-    if (msgval == msgid)
-      msgval = strrchr (msgid, '|') + 1;
-    return msgval;
-  }
-

-What this little function does is to recognize the case when no -translation is available. This can be done very efficiently by a -pointer comparison since the return value is the input value. If there -is no translation we know that the input string is in the format we used -for the Menu entries and therefore contains a | character. We -simply search for the last occurrence of this character and return a -pointer to the character following it. That's it! +

`-a number´ +

`--alignment=number´ +

+ + +Align strings to number bytes (default: 1). -

-If one now consistently uses the enlengthened string form and replaces -the gettext calls with calls to sgettext (this is normally -limited to very few places in the GUI implementation) then it is -possible to produce a program which can be internationalized. +

`--no-hash´ +

+ +Don't include a hash table in the binary file. Lookup will be more expensive +at run time (binary search instead of hash table lookup). -

-The other gettext functions (dgettext, dcgettext -and the ngettext equivalents) can and should have corresponding -functions as well which look almost identical, except for the parameters -and the call to the underlying function. +

-Now there is of course the question why such functions do not exist in -the GNU gettext package? There are two parts of the answer to this question. -

+
10.1.10 Informative output
-They are easy to write and therefore can be provided by the project they -are used in. This is not an answer by itself and must be seen together -with the second part which is: +
-
+
`-h´ +
+
`--help´ +
+ + +Display this help and exit. -There is no way the gettext package can contain a version which can work -everywhere. The problem is the selection of the character to separate -the prefix from the actual string in the enlenghtened string. The -examples above used | which is a quite good choice because it -resembles a notation frequently used in this context and it also is a -character not often used in message strings. +
`-V´ +
+
`--version´ +
+ + +Output version information and exit. -But what if the character is used in message strings? Or if the chose -character is not available in the character set on the machine one -compiles (e.g., | is not required to exist for ISO C; this is -why the `iso646.h´ file exists in ISO C programming environments). -

`--statistics´ +

+ +Print statistics about translations. -

-There is only one more comment to be said. The wrapper function above -requires that the translations strings are not enlengthened themselves. -This is only logical. There is no need to disambiguate the strings -(since they are never used as keys for a search) and one also saves -quite some memory and disk space by doing this. +

`-v´ +

`--verbose´ +

+ + +Increase verbosity level. -

+ -

10.2.7 Optimization of the *gettext functions

- -

-At this point of the discussion we should talk about an advantage of the -GNU gettext implementation. Some readers might have pointed out -that an internationalized program might have a poor performance if some -string has to be translated in an inner loop. While this is unavoidable -when the string varies from one run of the loop to the other it is -simply a waste of time when the string is always the same. Take the -following example: +

10.2 Invoking the `msgunfmt` Program

+ +

-{
-  while (...)
-    {
-      puts (gettext ("Hello world"));
-    }
-}
+msgunfmt [option] [file]...

-When the locale selection does not change between two runs the resulting -string is always the same. One way to use this is: + +The msgunfmt program converts a binary message catalog to a +Uniforum style .po file.

-{
-  str = gettext ("Hello world");
-  while (...)
-    {
-      puts (str);
-    }
-}
-

- -

-But this solution is not usable in all situation (e.g. when the locale -selection changes) nor does it lead to legible code. -

-For this reason, GNU gettext caches previous translation results. -When the same translation is requested twice, with no new message -catalogs being loaded in between, gettext will, the second time, -find the result through a single cache lookup. +

10.2.1 Operation mode

`-j´ +

`--java´ +

+ + + +Java mode: input is a Java ResourceBundle class. -

10.3 Comparing the Two Interfaces

- - +

`--csharp´ +

+ + +C# mode: input is a .NET .dll file containing a subclass of +GettextResourceSet. -

`--csharp-resources´ +

+ + +C# resources mode: input is a .NET `.resources´ file. -

-The following discussion is perhaps a little bit colored. As said -above we implemented GNU gettext following the Uniforum -proposal and this surely has its reasons. But it should show how we -came to this decision. +

`--tcl´ +

+ + +Tcl mode: input is a tcl/msgcat `.msg´ file. -

-First we take a look at the developing process. When we write an -application using NLS provided by gettext we proceed as always. -Only when we come to a string which might be seen by the users and thus -has to be translated we use gettext("...") instead of -"...". At the beginning of each source file (or in a central -header file) we define +

-#define gettext(String) (String)
-

-Even this definition can be avoided when the system supports the -gettext function in its C library. When we compile this code the -result is the same as if no NLS code is used. When you take a look at -the GNU gettext code you will see that we use _("...") -instead of gettext("..."). This reduces the number of -additional characters per translatable string to 3 (in words: -three). +

10.2.2 Input file location

-When now a production version of the program is needed we simply replace -the definition +

`file ...´ +

+Input .mo files. -

-#define _(String) (String)
-

-by +If no input file is given or if it is `-´, standard input is read.

- - -

-#include <libintl.h>
-#define _(String) gettext (String)
-

-Additionally we run the program `xgettext´ on all source code file -which contain translatable strings and that's it: we have a running -program which does not depend on translations to be available, but which -can use any that becomes available. -

- -The same procedure can be done for the gettext_noop invocations -(see section 3.6 Special Cases of Translatable Strings). One usually defines gettext_noop as a -no-op macro. So you should consider the following code for your project: +

10.2.3 Input file location in Java mode

-#define gettext_noop(String) String
-#define N_(String) gettext_noop (String)
-

`-r resource´ +

`--resource=resource´ +

+ + +Specify the resource name. -

-N_ is a short form similar to _. The `Makefile´ in -the `po/´ directory of GNU gettext knows by default both of the -mentioned short forms so you are invited to follow this proposal for -your own ease. +

`-l locale´ +

`--locale=locale´ +

+ + +Specify the locale name, either a language specification of the form ll +or a combined language and country specification of the form ll_CC. -

-Now to catgets. The main problem is the work for the -programmer. Every time he comes to a translatable string he has to -define a number (or a symbolic constant) which has also be defined in -the message catalog file. He also has to take care for duplicate -entries, duplicate message IDs etc. If he wants to have the same -quality in the message catalog as the GNU gettext program -provides he also has to put the descriptive comments for the strings and -the location in all source code files in the message catalog. This is -nearly a Mission: Impossible. +

-But there are also some points people might call advantages speaking for -catgets. If you have a single word in a string and this string -is used in different contexts it is likely that in one or the other -language the word has different translations. Example: +The class name is determined by appending the locale name to the resource name, +separated with an underscore. The class is located using the CLASSPATH.

-printf ("%s: %d", gettext ("number"), number_of_errors)
-
-printf ("you should see %d %s", number_count,
-        number_count == 1 ? gettext ("number") : gettext ("numbers"))
-

-Here we have to translate two times the string "number". Even -if you do not speak a language beside English it might be possible to -recognize that the two words have a different meaning. In German the -first appearance has to be translated to "Anzahl" and the second -to "Zahl". +

10.2.4 Input file location in C# mode

-Now you can say that this example is really esoteric. And you are -right! This is exactly how we felt about this problem and decide that -it does not weight that much. The solution for the above problem could -be very easy: +

`-r resource´ +

`--resource=resource´ +

+ + +Specify the resource name. -

-printf ("%s %d", gettext ("number:"), number_of_errors)
+`-l locale´
+

+
`--locale=locale´
+

+
+
+Specify the locale name, either a language specification of the form ll
+or a combined language and country specification of the form ll_CC.
 
-printf (number_count == 1 ? gettext ("you should see %d number")
-                          : gettext ("you should see %d numbers"),
-        number_count)
-

`-d directory´ +

+ +Specify the base directory for locale dependent `.dll´ files. -

-We believe that we can solve all conflicts with this method. If it is -difficult one can also consider changing one of the conflicting string a -little bit. But it is not impossible to overcome. +

-catgets allows same original entry to have different translations, -but gettext has another, scalable approach for solving ambiguities -of this kind: See section 10.2.2 Solving Ambiguities. +The `-l´ and `-d´ options are mandatory. The `.msg´ file is +located in a subdirectory of the specified directory whose name depends on the +locale.

10.4 Using libintl.a in own programs

10.2.5 Input file location in Tcl mode

-Starting with version 0.9.4 the library libintl.h should be -self-contained. I.e., you can use it in your own programs without -providing additional functions. The `Makefile´ will put the header -and the library in directories selected using the $(prefix). +

`-l locale´ +: +
`--locale=locale´ +: + + +Specify the locale name, either a language specification of the form ll +or a combined language and country specification of the form ll_CC. +
`-d directory´ +: + +Specify the base directory of `.msg´ message catalogs. -
10.5 Being a gettext grok
+

-To fully exploit the functionality of the GNU gettext library it -is surely helpful to read the source code. But for those who don't want -to spend that much time in reading the (sometimes complicated) code here -is a list comments: +The `-l´ and `-d´ options are mandatory. The `.msg´ file is +located in the specified directory.

Changing the language at runtime - - -For interactive programs it might be useful to offer a selection of the -used language at runtime. To understand how to do this one need to know -how the used language is determined while executing the gettext -function. The method which is presented here only works correctly -with the GNU implementation of the gettext functions. - -In the function dcgettext at every call the current setting of -the highest priority environment variable is determined and used. -Highest priority means here the following list with decreasing -priority: +
10.2.6 Output file location
+
-
1. LANGUAGE +
  `-o file´ +
  +
  `--output-file=file´ +
  + + +Write output to specified file. - - - -
  LC_ALL +
- - - - - - -
LC_xxx, according to selected locale +
+The results are written to standard output if no output file is specified +or if it is `-´. - -
LANG +
- -Afterwards the path is constructed using the found value and the -translation file is loaded if available. +
10.2.7 Output details
-What happens now when the value for, say, LANGUAGE changes? According -to the process explained above the new value of this variable is found -as soon as the dcgettext function is called. But this also means -the (perhaps) different message catalog file is loaded. In other -words: the used language is changed. +
-But there is one little hook. The code for gcc-2.7.0 and up provides -some optimization. This optimization normally prevents the calling of -the dcgettext function as long as no new catalog is loaded. But -if dcgettext is not called the program also cannot find the -LANGUAGE variable be changed (see section 10.2.7 Optimization of the *gettext functions). A -solution for this is very easy. Include the following code in the -language switching function. +
`--force-po´ +
+ +Always write an output file even if it contains no message. +
`-i´ +
+
`--indent´ +
+ + +Write the .po file using indented style. -
```
-  /* Change language.  */
-  setenv ("LANGUAGE", "fr", 1);
-
-  /* Make change known.  */
-  {
-    extern int  _nl_msg_cat_cntr;
-    ++_nl_msg_cat_cntr;
-  }
-
```
+
`--strict´ +
+ +Write out a strict Uniforum conforming PO file. Note that this +Uniforum format should be avoided because it doesn't support the +GNU extensions. - -The variable _nl_msg_cat_cntr is defined in `loadmsgcat.c´. -You don't need to know what this is for. But it can be used to detect -whether a gettext implementation is GNU gettext and not non-GNU -system's native gettext implementation. +
`-p´ +
+
`--properties-output´ +
+ + +Write out a Java ResourceBundle in Java .properties syntax. Note +that this file format doesn't support plural forms and silently drops +obsolete messages. -

`--stringtable-output´ +

+ +Write out a NeXTstep/GNUstep localized resource file in .strings syntax. +Note that this file format doesn't support plural forms. +

`-w number´ +

`--width=number´ +

+ + +Set the output page width. Long strings in the output files will be +split across multiple lines in order to ensure that each line's width +(= number of screen columns) is less or equal to the given number. +

`--no-wrap´ +

+ +Do not break long message lines. Message lines whose width exceeds the +output page width will not be split into several lines. Only file reference +lines which are wider than the output page width will be split. -

10.6 Temporary Notes for the Programmers Chapter

`-s´ +

`--sort-output´ +

+ + + +Generate sorted output. Note that using this option makes it much harder +for the translator to understand each message's context. + -

10.6.1 Temporary - Two Possible Implementations

-There are two competing methods for language independent messages: -the X/Open catgets method, and the Uniforum gettext -method. The catgets method indexes messages by integers; the -gettext method indexes them by their English translations. -The catgets method has been around longer and is supported -by more vendors. The gettext method is supported by Sun, -and it has been heard that the COSE multi-vendor initiative is -supporting it. Neither method is a POSIX standard; the POSIX.1 -committee had a lot of disagreement in this area. +

10.2.8 Informative output

-Neither one is in the POSIX standard. There was much disagreement -in the POSIX.1 committee about using the gettext routines -vs. catgets (XPG). In the end the committee couldn't -agree on anything, so no messaging system was included as part -of the standard. I believe the informative annex of the standard -includes the XPG3 messaging interfaces, "...as an example of -a messaging system that has been implemented..." +

`-h´ +: +
`--help´ +: + + +Display this help and exit. -
+
`-V´ +: +
`--version´ +: + + +Output version information and exit. +
`-v´ +: +
`--verbose´ +: + + +Increase verbosity level. -
10.6.2 Temporary - About catgets
+

-There have been a few discussions of late on the use of -catgets as a base. I think it important to present both -sides of the argument and hence am opting to play devil's advocate -for a little bit. -

-I'll not deny the fact that catgets could have been designed -a lot better. It currently has quite a number of limitations and -these have already been pointed out. -

10.3 The Format of GNU MO Files

-However there is a great deal to be said for consistency and -standardization. A common recurring problem when writing Unix -software is the myriad portability problems across Unix platforms. -It seems as if every Unix vendor had a look at the operating system -and found parts they could improve upon. Undoubtedly, these -modifications are probably innovative and solve real problems. -However, software developers have a hard time keeping up with all -these changes across so many platforms. + +

-And this has prompted the Unix vendors to begin to standardize their -systems. Hence the impetus for Spec1170. Every major Unix vendor -has committed to supporting this standard and every Unix software -developer waits with glee the day they can write software to this -standard and simply recompile (without having to use autoconf) -across different platforms. +The format of the generated MO files is best described by a picture, +which appears below.

-As I understand it, Spec1170 is roughly based upon version 4 of the -X/Open Portability Guidelines (XPG4). Because catgets and -friends are defined in XPG4, I'm led to believe that catgets -is a part of Spec1170 and hence will become a standardized component -of all Unix systems. + +The first two words serve the identification of the file. The magic +number will always signal GNU MO files. The number is stored in the +byte order of the generating machine, so the magic number really is +two numbers: 0x950412de and 0xde120495. The second +word describes the current revision of the file format. For now the +revision is 0. This might change in future versions, and ensures +that the readers of MO files can distinguish new formats from old +ones, so that both can be handled correctly. The version is kept +separate from the magic number, instead of using different magic +numbers for different formats, mainly because `/etc/magic´ is +not updated often. It might be better to have magic separated from +internal format version identification.

- - -

10.6.3 Temporary - Why a single implementation

-Now it seems kind of wasteful to me to have two different systems -installed for accessing message catalogs. If we do want to remedy -catgets deficiencies why don't we try to expand catgets -(in a compatible manner) rather than implement an entirely new system. -Otherwise, we'll end up with two message catalog access systems installed -with an operating system - one set of routines for packages using GNU -gettext for their internationalization, and another set of routines -(catgets) for all other software. Bloated? +Follow a number of pointers to later tables in the file, allowing +for the extension of the prefix part of MO files without having to +recompile programs reading them. This might become useful for later +inserting a few flag bits, indication about the charset used, new +tables, or other things.

-Supposing another catalog access system is implemented. Which do -we recommend? At least for Linux, we need to attract as many -software developers as possible. Hence we need to make it as easy -for them to port their software as possible. Which means supporting -catgets. We will be implementing the libintl code -within our libc, but does this mean we also have to incorporate -another message catalog access scheme within our libc as well? -And what about people who are going to be using the libintl -+ non-catgets routines. When they port their software to -other platforms, they're now going to have to include the front-end -(libintl) code plus the back-end code (the non-catgets -access routines) with their software instead of just including the -libintl code with their software. +Then, at offset O and offset T in the picture, two tables +of string descriptors can be found. In both tables, each string +descriptor uses two 32 bits integers, one for the string length, +another for the offset of the string in the MO file, counting in bytes +from the start of the file. The first table contains descriptors +for the original strings, and is sorted so the original strings +are in increasing lexicographical order. The second table contains +descriptors for the translated strings, and is parallel to the first +table: to find the corresponding translation one has to access the +array slot in the second array with the same index.

-Message catalog support is however only the tip of the iceberg. -What about the data for the other locale categories. They also have -a number of deficiencies. Are we going to abandon them as well and -develop another duplicate set of routines (should libintl -expand beyond message catalog support)? +Having the original strings sorted enables the use of simple binary +search, for when the MO file does not contain an hashing table, or +for when it is not practical to use the hashing table provided in +the MO file. This also has another advantage, as the empty string +in a PO file GNU gettext is usually translated into +some system information attached to that particular MO file, and the +empty string necessarily becomes the first in both the original and +translated tables, making the system information very easy to find.

-Like many parts of Unix that can be improved upon, we're stuck with balancing -compatibility with the past with useful improvements and innovations for -the future. + +The size S of the hash table can be zero. In this case, the +hash table itself is not contained in the MO file. Some people might +prefer this because a precomputed hashing table takes disk space, and +does not win that much speed. The hash table contains indices +to the sorted array of strings in the MO file. Conflict resolution is +done by double hashing. The precise hashing algorithm used is fairly +dependent on GNU gettext code, and is not documented here.

- - -

10.6.4 Temporary - Notes

-X/Open agreed very late on the standard form so that many -implementations differ from the final form. Both of my system (old -Linux catgets and Ultrix-4) have a strange variation. +As for the strings themselves, they follow the hash file, and each +is terminated with a NUL, and this NUL is not counted in +the length which appears in the string descriptor. The msgfmt +program has an option selecting the alignment for MO file strings. +With this option, each string is separately aligned so it starts at +an offset which is a multiple of the alignment value. On some RISC +machines, a correct alignment will speed things up.

-OK. After incorporating the last changes I have to spend some time on -making the GNU/Linux libc gettext functions. So in future -Solaris is not the only system having gettext. + +Plural forms are stored by letting the plural of the original string +follow the singular of the original string, separated through a +NUL byte. The length which appears in the string descriptor +includes both. However, only the singular of the original string +takes part in the hash table lookup. The plural variants of the +translation are all stored consecutively, separated through a +NUL byte. Here also, the length in the string descriptor +includes all of them. + +

+Nothing prevents a MO file from having embedded NULs in strings. +However, the program interface currently used already presumes +that strings are NUL terminated, so embedded NULs are +somewhat useless. But the MO file format is general enough so other +interfaces would be later possible, if for example, we ever want to +implement wide characters right in MO files, where NUL bytes may +accidently appear. (No, we don't want to have wide characters in MO +files. They would make the file unnecessarily large, and the +`wchar_t´ type being platform dependent, MO files would be +platform dependent as well.) + +

+This particular issue has been strongly debated in the GNU +gettext development forum, and it is expectable that MO file +format will evolve or change over time. It is even possible that many +formats may later be supported concurrently. But surely, we have to +start somewhere, and the MO file format described here is a good start. +Nothing is cast in concrete, and the format may later evolve fairly +easily, so we should feel comfortable with the current approach. + +

+ +

+        byte
+             +------------------------------------------+
+          0  | magic number = 0x950412de                |
+             |                                          |
+          4  | file format revision = 0                 |
+             |                                          |
+          8  | number of strings                        |  == N
+             |                                          |
+         12  | offset of table with original strings    |  == O
+             |                                          |
+         16  | offset of table with translation strings |  == T
+             |                                          |
+         20  | size of hashing table                    |  == S
+             |                                          |
+         24  | offset of hashing table                  |  == H
+             |                                          |
+             .                                          .
+             .    (possibly more entries later)         .
+             .                                          .
+             |                                          |
+          O  | length & offset 0th string  ----------------.
+      O + 8  | length & offset 1st string  ------------------.
+              ...                                    ...   | |
+O + ((N-1)*8)| length & offset (N-1)th string           |  | |
+             |                                          |  | |
+          T  | length & offset 0th translation  ---------------.
+      T + 8  | length & offset 1st translation  -----------------.
+              ...                                    ...   | | | |
+T + ((N-1)*8)| length & offset (N-1)th translation      |  | | | |
+             |                                          |  | | | |
+          H  | start hash table                         |  | | | |
+              ...                                    ...   | | | |
+  H + S * 4  | end hash table                           |  | | | |
+             |                                          |  | | | |
+             | NUL terminated 0th string  <----------------' | | |
+             |                                          |    | | |
+             | NUL terminated 1st string  <------------------' | |
+             |                                          |      | |
+              ...                                    ...       | |
+             |                                          |      | |
+             | NUL terminated 0th translation  <---------------' |
+             |                                          |        |
+             | NUL terminated 1st translation  <-----------------'
+             |                                          |
+              ...                                    ...
+             |                                          |
+             +------------------------------------------+
+

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_11.html b/gettext-tools/doc/gettext_11.html index d6f65b150..01c4665ff 100644 --- a/gettext-tools/doc/gettext_11.html +++ b/gettext-tools/doc/gettext_11.html @@ -1,662 +1,1502 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - 11 The Translator's View +GNU gettext utilities - 11 The Programmer's View -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

11 The Translator's View

11 The Programmer's View

+One aim of the current message catalog implementation provided by +GNU gettext was to use the system's message catalog handling, if the +installer wishes to do so. So we perhaps should first take a look at +the solutions we know about. The people in the POSIX committee did not +manage to agree on one of the semi-official standards which we'll +describe below. In fact they couldn't agree on anything, so they decided +only to include an example of an interface. The major Unix vendors +are split in the usage of the two most important specifications: X/Open's +catgets vs. Uniforum's gettext interface. We'll describe them both and +later explain our solution of this dilemma. + +

11.1 Introduction 0

11.1 About `catgets`

-Free software is going international! The Translation Project is a way -to get maintainers, translators and users all together, so free software -will gradually become able to speak many native languages. +

-The GNU gettext tool set contains everything maintainers -need for internationalizing their packages for messages. It also -contains quite useful tools for helping translators at localizing -messages to their native language, once a package has already been -internationalized. +The catgets implementation is defined in the X/Open Portability +Guide, Volume 3, XSI Supplementary Definitions, Chapter 5. But the +process of creating this standard seemed to be too slow for some of +the Unix vendors so they created their implementations on preliminary +versions of the standard. Of course this leads again to problems while +writing platform independent programs: even the usage of catgets +does not guarantee a unique interface.

-To achieve the Translation Project, we need many interested -people who like their own language and write it well, and who are also -able to synergize with other translators speaking the same language. -If you'd like to volunteer to work at translating messages, -please send mail to your translating team. +Another, personal comment on this that only a bunch of committee members +could have made this interface. They never really tried to program +using this interface. It is a fast, memory-saving implementation, an +user can happily live with it. But programmers hate it (at least I and +some others do...)

-Each team has its own mailing list, courtesy of Linux -International. You may reach your translating team at the address -`ll@li.org´, replacing ll by the two-letter ISO 639 -code for your language. Language codes are not the same as -country codes given in ISO 3166. The following translating teams -exist: +But we must not forget one point: after all the trouble with transfering +the rights on Unix(tm) they at last came to X/Open, the very same who +published this specification. This leads me to making the prediction +that this interface will be in future Unix standards (e.g. Spec1170) and +therefore part of all Unix implementation (implementations, which are +allowed to wear this name).

+ + +
11.1.1 The Interface

-Chinese zh, Czech cs, Danish da, Dutch nl, -Esperanto eo, Finnish fi, French fr, Irish -ga, German de, Greek el, Italian it, -Japanese ja, Indonesian in, Norwegian no, Polish -pl, Portuguese pt, Russian ru, Spanish es, -Swedish sv and Turkish tr. -

+ + +

+The interface to the catgets implementation consists of three +functions which correspond to those used in file access: catopen +to open the catalog for using, catgets for accessing the message +tables, and catclose for closing after work is done. Prototypes +for the functions and the needed definitions are in the +<nl_types.h> header file. +

-For example, you may reach the Chinese translating team by writing to -`zh@li.org´. When you become a member of the translating team -for your own language, you may subscribe to its list. For example, -Swedish people can send a message to `sv-request@li.org´, -having this message body: + +catopen is used like in this:

-subscribe
+nl_catd catd = catopen ("catalog_name", 0);

-Keep in mind that team members should be interested in working -at translations, or at solving translational difficulties, rather than -merely lurking around. If your team does not exist yet and you want to -start one, please write to `translation@iro.umontreal.ca´; -you will then reach the coordinator for all translator teams. +The function takes as the argument the name of the catalog. This usual +refers to the name of the program or the package. The second parameter +is not further specified in the standard. I don't even know whether it +is implemented consistently among various systems. So the common advice +is to use 0 as the value. The return value is a handle to the +message catalog, equivalent to handles to file returned by open. + +

+ +This handle is of course used in the catgets function which can +be used like this:

+ +

+char *translation = catgets (catd, set_no, msg_id, "original string");
+

-A handful of GNU packages have already been adapted and provided -with message translations for several languages. Translation -teams have begun to organize, using these packages as a starting -point. But there are many more packages and many languages for -which we have no volunteer translators. If you would like to -volunteer to work at translating messages, please send mail to -`translation@iro.umontreal.ca´ indicating what language(s) -you can work on. +The first parameter is this catalog descriptor. The second parameter +specifies the set of messages in this catalog, in which the message +described by msg_id is obtained. catgets therefore uses a +three-stage addressing:

+catalog name => set number => message ID => translation
+

11.2 Introduction 1

+The fourth argument is not used to address the translation. It is given +as a default value in case when one of the addressing stages fail. One +important thing to remember is that although the return type of catgets +is char * the resulting string must not be changed. It +should better be const char *, but the standard is published in +1988, one year before ANSI C. +

-This is now official, GNU is going international! Here is the -announcement submitted for the January 1995 GNU Bulletin: + +The last of these functions is used and behaves as expected:

+
+catclose (catd);
+
+
-A handful of GNU packages have already been adapted and provided -with message translations for several languages. Translation -teams have begun to organize, using these packages as a starting -point. But there are many more packages and many languages -for which we have no volunteer translators. If you'd like to -volunteer to work at translating messages, please send mail to -`translation@iro.umontreal.ca´ indicating what language(s) -you can work on. -

+After this no catgets call using the descriptor is legal anymore. + +

+ + +

11.1.2 Problems with the `catgets` Interface?!

+ + +

+Now that this description seemed to be really easy -- where are the +problems we speak of? In fact the interface could be used in a +reasonable way, but constructing the message catalogs is a pain. The +reason for this lies in the third argument of catgets: the unique +message ID. This has to be a numeric value for all messages in a single +set. Perhaps you could imagine the problems keeping such a list while +changing the source code. Add a new message here, remove one there. Of +course there have been developed a lot of tools helping to organize this +chaos but one as the other fails in one aspect or the other. We don't +want to say that the other approach has no problems but they are far +more easy to manage. + +

+ +

11.2 About `gettext`

-This document should answer many questions for those who are curious about -the process or would like to contribute. Please at least skim over it, -hoping to cut down a little of the high volume of e-mail generated by this -collective effort towards internationalization of free software. +

-Most free programming which is widely shared is done in English, and -currently, English is used as the main communicating language between -national communities collaborating to free software. This very document -is written in English. This will not change in the foreseeable future. +The definition of the gettext interface comes from a Uniforum +proposal. It was submitted there by Sun, who had implemented the +gettext function in SunOS 4, around 1990. Nowadays, the +gettext interface is specified by the OpenI18N standard.

-However, there is a strong appetite from national communities for -having more software able to write using national language and habits, -and there is an on-going effort to modify free software in such a way -that it becomes able to do so. The experiments driven so far raised -an enthusiastic response from pretesters, so we believe that -internationalization of free software is dedicated to succeed. +The main point about this solution is that it does not follow the +method of normal file handling (open-use-close) and that it does not +burden the programmer with so many tasks, especially the unique key handling. +Of course here also a unique key is needed, but this key is the message +itself (how long or short it is). See section 11.3 Comparing the Two Interfaces for a more +detailed comparison of the two methods.

-For suggestion clarifications, additions or corrections to this -document, please e-mail to `translation@iro.umontreal.ca´. +The following section contains a rather detailed description of the +interface. We make it that detailed because this is the interface +we chose for the GNU gettext Library. Programmers interested +in using this library will be interested in this description.

11.3 Discussions

11.2.1 The Interface

-Facing this internationalization effort, a few users expressed their -concerns. Some of these doubts are presented and discussed, here. +

+The minimal functionality an interface must have is a) to select a +domain the strings are coming from (a single domain for all programs is +not reasonable because its construction and maintenance is difficult, +perhaps impossible) and b) to access a string in a selected domain. -

Smaller groups - -Some languages are not spoken by a very large number of people, so people -speaking them sometimes consider that there may not be all that much -demand such versions of free software packages. Moreover, many people -being into computers, in some countries, generally seem to prefer -English versions of their software. - -On the other end, people might enjoy their own language a lot, and be -very motivated at providing to themselves the pleasure of having their -beloved free software speaking their mother tongue. They do themselves -a personal favor, and do not pay that much attention to the number of -people benefiting of their work. - -
Misinterpretation - -Other users are shy to push forward their own language, seeing in this -some kind of misplaced propaganda. Someone thought there must be some -users of the language over the networks pestering other people with it. - -But any spoken language is worth localization, because there are -people behind the language for whom the language is important and -dear to their hearts. - -
Odd translations - -The biggest problem is to find the right translations so that -everybody can understand the messages. Translations are usually a -little odd. Some people get used to English, to the extent they may -find translations into their own language "rather pushy, obnoxious -and sometimes even hilarious." As a French speaking man, I have -the experience of those instruction manuals for goods, so poorly -translated in French in Korea or Taiwan... - -The fact is that we sometimes have to create a kind of national -computer culture, and this is not easy without the collaboration of -many people liking their mother tongue. This is why translations are -better achieved by people knowing and loving their own language, and -ready to work together at improving the results they obtain. - -
Dependencies over the GPL or LGPL - -Some people wonder if using GNU gettext necessarily brings their -package under the protective wing of the GNU General Public License or -the GNU Library General Public License, when they do not want to make -their program free, or want other kinds of freedom. The simplest -answer is "normally not". - -The gettext-runtime part of GNU gettext, i.e. the -contents of libintl, is covered by the GNU Library General Public -License. The gettext-tools part of GNU gettext, i.e. the -rest of the GNU gettext package, is covered by the GNU General -Public License. - -The mere marking of localizable strings in a package, or conditional -inclusion of a few lines for initialization, is not really including -GPL'ed or LGPL'ed code. However, since the localization routines in -libintl are under the LGPL, the LGPL needs to be considered. -It gives the right to distribute the complete unmodified source of -libintl even with non-free programs. It also gives the right -to use libintl as a shared library, even for non-free programs. -But it gives the right to use libintl as a static library or -to incorporate libintl into another library only to free -software. +
+
+This is principally the description of the gettext interface. It +has a global domain which unqualified usages reference. Of course this +domain is selectable by the user. -

+char *textdomain (const char *domain_name);
+

+This provides the possibility to change or query the current status of +the current global domain of the LC_MESSAGE category. The +argument is a null-terminated string, whose characters must be legal in +the use in filenames. If the domain_name argument is NULL, +the function returns the current value. If no value has been set +before, the name of the default domain is returned: messages. +Please note that although the return value of textdomain is of +type char * no changing is allowed. It is also important to know +that no checks of the availability are made. If the name is not +available you will see this by the fact that no translations are provided. -

11.4 Organization

+To use a domain set by textdomain the function + +

+ +

+char *gettext (const char *msgid);
+

-On a larger scale, the true solution would be to organize some kind of -fairly precise set up in which volunteers could participate. I gave -some thought to this idea lately, and realize there will be some -touchy points. I thought of writing to Richard Stallman to launch -such a project, but feel it might be good to shake out the ideas -between ourselves first. Most probably that Linux International has -some experience in the field already, or would like to orchestrate -the volunteer work, maybe. Food for thought, in any case! +is to be used. This is the simplest reasonable form one can imagine. +The translation of the string msgid is returned if it is available +in the current domain. If it is not available, the argument itself is +returned. If the argument is NULL the result is undefined.

-I guess we have to setup something early, somehow, that will help -many possible contributors of the same language to interlock and avoid -work duplication, and further be put in contact for solving together -problems particular to their tongue (in most languages, there are many -difficulties peculiar to translating technical English). My Swedish -contributor acknowledged these difficulties, and I'm well aware of -them for French. +One thing which should come into mind is that no explicit dependency to +the used domain is given. The current value of the domain for the +LC_MESSAGES locale is used. If this changes between two +executions of the same gettext call in the program, both calls +reference a different message catalog.

-This is surely not a technical issue, but we should manage so the -effort of locale contributors be maximally useful, despite the national -team layer interface between contributors and maintainers. +For the easiest case, which is normally used in internationalized +packages, once at the beginning of execution a call to textdomain +is issued, setting the domain to a unique name, normally the package +name. In the following code all strings which have to be translated are +filtered through the gettext function. That's all, the package speaks +your language.

+ + +

11.2.2 Solving Ambiguities

-The Translation Project needs some setup for coordinating language -coordinators. Localizing evolving programs will surely -become a permanent and continuous activity in the free software community, -once well started. -The setup should be minimally completed and tested before GNU -gettext becomes an official reality. The e-mail address -`translation@iro.umontreal.ca´ has been setup for receiving -offers from volunteers and general e-mail on these topics. This address -reaches the Translation Project coordinator. + + +

+While this single name domain works well for most applications there +might be the need to get translations from more than one domain. Of +course one could switch between different domains with calls to +textdomain, but this is really not convenient nor is it fast. A +possible situation could be one case subject to discussion during this +writing: all +error messages of functions in the set of common used functions should +go into a separate domain error. By this mean we would only need +to translate them once. +Another case are messages from a library, as these have to be +independent of the current domain set by the application. +

+For this reasons there are two more functions to retrieve strings: +

11.4.1 Central Coordination

+char *dgettext (const char *domain_name, const char *msgid);
+char *dcgettext (const char *domain_name, const char *msgid,
+                 int category);
+

-I also think GNU will need sooner than it thinks, that someone setup -a way to organize and coordinate these groups. Some kind of group -of groups. My opinion is that it would be good that GNU delegates -this task to a small group of collaborating volunteers, shortly. -Perhaps in `gnu.announce´ a list of this national committee's -can be published. +Both take an additional argument at the first place, which corresponds +to the argument of textdomain. The third argument of +dcgettext allows to use another locale but LC_MESSAGES. +But I really don't know where this can be useful. If the +domain_name is NULL or category has an value beside +the known ones, the result is undefined. It should also be noted that +this function is not part of the second known implementation of this +function family, the one found in Solaris.

-My role as coordinator would simply be to refer to Ulrich any German -speaking volunteer interested to localization of free software packages, and -maybe helping national groups to initially organize, while maintaining -national registries for until national groups are ready to take over. -In fact, the coordinator should ease volunteers to get in contact with -one another for creating national teams, which should then select -one coordinator per language, or country (regionalized language). -If well done, the coordination should be useful without being an -overwhelming task, the time to put delegations in place. +A second ambiguity can arise by the fact, that perhaps more than one +domain has the same name. This can be solved by specifying where the +needed message catalog files can be found.

+char *bindtextdomain (const char *domain_name,
+                      const char *dir_name);
+

11.4.2 National Teams

+Calling this function binds the given domain to a file in the specified +directory (how this file is determined follows below). Especially a +file in the systems default place is not favored against the specified +file anymore (as it would be by solely using textdomain). A +NULL pointer for the dir_name parameter returns the binding +associated with domain_name. If domain_name itself is +NULL nothing happens and a NULL pointer is returned. Here +again as for all the other functions is true that none of the return +value must be changed! +

-I suggest we look for volunteer coordinators/editors for individual -languages. These people will scan contributions of translation files -for various programs, for their own languages, and will ensure high -and uniform standards of diction. +It is important to remember that relative path names for the +dir_name parameter can be trouble. Since the path is always +computed relative to the current directory different results will be +achieved when the program executes a chdir command. Relative +paths should always be avoided to avoid dependencies and +unreliabilities.

+ + +

11.2.3 Locating Message Catalog Files

-From my current experience with other people in these days, those who -provide localizations are very enthusiastic about the process, and are -more interested in the localization process than in the program they -localize, and want to do many programs, not just one. This seems -to confirm that having a coordinator/editor for each language is a -good idea. +

-We need to choose someone who is good at writing clear and concise -prose in the language in question. That is hard--we can't check -it ourselves. So we need to ask a few people to judge each others' -writing and select the one who is best. +Because many different languages for many different packages have to be +stored we need some way to add these information to file message catalog +files. The way usually used in Unix environments is have this encoding +in the file name. This is also done here. The directory name given in +bindtextdomains second argument (or the default directory), +followed by the value and name of the locale and the domain name are +concatenated:

+ +

+dir_name/locale/LC_category/domain_name.mo
+

-I announce my prerelease to a few dozen people, and you would not -believe all the discussions it generated already. I shudder to think -what will happen when this will be launched, for true, officially, -world wide. Who am I to arbitrate between two Czekolsovak users -contradicting each other, for example? +The default value for dir_name is system specific. For the GNU +library, and for packages adhering to its conventions, it's: + +

+/usr/local/share/locale
+

+ +

+locale is the value of the locale whose name is this +LC_category. For gettext and dgettext this +LC_category is always LC_MESSAGES.(3) +The value of the locale is determined through +setlocale (LC_category, NULL). +(4) +dcgettext specifies the locale category by the third argument.

+ + +

11.2.4 How to specify the output character set `gettext` uses

-I assume that your German is not much better than my French so that -I would not be able to judge about these formulations. What I would -suggest is that for each language there is a group for people who -maintain the PO files and judge about changes. I suspect there will -be cultural differences between how such groups of people will behave. -Some will have relaxed ways, reach consensus easily, and have anyone -of the group relate to the maintainers, while others will fight to -death, organize heavy administrations up to national standards, and -use strict channels. + +

-The German team is putting out a good example. Right now, they are -maybe half a dozen people revising translations of each other and -discussing the linguistic issues. I do not even have all the names. -Ulrich Drepper is taking care of coordinating the German team. -He subscribed to all my pretest lists, so I do not even have to warn -him specifically of incoming releases. +gettext not only looks up a translation in a message catalog. It +also converts the translation on the fly to the desired output character +set. This is useful if the user is working in a different character set +than the translator who created the message catalog, because it avoids +distributing variants of message catalogs which differ only in the +character set.

-I'm sure, that is a good idea to get teams for each language working -on translations. That will make the translations better and more -consistent. +The output character set is, by default, the value of nl_langinfo +(CODESET), which depends on the LC_CTYPE part of the current +locale. But programs which store strings in a locale independent way +(e.g. UTF-8) can request that gettext and related functions +return the translations in that encoding, by use of the +bind_textdomain_codeset function.

+Note that the msgid argument to gettext is not subject to +character set conversion. Also, when gettext does not find a +translation for msgid, it returns msgid unchanged -- +independently of the current output character set. It is therefore +recommended that all msgids be US-ASCII strings. +

Function: char * bind_textdomain_codeset (const char *domainname, const char *codeset) +

+The bind_textdomain_codeset function can be used to specify the +output character set for message catalogs for domain domainname. +The codeset argument must be a valid codeset name which can be used +for the iconv_open function, or a null pointer. +

+If the codeset parameter is the null pointer, +bind_textdomain_codeset returns the currently selected codeset +for the domain with the name domainname. It returns NULL if +no codeset has yet been selected. -

11.4.2.1 Sub-Cultures

+The bind_textdomain_codeset function can be used several times. +If used multiple times with the same domainname argument, the +later call overrides the settings made by the earlier one. + +

+The bind_textdomain_codeset function returns a pointer to a +string containing the name of the selected codeset. The string is +allocated internally in the function and must not be changed by the +user. If the system went out of core during the execution of +bind_textdomain_codeset, the return value is NULL and the +global variable errno is set accordingly. +

+ + +

11.2.5 Additional functions for plural forms

+ + +

-Taking French for example, there are a few sub-cultures around computers -which developed diverging vocabularies. Picking volunteers here and -there without addressing this problem in an organized way, soon in the -project, might produce a distasteful mix of internationalized programs, -and possibly trigger endless quarrels among those who really care. +The functions of the gettext family described so far (and all the +catgets functions as well) have one problem in the real world +which have been neglected completely in all existing approaches. What +is meant here is the handling of plural forms.

-Keeping some kind of unity in the way French localization of -internationalized programs is achieved is a difficult (and delicate) job. -Knowing the latin character of French people (:-), if we take this -the wrong way, we could end up nowhere, or spoil a lot of energies. -Maybe we should begin to address this problem seriously before -GNU gettext become officially published. And I suspect that this -means soon! +Looking through Unix source code before the time anybody thought about +internationalization (and, sadly, even afterwards) one can often find +code similar to the following:

+   printf ("%d file%s deleted", n, n == 1 ? "" : "s");
+

+ +

+After the first complaints from people internationalizing the code people +either completely avoided formulations like this or used strings like +"file(s)". Both look unnatural and should be avoided. First +tries to solve the problem correctly looked like this: + +

11.4.2.2 Organizational Ideas

+   if (n == 1)
+     printf ("%d file deleted", n);
+   else
+     printf ("%d files deleted", n);
+

-I expect the next big changes after the official release. Please note -that I use the German translation of the short GPL message. We need -to set a few good examples before the localization goes out for true -in the free software community. Here are a few points to discuss: +But this does not solve the problem. It helps languages where the +plural form of a noun is not simply constructed by adding an `s' but +that is all. Once again people fell into the trap of believing the +rules their language is using are universal. But the handling of plural +forms differs widely between the language families. For example, +Rafal Maszkowski <rzm@mat.uni.torun.pl> reports:

+
+
+In Polish we use e.g. plik (file) this way: -Each group should have one FTP server (at least one master). +
```
+1 plik
+2,3,4 pliki
+5-21 pliko'w
+22-24 pliki
+25-31 pliko'w
+
```
-
+
+and so on (o' means 8859-2 oacute which should be rather okreska, +similar to aogonek). +
+ +
+There are two things which can differ between languages (and even inside +language families); -The files on the server should reflect the latest version (of -course!) and it should also contain a RCS directory with the -corresponding archives (I don't have this now). +
+
- -There should also be a ChangeLog file (this is more useful than the -RCS archive but can be generated automatically from the later by -Emacs). +The form how plural forms are built differs. This is a problem with +languages which have many irregularities. German, for instance, is a +drastic case. Though English and German are part of the same language +family (Germanic), the almost regular forming of plural noun forms +(appending an `s') is hardly found in German.
- -A core group should judge about questionable changes (for now -this group consists solely by me but I ask some others occasionally; -this also seems to work). +The number of plural forms differ. This is somewhat surprising for +those who only have experiences with Romanic and Germanic languages +since here the number is the same (there are two). +But other language families have only one form or many forms. More +information on this in an extra section.
+
+The consequence of this is that application writers should not try to +solve the problem in their code. This would be localization since it is +only usable for certain, hardcoded language environments. Instead the +extended gettext interface should be used. + +
+
+These extra functions are taking instead of the one key string two +strings and a numerical argument. The idea behind this is that using +the numerical argument and the first string as a key, the implementation +can select using rules specified by the translator the right plural +form. The two string arguments then will be used to provide a return +value in case no message catalog is found (similar to the normal +gettext behavior). In this case the rules for Germanic language +is used and it is assumed that the first string argument is the singular +form, the second the plural form. +
+
+This has the consequence that programs without language catalogs can +display the correct strings only if the program itself is written using +a Germanic language. This is a limitation but since the GNU C library +(as well as the GNU gettext package) are written as part of the +GNU package and the coding standards for the GNU project require program +being written in English, this solution nevertheless fulfills its +purpose. -
11.4.3 Mailing Lists
+
+
+
+
Function: char * ngettext (const char *msgid1, const char *msgid2, unsigned long int n) +
+The ngettext function is similar to the gettext function +as it finds the message catalogs in the same way. But it takes two +extra arguments. The msgid1 parameter must contain the singular +form of the string to be converted. It is also used as the key for the +search in the catalog. The msgid2 parameter is the plural form. +The parameter n is used to determine the plural form. If no +message catalog is found msgid1 is returned if n == 1, +otherwise msgid2. +

-If we get any inquiries about GNU gettext, send them on to: +An example for the use of this function is:
```
-`translation@iro.umontreal.ca´
+printf (ngettext ("%d file removed", "%d files removed", n), n);
 
```
-The `*-pretest´ lists are quite useful to me, maybe the idea could -be generalized to many GNU, and non-GNU packages. But each maintainer -his/her way! +Please note that the numeric value n has to be passed to the +printf function as well. It is not sufficient to pass it only to +ngettext. +
+ +
+
+
+
Function: char * dngettext (const char *domain, const char *msgid1, const char *msgid2, unsigned long int n) +
+The dngettext is similar to the dgettext function in the +way the message catalog is selected. The difference is that it takes +two extra parameter to provide the correct plural form. These two +parameters are handled in the same way ngettext handles them. +
+ +
+
+
+
Function: char * dcngettext (const char *domain, const char *msgid1, const char *msgid2, unsigned long int n, int category) +
+The dcngettext is similar to the dcgettext function in the +way the message catalog is selected. The difference is that it takes +two extra parameter to provide the correct plural form. These two +parameters are handled in the same way ngettext handles them. +
+ +
+
+Now, how do these functions solve the problem of the plural forms? +Without the input of linguists (which was not available) it was not +possible to determine whether there are only a few different forms in +which plural forms are formed or whether the number can increase with +every new supported language.

-François, we have a mechanism in place here at -`gnu.ai.mit.edu´ to track teams, support mailing lists for -them and log members. We have a slight preference that you use it. -If this is OK with you, I can get you clued in. +Therefore the solution implemented is to allow the translator to specify +the rules of how to select the plural form. Since the formula varies +with every language this is the only viable solution except for +hardcoding the information in the code (which still would require the +possibility of extensions to not prevent the use of new languages).

-Things are changing! A few years ago, when Daniel Fekete and I -asked for a mailing list for GNU localization, nested at the FSF, we -were politely invited to organize it anywhere else, and so did we. -For communicating with my pretesters, I later made a handful of -mailing lists located at iro.umontreal.ca and administrated by -majordomo. These lists have been very dependable -so far... + + + +The information about the plural form selection has to be stored in the +header entry of the PO file (the one with the empty msgid string). +The plural form information looks like this:
+ +
```
+Plural-Forms: nplurals=2; plural=n == 1 ? 0 : 1;
+
```
+
-I suspect that the German team will organize itself a mailing list -located in Germany, and so forth for other countries. But before they -organize for true, it could surely be useful to offer mailing lists -located at the FSF to each national team. So yes, please explain me -how I should proceed to create and handle them. +The nplurals value must be a decimal number which specifies how +many different plural forms exist for this language. The string +following plural is an expression which is using the C language +syntax. Exceptions are that no negative numbers are allowed, numbers +must be decimal, and the only variable allowed is n. This +expression will be evaluated whenever one of the functions +ngettext, dngettext, or dcngettext is called. The +numeric value passed to these functions is then substituted for all uses +of the variable n in the expression. The resulting value then +must be greater or equal to zero and smaller than the value given as the +value of nplurals.

-We should create temporary mailing lists, one per country, to help -people organize. Temporary, because once regrouped and structured, it -would be fair the volunteers from country bring back their list -in there and manage it as they want. My feeling is that, in the long -run, each team should run its own list, from within their country. -There also should be some central list to which all teams could -subscribe as they see fit, as long as each team is represented in it. + +The following rules are known at this point. The language with families +are listed. But this does not necessarily mean the information can be +generalized for the whole family (as can be easily seen in the table +below).(5)
+
+ +
Only one form: +
+Some languages only require one single form. There is no distinction +between the singular and plural form. An appropriate header entry +would look like this: + + +
```
+Plural-Forms: nplurals=1; plural=0;
+
```
+ +Languages with this property include: + +
+ +
Finno-Ugric family +
+Hungarian +
Asian family +
+Japanese, Korean, Vietnamese +
Turkic/Altaic family +
+Turkish +
+ +
Two forms, singular used for one only +
+This is the form used in most existing programs since it is what English +is using. A header entry would look like this: + + +
```
+Plural-Forms: nplurals=2; plural=n != 1;
+
```
+ +(Note: this uses the feature of C expressions that boolean expressions +have to value zero or one.) + +Languages with this property include: + +
+ +
Germanic family +
+Danish, Dutch, English, Faroese, German, Norwegian, Swedish +
Finno-Ugric family +
+Estonian, Finnish +
Latin/Greek family +
+Greek +
Semitic family +
+Hebrew +
Romanic family +
+Italian, Portuguese, Spanish +
Artificial +
+Esperanto +
+ +
Two forms, singular used for zero and one +
+Exceptional case in the language family. The header entry would be: + + +
```
+Plural-Forms: nplurals=2; plural=n>1;
+
```
+ +Languages with this property include: + +
+ +
Romanic family +
+French, Brazilian Portuguese +
+ +
Three forms, special case for zero +
+The header entry would be: + + +
```
+Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n != 0 ? 1 : 2;
+
```
+ +Languages with this property include: + +
+ +
Baltic family +
+Latvian +
+ +
Three forms, special cases for one and two +
+The header entry would be: + + +
```
+Plural-Forms: nplurals=3; plural=n==1 ? 0 : n==2 ? 1 : 2;
+
```
+ +Languages with this property include: + +
+ +
Celtic +
+Gaeilge (Irish) +
+ +
Three forms, special case for numbers ending in 1[2-9] +
+The header entry would look like this: + + +
```
+Plural-Forms: nplurals=3; \
+    plural=n%10==1 && n%100!=11 ? 0 : \
+           n%10>=2 && (n%100<10 || n%100>=20) ? 1 : 2;
+
```
+ +Languages with this property include: + +
+ +
Baltic family +
+Lithuanian +
+ +
Three forms, special cases for numbers ending in 1 and 2, 3, 4, except those ending in 1[1-4] +
+The header entry would look like this: + + +
```
+Plural-Forms: nplurals=3; \
+    plural=n%10==1 && n%100!=11 ? 0 : \
+           n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;
+
```
+ +Languages with this property include: + +
+
Slavic family +
+Croatian, Serbian, Russian, Ukrainian +
-
11.5 Information Flow
+
Three forms, special cases for 1 and 2, 3, 4 +
+The header entry would look like this: + +
```
+Plural-Forms: nplurals=3; \
+    plural=(n==1) ? 0 : (n>=2 && n<=4) ? 1 : 2;
+
```
+ +Languages with this property include: + +
+ +
Slavic family +
+Slovak, Czech +
+ +
Three forms, special case for one and some numbers ending in 2, 3, or 4 +
+The header entry would look like this: + + +
```
+Plural-Forms: nplurals=3; \
+    plural=n==1 ? 0 : \
+           n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;
+
```
+ +Languages with this property include: + +
+ +
Slavic family +
+Polish +
+ +
Four forms, special case for one and all numbers ending in 02, 03, or 04 +
+The header entry would look like this: + + +
```
+Plural-Forms: nplurals=4; \
+    plural=n%100==1 ? 0 : n%100==2 ? 1 : n%100==3 || n%100==4 ? 2 : 3;
+
```
+ +Languages with this property include: + +
+ +
Slavic family +
+Slovenian +
+
+ + + +
11.2.6 How to use gettext in GUI programs
+
+ + + + +

-There will surely be some discussion about this messages after the -packages are finally released. If people now send you some proposals -for better messages, how do you proceed? Jim, please note that -right now, as I put forward nearly a dozen of localizable programs, I -receive both the translations and the coordination concerns about them. +One place where the gettext functions, if used normally, have big +problems is within programs with graphical user interfaces (GUIs). The +problem is that many of the strings which have to be translated are very +short. They have to appear in pull-down menus which restricts the +length. But strings which are not containing entire sentences or at +least large fragments of a sentence may appear in more than one +situation in the program but might have different translations. This is +especially true for the one-word strings which are frequently used in +GUI programs.

-If I put one of my things to pretest, Ulrich receives the announcement -and passes it on to the German team, who make last minute revisions. -Then he submits the translation files to me as the maintainer. -For free packages I do not maintain, I would not even hear about it. -This scheme could be made to work for the whole Translation Project, -I think. For security reasons, maybe Ulrich (national coordinators, -in fact) should update central registry kept at the Translation Project -(Jim, me, or Len's recruits) once in a while. +As a consequence many people say that the gettext approach is +wrong and instead catgets should be used which indeed does not +have this problem. But there is a very simple and powerful method to +handle these kind of problems with the gettext functions.

-In December/January, I was aggressively ready to internationalize -all of GNU, giving myself the duty of one small GNU package per week -or so, taking many weeks or months for bigger packages. But it does -not work this way. I first did all the things I'm responsible for. -I've nothing against some missionary work on other maintainers, but -I'm also loosing a lot of energy over it--same debates over again. +As as example consider the following fictional situation. A GUI program +has a menu bar with the following entries:
+ +
```
++------------+------------+--------------------------------------+
+| File       | Printer    |                                      |
++------------+------------+--------------------------------------+
+| Open     | | Select   |
+| New      | | Open     |
++----------+ | Connect  |
+             +----------+
+
```
+
-And when the first localized packages are released we'll get a lot of -responses about ugly translations :-). Surely, and we need to have -beforehand a fairly good idea about how to handle the information -flow between the national teams and the package maintainers. +To have the strings File, Printer, Open, +New, Select, and Connect translated there has to be +at some point in the code a call to a function of the gettext +family. But in two places the string passed into the function would be +Open. The translations might not be the same and therefore we +are in the dilemma described above.

-Please start saving somewhere a quick history of each PO file. I know -for sure that the file format will change, allowing for comments. -It would be nice that each file has a kind of log, and references for -those who want to submit comments or gripes, or otherwise contribute. -I sent a proposal for a fast and flexible format, but it is not -receiving acceptance yet by the GNU deciders. I'll tell you when I -have more information about this. +One solution to this problem is to artificially enlengthen the strings +to make them unambiguous. But what would the program do if no +translation is available? The enlengthened string is not what should be +printed. So we should use a little bit modified version of the functions.
+
+To enlengthen the strings a uniform method should be used. E.g., in the +example above the strings could be chosen as +
-
11.6 Prioritizing messages: How to determine which messages to translate first
+
```
+Menu|File
+Menu|Printer
+Menu|File|Open
+Menu|File|New
+Menu|Printer|Select
+Menu|Printer|Open
+Menu|Printer|Connect
+
```
-A translator sometimes has only a limited amount of time per week to -spend on a package, and some packages have quite large message catalogs -(over 1000 messages). Therefore she wishes to translate the messages -first that are the most visible to the user, or that occur most frequently. -This section describes how to determine these "most urgent" messages. -It also applies to determine the "next most urgent" messages after the -message catalog has already been partially translated. +Now all the strings are different and if now instead of gettext +the following little wrapper function is used, everything works just +fine:

-In a first step, she uses the programs like a user would do. While she -does this, the GNU gettext library logs into a file the not yet -translated messages for which a translation was requested from the program. + + +
```
+  char *
+  sgettext (const char *msgid)
+  {
+    char *msgval = gettext (msgid);
+    if (msgval == msgid)
+      msgval = strrchr (msgid, '|') + 1;
+    return msgval;
+  }
+
```
+ +
+What this little function does is to recognize the case when no +translation is available. This can be done very efficiently by a +pointer comparison since the return value is the input value. If there +is no translation we know that the input string is in the format we used +for the Menu entries and therefore contains a | character. We +simply search for the last occurrence of this character and return a +pointer to the character following it. That's it!

-In a second step, she uses the PO mode to translate precisely this set -of messages. +If one now consistently uses the enlengthened string form and replaces +the gettext calls with calls to sgettext (this is normally +limited to very few places in the GUI implementation) then it is +possible to produce a program which can be internationalized.

- -Here a more details. The GNU libintl library (but not the -corresponding functions in GNU libc) supports an environment variable -GETTEXT_LOG_UNTRANSLATED. The GNU libintl library will -log into this file the messages for which gettext() and related -functions couldn't find the translation. If the file doesn't exist, it -will be created as needed. On systems with GNU libc a shared library -`preloadable_libintl.so´ is provided that can be used with the ELF -`LD_PRELOAD´ mechanism. +The other gettext functions (dgettext, dcgettext +and the ngettext equivalents) can and should have corresponding +functions as well which look almost identical, except for the parameters +and the call to the underlying function.

-So, in the first step, the translator uses these commands on systems with -GNU libc: +Now there is of course the question why such functions do not exist in +the GNU gettext package? There are two parts of the answer to this question. + +
+ +
- + +They are easy to write and therefore can be provided by the project they +are used in. This is not an answer by itself and must be seen together +with the second part which is: + +
- + +There is no way the gettext package can contain a version which can work +everywhere. The problem is the selection of the character to separate +the prefix from the actual string in the enlenghtened string. The +examples above used | which is a quite good choice because it +resembles a notation frequently used in this context and it also is a +character not often used in message strings. + +But what if the character is used in message strings? Or if the chose +character is not available in the character set on the machine one +compiles (e.g., | is not required to exist for ISO C; this is +why the `iso646.h´ file exists in ISO C programming environments). +
+ +
+There is only one more comment to be said. The wrapper function above +requires that the translations strings are not enlengthened themselves. +This is only logical. There is no need to disambiguate the strings +(since they are never used as keys for a search) and one also saves +quite some memory and disk space by doing this. + +
+ + +
11.2.7 Optimization of the *gettext functions
+
+ + +
+
+At this point of the discussion we should talk about an advantage of the +GNU gettext implementation. Some readers might have pointed out +that an internationalized program might have a poor performance if some +string has to be translated in an inner loop. While this is unavoidable +when the string varies from one run of the loop to the other it is +simply a waste of time when the string is always the same. Take the +following example:
```
-$ LD_PRELOAD=/usr/local/lib/preloadable_libintl.so
-$ export LD_PRELOAD
-$ GETTEXT_LOG_UNTRANSLATED=$HOME/gettextlogused
-$ export GETTEXT_LOG_UNTRANSLATED
+{
+  while (...)
+    {
+      puts (gettext ("Hello world"));
+    }
+}
 
```
-and these commands on other systems: +When the locale selection does not change between two runs the resulting +string is always the same. One way to use this is:
```
-$ GETTEXT_LOG_UNTRANSLATED=$HOME/gettextlogused
-$ export GETTEXT_LOG_UNTRANSLATED
+{
+  str = gettext ("Hello world");
+  while (...)
+    {
+      puts (str);
+    }
+}
 
```
-Then she uses and peruses the programs. (It is a good and recommended -practice to use the programs for which you provide translations: it -gives you the needed context.) When done, she removes the environment -variables: +But this solution is not usable in all situation (e.g. when the locale +selection changes) nor does it lead to legible code. + +
+
+For this reason, GNU gettext caches previous translation results. +When the same translation is requested twice, with no new message +catalogs being loaded in between, gettext will, the second time, +find the result through a single cache lookup. + +
+ + +
11.3 Comparing the Two Interfaces
+
+ + + +
+ +
+The following discussion is perhaps a little bit colored. As said +above we implemented GNU gettext following the Uniforum +proposal and this surely has its reasons. But it should show how we +came to this decision. + +
+
+First we take a look at the developing process. When we write an +application using NLS provided by gettext we proceed as always. +Only when we come to a string which might be seen by the users and thus +has to be translated we use gettext("...") instead of +"...". At the beginning of each source file (or in a central +header file) we define
```
-$ unset LD_PRELOAD
-$ unset GETTEXT_LOG_UNTRANSLATED
+#define gettext(String) (String)
 
```
-The second step starts with removing duplicates: +Even this definition can be avoided when the system supports the +gettext function in its C library. When we compile this code the +result is the same as if no NLS code is used. When you take a look at +the GNU gettext code you will see that we use _("...") +instead of gettext("..."). This reduces the number of +additional characters per translatable string to 3 (in words: +three). + +
+
+When now a production version of the program is needed we simply replace +the definition
```
-$ msguniq $HOME/gettextlogused > missing.po
+#define _(String) (String)
 
```
-The result is a PO file, but needs some preprocessing before the Emacs PO -mode can be used with it. First, it is a multi-domain PO file, containing -messages from many translation domains. Second, it lacks all translator -comments and source references. Here is how to get a list of the affected -translation domains: +by
+
+
```
-$ sed -n -e 's,^domain "$.*$"$,\1,p' < missing.po | sort | uniq
+#include <libintl.h>
+#define _(String) gettext (String)
 
```
-Then the translator can handle the domains one by one. For simplicity, -let's use environment variables to denote the language, domain and source -package. +Additionally we run the program `xgettext´ on all source code file +which contain translatable strings and that's it: we have a running +program which does not depend on translations to be available, but which +can use any that becomes available. + +
+
+ +The same procedure can be done for the gettext_noop invocations +(see section 4.6 Special Cases of Translatable Strings). One usually defines gettext_noop as a +no-op macro. So you should consider the following code for your project: + +
+ +
```
+#define gettext_noop(String) String
+#define N_(String) gettext_noop (String)
+
```
+ +
+N_ is a short form similar to _. The `Makefile´ in +the `po/´ directory of GNU gettext knows by default both of the +mentioned short forms so you are invited to follow this proposal for +your own ease. + +
+
+Now to catgets. The main problem is the work for the +programmer. Every time he comes to a translatable string he has to +define a number (or a symbolic constant) which has also be defined in +the message catalog file. He also has to take care for duplicate +entries, duplicate message IDs etc. If he wants to have the same +quality in the message catalog as the GNU gettext program +provides he also has to put the descriptive comments for the strings and +the location in all source code files in the message catalog. This is +nearly a Mission: Impossible. + +
+
+But there are also some points people might call advantages speaking for +catgets. If you have a single word in a string and this string +is used in different contexts it is likely that in one or the other +language the word has different translations. Example:
```
-$ lang=nl             # your language
-$ domain=coreutils    # the name of the domain to be handled
-$ package=/usr/src/gnu/coreutils-4.5.4   # the package where it comes from
+printf ("%s: %d", gettext ("number"), number_of_errors)
+
+printf ("you should see %d %s", number_count,
+        number_count == 1 ? gettext ("number") : gettext ("numbers"))
 
```
-She takes the latest copy of `$lang.po´ from the Translation Project, -or from the package (in most cases, `$package/po/$lang.po´), or -creates a fresh one if she's the first translator (see section 5 Creating a New PO File). -She then uses the following commands to mark the not urgent messages as -"obsolete". (This doesn't mean that these messages - translated and -untranslated ones - will go away. It simply means that Emacs PO mode -will ignore them in the following editing session.) +Here we have to translate two times the string "number". Even +if you do not speak a language beside English it might be possible to +recognize that the two words have a different meaning. In German the +first appearance has to be translated to "Anzahl" and the second +to "Zahl". + +
+
+Now you can say that this example is really esoteric. And you are +right! This is exactly how we felt about this problem and decide that +it does not weight that much. The solution for the above problem could +be very easy:
```
-$ msggrep --domain=$domain missing.po | grep -v '^domain' \
-  > $domain-missing.po
-$ msgattrib --set-obsolete --ignore-file $domain-missing.po $domain.$lang.po \
-  > $domain.$lang-urgent.po
+printf ("%s %d", gettext ("number:"), number_of_errors)
+
+printf (number_count == 1 ? gettext ("you should see %d number")
+                          : gettext ("you should see %d numbers"),
+        number_count)
 
```
-The she translates `$domain.$lang-urgent.po´ by use of Emacs PO mode. -(FIXME: I don't know whether KBabel and gtranslator also -preserve obsolete messages, as they should.) -Finally she restores the not urgent messages (with their earlier -translations, for those which were already translated) through this command: +We believe that we can solve all conflicts with this method. If it is +difficult one can also consider changing one of the conflicting string a +little bit. But it is not impossible to overcome. + +
+
+catgets allows same original entry to have different translations, +but gettext has another, scalable approach for solving ambiguities +of this kind: See section 11.2.2 Solving Ambiguities. + +
+ + +
11.4 Using libintl.a in own programs
+ +
+Starting with version 0.9.4 the library libintl.h should be +self-contained. I.e., you can use it in your own programs without +providing additional functions. The `Makefile´ will put the header +and the library in directories selected using the $(prefix). + +
+ + +
11.5 Being a gettext grok
+ +
+To fully exploit the functionality of the GNU gettext library it +is surely helpful to read the source code. But for those who don't want +to spend that much time in reading the (sometimes complicated) code here +is a list comments:
+
- Changing the language at runtime + + + +For interactive programs it might be useful to offer a selection of the +used language at runtime. To understand how to do this one need to know +how the used language is determined while executing the gettext +function. The method which is presented here only works correctly +with the GNU implementation of the gettext functions. + +In the function dcgettext at every call the current setting of +the highest priority environment variable is determined and used. +Highest priority means here the following list with decreasing +priority: + + +
  1. LANGUAGE + + + + +
  2. LC_ALL + + + + + + + +
  3. LC_xxx, according to selected locale + + +
  4. LANG + +
  + +Afterwards the path is constructed using the found value and the +translation file is loaded if available. + +What happens now when the value for, say, LANGUAGE changes? According +to the process explained above the new value of this variable is found +as soon as the dcgettext function is called. But this also means +the (perhaps) different message catalog file is loaded. In other +words: the used language is changed. + +But there is one little hook. The code for gcc-2.7.0 and up provides +some optimization. This optimization normally prevents the calling of +the dcgettext function as long as no new catalog is loaded. But +if dcgettext is not called the program also cannot find the +LANGUAGE variable be changed (see section 11.2.7 Optimization of the *gettext functions). A +solution for this is very easy. Include the following code in the +language switching function. + +
```
-$ msgmerge --no-fuzzy-matching $domain.$lang-urgent.po $package/po/$domain.pot \
-  > $domain.$lang.po
+  /* Change language.  */
+  setenv ("LANGUAGE", "fr", 1);
+
+  /* Make change known.  */
+  {
+    extern int  _nl_msg_cat_cntr;
+    ++_nl_msg_cat_cntr;
+  }
 
```
  + +The variable _nl_msg_cat_cntr is defined in `loadmsgcat.c´. +You don't need to know what this is for. But it can be used to detect +whether a gettext implementation is GNU gettext and not non-GNU +system's native gettext implementation. + +
+ + + +
11.6 Temporary Notes for the Programmers Chapter
+ + + +
11.6.1 Temporary - Two Possible Implementations
+ +
+There are two competing methods for language independent messages: +the X/Open catgets method, and the Uniforum gettext +method. The catgets method indexes messages by integers; the +gettext method indexes them by their English translations. +The catgets method has been around longer and is supported +by more vendors. The gettext method is supported by Sun, +and it has been heard that the COSE multi-vendor initiative is +supporting it. Neither method is a POSIX standard; the POSIX.1 +committee had a lot of disagreement in this area. + +
+
+Neither one is in the POSIX standard. There was much disagreement +in the POSIX.1 committee about using the gettext routines +vs. catgets (XPG). In the end the committee couldn't +agree on anything, so no messaging system was included as part +of the standard. I believe the informative annex of the standard +includes the XPG3 messaging interfaces, "...as an example of +a messaging system that has been implemented..." + +
+
+They were very careful not to say anywhere that you should use one +set of interfaces over the other. For more on this topic please +see the Programming for Internationalization FAQ. + +
+ + +
11.6.2 Temporary - About catgets
+ +
+There have been a few discussions of late on the use of +catgets as a base. I think it important to present both +sides of the argument and hence am opting to play devil's advocate +for a little bit. + +
+
+I'll not deny the fact that catgets could have been designed +a lot better. It currently has quite a number of limitations and +these have already been pointed out. + +
+
+However there is a great deal to be said for consistency and +standardization. A common recurring problem when writing Unix +software is the myriad portability problems across Unix platforms. +It seems as if every Unix vendor had a look at the operating system +and found parts they could improve upon. Undoubtedly, these +modifications are probably innovative and solve real problems. +However, software developers have a hard time keeping up with all +these changes across so many platforms. + +
+
+And this has prompted the Unix vendors to begin to standardize their +systems. Hence the impetus for Spec1170. Every major Unix vendor +has committed to supporting this standard and every Unix software +developer waits with glee the day they can write software to this +standard and simply recompile (without having to use autoconf) +across different platforms. + +
+
+As I understand it, Spec1170 is roughly based upon version 4 of the +X/Open Portability Guidelines (XPG4). Because catgets and +friends are defined in XPG4, I'm led to believe that catgets +is a part of Spec1170 and hence will become a standardized component +of all Unix systems. + +
+ + +
11.6.3 Temporary - Why a single implementation
+ +
+Now it seems kind of wasteful to me to have two different systems +installed for accessing message catalogs. If we do want to remedy +catgets deficiencies why don't we try to expand catgets +(in a compatible manner) rather than implement an entirely new system. +Otherwise, we'll end up with two message catalog access systems installed +with an operating system - one set of routines for packages using GNU +gettext for their internationalization, and another set of routines +(catgets) for all other software. Bloated? + +
+
+Supposing another catalog access system is implemented. Which do +we recommend? At least for Linux, we need to attract as many +software developers as possible. Hence we need to make it as easy +for them to port their software as possible. Which means supporting +catgets. We will be implementing the libintl code +within our libc, but does this mean we also have to incorporate +another message catalog access scheme within our libc as well? +And what about people who are going to be using the libintl ++ non-catgets routines. When they port their software to +other platforms, they're now going to have to include the front-end +(libintl) code plus the back-end code (the non-catgets +access routines) with their software instead of just including the +libintl code with their software. + +
+
+Message catalog support is however only the tip of the iceberg. +What about the data for the other locale categories. They also have +a number of deficiencies. Are we going to abandon them as well and +develop another duplicate set of routines (should libintl +expand beyond message catalog support)? + +
+
+Like many parts of Unix that can be improved upon, we're stuck with balancing +compatibility with the past with useful improvements and innovations for +the future. + +
+ + +
11.6.4 Temporary - Notes
+ +
+X/Open agreed very late on the standard form so that many +implementations differ from the final form. Both of my system (old +Linux catgets and Ultrix-4) have a strange variation. + +

-Then she can submit `$domain.$lang.po´ and proceed to the next domain. +OK. After incorporating the last changes I have to spend some time on +making the GNU/Linux libc gettext functions. So in future +Solaris is not the only system having gettext.

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_12.html b/gettext-tools/doc/gettext_12.html index 66a4fc53b..441a90478 100644 --- a/gettext-tools/doc/gettext_12.html +++ b/gettext-tools/doc/gettext_12.html @@ -1,1710 +1,662 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - 12 The Maintainer's View +GNU gettext utilities - 12 The Translator's View -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.
-
12 The Maintainer's View
-
- +
12 The Translator's View
-
-
-The maintainer of a package has many responsibilities. One of them -is ensuring that the package will install easily on many platforms, -and that the magic we described earlier (see section 9 The User's View) will work -for installers and end users. -
-
-Of course, there are many possible ways by which GNU gettext -might be integrated in a distribution, and this chapter does not cover -them in all generality. Instead, it details one possible approach which -is especially adequate for many free software distributions following GNU -standards, or even better, Gnits standards, because GNU gettext -is purposely for helping the internationalization of the whole GNU -project, and as many other good free packages as possible. So, the -maintainer's view presented here presumes that the package already has -a `configure.in´ file and uses GNU Autoconf. -
-
-Nevertheless, GNU gettext may surely be useful for free packages -not following GNU standards and conventions, but the maintainers of such -packages might have to show imagination and initiative in organizing -their distributions so gettext work for them in all situations. -There are surely many, out there. +
12.1 Introduction 0
-

-Even if gettext methods are now stabilizing, slight adjustments -might be needed between successive gettext versions, so you -should ideally revise this chapter in subsequent releases, looking -for changes. +Free software is going international! The Translation Project is a way +to get maintainers, translators and users all together, so free software +will gradually become able to speak many native languages.
- - - -
12.1 Flat or Non-Flat Directory Structures
-
-Some free software packages are distributed as tar files which unpack -in a single directory, these are said to be flat distributions. -Other free software packages have a one level hierarchy of subdirectories, using -for example a subdirectory named `doc/´ for the Texinfo manual and -man pages, another called `lib/´ for holding functions meant to -replace or complement C libraries, and a subdirectory `src/´ for -holding the proper sources for the package. These other distributions -are said to be non-flat. +The GNU gettext tool set contains everything maintainers +need for internationalizing their packages for messages. It also +contains quite useful tools for helping translators at localizing +messages to their native language, once a package has already been +internationalized.

-We cannot say much about flat distributions. A flat -directory structure has the disadvantage of increasing the difficulty -of updating to a new version of GNU gettext. Also, if you have -many PO files, this could somewhat pollute your single directory. -Also, GNU gettext's libintl sources consist of C sources, shell -scripts, sed scripts and complicated Makefile rules, which don't -fit well into an existing flat structure. For these reasons, we -recommend to use non-flat approach in this case as well. +To achieve the Translation Project, we need many interested +people who like their own language and write it well, and who are also +able to synergize with other translators speaking the same language. +If you'd like to volunteer to work at translating messages, +please send mail to your translating team.

-Maybe because GNU gettext itself has a non-flat structure, -we have more experience with this approach, and this is what will be -described in the remaining of this chapter. Some maintainers might -use this as an opportunity to unflatten their package structure. +Each team has its own mailing list, courtesy of Linux +International. You may reach your translating team at the address +`ll@li.org´, replacing ll by the two-letter ISO 639 +code for your language. Language codes are not the same as +country codes given in ISO 3166. The following translating teams +exist:
- -
12.2 Prerequisite Works
+

- - - +Chinese zh, Czech cs, Danish da, Dutch nl, +Esperanto eo, Finnish fi, French fr, Irish +ga, German de, Greek el, Italian it, +Japanese ja, Indonesian in, Norwegian no, Polish +pl, Portuguese pt, Russian ru, Spanish es, +Swedish sv and Turkish tr. +
-

-There are some works which are required for using GNU gettext -in one of your package. These works have some kind of generality -that escape the point by point descriptions used in the remainder -of this chapter. So, we describe them here. +For example, you may reach the Chinese translating team by writing to +`zh@li.org´. When you become a member of the translating team +for your own language, you may subscribe to its list. For example, +Swedish people can send a message to `sv-request@li.org´, +having this message body:
-
- - -Before attempting to use gettextize you should install some -other packages first. -Ensure that recent versions of GNU m4, GNU Autoconf and GNU -gettext are already installed at your site, and if not, proceed -to do this first. If you get to install these things, beware that -GNU m4 must be fully installed before GNU Autoconf is even -configured. - -To further ease the task of a package maintainer the automake -package was designed and implemented. GNU gettext now uses this -tool and the `Makefile´s in the `intl/´ and `po/´ -therefore know about all the goals necessary for using automake -and `libintl´ in one project. - -Those four packages are only needed by you, as a maintainer; the -installers of your own package and end users do not really need any of -GNU m4, GNU Autoconf, GNU gettext, or GNU automake -for successfully installing and running your package, with messages -properly translated. But this is not completely true if you provide -internationalized shell scripts within your own package: GNU -gettext shall then be installed at the user site if the end users -want to see the translation of shell script messages. - -
- - -Your package should use Autoconf and have a `configure.in´ or -`configure.ac´ file. -If it does not, you have to learn how. The Autoconf documentation -is quite well written, it is a good idea that you print it and get -familiar with it. - -
- - -Your C sources should have already been modified according to -instructions given earlier in this manual. See section 3 Preparing Program Sources. - -
- - -Your `po/´ directory should receive all PO files submitted to you -by the translator teams, each having `ll.po´ as a name. -This is not usually easy to get translation -work done before your package gets internationalized and available! -Since the cycle has to start somewhere, the easiest for the maintainer -is to start with absolutely no PO files, and wait until various -translator teams get interested in your package, and submit PO files. - -
- -
-It is worth adding here a few words about how the maintainer should -ideally behave with PO files submissions. As a maintainer, your role is -to authenticate the origin of the submission as being the representative -of the appropriate translating teams of the Translation Project (forward -the submission to `translation@iro.umontreal.ca´ in case of doubt), -to ensure that the PO file format is not severely broken and does not -prevent successful installation, and for the rest, to merely put these -PO files in `po/´ for distribution. +
```
+subscribe
+
```
-

-As a maintainer, you do not have to take on your shoulders the -responsibility of checking if the translations are adequate or -complete, and should avoid diving into linguistic matters. Translation -teams drive themselves and are fully responsible of their linguistic -choices for the Translation Project. Keep in mind that translator teams are not -driven by maintainers. You can help by carefully redirecting all -communications and reports from users about linguistic matters to the -appropriate translation team, or explain users how to reach or join -their team. The simplest might be to send them the `ABOUT-NLS´ file. +Keep in mind that team members should be interested in working +at translations, or at solving translational difficulties, rather than +merely lurking around. If your team does not exist yet and you want to +start one, please write to `translation@iro.umontreal.ca´; +you will then reach the coordinator for all translator teams.

-Maintainers should never ever apply PO file bug reports -themselves, short-cutting translation teams. If some translator has -difficulty to get some of her points through her team, it should not be -an option for her to directly negotiate translations with maintainers. -Teams ought to settle their problems themselves, if any. If you, as -a maintainer, ever think there is a real problem with a team, please -never try to solve a team's problem on your own. +A handful of GNU packages have already been adapted and provided +with message translations for several languages. Translation +teams have begun to organize, using these packages as a starting +point. But there are many more packages and many languages for +which we have no volunteer translators. If you would like to +volunteer to work at translating messages, please send mail to +`translation@iro.umontreal.ca´ indicating what language(s) +you can work on.
-
12.3 Invoking the gettextize Program
+
12.2 Introduction 1

-The gettextize program is an interactive tool that helps the -maintainer of a package internationalized through GNU gettext. -It is used for two purposes: +This is now official, GNU is going international! Here is the +announcement submitted for the January 1995 GNU Bulletin:
-
- - -As a wizard, when a package is modified to use GNU gettext for -the first time. - -
- - -As a migration tool, for upgrading the GNU gettext support in -a package from a previous to a newer version of GNU gettext. -
- +
-This program performs the following tasks: - -
- -
- - -It copies into the package some files that are consistently and -identically needed in every package internationalized through -GNU gettext. - -
- It performs as many of the tasks mentioned in the next section - -section 12.4 Files You Must Create or Alter as can be performed automatically. - -
- It removes obsolete files and idioms used for previous GNU - -gettext versions to the form recommended for the current GNU -gettext version. - -
- It prints a summary of the tasks that ought to be done manually - -and could not be done automatically by gettextize. -
+A handful of GNU packages have already been adapted and provided +with message translations for several languages. Translation +teams have begun to organize, using these packages as a starting +point. But there are many more packages and many languages +for which we have no volunteer translators. If you'd like to +volunteer to work at translating messages, please send mail to +`translation@iro.umontreal.ca´ indicating what language(s) +you can work on. +
-It can be invoked as follows: +This document should answer many questions for those who are curious about +the process or would like to contribute. Please at least skim over it, +hoping to cut down a little of the high volume of e-mail generated by this +collective effort towards internationalization of free software.

- - - -
```
-gettextize [ option... ] [ directory ]
-
```
- -
-and accepts the following options: +Most free programming which is widely shared is done in English, and +currently, English is used as the main communicating language between +national communities collaborating to free software. This very document +is written in English. This will not change in the foreseeable future.
-
- -
`-c´ -
-
`--copy´ -
- - -Copy the needed files instead of making symbolic links. Using links -would allow the package to always use the latest gettext code -available on the system, but it might disturb some mechanism the -maintainer is used to apply to the sources. Because running -gettextize is easy there shouldn't be problems with using copies. - -
`-f´ -
-
`--force´ -
- - -Force replacement of files which already exist. - -
`--intl´ -
- -Install the libintl sources in a subdirectory named `intl/´. -This libintl will be used to provide internationalization on systems -that don't have GNU libintl installed. If this option is omitted, -the call to AM_GNU_GETTEXT in `configure.in´ should read: -`AM_GNU_GETTEXT([external])´, and internationalization will not -be enabled on systems lacking GNU gettext. - -
`--no-changelog´ -
- -Don't update or create ChangeLog files. By default, gettextize -logs all changes (file additions, modifications and removals) in a -file called `ChangeLog´ in each affected directory. - -
`-n´ -
-
`--dry-run´ -
- - -Print modifications but don't perform them. All actions that -gettextize would normally execute are inhibited and instead only -listed on standard output. - -
`--help´ -
- -Display this help and exit. - -
`--version´ -
- -Output version information and exit. - -
-
-If directory is given, this is the top level directory of a -package to prepare for using GNU gettext. If not given, it -is assumed that the current directory is the top level directory of -such a package. +However, there is a strong appetite from national communities for +having more software able to write using national language and habits, +and there is an on-going effort to modify free software in such a way +that it becomes able to do so. The experiments driven so far raised +an enthusiastic response from pretesters, so we believe that +internationalization of free software is dedicated to succeed.

-The program gettextize provides the following files. However, -no existing file will be replaced unless the option --force -(-f) is specified. +For suggestion clarifications, additions or corrections to this +document, please e-mail to `translation@iro.umontreal.ca´.
-
1. - -The `ABOUT-NLS´ file is copied in the main directory of your package, -the one being at the top level. This file gives the main indications -about how to install and use the Native Language Support features -of your program. You might elect to use a more recent copy of this -`ABOUT-NLS´ file than the one provided through gettextize, -if you have one handy. You may also fetch a more recent copy of file -`ABOUT-NLS´ from Translation Project sites, and from most GNU -archive sites. - -
2. - -A `po/´ directory is created for eventually holding -all translation files, but initially only containing the file -`po/Makefile.in.in´ from the GNU gettext distribution -(beware the double `.in´ in the file name) and a few auxiliary -files. If the `po/´ directory already exists, it will be preserved -along with the files it contains, and only `Makefile.in.in´ and -the auxiliary files will be overwritten. -
3. +
  12.3 Discussions
  -Only if `--intl´ has been specified: -A `intl/´ directory is created and filled with most of the files -originally in the `intl/´ directory of the GNU gettext -distribution. Also, if option --force (-f) is given, -the `intl/´ directory is emptied first. +
  +Facing this internationalization effort, a few users expressed their +concerns. Some of these doubts are presented and discussed, here. -
4. +
  -The files `config.rpath´ and `mkinstalldirs´ are copied into -the directory containing configuration support files. It is needed by -the AM_GNU_GETTEXT autoconf macro. +
  - Smaller groups + +Some languages are not spoken by a very large number of people, so people +speaking them sometimes consider that there may not be all that much +demand such versions of free software packages. Moreover, many people +being into computers, in some countries, generally seem to prefer +English versions of their software. + +On the other end, people might enjoy their own language a lot, and be +very motivated at providing to themselves the pleasure of having their +beloved free software speaking their mother tongue. They do themselves +a personal favor, and do not pay that much attention to the number of +people benefiting of their work. + +
  - Misinterpretation + +Other users are shy to push forward their own language, seeing in this +some kind of misplaced propaganda. Someone thought there must be some +users of the language over the networks pestering other people with it. + +But any spoken language is worth localization, because there are +people behind the language for whom the language is important and +dear to their hearts. + +
  - Odd translations + +The biggest problem is to find the right translations so that +everybody can understand the messages. Translations are usually a +little odd. Some people get used to English, to the extent they may +find translations into their own language "rather pushy, obnoxious +and sometimes even hilarious." As a French speaking man, I have +the experience of those instruction manuals for goods, so poorly +translated in French in Korea or Taiwan... + +The fact is that we sometimes have to create a kind of national +computer culture, and this is not easy without the collaboration of +many people liking their mother tongue. This is why translations are +better achieved by people knowing and loving their own language, and +ready to work together at improving the results they obtain. + +
  - Dependencies over the GPL or LGPL + +Some people wonder if using GNU gettext necessarily brings their +package under the protective wing of the GNU General Public License or +the GNU Library General Public License, when they do not want to make +their program free, or want other kinds of freedom. The simplest +answer is "normally not". + +The gettext-runtime part of GNU gettext, i.e. the +contents of libintl, is covered by the GNU Library General Public +License. The gettext-tools part of GNU gettext, i.e. the +rest of the GNU gettext package, is covered by the GNU General +Public License. + +The mere marking of localizable strings in a package, or conditional +inclusion of a few lines for initialization, is not really including +GPL'ed or LGPL'ed code. However, since the localization routines in +libintl are under the LGPL, the LGPL needs to be considered. +It gives the right to distribute the complete unmodified source of +libintl even with non-free programs. It also gives the right +to use libintl as a shared library, even for non-free programs. +But it gives the right to use libintl as a static library or +to incorporate libintl into another library only to free +software. -
  - +
  -Only if the project is using GNU automake: -A set of autoconf macro files is copied into the package's -autoconf macro repository, usually in a directory called `m4/´. -
-
-If your site support symbolic links, gettextize will not -actually copy the files into your package, but establish symbolic -links instead. This avoids duplicating the disk space needed in -all packages. Merely using the `-h´ option while creating the -tar archive of your distribution will resolve each link by an -actual copy in the distribution archive. So, to insist, you really -should use `-h´ option with tar within your dist -goal of your main `Makefile.in´. -
-
-Furthermore, gettextize will update all `Makefile.am´ files -in each affected directory, as well as the top level `configure.in´ -or `configure.ac´ file. +
12.4 Organization
-

-It is interesting to understand that most new files for supporting -GNU gettext facilities in one package go in `intl/´, -`po/´ and `m4/´ subdirectories. One distinction between -`intl/´ and the two other directories is that `intl/´ is -meant to be completely identical in all packages using GNU gettext, -while the other directories will mostly contain package dependent -files. +On a larger scale, the true solution would be to organize some kind of +fairly precise set up in which volunteers could participate. I gave +some thought to this idea lately, and realize there will be some +touchy points. I thought of writing to Richard Stallman to launch +such a project, but feel it might be good to shake out the ideas +between ourselves first. Most probably that Linux International has +some experience in the field already, or would like to orchestrate +the volunteer work, maybe. Food for thought, in any case!

-The gettextize program makes backup files for all files it -replaces or changes, and also write ChangeLog entries about these -changes. This way, the careful maintainer can check after running -gettextize whether its changes are acceptable to him, and -possibly adjust them. An exception to this rule is the `intl/´ -directory, which is added or replaced or removed as a whole. +I guess we have to setup something early, somehow, that will help +many possible contributors of the same language to interlock and avoid +work duplication, and further be put in contact for solving together +problems particular to their tongue (in most languages, there are many +difficulties peculiar to translating technical English). My Swedish +contributor acknowledged these difficulties, and I'm well aware of +them for French.

-It is important to understand that gettextize can not do the -entire job of adapting a package for using GNU gettext. The -amount of remaining work depends on whether the package uses GNU -automake or not. But in any case, the maintainer should still -read the section section 12.4 Files You Must Create or Alter after invoking gettextize. +This is surely not a technical issue, but we should manage so the +effort of locale contributors be maximally useful, despite the national +team layer interface between contributors and maintainers.

-It is also important to understand that gettextize is not part -of the GNU build system, in the sense that it should not be invoked -automatically, and not be invoked by someone who doesn't assume the -responsibilities of a package maintainer. For the latter purpose, a -separate tool is provided, see section 12.6.3 Invoking the autopoint Program. +The Translation Project needs some setup for coordinating language +coordinators. Localizing evolving programs will surely +become a permanent and continuous activity in the free software community, +once well started. +The setup should be minimally completed and tested before GNU +gettext becomes an official reality. The e-mail address +`translation@iro.umontreal.ca´ has been setup for receiving +offers from volunteers and general e-mail on these topics. This address +reaches the Translation Project coordinator.
-
12.4 Files You Must Create or Alter
-
- -
-
-Besides files which are automatically added through gettextize, -there are many files needing revision for properly interacting with -GNU gettext. If you are closely following GNU standards for -Makefile engineering and auto-configuration, the adaptations should -be easier to achieve. Here is a point by point description of the -changes needed in each. +
12.4.1 Central Coordination
-

-So, here comes a list of files, each one followed by a description of -all alterations it needs. Many examples are taken out from the GNU -gettext 0.14.4 distribution itself, or from the GNU -hello distribution (http://www.franken.de/users/gnu/ke/hello -or http://www.gnu.franken.de/ke/hello/) You may indeed -refer to the source code of the GNU gettext and GNU hello -packages, as they are intended to be good examples for using GNU -gettext functionality. +I also think GNU will need sooner than it thinks, that someone setup +a way to organize and coordinate these groups. Some kind of group +of groups. My opinion is that it would be good that GNU delegates +this task to a small group of collaborating volunteers, shortly. +Perhaps in `gnu.announce´ a list of this national committee's +can be published.
- - - -
12.4.1 `POTFILES.in´ in `po/´

- +My role as coordinator would simply be to refer to Ulrich any German +speaking volunteer interested to localization of free software packages, and +maybe helping national groups to initially organize, while maintaining +national registries for until national groups are ready to take over. +In fact, the coordinator should ease volunteers to get in contact with +one another for creating national teams, which should then select +one coordinator per language, or country (regionalized language). +If well done, the coordination should be useful without being an +overwhelming task, the time to put delegations in place.
-
-The `po/´ directory should receive a file named -`POTFILES.in´. This file tells which files, among all program -sources, have marked strings needing translation. Here is an example -of such a file: -
-
```
-# List of source files containing translatable strings.
-# Copyright (C) 1995 Free Software Foundation, Inc.
-
-# Common library files
-lib/error.c
-lib/getopt.c
-lib/xmalloc.c
-
-# Package source files
-src/gettext.c
-src/msgfmt.c
-src/xgettext.c
-
```
+
12.4.2 National Teams

-Hash-marked comments and white lines are ignored. All other lines -list those source files containing strings marked for translation -(see section 3.3 How Marks Appear in Sources), in a notation relative to the top level -of your whole distribution, rather than the location of the -`POTFILES.in´ file itself. +I suggest we look for volunteer coordinators/editors for individual +languages. These people will scan contributions of translation files +for various programs, for their own languages, and will ensure high +and uniform standards of diction.

-When a C file is automatically generated by a tool, like flex or -bison, that doesn't introduce translatable strings by itself, -it is recommended to list in `po/POTFILES.in´ the real source file -(ending in `.l´ in the case of flex, or in `.y´ in the -case of bison), not the generated C file. +From my current experience with other people in these days, those who +provide localizations are very enthusiastic about the process, and are +more interested in the localization process than in the program they +localize, and want to do many programs, not just one. This seems +to confirm that having a coordinator/editor for each language is a +good idea.
- - -
12.4.2 `LINGUAS´ in `po/´

- +We need to choose someone who is good at writing clear and concise +prose in the language in question. That is hard--we can't check +it ourselves. So we need to ask a few people to judge each others' +writing and select the one who is best.

-The `po/´ directory should also receive a file named -`LINGUAS´. This file contains the list of available translations. -It is a whitespace separated list. Hash-marked comments and white lines -are ignored. Here is an example file: +I announce my prerelease to a few dozen people, and you would not +believe all the discussions it generated already. I shudder to think +what will happen when this will be launched, for true, officially, +world wide. Who am I to arbitrate between two Czekolsovak users +contradicting each other, for example?
- -
```
-# Set of available languages.
-de fr
-
```
-
-This example means that German and French PO files are available, so -that these languages are currently supported by your package. If you -want to further restrict, at installation time, the set of installed -languages, this should not be done by modifying the `LINGUAS´ file, -but rather by using the LINGUAS environment variable -(see section 9.2 Magic for Installers). +I assume that your German is not much better than my French so that +I would not be able to judge about these formulations. What I would +suggest is that for each language there is a group for people who +maintain the PO files and judge about changes. I suspect there will +be cultural differences between how such groups of people will behave. +Some will have relaxed ways, reach consensus easily, and have anyone +of the group relate to the maintainers, while others will fight to +death, organize heavy administrations up to national standards, and +use strict channels.

-It is recommended that you add the "languages" `en@quot´ and -`en@boldquot´ to the LINGUAS file. en@quot is a -variant of English message catalogs (en) which uses real quotation -marks instead of the ugly looking asymmetric ASCII substitutes ``´ -and `'´. en@boldquot is a variant of en@quot that -additionally outputs quoted pieces of text in a bold font, when used in -a terminal emulator which supports the VT100 escape sequences (such as -xterm or the Linux console, but not Emacs in M-x shell mode). +The German team is putting out a good example. Right now, they are +maybe half a dozen people revising translations of each other and +discussing the linguistic issues. I do not even have all the names. +Ulrich Drepper is taking care of coordinating the German team. +He subscribed to all my pretest lists, so I do not even have to warn +him specifically of incoming releases.

-These extra message catalogs `en@quot´ and `en@boldquot´ -are constructed automatically, not by translators; to support them, you -need the files `Rules-quot´, `quot.sed´, `boldquot.sed´, -`en@quot.header´, `en@boldquot.header´, `insert-header.sin´ -in the `po/´ directory. You can copy them from GNU gettext's `po/´ -directory; they are also installed by running gettextize. +I'm sure, that is a good idea to get teams for each language working +on translations. That will make the translations better and more +consistent.
-
12.4.3 `Makevars´ in `po/´
-
- -
-
-The `po/´ directory also has a file named `Makevars´. -It can be left unmodified if your package has a single message domain -and, accordingly, a single `po/´ directory. Only packages which -have multiple `po/´ directories at different locations need to -adjust the three variables defined in `Makevars´. +
12.4.2.1 Sub-Cultures
-

-`po/Makevars´ gets inserted into the `po/Makefile´ when the -latter is created. At the same time, all files called `Rules-*´ in the -`po/´ directory get appended to the `po/Makefile´. They present -an opportunity to add rules for special PO files to the Makefile, without -needing to mess with `po/Makefile.in.in´. +Taking French for example, there are a few sub-cultures around computers +which developed diverging vocabularies. Picking volunteers here and +there without addressing this problem in an organized way, soon in the +project, might produce a distasteful mix of internationalized programs, +and possibly trigger endless quarrels among those who really care.

- - -GNU gettext comes with a `Rules-quot´ file, containing rules for -building catalogs `en@quot.po´ and `en@boldquot.po´. The -effect of `en@quot.po´ is that people who set their LANGUAGE -environment variable to `en@quot´ will get messages with proper -looking symmetric Unicode quotation marks instead of abusing the ASCII -grave accent and the ASCII apostrophe for indicating quotations. To -enable this catalog, simply add en@quot to the `po/LINGUAS´ -file. The effect of `en@boldquot.po´ is that people who set -LANGUAGE to `en@boldquot´ will get not only proper quotation -marks, but also the quoted text will be shown in a bold font on terminals -and consoles. This catalog is useful only for command-line programs, not -GUI programs. To enable it, similarly add en@boldquot to the -`po/LINGUAS´ file. +Keeping some kind of unity in the way French localization of +internationalized programs is achieved is a difficult (and delicate) job. +Knowing the latin character of French people (:-), if we take this +the wrong way, we could end up nowhere, or spoil a lot of energies. +Maybe we should begin to address this problem seriously before +GNU gettext become officially published. And I suspect that this +means soon!
-
12.4.4 `configure.in´ at top level
+
12.4.2.2 Organizational Ideas

-`configure.in´ or `configure.ac´ - this is the source from which -autoconf generates the `configure´ script. +I expect the next big changes after the official release. Please note +that I use the German translation of the short GPL message. We need +to set a few good examples before the localization goes out for true +in the free software community. Here are a few points to discuss:
-
1. Declare the package and version. - - - -This is done by a set of lines like these: - - -
```
-PACKAGE=gettext
-VERSION=0.14.4
-AC_DEFINE_UNQUOTED(PACKAGE, "$PACKAGE")
-AC_DEFINE_UNQUOTED(VERSION, "$VERSION")
-AC_SUBST(PACKAGE)
-AC_SUBST(VERSION)
-
```
  - -or, if you are using GNU automake, by a line like this: - - -
```
-AM_INIT_AUTOMAKE(gettext, 0.14.4)
-
```
  - -Of course, you replace `gettext´ with the name of your package, -and `0.14.4´ by its version numbers, exactly as they -should appear in the packaged tar file name of your distribution -(`gettext-0.14.4.tar.gz´, here). - -
2. Check for internationalization support. - -Here is the main m4 macro for triggering internationalization -support. Just add this line to `configure.in´: - - -
```
-AM_GNU_GETTEXT
-
```
  - -This call is purposely simple, even if it generates a lot of configure -time checking and actions. - -If you have suppressed the `intl/´ subdirectory by calling -gettextize without `--intl´ option, this call should read - +
  - -
```
-AM_GNU_GETTEXT([external])
-
```
    +Each group should have one FTP server (at least one master). -
  - Have output files created. +
  - -The AC_OUTPUT directive, at the end of your `configure.in´ -file, needs to be modified in two ways: +The files on the server should reflect the latest version (of +course!) and it should also contain a RCS directory with the +corresponding archives (I don't have this now). +
  - -
```
-AC_OUTPUT([existing configuration files intl/Makefile po/Makefile.in],
-[existing additional actions])
-
```
    +There should also be a ChangeLog file (this is more useful than the +RCS archive but can be generated automatically from the later by +Emacs). -The modification to the first argument to AC_OUTPUT asks -for substitution in the `intl/´ and `po/´ directories. -Note the `.in´ suffix used for `po/´ only. This is because -the distributed file is really `po/Makefile.in.in´. +
  - -If you have suppressed the `intl/´ subdirectory by calling -gettextize without `--intl´ option, then you don't need to -add intl/Makefile to the AC_OUTPUT line. +A core group should judge about questionable changes (for now +this group consists solely by me but I ask some others occasionally; +this also seems to work). -
+

12.4.5 `config.guess´, `config.sub´ at top level

12.4.3 Mailing Lists

-If you haven't suppressed the `intl/´ subdirectory, -you need to add the GNU `config.guess´ and `config.sub´ files -to your distribution. They are needed because the `intl/´ directory -has platform dependent support for determining the locale's character -encoding and therefore needs to identify the platform. +If we get any inquiries about GNU gettext, send them on to:

-You can obtain the newest version of `config.guess´ and -`config.sub´ from the CVS of the `config´ project at -`http://savannah.gnu.org/´. The commands to fetch them are

-$ wget 'http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/config/config/config.guess'
-$ wget 'http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/config/config/config.sub'
+`translation@iro.umontreal.ca´

-Less recent versions are also contained in the GNU automake and -GNU libtool packages. +The `*-pretest´ lists are quite useful to me, maybe the idea could +be generalized to many GNU, and non-GNU packages. But each maintainer +his/her way!

-Normally, `config.guess´ and `config.sub´ are put at the -top level of a distribution. But it is also possible to put them in a -subdirectory, altogether with other configuration support files like -`install-sh´, `ltconfig´, `ltmain.sh´, -`mkinstalldirs´ or `missing´. All you need to do, other than -moving the files, is to add the following line to your -`configure.in´. +François, we have a mechanism in place here at +`gnu.ai.mit.edu´ to track teams, support mailing lists for +them and log members. We have a slight preference that you use it. +If this is OK with you, I can get you clued in.

- -

-AC_CONFIG_AUX_DIR([subdir])
-

- - - -

12.4.6 `mkinstalldirs´ at top level

- +Things are changing! A few years ago, when Daniel Fekete and I +asked for a mailing list for GNU localization, nested at the FSF, we +were politely invited to organize it anywhere else, and so did we. +For communicating with my pretesters, I later made a handful of +mailing lists located at iro.umontreal.ca and administrated by +majordomo. These lists have been very dependable +so far...

-If gettextize has not already done it, you need to add the GNU -`mkinstalldirs´ script to your distribution. It is needed because -`mkdir -p´ is not portable enough. You find this script in the -GNU automake distribution. +I suspect that the German team will organize itself a mailing list +located in Germany, and so forth for other countries. But before they +organize for true, it could surely be useful to offer mailing lists +located at the FSF to each national team. So yes, please explain me +how I should proceed to create and handle them.

-Normally, `mkinstalldirs´ is put at the top level of a distribution. -But it is also possible to put it in a subdirectory, altogether with other -configuration support files like `install-sh´, `ltconfig´, -`ltmain.sh´ or `missing´. All you need to do, other than -moving the files, is to add the following line to your `configure.in´. +We should create temporary mailing lists, one per country, to help +people organize. Temporary, because once regrouped and structured, it +would be fair the volunteers from country bring back their list +in there and manage it as they want. My feeling is that, in the long +run, each team should run its own list, from within their country. +There also should be some central list to which all teams could +subscribe as they see fit, as long as each team is represented in it.

-AC_CONFIG_AUX_DIR([subdir])
-

- - - -

12.4.7 `aclocal.m4´ at top level

- - -

-If you do not have an `aclocal.m4´ file in your distribution, -the simplest is to concatenate the files `codeset.m4´, -`gettext.m4´, `glibc2.m4´, `glibc21.m4´, `iconv.m4´, -`intdiv0.m4´, `intmax.m4´, `inttypes.m4´, `inttypes_h.m4´, -`inttypes-pri.m4´, `isc-posix.m4´, `lcmessage.m4´, -`lib-ld.m4´, `lib-link.m4´, `lib-prefix.m4´, -`longdouble.m4´, `longlong.m4´, `printf-posix.m4´, -`progtest.m4´, `signed.m4´, `size_max.m4´, -`stdint_h.m4´, `uintmax_t.m4´, `ulonglong.m4´, -`wchar_t.m4´, `wint_t.m4´, `xsize.m4´ -from GNU gettext's -`m4/´ directory into a single file. If you have suppressed the -`intl/´ directory, only `gettext.m4´, `iconv.m4´, -`lib-ld.m4´, `lib-link.m4´, `lib-prefix.m4´, -`progtest.m4´ need to be concatenated. -

-If you already have an `aclocal.m4´ file, then you will have -to merge the said macro files into your `aclocal.m4´. Note that if -you are upgrading from a previous release of GNU gettext, you -should most probably replace the macros (AM_GNU_GETTEXT, -etc.), as they usually -change a little from one release of GNU gettext to the next. -Their contents may vary as we get more experience with strange systems -out there. +

12.5 Information Flow

-If you are using GNU automake 1.5 or newer, it is enough to put -these macro files into a subdirectory named `m4/´ and add the line +There will surely be some discussion about this messages after the +packages are finally released. If people now send you some proposals +for better messages, how do you proceed? Jim, please note that +right now, as I put forward nearly a dozen of localizable programs, I +receive both the translations and the coordination concerns about them.

- -

-ACLOCAL_AMFLAGS = -I m4
-

-to your top level `Makefile.am´. +If I put one of my things to pretest, Ulrich receives the announcement +and passes it on to the German team, who make last minute revisions. +Then he submits the translation files to me as the maintainer. +For free packages I do not maintain, I would not even hear about it. +This scheme could be made to work for the whole Translation Project, +I think. For security reasons, maybe Ulrich (national coordinators, +in fact) should update central registry kept at the Translation Project +(Jim, me, or Len's recruits) once in a while.

-These macros check for the internationalization support functions -and related informations. Hopefully, once stabilized, these macros -might be integrated in the standard Autoconf set, because this -piece of m4 code will be the same for all projects using GNU -gettext. +In December/January, I was aggressively ready to internationalize +all of GNU, giving myself the duty of one small GNU package per week +or so, taking many weeks or months for bigger packages. But it does +not work this way. I first did all the things I'm responsible for. +I've nothing against some missionary work on other maintainers, but +I'm also loosing a lot of energy over it--same debates over again.

- - -

12.4.8 `acconfig.h´ at top level

- +And when the first localized packages are released we'll get a lot of +responses about ugly translations :-). Surely, and we need to have +beforehand a fairly good idea about how to handle the information +flow between the national teams and the package maintainers.

-Earlier GNU gettext releases required to put definitions for -ENABLE_NLS, HAVE_GETTEXT and HAVE_LC_MESSAGES, -HAVE_STPCPY, PACKAGE and VERSION into an -`acconfig.h´ file. This is not needed any more; you can remove -them from your `acconfig.h´ file unless your package uses them -independently from the `intl/´ directory. +Please start saving somewhere a quick history of each PO file. I know +for sure that the file format will change, allowing for comments. +It would be nice that each file has a kind of log, and references for +those who want to submit comments or gripes, or otherwise contribute. +I sent a proposal for a fast and flexible format, but it is not +receiving acceptance yet by the GNU deciders. I'll tell you when I +have more information about this.

12.4.9 `config.h.in´ at top level

- +

12.6 Prioritizing messages: How to determine which messages to translate first

-The include file template that holds the C macros to be defined by -configure is usually called `config.h.in´ and may be -maintained either manually or automatically. +A translator sometimes has only a limited amount of time per week to +spend on a package, and some packages have quite large message catalogs +(over 1000 messages). Therefore she wishes to translate the messages +first that are the most visible to the user, or that occur most frequently. +This section describes how to determine these "most urgent" messages. +It also applies to determine the "next most urgent" messages after the +message catalog has already been partially translated.

-If gettextize has created an `intl/´ directory, this file -must be called `config.h.in´ and must be at the top level. If, -however, you have suppressed the `intl/´ directory by calling -gettextize without `--intl´ option, then you can choose the -name of this file and its location freely. +In a first step, she uses the programs like a user would do. While she +does this, the GNU gettext library logs into a file the not yet +translated messages for which a translation was requested from the program.

-If it is maintained automatically, by use of the `autoheader´ -program, you need to do nothing about it. This is the case in particular -if you are using GNU automake. +In a second step, she uses the PO mode to translate precisely this set +of messages.

-If it is maintained manually, and if gettextize has created an -`intl/´ directory, you should switch to using `autoheader´. -The list of C macros to be added for the sake of the `intl/´ -directory is just too long to be maintained manually; it also changes -between different versions of GNU gettext. + +Here a more details. The GNU libintl library (but not the +corresponding functions in GNU libc) supports an environment variable +GETTEXT_LOG_UNTRANSLATED. The GNU libintl library will +log into this file the messages for which gettext() and related +functions couldn't find the translation. If the file doesn't exist, it +will be created as needed. On systems with GNU libc a shared library +`preloadable_libintl.so´ is provided that can be used with the ELF +`LD_PRELOAD´ mechanism.

-If it is maintained manually, and if on the other hand you have -suppressed the `intl/´ directory by calling gettextize -without `--intl´ option, then you can get away by adding the -following lines to `config.h.in´: +So, in the first step, the translator uses these commands on systems with +GNU libc:

-/* Define to 1 if translation of program messages to the user's
-   native language is requested. */
-#undef ENABLE_NLS
+$ LD_PRELOAD=/usr/local/lib/preloadable_libintl.so
+$ export LD_PRELOAD
+$ GETTEXT_LOG_UNTRANSLATED=$HOME/gettextlogused
+$ export GETTEXT_LOG_UNTRANSLATED

- - -

12.4.10 `Makefile.in´ at top level

-Here are a few modifications you need to make to your main, top-level -`Makefile.in´ file. +and these commands on other systems:

- -Add the following lines near the beginning of your `Makefile.in´, -so the `dist:´ goal will work properly (as explained further down): - - -
```
-PACKAGE = @PACKAGE@
-VERSION = @VERSION@
-
```
- -
- -Add file `ABOUT-NLS´ to the DISTFILES definition, so the file gets -distributed. - -
- -Wherever you process subdirectories in your `Makefile.in´, be sure -you also process the subdirectories `intl´ and `po´. Special -rules in the `Makefiles´ take care for the case where no -internationalization is wanted. - -If you are using Makefiles, either generated by automake, or hand-written -so they carefully follow the GNU coding standards, the effected goals for -which the new subdirectories must be handled include `installdirs´, -`install´, `uninstall´, `clean´, `distclean´. - -Here is an example of a canonical order of processing. In this -example, we also define SUBDIRS in Makefile.in for it -to be further used in the `dist:´ goal. - -
```
-SUBDIRS = doc intl lib src po
+$ GETTEXT_LOG_UNTRANSLATED=$HOME/gettextlogused
+$ export GETTEXT_LOG_UNTRANSLATED
 
```
-Note that you must arrange for `make´ to descend into the -intl directory before descending into other directories containing -code which make use of the libintl.h header file. For this -reason, here we mention intl before lib and src. - -

- -A delicate point is the `dist:´ goal, as both -`intl/Makefile´ and `po/Makefile´ will later assume that the -proper directory has been set up from the main `Makefile´. Here is -an example at what the `dist:´ goal might look like: - - -

-distdir = $(PACKAGE)-$(VERSION)
-dist: Makefile
-	rm -fr $(distdir)
-	mkdir $(distdir)
-	chmod 777 $(distdir)
-	for file in $(DISTFILES); do \
-	  ln $$file $(distdir) 2>/dev/null || cp -p $$file $(distdir); \
-	done
-	for subdir in $(SUBDIRS); do \
-	  mkdir $(distdir)/$$subdir || exit 1; \
-	  chmod 777 $(distdir)/$$subdir; \
-	  (cd $$subdir && $(MAKE) $@) || exit 1; \
-	done
-	tar chozf $(distdir).tar.gz $(distdir)
-	rm -fr $(distdir)
-

- -

-Note that if you are using GNU automake, `Makefile.in´ is -automatically generated from `Makefile.am´, and all needed changes -to `Makefile.am´ are already made by running `gettextize´. - -

- - -

12.4.11 `Makefile.in´ in `src/´

-Some of the modifications made in the main `Makefile.in´ will -also be needed in the `Makefile.in´ from your package sources, -which we assume here to be in the `src/´ subdirectory. Here are -all the modifications needed in `src/Makefile.in´: +Then she uses and peruses the programs. (It is a good and recommended +practice to use the programs for which you provide translations: it +gives you the needed context.) When done, she removes the environment +variables:

- -In view of the `dist:´ goal, you should have these lines near the -beginning of `src/Makefile.in´: - - -
```
-PACKAGE = @PACKAGE@
-VERSION = @VERSION@
-
```
- -
- -If not done already, you should guarantee that top_srcdir -gets defined. This will serve for cpp include files. Just add -the line: - - -
```
-top_srcdir = @top_srcdir@
-
```
- -
- -You might also want to define subdir as `src´, later -allowing for almost uniform `dist:´ goals in all your -`Makefile.in´. At list, the `dist:´ goal below assume that -you used: - - -
```
-subdir = src
-
```
- -
- -The main function of your program will normally call -bindtextdomain (see see section 3.1 Triggering gettext Operations), like this: - -
```
-bindtextdomain (PACKAGE, LOCALEDIR);
-textdomain (PACKAGE);
+$ unset LD_PRELOAD
+$ unset GETTEXT_LOG_UNTRANSLATED
 
```
-To make LOCALEDIR known to the program, add the following lines to -`Makefile.in´: - - -
```
-datadir = @datadir@
-localedir = $(datadir)/locale
-DEFS = -DLOCALEDIR=\"$(localedir)\" @DEFS@
-
```
- -Note that @datadir@ defaults to `$(prefix)/share´, thus -$(localedir) defaults to `$(prefix)/share/locale´. - -
- -You should ensure that the final linking will use @LIBINTL@ or -@LTLIBINTL@ as a library. @LIBINTL@ is for use without -libtool, @LTLIBINTL@ is for use with libtool. An -easy way to achieve this is to manage that it gets into LIBS, like -this: - - -
```
-LIBS = @LIBINTL@ @LIBS@
-
```
- -In most packages internationalized with GNU gettext, one will -find a directory `lib/´ in which a library containing some helper -functions will be build. (You need at least the few functions which the -GNU gettext Library itself needs.) However some of the functions -in the `lib/´ also give messages to the user which of course should be -translated, too. Taking care of this, the support library (say -`libsupport.a´) should be placed before @LIBINTL@ and -@LIBS@ in the above example. So one has to write this: - - -
```
-LIBS = ../lib/libsupport.a @LIBINTL@ @LIBS@
-
```
- -
- -You should also ensure that directory `intl/´ will be searched for -C preprocessor include files in all circumstances. So, you have to -manage so both `-I../intl´ and `-I$(top_srcdir)/intl´ will -be given to the C compiler. - -

- -Your `dist:´ goal has to conform with others. Here is a -reasonable definition for it: - - -

-distdir = ../$(PACKAGE)-$(VERSION)/$(subdir)
-dist: Makefile $(DISTFILES)
-	for file in $(DISTFILES); do \
-	  ln $$file $(distdir) 2>/dev/null || cp -p $$file $(distdir) || exit 1; \
-	done
-

- -

-Note that if you are using GNU automake, `Makefile.in´ is -automatically generated from `Makefile.am´, and the first three -changes and the last change are not necessary. The remaining needed -`Makefile.am´ modifications are the following: +The second step starts with removing duplicates:

- -To make LOCALEDIR known to the program, add the following to -`Makefile.am´: - -
```
-<module>_CPPFLAGS = -DLOCALEDIR=\"$(localedir)\"
+$ msguniq $HOME/gettextlogused > missing.po
 
```
-for each specific module or compilation unit, or - - -
```
-AM_CPPFLAGS = -DLOCALEDIR=\"$(localedir)\"
-
```
- -for all modules and compilation units together. Furthermore, add this -line to define `localedir´: - - -
```
-localedir = $(datadir)/locale
-
```
- -
- -To ensure that the final linking will use @LIBINTL@ or -@LTLIBINTL@ as a library, add the following to -`Makefile.am´: - - -
```
-<program>_LDADD = @LIBINTL@
-
```
- -for each specific program, or - - -
```
-LDADD = @LIBINTL@
-
```
- -for all programs together. Remember that when you use libtool -to link a program, you need to use @LTLIBINTL@ instead of @LIBINTL@ -for that program. - -
- -If you have an `intl/´ directory, whose contents is created by -gettextize, then to ensure that it will be searched for -C preprocessor include files in all circumstances, add something like -this to `Makefile.am´: - - -
```
-AM_CPPFLAGS = -I../intl -I$(top_srcdir)/intl
-
```
- -

- - - -

12.4.12 `gettext.h´ in `lib/´

- - - - -

-Internationalization of packages, as provided by GNU gettext, is -optional. It can be turned off in two situations: - -

- -

- -When the installer has specified `./configure --disable-nls´. This -can be useful when small binaries are more important than features, for -example when building utilities for boot diskettes. It can also be useful -in order to get some specific C compiler warnings about code quality with -some older versions of GCC (older than 3.0). - -
- -When the package does not include the intl/ subdirectory, and the -libintl.h header (with its associated libintl library, if any) is not -already installed on the system, it is preferrable that the package builds -without internationalization support, rather than to give a compilation -error. -

- -

-A C preprocessor macro can be used to detect these two cases. Usually, -when libintl.h was found and not explicitly disabled, the -ENABLE_NLS macro will be defined to 1 in the autoconf generated -configuration file (usually called `config.h´). In the two negative -situations, however, this macro will not be defined, thus it will evaluate -to 0 in C preprocessor expressions. - -

- -`gettext.h´ is a convenience header file for conditional use of -`<libintl.h>´, depending on the ENABLE_NLS macro. If -ENABLE_NLS is set, it includes `<libintl.h>´; otherwise it -defines no-op substitutes for the libintl.h functions. We recommend -the use of "gettext.h" over direct use of `<libintl.h>´, -so that portability to older systems is guaranteed and installers can -turn off internationalization if they want to. In the C code, you will -then write +The result is a PO file, but needs some preprocessing before the Emacs PO +mode can be used with it. First, it is a multi-domain PO file, containing +messages from many translation domains. Second, it lacks all translator +comments and source references. Here is how to get a list of the affected +translation domains:

-#include "gettext.h"
+$ sed -n -e 's,^domain "\(.*\)"$,\1,p' < missing.po | sort | uniq

-instead of +Then the translator can handle the domains one by one. For simplicity, +let's use environment variables to denote the language, domain and source +package.

-#include <libintl.h>
+$ lang=nl             # your language
+$ domain=coreutils    # the name of the domain to be handled
+$ package=/usr/src/gnu/coreutils-4.5.4   # the package where it comes from

-The location of gettext.h is usually in a directory containing -auxiliary include files. In many GNU packages, there is a directory -`lib/´ containing helper functions; `gettext.h´ fits there. -In other packages, it can go into the `src´ directory. - -

-Do not install the gettext.h file in public locations. Every -package that needs it should contain a copy of it on its own. - -

- - -

12.5 Autoconf macros for use in `configure.in´

- - -

-GNU gettext installs macros for use in a package's -`configure.in´ or `configure.ac´. -See section `Introduction' in The Autoconf Manual. -The primary macro is, of course, AM_GNU_GETTEXT. - -

- - - -

12.5.1 AM_GNU_GETTEXT in `gettext.m4´

- -

- -The AM_GNU_GETTEXT macro tests for the presence of the GNU gettext -function family in either the C library or a separate libintl -library (shared or static libraries are both supported) or in the package's -`intl/´ directory. It also invokes AM_PO_SUBDIRS, thus preparing -the `po/´ directories of the package for building. - -

-AM_GNU_GETTEXT accepts up to three optional arguments. The general -syntax is - -

- -

-AM_GNU_GETTEXT([intlsymbol], [needsymbol], [intldir])
-

- -

-intlsymbol can be `external´ or `no-libtool´. The default -(if it is not specified or empty) is `no-libtool´. intlsymbol -should be `external´ for packages with no `intl/´ directory, -and `no-libtool´ for packages with an `intl/´ directory. In -the latter case, a static library $(top_builddir)/intl/libintl.a -will be created. - -

-If needsymbol is specified and is `need-ngettext´, then GNU -gettext implementations (in libc or libintl) without the ngettext() -function will be ignored. If needsymbol is specified and is -`need-formatstring-macros´, then GNU gettext implementations that don't -support the ISO C 99 `<inttypes.h>´ formatstring macros will be ignored. -Only one needsymbol can be specified. To specify more than one -requirement, just specify the strongest one among them. The hierarchy among -the various alternatives is as follows: `need-formatstring-macros´ -implies `need-ngettext´. - -

-intldir is used to find the intl libraries. If empty, the value -`$(top_builddir)/intl/´ is used. - -

-The AM_GNU_GETTEXT macro determines whether GNU gettext is -available and should be used. If so, it sets the USE_NLS variable -to `yes´; it defines ENABLE_NLS to 1 in the autoconf -generated configuration file (usually called `config.h´); it sets -the variables LIBINTL and LTLIBINTL to the linker options -for use in a Makefile (LIBINTL for use without libtool, -LTLIBINTL for use with libtool); it adds an `-I´ option to -CPPFLAGS if necessary. In the negative case, it sets -USE_NLS to `no´; it sets LIBINTL and LTLIBINTL -to empty and doesn't change CPPFLAGS. - -

-The complexities that AM_GNU_GETTEXT deals with are the following: - -

- -

- - -Some operating systems have gettext in the C library, for example -glibc. Some have it in a separate library libintl. GNU libintl -might have been installed as part of the GNU gettext package. - -
- -GNU libintl, if installed, is not necessarily already in the search -path (CPPFLAGS for the include file search path, LDFLAGS for -the library search path). - -
- -Except for glibc, the operating system's native gettext cannot -exploit the GNU mo files, doesn't have the necessary locale dependency -features, and cannot convert messages from the catalog's text encoding -to the user's locale encoding. - -
- -GNU libintl, if installed, is not necessarily already in the -run time library search path. To avoid the need for setting an environment -variable like LD_LIBRARY_PATH, the macro adds the appropriate -run time search path options to the LIBINTL and LTLIBINTL -variables. This works on most systems, but not on some operating systems -with limited shared library support, like SCO. - -
- -GNU libintl relies on POSIX/XSI iconv. The macro checks for -linker options needed to use iconv and appends them to the LIBINTL -and LTLIBINTL variables. -

- - - -

12.5.2 AM_GNU_GETTEXT_VERSION in `gettext.m4´

- -

- -The AM_GNU_GETTEXT_VERSION macro declares the version number of -the GNU gettext infrastructure that is used by the package. - -

-The use of this macro is optional; only the autopoint program makes -use of it (see section 12.6 Integrating with CVS). - -

- - -

12.5.3 AM_PO_SUBDIRS in `po.m4´

- -

- -The AM_PO_SUBDIRS macro prepares the `po/´ directories of the -package for building. This macro should be used in internationalized -programs written in other programming languages than C, C++, Objective C, -for example sh, Python, Lisp. See section 13 Other Programming Languages for a list of programming languages that support localization -through PO files. - -

-The AM_PO_SUBDIRS macro determines whether internationalization -should be used. If so, it sets the USE_NLS variable to `yes´, -otherwise to `no´. It also determines the right values for Makefile -variables in each `po/´ directory. - -

- - -

12.5.4 AM_ICONV in `iconv.m4´

- -

- -The AM_ICONV macro tests for the presence of the POSIX/XSI -iconv function family in either the C library or a separate -libiconv library. If found, it sets the am_cv_func_iconv -variable to `yes´; it defines HAVE_ICONV to 1 in the autoconf -generated configuration file (usually called `config.h´); it defines -ICONV_CONST to `const´ or to empty, depending on whether the -second argument of iconv() is of type `const char **´ or -`char **´; it sets the variables LIBICONV and -LTLIBICONV to the linker options for use in a Makefile -(LIBICONV for use without libtool, LTLIBICONV for use with -libtool); it adds an `-I´ option to CPPFLAGS if -necessary. If not found, it sets LIBICONV and LTLIBICONV to -empty and doesn't change CPPFLAGS. - -

-The complexities that AM_ICONV deals with are the following: - -

- -

- - -Some operating systems have iconv in the C library, for example -glibc. Some have it in a separate library libiconv, for example -OSF/1 or FreeBSD. Regardless of the operating system, GNU libiconv -might have been installed. In that case, it should be used instead of the -operating system's native iconv. - -
- -GNU libiconv, if installed, is not necessarily already in the search -path (CPPFLAGS for the include file search path, LDFLAGS for -the library search path). - -
- -GNU libiconv is binary incompatible with some operating system's -native iconv, for example on FreeBSD. Use of an `iconv.h´ -and `libiconv.so´ that don't fit together would produce program -crashes. - -
- -GNU libiconv, if installed, is not necessarily already in the -run time library search path. To avoid the need for setting an environment -variable like LD_LIBRARY_PATH, the macro adds the appropriate -run time search path options to the LIBICONV variable. This works -on most systems, but not on some operating systems with limited shared -library support, like SCO. -

- -

-`iconv.m4´ is distributed with the GNU gettext package because -`gettext.m4´ relies on it. - -

- - -

12.6 Integrating with CVS

- -

-Many projects use CVS for distributed development, version control and -source backup. This section gives some advice how to manage the uses -of cvs, gettextize, autopoint and autoconf. - -

- - - -

12.6.1 Avoiding version mismatch in distributed development

- -

-In a project development with multiple developers, using CVS, there -should be a single developer who occasionally - when there is desire to -upgrade to a new gettext version - runs gettextize and -performs the changes listed in section 12.4 Files You Must Create or Alter, and then commits -his changes to the CVS. - -

-It is highly recommended that all developers on a project use the same -version of GNU gettext in the package. In other words, if a -developer runs gettextize, he should go the whole way, make the -necessary remaining changes and commit his changes to the CVS. -Otherwise the following damages will likely occur: - -

- -

- -Apparent version mismatch between developers. Since some gettext -specific portions in `configure.in´, `configure.ac´ and -Makefile.am, Makefile.in files depend on the gettext -version, the use of infrastructure files belonging to different -gettext versions can easily lead to build errors. - -
- -Hidden version mismatch. Such version mismatch can also lead to -malfunctioning of the package, that may be undiscovered by the developers. -The worst case of hidden version mismatch is that internationalization -of the package doesn't work at all. - -
- -Release risks. All developers implicitly perform constant testing on -a package. This is important in the days and weeks before a release. -If the guy who makes the release tar files uses a different version -of GNU gettext than the other developers, the distribution will -be less well tested than if all had been using the same gettext -version. For example, it is possible that a platform specific bug goes -undiscovered due to this constellation. -

- - - -

12.6.2 Files to put under CVS version control

- -

-There are basically three ways to deal with generated files in the -context of a CVS repository, such as `configure´ generated from -`configure.in´, parser.c generated from -parser.y, or po/Makefile.in.in autoinstalled by -gettextize or autopoint. - -

- -

- -All generated files are always committed into the repository. - -
- -All generated files are committed into the repository occasionally, -for example each time a release is made. - -
- -Generated files are never committed into the repository. -

- -

-Each of these three approaches has different advantages and drawbacks. - -

- -

- -The advantage is that anyone can check out the CVS at any moment and -gets a working build. The drawbacks are: 1a. It requires some frequent -"cvs commit" actions by the maintainers. 1b. The repository grows in size -quite fast. - -
- -The advantage is that anyone can check out the CVS, and the usual -"./configure; make" will work. The drawbacks are: 2a. The one who -checks out the repository needs tools like GNU automake, -GNU autoconf, GNU m4 installed in his PATH; sometimes -he even needs particular versions of them. 2b. When a release is made -and a commit is made on the generated files, the other developers get -conflicts on the generated files after doing "cvs update". Although -these conflicts are easy to resolve, they are annoying. - -
- -The advantage is less work for the maintainers. The drawback is that -anyone who checks out the CVS not only needs tools like GNU automake, -GNU autoconf, GNU m4 installed in his PATH, but also that -he needs to perform a package specific pre-build step before being able -to "./configure; make". -

- -

-For the first and second approach, all files modified or brought in -by the occasional gettextize invocation and update should be -committed into the CVS. - -

-For the third approach, the maintainer can omit from the CVS repository -all the files that gettextize mentions as "copy". Instead, he -adds to the `configure.in´ or `configure.ac´ a line of the -form +She takes the latest copy of `$lang.po´ from the Translation Project, +or from the package (in most cases, `$package/po/$lang.po´), or +creates a fresh one if she's the first translator (see section 6 Creating a New PO File). +She then uses the following commands to mark the not urgent messages as +"obsolete". (This doesn't mean that these messages - translated and +untranslated ones - will go away. It simply means that Emacs PO mode +will ignore them in the following editing session.)

-AM_GNU_GETTEXT_VERSION(0.14.4)
+$ msggrep --domain=$domain missing.po | grep -v '^domain' \
+  > $domain-missing.po
+$ msgattrib --set-obsolete --ignore-file $domain-missing.po $domain.$lang.po \
+  > $domain.$lang-urgent.po

-and adds to the package's pre-build script an invocation of -`autopoint´. For everyone who checks out the CVS, this -autopoint invocation will copy into the right place the -gettext infrastructure files that have been omitted from the CVS. +The she translates `$domain.$lang-urgent.po´ by use of Emacs PO mode. +(FIXME: I don't know whether KBabel and gtranslator also +preserve obsolete messages, as they should.) +Finally she restores the not urgent messages (with their earlier +translations, for those which were already translated) through this command:

-The version number used as argument to AM_GNU_GETTEXT_VERSION is -the version of the gettext infrastructure that the package wants -to use. It is also the minimum version number of the `autopoint´ -program. So, if you write AM_GNU_GETTEXT_VERSION(0.11.5) then the -developers can have any version >= 0.11.5 installed; the package will work -with the 0.11.5 infrastructure in all developers' builds. When the -maintainer then runs gettextize from, say, version 0.12.1 on the package, -the occurrence of AM_GNU_GETTEXT_VERSION(0.11.5) will be changed -into AM_GNU_GETTEXT_VERSION(0.12.1), and all other developers that -use the CVS will henceforth need to have GNU gettext 0.12.1 or newer -installed. - -

- - -

12.6.3 Invoking the `autopoint` Program

- -

-autopoint [option]...
+$ msgmerge --no-fuzzy-matching $domain.$lang-urgent.po $package/po/$domain.pot \
+  > $domain.$lang.po

-The autopoint program copies standard gettext infrastructure files -into a source package. It extracts from a macro call of the form -AM_GNU_GETTEXT_VERSION(version), found in the package's -`configure.in´ or `configure.ac´ file, the gettext version -used by the package, and copies the infrastructure files belonging to -this version into the package. +Then she can submit `$domain.$lang.po´ and proceed to the next domain.

- - -

12.6.3.1 Options

- -

`-f´ -: -
`--force´ -: - - -Force overwriting of files that already exist. - -
`-n´ -: -
`--dry-run´ -: - - -Print modifications but don't perform them. All file copying actions that -autopoint would normally execute are inhibited and instead only -listed on standard output. - -

- - - -

12.6.3.2 Informative output

- -

`--help´ -: - -Display this help and exit. - -
`--version´ -: - -Output version information and exit. - -

- -

-autopoint supports the GNU gettext versions from 0.10.35 to -the current one, 0.14.4. In order to apply autopoint to -a package using a gettext version newer than 0.14.4, you -need to install this same version of GNU gettext at least. - -

-In packages using GNU automake, an invocation of autopoint -should be followed by invocations of aclocal and then autoconf -and autoheader. The reason is that autopoint installs some -autoconf macro files, which are used by aclocal to create -`aclocal.m4´, and the latter is used by autoconf to create the -package's `configure´ script and by autoheader to create the -package's `config.h.in´ include file template. - -

-The name `autopoint´ is an abbreviation of `auto-po-intl-m4´; -the tool copies or updates mostly files in the `po´, `intl´, -`m4´ directories. - -

- - -

12.7 Creating a Distribution Tarball

- -

- - -In projects that use GNU automake, the usual commands for creating -a distribution tarball, `make dist´ or `make distcheck´, -automatically update the PO files as needed. - -

-If GNU automake is not used, the maintainer needs to perform this -update before making a release: - -

- -

-$ ./configure
-$ (cd po; make update-po)
-$ make distclean
-

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_13.html b/gettext-tools/doc/gettext_13.html index 92a79cf55..6a27953f7 100644 --- a/gettext-tools/doc/gettext_13.html +++ b/gettext-tools/doc/gettext_13.html @@ -1,3798 +1,1710 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - 13 Other Programming Languages +GNU gettext utilities - 13 The Maintainer's View -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

13 Other Programming Languages

13 The Maintainer's View

+ + +

+The maintainer of a package has many responsibilities. One of them +is ensuring that the package will install easily on many platforms, +and that the magic we described earlier (see section 2 The User's View) will work +for installers and end users. + +

+Of course, there are many possible ways by which GNU gettext +might be integrated in a distribution, and this chapter does not cover +them in all generality. Instead, it details one possible approach which +is especially adequate for many free software distributions following GNU +standards, or even better, Gnits standards, because GNU gettext +is purposely for helping the internationalization of the whole GNU +project, and as many other good free packages as possible. So, the +maintainer's view presented here presumes that the package already has +a `configure.in´ file and uses GNU Autoconf. + +

+Nevertheless, GNU gettext may surely be useful for free packages +not following GNU standards and conventions, but the maintainers of such +packages might have to show imagination and initiative in organizing +their distributions so gettext work for them in all situations. +There are surely many, out there. +

-While the presentation of gettext focuses mostly on C and -implicitly applies to C++ as well, its scope is far broader than that: -Many programming languages, scripting languages and other textual data -like GUI resources or package descriptions can make use of the gettext -approach. +Even if gettext methods are now stabilizing, slight adjustments +might be needed between successive gettext versions, so you +should ideally revise this chapter in subsequent releases, looking +for changes.

13.1 The Language Implementor's View

13.1 Flat or Non-Flat Directory Structures

- - +Some free software packages are distributed as tar files which unpack +in a single directory, these are said to be flat distributions. +Other free software packages have a one level hierarchy of subdirectories, using +for example a subdirectory named `doc/´ for the Texinfo manual and +man pages, another called `lib/´ for holding functions meant to +replace or complement C libraries, and a subdirectory `src/´ for +holding the proper sources for the package. These other distributions +are said to be non-flat.

-All programming and scripting languages that have the notion of strings -are eligible to supporting gettext. Supporting gettext -means the following: +We cannot say much about flat distributions. A flat +directory structure has the disadvantage of increasing the difficulty +of updating to a new version of GNU gettext. Also, if you have +many PO files, this could somewhat pollute your single directory. +Also, GNU gettext's libintl sources consist of C sources, shell +scripts, sed scripts and complicated Makefile rules, which don't +fit well into an existing flat structure. For these reasons, we +recommend to use non-flat approach in this case as well.

+Maybe because GNU gettext itself has a non-flat structure, +we have more experience with this approach, and this is what will be +described in the remaining of this chapter. Some maintainers might +use this as an opportunity to unflatten their package structure. -

+
-You should add to the language a syntax for translatable strings. In -principle, a function call of gettext would do, but a shorthand -syntax helps keeping the legibility of internationalized programs. For -example, in C we use the syntax _("string"), and in GNU awk we use -the shorthand _"string". -
+
13.2 Prerequisite Works
+
+ + + + +
+
+There are some works which are required for using GNU gettext +in one of your package. These works have some kind of generality +that escape the point by point descriptions used in the remainder +of this chapter. So, we describe them here. -You should arrange that evaluation of such a translatable string at -runtime calls the gettext function, or performs equivalent -processing. +
+
- -Similarly, you should make the functions ngettext, -dcgettext, dcngettext available from within the language. -These functions are less often used, but are nevertheless necessary for -particular purposes: ngettext for correct plural handling, and -dcgettext and dcngettext for obeying other locale -environment variables than LC_MESSAGES, such as LC_TIME or -LC_MONETARY. For these latter functions, you need to make the -LC_* constants, available in the C header <locale.h>, -referenceable from within the language, usually either as enumeration -values or as strings. +Before attempting to use gettextize you should install some +other packages first. +Ensure that recent versions of GNU m4, GNU Autoconf and GNU +gettext are already installed at your site, and if not, proceed +to do this first. If you get to install these things, beware that +GNU m4 must be fully installed before GNU Autoconf is even +configured. + +To further ease the task of a package maintainer the automake +package was designed and implemented. GNU gettext now uses this +tool and the `Makefile´s in the `intl/´ and `po/´ +therefore know about all the goals necessary for using automake +and `libintl´ in one project. + +Those four packages are only needed by you, as a maintainer; the +installers of your own package and end users do not really need any of +GNU m4, GNU Autoconf, GNU gettext, or GNU automake +for successfully installing and running your package, with messages +properly translated. But this is not completely true if you provide +internationalized shell scripts within your own package: GNU +gettext shall then be installed at the user site if the end users +want to see the translation of shell script messages.
- -You should allow the programmer to designate a message domain, either by -making the textdomain function available from within the -language, or by introducing a magic variable called TEXTDOMAIN. -Similarly, you should allow the programmer to designate where to search -for message catalogs, by providing access to the bindtextdomain -function. +Your package should use Autoconf and have a `configure.in´ or +`configure.ac´ file. +If it does not, you have to learn how. The Autoconf documentation +is quite well written, it is a good idea that you print it and get +familiar with it.
- -You should either perform a setlocale (LC_ALL, "") call during -the startup of your language runtime, or allow the programmer to do so. -Remember that gettext will act as a no-op if the LC_MESSAGES and -LC_CTYPE locale facets are not both set. +Your C sources should have already been modified according to +instructions given earlier in this manual. See section 4 Preparing Program Sources.
- -A programmer should have a way to extract translatable strings from a -program into a PO file. The GNU xgettext program is being -extended to support very different programming languages. Please -contact the GNU gettext maintainers to help them doing this. If -the string extractor is best integrated into your language's parser, GNU -xgettext can function as a front end to your string extractor. +Your `po/´ directory should receive all PO files submitted to you +by the translator teams, each having `ll.po´ as a name. +This is not usually easy to get translation +work done before your package gets internationalized and available! +Since the cycle has to start somewhere, the easiest for the maintainer +is to start with absolutely no PO files, and wait until various +translator teams get interested in your package, and submit PO files. -
- +
-The language's library should have a string formatting facility where -the arguments of a format string are denoted by a positional number or a -name. This is needed because for some languages and some messages with -more than one substitutable argument, the translation will need to -output the substituted arguments in different order. See section 3.5 Special Comments preceding Keywords. +
+It is worth adding here a few words about how the maintainer should +ideally behave with PO files submissions. As a maintainer, your role is +to authenticate the origin of the submission as being the representative +of the appropriate translating teams of the Translation Project (forward +the submission to `translation@iro.umontreal.ca´ in case of doubt), +to ensure that the PO file format is not severely broken and does not +prevent successful installation, and for the rest, to merely put these +PO files in `po/´ for distribution. -
+
+
+As a maintainer, you do not have to take on your shoulders the +responsibility of checking if the translations are adequate or +complete, and should avoid diving into linguistic matters. Translation +teams drive themselves and are fully responsible of their linguistic +choices for the Translation Project. Keep in mind that translator teams are not +driven by maintainers. You can help by carefully redirecting all +communications and reports from users about linguistic matters to the +appropriate translation team, or explain users how to reach or join +their team. The simplest might be to send them the `ABOUT-NLS´ file. + +
+
+Maintainers should never ever apply PO file bug reports +themselves, short-cutting translation teams. If some translator has +difficulty to get some of her points through her team, it should not be +an option for her to directly negotiate translations with maintainers. +Teams ought to settle their problems themselves, if any. If you, as +a maintainer, ever think there is a real problem with a team, please +never try to solve a team's problem on your own. -If the language has more than one implementation, and not all of the -implementations use gettext, but the programs should be portable -across implementations, you should provide a no-i18n emulation, that -makes the other implementations accept programs written for yours, -without actually translating the strings. +
-
-To help the programmer in the task of marking translatable strings, -which is usually performed using the Emacs PO mode, you are welcome to -contact the GNU gettext maintainers, so they can add support for -your language to `po-mode.el´. -

13.3 Invoking the `gettextize` Program

-On the implementation side, three approaches are possible, with -different effects on portability and copyright: +The gettextize program is an interactive tool that helps the +maintainer of a package internationalized through GNU gettext. +It is used for two purposes:

-You may integrate the GNU gettext's `intl/´ directory in -your package, as described in section 12 The Maintainer's View. This allows you to -have internationalization on all kinds of platforms. Note that when you -then distribute your package, it legally falls under the GNU General -Public License, and the GNU project will be glad about your contribution -to the Free Software pool. +As a wizard, when a package is modified to use GNU gettext for +the first time.
-You may link against GNU gettext functions if they are found in -the C library. For example, an autoconf test for gettext() and -ngettext() will detect this situation. For the moment, this test -will succeed on GNU systems and not on other platforms. No severe -copyright restrictions apply. - -
- -You may emulate or reimplement the GNU gettext functionality. -This has the advantage of full portability and no copyright -restrictions, but also the drawback that you have to reimplement the GNU -gettext features (such as the LANGUAGE environment -variable, the locale aliases database, the automatic charset conversion, -and plural handling). +As a migration tool, for upgrading the GNU gettext support in +a package from a previous to a newer version of GNU gettext.

- - -

13.2 The Programmer's View

-For the programmer, the general procedure is the same as for the C -language. The Emacs PO mode supports other languages, and the GNU -xgettext string extractor recognizes other languages based on the -file extension or a command-line option. In some languages, -setlocale is not needed because it is already performed by the -underlying language runtime. +This program performs the following tasks:

-
13.3 The Translator's View
+It copies into the package some files that are consistently and +identically needed in every package internationalized through +GNU gettext. -
-The translator works exactly as in the C language case. The only -difference is that when translating format strings, she has to be aware -of the language's particular syntax for positional arguments in format -strings. +
It performs as many of the tasks mentioned in the next section -
+section 13.4 Files You Must Create or Alter as can be performed automatically. +
It removes obsolete files and idioms used for previous GNU +gettext versions to the form recommended for the current GNU +gettext version. -
13.3.1 C Format Strings
+
It prints a summary of the tasks that ought to be done manually -
-C format strings are described in POSIX (IEEE P1003.1 2001), section -XSH 3 fprintf(), -http://www.opengroup.org/onlinepubs/007904975/functions/fprintf.html. -See also the fprintf(3) manual page, -http://www.linuxvalley.it/encyclopedia/ldp/manpage/man3/printf.3.php, -http://informatik.fh-wuerzburg.de/student/i510/man/printf.html. +and could not be done automatically by gettextize. +

-Although format strings with positions that reorder arguments, such as +It can be invoked as follows:

- -

-"Only %2$d bytes free on '%1$s'."
-

-which is semantically equivalent to - -

+ +

-"'%s' has only %d bytes free."
+gettextize [ option... ] [ directory ]

-are a POSIX/XSI feature and not specified by ISO C 99, translators can rely -on this reordering ability: On the few platforms where printf(), -fprintf() etc. don't support this feature natively, `libintl.a´ -or `libintl.so´ provides replacement functions, and GNU <libintl.h> -activates these replacement functions automatically. +and accepts the following options:

- - -As a special feature for Farsi (Persian) and maybe Arabic, translators can -insert an `I´ flag into numeric format directives. For example, the -translation of "%d" can be "%Id". The effect of this flag, -on systems with GNU libc, is that in the output, the ASCII digits are -replaced with the `outdigits´ defined in the LC_CTYPE locale -facet. On other systems, the gettext function removes this flag, -so that it has no effect. +

`-c´ +: +
`--copy´ +: + + +Copy the needed files instead of making symbolic links. Using links +would allow the package to always use the latest gettext code +available on the system, but it might disturb some mechanism the +maintainer is used to apply to the sources. Because running +gettextize is easy there shouldn't be problems with using copies. -
+
`-f´ +: +
`--force´ +: + + +Force replacement of files which already exist. +
`--intl´ +: + +Install the libintl sources in a subdirectory named `intl/´. +This libintl will be used to provide internationalization on systems +that don't have GNU libintl installed. If this option is omitted, +the call to AM_GNU_GETTEXT in `configure.in´ should read: +`AM_GNU_GETTEXT([external])´, and internationalization will not +be enabled on systems lacking GNU gettext. -
13.3.2 Objective C Format Strings
+
`--no-changelog´ +: + +Don't update or create ChangeLog files. By default, gettextize +logs all changes (file additions, modifications and removals) in a +file called `ChangeLog´ in each affected directory. -
-Objective C format strings are like C format strings. They support an -additional format directive: "$@", which when executed consumes an argument -of type Object *. +
`-n´ +: +
`--dry-run´ +: + + +Print modifications but don't perform them. All actions that +gettextize would normally execute are inhibited and instead only +listed on standard output. -
+
`--help´ +: + +Display this help and exit. +
`--version´ +: + +Output version information and exit. -
13.3.3 Shell Format Strings
+

-Shell format strings, as supported by GNU gettext and the `envsubst´ -program, are strings with references to shell variables in the form -$variable or ${variable}. References of the form -${variable-default}, -${variable:-default}, -${variable=default}, -${variable:=default}, -${variable+replacement}, -${variable:+replacement}, -${variable?ignored}, -${variable:?ignored}, -that would be valid inside shell scripts, are not supported. The -variable names must consist solely of alphanumeric or underscore -ASCII characters, not start with a digit and be nonempty; otherwise such -a variable reference is ignored. +If directory is given, this is the top level directory of a +package to prepare for using GNU gettext. If not given, it +is assumed that the current directory is the top level directory of +such a package.

- - -

13.3.4 Python Format Strings

-Python format strings are described in -Python Library reference / -2. Built-in Types, Exceptions and Functions / -2.2. Built-in Types / -2.2.6. Sequence Types / -2.2.6.2. String Formatting Operations. -http://www.python.org/doc/2.2.1/lib/typesseq-strings.html. +The program gettextize provides the following files. However, +no existing file will be replaced unless the option --force +(-f) is specified.

-
13.3.5 Lisp Format Strings
+The `ABOUT-NLS´ file is copied in the main directory of your package, +the one being at the top level. This file gives the main indications +about how to install and use the Native Language Support features +of your program. You might elect to use a more recent copy of this +`ABOUT-NLS´ file than the one provided through gettextize, +if you have one handy. You may also fetch a more recent copy of file +`ABOUT-NLS´ from Translation Project sites, and from most GNU +archive sites. -
-Lisp format strings are described in the Common Lisp HyperSpec, -chapter 22.3 Formatted Output, -http://www.lisp.org/HyperSpec/Body/sec_22-3.html. +
-
+A `po/´ directory is created for eventually holding +all translation files, but initially only containing the file +`po/Makefile.in.in´ from the GNU gettext distribution +(beware the double `.in´ in the file name) and a few auxiliary +files. If the `po/´ directory already exists, it will be preserved +along with the files it contains, and only `Makefile.in.in´ and +the auxiliary files will be overwritten. +
-
13.3.6 Emacs Lisp Format Strings
+Only if `--intl´ has been specified: +A `intl/´ directory is created and filled with most of the files +originally in the `intl/´ directory of the GNU gettext +distribution. Also, if option --force (-f) is given, +the `intl/´ directory is emptied first. -
-Emacs Lisp format strings are documented in the Emacs Lisp reference, -section Formatting Strings, -http://www.gnu.org/manual/elisp-manual-21-2.8/html_chapter/elisp_4.html#SEC75. -Note that as of version 21, XEmacs supports numbered argument specifications -in format strings while FSF Emacs doesn't. +
-
+The files `config.rpath´ and `mkinstalldirs´ are copied into +the directory containing configuration support files. It is needed by +the AM_GNU_GETTEXT autoconf macro. +
-
13.3.7 librep Format Strings
+Only if the project is using GNU automake: +A set of autoconf macro files is copied into the package's +autoconf macro repository, usually in a directory called `m4/´. +

-librep format strings are documented in the librep manual, section -Formatted Output, -http://librep.sourceforge.net/librep-manual.html#Formatted%20Output, -http://www.gwinnup.org/research/docs/librep.html#SEC122. +If your site support symbolic links, gettextize will not +actually copy the files into your package, but establish symbolic +links instead. This avoids duplicating the disk space needed in +all packages. Merely using the `-h´ option while creating the +tar archive of your distribution will resolve each link by an +actual copy in the distribution archive. So, to insist, you really +should use `-h´ option with tar within your dist +goal of your main `Makefile.in´.

+Furthermore, gettextize will update all `Makefile.am´ files +in each affected directory, as well as the top level `configure.in´ +or `configure.ac´ file. +

+It is interesting to understand that most new files for supporting +GNU gettext facilities in one package go in `intl/´, +`po/´ and `m4/´ subdirectories. One distinction between +`intl/´ and the two other directories is that `intl/´ is +meant to be completely identical in all packages using GNU gettext, +while the other directories will mostly contain package dependent +files. -

13.3.8 Scheme Format Strings

+The gettextize program makes backup files for all files it +replaces or changes, and also write ChangeLog entries about these +changes. This way, the careful maintainer can check after running +gettextize whether its changes are acceptable to him, and +possibly adjust them. An exception to this rule is the `intl/´ +directory, which is added or replaced or removed as a whole. +

-Scheme format strings are documented in the SLIB manual, section -Format Specification. +It is important to understand that gettextize can not do the +entire job of adapting a package for using GNU gettext. The +amount of remaining work depends on whether the package uses GNU +automake or not. But in any case, the maintainer should still +read the section section 13.4 Files You Must Create or Alter after invoking gettextize.

+It is also important to understand that gettextize is not part +of the GNU build system, in the sense that it should not be invoked +automatically, and not be invoked by someone who doesn't assume the +responsibilities of a package maintainer. For the latter purpose, a +separate tool is provided, see section 13.6.3 Invoking the autopoint Program. +

13.3.9 Smalltalk Format Strings

13.4 Files You Must Create or Alter

-Smalltalk format strings are described in the GNU Smalltalk documentation, -class CharArray, methods `bindWith:´ and -`bindWithArguments:´. -http://www.gnu.org/software/smalltalk/gst-manual/gst_68.html#SEC238. -In summary, a directive starts with `%´ and is followed by `%´ -or a nonzero digit (`1´ to `9´). +

+Besides files which are automatically added through gettextize, +there are many files needing revision for properly interacting with +GNU gettext. If you are closely following GNU standards for +Makefile engineering and auto-configuration, the adaptations should +be easier to achieve. Here is a point by point description of the +changes needed in each. - -

13.3.10 Java Format Strings

- +

-Java format strings are described in the JDK documentation for class -java.text.MessageFormat, -http://java.sun.com/j2se/1.4/docs/api/java/text/MessageFormat.html. -See also the ICU documentation -http://oss.software.ibm.com/icu/apiref/classMessageFormat.html. +So, here comes a list of files, each one followed by a description of +all alterations it needs. Many examples are taken out from the GNU +gettext 0.15-pre0 distribution itself, or from the GNU +hello distribution (http://www.franken.de/users/gnu/ke/hello +or http://www.gnu.franken.de/ke/hello/) You may indeed +refer to the source code of the GNU gettext and GNU hello +packages, as they are intended to be good examples for using GNU +gettext functionality.

13.3.11 C# Format Strings

13.4.1 `POTFILES.in´ in `po/´

-C# format strings are described in the .NET documentation for class -System.String and in -http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpguide/html/cpConFormattingOverview.asp. +

+The `po/´ directory should receive a file named +`POTFILES.in´. This file tells which files, among all program +sources, have marked strings needing translation. Here is an example +of such a file: +

13.3.12 awk Format Strings

+# List of source files containing translatable strings.
+# Copyright (C) 1995 Free Software Foundation, Inc.
+
+# Common library files
+lib/error.c
+lib/getopt.c
+lib/xmalloc.c
+
+# Package source files
+src/gettext.c
+src/msgfmt.c
+src/xgettext.c
+

-awk format strings are described in the gawk documentation, section -Printf, -http://www.gnu.org/manual/gawk/html_node/Printf.html#Printf. +Hash-marked comments and white lines are ignored. All other lines +list those source files containing strings marked for translation +(see section 4.3 How Marks Appear in Sources), in a notation relative to the top level +of your whole distribution, rather than the location of the +`POTFILES.in´ file itself.

+When a C file is automatically generated by a tool, like flex or +bison, that doesn't introduce translatable strings by itself, +it is recommended to list in `po/POTFILES.in´ the real source file +(ending in `.l´ in the case of flex, or in `.y´ in the +case of bison), not the generated C file. +

13.3.13 Object Pascal Format Strings

13.4.2 `LINGUAS´ in `po/´

-Where is this documented? +

+The `po/´ directory should also receive a file named +`LINGUAS´. This file contains the list of available translations. +It is a whitespace separated list. Hash-marked comments and white lines +are ignored. Here is an example file: +

13.3.14 YCP Format Strings

+# Set of available languages.
+de fr
+

-YCP sformat strings are described in the libycp documentation -file:/usr/share/doc/packages/libycp/YCP-builtins.html. -In summary, a directive starts with `%´ and is followed by `%´ -or a nonzero digit (`1´ to `9´). +This example means that German and French PO files are available, so +that these languages are currently supported by your package. If you +want to further restrict, at installation time, the set of installed +languages, this should not be done by modifying the `LINGUAS´ file, +but rather by using the LINGUAS environment variable +(see section 14 The Installer's and Distributor's View).

+It is recommended that you add the "languages" `en@quot´ and +`en@boldquot´ to the LINGUAS file. en@quot is a +variant of English message catalogs (en) which uses real quotation +marks instead of the ugly looking asymmetric ASCII substitutes ``´ +and `'´. en@boldquot is a variant of en@quot that +additionally outputs quoted pieces of text in a bold font, when used in +a terminal emulator which supports the VT100 escape sequences (such as +xterm or the Linux console, but not Emacs in M-x shell mode). - -

13.3.15 Tcl Format Strings

- +

-Tcl format strings are described in the `format.n´ manual page, -http://www.scriptics.com/man/tcl8.3/TclCmd/format.htm. +These extra message catalogs `en@quot´ and `en@boldquot´ +are constructed automatically, not by translators; to support them, you +need the files `Rules-quot´, `quot.sed´, `boldquot.sed´, +`en@quot.header´, `en@boldquot.header´, `insert-header.sin´ +in the `po/´ directory. You can copy them from GNU gettext's `po/´ +directory; they are also installed by running gettextize.

13.3.16 Perl Format Strings

13.4.3 `Makevars´ in `po/´

+ +

-There are two kinds format strings in Perl: those acceptable to the -Perl built-in function printf, labelled as `perl-format´, -and those acceptable to the libintl-perl function __x, -labelled as `perl-brace-format´. +The `po/´ directory also has a file named `Makevars´. +It can be left unmodified if your package has a single message domain +and, accordingly, a single `po/´ directory. Only packages which +have multiple `po/´ directories at different locations need to +adjust the three variables defined in `Makevars´.

-Perl printf format strings are described in the sprintf -section of `man perlfunc´. +`po/Makevars´ gets inserted into the `po/Makefile´ when the +latter is created. At the same time, all files called `Rules-*´ in the +`po/´ directory get appended to the `po/Makefile´. They present +an opportunity to add rules for special PO files to the Makefile, without +needing to mess with `po/Makefile.in.in´.

-Perl brace format strings are described in the -`Locale::TextDomain(3pm)´ manual page of the CPAN package -libintl-perl. In brief, Perl format uses placeholders put between -braces (`{´ and `}´). The placeholder must have the syntax -of simple identifiers. + + +GNU gettext comes with a `Rules-quot´ file, containing rules for +building catalogs `en@quot.po´ and `en@boldquot.po´. The +effect of `en@quot.po´ is that people who set their LANGUAGE +environment variable to `en@quot´ will get messages with proper +looking symmetric Unicode quotation marks instead of abusing the ASCII +grave accent and the ASCII apostrophe for indicating quotations. To +enable this catalog, simply add en@quot to the `po/LINGUAS´ +file. The effect of `en@boldquot.po´ is that people who set +LANGUAGE to `en@boldquot´ will get not only proper quotation +marks, but also the quoted text will be shown in a bold font on terminals +and consoles. This catalog is useful only for command-line programs, not +GUI programs. To enable it, similarly add en@boldquot to the +`po/LINGUAS´ file.

13.3.17 PHP Format Strings

13.4.4 `configure.in´ at top level

-PHP format strings are described in the documentation of the PHP function -sprintf, in `phpdoc/manual/function.sprintf.html´ or -http://www.php.net/manual/en/function.sprintf.php. +`configure.in´ or `configure.ac´ - this is the source from which +autoconf generates the `configure´ script.

Declare the package and version. -
13.3.18 GCC internal Format Strings
- -
-These format strings are used inside the GCC sources. In such a format -string, a directive starts with `%´, is optionally followed by a -size specifier `l´, an optional flag `+´, another optional flag -`#´, and is finished by a specifier: `%´ denotes a literal -percent sign, `c´ denotes a character, `s´ denotes a string, -`i´ and `d´ denote an integer, `o´, `u´, `x´ -denote an unsigned integer, `.*s´ denotes a string preceded by a -width specification, `H´ denotes a `location_t *´ pointer, -`D´ denotes a general declaration, `F´ denotes a function -declaration, `T´ denotes a type, `A´ denotes a function argument, -`C´ denotes a tree code, `E´ denotes an expression, `L´ -denotes a programming language, `O´ denotes a binary operator, -`P´ denotes a function parameter, `Q´ denotes an assignment -operator, `V´ denotes a const/volatile qualifier. + -
+This is done by a set of lines like these: -
13.3.19 Qt Format Strings
+
```
+PACKAGE=gettext
+VERSION=0.15-pre0
+AC_DEFINE_UNQUOTED(PACKAGE, "$PACKAGE")
+AC_DEFINE_UNQUOTED(VERSION, "$VERSION")
+AC_SUBST(PACKAGE)
+AC_SUBST(VERSION)
+
```
-
-Qt format strings are described in the documentation of the QString class -file:/usr/lib/qt-3.0.5/doc/html/qstring.html. -In summary, a directive consists of a `%´ followed by a digit. The same -directive cannot occur more than once in a format string. +or, if you are using GNU automake, by a line like this: -
+
```
+AM_INIT_AUTOMAKE(gettext, 0.15-pre0)
+
```
-
13.4 The Maintainer's View
+Of course, you replace `gettext´ with the name of your package, +and `0.15-pre0´ by its version numbers, exactly as they +should appear in the packaged tar file name of your distribution +(`gettext-0.15-pre0.tar.gz´, here). -
-For the maintainer, the general procedure differs from the C language -case in two ways. +
Check for internationalization support. -
+Here is the main m4 macro for triggering internationalization +support. Just add this line to `configure.in´: -
- -For those languages that don't use GNU gettext, the `intl/´ directory -is not needed and can be omitted. This means that the maintainer calls the -gettextize program without the `--intl´ option, and that he -invokes the AM_GNU_GETTEXT autoconf macro via -`AM_GNU_GETTEXT([external])´. +
```
+AM_GNU_GETTEXT
+
```
  -
- +This call is purposely simple, even if it generates a lot of configure +time checking and actions. -If only a single programming language is used, the XGETTEXT_OPTIONS -variable in `po/Makevars´ (see section 12.4.3 `Makevars´ in `po/´) should be adjusted to -match the xgettext options for that particular programming language. -If the package uses more than one programming language with gettext -support, it becomes necessary to change the POT file construction rule -in `po/Makefile.in.in´. It is recommended to make one xgettext -invocation per programming language, each with the options appropriate for -that language, and to combine the resulting files using msgcat. -
+If you have suppressed the `intl/´ subdirectory by calling +gettextize without `--intl´ option, this call should read +
```
+AM_GNU_GETTEXT([external])
+
```
-
13.5 Individual Programming Languages
+
Have output files created. +The AC_OUTPUT directive, at the end of your `configure.in´ +file, needs to be modified in two ways: -
13.5.1 C, C++, Objective C
-
- +
```
+AC_OUTPUT([existing configuration files intl/Makefile po/Makefile.in],
+[existing additional actions])
+
```
-
-
+The modification to the first argument to AC_OUTPUT asks +for substitution in the `intl/´ and `po/´ directories. +Note the `.in´ suffix used for `po/´ only. This is because +the distributed file is really `po/Makefile.in.in´. -
RPMs -
-gcc, gpp, gobjc, glibc, gettext +If you have suppressed the `intl/´ subdirectory by calling +gettextize without `--intl´ option, then you don't need to +add intl/Makefile to the AC_OUTPUT line. -
File extension -
-For C: c, h. -
For C++: C, c++, cc, cxx, cpp, hpp. -
For Objective C: m. +

String syntax -

-"abc" -

gettext shorthand -

-_("abc") -

gettext/ngettext functions -

-gettext, dgettext, dcgettext, ngettext, -dngettext, dcngettext +

13.4.5 `config.guess´, `config.sub´ at top level

textdomain -

-textdomain function +

+If you haven't suppressed the `intl/´ subdirectory, +you need to add the GNU `config.guess´ and `config.sub´ files +to your distribution. They are needed because the `intl/´ directory +has platform dependent support for determining the locale's character +encoding and therefore needs to identify the platform. -

bindtextdomain -

-bindtextdomain function +

+You can obtain the newest version of `config.guess´ and +`config.sub´ from the CVS of the `config´ project at +`http://savannah.gnu.org/´. The commands to fetch them are -

setlocale -

-Programmer must call setlocale (LC_ALL, "") +

+$ wget 'http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/config/config/config.guess'
+$ wget 'http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/config/config/config.sub'
+

Prerequisite -

-#include <libintl.h> -
#include <locale.h> -
#define _(string) gettext (string) +

+Less recent versions are also contained in the GNU automake and +GNU libtool packages. -

Use or emulate GNU gettext -

-Use +

+Normally, `config.guess´ and `config.sub´ are put at the +top level of a distribution. But it is also possible to put them in a +subdirectory, altogether with other configuration support files like +`install-sh´, `ltconfig´, `ltmain.sh´, +`mkinstalldirs´ or `missing´. All you need to do, other than +moving the files, is to add the following line to your +`configure.in´. -

Extractor -

-xgettext -k_ +

Formatting with positions -

-fprintf "%2$d %1$d" -
In C++: autosprintf "%2$d %1$d" -(see section `Introduction' in GNU autosprintf) +

+AC_CONFIG_AUX_DIR([subdir])
+

Portability -

-autoconf (gettext.m4) and #if ENABLE_NLS -

po-mode marking -

-yes - +

13.4.6 `mkinstalldirs´ at top level

-The following examples are available in the `examples´ directory: -hello-c, hello-c-gnome, hello-c++, hello-c++-qt, -hello-c++-kde, hello-c++-gnome, hello-objc, -hello-objc-gnustep, hello-objc-gnome. +

+If gettextize has not already done it, you need to add the GNU +`mkinstalldirs´ script to your distribution. It is needed because +`mkdir -p´ is not portable enough. You find this script in the +GNU automake distribution. - -

13.5.2 sh - Shell Script

- +Normally, `mkinstalldirs´ is put at the top level of a distribution. +But it is also possible to put it in a subdirectory, altogether with other +configuration support files like `install-sh´, `ltconfig´, +`ltmain.sh´ or `missing´. All you need to do, other than +moving the files, is to add the following line to your `configure.in´.

RPMs -

-bash, gettext +

+AC_CONFIG_AUX_DIR([subdir])
+

File extension -

-sh -

String syntax -

-"abc", 'abc', abc -

gettext shorthand -

-"`gettext \"abc\"`" +

13.4.7 `aclocal.m4´ at top level

+ -

gettext/ngettext functions -

- - -gettext, ngettext programs -
eval_gettext, eval_ngettext shell functions +

+If you do not have an `aclocal.m4´ file in your distribution, +the simplest is to concatenate the files `codeset.m4´, +`gettext.m4´, `glibc2.m4´, `glibc21.m4´, `iconv.m4´, +`intdiv0.m4´, `intmax.m4´, `inttypes.m4´, `inttypes_h.m4´, +`inttypes-pri.m4´, `isc-posix.m4´, `lcmessage.m4´, +`lib-ld.m4´, `lib-link.m4´, `lib-prefix.m4´, `lock.m4´, +`longdouble.m4´, `longlong.m4´, `printf-posix.m4´, +`progtest.m4´, `signed.m4´, `size_max.m4´, +`stdint_h.m4´, `uintmax_t.m4´, `ulonglong.m4´, +`wchar_t.m4´, `wint_t.m4´, `xsize.m4´ +from GNU gettext's +`m4/´ directory into a single file. If you have suppressed the +`intl/´ directory, only `gettext.m4´, `iconv.m4´, +`lib-ld.m4´, `lib-link.m4´, `lib-prefix.m4´, +`progtest.m4´ need to be concatenated. -

textdomain -

- -environment variable TEXTDOMAIN +

+If you already have an `aclocal.m4´ file, then you will have +to merge the said macro files into your `aclocal.m4´. Note that if +you are upgrading from a previous release of GNU gettext, you +should most probably replace the macros (AM_GNU_GETTEXT, +etc.), as they usually +change a little from one release of GNU gettext to the next. +Their contents may vary as we get more experience with strange systems +out there. -

bindtextdomain -

- -environment variable TEXTDOMAINDIR +

+If you are using GNU automake 1.5 or newer, it is enough to put +these macro files into a subdirectory named `m4/´ and add the line -

setlocale -

-automatic +

Prerequisite -

-. gettext.sh +

+ACLOCAL_AMFLAGS = -I m4
+

Use or emulate GNU gettext -

-use +

+to your top level `Makefile.am´. -

Extractor -

-xgettext +

+These macros check for the internationalization support functions +and related informations. Hopefully, once stabilized, these macros +might be integrated in the standard Autoconf set, because this +piece of m4 code will be the same for all projects using GNU +gettext. -

Formatting with positions -

---- +

Portability -

-fully portable -

po-mode marking -

---- -

13.4.8 `acconfig.h´ at top level

+ +

-An example is available in the `examples´ directory: hello-sh. +Earlier GNU gettext releases required to put definitions for +ENABLE_NLS, HAVE_GETTEXT and HAVE_LC_MESSAGES, +HAVE_STPCPY, PACKAGE and VERSION into an +`acconfig.h´ file. This is not needed any more; you can remove +them from your `acconfig.h´ file unless your package uses them +independently from the `intl/´ directory.

13.4.9 `config.h.in´ at top level

+ -

13.5.2.1 Preparing Shell Scripts for Internationalization

- +The include file template that holds the C macros to be defined by +configure is usually called `config.h.in´ and may be +maintained either manually or automatically.

-Preparing a shell script for internationalization is conceptually similar -to the steps described in section 3 Preparing Program Sources. The concrete steps for shell -scripts are as follows. +If gettextize has created an `intl/´ directory, this file +must be called `config.h.in´ and must be at the top level. If, +however, you have suppressed the `intl/´ directory by calling +gettextize without `--intl´ option, then you can choose the +name of this file and its location freely.

+If it is maintained automatically, by use of the `autoheader´ +program, you need to do nothing about it. This is the case in particular +if you are using GNU automake. -

+
+
+If it is maintained manually, and if gettextize has created an +`intl/´ directory, you should switch to using `autoheader´. +The list of C macros to be added for the sake of the `intl/´ +directory is just too long to be maintained manually; it also changes +between different versions of GNU gettext. -Insert the line +
+
+If it is maintained manually, and if on the other hand you have +suppressed the `intl/´ directory by calling gettextize +without `--intl´ option, then you can get away by adding the +following lines to `config.h.in´: +
```
-. gettext.sh
+/* Define to 1 if translation of program messages to the user's
+   native language is requested. */
+#undef ENABLE_NLS
 
```
-near the top of the script. gettext.sh is a shell function library -that provides the functions -eval_gettext (see section 13.5.2.6 Invoking the eval_gettext function) and -eval_ngettext (see section 13.5.2.7 Invoking the eval_ngettext function). -You have to ensure that gettext.sh can be found in the PATH. + +
13.4.10 `Makefile.in´ at top level
+ +
+Here are a few modifications you need to make to your main, top-level +`Makefile.in´ file. + +
+ +
1. -Set and export the TEXTDOMAIN and TEXTDOMAINDIR environment -variables. Usually TEXTDOMAIN is the package or program name, and -TEXTDOMAINDIR is the absolute pathname corresponding to -$prefix/share/locale, where $prefix is the installation location. +Add the following lines near the beginning of your `Makefile.in´, +so the `dist:´ goal will work properly (as explained further down):
```
-TEXTDOMAIN=@PACKAGE@
-export TEXTDOMAIN
-TEXTDOMAINDIR=@LOCALEDIR@
-export TEXTDOMAINDIR
+PACKAGE = @PACKAGE@
+VERSION = @VERSION@
 
```
2. -Prepare the strings for translation, as described in section 3.2 Preparing Translatable Strings. +Add file `ABOUT-NLS´ to the DISTFILES definition, so the file gets +distributed.
3. -Simplify translatable strings so that they don't contain command substitution -("`...`" or "$(...)"), variable access with defaulting (like -${variable-default}), access to positional arguments -(like $0, $1, ...) or highly volatile shell variables (like -$?). This can always be done through simple local code restructuring. -For example, +Wherever you process subdirectories in your `Makefile.in´, be sure +you also process the subdirectories `intl´ and `po´. Special +rules in the `Makefiles´ take care for the case where no +internationalization is wanted. + +If you are using Makefiles, either generated by automake, or hand-written +so they carefully follow the GNU coding standards, the effected goals for +which the new subdirectories must be handled include `installdirs´, +`install´, `uninstall´, `clean´, `distclean´. + +Here is an example of a canonical order of processing. In this +example, we also define SUBDIRS in Makefile.in for it +to be further used in the `dist:´ goal.
```
-echo "Usage: $0 [OPTION] FILE..."
+SUBDIRS = doc intl lib src po
 
```
  -becomes +Note that you must arrange for `make´ to descend into the +intl directory before descending into other directories containing +code which make use of the libintl.h header file. For this +reason, here we mention intl before lib and src. + +
4. + +A delicate point is the `dist:´ goal, as both +`intl/Makefile´ and `po/Makefile´ will later assume that the +proper directory has been set up from the main `Makefile´. Here is +an example at what the `dist:´ goal might look like:
```
-program_name=$0
-echo "Usage: $program_name [OPTION] FILE..."
+distdir = $(PACKAGE)-$(VERSION)
+dist: Makefile
+	rm -fr $(distdir)
+	mkdir $(distdir)
+	chmod 777 $(distdir)
+	for file in $(DISTFILES); do \
+	  ln $$file $(distdir) 2>/dev/null || cp -p $$file $(distdir); \
+	done
+	for subdir in $(SUBDIRS); do \
+	  mkdir $(distdir)/$$subdir || exit 1; \
+	  chmod 777 $(distdir)/$$subdir; \
+	  (cd $$subdir && $(MAKE) $@) || exit 1; \
+	done
+	tar chozf $(distdir).tar.gz $(distdir)
+	rm -fr $(distdir)
 
```
  -Similarly, +
+
+Note that if you are using GNU automake, `Makefile.in´ is +automatically generated from `Makefile.am´, and all needed changes +to `Makefile.am´ are already made by running `gettextize´. -
```
-echo "Remaining files: `ls | wc -l`"
-
```
+
-becomes +
13.4.11 `Makefile.in´ in `src/´
-
```
-filecount="`ls | wc -l`"
-echo "Remaining files: $filecount"
-
```
+
+Some of the modifications made in the main `Makefile.in´ will +also be needed in the `Makefile.in´ from your package sources, +which we assume here to be in the `src/´ subdirectory. Here are +all the modifications needed in `src/Makefile.in´: -
+
-For each translatable string, change the output command `echo´ or -`$echo´ to `gettext´ (if the string contains no references to -shell variables) or to `eval_gettext´ (if it refers to shell variables), -followed by a no-argument `echo´ command (to account for the terminating -newline). Similarly, for cases with plural handling, replace a conditional -`echo´ command with an invocation of `ngettext´ or -`eval_ngettext´, followed by a no-argument `echo´ command. +
1. -When doing this, you also need to add an extra backslash before the dollar -sign in references to shell variables, so that the `eval_gettext´ -function receives the translatable string before the variable values are -substituted into it. For example, +In view of the `dist:´ goal, you should have these lines near the +beginning of `src/Makefile.in´:
```
-echo "Remaining files: $filecount"
+PACKAGE = @PACKAGE@
+VERSION = @VERSION@
 
```
  -becomes +
2. + +If not done already, you should guarantee that top_srcdir +gets defined. This will serve for cpp include files. Just add +the line:
```
-eval_gettext "Remaining files: \$filecount"; echo
+top_srcdir = @top_srcdir@
 
```
  -If the output command is not `echo´, you can make it use `echo´ -nevertheless, through the use of backquotes. However, note that inside -backquotes, backslashes must be doubled to be effective (because the -backquoting eats one level of backslashes). For example, assuming that -`error´ is a shell function that signals an error, +
3. + +You might also want to define subdir as `src´, later +allowing for almost uniform `dist:´ goals in all your +`Makefile.in´. At list, the `dist:´ goal below assume that +you used:
```
-error "file not found: $filename"
+subdir = src
 
```
  -is first transformed into +
4. + +The main function of your program will normally call +bindtextdomain (see see section 4.1 Triggering gettext Operations), like this:
```
-error "`echo \"file not found: \$filename\"`"
+bindtextdomain (PACKAGE, LOCALEDIR);
+textdomain (PACKAGE);
 
```
  -which then becomes +To make LOCALEDIR known to the program, add the following lines to +`Makefile.in´:
```
-error "`eval_gettext \"file not found: \\\$filename\"`"
+datadir = @datadir@
+localedir = $(datadir)/locale
+DEFS = -DLOCALEDIR=\"$(localedir)\" @DEFS@
 
```
  -
+Note that @datadir@ defaults to `$(prefix)/share´, thus +$(localedir) defaults to `$(prefix)/share/locale´. +
+You should ensure that the final linking will use @LIBINTL@ or +@LTLIBINTL@ as a library. @LIBINTL@ is for use without +libtool, @LTLIBINTL@ is for use with libtool. An +easy way to achieve this is to manage that it gets into LIBS, like +this: -
13.5.2.2 Contents of gettext.sh
-
-gettext.sh, contained in the run-time package of GNU gettext, provides -the following: +
```
+LIBS = @LIBINTL@ @LIBS@
+
```
-
+In most packages internationalized with GNU gettext, one will +find a directory `lib/´ in which a library containing some helper +functions will be build. (You need at least the few functions which the +GNU gettext Library itself needs.) However some of the functions +in the `lib/´ also give messages to the user which of course should be +translated, too. Taking care of this, the support library (say +`libsupport.a´) should be placed before @LIBINTL@ and +@LIBS@ in the above example. So one has to write this: -
- $echo - -The variable echo is set to a command that outputs its first argument -and a newline, without interpreting backslashes in the argument string. - -
- eval_gettext - -See section 13.5.2.6 Invoking the eval_gettext function. - -
- eval_ngettext - -See section 13.5.2.7 Invoking the eval_ngettext function. -
- - - -
13.5.2.3 Invoking the gettext program
- -
- - - -
```
-gettext [option] [[textdomain] msgid]
-gettext [option] -s [msgid]...
-
```
- -
- -The gettext program displays the native language translation of a -textual message. - -
-
-Arguments - -
-
- -
`-d textdomain´ -
-
`--domain=textdomain´ -
- - -Retrieve translated messages from textdomain. Usually a textdomain -corresponds to a package, a program, or a module of a program. - -
`-e´ -
- -Enable expansion of some escape sequences. This option is for compatibility -with the `echo´ program or shell built-in. The escape sequences -`\a´, `\b´, `\c´, `\f´, `\n´, `\r´, `\t´, -`\v´, `\\´, and `\´ followed by one to three octal digits, are -interpreted like the SystemV `echo´ program does. - -
`-E´ -
- -This option is only for compatibility with the `echo´ program or shell -built-in. It has no effect. - -
`-h´ -
-
`--help´ -
- - -Display this help and exit. - -
`-n´ -
- -Suppress trailing newline. By default, gettext adds a newline to -the output. - -
`-V´ -
-
`--version´ -
- - -Output version information and exit. - -
`[textdomain] msgid´ -
-Retrieve translated message corresponding to msgid from textdomain. - -
- -
-If the textdomain parameter is not given, the domain is determined from -the environment variable TEXTDOMAIN. If the message catalog is not -found in the regular directory, another location can be specified with the -environment variable TEXTDOMAINDIR. - -
-
-When used with the -s option the program behaves like the `echo´ -command. But it does not simply copy its arguments to stdout. Instead those -messages found in the selected catalog are translated. - -
- - -
13.5.2.4 Invoking the ngettext program
- -
- - - -
```
-ngettext [option] [textdomain] msgid msgid-plural count
-
```
- -
- -The ngettext program displays the native language translation of a -textual message whose grammatical form depends on a number. - -
-
-Arguments - -
-
- -
`-d textdomain´ -
-
`--domain=textdomain´ -
- - -Retrieve translated messages from textdomain. Usually a textdomain -corresponds to a package, a program, or a module of a program. - -
`-e´ -
- -Enable expansion of some escape sequences. This option is for compatibility -with the `gettext´ program. The escape sequences -`\a´, `\b´, `\c´, `\f´, `\n´, `\r´, `\t´, -`\v´, `\\´, and `\´ followed by one to three octal digits, are -interpreted like the SystemV `echo´ program does. - -
`-E´ -
- -This option is only for compatibility with the `gettext´ program. It has -no effect. - -
`-h´ -
-
`--help´ -
- - -Display this help and exit. - -
`-V´ -
-
`--version´ -
- - -Output version information and exit. - -
`textdomain´ -
-Retrieve translated message from textdomain. - -
`msgid msgid-plural´ -
-Translate msgid (English singular) / msgid-plural (English plural). - -
`count´ -
-Choose singular/plural form based on this value. - -
- -
-If the textdomain parameter is not given, the domain is determined from -the environment variable TEXTDOMAIN. If the message catalog is not -found in the regular directory, another location can be specified with the -environment variable TEXTDOMAINDIR. - -
- - -
13.5.2.5 Invoking the envsubst program
- -
- - - -
```
-envsubst [option] [shell-format]
-
```
- -
- - - -The envsubst program substitutes the values of environment variables. - -
-
-Operation mode - -
-
- -
`-v´ -
-
`--variables´ -
- - -Output the variables occurring in shell-format. - -
- -
-Informative output - -
-
- -
`-h´ -
-
`--help´ -
- - -Display this help and exit. - -
`-V´ -
-
`--version´ -
- - -Output version information and exit. - -
- -
-In normal operation mode, standard input is copied to standard output, -with references to environment variables of the form $VARIABLE or -${VARIABLE} being replaced with the corresponding values. If a -shell-format is given, only those environment variables that are -referenced in shell-format are substituted; otherwise all environment -variables references occurring in standard input are substituted. - -
-
-These substitutions are a subset of the substitutions that a shell performs -on unquoted and double-quoted strings. Other kinds of substitutions done -by a shell, such as ${variable-default} or -$(command-list) or `command-list`, are not performed -by the envsubst program, due to security reasons. - -
-
-When --variables is used, standard input is ignored, and the output -consists of the environment variables that are referenced in -shell-format, one per line. - -
- - -
13.5.2.6 Invoking the eval_gettext function
- -
- - -
```
-eval_gettext msgid
-
```
- -
- -This function outputs the native language translation of a textual message, -performing dollar-substitution on the result. Note that only shell variables -mentioned in msgid will be dollar-substituted in the result. - -
- - -
13.5.2.7 Invoking the eval_ngettext function
- -
- - -
```
-eval_ngettext msgid msgid-plural count
-
```
- -
- -This function outputs the native language translation of a textual message -whose grammatical form depends on a number, performing dollar-substitution -on the result. Note that only shell variables mentioned in msgid or -msgid-plural will be dollar-substituted in the result. - -
- - -
13.5.3 bash - Bourne-Again Shell Script
-
- - -
-
-GNU bash 2.0 or newer has a special shorthand for translating a -string and substituting variable values in it: $"msgid". But -the use of this construct is discouraged, due to the security -holes it opens and due to its portability problems. - -
-
-The security holes of $"..." come from the fact that after looking up -the translation of the string, bash processes it like it processes -any double-quoted string: dollar and backquote processing, like `eval´ -does. - -
- -
1. - -In a locale whose encoding is one of BIG5, BIG5-HKSCS, GBK, GB18030, SHIFT_JIS, -JOHAB, some double-byte characters have a second byte whose value is -0x60. For example, the byte sequence \xe0\x60 is a single -character in these locales. Many versions of bash (all versions -up to bash-2.05, and newer versions on platforms without mbsrtowcs() -function) don't know about character boundaries and see a backquote character -where there is only a particular Chinese character. Thus it can start -executing part of the translation as a command list. This situation can occur -even without the translator being aware of it: if the translator provides -translations in the UTF-8 encoding, it is the gettext() function which -will, during its conversion from the translator's encoding to the user's -locale's encoding, produce the dangerous \x60 bytes. - -
2. - -A translator could - voluntarily or inadvertantly - use backquotes -"`...`" or dollar-parentheses "$(...)" in her translations. -The enclosed strings would be executed as command lists by the shell. -
- -
-The portability problem is that bash must be built with -internationalization support; this is normally not the case on systems -that don't have the gettext() function in libc. - -
- - -
13.5.4 Python
-
- - -
-
- -
RPMs -
-python - -
File extension -
-py - -
String syntax -
-'abc', u'abc', r'abc', ur'abc', -
"abc", u"abc", r"abc", ur"abc", -
"'abc"', u"'abc"', r"'abc"', ur"'abc"', -
"""abc""", u"""abc""", r"""abc""", ur"""abc""" - -
gettext shorthand -
-_('abc') etc. - -
gettext/ngettext functions -
-gettext.gettext, gettext.dgettext, -gettext.ngettext, gettext.dngettext, -also ugettext, ungettext - -
textdomain -
-gettext.textdomain function, or -gettext.install(domain) function - -
bindtextdomain -
-gettext.bindtextdomain function, or -gettext.install(domain,localedir) function - -
setlocale -
-not used by the gettext emulation - -
Prerequisite -
-import gettext - -
Use or emulate GNU gettext -
-emulate - -
Extractor -
-xgettext - -
Formatting with positions -
-'...%(ident)d...' % { 'ident': value } - -
Portability -
-fully portable - -
po-mode marking -
---- -
- -
-An example is available in the `examples´ directory: hello-python. - -
- - -
13.5.5 GNU clisp - Common Lisp
-
- - - - -
-
- -
RPMs -
-clisp 2.28 or newer - -
File extension -
-lisp - -
String syntax -
-"abc" - -
gettext shorthand -
-(_ "abc"), (ENGLISH "abc") - -
gettext/ngettext functions -
-i18n:gettext, i18n:ngettext - -
textdomain -
-i18n:textdomain - -
bindtextdomain -
-i18n:textdomaindir - -
setlocale -
-automatic - -
Prerequisite -
---- - -
Use or emulate GNU gettext -
-use - -
Extractor -
-xgettext -k_ -kENGLISH - -
Formatting with positions -
-format "~1@*~D ~0@*~D" - -
Portability -
-On platforms without gettext, no translation. - -
po-mode marking -
---- -
- -
-An example is available in the `examples´ directory: hello-clisp. - -
- - -
13.5.6 GNU clisp C sources
-
- - -
-
- -
RPMs -
-clisp - -
File extension -
-d - -
String syntax -
-"abc" - -
gettext shorthand -
-ENGLISH ? "abc" : "" -
GETTEXT("abc") -
GETTEXTL("abc") - -
gettext/ngettext functions -
-clgettext, clgettextl - -
textdomain -
---- - -
bindtextdomain -
---- - -
setlocale -
-automatic - -
Prerequisite -
-#include "lispbibl.c" - -
Use or emulate GNU gettext -
-use - -
Extractor -
-clisp-xgettext - -
Formatting with positions -
-fprintf "%2$d %1$d" - -
Portability -
-On platforms without gettext, no translation. - -
po-mode marking -
---- -
- - - -
13.5.7 Emacs Lisp
-
- - -
-
- -
RPMs -
-emacs, xemacs - -
File extension -
-el - -
String syntax -
-"abc" - -
gettext shorthand -
-(_"abc") - -
gettext/ngettext functions -
-gettext, dgettext (xemacs only) - -
textdomain -
-domain special form (xemacs only) - -
bindtextdomain -
-bind-text-domain function (xemacs only) - -
setlocale -
-automatic - -
Prerequisite -
---- - -
Use or emulate GNU gettext -
-use - -
Extractor -
-xgettext - -
Formatting with positions -
-format "%2$d %1$d" - -
Portability -
-Only XEmacs. Without I18N3 defined at build time, no translation. - -
po-mode marking -
---- -
- - - -
13.5.8 librep
-
- - -
-
- -
RPMs -
-librep 0.15.3 or newer - -
File extension -
-jl - -
String syntax -
-"abc" - -
gettext shorthand -
-(_"abc") - -
gettext/ngettext functions -
-gettext - -
textdomain -
-textdomain function - -
bindtextdomain -
-bindtextdomain function - -
setlocale -
---- - -
Prerequisite -
-(require 'rep.i18n.gettext) - -
Use or emulate GNU gettext -
-use - -
Extractor -
-xgettext - -
Formatting with positions -
-format "%2$d %1$d" - -
Portability -
-On platforms without gettext, no translation. - -
po-mode marking -
---- -
- -
-An example is available in the `examples´ directory: hello-librep. - -
- - -
13.5.9 GNU guile - Scheme
-
- - - -
-
- -
RPMs -
-guile - -
File extension -
-scm - -
String syntax -
-"abc" - -
gettext shorthand -
-(_ "abc") - -
gettext/ngettext functions -
-gettext, ngettext - -
textdomain -
-textdomain - -
bindtextdomain -
-bindtextdomain - -
setlocale -
-(catch #t (lambda () (setlocale LC_ALL "")) (lambda args #f)) - -
Prerequisite -
-(use-modules (ice-9 format)) - -
Use or emulate GNU gettext -
-use - -
Extractor -
-xgettext -k_ - -
Formatting with positions -
---- - -
Portability -
-On platforms without gettext, no translation. - -
po-mode marking -
---- -
- -
-An example is available in the `examples´ directory: hello-guile. - -
- - -
13.5.10 GNU Smalltalk
-
- - -
-
- -
RPMs -
-smalltalk - -
File extension -
-st - -
String syntax -
-'abc' - -
gettext shorthand -
-NLS ? 'abc' - -
gettext/ngettext functions -
-LcMessagesDomain>>#at:, LcMessagesDomain>>#at:plural:with: - -
textdomain -
-LcMessages>>#domain:localeDirectory: (returns a LcMessagesDomain -object).
-Example: I18N Locale default messages domain: 'gettext' localeDirectory: /usr/local/share/locale' - -
bindtextdomain -
-LcMessages>>#domain:localeDirectory:, see above. - -
setlocale -
-Automatic if you use I18N Locale default. - -
Prerequisite -
-PackageLoader fileInPackage: 'I18N'! - -
Use or emulate GNU gettext -
-emulate - -
Extractor -
-xgettext - -
Formatting with positions -
-'%1 %2' bindWith: 'Hello' with: 'world' - -
Portability -
-fully portable - -
po-mode marking -
---- -
- -
-An example is available in the `examples´ directory: -hello-smalltalk. - -
- - -
13.5.11 Java
-
- - -
-
- -
RPMs -
-java, java2 - -
File extension -
-java - -
String syntax -
-"abc" - -
gettext shorthand -
-_("abc") - -
gettext/ngettext functions -
-GettextResource.gettext, GettextResource.ngettext - -
textdomain -
----, use ResourceBundle.getResource instead - -
bindtextdomain -
----, use CLASSPATH instead - -
setlocale -
-automatic - -
Prerequisite -
---- - -
Use or emulate GNU gettext -
----, uses a Java specific message catalog format - -
Extractor -
-xgettext -k_ - -
Formatting with positions -
-MessageFormat.format "{1,number} {0,number}" - -
Portability -
-fully portable - -
po-mode marking -
---- -
- -
-Before marking strings as internationalizable, uses of the string -concatenation operator need to be converted to MessageFormat -applications. For example, "file "+filename+" not found" becomes -MessageFormat.format("file {0} not found", new Object[] { filename }). -Only after this is done, can the strings be marked and extracted. - -
-
-GNU gettext uses the native Java internationalization mechanism, namely -ResourceBundles. There are two formats of ResourceBundles: -.properties files and .class files. The .properties -format is a text file which the translators can directly edit, like PO -files, but which doesn't support plural forms. Whereas the .class -format is compiled from .java source code and can support plural -forms (provided it is accessed through an appropriate API, see below). - -
-
-To convert a PO file to a .properties file, the msgcat -program can be used with the option --properties-output. To convert -a .properties file back to a PO file, the msgcat program -can be used with the option --properties-input. All the tools -that manipulate PO files can work with .properties files as well, -if given the --properties-input and/or --properties-output -option. - -
-
-To convert a PO file to a ResourceBundle class, the msgfmt program -can be used with the option --java or --java2. To convert a -ResourceBundle back to a PO file, the msgunfmt program can be used -with the option --java. - -
-
-Two different programmatic APIs can be used to access ResourceBundles. -Note that both APIs work with all kinds of ResourceBundles, whether -GNU gettext generated classes, or other .class or .properties -files. - -
- -
1. - -The java.util.ResourceBundle API. - -In particular, its getString function returns a string translation. -Note that a missing translation yields a MissingResourceException. - -This has the advantage of being the standard API. And it does not require -any additional libraries, only the msgcat generated .properties -files or the msgfmt generated .class files. But it cannot do -plural handling, even if the resource was generated by msgfmt from -a PO file with plural handling. - -
2. - -The gnu.gettext.GettextResource API. - -Reference documentation in Javadoc 1.1 style format -is in the javadoc1 directory and -in Javadoc 2 style format -in the javadoc2 directory. - -Its gettext function returns a string translation. Note that when -a translation is missing, the msgid argument is returned unchanged. - -This has the advantage of having the ngettext function for plural -handling. - - -To use this API, one needs the libintl.jar file which is part of -the GNU gettext package and distributed under the LGPL. -
- -
-Three examples, using the second API, are available in the `examples´ -directory: hello-java, hello-java-awt, hello-java-swing. - -
-
-Now, to make use of the API and define a shorthand for `getString´, -there are two idioms that you can choose from: - -
- -
- - -In a unique class of your project, say `Util´, define a static variable -holding the ResourceBundle instance: - - -
```
-public static ResourceBundle myResources =
-  ResourceBundle.getBundle("domain-name");
-
```
  - -All classes containing internationalized strings then contain - - -
```
-private static ResourceBundle res = Util.myResources;
-private static String _(String s) { return res.getString(s); }
-
```
  - -and the shorthand is used like this: - - -
```
-System.out.println(_("Operation completed."));
-
```
  - -
- - -You add a class with a very short name, say `S´, containing just the -definition of the resource bundle and of the shorthand: - - -
```
-public class S {
-  public static ResourceBundle myResources =
-    ResourceBundle.getBundle("domain-name");
-  public static String _(String s) {
-    return myResources.getString(s);
-  }
-}
-
```
  - -and the shorthand is used like this: - - -
```
-System.out.println(S._("Operation completed."));
-
```
  - -
- -
-Which of the two idioms you choose, will depend on whether copying two lines -of codes into every class is more acceptable in your project than a class -with a single-letter name. - -
- - -
13.5.12 C#
-
- - -
-
- -
RPMs -
-pnet, pnetlib 0.6.2 or newer, or mono 0.29 or newer - -
File extension -
-cs - -
String syntax -
-"abc", @"abc" - -
gettext shorthand -
-_("abc") - -
gettext/ngettext functions -
-GettextResourceManager.GetString, -GettextResourceManager.GetPluralString - -
textdomain -
-new GettextResourceManager(domain) - -
bindtextdomain -
----, compiled message catalogs are located in subdirectories of the directory -containing the executable - -
setlocale -
-automatic - -
Prerequisite -
---- - -
Use or emulate GNU gettext -
----, uses a C# specific message catalog format - -
Extractor -
-xgettext -k_ - -
Formatting with positions -
-String.Format "{1} {0}" - -
Portability -
-fully portable - -
po-mode marking -
---- -
- -
-Before marking strings as internationalizable, uses of the string -concatenation operator need to be converted to String.Format -invocations. For example, "file "+filename+" not found" becomes -String.Format("file {0} not found", filename). -Only after this is done, can the strings be marked and extracted. - -
-
-GNU gettext uses the native C#/.NET internationalization mechanism, namely -the classes ResourceManager and ResourceSet. Applications -use the ResourceManager methods to retrieve the native language -translation of strings. An instance of ResourceSet is the in-memory -representation of a message catalog file. The ResourceManager loads -and accesses ResourceSet instances as needed to look up the -translations. - -
-
-There are two formats of ResourceSets that can be directly loaded by -the C# runtime: .resources files and .dll files. - -
- -
- - -The .resources format is a binary file usually generated through the -resgen or monoresgen utility, but which doesn't support plural -forms. .resources files can also be embedded in .NET .exe files. -This only affects whether a file system access is performed to load the message -catalog; it doesn't affect the contents of the message catalog. - -
- - -On the other hand, the .dll format is a binary file that is compiled -from .cs source code and can support plural forms (provided it is -accessed through the GNU gettext API, see below). -
- -
-Note that these .NET .dll and .exe files are not tied to a -particular platform; their file format and GNU gettext for C# can be used -on any platform. - -
-
-To convert a PO file to a .resources file, the msgfmt program -can be used with the option `--csharp-resources´. To convert a -.resources file back to a PO file, the msgunfmt program can be -used with the option `--csharp-resources´. You can also, in some cases, -use the resgen program (from the pnet package) or the -monoresgen program (from the mono/mcs package). These -programs can also convert a .resources file back to a PO file. But -beware: as of this writing (January 2004), the monoresgen converter is -quite buggy and the resgen converter ignores the encoding of the PO -files. - -
-
-To convert a PO file to a .dll file, the msgfmt program can be -used with the option --csharp. The result will be a .dll file -containing a subclass of GettextResourceSet, which itself is a subclass -of ResourceSet. To convert a .dll file containing a -GettextResourceSet subclass back to a PO file, the msgunfmt -program can be used with the option --csharp. - -
-
-The advantages of the .dll format over the .resources format -are: - -
- -
1. - -Freedom to localize: Users can add their own translations to an application -after it has been built and distributed. Whereas when the programmer uses -a ResourceManager constructor provided by the system, the set of -.resources files for an application must be specified when the -application is built and cannot be extended afterwards. - -
2. - -Plural handling: A message catalog in .dll format supports the plural -handling function GetPluralString. Whereas .resources files can -only contain data and only support lookups that depend on a single string. - -
3. - -The GettextResourceManager that loads the message catalogs in -.dll format also provides for inheritance on a per-message basis. -For example, in Austrian (de_AT) locale, translations from the German -(de) message catalog will be used for messages not found in the -Austrian message catalog. This has the consequence that the Austrian -translators need only translate those few messages for which the translation -into Austrian differs from the German one. Whereas when working with -.resources files, each message catalog must provide the translations -of all messages by itself. - -
4. - -The GettextResourceManager that loads the message catalogs in -.dll format also provides for a fallback: The English msgid is -returned when no translation can be found. Whereas when working with -.resources files, a language-neutral .resources file must -explicitly be provided as a fallback. -
- -
-On the side of the programmatic APIs, the programmer can use either the -standard ResourceManager API and the GNU GettextResourceManager -API. The latter is an extension of the former, because -GettextResourceManager is a subclass of ResourceManager. - -
- -
1. - -The System.Resources.ResourceManager API. - -This API works with resources in .resources format. - -The creation of the ResourceManager is done through - -
```
-  new ResourceManager(domainname, Assembly.GetExecutingAssembly())
-
```
  - - -The GetString function returns a string's translation. Note that this -function returns null when a translation is missing (i.e. not even found in -the fallback resource file). - -
2. - -The GNU.Gettext.GettextResourceManager API. - -This API works with resources in .dll format. - -Reference documentation is in the -csharpdoc directory. - -The creation of the ResourceManager is done through - -
```
-  new GettextResourceManager(domainname)
-
```
  - -The GetString function returns a string's translation. Note that when -a translation is missing, the msgid argument is returned unchanged. - -The GetPluralString function returns a string translation with plural -handling, like the ngettext function in C. - - -To use this API, one needs the GNU.Gettext.dll file which is part of -the GNU gettext package and distributed under the LGPL. -
- -
-You can also mix both approaches: use the -GNU.Gettext.GettextResourceManager constructor, but otherwise use -only the ResourceManager type and only the GetString method. -This is appropriate when you want to profit from the tools for PO files, -but don't want to change an existing source code that uses -ResourceManager and don't (yet) need the GetPluralString method. - -
-
-Two examples, using the second API, are available in the `examples´ -directory: hello-csharp, hello-csharp-forms. - -
-
-Now, to make use of the API and define a shorthand for `GetString´, -there are two idioms that you can choose from: - -
- -
- - -In a unique class of your project, say `Util´, define a static variable -holding the ResourceManager instance: - - -
```
-public static GettextResourceManager MyResourceManager =
-  new GettextResourceManager("domain-name");
-
```
  - -All classes containing internationalized strings then contain - - -
```
-private static GettextResourceManager Res = Util.MyResourceManager;
-private static String _(String s) { return Res.GetString(s); }
-
```
  - -and the shorthand is used like this: - - -
```
-Console.WriteLine(_("Operation completed."));
-
```
  - -
- - -You add a class with a very short name, say `S´, containing just the -definition of the resource manager and of the shorthand: - - -
```
-public class S {
-  public static GettextResourceManager MyResourceManager =
-    new GettextResourceManager("domain-name");
-  public static String _(String s) {
-     return MyResourceManager.GetString(s);
-  }
-}
-
```
  - -and the shorthand is used like this: - - -
```
-Console.WriteLine(S._("Operation completed."));
-
```
  - -
- -
-Which of the two idioms you choose, will depend on whether copying two lines -of codes into every class is more acceptable in your project than a class -with a single-letter name. - -
- - -
13.5.13 GNU awk
-
- - - -
-
- -
RPMs -
-gawk 3.1 or newer - -
File extension -
-awk - -
String syntax -
-"abc" - -
gettext shorthand -
-_"abc" - -
gettext/ngettext functions -
-dcgettext, missing dcngettext in gawk-3.1.0 - -
textdomain -
-TEXTDOMAIN variable - -
bindtextdomain -
-bindtextdomain function - -
setlocale -
-automatic, but missing setlocale (LC_MESSAGES, "") in gawk-3.1.0 - -
Prerequisite -
---- - -
Use or emulate GNU gettext -
-use - -
Extractor -
-xgettext - -
Formatting with positions -
-printf "%2$d %1$d" (GNU awk only) - -
Portability -
-On platforms without gettext, no translation. On non-GNU awks, you must -define dcgettext, dcngettext and bindtextdomain -yourself. - -
po-mode marking -
---- -
- -
-An example is available in the `examples´ directory: hello-gawk. - -
- - -
13.5.14 Pascal - Free Pascal Compiler
-
- - - - -
-
- -
RPMs -
-fpk - -
File extension -
-pp, pas - -
String syntax -
-'abc' - -
gettext shorthand -
-automatic - -
gettext/ngettext functions -
----, use ResourceString data type instead - -
textdomain -
----, use TranslateResourceStrings function instead - -
bindtextdomain -
----, use TranslateResourceStrings function instead - -
setlocale -
-automatic, but uses only LANG, not LC_MESSAGES or LC_ALL - -
Prerequisite -
-{$mode delphi} or {$mode objfpc}
uses gettext; - -
Use or emulate GNU gettext -
-emulate partially - -
Extractor -
-ppc386 followed by xgettext or rstconv - -
Formatting with positions -
-uses sysutils;
format "%1:d %0:d" - -
Portability -
-? - -
po-mode marking -
---- -
- -
-The Pascal compiler has special support for the ResourceString data -type. It generates a .rst file. This is then converted to a -.pot file by use of xgettext or rstconv. At runtime, -a .mo file corresponding to translations of this .pot file -can be loaded using the TranslateResourceStrings function in the -gettext unit. - -
-
-An example is available in the `examples´ directory: hello-pascal. - -
- - -
13.5.15 wxWindows library
-
- - -
-
- -
RPMs -
-wxGTK, gettext - -
File extension -
-cpp - -
String syntax -
-"abc" - -
gettext shorthand -
-_("abc") - -
gettext/ngettext functions -
-wxLocale::GetString, wxGetTranslation - -
textdomain -
-wxLocale::AddCatalog - -
bindtextdomain -
-wxLocale::AddCatalogLookupPathPrefix - -
setlocale -
-wxLocale::Init, wxSetLocale - -
Prerequisite -
-#include <wx/intl.h> - -
Use or emulate GNU gettext -
-emulate, see include/wx/intl.h and src/common/intl.cpp - -
Extractor -
-xgettext - -
Formatting with positions -
---- - -
Portability -
-fully portable - -
po-mode marking -
-yes -
- - - -
13.5.16 YCP - YaST2 scripting language
-
- - - -
-
- -
RPMs -
-libycp, libycp-devel, yast2-core, yast2-core-devel - -
File extension -
-ycp - -
String syntax -
-"abc" - -
gettext shorthand -
-_("abc") - -
gettext/ngettext functions -
-_() with 1 or 3 arguments - -
textdomain -
-textdomain statement - -
bindtextdomain -
---- - -
setlocale -
---- - -
Prerequisite -
---- - -
Use or emulate GNU gettext -
-use - -
Extractor -
-xgettext - -
Formatting with positions -
-sformat "%2 %1" - -
Portability -
-fully portable - -
po-mode marking -
---- -
- -
-An example is available in the `examples´ directory: hello-ycp. - -
- - -
13.5.17 Tcl - Tk's scripting language
-
- - - -
-
- -
RPMs -
-tcl - -
File extension -
-tcl - -
String syntax -
-"abc" - -
gettext shorthand -
-[_ "abc"] - -
gettext/ngettext functions -
-::msgcat::mc - -
textdomain -
---- - -
bindtextdomain -
----, use ::msgcat::mcload instead - -
setlocale -
-automatic, uses LANG, but ignores LC_MESSAGES and LC_ALL - -
Prerequisite -
-package require msgcat -
proc _ {s} {return [::msgcat::mc $s]} - -
Use or emulate GNU gettext -
----, uses a Tcl specific message catalog format - -
Extractor -
-xgettext -k_ - -
Formatting with positions -
-format "%2\$d %1\$d" - -
Portability -
-fully portable - -
po-mode marking -
---- -
- -
-Two examples are available in the `examples´ directory: -hello-tcl, hello-tcl-tk. - -
-
-Before marking strings as internationalizable, substitutions of variables -into the string need to be converted to format applications. For -example, "file $filename not found" becomes -[format "file %s not found" $filename]. -Only after this is done, can the strings be marked and extracted. -After marking, this example becomes -[format [_ "file %s not found"] $filename] or -[msgcat::mc "file %s not found" $filename]. Note that the -msgcat::mc function implicitly calls format when more than one -argument is given. - -
- - -
13.5.18 Perl
-
- - -
-
- -
RPMs -
-perl - -
File extension -
-pl, PL, pm, cgi - -
String syntax -
- -
- "abc" - -
- 'abc' - -
- qq (abc) - -
- q (abc) - -
- qr /abc/ - -
- qx (/bin/date) - -
- /pattern match/ - -
- ?pattern match? - -
- s/substitution/operators/ - -
- $tied_hash{"message"} - -
- $tied_hash_reference->{"message"} - -
- etc., issue the command `man perlsyn´ for details - -
- -
gettext shorthand -
-__ (double underscore) - -
gettext/ngettext functions -
-gettext, dgettext, dcgettext, ngettext, -dngettext, dcngettext - -
textdomain -
-textdomain function - -
bindtextdomain -
-bindtextdomain function - -
bind_textdomain_codeset -
-bind_textdomain_codeset function - -
setlocale -
-Use setlocale (LC_ALL, ""); - -
Prerequisite -
-use POSIX; -
use Locale::TextDomain; (included in the package libintl-perl -which is available on the Comprehensive Perl Archive Network CPAN, -http://www.cpan.org/). - -
Use or emulate GNU gettext -
-platform dependent: gettext_pp emulates, gettext_xs uses GNU gettext - -
Extractor -
-xgettext -k__ -k\$__ -k%__ -k__x -k__n:1,2 -k__nx:1,2 -k__xn:1,2 -kN__ -k - -
Formatting with positions -
-Both kinds of format strings support formatting with positions. -
printf "%2\$d %1\$d", ... (requires Perl 5.8.0 or newer) -
__expand("[new] replaces [old]", old => $oldvalue, new => $newvalue) - -
Portability -
-The libintl-perl package is platform independent but is not -part of the Perl core. The programmer is responsible for -providing a dummy implementation of the required functions if the -package is not installed on the target system. - -
po-mode marking -
---- - -
Documentation -
-Included in libintl-perl, available on CPAN -(http://www.cpan.org/). - -
- -
-An example is available in the `examples´ directory: hello-perl. - -
-
- - -
-
-The xgettext parser backend for Perl differs significantly from -the parser backends for other programming languages, just as Perl -itself differs significantly from other programming languages. The -Perl parser backend offers many more string marking facilities than -the other backends but it also has some Perl specific limitations, the -worst probably being its imperfectness. - -
- - - -
13.5.18.1 General Problems Parsing Perl Code
- -
-It is often heard that only Perl can parse Perl. This is not true. -Perl cannot be parsed at all, it can only be executed. -Perl has various built-in ambiguities that can only be resolved at runtime. - -
-
-The following example may illustrate one common problem: - -
- -
```
-print gettext "Hello World!";
-
```
- -
-Although this example looks like a bullet-proof case of a function -invocation, it is not: - -
- -
```
-open gettext, ">testfile" or die;
-print gettext "Hello world!"
-
```
- -
-In this context, the string gettext looks more like a -file handle. But not necessarily: - -
- -
```
-use Locale::Messages qw (:libintl_h);
-open gettext ">testfile" or die;
-print gettext "Hello world!";
-
```
- -
-Now, the file is probably syntactically incorrect, provided that the module -Locale::Messages found first in the Perl include path exports a -function gettext. But what if the module -Locale::Messages really looks like this? - -
- -
```
-use vars qw (*gettext);
-
-1;
-
```
- -
-In this case, the string gettext will be interpreted as a file -handle again, and the above example will create a file `testfile´ -and write the string "Hello world!" into it. Even advanced -control flow analysis will not really help: - -
- -
```
-if (0.5 < rand) {
-   eval "use Sane";
-} else {
-   eval "use InSane";
-}
-print gettext "Hello world!";
-
```
- -
-If the module Sane exports a function gettext that does -what we expect, and the module InSane opens a file for writing -and associates the handle gettext with this output -stream, we are clueless again about what will happen at runtime. It is -completely unpredictable. The truth is that Perl has so many ways to -fill its symbol table at runtime that it is impossible to interpret a -particular piece of code without executing it. - -
-
-Of course, xgettext will not execute your Perl sources while -scanning for translatable strings, but rather use heuristics in order -to guess what you meant. - -
-
-Another problem is the ambiguity of the slash and the question mark. -Their interpretation depends on the context: - -
- -
```
-# A pattern match.
-print "OK\n" if /foobar/;
-
-# A division.
-print 1 / 2;
-
-# Another pattern match.
-print "OK\n" if ?foobar?;
-
-# Conditional.
-print $x ? "foo" : "bar";
-
```
- -
-The slash may either act as the division operator or introduce a -pattern match, whereas the question mark may act as the ternary -conditional operator or as a pattern match, too. Other programming -languages like awk present similar problems, but the consequences of a -misinterpretation are particularly nasty with Perl sources. In awk -for instance, a statement can never exceed one line and the parser -can recover from a parsing error at the next newline and interpret -the rest of the input stream correctly. Perl is different, as a -pattern match is terminated by the next appearance of the delimiter -(the slash or the question mark) in the input stream, regardless of -the semantic context. If a slash is really a division sign but -mis-interpreted as a pattern match, the rest of the input file is most -probably parsed incorrectly. - -
-
-If you find that xgettext fails to extract strings from -portions of your sources, you should therefore look out for slashes -and/or question marks preceding these sections. You may have come -across a bug in xgettext's Perl parser (and of course you -should report that bug). In the meantime you should consider to -reformulate your code in a manner less challenging to xgettext. - -
- - -
13.5.18.2 Which keywords will xgettext look for?
-
- - -
-
-Unless you instruct xgettext otherwise by invoking it with one -of the options --keyword or -k, it will recognize the -following keywords in your Perl sources: - -
- -
- gettext - -
- dgettext - -
- dcgettext - -
- ngettext:1,2 - -The first (singular) and the second (plural) argument will be -extracted. - -
- dngettext:1,2 - -The first (singular) and the second (plural) argument will be -extracted. - -
- dcngettext:1,2 - -The first (singular) and the second (plural) argument will be -extracted. - -
- gettext_noop - -
- %gettext - -The keys of lookups into the hash %gettext will be extracted. - -
- $gettext - -The keys of lookups into the hash reference $gettext will be extracted. - -
- - - -
13.5.18.3 How to Extract Hash Keys
-
- - -
-
-Translating messages at runtime is normally performed by looking up the -original string in the translation database and returning the -translated version. The "natural" Perl implementation is a hash -lookup, and, of course, xgettext supports such practice. - -
- -
```
-print __"Hello world!";
-print $__{"Hello world!"};
-print $__->{"Hello world!"};
-print $$__{"Hello world!"};
-
```
- -
-The above four lines all do the same thing. The Perl module -Locale::TextDomain exports by default a hash %__ that -is tied to the function __(). It also exports a reference -$__ to %__. - -
-
-If an argument to the xgettext option --keyword, -resp. -k starts with a percent sign, the rest of the keyword is -interpreted as the name of a hash. If it starts with a dollar -sign, the rest of the keyword is interpreted as a reference to a -hash. - -
-
-Note that you can omit the quotation marks (single or double) around -the hash key (almost) whenever Perl itself allows it: - -
- -
```
-print $gettext{Error};
-
```
- -
-The exact rule is: You can omit the surrounding quotes, when the hash -key is a valid C (!) identifier, i. e. when it starts with an -underscore or an ASCII letter and is followed by an arbitrary number -of underscores, ASCII letters or digits. Other Unicode characters -are not allowed, regardless of the use utf8 pragma. - -
- - -
13.5.18.4 What are Strings And Quote-like Expressions?
-
- - -
-
-Perl offers a plethora of different string constructs. Those that can -be used either as arguments to functions or inside braces for hash -lookups are generally supported by xgettext. - -
- -
- double-quoted strings - -
  - -
```
-print gettext "Hello World!";
-
```
  - -
- single-quoted strings - -
  - -
```
-print gettext 'Hello World!';
-
```
  - -
- the operator qq - -
  - -
```
-print gettext qq |Hello World!|;
-print gettext qq <E-mail: <guido\@imperia.net>>;
-
```
  - -The operator qq is fully supported. You can use arbitrary -delimiters, including the four bracketing delimiters (round, angle, -square, curly) that nest. - -
- the operator q - -
  - -
```
-print gettext q |Hello World!|;
-print gettext q <E-mail: <guido@imperia.net>>;
-
```
  - -The operator q is fully supported. You can use arbitrary -delimiters, including the four bracketing delimiters (round, angle, -square, curly) that nest. - -
- the operator qx - -
```
-print gettext qx ;LANGUAGE=C /bin/date;
-print gettext qx [/usr/bin/ls | grep '^[A-Z]*'];
+LIBS = ../lib/libsupport.a @LIBINTL@ @LIBS@
 
```
  -The operator qx is fully supported. You can use arbitrary -delimiters, including the four bracketing delimiters (round, angle, -square, curly) that nest. +
- + +You should also ensure that directory `intl/´ will be searched for +C preprocessor include files in all circumstances. So, you have to +manage so both `-I../intl´ and `-I$(top_srcdir)/intl´ will +be given to the C compiler. -The example is actually a useless use of gettext. It will -invoke the gettext function on the output of the command -specified with the qx operator. The feature was included -in order to make the interface consistent (the parser will extract -all strings and quote-like expressions). +
- -
- here documents +Your `dist:´ goal has to conform with others. Here is a +reasonable definition for it: -
```
-print gettext <<'EOF';
-program not found in $PATH
-EOF
-
-print ngettext <<EOF, <<"EOF";
-one file deleted
-EOF
-several files deleted
-EOF
+distdir = ../$(PACKAGE)-$(VERSION)/$(subdir)
+dist: Makefile $(DISTFILES)
+	for file in $(DISTFILES); do \
+	  ln $$file $(distdir) 2>/dev/null || cp -p $$file $(distdir) || exit 1; \
+	done
 
```
  -Here-documents are recognized. If the delimiter is enclosed in single -quotes, the string is not interpolated. If it is enclosed in double -quotes or has no quotes at all, the string is interpolated. - -Delimiters that start with a digit are not supported! - -
- - +

13.5.18.5 Invalid Uses Of String Interpolation

- +Note that if you are using GNU automake, `Makefile.in´ is +automatically generated from `Makefile.am´, and the first three +changes and the last change are not necessary. The remaining needed +`Makefile.am´ modifications are the following:

-Perl is capable of interpolating variables into strings. This offers -some nice features in localized programs but can also lead to -problems. -

-A common error is a construct like the following: +

+ +To make LOCALEDIR known to the program, add the following to +`Makefile.am´: -
```
-print gettext "This is the program $0!\n";
+<module>_CPPFLAGS = -DLOCALEDIR=\"$(localedir)\"
 
```
-
-Perl will interpolate at runtime the value of the variable $0 -into the argument of the gettext() function. Hence, this -argument is not a string constant but a variable argument ($0 -is a global variable that holds the name of the Perl script being -executed). The interpolation is performed by Perl before the string -argument is passed to gettext() and will therefore depend on -the name of the script which can only be determined at runtime. -Consequently, it is almost impossible that a translation can be looked -up at runtime (except if, by accident, the interpolated string is found -in the message catalog). - -
-
-The xgettext program will therefore terminate parsing with a fatal -error if it encounters a variable inside of an extracted string. In -general, this will happen for all kinds of string interpolations that -cannot be safely performed at compile time. If you absolutely know -what you are doing, you can always circumvent this behavior: +for each specific module or compilation unit, or -
```
-my $know_what_i_am_doing = "This is program $0!\n";
-print gettext $know_what_i_am_doing;
+AM_CPPFLAGS = -DLOCALEDIR=\"$(localedir)\"
 
```
-
-Since the parser only recognizes strings and quote-like expressions, -but not variables or other terms, the above construct will be -accepted. You will have to find another way, however, to let your -original string make it into your message catalog. - -
-
-If invoked with the option --extract-all, resp. -a, -variable interpolation will be accepted. Rationale: You will -generally use this option in order to prepare your sources for -internationalization. - -
-
-Please see the manual page `man perlop´ for details of strings and -quote-like expressions that are subject to interpolation and those -that are not. Safe interpolations (that will not lead to a fatal -error) are: - -
- -
- the escape sequences \t (tab, HT, TAB), \n +for all modules and compilation units together. Furthermore, add this +line to define `localedir´: -(newline, NL), \r (return, CR), \f (form feed, FF), -\b (backspace, BS), \a (alarm, bell, BEL), and \e -(escape, ESC). -
- octal chars, like \033 - -
  -Note that octal escapes in the range of 400-777 are translated into a -UTF-8 representation, regardless of the presence of the use utf8 pragma. - -
- hex chars, like \x1b +
```
+localedir = $(datadir)/locale
+
```
  -
- wide hex chars, like \x{263a} +
- -
  -Note that this escape is translated into a UTF-8 representation, -regardless of the presence of the use utf8 pragma. +To ensure that the final linking will use @LIBINTL@ or +@LTLIBINTL@ as a library, add the following to +`Makefile.am´: -
- control chars, like \c[ (CTRL-[) -
- named Unicode chars, like \N{LATIN CAPITAL LETTER C WITH CEDILLA} +
```
+<program>_LDADD = @LIBINTL@
+
```
  -
  -Note that this escape is translated into a UTF-8 representation, -regardless of the presence of the use utf8 pragma. -
+for each specific program, or -
-The following escapes are considered partially safe: -
+
```
+LDADD = @LIBINTL@
+
```
-
- \l lowercase next char +
- -
- \u uppercase next char +If you have an `intl/´ directory, whose contents is created by +gettextize, then to ensure that it will be searched for +C preprocessor include files in all circumstances, add something like +this to `Makefile.am´: -
- \L lowercase till \E -
- \U uppercase till \E +
```
+AM_CPPFLAGS = -I../intl -I$(top_srcdir)/intl
+
```
  -
- \E end case modification +

\Q quote non-word characters till \E - +

13.4.12 `gettext.h´ in `lib/´

-These escapes are only considered safe if the string consists of -ASCII characters only. Translation of characters outside the range -defined by ASCII is locale-dependent and can actually only be performed -at runtime; xgettext doesn't do these locale-dependent translations -at extraction time. + + +

-Except for the modifier \Q, these translations, albeit valid, -are generally useless and only obfuscate your sources. If a -translation can be safely performed at compile time you can just as -well write what you mean. +Internationalization of packages, as provided by GNU gettext, is +optional. It can be turned off in two situations:

+ +When the installer has specified `./configure --disable-nls´. This +can be useful when small binaries are more important than features, for +example when building utilities for boot diskettes. It can also be useful +in order to get some specific C compiler warnings about code quality with +some older versions of GCC (older than 3.0). -
13.5.18.6 Valid Uses Of String Interpolation
-
- +
+ +When the package does not include the intl/ subdirectory, and the +libintl.h header (with its associated libintl library, if any) is not +already installed on the system, it is preferrable that the package builds +without internationalization support, rather than to give a compilation +error. +

-Perl is often used to generate sources for other programming languages -or arbitrary file formats. Web applications that output HTML code -make a prominent example for such usage. +A C preprocessor macro can be used to detect these two cases. Usually, +when libintl.h was found and not explicitly disabled, the +ENABLE_NLS macro will be defined to 1 in the autoconf generated +configuration file (usually called `config.h´). In the two negative +situations, however, this macro will not be defined, thus it will evaluate +to 0 in C preprocessor expressions.

-You will often come across situations where you want to intersperse -code written in the target (programming) language with translatable -messages, like in the following HTML example: + +`gettext.h´ is a convenience header file for conditional use of +`<libintl.h>´, depending on the ENABLE_NLS macro. If +ENABLE_NLS is set, it includes `<libintl.h>´; otherwise it +defines no-op substitutes for the libintl.h functions. We recommend +the use of "gettext.h" over direct use of `<libintl.h>´, +so that portability to older systems is guaranteed and installers can +turn off internationalization if they want to. In the C code, you will +then write

-print gettext <<EOF;
-<h1>My Homepage</h1>
-<script language="JavaScript"><!--
-for (i = 0; i < 100; ++i) {
-    alert ("Thank you so much for visiting my homepage!");
-}
-//--></script>
-EOF
+#include "gettext.h"

-The parser will extract the entire here document, and it will appear -entirely in the resulting PO file, including the JavaScript snippet -embedded in the HTML code. If you exaggerate with constructs like -the above, you will run the risk that the translators of your package -will look out for a less challenging project. You should consider an -alternative expression here: +instead of

-print <<EOF;
-<h1>$gettext{"My Homepage"}</h1>
-<script language="JavaScript"><!--
-for (i = 0; i < 100; ++i) {
-    alert ("$gettext{'Thank you so much for visiting my homepage!'}");
-}
-//--></script>
-EOF
+#include <libintl.h>

-Only the translatable portions of the code will be extracted here, and -the resulting PO file will begrudgingly improve in terms of readability. +The location of gettext.h is usually in a directory containing +auxiliary include files. In many GNU packages, there is a directory +`lib/´ containing helper functions; `gettext.h´ fits there. +In other packages, it can go into the `src´ directory.

-You can interpolate hash lookups in all strings or quote-like -expressions that are subject to interpolation (see the manual page -`man perlop´ for details). Double interpolation is invalid, however: +Do not install the gettext.h file in public locations. Every +package that needs it should contain a copy of it on its own.

-# TRANSLATORS: Replace "the earth" with the name of your planet.
-print gettext qq{Welcome to $gettext->{"the earth"}};
-

13.5 Autoconf macros for use in `configure.in´

-The qq-quoted string is recognized as an argument to xgettext in -the first place, and checked for invalid variable interpolation. The -dollar sign of hash-dereferencing will therefore terminate the parser -with an "invalid interpolation" error. +

-It is valid to interpolate hash lookups in regular expressions: +GNU gettext installs macros for use in a package's +`configure.in´ or `configure.ac´. +See section `Introduction' in The Autoconf Manual. +The primary macro is, of course, AM_GNU_GETTEXT.

-if ($var =~ /$gettext{"the earth"}/) {
-   print gettext "Match!\n";
-}
-s/$gettext{"U. S. A."}/$gettext{"U. S. A."} $gettext{"(dial +0)"}/g;
-

13.5.1 AM_GNU_GETTEXT in `gettext.m4´

13.5.18.7 When To Use Parentheses

- + +The AM_GNU_GETTEXT macro tests for the presence of the GNU gettext +function family in either the C library or a separate libintl +library (shared or static libraries are both supported) or in the package's +`intl/´ directory. It also invokes AM_PO_SUBDIRS, thus preparing +the `po/´ directories of the package for building.

-In Perl, parentheses around function arguments are mostly optional. -xgettext will always assume that all -recognized keywords (except for hashs and hash references) are names -of properly prototyped functions, and will (hopefully) only require -parentheses where Perl itself requires them. All constructs in the -following example are therefore ok to use: +AM_GNU_GETTEXT accepts up to three optional arguments. The general +syntax is

-print gettext ("Hello World!\n");
-print gettext "Hello World!\n";
-print dgettext ($package => "Hello World!\n");
-print dgettext $package, "Hello World!\n";
-
-# The "fat comma" => turns the left-hand side argument into a
-# single-quoted string!
-print dgettext smellovision => "Hello World!\n";
-
-# The following assignment only works with prototyped functions.
-# Otherwise, the functions will act as "greedy" list operators and
-# eat up all following arguments.
-my $anonymous_hash = {
-   planet => gettext "earth",
-   cakes => ngettext "one cake", "several cakes", $n,
-   still => $works,
-};
-# The same without fat comma:
-my $other_hash = {
-   'planet', gettext "earth",
-   'cakes', ngettext "one cake", "several cakes", $n,
-   'still', $works,
-};
-
-# Parentheses are only significant for the first argument.
-print dngettext 'package', ("one cake", "several cakes", $n), $discarded;
+AM_GNU_GETTEXT([intlsymbol], [needsymbol], [intldir])

- - -

13.5.18.8 How To Grok with Long Lines

- +intlsymbol can be `external´ or `no-libtool´. The default +(if it is not specified or empty) is `no-libtool´. intlsymbol +should be `external´ for packages with no `intl/´ directory, +and `no-libtool´ for packages with an `intl/´ directory. In +the latter case, a static library $(top_builddir)/intl/libintl.a +will be created.

-The necessity of long messages can often lead to a cumbersome or -unreadable coding style. Perl has several options that may prevent -you from writing unreadable code, and -xgettext does its best to do likewise. This is where the dot -operator (the string concatenation operator) may come in handy: +If needsymbol is specified and is `need-ngettext´, then GNU +gettext implementations (in libc or libintl) without the ngettext() +function will be ignored. If needsymbol is specified and is +`need-formatstring-macros´, then GNU gettext implementations that don't +support the ISO C 99 `<inttypes.h>´ formatstring macros will be ignored. +Only one needsymbol can be specified. To specify more than one +requirement, just specify the strongest one among them. The hierarchy among +the various alternatives is as follows: `need-formatstring-macros´ +implies `need-ngettext´.

- -

-print gettext ("This is a very long"
-               . " message that is still"
-               . " readable, because"
-               . " it is split into"
-               . " multiple lines.\n");
-

-Perl is smart enough to concatenate these constant string fragments -into one long string at compile time, and so is -xgettext. You will only find one long message in the resulting -POT file. +intldir is used to find the intl libraries. If empty, the value +`$(top_builddir)/intl/´ is used.

-Note that the future Perl 6 will probably use the underscore -(`_´) as the string concatenation operator, and the dot -(`.´) for dereferencing. This new syntax is not yet supported by -xgettext. +The AM_GNU_GETTEXT macro determines whether GNU gettext is +available and should be used. If so, it sets the USE_NLS variable +to `yes´; it defines ENABLE_NLS to 1 in the autoconf +generated configuration file (usually called `config.h´); it sets +the variables LIBINTL and LTLIBINTL to the linker options +for use in a Makefile (LIBINTL for use without libtool, +LTLIBINTL for use with libtool); it adds an `-I´ option to +CPPFLAGS if necessary. In the negative case, it sets +USE_NLS to `no´; it sets LIBINTL and LTLIBINTL +to empty and doesn't change CPPFLAGS.

-If embedded newline characters are not an issue, or even desired, you -may also insert newline characters inside quoted strings wherever you -feel like it: +The complexities that AM_GNU_GETTEXT deals with are the following:

-print gettext ("<em>In HTML output
-embedded newlines are generally no
-problem, since adjacent whitespace
-is always rendered into a single
-space character.</em>");
-

- -

-You may also consider to use here documents: - -

-
```
-print gettext <<EOF;
-<em>In HTML output
-embedded newlines are generally no
-problem, since adjacent whitespace
-is always rendered into a single
-space character.</em>
-EOF
-
```
+ +Some operating systems have gettext in the C library, for example +glibc. Some have it in a separate library libintl. GNU libintl +might have been installed as part of the GNU gettext package. -
-Please do not forget, that the line breaks are real, i. e. they -translate into newline characters that will consequently show up in -the resulting POT file. +
-
+GNU libintl, if installed, is not necessarily already in the search +path (CPPFLAGS for the include file search path, LDFLAGS for +the library search path). +
-
13.5.18.9 Bugs, Pitfalls, And Things That Do Not Work
-
- +Except for glibc, the operating system's native gettext cannot +exploit the GNU mo files, doesn't have the necessary locale dependency +features, and cannot convert messages from the catalog's text encoding +to the user's locale encoding. -
-
-The foregoing sections should have proven that -xgettext is quite smart in extracting translatable strings from -Perl sources. Yet, some more or less exotic constructs that could be -expected to work, actually do not work. +
-
-
-One of the more relevant limitations can be found in the -implementation of variable interpolation inside quoted strings. Only -simple hash lookups can be used there: +GNU libintl, if installed, is not necessarily already in the +run time library search path. To avoid the need for setting an environment +variable like LD_LIBRARY_PATH, the macro adds the appropriate +run time search path options to the LIBINTL and LTLIBINTL +variables. This works on most systems, but not on some operating systems +with limited shared library support, like SCO. -
+

-print <<EOF;
-$gettext{"The dot operator"
-          . " does not work"
-          . "here!"}
-Likewise, you cannot @{[ gettext ("interpolate function calls") ]}
-inside quoted strings or quote-like expressions.
-EOF
-

+GNU libintl relies on POSIX/XSI iconv. The macro checks for +linker options needed to use iconv and appends them to the LIBINTL +and LTLIBINTL variables. +

-This is valid Perl code and will actually trigger invocations of the -gettext function at runtime. Yet, the Perl parser in -xgettext will fail to recognize the strings. A less obvious -example can be found in the interpolation of regular expressions: -

-s/<!--START_OF_WEEK-->/gettext ("Sunday")/e;
-

13.5.2 AM_GNU_GETTEXT_VERSION in `gettext.m4´

-The modifier e will cause the substitution to be interpreted as -an evaluable statement. Consequently, at runtime the function -gettext() is called, but again, the parser fails to extract the -string "Sunday". Use a temporary variable as a simple workaround if -you really happen to need this feature: + +The AM_GNU_GETTEXT_VERSION macro declares the version number of +the GNU gettext infrastructure that is used by the package.

- -

-my $sunday = gettext "Sunday";
-s/<!--START_OF_WEEK-->/$sunday/;
-

-Hash slices would also be handy but are not recognized: +The use of this macro is optional; only the autopoint program makes +use of it (see section 13.6 Integrating with CVS).

-my @weekdays = @gettext{'Sunday', 'Monday', 'Tuesday', 'Wednesday',
-                        'Thursday', 'Friday', 'Saturday'};
-# Or even:
-@weekdays = @gettext{qw (Sunday Monday Tuesday Wednesday Thursday
-                         Friday Saturday) };
-

-This is perfectly valid usage of the tied hash %gettext but the -strings are not recognized and therefore will not be extracted. +

13.5.3 AM_PO_SUBDIRS in `po.m4´

-Another caveat of the current version is its rudimentary support for -non-ASCII characters in identifiers. You may encounter serious -problems if you use identifiers with characters outside the range of -'A'-'Z', 'a'-'z', '0'-'9' and the underscore '_'. + +The AM_PO_SUBDIRS macro prepares the `po/´ directories of the +package for building. This macro should be used in internationalized +programs written in other programming languages than C, C++, Objective C, +for example sh, Python, Lisp. See section 15 Other Programming Languages for a list of programming languages that support localization +through PO files.

-Maybe some of these missing features will be implemented in future -versions, but since you can always make do without them at minimal effort, -these todos have very low priority. +The AM_PO_SUBDIRS macro determines whether internationalization +should be used. If so, it sets the USE_NLS variable to `yes´, +otherwise to `no´. It also determines the right values for Makefile +variables in each `po/´ directory.

-A nasty problem are brace format strings that already contain braces -as part of the normal text, for example the usage strings typically -encountered in programs: -

-die "usage: $0 {OPTIONS} FILENAME...\n";
-

13.5.4 AM_ICONV in `iconv.m4´

-If you want to internationalize this code with Perl brace format strings, -you will run into a problem: + +The AM_ICONV macro tests for the presence of the POSIX/XSI +iconv function family in either the C library or a separate +libiconv library. If found, it sets the am_cv_func_iconv +variable to `yes´; it defines HAVE_ICONV to 1 in the autoconf +generated configuration file (usually called `config.h´); it defines +ICONV_CONST to `const´ or to empty, depending on whether the +second argument of iconv() is of type `const char **´ or +`char **´; it sets the variables LIBICONV and +LTLIBICONV to the linker options for use in a Makefile +(LIBICONV for use without libtool, LTLIBICONV for use with +libtool); it adds an `-I´ option to CPPFLAGS if +necessary. If not found, it sets LIBICONV and LTLIBICONV to +empty and doesn't change CPPFLAGS.

- -

-die __x ("usage: {program} {OPTIONS} FILENAME...\n", program => $0);
-

-Whereas `{program}´ is a placeholder, `{OPTIONS}´ -is not and should probably be translated. Yet, there is no way to teach -the Perl parser in xgettext to recognize the first one, and leave -the other one alone. +The complexities that AM_ICONV deals with are the following:

-There are two possible work-arounds for this problem. If you are -sure that your program will run under Perl 5.8.0 or newer (these -Perl versions handle positional parameters in printf()) or -if you are sure that the translator will not have to reorder the arguments -in her translation -- for example if you have only one brace placeholder -in your string, or if it describes a syntax, like in this one --, you can -mark the string as no-perl-brace-format and use printf(): -

-
```
-# xgettext: no-perl-brace-format
-die sprintf ("usage: %s {OPTIONS} FILENAME...\n", $0);
-
```
+ +Some operating systems have iconv in the C library, for example +glibc. Some have it in a separate library libiconv, for example +OSF/1 or FreeBSD. Regardless of the operating system, GNU libiconv +might have been installed. In that case, it should be used instead of the +operating system's native iconv. -
-If you want to use the more portable Perl brace format, you will have to do -put placeholders in place of the literal braces: +
-
+GNU libiconv, if installed, is not necessarily already in the search +path (CPPFLAGS for the include file search path, LDFLAGS for +the library search path). -
```
-die __x ("usage: {program} {[}OPTIONS{]} FILENAME...\n",
-         program => $0, '[' => '{', ']' => '}');
-
```
+
-
-Perl brace format strings know no escaping mechanism. No matter how this -escaping mechanism looked like, it would either give the programmer a -hard time, make translating Perl brace format strings heavy-going, or -result in a performance penalty at runtime, when the format directives -get executed. Most of the time you will happily get along with -printf() for this special case. +GNU libiconv is binary incompatible with some operating system's +native iconv, for example on FreeBSD. Use of an `iconv.h´ +and `libiconv.so´ that don't fit together would produce program +crashes. -
+
+GNU libiconv, if installed, is not necessarily already in the +run time library search path. To avoid the need for setting an environment +variable like LD_LIBRARY_PATH, the macro adds the appropriate +run time search path options to the LIBICONV variable. This works +on most systems, but not on some operating systems with limited shared +library support, like SCO. +

13.5.19 PHP Hypertext Preprocessor

- +`iconv.m4´ is distributed with the GNU gettext package because +`gettext.m4´ relies on it.

RPMs -: -mod_php4, mod_php4-core, phpdoc - -
File extension -: -php, php3, php4 - -
String syntax -: -"abc", 'abc' - -
gettext shorthand -: -_("abc") - -
gettext/ngettext functions -: -gettext, dgettext, dcgettext; starting with PHP 4.2.0 -also ngettext, dngettext, dcngettext -
textdomain -: -textdomain function - -
bindtextdomain -: -bindtextdomain function - -
setlocale -: -Programmer must call setlocale (LC_ALL, "") -
Prerequisite -: ---- +
13.6 Integrating with CVS
-
Use or emulate GNU gettext -: -use +
+Many projects use CVS for distributed development, version control and +source backup. This section gives some advice how to manage the uses +of cvs, gettextize, autopoint and autoconf. -
Extractor -: -xgettext +
-
Formatting with positions -: -printf "%2\$d %1\$d" -
Portability -: -On platforms without gettext, the functions are not available. -
po-mode marking -: ---- -

13.6.1 Avoiding version mismatch in distributed development

-An example is available in the `examples´ directory: hello-php. +In a project development with multiple developers, using CVS, there +should be a single developer who occasionally - when there is desire to +upgrade to a new gettext version - runs gettextize and +performs the changes listed in section 13.4 Files You Must Create or Alter, and then commits +his changes to the CVS.

- - -

13.5.20 Pike

- +It is highly recommended that all developers on a project use the same +version of GNU gettext in the package. In other words, if a +developer runs gettextize, he should go the whole way, make the +necessary remaining changes and commit his changes to the CVS. +Otherwise the following damages will likely occur:

RPMs -

-roxen +

-
File extension -
-pike +Apparent version mismatch between developers. Since some gettext +specific portions in `configure.in´, `configure.ac´ and +Makefile.am, Makefile.in files depend on the gettext +version, the use of infrastructure files belonging to different +gettext versions can easily lead to build errors. -
String syntax -
-"abc" +
-
gettext shorthand -
---- +Hidden version mismatch. Such version mismatch can also lead to +malfunctioning of the package, that may be undiscovered by the developers. +The worst case of hidden version mismatch is that internationalization +of the package doesn't work at all. -
gettext/ngettext functions -
-gettext, dgettext, dcgettext +
-
textdomain -
-textdomain function +Release risks. All developers implicitly perform constant testing on +a package. This is important in the days and weeks before a release. +If the guy who makes the release tar files uses a different version +of GNU gettext than the other developers, the distribution will +be less well tested than if all had been using the same gettext +version. For example, it is possible that a platform specific bug goes +undiscovered due to this constellation. +

bindtextdomain -

-bindtextdomain function -

setlocale -

-setlocale function -

Prerequisite -

-import Locale.Gettext; +

13.6.2 Files to put under CVS version control

Use or emulate GNU gettext -

-use +

+There are basically three ways to deal with generated files in the +context of a CVS repository, such as `configure´ generated from +`configure.in´, parser.c generated from +parser.y, or po/Makefile.in.in autoinstalled by +gettextize or autopoint. -

Extractor -

---- +

Formatting with positions -

---- +

-
Portability -
-On platforms without gettext, the functions are not available. +All generated files are always committed into the repository. -
po-mode marking -
---- -

+All generated files are committed into the repository occasionally, +for example each time a release is made. + +

+Generated files are never committed into the repository. + -

13.5.21 GNU Compiler Collection sources

- +Each of these three approaches has different advantages and drawbacks.

RPMs -

-gcc +

-
File extension -
-c, h. +The advantage is that anyone can check out the CVS at any moment and +gets a working build. The drawbacks are: 1a. It requires some frequent +"cvs commit" actions by the maintainers. 1b. The repository grows in size +quite fast. -
String syntax -
-"abc" +
-
gettext shorthand -
-_("abc") +The advantage is that anyone can check out the CVS, and the usual +"./configure; make" will work. The drawbacks are: 2a. The one who +checks out the repository needs tools like GNU automake, +GNU autoconf, GNU m4 installed in his PATH; sometimes +he even needs particular versions of them. 2b. When a release is made +and a commit is made on the generated files, the other developers get +conflicts on the generated files after doing "cvs update". Although +these conflicts are easy to resolve, they are annoying. -
gettext/ngettext functions -
-gettext, dgettext, dcgettext, ngettext, -dngettext, dcngettext +
-
textdomain -
-textdomain function +The advantage is less work for the maintainers. The drawback is that +anyone who checks out the CVS not only needs tools like GNU automake, +GNU autoconf, GNU m4 installed in his PATH, but also that +he needs to perform a package specific pre-build step before being able +to "./configure; make". +

bindtextdomain -

-bindtextdomain function +

+For the first and second approach, all files modified or brought in +by the occasional gettextize invocation and update should be +committed into the CVS. -

setlocale -

-Programmer must call setlocale (LC_ALL, "") +

+For the third approach, the maintainer can omit from the CVS repository +all the files that gettextize mentions as "copy". Instead, he +adds to the `configure.in´ or `configure.ac´ a line of the +form -

Prerequisite -

-#include "intl.h" +

Use or emulate GNU gettext -

-Use +

+AM_GNU_GETTEXT_VERSION(0.15-pre0)
+

Extractor -

-xgettext -k_ +

+and adds to the package's pre-build script an invocation of +`autopoint´. For everyone who checks out the CVS, this +autopoint invocation will copy into the right place the +gettext infrastructure files that have been omitted from the CVS. -

Formatting with positions -

---- +

+The version number used as argument to AM_GNU_GETTEXT_VERSION is +the version of the gettext infrastructure that the package wants +to use. It is also the minimum version number of the `autopoint´ +program. So, if you write AM_GNU_GETTEXT_VERSION(0.11.5) then the +developers can have any version >= 0.11.5 installed; the package will work +with the 0.11.5 infrastructure in all developers' builds. When the +maintainer then runs gettextize from, say, version 0.12.1 on the package, +the occurrence of AM_GNU_GETTEXT_VERSION(0.11.5) will be changed +into AM_GNU_GETTEXT_VERSION(0.12.1), and all other developers that +use the CVS will henceforth need to have GNU gettext 0.12.1 or newer +installed. -

Portability -

-Uses autoconf macros +

po-mode marking -

-yes -

13.6.3 Invoking the `autopoint` Program

+ + -

13.6 Internationalizable Data

+autopoint [option]...
+

-Here is a list of other data formats which can be internationalized -using GNU gettext. +The autopoint program copies standard gettext infrastructure files +into a source package. It extracts from a macro call of the form +AM_GNU_GETTEXT_VERSION(version), found in the package's +`configure.in´ or `configure.ac´ file, the gettext version +used by the package, and copies the infrastructure files belonging to +this version into the package.

- -

13.6.1 POT - Portable Object Template

13.6.3.1 Options

RPMs +
`-f´: -gettext - -
File extension +
`--force´: -pot, po + + +Force overwriting of files that already exist. -
Extractor +
`-n´: -xgettext +
`--dry-run´ +: + + +Print modifications but don't perform them. All file copying actions that +autopoint would normally execute are inhibited and instead only +listed on standard output. +

13.6.2 Resource String Table

- +

13.6.3.2 Informative output

RPMs +
`--help´: -fpk + +Display this help and exit. -
File extension +
`--version´: -rst + +Output version information and exit. -
Extractor -: -xgettext, rstconv

+autopoint supports the GNU gettext versions from 0.10.35 to +the current one, 0.15-pre0. In order to apply autopoint to +a package using a gettext version newer than 0.15-pre0, you +need to install this same version of GNU gettext at least. + +

+In packages using GNU automake, an invocation of autopoint +should be followed by invocations of aclocal and then autoconf +and autoheader. The reason is that autopoint installs some +autoconf macro files, which are used by aclocal to create +`aclocal.m4´, and the latter is used by autoconf to create the +package's `configure´ script and by autoheader to create the +package's `config.h.in´ include file template. + +

+The name `autopoint´ is an abbreviation of `auto-po-intl-m4´; +the tool copies or updates mostly files in the `po´, `intl´, +`m4´ directories. +

13.6.3 Glade - GNOME user interface description

13.7 Creating a Distribution Tarball

RPMs -

-glade, libglade, glade2, libglade2, intltool +

+ + +In projects that use GNU automake, the usual commands for creating +a distribution tarball, `make dist´ or `make distcheck´, +automatically update the PO files as needed. -

File extension -

-glade, glade2 +

+If GNU automake is not used, the maintainer needs to perform this +update before making a release: -

Extractor -

-xgettext, libglade-xgettext, xml-i18n-extract, intltool-extract -

+ +

+$ ./configure
+$ (cd po; make update-po)
+$ make distclean
+

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_14.html b/gettext-tools/doc/gettext_14.html index 6a617c204..7b84329a6 100644 --- a/gettext-tools/doc/gettext_14.html +++ b/gettext-tools/doc/gettext_14.html @@ -1,189 +1,50 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - 14 Concluding Remarks +GNU gettext utilities - 14 The Installer's and Distributor's View -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

14 Concluding Remarks

- -

-We would like to conclude this GNU gettext manual by presenting -an history of the Translation Project so far. We finally give -a few pointers for those who want to do further research or readings -about Native Language Support matters. - -

- - - -

14.1 History of GNU `gettext`

- - -

-Internationalization concerns and algorithms have been informally -and casually discussed for years in GNU, sometimes around GNU -libc, maybe around the incoming Hurd, or otherwise -(nobody clearly remembers). And even then, when the work started for -real, this was somewhat independently of these previous discussions. - -

-This all began in July 1994, when Patrick D'Cruze had the idea and -initiative of internationalizing version 3.9.2 of GNU fileutils. -He then asked Jim Meyering, the maintainer, how to get those changes -folded into an official release. That first draft was full of -#ifdefs and somewhat disconcerting, and Jim wanted to find -nicer ways. Patrick and Jim shared some tries and experimentations -in this area. Then, feeling that this might eventually have a deeper -impact on GNU, Jim wanted to know what standards were, and contacted -Richard Stallman, who very quickly and verbally described an overall -design for what was meant to become glocale, at that time. - -

-Jim implemented glocale and got a lot of exhausting feedback -from Patrick and Richard, of course, but also from Mitchum DSouza -(who wrote a catgets-like package), Roland McGrath, maybe David -MacKenzie, François Pinard, and Paul Eggert, all pushing and -pulling in various directions, not always compatible, to the extent -that after a couple of test releases, glocale was torn apart. -In particular, Paul Eggert -- always keeping an eye on developments -in Solaris -- advocated the use of the gettext API over -glocale's catgets-based API. - -

-While Jim took some distance and time and became dad for a second -time, Roland wanted to get GNU libc internationalized, and -got Ulrich Drepper involved in that project. Instead of starting -from glocale, Ulrich rewrote something from scratch, but -more conformant to the set of guidelines who emerged out of the -glocale effort. Then, Ulrich got people from the previous -forum to involve themselves into this new project, and the switch -from glocale to what was first named msgutils, renamed -nlsutils, and later gettext, became officially accepted -by Richard in May 1995 or so. - -

-Let's summarize by saying that Ulrich Drepper wrote GNU gettext -in April 1995. The first official release of the package, including -PO mode, occurred in July 1995, and was numbered 0.7. Other people -contributed to the effort by providing a discussion forum around -Ulrich, writing little pieces of code, or testing. These are quoted -in the THANKS file which comes with the GNU gettext -distribution. - -

-While this was being done, François adapted half a dozen of -GNU packages to glocale first, then later to gettext, -putting them in pretest, so providing along the way an effective -user environment for fine tuning the evolving tools. He also took -the responsibility of organizing and coordinating the Translation -Project. After nearly a year of informal exchanges between people from -many countries, translator teams started to exist in May 1995, through -the creation and support by Patrick D'Cruze of twenty unmoderated -mailing lists for that many native languages, and two moderated -lists: one for reaching all teams at once, the other for reaching -all willing maintainers of internationalized free software packages. - -

-François also wrote PO mode in June 1995 with the collaboration -of Greg McGary, as a kind of contribution to Ulrich's package. -He also gave a hand with the GNU gettext Texinfo manual. - -

-In 1997, Ulrich Drepper released the GNU libc 2.0, which included the -gettext, textdomain and bindtextdomain functions. - -

14 The Installer's and Distributor's View

-In 2000, Ulrich Drepper added plural form handling (the ngettext -function) to GNU libc. Later, in 2001, he released GNU libc 2.2.x, -which is the first free C library with full internationalization support. + + + +

-Ulrich being quite busy in his role of General Maintainer of GNU libc, -he handed over the GNU gettext maintenance to Bruno Haible in -2000. Bruno added the plural form handling to the tools as well, added -support for UTF-8 and CJK locales, and wrote a few new tools for -manipulating PO files. +By default, packages fully using GNU gettext, internally, +are installed in such a way that they to allow translation of +messages. At configuration time, those packages should +automatically detect whether the underlying host system already provides +the GNU gettext functions. If not, +the GNU gettext library should be automatically prepared +and used. Installers may use special options at configuration +time for changing this behavior. The command `./configure +--with-included-gettext´ bypasses system gettext to +use the included GNU gettext instead, +while `./configure --disable-nls´ +produces programs totally unable to translate messages.

- - -

14.2 Related Readings

- - - -

-Eugene H. Dorr (`dorre@well.com´) maintains an interesting -bibliography on internationalization matters, called -Internationalization Reference List, which is available as: - -

-ftp://ftp.ora.com/pub/examples/nutshell/ujip/doc/i18n-books.txt
-

- -

-Michael Gschwind (`mike@vlsivie.tuwien.ac.at´) maintains a -Frequently Asked Questions (FAQ) list, entitled Programming for -Internationalisation. This FAQ discusses writing programs which -can handle different language conventions, character sets, etc.; -and is applicable to all character set encodings, with particular -emphasis on ISO 8859-1. It is regularly published in Usenet -groups `comp.unix.questions´, `comp.std.internat´, -`comp.software.international´, `comp.lang.c´, -`comp.windows.x´, `comp.std.c´, `comp.answers´ -and `news.answers´. The home location of this document is: - -

-ftp://ftp.vlsivie.tuwien.ac.at/pub/8bit/ISO-programming
-

- -

-Patrick D'Cruze (`pdcruze@li.org´) wrote a tutorial about NLS -matters, and Jochen Hein (`Hein@student.tu-clausthal.de´) took -over the responsibility of maintaining it. It may be found as: - -

-ftp://sunsite.unc.edu/pub/Linux/utils/nls/catalogs/Incoming/...
-     ...locale-tutorial-0.8.txt.gz
-

- -

-This site is mirrored in: - -

-ftp://ftp.ibp.fr/pub/linux/sunsite/
-

- -

-A French version of the same tutorial should be findable at: - -

-ftp://ftp.ibp.fr/pub/linux/french/docs/
-

-together with French translations of many Linux-related documents. + +Internationalized packages have usually many `ll.po´ +files. Unless +translations are disabled, all those available are installed together +with the package. However, the environment variable LINGUAS +may be set, prior to configuration, to limit the installed set. +LINGUAS should then contain a space separated list of two-letter +codes, stating which languages are allowed.

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_15.html b/gettext-tools/doc/gettext_15.html index 780df4812..02c25d02e 100644 --- a/gettext-tools/doc/gettext_15.html +++ b/gettext-tools/doc/gettext_15.html @@ -1,587 +1,3798 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - A Language Codes +GNU gettext utilities - 15 Other Programming Languages -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

A Language Codes

15 Other Programming Languages

+ +

+While the presentation of gettext focuses mostly on C and +implicitly applies to C++ as well, its scope is far broader than that: +Many programming languages, scripting languages and other textual data +like GUI resources or package descriptions can make use of the gettext +approach. + +

+ + + +

15.1 The Language Implementor's View

+ + + +

+All programming and scripting languages that have the notion of strings +are eligible to supporting gettext. Supporting gettext +means the following: + +

+ +

+ +You should add to the language a syntax for translatable strings. In +principle, a function call of gettext would do, but a shorthand +syntax helps keeping the legibility of internationalized programs. For +example, in C we use the syntax _("string"), and in GNU awk we use +the shorthand _"string". + +
+ +You should arrange that evaluation of such a translatable string at +runtime calls the gettext function, or performs equivalent +processing. + +
+ +Similarly, you should make the functions ngettext, +dcgettext, dcngettext available from within the language. +These functions are less often used, but are nevertheless necessary for +particular purposes: ngettext for correct plural handling, and +dcgettext and dcngettext for obeying other locale +environment variables than LC_MESSAGES, such as LC_TIME or +LC_MONETARY. For these latter functions, you need to make the +LC_* constants, available in the C header <locale.h>, +referenceable from within the language, usually either as enumeration +values or as strings. + +
+ +You should allow the programmer to designate a message domain, either by +making the textdomain function available from within the +language, or by introducing a magic variable called TEXTDOMAIN. +Similarly, you should allow the programmer to designate where to search +for message catalogs, by providing access to the bindtextdomain +function. + +
+ +You should either perform a setlocale (LC_ALL, "") call during +the startup of your language runtime, or allow the programmer to do so. +Remember that gettext will act as a no-op if the LC_MESSAGES and +LC_CTYPE locale facets are not both set. + +
+ +A programmer should have a way to extract translatable strings from a +program into a PO file. The GNU xgettext program is being +extended to support very different programming languages. Please +contact the GNU gettext maintainers to help them doing this. If +the string extractor is best integrated into your language's parser, GNU +xgettext can function as a front end to your string extractor. + +
+ +The language's library should have a string formatting facility where +the arguments of a format string are denoted by a positional number or a +name. This is needed because for some languages and some messages with +more than one substitutable argument, the translation will need to +output the substituted arguments in different order. See section 4.5 Special Comments preceding Keywords. + +
+ +If the language has more than one implementation, and not all of the +implementations use gettext, but the programs should be portable +across implementations, you should provide a no-i18n emulation, that +makes the other implementations accept programs written for yours, +without actually translating the strings. + +
+ +To help the programmer in the task of marking translatable strings, +which is usually performed using the Emacs PO mode, you are welcome to +contact the GNU gettext maintainers, so they can add support for +your language to `po-mode.el´. +

+ +

+On the implementation side, three approaches are possible, with +different effects on portability and copyright: + +

+ +

+ +You may integrate the GNU gettext's `intl/´ directory in +your package, as described in section 13 The Maintainer's View. This allows you to +have internationalization on all kinds of platforms. Note that when you +then distribute your package, it legally falls under the GNU General +Public License, and the GNU project will be glad about your contribution +to the Free Software pool. + +
+ +You may link against GNU gettext functions if they are found in +the C library. For example, an autoconf test for gettext() and +ngettext() will detect this situation. For the moment, this test +will succeed on GNU systems and not on other platforms. No severe +copyright restrictions apply. + +
+ +You may emulate or reimplement the GNU gettext functionality. +This has the advantage of full portability and no copyright +restrictions, but also the drawback that you have to reimplement the GNU +gettext features (such as the LANGUAGE environment +variable, the locale aliases database, the automatic charset conversion, +and plural handling). +

+ + + +

15.2 The Programmer's View

+ +

+For the programmer, the general procedure is the same as for the C +language. The Emacs PO mode supports other languages, and the GNU +xgettext string extractor recognizes other languages based on the +file extension or a command-line option. In some languages, +setlocale is not needed because it is already performed by the +underlying language runtime. + +

+ + +

15.3 The Translator's View

+ +

+The translator works exactly as in the C language case. The only +difference is that when translating format strings, she has to be aware +of the language's particular syntax for positional arguments in format +strings. + +

+ + + +

15.3.1 C Format Strings

+ +

+C format strings are described in POSIX (IEEE P1003.1 2001), section +XSH 3 fprintf(), +http://www.opengroup.org/onlinepubs/007904975/functions/fprintf.html. +See also the fprintf() manual page, +http://www.linuxvalley.it/encyclopedia/ldp/manpage/man3/printf.3.php, +http://informatik.fh-wuerzburg.de/student/i510/man/printf.html. + +

+Although format strings with positions that reorder arguments, such as + +

+ +

+"Only %2$d bytes free on '%1$s'."
+

+ +

+which is semantically equivalent to + +

+ +

+"'%s' has only %d bytes free."
+

+ + +

15.3.17 PHP Format Strings

+ +

+PHP format strings are described in the documentation of the PHP function +sprintf, in `phpdoc/manual/function.sprintf.html´ or +http://www.php.net/manual/en/function.sprintf.php. + +

+ + +

15.3.18 GCC internal Format Strings

+ +

+These format strings are used inside the GCC sources. In such a format +string, a directive starts with `%´, is optionally followed by a +size specifier `l´, an optional flag `+´, another optional flag +`#´, and is finished by a specifier: `%´ denotes a literal +percent sign, `c´ denotes a character, `s´ denotes a string, +`i´ and `d´ denote an integer, `o´, `u´, `x´ +denote an unsigned integer, `.*s´ denotes a string preceded by a +width specification, `H´ denotes a `location_t *´ pointer, +`D´ denotes a general declaration, `F´ denotes a function +declaration, `T´ denotes a type, `A´ denotes a function argument, +`C´ denotes a tree code, `E´ denotes an expression, `L´ +denotes a programming language, `O´ denotes a binary operator, +`P´ denotes a function parameter, `Q´ denotes an assignment +operator, `V´ denotes a const/volatile qualifier. + +

+ + +

15.3.19 Qt Format Strings

+ +

+Qt format strings are described in the documentation of the QString class +file:/usr/lib/qt-3.0.5/doc/html/qstring.html. +In summary, a directive consists of a `%´ followed by a digit. The same +directive cannot occur more than once in a format string. + +

+ + +

15.4 The Maintainer's View

+ +

+For the maintainer, the general procedure differs from the C language +case in two ways. + +

+ +

+ +For those languages that don't use GNU gettext, the `intl/´ directory +is not needed and can be omitted. This means that the maintainer calls the +gettextize program without the `--intl´ option, and that he +invokes the AM_GNU_GETTEXT autoconf macro via +`AM_GNU_GETTEXT([external])´. + +
+ +If only a single programming language is used, the XGETTEXT_OPTIONS +variable in `po/Makevars´ (see section 13.4.3 `Makevars´ in `po/´) should be adjusted to +match the xgettext options for that particular programming language. +If the package uses more than one programming language with gettext +support, it becomes necessary to change the POT file construction rule +in `po/Makefile.in.in´. It is recommended to make one xgettext +invocation per programming language, each with the options appropriate for +that language, and to combine the resulting files using msgcat. +

+ + + +

15.5 Individual Programming Languages

+ + + +

15.5.1 C, C++, Objective C

+ + +

RPMs +: +gcc, gpp, gobjc, glibc, gettext + +
File extension +: +For C: c, h. +
For C++: C, c++, cc, cxx, cpp, hpp. +
For Objective C: m. + +
String syntax +: +"abc" + +
gettext shorthand +: +_("abc") + +
gettext/ngettext functions +: +gettext, dgettext, dcgettext, ngettext, +dngettext, dcngettext + +
textdomain +: +textdomain function + +
bindtextdomain +: +bindtextdomain function + +
setlocale +: +Programmer must call setlocale (LC_ALL, "") + +
Prerequisite +: +#include <libintl.h> +
#include <locale.h> +
#define _(string) gettext (string) + +
Use or emulate GNU gettext +: +Use + +
Extractor +: +xgettext -k_ + +
Formatting with positions +: +fprintf "%2$d %1$d" +
In C++: autosprintf "%2$d %1$d" +(see section `Introduction' in GNU autosprintf) + +
Portability +: +autoconf (gettext.m4) and #if ENABLE_NLS + +
po-mode marking +: +yes +

+ +

+The following examples are available in the `examples´ directory: +hello-c, hello-c-gnome, hello-c++, hello-c++-qt, +hello-c++-kde, hello-c++-gnome, hello-objc, +hello-objc-gnustep, hello-objc-gnome. + +

+ + +

15.5.2 sh - Shell Script

+ + +

RPMs +: +bash, gettext + +
File extension +: +sh + +
String syntax +: +"abc", 'abc', abc + +
gettext shorthand +: +"`gettext \"abc\"`" + +
gettext/ngettext functions +: + + +gettext, ngettext programs +
eval_gettext, eval_ngettext shell functions + +
textdomain +: + +environment variable TEXTDOMAIN + +
bindtextdomain +: + +environment variable TEXTDOMAINDIR + +
setlocale +: +automatic + +
Prerequisite +: +. gettext.sh + +
Use or emulate GNU gettext +: +use + +
Extractor +: +xgettext + +
Formatting with positions +: +--- + +
Portability +: +fully portable + +
po-mode marking +: +--- +

+ +

+An example is available in the `examples´ directory: hello-sh. + +

+ + + +

15.5.2.1 Preparing Shell Scripts for Internationalization

+ + +

+Preparing a shell script for internationalization is conceptually similar +to the steps described in section 4 Preparing Program Sources. The concrete steps for shell +scripts are as follows. + +

+ +

+ +Insert the line + + +
```
+. gettext.sh
+
```
+ +near the top of the script. gettext.sh is a shell function library +that provides the functions +eval_gettext (see section 15.5.2.6 Invoking the eval_gettext function) and +eval_ngettext (see section 15.5.2.7 Invoking the eval_ngettext function). +You have to ensure that gettext.sh can be found in the PATH. + +
+ +Set and export the TEXTDOMAIN and TEXTDOMAINDIR environment +variables. Usually TEXTDOMAIN is the package or program name, and +TEXTDOMAINDIR is the absolute pathname corresponding to +$prefix/share/locale, where $prefix is the installation location. + + +
```
+TEXTDOMAIN=@PACKAGE@
+export TEXTDOMAIN
+TEXTDOMAINDIR=@LOCALEDIR@
+export TEXTDOMAINDIR
+
```
+ +
+ +Prepare the strings for translation, as described in section 4.2 Preparing Translatable Strings. + +
+ +Simplify translatable strings so that they don't contain command substitution +("`...`" or "$(...)"), variable access with defaulting (like +${variable-default}), access to positional arguments +(like $0, $1, ...) or highly volatile shell variables (like +$?). This can always be done through simple local code restructuring. +For example, + + +
```
+echo "Usage: $0 [OPTION] FILE..."
+
```
+ +becomes + + +
```
+program_name=$0
+echo "Usage: $program_name [OPTION] FILE..."
+
```
+ +Similarly, + + +
```
+echo "Remaining files: `ls | wc -l`"
+
```
+ +becomes + + +
```
+filecount="`ls | wc -l`"
+echo "Remaining files: $filecount"
+
```
+ +
+ +For each translatable string, change the output command `echo´ or +`$echo´ to `gettext´ (if the string contains no references to +shell variables) or to `eval_gettext´ (if it refers to shell variables), +followed by a no-argument `echo´ command (to account for the terminating +newline). Similarly, for cases with plural handling, replace a conditional +`echo´ command with an invocation of `ngettext´ or +`eval_ngettext´, followed by a no-argument `echo´ command. + +When doing this, you also need to add an extra backslash before the dollar +sign in references to shell variables, so that the `eval_gettext´ +function receives the translatable string before the variable values are +substituted into it. For example, + + +
```
+echo "Remaining files: $filecount"
+
```
+ +becomes + + +
```
+eval_gettext "Remaining files: \$filecount"; echo
+
```
+ +If the output command is not `echo´, you can make it use `echo´ +nevertheless, through the use of backquotes. However, note that inside +backquotes, backslashes must be doubled to be effective (because the +backquoting eats one level of backslashes). For example, assuming that +`error´ is a shell function that signals an error, + + +
```
+error "file not found: $filename"
+
```
+ +is first transformed into + + +
```
+error "`echo \"file not found: \$filename\"`"
+
```
+ +which then becomes + + +
```
+error "`eval_gettext \"file not found: \\\$filename\"`"
+
```
+ +

+ + + +

15.5.2.2 Contents of `gettext.sh`

+ +

+gettext.sh, contained in the run-time package of GNU gettext, provides +the following: + +

+ +

$echo + +The variable echo is set to a command that outputs its first argument +and a newline, without interpreting backslashes in the argument string. + +
eval_gettext + +See section 15.5.2.6 Invoking the eval_gettext function. + +
eval_ngettext + +See section 15.5.2.7 Invoking the eval_ngettext function. +

+ + + +

15.5.2.3 Invoking the `gettext` program

+ +

+ + + +

+gettext [option] [[textdomain] msgid]
+gettext [option] -s [msgid]...
+

+ +

+ +The gettext program displays the native language translation of a +textual message. + +

+Arguments + +

`-d textdomain´ +: +
`--domain=textdomain´ +: + + +Retrieve translated messages from textdomain. Usually a textdomain +corresponds to a package, a program, or a module of a program. + +
`-e´ +: + +Enable expansion of some escape sequences. This option is for compatibility +with the `echo´ program or shell built-in. The escape sequences +`\a´, `\b´, `\c´, `\f´, `\n´, `\r´, `\t´, +`\v´, `\\´, and `\´ followed by one to three octal digits, are +interpreted like the SystemV `echo´ program does. + +
`-E´ +: + +This option is only for compatibility with the `echo´ program or shell +built-in. It has no effect. + +
`-h´ +: +
`--help´ +: + + +Display this help and exit. + +
`-n´ +: + +Suppress trailing newline. By default, gettext adds a newline to +the output. + +
`-V´ +: +
`--version´ +: + + +Output version information and exit. + +
`[textdomain] msgid´ +: +Retrieve translated message corresponding to msgid from textdomain. + +

+ +

+If the textdomain parameter is not given, the domain is determined from +the environment variable TEXTDOMAIN. If the message catalog is not +found in the regular directory, another location can be specified with the +environment variable TEXTDOMAINDIR. + +

+When used with the -s option the program behaves like the `echo´ +command. But it does not simply copy its arguments to stdout. Instead those +messages found in the selected catalog are translated. + +

+ + +

15.5.2.4 Invoking the `ngettext` program

+ +

+ + + +

+ngettext [option] [textdomain] msgid msgid-plural count
+

+ +

+ +The ngettext program displays the native language translation of a +textual message whose grammatical form depends on a number. + +

+Arguments + +

`-d textdomain´ +: +
`--domain=textdomain´ +: + + +Retrieve translated messages from textdomain. Usually a textdomain +corresponds to a package, a program, or a module of a program. + +
`-e´ +: + +Enable expansion of some escape sequences. This option is for compatibility +with the `gettext´ program. The escape sequences +`\a´, `\b´, `\c´, `\f´, `\n´, `\r´, `\t´, +`\v´, `\\´, and `\´ followed by one to three octal digits, are +interpreted like the SystemV `echo´ program does. + +
`-E´ +: + +This option is only for compatibility with the `gettext´ program. It has +no effect. + +
`-h´ +: +
`--help´ +: + + +Display this help and exit. + +
`-V´ +: +
`--version´ +: + + +Output version information and exit. + +
`textdomain´ +: +Retrieve translated message from textdomain. + +
`msgid msgid-plural´ +: +Translate msgid (English singular) / msgid-plural (English plural). + +
`count´ +: +Choose singular/plural form based on this value. + +

+ +

+ + +

15.5.2.5 Invoking the `envsubst` program

+ +

+ + + +

+envsubst [option] [shell-format]
+

+ +

+ + + +The envsubst program substitutes the values of environment variables. + +

+Operation mode + +

`-v´ +: +
`--variables´ +: + + +Output the variables occurring in shell-format. + +

+ +

+Informative output + +

`-h´ +: +
`--help´ +: + + +Display this help and exit. + +
`-V´ +: +
`--version´ +: + + +Output version information and exit. + +

+ +

+In normal operation mode, standard input is copied to standard output, +with references to environment variables of the form $VARIABLE or +${VARIABLE} being replaced with the corresponding values. If a +shell-format is given, only those environment variables that are +referenced in shell-format are substituted; otherwise all environment +variables references occurring in standard input are substituted. + +

+These substitutions are a subset of the substitutions that a shell performs +on unquoted and double-quoted strings. Other kinds of substitutions done +by a shell, such as ${variable-default} or +$(command-list) or `command-list`, are not performed +by the envsubst program, due to security reasons. + +

+When --variables is used, standard input is ignored, and the output +consists of the environment variables that are referenced in +shell-format, one per line. + +

+ + +

15.5.2.6 Invoking the `eval_gettext` function

+ +

+ + +

+eval_gettext msgid
+

+ +

+ +This function outputs the native language translation of a textual message, +performing dollar-substitution on the result. Note that only shell variables +mentioned in msgid will be dollar-substituted in the result. + +

+ + +

15.5.2.7 Invoking the `eval_ngettext` function

+ +

+ + +

+eval_ngettext msgid msgid-plural count
+

+ +

+ +This function outputs the native language translation of a textual message +whose grammatical form depends on a number, performing dollar-substitution +on the result. Note that only shell variables mentioned in msgid or +msgid-plural will be dollar-substituted in the result. + +

+ + +

15.5.3 bash - Bourne-Again Shell Script

+ + +

+GNU bash 2.0 or newer has a special shorthand for translating a +string and substituting variable values in it: $"msgid". But +the use of this construct is discouraged, due to the security +holes it opens and due to its portability problems. + +

+The security holes of $"..." come from the fact that after looking up +the translation of the string, bash processes it like it processes +any double-quoted string: dollar and backquote processing, like `eval´ +does. + +

+ +

+ +In a locale whose encoding is one of BIG5, BIG5-HKSCS, GBK, GB18030, SHIFT_JIS, +JOHAB, some double-byte characters have a second byte whose value is +0x60. For example, the byte sequence \xe0\x60 is a single +character in these locales. Many versions of bash (all versions +up to bash-2.05, and newer versions on platforms without mbsrtowcs() +function) don't know about character boundaries and see a backquote character +where there is only a particular Chinese character. Thus it can start +executing part of the translation as a command list. This situation can occur +even without the translator being aware of it: if the translator provides +translations in the UTF-8 encoding, it is the gettext() function which +will, during its conversion from the translator's encoding to the user's +locale's encoding, produce the dangerous \x60 bytes. + +
+ +A translator could - voluntarily or inadvertantly - use backquotes +"`...`" or dollar-parentheses "$(...)" in her translations. +The enclosed strings would be executed as command lists by the shell. +

+ +

+The portability problem is that bash must be built with +internationalization support; this is normally not the case on systems +that don't have the gettext() function in libc. + +

+ + +

15.5.4 Python

+ + +

RPMs +: +python + +
File extension +: +py + +
String syntax +: +'abc', u'abc', r'abc', ur'abc', +
"abc", u"abc", r"abc", ur"abc", +
"'abc"', u"'abc"', r"'abc"', ur"'abc"', +
"""abc""", u"""abc""", r"""abc""", ur"""abc""" + +
gettext shorthand +: +_('abc') etc. + +
gettext/ngettext functions +: +gettext.gettext, gettext.dgettext, +gettext.ngettext, gettext.dngettext, +also ugettext, ungettext + +
textdomain +: +gettext.textdomain function, or +gettext.install(domain) function + +
bindtextdomain +: +gettext.bindtextdomain function, or +gettext.install(domain,localedir) function + +
setlocale +: +not used by the gettext emulation + +
Prerequisite +: +import gettext + +
Use or emulate GNU gettext +: +emulate + +
Extractor +: +xgettext + +
Formatting with positions +: +'...%(ident)d...' % { 'ident': value } + +
Portability +: +fully portable + +
po-mode marking +: +--- +

+ +

+An example is available in the `examples´ directory: hello-python. + +

+ + +

15.5.5 GNU clisp - Common Lisp

+ + + + +

RPMs +: +clisp 2.28 or newer + +
File extension +: +lisp + +
String syntax +: +"abc" + +
gettext shorthand +: +(_ "abc"), (ENGLISH "abc") + +
gettext/ngettext functions +: +i18n:gettext, i18n:ngettext + +
textdomain +: +i18n:textdomain + +
bindtextdomain +: +i18n:textdomaindir + +
setlocale +: +automatic + +
Prerequisite +: +--- + +
Use or emulate GNU gettext +: +use + +
Extractor +: +xgettext -k_ -kENGLISH + +
Formatting with positions +: +format "~1@*~D ~0@*~D" + +
Portability +: +On platforms without gettext, no translation. + +
po-mode marking +: +--- +

+ +

+An example is available in the `examples´ directory: hello-clisp. + +

+ + +

15.5.6 GNU clisp C sources

+ + +

RPMs +: +clisp + +
File extension +: +d + +
String syntax +: +"abc" + +
gettext shorthand +: +ENGLISH ? "abc" : "" +
GETTEXT("abc") +
GETTEXTL("abc") + +
gettext/ngettext functions +: +clgettext, clgettextl + +
textdomain +: +--- + +
bindtextdomain +: +--- + +
setlocale +: +automatic + +
Prerequisite +: +#include "lispbibl.c" + +
Use or emulate GNU gettext +: +use + +
Extractor +: +clisp-xgettext + +
Formatting with positions +: +fprintf "%2$d %1$d" + +
Portability +: +On platforms without gettext, no translation. + +
po-mode marking +: +--- +

+ + + +

15.5.7 Emacs Lisp

+ + +

RPMs +: +emacs, xemacs + +
File extension +: +el + +
String syntax +: +"abc" + +
gettext shorthand +: +(_"abc") + +
gettext/ngettext functions +: +gettext, dgettext (xemacs only) + +
textdomain +: +domain special form (xemacs only) + +
bindtextdomain +: +bind-text-domain function (xemacs only) + +
setlocale +: +automatic + +
Prerequisite +: +--- + +
Use or emulate GNU gettext +: +use + +
Extractor +: +xgettext + +
Formatting with positions +: +format "%2$d %1$d" + +
Portability +: +Only XEmacs. Without I18N3 defined at build time, no translation. + +
po-mode marking +: +--- +

+ + + +

15.5.8 librep

+ + +

RPMs +: +librep 0.15.3 or newer + +
File extension +: +jl + +
String syntax +: +"abc" + +
gettext shorthand +: +(_"abc") + +
gettext/ngettext functions +: +gettext + +
textdomain +: +textdomain function + +
bindtextdomain +: +bindtextdomain function + +
setlocale +: +--- + +
Prerequisite +: +(require 'rep.i18n.gettext) + +
Use or emulate GNU gettext +: +use + +
Extractor +: +xgettext + +
Formatting with positions +: +format "%2$d %1$d" + +
Portability +: +On platforms without gettext, no translation. + +
po-mode marking +: +--- +

+ +

+An example is available in the `examples´ directory: hello-librep. + +

+ + +

15.5.9 GNU guile - Scheme

+ + + +

RPMs +: +guile + +
File extension +: +scm + +
String syntax +: +"abc" + +
gettext shorthand +: +(_ "abc") + +
gettext/ngettext functions +: +gettext, ngettext + +
textdomain +: +textdomain + +
bindtextdomain +: +bindtextdomain + +
setlocale +: +(catch #t (lambda () (setlocale LC_ALL "")) (lambda args #f)) + +
Prerequisite +: +(use-modules (ice-9 format)) + +
Use or emulate GNU gettext +: +use + +
Extractor +: +xgettext -k_ + +
Formatting with positions +: +--- + +
Portability +: +On platforms without gettext, no translation. + +
po-mode marking +: +--- +

+ +

+An example is available in the `examples´ directory: hello-guile. + +

+ + +

15.5.10 GNU Smalltalk

+ + +

RPMs +: +smalltalk + +
File extension +: +st + +
String syntax +: +'abc' + +
gettext shorthand +: +NLS ? 'abc' + +
gettext/ngettext functions +: +LcMessagesDomain>>#at:, LcMessagesDomain>>#at:plural:with: + +
textdomain +: +LcMessages>>#domain:localeDirectory: (returns a LcMessagesDomain +object).
+Example: I18N Locale default messages domain: 'gettext' localeDirectory: /usr/local/share/locale' + +
bindtextdomain +: +LcMessages>>#domain:localeDirectory:, see above. + +
setlocale +: +Automatic if you use I18N Locale default. + +
Prerequisite +: +PackageLoader fileInPackage: 'I18N'! + +
Use or emulate GNU gettext +: +emulate + +
Extractor +: +xgettext + +
Formatting with positions +: +'%1 %2' bindWith: 'Hello' with: 'world' + +
Portability +: +fully portable + +
po-mode marking +: +--- +

+ +

+An example is available in the `examples´ directory: +hello-smalltalk. + +

+ + +

15.5.11 Java

+ + +

RPMs +: +java, java2 + +
File extension +: +java + +
String syntax +: +"abc" + +
gettext shorthand +: +_("abc") + +
gettext/ngettext functions +: +GettextResource.gettext, GettextResource.ngettext + +
textdomain +: +---, use ResourceBundle.getResource instead + +
bindtextdomain +: +---, use CLASSPATH instead + +
setlocale +: +automatic + +
Prerequisite +: +--- + +
Use or emulate GNU gettext +: +---, uses a Java specific message catalog format + +
Extractor +: +xgettext -k_ + +
Formatting with positions +: +MessageFormat.format "{1,number} {0,number}" + +
Portability +: +fully portable + +
po-mode marking +: +--- +

+ +

+Before marking strings as internationalizable, uses of the string +concatenation operator need to be converted to MessageFormat +applications. For example, "file "+filename+" not found" becomes +MessageFormat.format("file {0} not found", new Object[] { filename }). +Only after this is done, can the strings be marked and extracted. + +

+GNU gettext uses the native Java internationalization mechanism, namely +ResourceBundles. There are two formats of ResourceBundles: +.properties files and .class files. The .properties +format is a text file which the translators can directly edit, like PO +files, but which doesn't support plural forms. Whereas the .class +format is compiled from .java source code and can support plural +forms (provided it is accessed through an appropriate API, see below). + +

+To convert a PO file to a .properties file, the msgcat +program can be used with the option --properties-output. To convert +a .properties file back to a PO file, the msgcat program +can be used with the option --properties-input. All the tools +that manipulate PO files can work with .properties files as well, +if given the --properties-input and/or --properties-output +option. + +

+To convert a PO file to a ResourceBundle class, the msgfmt program +can be used with the option --java or --java2. To convert a +ResourceBundle back to a PO file, the msgunfmt program can be used +with the option --java. + +

+Two different programmatic APIs can be used to access ResourceBundles. +Note that both APIs work with all kinds of ResourceBundles, whether +GNU gettext generated classes, or other .class or .properties +files. + +

+ +

+ +The java.util.ResourceBundle API. + +In particular, its getString function returns a string translation. +Note that a missing translation yields a MissingResourceException. + +This has the advantage of being the standard API. And it does not require +any additional libraries, only the msgcat generated .properties +files or the msgfmt generated .class files. But it cannot do +plural handling, even if the resource was generated by msgfmt from +a PO file with plural handling. + +
+ +The gnu.gettext.GettextResource API. + +Reference documentation in Javadoc 1.1 style format +is in the javadoc1 directory and +in Javadoc 2 style format +in the javadoc2 directory. + +Its gettext function returns a string translation. Note that when +a translation is missing, the msgid argument is returned unchanged. + +This has the advantage of having the ngettext function for plural +handling. + + +To use this API, one needs the libintl.jar file which is part of +the GNU gettext package and distributed under the LGPL. +

+ +

+Three examples, using the second API, are available in the `examples´ +directory: hello-java, hello-java-awt, hello-java-swing. + +

+Now, to make use of the API and define a shorthand for `getString´, +there are two idioms that you can choose from: + +

+ +

+ +In a unique class of your project, say `Util´, define a static variable +holding the ResourceBundle instance: + + +

+public static ResourceBundle myResources =
+  ResourceBundle.getBundle("domain-name");
+

+ +All classes containing internationalized strings then contain + + +

+private static ResourceBundle res = Util.myResources;
+private static String _(String s) { return res.getString(s); }
+

+ +and the shorthand is used like this: + + +

+System.out.println(_("Operation completed."));
+

+ +

+ +You add a class with a very short name, say `S´, containing just the +definition of the resource bundle and of the shorthand: + + +

+public class S {
+  public static ResourceBundle myResources =
+    ResourceBundle.getBundle("domain-name");
+  public static String _(String s) {
+    return myResources.getString(s);
+  }
+}
+

+ +and the shorthand is used like this: + + +

+System.out.println(S._("Operation completed."));
+

+ +

+Which of the two idioms you choose, will depend on whether copying two lines +of codes into every class is more acceptable in your project than a class +with a single-letter name. + +

+ + +

15.5.12 C#

+ + +

RPMs +: +pnet, pnetlib 0.6.2 or newer, or mono 0.29 or newer + +
File extension +: +cs + +
String syntax +: +"abc", @"abc" + +
gettext shorthand +: +_("abc") + +
gettext/ngettext functions +: +GettextResourceManager.GetString, +GettextResourceManager.GetPluralString + +
textdomain +: +new GettextResourceManager(domain) + +
bindtextdomain +: +---, compiled message catalogs are located in subdirectories of the directory +containing the executable + +
setlocale +: +automatic + +
Prerequisite +: +--- + +
Use or emulate GNU gettext +: +---, uses a C# specific message catalog format + +
Extractor +: +xgettext -k_ + +
Formatting with positions +: +String.Format "{1} {0}" + +
Portability +: +fully portable + +
po-mode marking +: +--- +

+ +

+Before marking strings as internationalizable, uses of the string +concatenation operator need to be converted to String.Format +invocations. For example, "file "+filename+" not found" becomes +String.Format("file {0} not found", filename). +Only after this is done, can the strings be marked and extracted. + +

+GNU gettext uses the native C#/.NET internationalization mechanism, namely +the classes ResourceManager and ResourceSet. Applications +use the ResourceManager methods to retrieve the native language +translation of strings. An instance of ResourceSet is the in-memory +representation of a message catalog file. The ResourceManager loads +and accesses ResourceSet instances as needed to look up the +translations. + +

+There are two formats of ResourceSets that can be directly loaded by +the C# runtime: .resources files and .dll files. + +

+ +

+ +The .resources format is a binary file usually generated through the +resgen or monoresgen utility, but which doesn't support plural +forms. .resources files can also be embedded in .NET .exe files. +This only affects whether a file system access is performed to load the message +catalog; it doesn't affect the contents of the message catalog. + +
+ +On the other hand, the .dll format is a binary file that is compiled +from .cs source code and can support plural forms (provided it is +accessed through the GNU gettext API, see below). +

+ +

+Note that these .NET .dll and .exe files are not tied to a +particular platform; their file format and GNU gettext for C# can be used +on any platform. + +

+To convert a PO file to a .resources file, the msgfmt program +can be used with the option `--csharp-resources´. To convert a +.resources file back to a PO file, the msgunfmt program can be +used with the option `--csharp-resources´. You can also, in some cases, +use the resgen program (from the pnet package) or the +monoresgen program (from the mono/mcs package). These +programs can also convert a .resources file back to a PO file. But +beware: as of this writing (January 2004), the monoresgen converter is +quite buggy and the resgen converter ignores the encoding of the PO +files. + +

+To convert a PO file to a .dll file, the msgfmt program can be +used with the option --csharp. The result will be a .dll file +containing a subclass of GettextResourceSet, which itself is a subclass +of ResourceSet. To convert a .dll file containing a +GettextResourceSet subclass back to a PO file, the msgunfmt +program can be used with the option --csharp. + +

+The advantages of the .dll format over the .resources format +are: + +

+ +

+ +Freedom to localize: Users can add their own translations to an application +after it has been built and distributed. Whereas when the programmer uses +a ResourceManager constructor provided by the system, the set of +.resources files for an application must be specified when the +application is built and cannot be extended afterwards. + +
+ +Plural handling: A message catalog in .dll format supports the plural +handling function GetPluralString. Whereas .resources files can +only contain data and only support lookups that depend on a single string. + +
+ +The GettextResourceManager that loads the message catalogs in +.dll format also provides for inheritance on a per-message basis. +For example, in Austrian (de_AT) locale, translations from the German +(de) message catalog will be used for messages not found in the +Austrian message catalog. This has the consequence that the Austrian +translators need only translate those few messages for which the translation +into Austrian differs from the German one. Whereas when working with +.resources files, each message catalog must provide the translations +of all messages by itself. + +
+ +The GettextResourceManager that loads the message catalogs in +.dll format also provides for a fallback: The English msgid is +returned when no translation can be found. Whereas when working with +.resources files, a language-neutral .resources file must +explicitly be provided as a fallback. +

+ +

+On the side of the programmatic APIs, the programmer can use either the +standard ResourceManager API and the GNU GettextResourceManager +API. The latter is an extension of the former, because +GettextResourceManager is a subclass of ResourceManager. + +

+ +

+ +The System.Resources.ResourceManager API. + +This API works with resources in .resources format. + +The creation of the ResourceManager is done through + +
```
+  new ResourceManager(domainname, Assembly.GetExecutingAssembly())
+
```
+ + +The GetString function returns a string's translation. Note that this +function returns null when a translation is missing (i.e. not even found in +the fallback resource file). + +
+ +The GNU.Gettext.GettextResourceManager API. + +This API works with resources in .dll format. + +Reference documentation is in the +csharpdoc directory. + +The creation of the ResourceManager is done through + +
```
+  new GettextResourceManager(domainname)
+
```
+ +The GetString function returns a string's translation. Note that when +a translation is missing, the msgid argument is returned unchanged. + +The GetPluralString function returns a string translation with plural +handling, like the ngettext function in C. + + +To use this API, one needs the GNU.Gettext.dll file which is part of +the GNU gettext package and distributed under the LGPL. +

+ +

+You can also mix both approaches: use the +GNU.Gettext.GettextResourceManager constructor, but otherwise use +only the ResourceManager type and only the GetString method. +This is appropriate when you want to profit from the tools for PO files, +but don't want to change an existing source code that uses +ResourceManager and don't (yet) need the GetPluralString method. + +

+Two examples, using the second API, are available in the `examples´ +directory: hello-csharp, hello-csharp-forms. + +

+Now, to make use of the API and define a shorthand for `GetString´, +there are two idioms that you can choose from: + +

+ +

+ +In a unique class of your project, say `Util´, define a static variable +holding the ResourceManager instance: + + +

+public static GettextResourceManager MyResourceManager =
+  new GettextResourceManager("domain-name");
+

+ +All classes containing internationalized strings then contain + + +

+private static GettextResourceManager Res = Util.MyResourceManager;
+private static String _(String s) { return Res.GetString(s); }
+

+ +and the shorthand is used like this: + + +

+Console.WriteLine(_("Operation completed."));
+

+ +

+ +You add a class with a very short name, say `S´, containing just the +definition of the resource manager and of the shorthand: + + +

+public class S {
+  public static GettextResourceManager MyResourceManager =
+    new GettextResourceManager("domain-name");
+  public static String _(String s) {
+     return MyResourceManager.GetString(s);
+  }
+}
+

+ +and the shorthand is used like this: + + +

+Console.WriteLine(S._("Operation completed."));
+

+ +

+Which of the two idioms you choose, will depend on whether copying two lines +of codes into every class is more acceptable in your project than a class +with a single-letter name. + +

+ + +

15.5.13 GNU awk

+ + + +

RPMs +: +gawk 3.1 or newer + +
File extension +: +awk + +
String syntax +: +"abc" + +
gettext shorthand +: +_"abc" + +
gettext/ngettext functions +: +dcgettext, missing dcngettext in gawk-3.1.0 + +
textdomain +: +TEXTDOMAIN variable + +
bindtextdomain +: +bindtextdomain function + +
setlocale +: +automatic, but missing setlocale (LC_MESSAGES, "") in gawk-3.1.0 + +
Prerequisite +: +--- + +
Use or emulate GNU gettext +: +use + +
Extractor +: +xgettext + +
Formatting with positions +: +printf "%2$d %1$d" (GNU awk only) + +
Portability +: +On platforms without gettext, no translation. On non-GNU awks, you must +define dcgettext, dcngettext and bindtextdomain +yourself. + +
po-mode marking +: +--- +

+ +

+An example is available in the `examples´ directory: hello-gawk. + +

+ + +

15.5.14 Pascal - Free Pascal Compiler

+ + + + +

RPMs +: +fpk + +
File extension +: +pp, pas + +
String syntax +: +'abc' + +
gettext shorthand +: +automatic + +
gettext/ngettext functions +: +---, use ResourceString data type instead + +
textdomain +: +---, use TranslateResourceStrings function instead + +
bindtextdomain +: +---, use TranslateResourceStrings function instead + +
setlocale +: +automatic, but uses only LANG, not LC_MESSAGES or LC_ALL + +
Prerequisite +: +{$mode delphi} or {$mode objfpc}
uses gettext; + +
Use or emulate GNU gettext +: +emulate partially + +
Extractor +: +ppc386 followed by xgettext or rstconv + +
Formatting with positions +: +uses sysutils;
format "%1:d %0:d" + +
Portability +: +? + +
po-mode marking +: +--- +

+ +

+The Pascal compiler has special support for the ResourceString data +type. It generates a .rst file. This is then converted to a +.pot file by use of xgettext or rstconv. At runtime, +a .mo file corresponding to translations of this .pot file +can be loaded using the TranslateResourceStrings function in the +gettext unit. + +

+An example is available in the `examples´ directory: hello-pascal. + +

+ + +

15.5.15 wxWindows library

+ + +

RPMs +: +wxGTK, gettext + +
File extension +: +cpp + +
String syntax +: +"abc" + +
gettext shorthand +: +_("abc") + +
gettext/ngettext functions +: +wxLocale::GetString, wxGetTranslation + +
textdomain +: +wxLocale::AddCatalog + +
bindtextdomain +: +wxLocale::AddCatalogLookupPathPrefix + +
setlocale +: +wxLocale::Init, wxSetLocale + +
Prerequisite +: +#include <wx/intl.h> + +
Use or emulate GNU gettext +: +emulate, see include/wx/intl.h and src/common/intl.cpp + +
Extractor +: +xgettext + +
Formatting with positions +: +--- + +
Portability +: +fully portable + +
po-mode marking +: +yes +

+ + + +

15.5.16 YCP - YaST2 scripting language

+ + + +

RPMs +: +libycp, libycp-devel, yast2-core, yast2-core-devel + +
File extension +: +ycp + +
String syntax +: +"abc" + +
gettext shorthand +: +_("abc") + +
gettext/ngettext functions +: +_() with 1 or 3 arguments + +
textdomain +: +textdomain statement + +
bindtextdomain +: +--- + +
setlocale +: +--- + +
Prerequisite +: +--- + +
Use or emulate GNU gettext +: +use + +
Extractor +: +xgettext + +
Formatting with positions +: +sformat "%2 %1" + +
Portability +: +fully portable + +
po-mode marking +: +--- +

+ +

+An example is available in the `examples´ directory: hello-ycp. + +

+ + +

15.5.17 Tcl - Tk's scripting language

+ + + +

RPMs +: +tcl + +
File extension +: +tcl + +
String syntax +: +"abc" + +
gettext shorthand +: +[_ "abc"] + +
gettext/ngettext functions +: +::msgcat::mc + +
textdomain +: +--- + +
bindtextdomain +: +---, use ::msgcat::mcload instead + +
setlocale +: +automatic, uses LANG, but ignores LC_MESSAGES and LC_ALL + +
Prerequisite +: +package require msgcat +
proc _ {s} {return [::msgcat::mc $s]} + +
Use or emulate GNU gettext +: +---, uses a Tcl specific message catalog format + +
Extractor +: +xgettext -k_ + +
Formatting with positions +: +format "%2\$d %1\$d" + +
Portability +: +fully portable + +
po-mode marking +: +--- +

+ +

+Two examples are available in the `examples´ directory: +hello-tcl, hello-tcl-tk. + +

+Before marking strings as internationalizable, substitutions of variables +into the string need to be converted to format applications. For +example, "file $filename not found" becomes +[format "file %s not found" $filename]. +Only after this is done, can the strings be marked and extracted. +After marking, this example becomes +[format [_ "file %s not found"] $filename] or +[msgcat::mc "file %s not found" $filename]. Note that the +msgcat::mc function implicitly calls format when more than one +argument is given. + +

+ + +

15.5.18 Perl

+ + +

RPMs +

+perl + +

File extension +

+pl, PL, pm, cgi + +

String syntax +

+ +

"abc" + +
'abc' + +
qq (abc) + +
q (abc) + +
qr /abc/ + +
qx (/bin/date) + +
/pattern match/ + +
?pattern match? + +
s/substitution/operators/ + +
$tied_hash{"message"} + +
$tied_hash_reference->{"message"} + +
etc., issue the command `man perlsyn´ for details + +

+ +

gettext shorthand +

+__ (double underscore) + +

gettext/ngettext functions +

+gettext, dgettext, dcgettext, ngettext, +dngettext, dcngettext + +

textdomain +

+textdomain function + +

bindtextdomain +

+bindtextdomain function + +

bind_textdomain_codeset +

+bind_textdomain_codeset function + +

setlocale +

+Use setlocale (LC_ALL, ""); + +

Prerequisite +

+use POSIX; +
use Locale::TextDomain; (included in the package libintl-perl +which is available on the Comprehensive Perl Archive Network CPAN, +http://www.cpan.org/). + +

Use or emulate GNU gettext +

+platform dependent: gettext_pp emulates, gettext_xs uses GNU gettext + +

Extractor +

+xgettext -k__ -k\$__ -k%__ -k__x -k__n:1,2 -k__nx:1,2 -k__xn:1,2 -kN__ -k + +

Formatting with positions +

+Both kinds of format strings support formatting with positions. +
printf "%2\$d %1\$d", ... (requires Perl 5.8.0 or newer) +
__expand("[new] replaces [old]", old => $oldvalue, new => $newvalue) + +

Portability +

+The libintl-perl package is platform independent but is not +part of the Perl core. The programmer is responsible for +providing a dummy implementation of the required functions if the +package is not installed on the target system. + +

po-mode marking +

+--- + +

Documentation +

+Included in libintl-perl, available on CPAN +(http://www.cpan.org/). + +

+ +

+An example is available in the `examples´ directory: hello-perl. + +

+ + +

+The xgettext parser backend for Perl differs significantly from +the parser backends for other programming languages, just as Perl +itself differs significantly from other programming languages. The +Perl parser backend offers many more string marking facilities than +the other backends but it also has some Perl specific limitations, the +worst probably being its imperfectness. + +

+ + + +

15.5.18.1 General Problems Parsing Perl Code

+ +

+It is often heard that only Perl can parse Perl. This is not true. +Perl cannot be parsed at all, it can only be executed. +Perl has various built-in ambiguities that can only be resolved at runtime. + +

+The following example may illustrate one common problem: + +

+ +

+print gettext "Hello World!";
+

+ +

+Although this example looks like a bullet-proof case of a function +invocation, it is not: + +

+ +

+open gettext, ">testfile" or die;
+print gettext "Hello world!"
+

+ +

+In this context, the string gettext looks more like a +file handle. But not necessarily: + +

+ +

+use Locale::Messages qw (:libintl_h);
+open gettext ">testfile" or die;
+print gettext "Hello world!";
+

+ +

+Now, the file is probably syntactically incorrect, provided that the module +Locale::Messages found first in the Perl include path exports a +function gettext. But what if the module +Locale::Messages really looks like this? + +

+ +

+use vars qw (*gettext);
+
+1;
+

+ +

+In this case, the string gettext will be interpreted as a file +handle again, and the above example will create a file `testfile´ +and write the string "Hello world!" into it. Even advanced +control flow analysis will not really help: + +

+ +

+if (0.5 < rand) {
+   eval "use Sane";
+} else {
+   eval "use InSane";
+}
+print gettext "Hello world!";
+

+ +

+If the module Sane exports a function gettext that does +what we expect, and the module InSane opens a file for writing +and associates the handle gettext with this output +stream, we are clueless again about what will happen at runtime. It is +completely unpredictable. The truth is that Perl has so many ways to +fill its symbol table at runtime that it is impossible to interpret a +particular piece of code without executing it. + +

+Of course, xgettext will not execute your Perl sources while +scanning for translatable strings, but rather use heuristics in order +to guess what you meant. + +

+Another problem is the ambiguity of the slash and the question mark. +Their interpretation depends on the context: + +

+ +

+# A pattern match.
+print "OK\n" if /foobar/;
+
+# A division.
+print 1 / 2;
+
+# Another pattern match.
+print "OK\n" if ?foobar?;
+
+# Conditional.
+print $x ? "foo" : "bar";
+

+ +

+The slash may either act as the division operator or introduce a +pattern match, whereas the question mark may act as the ternary +conditional operator or as a pattern match, too. Other programming +languages like awk present similar problems, but the consequences of a +misinterpretation are particularly nasty with Perl sources. In awk +for instance, a statement can never exceed one line and the parser +can recover from a parsing error at the next newline and interpret +the rest of the input stream correctly. Perl is different, as a +pattern match is terminated by the next appearance of the delimiter +(the slash or the question mark) in the input stream, regardless of +the semantic context. If a slash is really a division sign but +mis-interpreted as a pattern match, the rest of the input file is most +probably parsed incorrectly. + +

+If you find that xgettext fails to extract strings from +portions of your sources, you should therefore look out for slashes +and/or question marks preceding these sections. You may have come +across a bug in xgettext's Perl parser (and of course you +should report that bug). In the meantime you should consider to +reformulate your code in a manner less challenging to xgettext. + +

+ + +

15.5.18.2 Which keywords will xgettext look for?

+ + +

+Unless you instruct xgettext otherwise by invoking it with one +of the options --keyword or -k, it will recognize the +following keywords in your Perl sources: + +

+ +

gettext + +
dgettext + +
dcgettext + +
ngettext:1,2 + +The first (singular) and the second (plural) argument will be +extracted. + +
dngettext:1,2 + +The first (singular) and the second (plural) argument will be +extracted. + +
dcngettext:1,2 + +The first (singular) and the second (plural) argument will be +extracted. + +
gettext_noop + +
%gettext + +The keys of lookups into the hash %gettext will be extracted. + +
$gettext + +The keys of lookups into the hash reference $gettext will be extracted. + +

+ + + +

15.5.18.3 How to Extract Hash Keys

+ + +

+Translating messages at runtime is normally performed by looking up the +original string in the translation database and returning the +translated version. The "natural" Perl implementation is a hash +lookup, and, of course, xgettext supports such practice. + +

+ +

+print __"Hello world!";
+print $__{"Hello world!"};
+print $__->{"Hello world!"};
+print $$__{"Hello world!"};
+

+ +

+The above four lines all do the same thing. The Perl module +Locale::TextDomain exports by default a hash %__ that +is tied to the function __(). It also exports a reference +$__ to %__. + +

+If an argument to the xgettext option --keyword, +resp. -k starts with a percent sign, the rest of the keyword is +interpreted as the name of a hash. If it starts with a dollar +sign, the rest of the keyword is interpreted as a reference to a +hash. + +

+Note that you can omit the quotation marks (single or double) around +the hash key (almost) whenever Perl itself allows it: + +

+ +

+print $gettext{Error};
+

+ +

+The exact rule is: You can omit the surrounding quotes, when the hash +key is a valid C (!) identifier, i. e. when it starts with an +underscore or an ASCII letter and is followed by an arbitrary number +of underscores, ASCII letters or digits. Other Unicode characters +are not allowed, regardless of the use utf8 pragma. + +

+ + +

15.5.18.4 What are Strings And Quote-like Expressions?

+ + +

+Perl offers a plethora of different string constructs. Those that can +be used either as arguments to functions or inside braces for hash +lookups are generally supported by xgettext. + +

+ +

double-quoted strings + +
+ +
```
+print gettext "Hello World!";
+
```
+ +
single-quoted strings + +
+ +
```
+print gettext 'Hello World!';
+
```
+ +
the operator qq + +
+ +
```
+print gettext qq |Hello World!|;
+print gettext qq <E-mail: <guido\@imperia.net>>;
+
```
+ +The operator qq is fully supported. You can use arbitrary +delimiters, including the four bracketing delimiters (round, angle, +square, curly) that nest. + +
the operator q + +
+ +
```
+print gettext q |Hello World!|;
+print gettext q <E-mail: <guido@imperia.net>>;
+
```
+ +The operator q is fully supported. You can use arbitrary +delimiters, including the four bracketing delimiters (round, angle, +square, curly) that nest. + +
the operator qx + +
+ +
```
+print gettext qx ;LANGUAGE=C /bin/date;
+print gettext qx [/usr/bin/ls | grep '^[A-Z]*'];
+
```
+ +The operator qx is fully supported. You can use arbitrary +delimiters, including the four bracketing delimiters (round, angle, +square, curly) that nest. + +The example is actually a useless use of gettext. It will +invoke the gettext function on the output of the command +specified with the qx operator. The feature was included +in order to make the interface consistent (the parser will extract +all strings and quote-like expressions). + +
here documents + +
+ +
```
+print gettext <<'EOF';
+program not found in $PATH
+EOF
+
+print ngettext <<EOF, <<"EOF";
+one file deleted
+EOF
+several files deleted
+EOF
+
```
+ +Here-documents are recognized. If the delimiter is enclosed in single +quotes, the string is not interpolated. If it is enclosed in double +quotes or has no quotes at all, the string is interpolated. + +Delimiters that start with a digit are not supported! + +

+ + + +

15.5.18.5 Invalid Uses Of String Interpolation

+ + +

+Perl is capable of interpolating variables into strings. This offers +some nice features in localized programs but can also lead to +problems. + +

+A common error is a construct like the following: + +

+ +

+print gettext "This is the program $0!\n";
+

+ +

+Perl will interpolate at runtime the value of the variable $0 +into the argument of the gettext() function. Hence, this +argument is not a string constant but a variable argument ($0 +is a global variable that holds the name of the Perl script being +executed). The interpolation is performed by Perl before the string +argument is passed to gettext() and will therefore depend on +the name of the script which can only be determined at runtime. +Consequently, it is almost impossible that a translation can be looked +up at runtime (except if, by accident, the interpolated string is found +in the message catalog). + +

+The xgettext program will therefore terminate parsing with a fatal +error if it encounters a variable inside of an extracted string. In +general, this will happen for all kinds of string interpolations that +cannot be safely performed at compile time. If you absolutely know +what you are doing, you can always circumvent this behavior: + +

+ +

+my $know_what_i_am_doing = "This is program $0!\n";
+print gettext $know_what_i_am_doing;
+

+ +

+Since the parser only recognizes strings and quote-like expressions, +but not variables or other terms, the above construct will be +accepted. You will have to find another way, however, to let your +original string make it into your message catalog. + +

+If invoked with the option --extract-all, resp. -a, +variable interpolation will be accepted. Rationale: You will +generally use this option in order to prepare your sources for +internationalization. + +

+Please see the manual page `man perlop´ for details of strings and +quote-like expressions that are subject to interpolation and those +that are not. Safe interpolations (that will not lead to a fatal +error) are: + +

+ +

the escape sequences \t (tab, HT, TAB), \n + +(newline, NL), \r (return, CR), \f (form feed, FF), +\b (backspace, BS), \a (alarm, bell, BEL), and \e +(escape, ESC). + +
octal chars, like \033 + +
+Note that octal escapes in the range of 400-777 are translated into a +UTF-8 representation, regardless of the presence of the use utf8 pragma. + +
hex chars, like \x1b + +
wide hex chars, like \x{263a} + +
+Note that this escape is translated into a UTF-8 representation, +regardless of the presence of the use utf8 pragma. + +
control chars, like \c[ (CTRL-[) + +
named Unicode chars, like \N{LATIN CAPITAL LETTER C WITH CEDILLA} + +
+Note that this escape is translated into a UTF-8 representation, +regardless of the presence of the use utf8 pragma. +

+ +

+The following escapes are considered partially safe: + +

+ +

\l lowercase next char + +
\u uppercase next char + +
\L lowercase till \E + +
\U uppercase till \E + +
\E end case modification + +
\Q quote non-word characters till \E + +

+ +

+These escapes are only considered safe if the string consists of +ASCII characters only. Translation of characters outside the range +defined by ASCII is locale-dependent and can actually only be performed +at runtime; xgettext doesn't do these locale-dependent translations +at extraction time. + +

+Except for the modifier \Q, these translations, albeit valid, +are generally useless and only obfuscate your sources. If a +translation can be safely performed at compile time you can just as +well write what you mean. + +

+ + +

15.5.18.6 Valid Uses Of String Interpolation

+ + +

+Perl is often used to generate sources for other programming languages +or arbitrary file formats. Web applications that output HTML code +make a prominent example for such usage. + +

+You will often come across situations where you want to intersperse +code written in the target (programming) language with translatable +messages, like in the following HTML example: + +

+ +

+print gettext <<EOF;
+<h1>My Homepage</h1>
+<script language="JavaScript"><!--
+for (i = 0; i < 100; ++i) {
+    alert ("Thank you so much for visiting my homepage!");
+}
+//--></script>
+EOF
+

+ +

+The parser will extract the entire here document, and it will appear +entirely in the resulting PO file, including the JavaScript snippet +embedded in the HTML code. If you exaggerate with constructs like +the above, you will run the risk that the translators of your package +will look out for a less challenging project. You should consider an +alternative expression here: + +

+ +

+print <<EOF;
+<h1>$gettext{"My Homepage"}</h1>
+<script language="JavaScript"><!--
+for (i = 0; i < 100; ++i) {
+    alert ("$gettext{'Thank you so much for visiting my homepage!'}");
+}
+//--></script>
+EOF
+

+ +

+Only the translatable portions of the code will be extracted here, and +the resulting PO file will begrudgingly improve in terms of readability. + +

+You can interpolate hash lookups in all strings or quote-like +expressions that are subject to interpolation (see the manual page +`man perlop´ for details). Double interpolation is invalid, however: + +

+ +

+# TRANSLATORS: Replace "the earth" with the name of your planet.
+print gettext qq{Welcome to $gettext->{"the earth"}};
+

+ +

+The qq-quoted string is recognized as an argument to xgettext in +the first place, and checked for invalid variable interpolation. The +dollar sign of hash-dereferencing will therefore terminate the parser +with an "invalid interpolation" error. + +

+It is valid to interpolate hash lookups in regular expressions: + +

+ +

+if ($var =~ /$gettext{"the earth"}/) {
+   print gettext "Match!\n";
+}
+s/$gettext{"U. S. A."}/$gettext{"U. S. A."} $gettext{"(dial +0)"}/g;
+

+ + + +

15.5.18.7 When To Use Parentheses

+ + +

+In Perl, parentheses around function arguments are mostly optional. +xgettext will always assume that all +recognized keywords (except for hashs and hash references) are names +of properly prototyped functions, and will (hopefully) only require +parentheses where Perl itself requires them. All constructs in the +following example are therefore ok to use: + +

+ +

+print gettext ("Hello World!\n");
+print gettext "Hello World!\n";
+print dgettext ($package => "Hello World!\n");
+print dgettext $package, "Hello World!\n";
+
+# The "fat comma" => turns the left-hand side argument into a
+# single-quoted string!
+print dgettext smellovision => "Hello World!\n";
+
+# The following assignment only works with prototyped functions.
+# Otherwise, the functions will act as "greedy" list operators and
+# eat up all following arguments.
+my $anonymous_hash = {
+   planet => gettext "earth",
+   cakes => ngettext "one cake", "several cakes", $n,
+   still => $works,
+};
+# The same without fat comma:
+my $other_hash = {
+   'planet', gettext "earth",
+   'cakes', ngettext "one cake", "several cakes", $n,
+   'still', $works,
+};
+
+# Parentheses are only significant for the first argument.
+print dngettext 'package', ("one cake", "several cakes", $n), $discarded;
+

+ + + +

15.5.18.8 How To Grok with Long Lines

+ + +

+The necessity of long messages can often lead to a cumbersome or +unreadable coding style. Perl has several options that may prevent +you from writing unreadable code, and +xgettext does its best to do likewise. This is where the dot +operator (the string concatenation operator) may come in handy: + +

+ +

+print gettext ("This is a very long"
+               . " message that is still"
+               . " readable, because"
+               . " it is split into"
+               . " multiple lines.\n");
+

+ +

+Perl is smart enough to concatenate these constant string fragments +into one long string at compile time, and so is +xgettext. You will only find one long message in the resulting +POT file. + +

+Note that the future Perl 6 will probably use the underscore +(`_´) as the string concatenation operator, and the dot +(`.´) for dereferencing. This new syntax is not yet supported by +xgettext. + +

+If embedded newline characters are not an issue, or even desired, you +may also insert newline characters inside quoted strings wherever you +feel like it: + +

+ +

+print gettext ("<em>In HTML output
+embedded newlines are generally no
+problem, since adjacent whitespace
+is always rendered into a single
+space character.</em>");
+

+ +

+You may also consider to use here documents: + +

+ +

+print gettext <<EOF;
+<em>In HTML output
+embedded newlines are generally no
+problem, since adjacent whitespace
+is always rendered into a single
+space character.</em>
+EOF
+

+ +

+Please do not forget, that the line breaks are real, i. e. they +translate into newline characters that will consequently show up in +the resulting POT file. + +

+ + +

15.5.18.9 Bugs, Pitfalls, And Things That Do Not Work

+ + +

+The foregoing sections should have proven that +xgettext is quite smart in extracting translatable strings from +Perl sources. Yet, some more or less exotic constructs that could be +expected to work, actually do not work. + +

+One of the more relevant limitations can be found in the +implementation of variable interpolation inside quoted strings. Only +simple hash lookups can be used there: + +

+ +

+print <<EOF;
+$gettext{"The dot operator"
+          . " does not work"
+          . "here!"}
+Likewise, you cannot @{[ gettext ("interpolate function calls") ]}
+inside quoted strings or quote-like expressions.
+EOF
+

+ +

+This is valid Perl code and will actually trigger invocations of the +gettext function at runtime. Yet, the Perl parser in +xgettext will fail to recognize the strings. A less obvious +example can be found in the interpolation of regular expressions: + +

+ +

+s/<!--START_OF_WEEK-->/gettext ("Sunday")/e;
+

+ +

+The modifier e will cause the substitution to be interpreted as +an evaluable statement. Consequently, at runtime the function +gettext() is called, but again, the parser fails to extract the +string "Sunday". Use a temporary variable as a simple workaround if +you really happen to need this feature: + +

+ +

+my $sunday = gettext "Sunday";
+s/<!--START_OF_WEEK-->/$sunday/;
+

+ +

+Hash slices would also be handy but are not recognized: + +

+ +

+my @weekdays = @gettext{'Sunday', 'Monday', 'Tuesday', 'Wednesday',
+                        'Thursday', 'Friday', 'Saturday'};
+# Or even:
+@weekdays = @gettext{qw (Sunday Monday Tuesday Wednesday Thursday
+                         Friday Saturday) };
+

+ +

+This is perfectly valid usage of the tied hash %gettext but the +strings are not recognized and therefore will not be extracted. + +

+Another caveat of the current version is its rudimentary support for +non-ASCII characters in identifiers. You may encounter serious +problems if you use identifiers with characters outside the range of +'A'-'Z', 'a'-'z', '0'-'9' and the underscore '_'. + +

+Maybe some of these missing features will be implemented in future +versions, but since you can always make do without them at minimal effort, +these todos have very low priority. + +

+A nasty problem are brace format strings that already contain braces +as part of the normal text, for example the usage strings typically +encountered in programs: + +

+ +

+die "usage: $0 {OPTIONS} FILENAME...\n";
+

- - +If you want to internationalize this code with Perl brace format strings, +you will run into a problem: + +

+ +

+die __x ("usage: {program} {OPTIONS} FILENAME...\n", program => $0);
+

+ +

+Whereas `{program}´ is a placeholder, `{OPTIONS}´ +is not and should probably be translated. Yet, there is no way to teach +the Perl parser in xgettext to recognize the first one, and leave +the other one alone. + +

+There are two possible work-arounds for this problem. If you are +sure that your program will run under Perl 5.8.0 or newer (these +Perl versions handle positional parameters in printf()) or +if you are sure that the translator will not have to reorder the arguments +in her translation -- for example if you have only one brace placeholder +in your string, or if it describes a syntax, like in this one --, you can +mark the string as no-perl-brace-format and use printf(): + +

+ +

+# xgettext: no-perl-brace-format
+die sprintf ("usage: %s {OPTIONS} FILENAME...\n", $0);
+

+ +

+If you want to use the more portable Perl brace format, you will have to do +put placeholders in place of the literal braces: + +

+ +

+die __x ("usage: {program} {[}OPTIONS{]} FILENAME...\n",
+         program => $0, '[' => '{', ']' => '}');
+

+ +

+Perl brace format strings know no escaping mechanism. No matter how this +escaping mechanism looked like, it would either give the programmer a +hard time, make translating Perl brace format strings heavy-going, or +result in a performance penalty at runtime, when the format directives +get executed. Most of the time you will happily get along with +printf() for this special case.

+ + +

15.5.19 PHP Hypertext Preprocessor

-The ISO 639 standard defines two character codes for many languages. -All abbreviations for languages used in the Translation Project should -come from this standard. +

`aa´ -: -Afar. -
`ab´ -: -Abkhazian. -
`ae´ -: -Avestan. -
`af´ -: -Afrikaans. -
`ak´ -: -Akan. -
`am´ -: -Amharic. -
`an´ -: -Aragonese. -
`ar´ -: -Arabic. -
`as´ -: -Assamese. -
`av´ -: -Avaric. -
`ay´ -: -Aymara. -
`az´ -: -Azerbaijani. -
`ba´ -: -Bashkir. -
`be´ -: -Byelorussian; Belarusian. -
`bg´ -: -Bulgarian. -
`bh´ -: -Bihari. -
`bi´ -: -Bislama. -
`bm´ -: -Bambara. -
`bn´ -: -Bengali; Bangla. -
`bo´ -: -Tibetan. -
`br´ -: -Breton. -
`bs´ -: -Bosnian. -
`ca´ -: -Catalan. -
`ce´ -: -Chechen. -
`ch´ -: -Chamorro. -
`co´ -: -Corsican. -
`cr´ -: -Cree. -
`cs´ -: -Czech. -
`cu´ -: -Church Slavic. -
`cv´ -: -Chuvash. -
`cy´ -: -Welsh. -
`da´ -: -Danish. -
`de´ -: -German. -
`dv´ -: -Divehi. -
`dz´ -: -Dzongkha; Bhutani. -
`ee´ -: -'Ew'e. -
`el´ -: -Greek. -
`en´ -: -English. -
`eo´ -: -Esperanto. -
`es´ -: -Spanish. -
`et´ -: -Estonian. -
`eu´ -: -Basque. -
`fa´ -: -Persian. -
`ff´ -: -Fulah. -
`fi´ -: -Finnish. -
`fj´ -: -Fijian; Fiji. -
`fo´ -: -Faroese. -
`fr´ -: -French. -
`fy´ -: -Frisian. -
`ga´ -: -Irish. -
`gd´ -: -Scots; Gaelic. -
`gl´ -: -Gallegan; Galician. -
`gn´ -: -Guarani. -
`gu´ -: -Gujarati. -
`gv´ -: -Manx. -
`ha´ -: -Hausa (?). -
`he´ -: -Hebrew (formerly iw). -
`hi´ -: -Hindi. -
`ho´ -: -Hiri Motu. -
`hr´ -: -Croatian. -
`ht´ -: -Haitian; Haitian Creole. -
`hu´ -: -Hungarian. -
`hy´ -: -Armenian. -
`hz´ -: -Herero. -
`ia´ -: -Interlingua. -
`id´ -: -Indonesian (formerly in). -
`ie´ -: -Interlingue. -
`ig´ -: -Igbo. -
`ii´ -: -Sichuan Yi. -
`ik´ -: -Inupiak. -
`io´ -: -Ido. -
`is´ -: -Icelandic. -
`it´ -: -Italian. -
`iu´ -: -Inuktitut. -
`ja´ -: -Japanese. -
`jv´ -: -Javanese. -
`ka´ -: -Georgian. -
`kg´ -: -Kongo. -
`ki´ -: -Kikuyu. -
`kj´ -: -Kuanyama. -
`kk´ -: -Kazakh. -
`kl´ -: -Kalaallisut; Greenlandic. -
`km´ -: -Khmer; Cambodian. -
`kn´ -: -Kannada. -
`ko´ -: -Korean. -
`kr´ -: -Kanuri. -
`ks´ -: -Kashmiri. -
`ku´ -: -Kurdish. -
`kv´ -: -Komi. -
`kw´ -: -Cornish. -
`ky´ -: -Kirghiz. -
`la´ -: -Latin. -
`lb´ -: -Letzeburgesch. -
`lg´ -: -Ganda. -
`li´ -: -Limburgish; Limburger; Limburgan. -
`ln´ -: -Lingala. -
`lo´ -: -Lao; Laotian. -
`lt´ -: -Lithuanian. -
`lu´ -: -Luba-Katanga. -
`lv´ -: -Latvian; Lettish. -
`mg´ -: -Malagasy. -
`mh´ -: -Marshall. -
`mi´ -: -Maori. -
`mk´ -: -Macedonian. -
`ml´ +
RPMs: -Malayalam. -
`mn´ -: -Mongolian. -
`mo´ -: -Moldavian. -
`mr´ -: -Marathi. -
`ms´ -: -Malay. -
`mt´ -: -Maltese. -
`my´ -: -Burmese. -
`na´ -: -Nauru. -
`nb´ -: -Norwegian Bokmål. -
`nd´ -: -Ndebele, North. -
`ne´ -: -Nepali. -
`ng´ -: -Ndonga. -
`nl´ -: -Dutch. -
`nn´ -: -Norwegian Nynorsk. -
`no´ -: -Norwegian. -
`nr´ -: -Ndebele, South. -
`nv´ -: -Navajo. -
`ny´ -: -Chichewa; Nyanja. -
`oc´ -: -Occitan; Provençal. -
`oj´ -: -Ojibwa. -
`om´ -: -(Afan) Oromo. -
`or´ -: -Oriya. -
`os´ -: -Ossetian; Ossetic. -
`pa´ -: -Panjabi; Punjabi. -
`pi´ -: -Pali. -
`pl´ -: -Polish. -
`ps´ -: -Pashto, Pushto. -
`pt´ -: -Portuguese. -
`qu´ -: -Quechua. -
`rm´ -: -Rhaeto-Romance. -
`rn´ -: -Rundi; Kirundi. -
`ro´ +mod_php4, mod_php4-core, phpdoc + +
File extension: -Romanian. -
`ru´ +php, php3, php4 + +
String syntax: -Russian. -
`rw´ +"abc", 'abc' + +
gettext shorthand: -Kinyarwanda. -
`sa´ +_("abc") + +
gettext/ngettext functions: -Sanskrit. -
`sc´ +gettext, dgettext, dcgettext; starting with PHP 4.2.0 +also ngettext, dngettext, dcngettext + +
textdomain: -Sardinian. -
`sd´ +textdomain function + +
bindtextdomain: -Sindhi. -
`se´ +bindtextdomain function + +
setlocale: -Northern Sami. -
`sg´ +Programmer must call setlocale (LC_ALL, "") + +
Prerequisite: -Sango; Sangro. -
`si´ +--- + +
Use or emulate GNU gettext: -Sinhalese. -
`sk´ +use + +
Extractor: -Slovak. -
`sl´ +xgettext + +
Formatting with positions: -Slovenian. -
`sm´ +printf "%2\$d %1\$d" + +
Portability: -Samoan. -
`sn´ +On platforms without gettext, the functions are not available. + +
po-mode marking: -Shona. -
`so´ +--- +

+ +

+An example is available in the `examples´ directory: hello-php. + +

+ + +

15.5.20 Pike

+ + +

RPMs: -Somali. -
`sq´ +roxen + +
File extension: -Albanian. -
`sr´ +pike + +
String syntax: -Serbian. -
`ss´ +"abc" + +
gettext shorthand: -Swati; Siswati. -
`st´ +--- + +
gettext/ngettext functions: -Sesotho; Sotho, Southern. -
`su´ +gettext, dgettext, dcgettext + +
textdomain: -Sundanese. -
`sv´ +textdomain function + +
bindtextdomain: -Swedish. -
`sw´ +bindtextdomain function + +
setlocale: -Swahili. -
`ta´ +setlocale function + +
Prerequisite: -Tamil. -
`te´ +import Locale.Gettext; + +
Use or emulate GNU gettext: -Telugu. -
`tg´ +use + +
Extractor: -Tajik. -
`th´ +--- + +
Formatting with positions: -Thai. -
`ti´ +--- + +
Portability: -Tigrinya. -
`tk´ +On platforms without gettext, the functions are not available. + +
po-mode marking: -Turkmen. -
`tl´ +--- +

+ + + +

15.5.21 GNU Compiler Collection sources

+ + +

RPMs: -Tagalog. -
`tn´ +gcc + +
File extension: -Tswana; Setswana. -
`to´ +c, h. + +
String syntax: -Tonga (?). -
`tr´ +"abc" + +
gettext shorthand: -Turkish. -
`ts´ +_("abc") + +
gettext/ngettext functions: -Tsonga. -
`tt´ +gettext, dgettext, dcgettext, ngettext, +dngettext, dcngettext + +
textdomain: -Tatar. -
`tw´ +textdomain function + +
bindtextdomain: -Twi. -
`ty´ +bindtextdomain function + +
setlocale: -Tahitian. -
`ug´ +Programmer must call setlocale (LC_ALL, "") + +
Prerequisite: -Uighur. -
`uk´ +#include "intl.h" + +
Use or emulate GNU gettext: -Ukrainian. -
`ur´ +Use + +
Extractor: -Urdu. -
`uz´ +xgettext -k_ + +
Formatting with positions: -Uzbek. -
`ve´ +--- + +
Portability: -Venda. -
`vi´ +Uses autoconf macros + +
po-mode marking: -Vietnamese. -
`vo´ +yes +

+ + + +

15.6 Internationalizable Data

+ +

+Here is a list of other data formats which can be internationalized +using GNU gettext. + +

+ + + +

15.6.1 POT - Portable Object Template

+ +

RPMs: -Volapük; Volapuk. -
`wa´ +gettext + +
File extension: -Walloon. -
`wo´ +pot, po + +
Extractor: -Wolof. -
`xh´ +xgettext +

+ + + +

15.6.2 Resource String Table

+ + +

RPMs: -Xhosa. -
`yi´ +fpk + +
File extension: -Yiddish (formerly ji). -
`yo´ +rst + +
Extractor: -Yoruba. -
`za´ +xgettext, rstconv +

+ + + +

15.6.3 Glade - GNOME user interface description

+ +

RPMs: -Zhuang. -
`zh´ +glade, libglade, glade2, libglade2, intltool + +
File extension: -Chinese. -
`zu´ +glade, glade2 + +
Extractor: -Zulu. +xgettext, libglade-xgettext, xml-i18n-extract, intltool-extract

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_16.html b/gettext-tools/doc/gettext_16.html index 624472c94..5b69aa639 100644 --- a/gettext-tools/doc/gettext_16.html +++ b/gettext-tools/doc/gettext_16.html @@ -1,749 +1,189 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - B Country Codes +GNU gettext utilities - 16 Concluding Remarks -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

B Country Codes

16 Concluding Remarks

+ +

+We would like to conclude this GNU gettext manual by presenting +an history of the Translation Project so far. We finally give +a few pointers for those who want to do further research or readings +about Native Language Support matters. + +

+ + + +

16.1 History of GNU `gettext`

-The ISO 3166 standard defines two character codes for many countries -and territories. All abbreviations for countries used in the Translation -Project should come from this standard. +Internationalization concerns and algorithms have been informally +and casually discussed for years in GNU, sometimes around GNU +libc, maybe around the incoming Hurd, or otherwise +(nobody clearly remembers). And even then, when the work started for +real, this was somewhat independently of these previous discussions. + +

+This all began in July 1994, when Patrick D'Cruze had the idea and +initiative of internationalizing version 3.9.2 of GNU fileutils. +He then asked Jim Meyering, the maintainer, how to get those changes +folded into an official release. That first draft was full of +#ifdefs and somewhat disconcerting, and Jim wanted to find +nicer ways. Patrick and Jim shared some tries and experimentations +in this area. Then, feeling that this might eventually have a deeper +impact on GNU, Jim wanted to know what standards were, and contacted +Richard Stallman, who very quickly and verbally described an overall +design for what was meant to become glocale, at that time. + +

+Jim implemented glocale and got a lot of exhausting feedback +from Patrick and Richard, of course, but also from Mitchum DSouza +(who wrote a catgets-like package), Roland McGrath, maybe David +MacKenzie, François Pinard, and Paul Eggert, all pushing and +pulling in various directions, not always compatible, to the extent +that after a couple of test releases, glocale was torn apart. +In particular, Paul Eggert -- always keeping an eye on developments +in Solaris -- advocated the use of the gettext API over +glocale's catgets-based API. + +

+While Jim took some distance and time and became dad for a second +time, Roland wanted to get GNU libc internationalized, and +got Ulrich Drepper involved in that project. Instead of starting +from glocale, Ulrich rewrote something from scratch, but +more conformant to the set of guidelines who emerged out of the +glocale effort. Then, Ulrich got people from the previous +forum to involve themselves into this new project, and the switch +from glocale to what was first named msgutils, renamed +nlsutils, and later gettext, became officially accepted +by Richard in May 1995 or so. + +

+Let's summarize by saying that Ulrich Drepper wrote GNU gettext +in April 1995. The first official release of the package, including +PO mode, occurred in July 1995, and was numbered 0.7. Other people +contributed to the effort by providing a discussion forum around +Ulrich, writing little pieces of code, or testing. These are quoted +in the THANKS file which comes with the GNU gettext +distribution. + +

+While this was being done, François adapted half a dozen of +GNU packages to glocale first, then later to gettext, +putting them in pretest, so providing along the way an effective +user environment for fine tuning the evolving tools. He also took +the responsibility of organizing and coordinating the Translation +Project. After nearly a year of informal exchanges between people from +many countries, translator teams started to exist in May 1995, through +the creation and support by Patrick D'Cruze of twenty unmoderated +mailing lists for that many native languages, and two moderated +lists: one for reaching all teams at once, the other for reaching +all willing maintainers of internationalized free software packages. + +

+François also wrote PO mode in June 1995 with the collaboration +of Greg McGary, as a kind of contribution to Ulrich's package. +He also gave a hand with the GNU gettext Texinfo manual. + +

+In 1997, Ulrich Drepper released the GNU libc 2.0, which included the +gettext, textdomain and bindtextdomain functions.

`AD´ -: -Andorra. -
`AE´ -: -United Arab Emirates. -
`AF´ -: -Afghanistan. -
`AG´ -: -Antigua and Barbuda. -
`AI´ -: -Anguilla. -
`AL´ -: -Albania. -
`AM´ -: -Armenia. -
`AN´ -: -Netherlands Antilles. -
`AO´ -: -Angola. -
`AQ´ -: -Antarctica. -
`AR´ -: -Argentina. -
`AS´ -: -Samoa (American). -
`AT´ -: -Austria. -
`AU´ -: -Australia. -
`AW´ -: -Aruba. -
`AZ´ -: -Azerbaijan. -
`BA´ -: -Bosnia and Herzegovina. -
`BB´ -: -Barbados. -
`BD´ -: -Bangladesh. -
`BE´ -: -Belgium. -
`BF´ -: -Burkina Faso. -
`BG´ -: -Bulgaria. -
`BH´ -: -Bahrain. -
`BI´ -: -Burundi. -
`BJ´ -: -Benin. -
`BM´ -: -Bermuda. -
`BN´ -: -Brunei. -
`BO´ -: -Bolivia. -
`BR´ -: -Brazil. -
`BS´ -: -Bahamas. -
`BT´ -: -Bhutan. -
`BV´ -: -Bouvet Island. -
`BW´ -: -Botswana. -
`BY´ -: -Belarus. -
`BZ´ -: -Belize. -
`CA´ -: -Canada. -
`CC´ -: -Cocos (Keeling) Islands. -
`CD´ -: -Congo (Dem. Rep.). -
`CF´ -: -Central African Rep.. -
`CG´ -: -Congo (Rep.). -
`CH´ -: -Switzerland. -
`CI´ -: -Côte d'Ivoire. -
`CK´ -: -Cook Islands. -
`CL´ -: -Chile. -
`CM´ -: -Cameroon. -
`CN´ -: -China. -
`CO´ -: -Colombia. -
`CR´ -: -Costa Rica. -
`CS´ -: -Serbia and Montenegro. -
`CU´ -: -Cuba. -
`CV´ -: -Cape Verde. -
`CX´ -: -Christmas Island. -
`CY´ -: -Cyprus. -
`CZ´ -: -Czech Republic. -
`DE´ -: -Germany. -
`DJ´ -: -Djibouti. -
`DK´ -: -Denmark. -
`DM´ -: -Dominica. -
`DO´ -: -Dominican Republic. -
`DZ´ -: -Algeria. -
`EC´ -: -Ecuador. -
`EE´ -: -Estonia. -
`EG´ -: -Egypt. -
`EH´ -: -Western Sahara. -
`ER´ -: -Eritrea. -
`ES´ -: -Spain. -
`ET´ -: -Ethiopia. -
`FI´ -: -Finland. -
`FJ´ -: -Fiji. -
`FK´ -: -Falkland Islands. -
`FM´ -: -Micronesia. -
`FO´ -: -Faeroe Islands. -
`FR´ -: -France. -
`GA´ -: -Gabon. -
`GB´ -: -Britain (UK). -
`GD´ -: -Grenada. -
`GE´ -: -Georgia. -
`GF´ -: -French Guiana. -
`GH´ -: -Ghana. -
`GI´ -: -Gibraltar. -
`GL´ -: -Greenland. -
`GM´ -: -Gambia. -
`GN´ -: -Guinea. -
`GP´ -: -Guadeloupe. -
`GQ´ -: -Equatorial Guinea. -
`GR´ -: -Greece. -
`GS´ -: -South Georgia and the South Sandwich Islands. -
`GT´ -: -Guatemala. -
`GU´ -: -Guam. -
`GW´ -: -Guinea-Bissau. -
`GY´ -: -Guyana. -
`HK´ -: -Hong Kong. -
`HM´ -: -Heard Island and McDonald Islands. -
`HN´ -: -Honduras. -
`HR´ -: -Croatia. -
`HT´ -: -Haiti. -
`HU´ -: -Hungary. -
`ID´ -: -Indonesia. -
`IE´ -: -Ireland. -
`IL´ -: -Israel. -
`IN´ -: -India. -
`IO´ -: -British Indian Ocean Territory. -
`IQ´ -: -Iraq. -
`IR´ -: -Iran. -
`IS´ -: -Iceland. -
`IT´ -: -Italy. -
`JM´ -: -Jamaica. -
`JO´ -: -Jordan. -
`JP´ -: -Japan. -
`KE´ -: -Kenya. -
`KG´ -: -Kyrgyzstan. -
`KH´ -: -Cambodia. -
`KI´ -: -Kiribati. -
`KM´ -: -Comoros. -
`KN´ -: -St Kitts and Nevis. -
`KP´ -: -Korea (North). -
`KR´ -: -Korea (South). -
`KW´ -: -Kuwait. -
`KY´ -: -Cayman Islands. -
`KZ´ -: -Kazakhstan. -
`LA´ -: -Laos. -
`LB´ -: -Lebanon. -
`LC´ -: -St Lucia. -
`LI´ -: -Liechtenstein. -
`LK´ -: -Sri Lanka. -
`LR´ -: -Liberia. -
`LS´ -: -Lesotho. -
`LT´ -: -Lithuania. -
`LU´ -: -Luxembourg. -
`LV´ -: -Latvia. -
`LY´ -: -Libya. -
`MA´ -: -Morocco. -
`MC´ -: -Monaco. -
`MD´ -: -Moldova. -
`MG´ -: -Madagascar. -
`MH´ -: -Marshall Islands. -
`MK´ -: -Macedonia. -
`ML´ -: -Mali. -
`MM´ -: -Myanmar (Burma). -
`MN´ -: -Mongolia. -
`MO´ -: -Macao. -
`MP´ -: -Northern Mariana Islands. -
`MQ´ -: -Martinique. -
`MR´ -: -Mauritania. -
`MS´ -: -Montserrat. -
`MT´ -: -Malta. -
`MU´ -: -Mauritius. -
`MV´ -: -Maldives. -
`MW´ -: -Malawi. -
`MX´ -: -Mexico. -
`MY´ -: -Malaysia. -
`MZ´ -: -Mozambique. -
`NA´ -: -Namibia. -
`NC´ -: -New Caledonia. -
`NE´ -: -Niger. -
`NF´ -: -Norfolk Island. -
`NG´ -: -Nigeria. -
`NI´ -: -Nicaragua. -
`NL´ -: -Netherlands. -
`NO´ -: -Norway. -
`NP´ -: -Nepal. -
`NR´ -: -Nauru. -
`NU´ -: -Niue. -
`NZ´ -: -New Zealand. -
`OM´ -: -Oman. -
`PA´ -: -Panama. -
`PE´ -: -Peru. -
`PF´ -: -French Polynesia. -
`PG´ -: -Papua New Guinea. -
`PH´ -: -Philippines. -
`PK´ -: -Pakistan. -
`PL´ -: -Poland. -
`PM´ -: -St Pierre and Miquelon. -
`PN´ -: -Pitcairn. -
`PR´ -: -Puerto Rico. -
`PS´ -: -Palestine. -
`PT´ -: -Portugal. -
`PW´ -: -Palau. -
`PY´ -: -Paraguay. -
`QA´ -: -Qatar. -
`RE´ -: -Reunion. -
`RO´ -: -Romania. -
`RU´ -: -Russia. -
`RW´ -: -Rwanda. -
`SA´ -: -Saudi Arabia. -
`SB´ -: -Solomon Islands. -
`SC´ -: -Seychelles. -
`SD´ -: -Sudan. -
`SE´ -: -Sweden. -
`SG´ -: -Singapore. -
`SH´ -: -St Helena. -
`SI´ -: -Slovenia. -
`SJ´ -: -Svalbard and Jan Mayen. -
`SK´ -: -Slovakia. -
`SL´ -: -Sierra Leone. -
`SM´ -: -San Marino. -
`SN´ -: -Senegal. -
`SO´ -: -Somalia. -
`SR´ -: -Suriname. -
`ST´ -: -Sao Tome and Principe. -
`SV´ -: -El Salvador. -
`SY´ -: -Syria. -
`SZ´ -: -Swaziland. -
`TC´ -: -Turks and Caicos Islands. -
`TD´ -: -Chad. -
`TF´ -: -French Southern and Antarctic Lands. -
`TG´ -: -Togo. -
`TH´ -: -Thailand. -
`TJ´ -: -Tajikistan. -
`TK´ -: -Tokelau. -
`TL´ -: -Timor-Leste. -
`TM´ -: -Turkmenistan. -
`TN´ -: -Tunisia. -
`TO´ -: -Tonga. -
`TR´ -: -Turkey. -
`TT´ -: -Trinidad and Tobago. -
`TV´ -: -Tuvalu. -
`TW´ -: -Taiwan. -
`TZ´ -: -Tanzania. -
`UA´ -: -Ukraine. -
`UG´ -: -Uganda. -
`UM´ -: -US minor outlying islands. -
`US´ -: -United States. -
`UY´ -: -Uruguay. -
`UZ´ -: -Uzbekistan. -
`VA´ -: -Vatican City. -
`VC´ -: -St Vincent. -
`VE´ -: -Venezuela. -
`VG´ -: -Virgin Islands (UK). -
`VI´ -: -Virgin Islands (US). -
`VN´ -: -Vietnam. -
`VU´ -: -Vanuatu. -
`WF´ -: -Wallis and Futuna. -
`WS´ -: -Samoa (Western). -
`YE´ -: -Yemen. -
`YT´ -: -Mayotte. -
`ZA´ -: -South Africa. -
`ZM´ -: -Zambia. -
`ZW´ -: -Zimbabwe. -

+In 2000, Ulrich Drepper added plural form handling (the ngettext +function) to GNU libc. Later, in 2001, he released GNU libc 2.2.x, +which is the first free C library with full internationalization support. + +

+Ulrich being quite busy in his role of General Maintainer of GNU libc, +he handed over the GNU gettext maintenance to Bruno Haible in +2000. Bruno added the plural form handling to the tools as well, added +support for UTF-8 and CJK locales, and wrote a few new tools for +manipulating PO files. + +

+ + +

16.2 Related Readings

+ + + +

+Eugene H. Dorr (`dorre@well.com´) maintains an interesting +bibliography on internationalization matters, called +Internationalization Reference List, which is available as: + +

+ftp://ftp.ora.com/pub/examples/nutshell/ujip/doc/i18n-books.txt
+

+ +

+Michael Gschwind (`mike@vlsivie.tuwien.ac.at´) maintains a +Frequently Asked Questions (FAQ) list, entitled Programming for +Internationalisation. This FAQ discusses writing programs which +can handle different language conventions, character sets, etc.; +and is applicable to all character set encodings, with particular +emphasis on ISO 8859-1. It is regularly published in Usenet +groups `comp.unix.questions´, `comp.std.internat´, +`comp.software.international´, `comp.lang.c´, +`comp.windows.x´, `comp.std.c´, `comp.answers´ +and `news.answers´. The home location of this document is: + +

+ftp://ftp.vlsivie.tuwien.ac.at/pub/8bit/ISO-programming
+

+ +

+Patrick D'Cruze (`pdcruze@li.org´) wrote a tutorial about NLS +matters, and Jochen Hein (`Hein@student.tu-clausthal.de´) took +over the responsibility of maintaining it. It may be found as: + +

+ftp://sunsite.unc.edu/pub/Linux/utils/nls/catalogs/Incoming/...
+     ...locale-tutorial-0.8.txt.gz
+

+ +

+This site is mirrored in: +

+ftp://ftp.ibp.fr/pub/linux/sunsite/
+

+ +

+A French version of the same tutorial should be findable at: + +

+ftp://ftp.ibp.fr/pub/linux/french/docs/
+

+ +

+together with French translations of many Linux-related documents. + +

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_17.html b/gettext-tools/doc/gettext_17.html index 590f2592c..a306ade3d 100644 --- a/gettext-tools/doc/gettext_17.html +++ b/gettext-tools/doc/gettext_17.html @@ -1,72 +1,587 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - Program Index +GNU gettext utilities - A Language Codes -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

Program Index

- +

A Language Codes

-Jump to: -a -- -e -- -g -- -m -- -n -- -x + + + +

a

- -

autopoint -

e

- -

envsubst -

g

- -

gettext, gettext -

gettextize -

m

- -

msgattrib -

msgcat -

msgcmp -

msgcomm -

msgconv -

msgen -

msgexec -

msgfilter -

msgfmt -

msggrep -

msginit -

msgmerge -

msgunfmt -

msguniq -

n

- -

ngettext, ngettext -

x

- -

xgettext -

+The ISO 639 standard defines two character codes for many languages. +All abbreviations for languages used in the Translation Project should +come from this standard.

`aa´ +: +Afar. +
`ab´ +: +Abkhazian. +
`ae´ +: +Avestan. +
`af´ +: +Afrikaans. +
`ak´ +: +Akan. +
`am´ +: +Amharic. +
`an´ +: +Aragonese. +
`ar´ +: +Arabic. +
`as´ +: +Assamese. +
`av´ +: +Avaric. +
`ay´ +: +Aymara. +
`az´ +: +Azerbaijani. +
`ba´ +: +Bashkir. +
`be´ +: +Byelorussian; Belarusian. +
`bg´ +: +Bulgarian. +
`bh´ +: +Bihari. +
`bi´ +: +Bislama. +
`bm´ +: +Bambara. +
`bn´ +: +Bengali; Bangla. +
`bo´ +: +Tibetan. +
`br´ +: +Breton. +
`bs´ +: +Bosnian. +
`ca´ +: +Catalan. +
`ce´ +: +Chechen. +
`ch´ +: +Chamorro. +
`co´ +: +Corsican. +
`cr´ +: +Cree. +
`cs´ +: +Czech. +
`cu´ +: +Church Slavic. +
`cv´ +: +Chuvash. +
`cy´ +: +Welsh. +
`da´ +: +Danish. +
`de´ +: +German. +
`dv´ +: +Divehi. +
`dz´ +: +Dzongkha; Bhutani. +
`ee´ +: +'Ew'e. +
`el´ +: +Greek. +
`en´ +: +English. +
`eo´ +: +Esperanto. +
`es´ +: +Spanish. +
`et´ +: +Estonian. +
`eu´ +: +Basque. +
`fa´ +: +Persian. +
`ff´ +: +Fulah. +
`fi´ +: +Finnish. +
`fj´ +: +Fijian; Fiji. +
`fo´ +: +Faroese. +
`fr´ +: +French. +
`fy´ +: +Frisian. +
`ga´ +: +Irish. +
`gd´ +: +Scots; Gaelic. +
`gl´ +: +Gallegan; Galician. +
`gn´ +: +Guarani. +
`gu´ +: +Gujarati. +
`gv´ +: +Manx. +
`ha´ +: +Hausa (?). +
`he´ +: +Hebrew (formerly iw). +
`hi´ +: +Hindi. +
`ho´ +: +Hiri Motu. +
`hr´ +: +Croatian. +
`ht´ +: +Haitian; Haitian Creole. +
`hu´ +: +Hungarian. +
`hy´ +: +Armenian. +
`hz´ +: +Herero. +
`ia´ +: +Interlingua. +
`id´ +: +Indonesian (formerly in). +
`ie´ +: +Interlingue. +
`ig´ +: +Igbo. +
`ii´ +: +Sichuan Yi. +
`ik´ +: +Inupiak. +
`io´ +: +Ido. +
`is´ +: +Icelandic. +
`it´ +: +Italian. +
`iu´ +: +Inuktitut. +
`ja´ +: +Japanese. +
`jv´ +: +Javanese. +
`ka´ +: +Georgian. +
`kg´ +: +Kongo. +
`ki´ +: +Kikuyu. +
`kj´ +: +Kuanyama. +
`kk´ +: +Kazakh. +
`kl´ +: +Kalaallisut; Greenlandic. +
`km´ +: +Khmer; Cambodian. +
`kn´ +: +Kannada. +
`ko´ +: +Korean. +
`kr´ +: +Kanuri. +
`ks´ +: +Kashmiri. +
`ku´ +: +Kurdish. +
`kv´ +: +Komi. +
`kw´ +: +Cornish. +
`ky´ +: +Kirghiz. +
`la´ +: +Latin. +
`lb´ +: +Letzeburgesch. +
`lg´ +: +Ganda. +
`li´ +: +Limburgish; Limburger; Limburgan. +
`ln´ +: +Lingala. +
`lo´ +: +Lao; Laotian. +
`lt´ +: +Lithuanian. +
`lu´ +: +Luba-Katanga. +
`lv´ +: +Latvian; Lettish. +
`mg´ +: +Malagasy. +
`mh´ +: +Marshall. +
`mi´ +: +Maori. +
`mk´ +: +Macedonian. +
`ml´ +: +Malayalam. +
`mn´ +: +Mongolian. +
`mo´ +: +Moldavian. +
`mr´ +: +Marathi. +
`ms´ +: +Malay. +
`mt´ +: +Maltese. +
`my´ +: +Burmese. +
`na´ +: +Nauru. +
`nb´ +: +Norwegian Bokmål. +
`nd´ +: +Ndebele, North. +
`ne´ +: +Nepali. +
`ng´ +: +Ndonga. +
`nl´ +: +Dutch. +
`nn´ +: +Norwegian Nynorsk. +
`no´ +: +Norwegian. +
`nr´ +: +Ndebele, South. +
`nv´ +: +Navajo. +
`ny´ +: +Chichewa; Nyanja. +
`oc´ +: +Occitan; Provençal. +
`oj´ +: +Ojibwa. +
`om´ +: +(Afan) Oromo. +
`or´ +: +Oriya. +
`os´ +: +Ossetian; Ossetic. +
`pa´ +: +Panjabi; Punjabi. +
`pi´ +: +Pali. +
`pl´ +: +Polish. +
`ps´ +: +Pashto, Pushto. +
`pt´ +: +Portuguese. +
`qu´ +: +Quechua. +
`rm´ +: +Rhaeto-Romance. +
`rn´ +: +Rundi; Kirundi. +
`ro´ +: +Romanian. +
`ru´ +: +Russian. +
`rw´ +: +Kinyarwanda. +
`sa´ +: +Sanskrit. +
`sc´ +: +Sardinian. +
`sd´ +: +Sindhi. +
`se´ +: +Northern Sami. +
`sg´ +: +Sango; Sangro. +
`si´ +: +Sinhalese. +
`sk´ +: +Slovak. +
`sl´ +: +Slovenian. +
`sm´ +: +Samoan. +
`sn´ +: +Shona. +
`so´ +: +Somali. +
`sq´ +: +Albanian. +
`sr´ +: +Serbian. +
`ss´ +: +Swati; Siswati. +
`st´ +: +Sesotho; Sotho, Southern. +
`su´ +: +Sundanese. +
`sv´ +: +Swedish. +
`sw´ +: +Swahili. +
`ta´ +: +Tamil. +
`te´ +: +Telugu. +
`tg´ +: +Tajik. +
`th´ +: +Thai. +
`ti´ +: +Tigrinya. +
`tk´ +: +Turkmen. +
`tl´ +: +Tagalog. +
`tn´ +: +Tswana; Setswana. +
`to´ +: +Tonga (?). +
`tr´ +: +Turkish. +
`ts´ +: +Tsonga. +
`tt´ +: +Tatar. +
`tw´ +: +Twi. +
`ty´ +: +Tahitian. +
`ug´ +: +Uighur. +
`uk´ +: +Ukrainian. +
`ur´ +: +Urdu. +
`uz´ +: +Uzbek. +
`ve´ +: +Venda. +
`vi´ +: +Vietnamese. +
`vo´ +: +Volapük; Volapuk. +
`wa´ +: +Walloon. +
`wo´ +: +Wolof. +
`xh´ +: +Xhosa. +
`yi´ +: +Yiddish (formerly ji). +
`yo´ +: +Yoruba. +
`za´ +: +Zhuang. +
`zh´ +: +Chinese. +
`zu´ +: +Zulu. +

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_18.html b/gettext-tools/doc/gettext_18.html index a6e41a2eb..bd5869bee 100644 --- a/gettext-tools/doc/gettext_18.html +++ b/gettext-tools/doc/gettext_18.html @@ -1,567 +1,749 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - Option Index +GNU gettext utilities - B Country Codes -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

Option Index

- +

B Country Codes

-Jump to: -- + + + +

-

- -

--add-comments, xgettext option -

--add-location, msgattrib option -

--add-location, msgcat option -

--add-location, msgcomm option -

--add-location, msgconv option -

--add-location, msgen option -

--add-location, msgfilter option -

--add-location, msggrep option -

--add-location, msgmerge option -

--add-location, msguniq option -

--add-location, xgettext option -

--alignment, msgfmt option -

--backup, msgmerge option -

--c++, xgettext option -

--check, msgfmt option -

--check-accelerators, msgfmt option -

--check-compatibility, msgfmt option -

--check-domain, msgfmt option -

--check-format, msgfmt option -

--check-header, msgfmt option -

--clear-fuzzy, msgattrib option -

--clear-obsolete, msgattrib option -

--comment, msggrep option -

--compendium, msgmerge option -

--copy, gettextize option -

--copyright-holder, xgettext option -

--csharp, msgfmt option -

--csharp, msgunfmt option -

--csharp-resources, msgfmt option -

--csharp-resources, msgunfmt option -

--debug, xgettext option -

--default-domain, xgettext option -

--directory, msgattrib option -

--directory, msgcat option -

--directory, msgcmp option -

--directory, msgcomm option -

--directory, msgconv option -

--directory, msgen option -

--directory, msgexec option -

--directory, msgfilter option -

--directory, msgfmt option -

--directory, msggrep option -

--directory, msgmerge option -

--directory, msguniq option -

--directory, xgettext option -

--domain, gettext option -

--domain, msggrep option -

--domain, ngettext option -

--dry-run, autopoint option -

--dry-run, gettextize option -

--exclude-file, xgettext option -

--expression, msgfilter option -

--extended-regexp, msggrep option -

--extract-all, xgettext option -

--file, msgfilter option -

--file, msggrep option -

--files-from, msgcat option -

--files-from, msgcomm option -

--files-from, xgettext option -

--fixed-strings, msggrep option -

--flag, xgettext option -

--force, autopoint option -

--force, gettextize option -

--force-po, msgattrib option -

--force-po, msgcat option -

--force-po, msgcomm option -

--force-po, msgconv option -

--force-po, msgen option -

--force-po, msgfilter option -

--force-po, msggrep option -

--force-po, msgmerge option -

--force-po, msgunfmt option -

--force-po, msguniq option -

--force-po, xgettext option -

--foreign-user, xgettext option -

--from-code, xgettext option -

--fuzzy, msgattrib option -

--help, autopoint option -

--help, envsubst option -

--help, gettext option -

--help, gettextize option -

--help, msgattrib option -

--help, msgcat option -

--help, msgcmp option -

--help, msgcomm option -

--help, msgconv option -

--help, msgen option -

--help, msgexec option -

--help, msgfilter option -

--help, msgfmt option -

--help, msggrep option -

--help, msginit option -

--help, msgmerge option -

--help, msgunfmt option -

--help, msguniq option -

--help, ngettext option -

--help, xgettext option -

--ignore-case, msggrep option -

--ignore-file, msgattrib option -

--indent, msgattrib option -

--indent, msgcat option -

--indent, msgcomm option -

--indent, msgconv option -

--indent, msgen option -

--indent, msgfilter option -

--indent, msggrep option -

--indent, msgmerge option -

--indent, msgunfmt option -

--indent, msguniq option -

--indent, xgettext option -

--input, msgexec option -

--input, msgfilter option -

--input, msginit option -

--intl, gettextize option -

--java, msgfmt option -

--java, msgunfmt option -

--java2, msgfmt option -

--join-existing, xgettext option -

--keep-header, msgfilter option -

--keyword, xgettext option -

--language, xgettext option -

--less-than, msgcat option -

--less-than, msgcomm option -

--locale, msgfmt option, --locale, msgfmt option, --locale, msgfmt option -

--locale, msginit option -

--locale, msgunfmt option, --locale, msgunfmt option, --locale, msgunfmt option -

--location, msggrep option -

--more-than, msgcat option -

--more-than, msgcomm option -

--msgid, msggrep option -

--msgid-bugs-address, xgettext option -

--msgstr, msggrep option -

--msgstr-prefix, xgettext option -

--msgstr-suffix, xgettext option -

--multi-domain, msgcmp option -

--multi-domain, msgmerge option -

--no-changelog, gettextize option -

--no-fuzzy, msgattrib option -

--no-fuzzy-matching, msgmerge option -

--no-hash, msgfmt option -

--no-location, msgattrib option -

--no-location, msgcat option -

--no-location, msgcomm option -

--no-location, msgconv option -

--no-location, msgen option -

--no-location, msgfilter option -

--no-location, msggrep option -

--no-location, msgmerge option -

--no-location, msguniq option -

--no-location, xgettext option -

--no-obsolete, msgattrib option -

--no-translator, msginit option -

--no-wrap, msgattrib option -

--no-wrap, msgcat option -

--no-wrap, msgcomm option -

--no-wrap, msgconv option -

--no-wrap, msgen option -

--no-wrap, msgfilter option -

--no-wrap, msggrep option -

--no-wrap, msginit option -

--no-wrap, msgmerge option -

--no-wrap, msgunfmt option -

--no-wrap, msguniq option -

--no-wrap, xgettext option -

--obsolete, msgattrib option -

--omit-header, msgcomm option -

--omit-header, xgettext option -

--only-file, msgattrib option -

--only-fuzzy, msgattrib option -

--only-obsolete, msgattrib option -

--output, xgettext option -

--output-dir, xgettext option -

--output-file, msgattrib option -

--output-file, msgcat option -

--output-file, msgcomm option -

--output-file, msgconv option -

--output-file, msgen option -

--output-file, msgfilter option -

--output-file, msgfmt option -

--output-file, msggrep option -

--output-file, msginit option -

--output-file, msgmerge option -

--output-file, msgunfmt option -

--output-file, msguniq option -

--properties-input, msgattrib option -

--properties-input, msgcat option -

--properties-input, msgcmp option -

--properties-input, msgcomm option -

--properties-input, msgconv option -

--properties-input, msgen option -

--properties-input, msgexec option -

--properties-input, msgfilter option -

--properties-input, msgfmt option -

--properties-input, msggrep option -

--properties-input, msginit option -

--properties-input, msgmerge option -

--properties-input, msguniq option -

--properties-output, msgattrib option -

--properties-output, msgcat option -

--properties-output, msgcomm option -

--properties-output, msgconv option -

--properties-output, msgen option -

--properties-output, msgfilter option -

--properties-output, msggrep option -

--properties-output, msginit option -

--properties-output, msgmerge option -

--properties-output, msgunfmt option -

--properties-output, msguniq option -

--properties-output, xgettext option -

--qt, msgfmt option -

--qt, xgettext option -

--quiet, msgfilter option -

--quiet, msgmerge option -

--regexp=, msggrep option -

--repeated, msguniq option -

--resource, msgfmt option, --resource, msgfmt option -

--resource, msgunfmt option, --resource, msgunfmt option -

--set-fuzzy, msgattrib option -

--set-obsolete, msgattrib option -

--silent, msgfilter option -

--silent, msgmerge option -

--sort-by-file, msgattrib option -

--sort-by-file, msgcat option -

--sort-by-file, msgcomm option -

--sort-by-file, msgconv option -

--sort-by-file, msgen option -

--sort-by-file, msgfilter option -

--sort-by-file, msggrep option -

--sort-by-file, msgmerge option -

--sort-by-file, msguniq option -

--sort-by-file, xgettext option -

--sort-output, msgattrib option -

--sort-output, msgcat option -

--sort-output, msgcomm option -

--sort-output, msgconv option -

--sort-output, msgen option -

--sort-output, msgfilter option -

--sort-output, msggrep option -

--sort-output, msgmerge option -

--sort-output, msgunfmt option -

--sort-output, msguniq option -

--sort-output, xgettext option -

--statistics, msgfmt option -

--strict, msgattrib option -

--strict, msgcat option -

--strict, msgcomm option -

--strict, msgconv option -

--strict, msgen option -

--strict, msgfilter option -

--strict, msgfmt option -

--strict, msggrep option -

--strict, msgmerge option -

--strict, msgunfmt option -

--strict, msguniq option -

--strict, xgettext option -

--stringtable-input, msgattrib option -

--stringtable-input, msgcat option -

--stringtable-input, msgcmp option -

--stringtable-input, msgcomm option -

--stringtable-input, msgen option -

--stringtable-input, msgexec option -

--stringtable-input, msgfilter option -

--stringtable-input, msgfmt option -

--stringtable-input, msggrep option -

--stringtable-input, msginit option -

--stringtable-input, msgmerge option -

--stringtable-input, msgonv option -

--stringtable-input, msguniq option -

--stringtable-output, msgattrib option -

--stringtable-output, msgcat option -

--stringtable-output, msgcomm option -

--stringtable-output, msgconv option -

--stringtable-output, msgen option -

--stringtable-output, msgfilter option -

--stringtable-output, msggrep option -

--stringtable-output, msginit option -

--stringtable-output, msgmerge option -

--stringtable-output, msgunfmt option -

--stringtable-output, msguniq option -

--stringtable-output, xgettext option -

--suffix, msgmerge option -

--tcl, msgfmt option -

--tcl, msgunfmt option -

--to-code, msgcat option -

--to-code, msgconv option -

--to-code, msguniq option -

--translated, msgattrib option -

--trigraphs, xgettext option -

--unique, msgcat option -

--unique, msgcomm option -

--unique, msguniq option -

--untranslated, msgattrib option -

--update, msgmerge option -

--use-first, msgcat option -

--use-first, msguniq option -

--use-fuzzy, msgfmt option -

--variables, envsubst option -

--verbose, msgfmt option -

--verbose, msgmerge option -

--verbose, msgunfmt option -

--version, autopoint option -

--version, envsubst option -

--version, gettext option -

--version, gettextize option -

--version, msgattrib option -

--version, msgcat option -

--version, msgcmp option -

--version, msgcomm option -

--version, msgconv option -

--version, msgen option -

--version, msgexec option -

--version, msgfilter option -

--version, msgfmt option -

--version, msggrep option -

--version, msginit option -

--version, msgmerge option -

--version, msgunfmt option -

--version, msguniq option -

--version, ngettext option -

--version, xgettext option -

--width, msgattrib option -

--width, msgcat option -

--width, msgcomm option -

--width, msgconv option -

--width, msgen option -

--width, msgfilter option -

--width, msggrep option -

--width, msginit option -

--width, msgmerge option -

--width, msgunfmt option -

--width, msguniq option -

--width, xgettext option -

-<, msgcat option -

-<, msgcomm option -

->, msgcat option -

->, msgcomm option -

-a, msgfmt option -

-a, xgettext option -

-c, gettextize option -

-C, msgfmt option -

-c, msgfmt option -

-C, msggrep option -

-C, msgmerge option -

-C, xgettext option -

-c, xgettext option -

-d, autopoint option -

-d, gettext option -

-d, gettextize option -

-D, msgattrib option -

-D, msgcat option -

-D, msgcmp option -

-D, msgcomm option -

-D, msgconv option -

-D, msgen option -

-D, msgexec option -

-D, msgfilter option -

-d, msgfmt option, -d, msgfmt option, -d, msgfmt option -

-D, msgfmt option -

-D, msggrep option -

-D, msgmerge option -

-d, msgunfmt option, -d, msgunfmt option -

-D, msguniq option -

-d, msguniq option -

-d, ngettext option -

-D, xgettext option -

-d, xgettext option -

-e, gettext option -

-E, gettext option -

-e, msgfilter option -

-E, msggrep option -

-e, msggrep option -

-e, ngettext option -

-E, ngettext option -

-f, autopoint option -

-f, gettextize option -

-F, msgattrib option -

-f, msgcat option -

-F, msgcat option -

-F, msgcomm option -

-f, msgcomm option -

-F, msgconv option -

-F, msgen option -

-F, msgfilter option -

-f, msgfilter option -

-f, msgfmt option -

-f, msggrep option -

-F, msggrep option -

-F, msgmerge option -

-F, msguniq option -

-F, xgettext option -

-f, xgettext option -

-h, envsubst option -

-h, gettext option -

-h, msgattrib option -

-h, msgcat option -

-h, msgcmp option -

-h, msgcomm option -

-h, msgconv option -

-h, msgen option -

-h, msgexec option -

-h, msgfilter option -

-h, msgfmt option -

-h, msggrep option -

-h, msginit option -

-h, msgmerge option -

-h, msgunfmt option -

-h, msguniq option -

-h, ngettext option -

-h, xgettext option -

-i, msgattrib option -

-i, msgcat option -

-i, msgcomm option -

-i, msgconv option -

-i, msgen option -

-i, msgexec option -

-i, msgfilter option -

-i, msggrep option -

-i, msginit option -

-i, msgmerge option -

-i, msgunfmt option -

-i, msguniq option -

-i, xgettext option -

-j, msgfmt option -

-j, msgunfmt option -

-j, xgettext option -

-K, msggrep option -

-k, xgettext option -

-l, msgfmt option, -l, msgfmt option, -l, msgfmt option -

-l, msginit option -

-l, msgunfmt option, -l, msgunfmt option, -l, msgunfmt option -

-L, xgettext option -

-m, msgcmp option -

-M, msggrep option -

-m, msgmerge option -

-M, xgettext option -

-m, xgettext option -

-n, gettext option -

-n, msgattrib option -

-n, msgcat option -

-n, msgcomm option -

-n, msgfilter option -

-N, msggrep option -

-N, msgmerge option -

-n, msguniq option -

-n, xgettext option -

-o, msgattrib option -

-o, msgcat option -

-o, msgcomm option -

-o, msgconv option -

-o, msgen option -

-o, msgfilter option -

-o, msgfmt option -

-o, msggrep option -

-o, msginit option -

-o, msgmerge option -

-o, msgunfmt option -

-o, msguniq option -

-o, xgettext option -

-P, msgattrib option -

-p, msgattrib option -

-P, msgcat option -

-p, msgcat option -

-P, msgcmp option -

-P, msgcomm option -

-p, msgcomm option -

-P, msgconv option -

-p, msgconv option -

-P, msgen option -

-p, msgen option -

-P, msgexec option -

-P, msgfilter option -

-p, msgfilter option -

-P, msgfmt option -

-p, msggrep option -

-P, msggrep option -

-P, msginit option -

-p, msginit option -

-p, msgmerge option -

-P, msgmerge option -

-p, msgunfmt option -

-p, msguniq option -

-P, msguniq option -

-p, xgettext option -

-q, msgmerge option -

-r, msgfmt option, -r, msgfmt option -

-r, msgunfmt option, -r, msgunfmt option -

-s, msgattrib option -

-s, msgcat option -

-s, msgcomm option -

-s, msgconv option -

-s, msgen option -

-s, msgfilter option -

-s, msgmerge option -

-s, msgunfmt option -

-s, msguniq option -

-s, xgettext option -

-t, msgcat option -

-t, msgconv option -

-T, msggrep option -

-t, msguniq option -

-T, xgettext option -

-u, msgcat option -

-u, msgcomm option -

-U, msgmerge option -

-u, msguniq option -

-v, envsubst option -

-V, envsubst option -

-V, gettext option -

-V, msgattrib option -

-V, msgcat option -

-V, msgcmp option -

-V, msgcomm option -

-V, msgconv option -

-V, msgen option -

-V, msgexec option -

-V, msgfilter option -

-V, msgfmt option -

-v, msgfmt option -

-V, msggrep option -

-V, msginit option -

-v, msgmerge option -

-V, msgmerge option -

-v, msgunfmt option -

-V, msgunfmt option -

-V, msguniq option -

-V, ngettext option -

-V, xgettext option -

-w, msgattrib option -

-w, msgcat option -

-w, msgcomm option -

-w, msgconv option -

-w, msgen option -

-w, msgfilter option -

-w, msggrep option -

-w, msginit option -

-w, msgmerge option -

-w, msgunfmt option -

-w, msguniq option -

-w, xgettext option -

-x, xgettext option -

+The ISO 3166 standard defines two character codes for many countries +and territories. All abbreviations for countries used in the Translation +Project should come from this standard.

`AD´ +: +Andorra. +
`AE´ +: +United Arab Emirates. +
`AF´ +: +Afghanistan. +
`AG´ +: +Antigua and Barbuda. +
`AI´ +: +Anguilla. +
`AL´ +: +Albania. +
`AM´ +: +Armenia. +
`AN´ +: +Netherlands Antilles. +
`AO´ +: +Angola. +
`AQ´ +: +Antarctica. +
`AR´ +: +Argentina. +
`AS´ +: +Samoa (American). +
`AT´ +: +Austria. +
`AU´ +: +Australia. +
`AW´ +: +Aruba. +
`AZ´ +: +Azerbaijan. +
`BA´ +: +Bosnia and Herzegovina. +
`BB´ +: +Barbados. +
`BD´ +: +Bangladesh. +
`BE´ +: +Belgium. +
`BF´ +: +Burkina Faso. +
`BG´ +: +Bulgaria. +
`BH´ +: +Bahrain. +
`BI´ +: +Burundi. +
`BJ´ +: +Benin. +
`BM´ +: +Bermuda. +
`BN´ +: +Brunei. +
`BO´ +: +Bolivia. +
`BR´ +: +Brazil. +
`BS´ +: +Bahamas. +
`BT´ +: +Bhutan. +
`BV´ +: +Bouvet Island. +
`BW´ +: +Botswana. +
`BY´ +: +Belarus. +
`BZ´ +: +Belize. +
`CA´ +: +Canada. +
`CC´ +: +Cocos (Keeling) Islands. +
`CD´ +: +Congo (Dem. Rep.). +
`CF´ +: +Central African Rep.. +
`CG´ +: +Congo (Rep.). +
`CH´ +: +Switzerland. +
`CI´ +: +Côte d'Ivoire. +
`CK´ +: +Cook Islands. +
`CL´ +: +Chile. +
`CM´ +: +Cameroon. +
`CN´ +: +China. +
`CO´ +: +Colombia. +
`CR´ +: +Costa Rica. +
`CS´ +: +Serbia and Montenegro. +
`CU´ +: +Cuba. +
`CV´ +: +Cape Verde. +
`CX´ +: +Christmas Island. +
`CY´ +: +Cyprus. +
`CZ´ +: +Czech Republic. +
`DE´ +: +Germany. +
`DJ´ +: +Djibouti. +
`DK´ +: +Denmark. +
`DM´ +: +Dominica. +
`DO´ +: +Dominican Republic. +
`DZ´ +: +Algeria. +
`EC´ +: +Ecuador. +
`EE´ +: +Estonia. +
`EG´ +: +Egypt. +
`EH´ +: +Western Sahara. +
`ER´ +: +Eritrea. +
`ES´ +: +Spain. +
`ET´ +: +Ethiopia. +
`FI´ +: +Finland. +
`FJ´ +: +Fiji. +
`FK´ +: +Falkland Islands. +
`FM´ +: +Micronesia. +
`FO´ +: +Faeroe Islands. +
`FR´ +: +France. +
`GA´ +: +Gabon. +
`GB´ +: +Britain (UK). +
`GD´ +: +Grenada. +
`GE´ +: +Georgia. +
`GF´ +: +French Guiana. +
`GH´ +: +Ghana. +
`GI´ +: +Gibraltar. +
`GL´ +: +Greenland. +
`GM´ +: +Gambia. +
`GN´ +: +Guinea. +
`GP´ +: +Guadeloupe. +
`GQ´ +: +Equatorial Guinea. +
`GR´ +: +Greece. +
`GS´ +: +South Georgia and the South Sandwich Islands. +
`GT´ +: +Guatemala. +
`GU´ +: +Guam. +
`GW´ +: +Guinea-Bissau. +
`GY´ +: +Guyana. +
`HK´ +: +Hong Kong. +
`HM´ +: +Heard Island and McDonald Islands. +
`HN´ +: +Honduras. +
`HR´ +: +Croatia. +
`HT´ +: +Haiti. +
`HU´ +: +Hungary. +
`ID´ +: +Indonesia. +
`IE´ +: +Ireland. +
`IL´ +: +Israel. +
`IN´ +: +India. +
`IO´ +: +British Indian Ocean Territory. +
`IQ´ +: +Iraq. +
`IR´ +: +Iran. +
`IS´ +: +Iceland. +
`IT´ +: +Italy. +
`JM´ +: +Jamaica. +
`JO´ +: +Jordan. +
`JP´ +: +Japan. +
`KE´ +: +Kenya. +
`KG´ +: +Kyrgyzstan. +
`KH´ +: +Cambodia. +
`KI´ +: +Kiribati. +
`KM´ +: +Comoros. +
`KN´ +: +St Kitts and Nevis. +
`KP´ +: +Korea (North). +
`KR´ +: +Korea (South). +
`KW´ +: +Kuwait. +
`KY´ +: +Cayman Islands. +
`KZ´ +: +Kazakhstan. +
`LA´ +: +Laos. +
`LB´ +: +Lebanon. +
`LC´ +: +St Lucia. +
`LI´ +: +Liechtenstein. +
`LK´ +: +Sri Lanka. +
`LR´ +: +Liberia. +
`LS´ +: +Lesotho. +
`LT´ +: +Lithuania. +
`LU´ +: +Luxembourg. +
`LV´ +: +Latvia. +
`LY´ +: +Libya. +
`MA´ +: +Morocco. +
`MC´ +: +Monaco. +
`MD´ +: +Moldova. +
`MG´ +: +Madagascar. +
`MH´ +: +Marshall Islands. +
`MK´ +: +Macedonia. +
`ML´ +: +Mali. +
`MM´ +: +Myanmar (Burma). +
`MN´ +: +Mongolia. +
`MO´ +: +Macao. +
`MP´ +: +Northern Mariana Islands. +
`MQ´ +: +Martinique. +
`MR´ +: +Mauritania. +
`MS´ +: +Montserrat. +
`MT´ +: +Malta. +
`MU´ +: +Mauritius. +
`MV´ +: +Maldives. +
`MW´ +: +Malawi. +
`MX´ +: +Mexico. +
`MY´ +: +Malaysia. +
`MZ´ +: +Mozambique. +
`NA´ +: +Namibia. +
`NC´ +: +New Caledonia. +
`NE´ +: +Niger. +
`NF´ +: +Norfolk Island. +
`NG´ +: +Nigeria. +
`NI´ +: +Nicaragua. +
`NL´ +: +Netherlands. +
`NO´ +: +Norway. +
`NP´ +: +Nepal. +
`NR´ +: +Nauru. +
`NU´ +: +Niue. +
`NZ´ +: +New Zealand. +
`OM´ +: +Oman. +
`PA´ +: +Panama. +
`PE´ +: +Peru. +
`PF´ +: +French Polynesia. +
`PG´ +: +Papua New Guinea. +
`PH´ +: +Philippines. +
`PK´ +: +Pakistan. +
`PL´ +: +Poland. +
`PM´ +: +St Pierre and Miquelon. +
`PN´ +: +Pitcairn. +
`PR´ +: +Puerto Rico. +
`PS´ +: +Palestine. +
`PT´ +: +Portugal. +
`PW´ +: +Palau. +
`PY´ +: +Paraguay. +
`QA´ +: +Qatar. +
`RE´ +: +Reunion. +
`RO´ +: +Romania. +
`RU´ +: +Russia. +
`RW´ +: +Rwanda. +
`SA´ +: +Saudi Arabia. +
`SB´ +: +Solomon Islands. +
`SC´ +: +Seychelles. +
`SD´ +: +Sudan. +
`SE´ +: +Sweden. +
`SG´ +: +Singapore. +
`SH´ +: +St Helena. +
`SI´ +: +Slovenia. +
`SJ´ +: +Svalbard and Jan Mayen. +
`SK´ +: +Slovakia. +
`SL´ +: +Sierra Leone. +
`SM´ +: +San Marino. +
`SN´ +: +Senegal. +
`SO´ +: +Somalia. +
`SR´ +: +Suriname. +
`ST´ +: +Sao Tome and Principe. +
`SV´ +: +El Salvador. +
`SY´ +: +Syria. +
`SZ´ +: +Swaziland. +
`TC´ +: +Turks and Caicos Islands. +
`TD´ +: +Chad. +
`TF´ +: +French Southern and Antarctic Lands. +
`TG´ +: +Togo. +
`TH´ +: +Thailand. +
`TJ´ +: +Tajikistan. +
`TK´ +: +Tokelau. +
`TL´ +: +Timor-Leste. +
`TM´ +: +Turkmenistan. +
`TN´ +: +Tunisia. +
`TO´ +: +Tonga. +
`TR´ +: +Turkey. +
`TT´ +: +Trinidad and Tobago. +
`TV´ +: +Tuvalu. +
`TW´ +: +Taiwan. +
`TZ´ +: +Tanzania. +
`UA´ +: +Ukraine. +
`UG´ +: +Uganda. +
`UM´ +: +US minor outlying islands. +
`US´ +: +United States. +
`UY´ +: +Uruguay. +
`UZ´ +: +Uzbekistan. +
`VA´ +: +Vatican City. +
`VC´ +: +St Vincent. +
`VE´ +: +Venezuela. +
`VG´ +: +Virgin Islands (UK). +
`VI´ +: +Virgin Islands (US). +
`VN´ +: +Vietnam. +
`VU´ +: +Vanuatu. +
`WF´ +: +Wallis and Futuna. +
`WS´ +: +Samoa (Western). +
`YE´ +: +Yemen. +
`YT´ +: +Mayotte. +
`ZA´ +: +South Africa. +
`ZM´ +: +Zambia. +
`ZW´ +: +Zimbabwe. +

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_19.html b/gettext-tools/doc/gettext_19.html index dab2245cb..963ed5baf 100644 --- a/gettext-tools/doc/gettext_19.html +++ b/gettext-tools/doc/gettext_19.html @@ -1,57 +1,72 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - Variable Index +GNU gettext utilities - Program Index -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

Variable Index

Program Index

Jump to: -g +a - -l +e - -m +g - -t +m +- +n +- +x

g

a

+ +

autopoint +

e

+ +

envsubst +

g

GETTEXT_LOG_UNTRANSLATED, environment variable +

gettext, gettext +

gettextize

l

m

LANG, environment variable, LANG, environment variable -

LANGUAGE, environment variable, LANGUAGE, environment variable -

LC_ALL, environment variable -

LC_COLLATE, environment variable -

LC_CTYPE, environment variable -

LC_MESSAGES, environment variable -

LC_MONETARY, environment variable -

LC_NUMERIC, environment variable -

LC_TIME, environment variable -

LINGUAS, environment variable +

msgattrib +

msgcat +

msgcmp +

msgcomm +

msgconv +

msgen +

msgexec +

msgfilter +

msgfmt +

msggrep +

msginit +

msgmerge +

msgunfmt +

msguniq

m

n

MSGEXEC_LOCATION, environment variable -

MSGEXEC_MSGID, environment variable +

ngettext, ngettext

t

x

TEXTDOMAIN, environment variable -

TEXTDOMAINDIR, environment variable +

xgettext

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_2.html b/gettext-tools/doc/gettext_2.html index 65d825aea..88a864ebc 100644 --- a/gettext-tools/doc/gettext_2.html +++ b/gettext-tools/doc/gettext_2.html @@ -1,945 +1,101 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - 2 PO Files and PO Mode Basics +GNU gettext utilities - 2 The User's View -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

2 PO Files and PO Mode Basics

2 The User's View

-The GNU gettext toolset helps programmers and translators -at producing, updating and using translation files, mainly those -PO files which are textual, editable files. This chapter stresses -the format of PO files, and contains a PO mode starter. PO mode -description is spread throughout this manual instead of being concentrated -in one place. Here we present only the basics of PO mode. +When GNU gettext will truly have reached its goal, average users +should feel some kind of astonished pleasure, seeing the effect of +that strange kind of magic that just makes their own native language +appear everywhere on their screens. As for naive users, they would +ideally have no special pleasure about it, merely taking their own +language for granted, and becoming rather unhappy otherwise.

- - - -

2.1 Completing GNU `gettext` Installation

- - -Once you have received, unpacked, configured and compiled the GNU -gettext distribution, the `make install´ command puts in -place the programs xgettext, msgfmt, gettext, and -msgmerge, as well as their available message catalogs. To -top off a comfortable installation, you might also want to make the -PO mode available to your Emacs users. +So, let's try to describe here how we would like the magic to operate, +as we want the users' view to be the simplest, among all ways one +could look at GNU gettext. All other software engineers: +programmers, translators, maintainers, should work together in such a +way that the magic becomes possible. This is a long and progressive +undertaking, and information is available about the progress of the +Translation Project.

- - -During the installation of the PO mode, you might want to modify your -file `.emacs´, once and for all, so it contains a few lines looking -like: +When a package is distributed, there are two kinds of users: +installers who fetch the distribution, unpack it, configure +it, compile it and install it for themselves or others to use; and +end users that call programs of the package, once these have +been installed at their site. GNU gettext is offering magic +for both installers and end users.

-(setq auto-mode-alist
-      (cons '("\\.po\\'\\|\\.po\\." . po-mode) auto-mode-alist))
-(autoload 'po-mode "po-mode" "Major mode for translators to edit PO files" t)
-

+ +

2.1 The Current `ABOUT-NLS´ Matrix

-Later, whenever you edit some `.po´ -file, or any file having the string `.po.´ within its name, -Emacs loads `po-mode.elc´ (or `po-mode.el´) as needed, and -automatically activates PO mode commands for the associated buffer. -The string PO appears in the mode line for any buffer for -which PO mode is active. Many PO files may be active at once in a -single Emacs session. + + +

-If you are using Emacs version 20 or newer, and have already installed -the appropriate international fonts on your system, you may also tell -Emacs how to determine automatically the coding system of every PO file. -This will often (but not always) cause the necessary fonts to be loaded -and used for displaying the translations on your Emacs screen. For this -to happen, add the lines: +Languages are not equally supported in all packages using GNU +gettext. To know if some package uses GNU gettext, one +may check the distribution for the `ABOUT-NLS´ information file, for +some `ll.po´ files, often kept together into some `po/´ +directory, or for an `intl/´ directory. Internationalized packages +have usually many `ll.po´ files, where ll represents +the language. section 2.2 Magic for End Users for a complete description of the format +for ll.

- -

-(modify-coding-system-alist 'file "\\.po\\'\\|\\.po\\."
-                            'po-find-file-coding-system)
-(autoload 'po-find-file-coding-system "po-mode")
-

-to your `.emacs´ file. If, with this, you still see boxes instead -of international characters, try a different font set (via Shift Mouse -button 1). +More generally, a matrix is available for showing the current state +of the Translation Project, listing which packages are prepared for +multi-lingual messages, and which languages are supported by each. +Because this information changes often, this matrix is not kept within +this GNU gettext manual. This information is often found in +file `ABOUT-NLS´ from various distributions, but is also as old as +the distribution itself. A recent copy of this `ABOUT-NLS´ file, +containing up-to-date information, should generally be found on the +Translation Project sites, and also on most GNU archive sites.

2.2 The Format of PO Files

2.2 Magic for End Users

+ -

-A PO file is made up of many entries, each entry holding the relation -between an original untranslated string and its corresponding -translation. All entries in a given PO file usually pertain -to a single project, and all translations are expressed in a single -target language. One PO file entry has the following schematic -structure: - -

- -

-white-space
-#  translator-comments
-#. automatic-comments
-#: reference...
-#, flag...
-msgid untranslated-string
-msgstr translated-string
-

- -

-The general structure of a PO file should be well understood by -the translator. When using PO mode, very little has to be known -about the format details, as PO mode takes care of them for her. - -

-A simple entry can look like this: - -

- -

-#: lib/error.c:116
-msgid "Unknown system error"
-msgstr "Error desconegut del sistema"
-

- -

-Entries begin with some optional white space. Usually, when generated -through GNU gettext tools, there is exactly one blank line -between entries. Then comments follow, on lines all starting with the -character #. There are two kinds of comments: those which have -some white space immediately following the #, which comments are -created and maintained exclusively by the translator, and those which -have some non-white character just after the #, which comments -are created and maintained automatically by GNU gettext tools. -All comments, of either kind, are optional. -

- -After white space and comments, entries show two strings, namely -first the untranslated string as it appears in the original program -sources, and then, the translation of this string. The original -string is introduced by the keyword msgid, and the translation, -by msgstr. The two strings, untranslated and translated, -are quoted in various ways in the PO file, using " -delimiters and \ escapes, but the translator does not really -have to pay attention to the precise quoting format, as PO mode fully -takes care of quoting for her. - -

-The msgid strings, as well as automatic comments, are produced -and managed by other GNU gettext tools, and PO mode does not -provide means for the translator to alter these. The most she can -do is merely deleting them, and only by deleting the whole entry. -On the other hand, the msgstr string, as well as translator -comments, are really meant for the translator, and PO mode gives her -the full control she needs. - -

-The comment lines beginning with #, are special because they are -not completely ignored by the programs as comments generally are. The -comma separated list of flags is used by the msgfmt -program to give the user some better diagnostic messages. Currently -there are two forms of flags defined: - -

fuzzy -: - -This flag can be generated by the msgmerge program or it can be -inserted by the translator herself. It shows that the msgstr -string might not be a correct translation (anymore). Only the translator -can judge if the translation requires further modification, or is -acceptable as is. Once satisfied with the translation, she then removes -this fuzzy attribute. The msgmerge program inserts this -when it combined the msgid and msgstr entries after fuzzy -search only. See section 6.3 Fuzzy Entries. - -
c-format -: - -
no-c-format -: - -These flags should not be added by a human. Instead only the -xgettext program adds them. In an automated PO file processing -system as proposed here the user changes would be thrown away again as -soon as the xgettext program generates a new template file. - -The c-format flag tells that the untranslated string and the -translation are supposed to be C format strings. The no-c-format -flag tells that they are not C format strings, even though the untranslated -string happens to look like a C format string (with `%´ directives). - -In case the c-format flag is given for a string the msgfmt -does some more tests to check to validity of the translation. -See section 8.1 Invoking the msgfmt Program, section 3.5 Special Comments preceding Keywords and section 13.3.1 C Format Strings. - -
objc-format -: - -
no-objc-format -: - -Likewise for Objective C, see section 13.3.2 Objective C Format Strings. - -
sh-format -: - -
no-sh-format -: - -Likewise for Shell, see section 13.3.3 Shell Format Strings. - -
python-format -: - -
no-python-format -: - -Likewise for Python, see section 13.3.4 Python Format Strings. - -
lisp-format -: - -
no-lisp-format -: - -Likewise for Lisp, see section 13.3.5 Lisp Format Strings. - -
elisp-format -: - -
no-elisp-format -: - -Likewise for Emacs Lisp, see section 13.3.6 Emacs Lisp Format Strings. - -
librep-format -: - -
no-librep-format -: - -Likewise for librep, see section 13.3.7 librep Format Strings. - -
scheme-format -: - -
no-scheme-format -: - -Likewise for Scheme, see section 13.3.8 Scheme Format Strings. - -
smalltalk-format -: - -
no-smalltalk-format -: - -Likewise for Smalltalk, see section 13.3.9 Smalltalk Format Strings. - -
java-format -: - -
no-java-format -: - -Likewise for Java, see section 13.3.10 Java Format Strings. - -
csharp-format -: - -
no-csharp-format -: - -Likewise for C#, see section 13.3.11 C# Format Strings. - -
awk-format -: - -
no-awk-format -: - -Likewise for awk, see section 13.3.12 awk Format Strings. - -
object-pascal-format -: - -
no-object-pascal-format -: - -Likewise for Object Pascal, see section 13.3.13 Object Pascal Format Strings. - -
ycp-format -: - -
no-ycp-format -: - -Likewise for YCP, see section 13.3.14 YCP Format Strings. - -
tcl-format -: - -
no-tcl-format -: - -Likewise for Tcl, see section 13.3.15 Tcl Format Strings. - -
perl-format -: - -
no-perl-format -: - -Likewise for Perl, see section 13.3.16 Perl Format Strings. - -
perl-brace-format -: - -
no-perl-brace-format -: - -Likewise for Perl brace, see section 13.3.16 Perl Format Strings. - -
php-format -: - -
no-php-format -: - -Likewise for PHP, see section 13.3.17 PHP Format Strings. - -
gcc-internal-format -: - -
no-gcc-internal-format -: - -Likewise for the GCC sources, see section 13.3.18 GCC internal Format Strings. - -
qt-format -: - -
no-qt-format -: - -Likewise for Qt, see section 13.3.19 Qt Format Strings. - -

- -

- - -A different kind of entries is used for translations which involve -plural forms. - -

- -

-white-space
-#  translator-comments
-#. automatic-comments
-#: reference...
-#, flag...
-msgid untranslated-string-singular
-msgid_plural untranslated-string-plural
-msgstr[0] translated-string-case-0
-...
-msgstr[N] translated-string-case-n
-

- -

-Such an entry can look like this: - -

- -

-#: src/msgcmp.c:338 src/po-lex.c:699
-#, c-format
-msgid "found %d fatal error"
-msgid_plural "found %d fatal errors"
-msgstr[0] "s'ha trobat %d error fatal"
-msgstr[1] "s'han trobat %d errors fatals"
-

- -

- -It happens that some lines, usually whitespace or comments, follow the -very last entry of a PO file. Such lines are not part of any entry, -and PO mode is unable to take action on those lines. By using the -PO mode function M-x po-normalize, the translator may get -rid of those spurious lines. See section 2.5 Normalizing Strings in Entries. - -

-The remainder of this section may be safely skipped by those using -PO mode, yet it may be interesting for everybody to have a better -idea of the precise format of a PO file. On the other hand, those -not having Emacs handy should carefully continue reading on. - -

-Each of untranslated-string and translated-string respects -the C syntax for a character string, including the surrounding quotes -and embedded backslashed escape sequences. When the time comes -to write multi-line strings, one should not use escaped newlines. -Instead, a closing quote should follow the last character on the -line to be continued, and an opening quote should resume the string -at the beginning of the following PO file line. For example: - -

- -

-msgid ""
-"Here is an example of how one might continue a very long string\n"
-"for the common case the string represents multi-line output.\n"
-

- -

-In this example, the empty string is used on the first line, to -allow better alignment of the H from the word `Here´ -over the f from the word `for´. In this example, the -msgid keyword is followed by three strings, which are meant -to be concatenated. Concatenating the empty string does not change -the resulting overall string, but it is a way for us to comply with -the necessity of msgid to be followed by a string on the same -line, while keeping the multi-line presentation left-justified, as -we find this to be a cleaner disposition. The empty string could have -been omitted, but only if the string starting with `Here´ was -promoted on the first line, right after msgid.(2) It was not really necessary -either to switch between the two last quoted strings immediately after -the newline `\n´, the switch could have occurred after any -other character, we just did it this way because it is neater. - -

- -One should carefully distinguish between end of lines marked as -`\n´ inside quotes, which are part of the represented -string, and end of lines in the PO file itself, outside string quotes, -which have no incidence on the represented string. - -

- -Outside strings, white lines and comments may be used freely. -Comments start at the beginning of a line with `#´ and extend -until the end of the PO file line. Comments written by translators -should have the initial `#´ immediately followed by some white -space. If the `#´ is not immediately followed by white space, -this comment is most likely generated and managed by specialized GNU -tools, and might disappear or be replaced unexpectedly when the PO -file is given to msgmerge. - -

- - -

2.3 Main PO mode Commands

- -

- - -After setting up Emacs with something similar to the lines in -section 2.1 Completing GNU gettext Installation, PO mode is activated for a window when Emacs finds a -PO file in that window. This puts the window read-only and establishes a -po-mode-map, which is a genuine Emacs mode, in a way that is not derived -from text mode in any way. Functions found on po-mode-hook, -if any, will be executed. - -

-When PO mode is active in a window, the letters `PO´ appear -in the mode line for that window. The mode line also displays how -many entries of each kind are held in the PO file. For example, -the string `132t+3f+10u+2o´ would tell the translator that the -PO mode contains 132 translated entries (see section 6.2 Translated Entries, -3 fuzzy entries (see section 6.3 Fuzzy Entries), 10 untranslated entries -(see section 6.4 Untranslated Entries) and 2 obsolete entries (see section 6.5 Obsolete Entries). Zero-coefficients items are not shown. So, in this example, if -the fuzzy entries were unfuzzied, the untranslated entries were translated -and the obsolete entries were deleted, the mode line would merely display -`145t´ for the counters. - -

-The main PO commands are those which do not fit into the other categories of -subsequent sections. These allow for quitting PO mode or for managing windows -in special ways. - -

_ -: - -Undo last modification to the PO file (po-undo). - -
Q -: - -Quit processing and save the PO file (po-quit). - -
q -: - -Quit processing, possibly after confirmation (po-confirm-and-quit). - -
0 -: - -Temporary leave the PO file window (po-other-window). - -
? -: -
h -: - - -Show help about PO mode (po-help). - -
= -: - -Give some PO file statistics (po-statistics). - -
V -: - -Batch validate the format of the whole PO file (po-validate). - -

- -

- - -The command _ (po-undo) interfaces to the Emacs -undo facility. See section `Undoing Changes' in The Emacs Editor. Each time U is typed, modifications which the translator -did to the PO file are undone a little more. For the purpose of -undoing, each PO mode command is atomic. This is especially true for -the RET command: the whole edition made by using a single -use of this command is undone at once, even if the edition itself -implied several actions. However, while in the editing window, one -can undo the edition work quite parsimoniously. - -

- - - - -The commands Q (po-quit) and q -(po-confirm-and-quit) are used when the translator is done with the -PO file. The former is a bit less verbose than the latter. If the file -has been modified, it is saved to disk first. In both cases, and prior to -all this, the commands check if any untranslated messages remain in the -PO file and, if so, the translator is asked if she really wants to leave -off working with this PO file. This is the preferred way of getting rid -of an Emacs PO file buffer. Merely killing it through the usual command -C-x k (kill-buffer) is not the tidiest way to proceed. - -

- - -The command 0 (po-other-window) is another, softer way, -to leave PO mode, temporarily. It just moves the cursor to some other -Emacs window, and pops one if necessary. For example, if the translator -just got PO mode to show some source context in some other, she might -discover some apparent bug in the program source that needs correction. -This command allows the translator to change sex, become a programmer, -and have the cursor right into the window containing the program she -(or rather he) wants to modify. By later getting the cursor back -in the PO file window, or by asking Emacs to edit this file once again, -PO mode is then recovered. - -

- - - -The command h (po-help) displays a summary of all available PO -mode commands. The translator should then type any character to resume -normal PO mode operations. The command ? has the same effect -as h. - -

- - -The command = (po-statistics) computes the total number of -entries in the PO file, the ordinal of the current entry (counted from -1), the number of untranslated entries, the number of obsolete entries, -and displays all these numbers. - -

- - -The command V (po-validate) launches msgfmt in -checking and verbose -mode over the current PO file. This command first offers to save the -current PO file on disk. The msgfmt tool, from GNU gettext, -has the purpose of creating a MO file out of a PO file, and PO mode uses -the features of this program for checking the overall format of a PO file, -as well as all individual entries. - -

- -The program msgfmt runs asynchronously with Emacs, so the -translator regains control immediately while her PO file is being studied. -Error output is collected in the Emacs `*compilation*´ buffer, -displayed in another window. The regular Emacs command C-x` -(next-error), as well as other usual compile commands, allow the -translator to reposition quickly to the offending parts of the PO file. -Once the cursor is on the line in error, the translator may decide on -any PO mode action which would help correcting the error. - -

- - -

2.4 Entry Positioning

- -

- -The cursor in a PO file window is almost always part of -an entry. The only exceptions are the special case when the cursor -is after the last entry in the file, or when the PO file is -empty. The entry where the cursor is found to be is said to be the -current entry. Many PO mode commands operate on the current entry, -so moving the cursor does more than allowing the translator to browse -the PO file, this also selects on which entry commands operate. - -

- -Some PO mode commands alter the position of the cursor in a specialized -way. A few of those special purpose positioning are described here, -the others are described in following sections (for a complete list try -C-h m): - -

. -: - -Redisplay the current entry (po-current-entry). - -
n -: - -Select the entry after the current one (po-next-entry). - -
p -: - -Select the entry before the current one (po-previous-entry). - -
< -: - -Select the first entry in the PO file (po-first-entry). - -
> -: - -Select the last entry in the PO file (po-last-entry). - -
m -: - -Record the location of the current entry for later use -(po-push-location). - -
r -: - -Return to a previously saved entry location (po-pop-location). - -
x -: - -Exchange the current entry location with the previously saved one -(po-exchange-location). - -

- -

- - -Any Emacs command able to reposition the cursor may be used -to select the current entry in PO mode, including commands which -move by characters, lines, paragraphs, screens or pages, and search -commands. However, there is a kind of standard way to display the -current entry in PO mode, which usual Emacs commands moving -the cursor do not especially try to enforce. The command . -(po-current-entry) has the sole purpose of redisplaying the -current entry properly, after the current entry has been changed by -means external to PO mode, or the Emacs screen otherwise altered. - -

-It is yet to be decided if PO mode helps the translator, or otherwise -irritates her, by forcing a rigid window disposition while she -is doing her work. We originally had quite precise ideas about -how windows should behave, but on the other hand, anyone used to -Emacs is often happy to keep full control. Maybe a fixed window -disposition might be offered as a PO mode option that the translator -might activate or deactivate at will, so it could be offered on an -experimental basis. If nobody feels a real need for using it, or -a compulsion for writing it, we should drop this whole idea. -The incentive for doing it should come from translators rather than -programmers, as opinions from an experienced translator are surely -more worth to me than opinions from programmers thinking about -how others should do translation. - -

- - - - -The commands n (po-next-entry) and p -(po-previous-entry) move the cursor the entry following, -or preceding, the current one. If n is given while the -cursor is on the last entry of the PO file, or if p -is given while the cursor is on the first entry, no move is done. - -

- - - - -The commands < (po-first-entry) and > -(po-last-entry) move the cursor to the first entry, or last -entry, of the PO file. When the cursor is located past the last -entry in a PO file, most PO mode commands will return an error saying -`After last entry´. Moreover, the commands < and > -have the special property of being able to work even when the cursor -is not into some PO file entry, and one may use them for nicely -correcting this situation. But even these commands will fail on a -truly empty PO file. There are development plans for the PO mode for it -to interactively fill an empty PO file from sources. See section 3.4 Marking Translatable Strings. - -

-The translator may decide, before working at the translation of -a particular entry, that she needs to browse the remainder of the -PO file, maybe for finding the terminology or phraseology used -in related entries. She can of course use the standard Emacs idioms -for saving the current cursor location in some register, and use that -register for getting back, or else, use the location ring. - -

- - - - -PO mode offers another approach, by which cursor locations may be saved -onto a special stack. The command m (po-push-location) -merely adds the location of current entry to the stack, pushing -the already saved locations under the new one. The command -r (po-pop-location) consumes the top stack element and -repositions the cursor to the entry associated with that top element. -This position is then lost, for the next r will move the cursor -to the previously saved location, and so on until no locations remain -on the stack. - -

-If the translator wants the position to be kept on the location stack, -maybe for taking a look at the entry associated with the top -element, then go elsewhere with the intent of getting back later, she -ought to use m immediately after r. - -

- - -The command x (po-exchange-location) simultaneously -repositions the cursor to the entry associated with the top element of -the stack of saved locations, and replaces that top element with the -location of the current entry before the move. Consequently, repeating -the x command toggles alternatively between two entries. -For achieving this, the translator will position the cursor on the -first entry, use m, then position to the second entry, and -merely use x for making the switch. - -

- - -

2.5 Normalizing Strings in Entries

- - -

-There are many different ways for encoding a particular string into a -PO file entry, because there are so many different ways to split and -quote multi-line strings, and even, to represent special characters -by backslashed escaped sequences. Some features of PO mode rely on -the ability for PO mode to scan an already existing PO file for a -particular string encoded into the msgid field of some entry. -Even if PO mode has internally all the built-in machinery for -implementing this recognition easily, doing it fast is technically -difficult. To facilitate a solution to this efficiency problem, -we decided on a canonical representation for strings. - -

-A conventional representation of strings in a PO file is currently -under discussion, and PO mode experiments with a canonical representation. -Having both xgettext and PO mode converging towards a uniform -way of representing equivalent strings would be useful, as the internal -normalization needed by PO mode could be automatically satisfied -when using xgettext from GNU gettext. An explicit -PO mode normalization should then be only necessary for PO files -imported from elsewhere, or for when the convention itself evolves. - -

-So, for achieving normalization of at least the strings of a given -PO file needing a canonical representation, the following PO mode -command is available: - -

- -

M-x po-normalize -: - -Tidy the whole PO file by making entries more uniform. - -

- -

-The special command M-x po-normalize, which has no associated -keys, revises all entries, ensuring that strings of both original -and translated entries use uniform internal quoting in the PO file. -It also removes any crumb after the last entry. This command may be -useful for PO files freshly imported from elsewhere, or if we ever -improve on the canonical quoting format we use. This canonical format -is not only meant for getting cleaner PO files, but also for greatly -speeding up msgid string lookup for some other PO mode commands. - -

-M-x po-normalize presently makes three passes over the entries. -The first implements heuristics for converting PO files for GNU -gettext 0.6 and earlier, in which msgid and msgstr -fields were using K&R style C string syntax for multi-line strings. -These heuristics may fail for comments not related to obsolete -entries and ending with a backslash; they also depend on subsequent -passes for finalizing the proper commenting of continued lines for -obsolete entries. This first pass might disappear once all oldish PO -files would have been adjusted. The second and third pass normalize -all msgid and msgstr strings respectively. They also -clean out those trailing backslashes used by XView's msgfmt -for continued lines. - -

- -Having such an explicit normalizing command allows for importing PO -files from other sources, but also eases the evolution of the current -convention, evolution driven mostly by aesthetic concerns, as of now. -It is easy to make suggested adjustments at a later time, as the -normalizing command and eventually, other GNU gettext tools -should greatly automate conformance. A description of the canonical -string format is given below, for the particular benefit of those not -having Emacs handy, and who would nevertheless want to handcraft -their PO files in nice ways. - -

- -Right now, in PO mode, strings are single line or multi-line. A string -goes multi-line if and only if it has embedded newlines, that -is, if it matches `[^\n]\n+[^\n]´. So, we would have: - -

- -

-msgstr "\n\nHello, world!\n\n\n"
-

- -

-but, replacing the space by a newline, this becomes: - -

- -

-msgstr ""
-"\n"
-"\n"
-"Hello,\n"
-"world!\n"
-"\n"
-"\n"
-

- -

-We are deliberately using a caricatural example, here, to make the -point clearer. Usually, multi-lines are not that bad looking. -It is probable that we will implement the following suggestion. -We might lump together all initial newlines into the empty string, -and also all newlines introducing empty lines (that is, for n -> 1, the n-1'th last newlines would go together on a separate -string), so making the previous example appear: - -

- -

-msgstr "\n\n"
-"Hello,\n"
-"world!\n"
-"\n\n"
-

- -

-There are a few yet undecided little points about string normalization, -to be documented in this manual, once these questions settle. +We consider here those packages using GNU gettext internally, +and for which the installers did not disable translation at +configure time. Then, users only have to set the LANG +environment variable to the appropriate `ll_CC´ +combination prior to using the programs in the package. See section 2.1 The Current `ABOUT-NLS´ Matrix. +For example, let's presume a German site. At the shell prompt, users +merely have to execute `setenv LANG de_DE´ (in csh) or +`export LANG; LANG=de_DE´ (in sh). They could even do +this from their `.login´ or `.profile´ file.

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_20.html b/gettext-tools/doc/gettext_20.html index be37b084d..89278c101 100644 --- a/gettext-tools/doc/gettext_20.html +++ b/gettext-tools/doc/gettext_20.html @@ -1,118 +1,567 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - PO Mode Index +GNU gettext utilities - Option Index -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

PO Mode Index

Option Index

Jump to: -. -- -a -- -c -- -e -- -f -- -i -- -l -- -m -- -o -- -p -- -s -- -t -- -u +-

.

-

`.emacs´ customizations -

a

- -

auxiliary PO file -

c

- -

commands -

comment out PO file entry -

consulting program sources -

consulting translations to other languages -

current entry of a PO file -

cut and paste for translated strings -

e

- -

editing comments -

editing multiple entries -

editing translations -

etags, using for marking strings -

exiting PO subedit -

f

- -

find source fragment for a PO file entry -

i

--add-location, msgattrib option +

--add-location, msgcat option +

--add-location, msgcomm option +

--add-location, msgconv option +

--add-location, msgen option +

--add-location, msgfilter option +

--add-location, msggrep option +

--add-location, msgmerge option +

--add-location, msguniq option +

--add-location, xgettext option +

--alignment, msgfmt option +

--backup, msgmerge option +

--c++, xgettext option +

--check, msgfmt option +

--check-accelerators, msgfmt option +

--check-compatibility, msgfmt option +

--check-domain, msgfmt option +

--check-format, msgfmt option +

--check-header, msgfmt option +

--clear-fuzzy, msgattrib option +

--clear-obsolete, msgattrib option +

--comment, msggrep option +

--compendium, msgmerge option +

--copy, gettextize option +

--copyright-holder, xgettext option +

--csharp, msgfmt option +

--csharp, msgunfmt option +

--csharp-resources, msgfmt option +

--csharp-resources, msgunfmt option +

--debug, xgettext option +

--default-domain, xgettext option +

--directory, msgattrib option +

--directory, msgcat option +

--directory, msgcmp option +

--directory, msgcomm option +

--directory, msgconv option +

--directory, msgen option +

--directory, msgexec option +

--directory, msgfilter option +

--directory, msgfmt option +

--directory, msggrep option +

--directory, msgmerge option +

--directory, msguniq option +

--directory, xgettext option +

--domain, gettext option +

--domain, msggrep option +

--domain, ngettext option +

--dry-run, autopoint option +

--dry-run, gettextize option +

--exclude-file, xgettext option +

--expression, msgfilter option +

--extended-regexp, msggrep option +

--extract-all, xgettext option +

--file, msgfilter option +

--file, msggrep option +

--files-from, msgcat option +

--files-from, msgcomm option +

--files-from, xgettext option +

--fixed-strings, msggrep option +

--flag, xgettext option +

--force, autopoint option +

--force, gettextize option +

--force-po, msgattrib option +

--force-po, msgcat option +

--force-po, msgcomm option +

--force-po, msgconv option +

--force-po, msgen option +

--force-po, msgfilter option +

--force-po, msggrep option +

--force-po, msgmerge option +

--force-po, msgunfmt option +

--force-po, msguniq option +

--force-po, xgettext option +

--foreign-user, xgettext option +

--from-code, xgettext option +

--fuzzy, msgattrib option +

--help, autopoint option +

--help, envsubst option +

--help, gettext option +

--help, gettextize option +

--help, msgattrib option +

--help, msgcat option +

--help, msgcmp option +

--help, msgcomm option +

--help, msgconv option +

--help, msgen option +

--help, msgexec option +

--help, msgfilter option +

--help, msgfmt option +

--help, msggrep option +

--help, msginit option +

--help, msgmerge option +

--help, msgunfmt option +

--help, msguniq option +

--help, ngettext option +

--help, xgettext option +

--ignore-case, msggrep option +

--ignore-file, msgattrib option +

--indent, msgattrib option +

--indent, msgcat option +

--indent, msgcomm option +

--indent, msgconv option +

--indent, msgen option +

--indent, msgfilter option +

--indent, msggrep option +

--indent, msgmerge option +

--indent, msgunfmt option +

--indent, msguniq option +

--indent, xgettext option +

--input, msgexec option +

--input, msgfilter option +

--input, msginit option +

--intl, gettextize option +

--java, msgfmt option +

--java, msgunfmt option +

--java2, msgfmt option +

--join-existing, xgettext option +

--keep-header, msgfilter option +

--keyword, xgettext option +

--language, xgettext option +

--less-than, msgcat option +

--less-than, msgcomm option +

--locale, msgfmt option, --locale, msgfmt option, --locale, msgfmt option +

--locale, msginit option +

--locale, msgunfmt option, --locale, msgunfmt option, --locale, msgunfmt option +

--location, msggrep option +

--more-than, msgcat option +

--more-than, msgcomm option +

--msgid, msggrep option +

--msgid-bugs-address, xgettext option +

--msgstr, msggrep option +

--msgstr-prefix, xgettext option +

--msgstr-suffix, xgettext option +

--multi-domain, msgcmp option +

--multi-domain, msgmerge option +

--no-changelog, gettextize option +

--no-fuzzy, msgattrib option +

--no-fuzzy-matching, msgmerge option +

--no-hash, msgfmt option +

--no-location, msgattrib option +

--no-location, msgcat option +

--no-location, msgcomm option +

--no-location, msgconv option +

--no-location, msgen option +

--no-location, msgfilter option +

--no-location, msggrep option +

--no-location, msgmerge option +

--no-location, msguniq option +

--no-location, xgettext option +

--no-obsolete, msgattrib option +

--no-translator, msginit option +

--no-wrap, msgattrib option +

--no-wrap, msgcat option +

--no-wrap, msgcomm option +

--no-wrap, msgconv option +

--no-wrap, msgen option +

--no-wrap, msgfilter option +

--no-wrap, msggrep option +

--no-wrap, msginit option +

--no-wrap, msgmerge option +

--no-wrap, msgunfmt option +

--no-wrap, msguniq option +

--no-wrap, xgettext option +

--obsolete, msgattrib option +

--omit-header, msgcomm option +

--omit-header, xgettext option +

--only-file, msgattrib option +

--only-fuzzy, msgattrib option +

--only-obsolete, msgattrib option +

--output, xgettext option +

--output-dir, xgettext option +

--output-file, msgattrib option +

--output-file, msgcat option +

--output-file, msgcomm option +

--output-file, msgconv option +

--output-file, msgen option +

--output-file, msgfilter option +

--output-file, msgfmt option +

--output-file, msggrep option +

--output-file, msginit option +

--output-file, msgmerge option +

--output-file, msgunfmt option +

--output-file, msguniq option +

--properties-input, msgattrib option +

--properties-input, msgcat option +

--properties-input, msgcmp option +

--properties-input, msgcomm option +

--properties-input, msgconv option +

--properties-input, msgen option +

--properties-input, msgexec option +

--properties-input, msgfilter option +

--properties-input, msgfmt option +

--properties-input, msggrep option +

--properties-input, msginit option +

--properties-input, msgmerge option +

--properties-input, msguniq option +

--properties-output, msgattrib option +

--properties-output, msgcat option +

--properties-output, msgcomm option +

--properties-output, msgconv option +

--properties-output, msgen option +

--properties-output, msgfilter option +

--properties-output, msggrep option +

--properties-output, msginit option +

--properties-output, msgmerge option +

--properties-output, msgunfmt option +

--properties-output, msguniq option +

--properties-output, xgettext option +

--qt, msgfmt option +

--qt, xgettext option +

--quiet, msgfilter option +

--quiet, msgmerge option +

--regexp=, msggrep option +

--repeated, msguniq option +

--resource, msgfmt option, --resource, msgfmt option +

--resource, msgunfmt option, --resource, msgunfmt option +

--set-fuzzy, msgattrib option +

--set-obsolete, msgattrib option +

--silent, msgfilter option +

--silent, msgmerge option +

--sort-by-file, msgattrib option +

--sort-by-file, msgcat option +

--sort-by-file, msgcomm option +

--sort-by-file, msgconv option +

--sort-by-file, msgen option +

--sort-by-file, msgfilter option +

--sort-by-file, msggrep option +

--sort-by-file, msgmerge option +

--sort-by-file, msguniq option +

--sort-by-file, xgettext option +

--sort-output, msgattrib option +

--sort-output, msgcat option +

--sort-output, msgcomm option +

--sort-output, msgconv option +

--sort-output, msgen option +

--sort-output, msgfilter option +

--sort-output, msggrep option +

--sort-output, msgmerge option +

--sort-output, msgunfmt option +

--sort-output, msguniq option +

--sort-output, xgettext option +

--statistics, msgfmt option +

--strict, msgattrib option +

--strict, msgcat option +

--strict, msgcomm option +

--strict, msgconv option +

--strict, msgen option +

--strict, msgfilter option +

--strict, msgfmt option +

--strict, msggrep option +

--strict, msgmerge option +

--strict, msgunfmt option +

--strict, msguniq option +

--strict, xgettext option +

--stringtable-input, msgattrib option +

--stringtable-input, msgcat option +

--stringtable-input, msgcmp option +

--stringtable-input, msgcomm option +

--stringtable-input, msgen option +

--stringtable-input, msgexec option +

--stringtable-input, msgfilter option +

--stringtable-input, msgfmt option +

--stringtable-input, msggrep option +

--stringtable-input, msginit option +

--stringtable-input, msgmerge option +

--stringtable-input, msgonv option +

--stringtable-input, msguniq option +

--stringtable-output, msgattrib option +

--stringtable-output, msgcat option +

--stringtable-output, msgcomm option +

--stringtable-output, msgconv option +

--stringtable-output, msgen option +

--stringtable-output, msgfilter option +

--stringtable-output, msggrep option +

--stringtable-output, msginit option +

--stringtable-output, msgmerge option +

--stringtable-output, msgunfmt option +

--stringtable-output, msguniq option +

--stringtable-output, xgettext option +

--suffix, msgmerge option +

--tcl, msgfmt option +

--tcl, msgunfmt option +

--to-code, msgcat option +

--to-code, msgconv option +

--to-code, msguniq option +

--translated, msgattrib option +

--trigraphs, xgettext option +

--unique, msgcat option +

--unique, msgcomm option +

--unique, msguniq option +

--untranslated, msgattrib option +

--update, msgmerge option +

--use-first, msgcat option +

--use-first, msguniq option +

--use-fuzzy, msgfmt option +

--variables, envsubst option +

--verbose, msgfmt option +

--verbose, msgmerge option +

--verbose, msgunfmt option +

--version, autopoint option +

--version, envsubst option +

--version, gettext option +

--version, gettextize option +

--version, msgattrib option +

--version, msgcat option +

--version, msgcmp option +

--version, msgcomm option +

--version, msgconv option +

--version, msgen option +

--version, msgexec option +

--version, msgfilter option +

--version, msgfmt option +

--version, msggrep option +

--version, msginit option +

--version, msgmerge option +

--version, msgunfmt option +

--version, msguniq option +

--version, ngettext option +

--version, xgettext option +

--width, msgattrib option +

--width, msgcat option +

--width, msgcomm option +

--width, msgconv option +

--width, msgen option +

--width, msgfilter option +

--width, msggrep option +

--width, msginit option +

--width, msgmerge option +

--width, msgunfmt option +

--width, msguniq option +

--width, xgettext option +

-<, msgcat option +

-<, msgcomm option +

->, msgcat option +

->, msgcomm option +

-a, msgfmt option +

-a, xgettext option +

-c, gettextize option +

-C, msgfmt option +

-c, msgfmt option +

-C, msggrep option +

-C, msgmerge option +

-C, xgettext option +

-c, xgettext option +

-d, autopoint option +

-d, gettext option +

-d, gettextize option +

-D, msgattrib option +

-D, msgcat option +

-D, msgcmp option +

-D, msgcomm option +

-D, msgconv option +

-D, msgen option +

-D, msgexec option +

-D, msgfilter option +

-d, msgfmt option, -d, msgfmt option, -d, msgfmt option +

-D, msgfmt option +

-D, msggrep option +

-D, msgmerge option +

-d, msgunfmt option, -d, msgunfmt option +

-D, msguniq option +

-d, msguniq option +

-d, ngettext option +

-D, xgettext option +

-d, xgettext option +

-e, gettext option +

-E, gettext option +

-e, msgfilter option +

-E, msggrep option +

-e, msggrep option +

-e, ngettext option +

-E, ngettext option +

-f, autopoint option +

-f, gettextize option +

-F, msgattrib option +

-f, msgcat option +

-F, msgcat option +

-F, msgcomm option +

-f, msgcomm option +

-F, msgconv option +

-F, msgen option +

-F, msgfilter option +

-f, msgfilter option +

-f, msgfmt option +

-f, msggrep option +

-F, msggrep option +

-F, msgmerge option +

-F, msguniq option +

-F, xgettext option +

-f, xgettext option +

-h, envsubst option +

-h, gettext option +

-h, msgattrib option +

-h, msgcat option +

-h, msgcmp option +

-h, msgcomm option +

-h, msgconv option +

-h, msgen option +

-h, msgexec option +

-h, msgfilter option +

-h, msgfmt option +

-h, msggrep option +

-h, msginit option +

-h, msgmerge option +

-h, msgunfmt option +

-h, msguniq option +

-h, ngettext option +

-h, xgettext option +

-i, msgattrib option +

-i, msgcat option +

-i, msgcomm option +

-i, msgconv option +

-i, msgen option +

-i, msgexec option +

-i, msgfilter option +

-i, msggrep option +

-i, msginit option +

-i, msgmerge option +

-i, msgunfmt option +

-i, msguniq option +

-i, xgettext option +

-j, msgfmt option +

-j, msgunfmt option +

-j, xgettext option +

-K, msggrep option +

-k, xgettext option +

-l, msgfmt option, -l, msgfmt option, -l, msgfmt option +

-l, msginit option +

-l, msgunfmt option, -l, msgunfmt option, -l, msgunfmt option +

-L, xgettext option +

-m, msgcmp option +

-M, msggrep option +

-m, msgmerge option +

-M, xgettext option +

-m, xgettext option +

-n, gettext option +

-n, msgattrib option +

-n, msgcat option +

-n, msgcomm option +

-n, msgfilter option +

-N, msggrep option +

-N, msgmerge option +

-n, msguniq option +

-n, xgettext option +

-o, msgattrib option +

-o, msgcat option +

-o, msgcomm option +

-o, msgconv option +

-o, msgen option +

-o, msgfilter option +

-o, msgfmt option +

-o, msggrep option +

-o, msginit option +

-o, msgmerge option +

-o, msgunfmt option +

-o, msguniq option +

-o, xgettext option +

-P, msgattrib option +

-p, msgattrib option +

-P, msgcat option +

-p, msgcat option +

-P, msgcmp option +

-P, msgcomm option +

-p, msgcomm option +

-P, msgconv option +

-p, msgconv option +

-P, msgen option +

-p, msgen option +

-P, msgexec option +

-P, msgfilter option +

-p, msgfilter option +

-P, msgfmt option +

-p, msggrep option +

-P, msggrep option +

-P, msginit option +

-p, msginit option +

-p, msgmerge option +

-P, msgmerge option +

-p, msgunfmt option +

-p, msguniq option +

-P, msguniq option +

-p, xgettext option +

-q, msgmerge option +

-r, msgfmt option, -r, msgfmt option +

-r, msgunfmt option, -r, msgunfmt option +

-s, msgattrib option +

-s, msgcat option +

-s, msgcomm option +

-s, msgconv option +

-s, msgen option +

-s, msgfilter option +

-s, msgmerge option +

-s, msgunfmt option +

-s, msguniq option +

-s, xgettext option +

-t, msgcat option +

-t, msgconv option +

-T, msggrep option +

-t, msguniq option +

-T, xgettext option +

-u, msgcat option +

-u, msgcomm option +

-U, msgmerge option +

-u, msguniq option +

-v, envsubst option +

-V, envsubst option +

-V, gettext option +

-V, msgattrib option +

-V, msgcat option +

-V, msgcmp option +

-V, msgcomm option +

-V, msgconv option +

-V, msgen option +

-V, msgexec option +

-V, msgfilter option +

-V, msgfmt option +

-v, msgfmt option +

-V, msggrep option +

-V, msginit option +

-v, msgmerge option +

-V, msgmerge option +

-v, msgunfmt option +

-V, msgunfmt option +

-V, msguniq option +

-V, ngettext option +

-V, xgettext option +

-w, msgattrib option +

-w, msgcat option +

-w, msgcomm option +

-w, msgconv option +

-w, msgen option +

-w, msgfilter option +

-w, msggrep option +

-w, msginit option +

-w, msgmerge option +

-w, msgunfmt option +

-w, msguniq option +

-w, xgettext option +

-x, xgettext option

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_21.html b/gettext-tools/doc/gettext_21.html index b78c7e071..122f17ebe 100644 --- a/gettext-tools/doc/gettext_21.html +++ b/gettext-tools/doc/gettext_21.html @@ -1,31 +1,57 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - Autoconf Macro Index +GNU gettext utilities - Variable Index -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

Autoconf Macro Index

Variable Index

Jump to: -a +g +- +l +- +m +- +t

a

g

AM_GNU_GETTEXT -

AM_GNU_GETTEXT_VERSION -

AM_ICONV -

AM_PO_SUBDIRS +

GETTEXT_LOG_UNTRANSLATED, environment variable +

l

+ +

LANG, environment variable, LANG, environment variable +

LANGUAGE, environment variable, LANGUAGE, environment variable +

LC_ALL, environment variable +

LC_COLLATE, environment variable +

LC_CTYPE, environment variable +

LC_MESSAGES, environment variable +

LC_MONETARY, environment variable +

LC_NUMERIC, environment variable +

LC_TIME, environment variable +

LINGUAS, environment variable +

m

+ +

MSGEXEC_LOCATION, environment variable +

MSGEXEC_MSGID, environment variable +

t

+ +

TEXTDOMAIN, environment variable +

TEXTDOMAINDIR, environment variable

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_22.html b/gettext-tools/doc/gettext_22.html index f85e47181..d3a23ce0d 100644 --- a/gettext-tools/doc/gettext_22.html +++ b/gettext-tools/doc/gettext_22.html @@ -1,467 +1,118 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - General Index +GNU gettext utilities - PO Mode Index -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

General Index

PO Mode Index

Jump to: -_ +. - -a +a - -b +c - -c +e - -d +f - -e +i - -f +l - -g +m - -h +o - -i +p - -j +s - -k +t - -l -- -m -- -n -- -o -- -p -- -q -- -r -- -s -- -t -- -u -- -v -- -w -- -x -- -y +u

_

- -

_, a macro to mark strings for translation -

_nl_msg_cat_cntr -

a

- -

`ABOUT-NLS´ file -

`acconfig.h´ file -

accumulating translations -

`aclocal.m4´ file -

adding keywords, xgettext -

ambiguities -

apply a filter to translations -

apply command to all translations in a catalog -

Arabic digits -

attribute manipulation -

attribute, fuzzy -

attributes of a PO file entry -

attributes, manipulating -

autoconf macros for gettext -

autopoint program, usage -

auxiliary PO file -

available translations -

awk -

b

- -

backup old file, and msgmerge program -

bash -

bibliography -

big picture -

bind_textdomain_codeset -

bug report address -

c

- -

C and C-like languages -

C trigraphs -

C# -

C# mode, and msgfmt program -

C# mode, and msgunfmt program -

C# resources mode, and msgfmt program -

C# resources mode, and msgunfmt program -

C#, string concatenation -

catalog encoding and msgexec output -

catclose, a catgets function -

catgets, X/Open specification -

catgets, a catgets function -

catopen, a catgets function -

character encoding -

charset conversion at runtime -

charset of PO files -

check format strings -

checking of translations -

clisp -

clisp C sources -

codeset -

comments in PO files -

Common Lisp -

compare PO files -

comparison of interfaces -

compatibility with X/Open msgfmt -

compendium -

compendium, creating -

concatenate PO files -

concatenating PO files into a compendium -

concatenation of strings -

`config.h.in´ file -

convert binary message catalog into PO file -

convert translations to a different encoding -

converting a package to use gettext -

country codes -

create new PO file -

creating a new PO file -

creating compendia -

currency symbols -

d

- -

date format -

dcngettext -

debugging messages marked as format strings -

dialect -

disabling NLS -

distribution tarball -

dngettext -

dollar substitution -

domain ambiguities -

duplicate elimination -

duplicate removal -

e

- -

editing comments in PO files -

editing translations -

Emacs Lisp -

encoding -

encoding conversion -

encoding conversion at runtime -

encoding for your language -

encoding list -

encoding of PO files -

environment variables -

envsubst program, usage -

eval_gettext function, usage -

eval_ngettext function, usage -

evolution of packages -

extracting parts of a PO file into a compendium -

f

- -

file format, `.mo´ -

file format, `.po´ -

files, `.po´ and `.mo´ -

files, `.pot´ -

filter messages according to attributes -

find common messages -

force use of fuzzy entries -

format strings -

Free Pascal -

function attribute, __format__ -

function attribute, __format_arg__ -

fuzzy entries -

g

- -

gawk -

GCC-source -

generate binary message catalog from PO file -

generate translation catalog in English -

gettext files -

gettext installation -

gettext interface -

gettext program, usage -

gettext, a programmer's view -

`gettext.h´ file -

gettext vs catgets -

gettextize program, usage -

GUI programs -

guile -

h

- -

hash table, inside MO files -

he, she, and they -

header entry of a PO file -

help option -

history of GNU gettext -

i

- -

i18n -

importing PO files -

include file `libintl.h´, include file `libintl.h´, include file `libintl.h´, include file `libintl.h´ -

initialization -

initialize new PO file -

initialize translations from a compendium -

installing gettext -

interface to catgets -

internationalization -

inttypes.h -

ISO 3166 -

ISO 639 -

j

- -

Java -

Java mode, and msgfmt program -

Java mode, and msgunfmt program -

Java, string concatenation -

k

.

keyboard accelerator checking +

`.emacs´ customizations

l

a

l10n -

language codes -

language selection -

language selection at runtime -

large package -

libiconv library -

libintl for C# -

libintl for Java -

libintl library -

librep Lisp -

`LINGUAS´ file -

link with `libintl´ -

Linux, Linux, Linux -

Lisp -

list of translation teams, where to find -

locale facet, LC_ALL -

locale facet, LC_COLLATE -

locale facet, LC_CTYPE, locale facet, LC_CTYPE, locale facet, LC_CTYPE -

locale facet, LC_MESSAGES, locale facet, LC_MESSAGES -

locale facet, LC_MONETARY, locale facet, LC_MONETARY -

locale facet, LC_NUMERIC, locale facet, LC_NUMERIC -

locale facet, LC_RESPONSES -

locale facet, LC_TIME, locale facet, LC_TIME -

locale facets -

locale program -

localization -

lookup message translation, lookup message translation -

lookup plural message translation, lookup plural message translation +

auxiliary PO file

m

c

magic signature of MO files -

`Makevars´ file -

manipulating PO files -

marking Perl sources -

marking string initializers -

marking strings that require translation -

marking strings, preparations -

marking translatable strings -

menu entries -

menu, keyboard accelerator support -

merge PO files -

merging two PO files -

message catalog files location -

messages -

migration from earlier versions of gettext -

`mkinstalldirs´ file -

mnemonics of menu entries -

MO file's format -

modify message attrributes -

msgattrib program, usage -

msgcat program, usage -

msgcmp program, usage -

msgcomm program, usage -

msgconv program, usage -

msgen program, usage -

msgexec program, usage -

msgfilter filter and catalog encoding -

msgfilter program, usage -

msgfmt program, usage -

msggrep program, usage -

msginit program, usage -

msgmerge program, usage -

msgunfmt program, usage -

msguniq program, usage -

multi-line strings +

commands +

comment out PO file entry +

consulting program sources +

consulting translations to other languages +

current entry of a PO file +

cut and paste for translated strings

n

e

N_, a convenience macro -

Native Language Support -

Natural Language Support -

newlines in PO files -

ngettext -

ngettext program, usage -

NLS -

number format +

editing comments +

editing multiple entries +

editing translations +

etags, using for marking strings +

exiting PO subedit

o

f

Object Pascal -

obsolete entries -

optimization of gettext functions -

orthography -

outdigits -

output to stdout, xgettext -

overview of gettext +

find source fragment for a PO file entry

p

i

package and version declaration in `configure.in´ -

package build and installation options -

package maintainer's view of gettext -

paragraphs -

Pascal -

Perl -

Perl default keywords -

Perl invalid string interpolation -

Perl long lines -

Perl parentheses -

Perl pitfalls -

Perl quote-like expressions -

Perl special keywords for hash-lookups -

Perl valid string interpolation -

PHP -

Pike -

plural form formulas -

plural forms -

plural forms, in MO files -

plural forms, in PO files -

PO files' format -

PO mode (Emacs) commands -

po_message_iterator -

po_message_iterator_free -

po_message_msgid -

po_message_msgid_plural -

po_message_msgstr -

po_message_msgstr_plural -

po_next_message -

portability problems with sed -

`POTFILES.in´ file -

preparing programs for translation -

preparing shell scripts for translation -

problems with catgets interface -

programming languages -

Python +

installing PO mode

q

l

Qt format strings -

Qt mode, and msgfmt program -

quotation marks, quotation marks -

quote characters, use in PO files +

looking at the source to aid translation

r

m

s

o

Scheme -

scripting languages -

search messages in a catalog -

selecting message language -

sentences -

setting up gettext at build time -

setting up gettext at run time -

several domains -

sex -

sgettext -

she, he, and they -

shell format string -

shell scripts -

Smalltalk -

sorting msgcat output -

sorting msgmerge output -

sorting msgunfmt output -

sorting output of xgettext -

specifying plural form in a PO file -

standard output, and msgcat -

standard output, and msgmerge program -

string concatenation -

string normalization in entries -

style -

supported languages, xgettext +

obsolete active entry

t

p

Tcl -

Tcl mode, and msgfmt program -

Tcl mode, and msgunfmt program -

template PO file -

testing `.po´ files for equivalence -

Tk's scripting language -

translated entries -

translating menu entries -

translation aspects -

Translation Matrix -

Translation Project -

turning off NLS support -

tutorial of gettext usage +

pending subedits

u

s

unify duplicate translations -

untranslated entries -

update translations from a compendium -

upgrading to new versions of gettext +

starting a string translation +

string normalization in entries +

subedit minor mode

v

t

version control for backup files, msgmerge +

`TAGS´, and marking translatable strings

w

u

wxWindows library -

x

- -

xargs, and output from msgexec -

xgettext program, usage -

xmodmap program, and typing quotation marks -

y

- -

YaST2 scripting language -

YCP +

use the source, Luke +

using obsolete translations to make new entries +

using translation compendia

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_23.html b/gettext-tools/doc/gettext_23.html new file mode 100644 index 000000000..a055aff7f --- /dev/null +++ b/gettext-tools/doc/gettext_23.html @@ -0,0 +1,31 @@ + + + + +GNU gettext utilities - Autoconf Macro Index + + +Go to the first, previous, next, last section, table of contents. +

+ + +

Autoconf Macro Index

+ +

+Jump to: +a +

a

+ +

AM_GNU_GETTEXT +

AM_GNU_GETTEXT_VERSION +

AM_ICONV +

AM_PO_SUBDIRS +

+ +

+Go to the first, previous, next, last section, table of contents. + + diff --git a/gettext-tools/doc/gettext_24.html b/gettext-tools/doc/gettext_24.html new file mode 100644 index 000000000..eae087475 --- /dev/null +++ b/gettext-tools/doc/gettext_24.html @@ -0,0 +1,473 @@ + + + + +GNU gettext utilities - General Index + + +Go to the first, previous, next, last section, table of contents. +

+ + +

General Index

+ +

+Jump to: +_ +- +a +- +b +- +c +- +d +- +e +- +f +- +g +- +h +- +i +- +j +- +k +- +l +- +m +- +n +- +o +- +p +- +q +- +r +- +s +- +t +- +u +- +v +- +w +- +x +- +y +

_

+ +

_, a macro to mark strings for translation +

_nl_msg_cat_cntr +

a

+ +

`ABOUT-NLS´ file +

`acconfig.h´ file +

accumulating translations +

`aclocal.m4´ file +

adding keywords, xgettext +

ambiguities +

apply a filter to translations +

apply command to all translations in a catalog +

Arabic digits +

attribute manipulation +

attribute, fuzzy +

attributes of a PO file entry +

attributes, manipulating +

autoconf macros for gettext +

autopoint program, usage +

auxiliary PO file +

available translations +

awk +

b

+ +

backup old file, and msgmerge program +

bash +

bibliography +

big picture +

bind_textdomain_codeset +

bug report address +

c

+ +

C and C-like languages +

C trigraphs +

C# +

C# mode, and msgfmt program +

C# mode, and msgunfmt program +

C# resources mode, and msgfmt program +

C# resources mode, and msgunfmt program +

C#, string concatenation +

catalog encoding and msgexec output +

catclose, a catgets function +

catgets, X/Open specification +

catgets, a catgets function +

catopen, a catgets function +

character encoding +

charset conversion at runtime +

charset of PO files +

check format strings +

checking of translations +

clisp +

clisp C sources +

codeset +

comments in PO files +

Common Lisp +

compare PO files +

comparison of interfaces +

compatibility with X/Open msgfmt +

compendium +

compendium, creating +

concatenate PO files +

concatenating PO files into a compendium +

concatenation of strings +

`config.h.in´ file +

convert binary message catalog into PO file +

convert translations to a different encoding +

converting a package to use gettext +

country codes +

create new PO file +

creating a new PO file +

creating compendia +

currency symbols +

d

+ +

date format +

dcngettext +

debugging messages marked as format strings +

dialect +

disabling NLS +

distribution tarball +

dngettext +

dollar substitution +

domain ambiguities +

duplicate elimination +

duplicate removal +

e

+ +

editing comments in PO files +

Editing PO Files +

editing translations +

Emacs Lisp +

Emacs PO Mode +

encoding +

encoding conversion +

encoding conversion at runtime +

encoding for your language +

encoding list +

encoding of PO files +

environment variables +

envsubst program, usage +

eval_gettext function, usage +

eval_ngettext function, usage +

evolution of packages +

extracting parts of a PO file into a compendium +

f

+ +

file format, `.mo´ +

file format, `.po´ +

files, `.po´ and `.mo´ +

files, `.pot´ +

filter messages according to attributes +

find common messages +

force use of fuzzy entries +

format strings +

Free Pascal +

function attribute, __format__ +

function attribute, __format_arg__ +

fuzzy entries +

g

+ +

gawk +

GCC-source +

generate binary message catalog from PO file +

generate translation catalog in English +

gettext files +

gettext installation +

gettext interface +

gettext program, usage +

gettext, a programmer's view +

`gettext.h´ file +

gettext vs catgets +

gettextize program, usage +

GNOME PO file editor +

GUI programs +

guile +

h

+ +

hash table, inside MO files +

he, she, and they +

header entry of a PO file +

help option +

history of GNU gettext +

i

+ +

i18n +

importing PO files +

include file `libintl.h´, include file `libintl.h´, include file `libintl.h´, include file `libintl.h´ +

initialization +

initialize new PO file +

initialize translations from a compendium +

installing gettext +

interface to catgets +

internationalization +

inttypes.h +

ISO 3166 +

ISO 639 +

j

+ +

Java +

Java mode, and msgfmt program +

Java mode, and msgunfmt program +

Java, string concatenation +

k

+ +

KDE PO file editor +

keyboard accelerator checking +

l

+ +

l10n +

language codes +

language selection +

language selection at runtime +

large package +

libiconv library +

libintl for C# +

libintl for Java +

libintl library +

librep Lisp +

`LINGUAS´ file +

link with `libintl´ +

Linux, Linux, Linux +

Lisp +

list of translation teams, where to find +

locale facet, LC_ALL +

locale facet, LC_COLLATE +

locale facet, LC_CTYPE, locale facet, LC_CTYPE, locale facet, LC_CTYPE +

locale facet, LC_MESSAGES, locale facet, LC_MESSAGES +

locale facet, LC_MONETARY, locale facet, LC_MONETARY +

locale facet, LC_NUMERIC, locale facet, LC_NUMERIC +

locale facet, LC_RESPONSES +

locale facet, LC_TIME, locale facet, LC_TIME +

locale facets +

locale program +

localization +

lookup message translation, lookup message translation +

lookup plural message translation, lookup plural message translation +

m

+ +

magic signature of MO files +

`Makevars´ file +

manipulating PO files +

marking Perl sources +

marking string initializers +

marking strings that require translation +

marking strings, preparations +

marking translatable strings +

menu entries +

menu, keyboard accelerator support +

merge PO files +

merging two PO files +

message catalog files location +

messages +

migration from earlier versions of gettext +

`mkinstalldirs´ file +

mnemonics of menu entries +

MO file's format +

modify message attrributes +

msgattrib program, usage +

msgcat program, usage +

msgcmp program, usage +

msgcomm program, usage +

msgconv program, usage +

msgen program, usage +

msgexec program, usage +

msgfilter filter and catalog encoding +

msgfilter program, usage +

msgfmt program, usage +

msggrep program, usage +

msginit program, usage +

msgmerge program, usage +

msgunfmt program, usage +

msguniq program, usage +

multi-line strings +

n

+ +

N_, a convenience macro +

Native Language Support +

Natural Language Support +

newlines in PO files +

ngettext +

ngettext program, usage +

NLS +

number format +

o

+ +

Object Pascal +

obsolete entries +

optimization of gettext functions +

orthography +

outdigits +

output to stdout, xgettext +

overview of gettext +

p

+ +

package and version declaration in `configure.in´ +

package build and installation options +

package distributor's view of gettext +

package installer's view of gettext +

package maintainer's view of gettext +

paragraphs +

Pascal +

Perl +

Perl default keywords +

Perl invalid string interpolation +

Perl long lines +

Perl parentheses +

Perl pitfalls +

Perl quote-like expressions +

Perl special keywords for hash-lookups +

Perl valid string interpolation +

PHP +

Pike +

plural form formulas +

plural forms +

plural forms, in MO files +

plural forms, in PO files +

PO files' format +

PO mode (Emacs) commands +

po_message_iterator +

po_message_iterator_free +

po_message_msgid +

po_message_msgid_plural +

po_message_msgstr +

po_message_msgstr_plural +

po_next_message +

portability problems with sed +

`POTFILES.in´ file +

preparing programs for translation +

preparing shell scripts for translation +

problems with catgets interface +

programming languages +

Python +

q

+ +

Qt format strings +

Qt mode, and msgfmt program +

quotation marks, quotation marks +

quote characters, use in PO files +

r

+ +

s

+ +

Scheme +

scripting languages +

search messages in a catalog +

selecting message language +

sentences +

setting up gettext at build time +

setting up gettext at run time +

several domains +

sex +

sgettext +

she, he, and they +

shell format string +

shell scripts +

Smalltalk +

sorting msgcat output +

sorting msgmerge output +

sorting msgunfmt output +

sorting output of xgettext +

specifying plural form in a PO file +

standard output, and msgcat +

standard output, and msgmerge program +

string concatenation +

string normalization in entries +

style +

supported languages, xgettext +

t

+ +

Tcl +

Tcl mode, and msgfmt program +

Tcl mode, and msgunfmt program +

template PO file +

testing `.po´ files for equivalence +

Tk's scripting language +

translated entries +

translating menu entries +

translation aspects +

Translation Matrix +

Translation Project +

turning off NLS support +

tutorial of gettext usage +

u

+ +

unify duplicate translations +

untranslated entries +

update translations from a compendium +

upgrading to new versions of gettext +

v

+ +

version control for backup files, msgmerge +

w

+ +

wxWindows library +

-#include <libintl.h>
-

- -

-Similarly, each C module containing printf()/fprintf()/... -calls with a format string that could be a translated C string (even if -the C string comes from a different C module) should contain the line: - -

- -

-#include <libintl.h>
-

- -

-The remaining changes to your C sources are discussed in the further -sections of this chapter. - -

- - - -

3.1 Triggering `gettext` Operations

- -

- -The initialization of locale data should be done with more or less -the same code in every program, as demonstrated below: - -

- -

-int
-main (int argc, char *argv[])
-{
-  ...
-  setlocale (LC_ALL, "");
-  bindtextdomain (PACKAGE, LOCALEDIR);
-  textdomain (PACKAGE);
-  ...
-}
-

- -

-PACKAGE and LOCALEDIR should be provided either by -`config.h´ or by the Makefile. For now consult the gettext -or hello sources for more information. - -

- - -The use of LC_ALL might not be appropriate for you. -LC_ALL includes all locale categories and especially -LC_CTYPE. This later category is responsible for determining -character classes with the isalnum etc. functions from -`ctype.h´ which could especially for programs, which process some -kind of input language, be wrong. For example this would mean that a -source code using the ç (c-cedilla character) is runnable in -France but not in the U.S. - -

-Some systems also have problems with parsing numbers using the -scanf functions if an other but the LC_ALL locale is used. -The standards say that additional formats but the one known in the -"C" locale might be recognized. But some systems seem to reject -numbers in the "C" locale format. In some situation, it might -also be a problem with the notation itself which makes it impossible to -recognize whether the number is in the "C" locale or the local -format. This can happen if thousands separator characters are used. -Some locales define this character according to the national -conventions to '.' which is the same character used in the -"C" locale to denote the decimal point. - -

-So it is sometimes necessary to replace the LC_ALL line in the -code above by a sequence of setlocale lines - -

- -

-{
-  ...
-  setlocale (LC_CTYPE, "");
-  setlocale (LC_MESSAGES, "");
-  ...
-}
-

- -

- - - - - - - -On all POSIX conformant systems the locale categories LC_CTYPE, -LC_MESSAGES, LC_COLLATE, LC_MONETARY, -LC_NUMERIC, and LC_TIME are available. On some systems -which are only ISO C compliant, LC_MESSAGES is missing, but -a substitute for it is defined in GNU gettext's <libintl.h>. - -

-Note that changing the LC_CTYPE also affects the functions -declared in the <ctype.h> standard header. If this is not -desirable in your application (for example in a compiler's parser), -you can use a set of substitute functions which hardwire the C locale, -such as found in the <c-ctype.h> and <c-ctype.c> files -in the gettext source distribution. - -

-It is also possible to switch the locale forth and back between the -environment dependent locale and the C locale, but this approach is -normally avoided because a setlocale call is expensive, -because it is tedious to determine the places where a locale switch -is needed in a large program's source, and because switching a locale -is not multithread-safe. - -

- - -

3.2 Preparing Translatable Strings

- -

- -Before strings can be marked for translations, they sometimes need to -be adjusted. Usually preparing a string for translation is done right -before marking it, during the marking phase which is described in the -next sections. What you have to keep in mind while doing that is the -following. - -

- -

- -Decent English style. - -
- -Entire sentences. - -
- -Split at paragraphs. - -
- -Use format strings instead of string concatenation. -

- -

-Let's look at some examples of these guidelines. - -

- -Translatable strings should be in good English style. If slang language -with abbreviations and shortcuts is used, often translators will not -understand the message and will produce very inappropriate translations. - -

- -

-"%s: is parameter\n"
-

- -

-This is nearly untranslatable: Is the displayed item a parameter or -the parameter? - -

- -

-"No match"
-

- -

-The ambiguity in this message makes it ununderstandable: Is the program -attempting to set something on fire? Does it mean "The given object does -not match the template"? Does it mean "The template does not fit for any -of the objects"? - -

- -In both cases, adding more words to the message will help both the -translator and the English speaking user. - -

- -Translatable strings should be entire sentences. It is often not possible -to translate single verbs or adjectives in a substitutable way. - -

- -

-printf ("File %s is %s protected", filename, rw ? "write" : "read");
-

- -

-Most translators will not look at the source and will thus only see the -string "File %s is %s protected", which is unintelligible. Change -this to - -

- -

-printf (rw ? "File %s is write protected" : "File %s is read protected",
-        filename);
-

- -

-This way the translator will not only understand the message, she will -also be able to find the appropriate grammatical construction. The French -translator for example translates "write protected" like "protected -against writing". - -

-Entire sentences are also important because in many languages, the -declination of some word in a sentence depends on the gender or the -number (singular/plural) of another part of the sentence. There are -usually more interdependencies between words than in English. The -consequence is that asking a translator to translate two half-sentences -and then combining these two half-sentences through dumb string concatenation -will not work, for many languages, even though it would work for English. -That's why translators need to handle entire sentences. - -

-Often sentences don't fit into a single line. If a sentence is output -using two subsequent printf statements, like this - -

- -

-printf ("Locale charset \"%s\" is different from\n", lcharset);
-printf ("input file charset \"%s\".\n", fcharset);
-

- -

-the translator would have to translate two half sentences, but nothing -in the POT file would tell her that the two half sentences belong together. -It is necessary to merge the two printf statements so that the -translator can handle the entire sentence at once and decide at which -place to insert a line break in the translation (if at all): - -

- -

-printf ("Locale charset \"%s\" is different from\n\
-input file charset \"%s\".\n", lcharset, fcharset);
-

- -

-You may now ask: how about two or more adjacent sentences? Like in this case: - -

- -

-puts ("Apollo 13 scenario: Stack overflow handling failed.");
-puts ("On the next stack overflow we will crash!!!");
-

- -

-Should these two statements merged into a single one? I would recommend to -merge them if the two sentences are related to each other, because then it -makes it easier for the translator to understand and translate both. On -the other hand, if one of the two messages is a stereotypic one, occurring -in other places as well, you will do a favour to the translator by not -merging the two. (Identical messages occurring in several places are -combined by xgettext, so the translator has to handle them once only.) - -

- -Translatable strings should be limited to one paragraph; don't let a -single message be longer than ten lines. The reason is that when the -translatable string changes, the translator is faced with the task of -updating the entire translated string. Maybe only a single word will -have changed in the English string, but the translator doesn't see that -(with the current translation tools), therefore she has to proofread -the entire message. - -

- -Many GNU programs have a `--help´ output that extends over several -screen pages. It is a courtesy towards the translators to split such a -message into several ones of five to ten lines each. While doing that, -you can also attempt to split the documented options into groups, -such as the input options, the output options, and the informative -output options. This will help every user to find the option he is -looking for. - -

- - -Hardcoded string concatenation is sometimes used to construct English -strings: - -

- -

-strcpy (s, "Replace ");
-strcat (s, object1);
-strcat (s, " with ");
-strcat (s, object2);
-strcat (s, "?");
-

- -

-In order to present to the translator only entire sentences, and also -because in some languages the translator might want to swap the order -of object1 and object2, it is necessary to change this -to use a format string: - -

- -

-sprintf (s, "Replace %s with %s?", object1, object2);
-

- -

- -A similar case is compile time concatenation of strings. The ISO C 99 -include file <inttypes.h> contains a macro PRId64 that -can be used as a formatting directive for outputting an `int64_t´ -integer through printf. It expands to a constant string, usually -"d" or "ld" or "lld" or something like this, depending on the platform. -Assume you have code like - -

- -

-printf ("The amount is %0" PRId64 "\n", number);
-

- -

-The gettext tools and library have special support for these -<inttypes.h> macros. You can therefore simply write - -

- -

-printf (gettext ("The amount is %0" PRId64 "\n"), number);
-

- -

-The PO file will contain the string "The amount is %0<PRId64>\n". -The translators will provide a translation containing "%0<PRId64>" -as well, and at runtime the gettext function's result will -contain the appropriate constant string, "d" or "ld" or "lld". - -

-This works only for the predefined <inttypes.h> macros. If -you have defined your own similar macros, let's say `MYPRId64´, -that are not known to xgettext, the solution for this problem -is to change the code like this: - -

- -

-char buf1[100];
-sprintf (buf1, "%0" MYPRId64, number);
-printf (gettext ("The amount is %s\n"), buf1);
-

-This means, you put the platform dependent code in one statement, and the -internationalization code in a different statement. Note that a buffer length -of 100 is safe, because all available hardware integer types are limited to -128 bits, and to print a 128 bit integer one needs at most 54 characters, -regardless whether in decimal, octal or hexadecimal. +The GNU gettext toolset helps programmers and translators +at producing, updating and using translation files, mainly those +PO files which are textual, editable files. This chapter explains +the format of PO files.

- - -All this applies to other programming languages as well. For example, in -Java and C#, string contenation is very frequently used, because it is a -compiler built-in operator. Like in C, in Java, you would change +A PO file is made up of many entries, each entry holding the relation +between an original untranslated string and its corresponding +translation. All entries in a given PO file usually pertain +to a single project, and all translations are expressed in a single +target language. One PO file entry has the following schematic +structure:

-System.out.println("Replace "+object1+" with "+object2+"?");
+white-space
+#  translator-comments
+#. automatic-comments
+#: reference...
+#, flag...
+msgid untranslated-string
+msgstr translated-string

-into a statement involving a format string: +The general structure of a PO file should be well understood by +the translator. When using PO mode, very little has to be known +about the format details, as PO mode takes care of them for her.

- -

-System.out.println(
-    MessageFormat.format("Replace {0} with {1}?",
-                         new Object[] { object1, object2 }));
-

- -

-Similarly, in C#, you would change - -

- -

-Console.WriteLine("Replace "+object1+" with "+object2+"?");
-

-into a statement involving a format string: +A simple entry can look like this:

-Console.WriteLine(
-    String.Format("Replace {0} with {1}?", object1, object2));
+#: lib/error.c:116
+msgid "Unknown system error"
+msgstr "Error desconegut del sistema"

- - -

3.3 How Marks Appear in Sources

- +Entries begin with some optional white space. Usually, when generated +through GNU gettext tools, there is exactly one blank line +between entries. Then comments follow, on lines all starting with the +character #. There are two kinds of comments: those which have +some white space immediately following the #, which comments are +created and maintained exclusively by the translator, and those which +have some non-white character just after the #, which comments +are created and maintained automatically by GNU gettext tools. +All comments, of either kind, are optional.

-All strings requiring translation should be marked in the C sources. Marking -is done in such a way that each translatable string appears to be -the sole argument of some function or preprocessor macro. There are -only a few such possible functions or macros meant for translation, -and their names are said to be marking keywords. The marking is -attached to strings themselves, rather than to what we do with them. -This approach has more uses. A blatant example is an error message -produced by formatting. The format string needs translation, as -well as some strings inserted through some `%s´ specification -in the format, while the result from sprintf may have so many -different instances that it is impractical to list them all in some -`error_string_out()´ routine, say. + + +After white space and comments, entries show two strings, namely +first the untranslated string as it appears in the original program +sources, and then, the translation of this string. The original +string is introduced by the keyword msgid, and the translation, +by msgstr. The two strings, untranslated and translated, +are quoted in various ways in the PO file, using " +delimiters and \ escapes, but the translator does not really +have to pay attention to the precise quoting format, as PO mode fully +takes care of quoting for her.

-This marking operation has two goals. The first goal of marking -is for triggering the retrieval of the translation, at run time. -The keyword are possibly resolved into a routine able to dynamically -return the proper translation, as far as possible or wanted, for the -argument string. Most localizable strings are found in executable -positions, that is, attached to variables or given as parameters to -functions. But this is not universal usage, and some translatable -strings appear in structured initializations. See section 3.6 Special Cases of Translatable Strings. +The msgid strings, as well as automatic comments, are produced +and managed by other GNU gettext tools, and PO mode does not +provide means for the translator to alter these. The most she can +do is merely deleting them, and only by deleting the whole entry. +On the other hand, the msgstr string, as well as translator +comments, are really meant for the translator, and PO mode gives her +the full control she needs.

-The second goal of the marking operation is to help xgettext -at properly extracting all translatable strings when it scans a set -of program sources and produces PO file templates. - -

-The canonical keyword for marking translatable strings is -`gettext´, it gave its name to the whole GNU gettext -package. For packages making only light use of the `gettext´ -keyword, macro or function, it is easily used as is. However, -for packages using the gettext interface more heavily, it -is usually more convenient to give the main keyword a shorter, less -obtrusive name. Indeed, the keyword might appear on a lot of strings -all over the package, and programmers usually do not want nor need -their program sources to remind them forcefully, all the time, that they -are internationalized. Further, a long keyword has the disadvantage -of using more horizontal space, forcing more indentation work on -sources for those trying to keep them within 79 or 80 columns. - -

- -Many packages use `_´ (a simple underline) as a keyword, -and write `_("Translatable string")´ instead of `gettext -("Translatable string")´. Further, the coding rule, from GNU standards, -wanting that there is a space between the keyword and the opening -parenthesis is relaxed, in practice, for this particular usage. -So, the textual overhead per translatable string is reduced to -only three characters: the underline and the two parentheses. -However, even if GNU gettext uses this convention internally, -it does not offer it officially. The real, genuine keyword is truly -`gettext´ indeed. It is fairly easy for those wanting to use -`_´ instead of `gettext´ to declare: - -

- -

-#include <libintl.h>
-#define _(String) gettext (String)
-

- -

-instead of merely using `#include <libintl.h>´. - -

-Later on, the maintenance is relatively easy. If, as a programmer, -you add or modify a string, you will have to ask yourself if the -new or altered string requires translation, and include it within -`_()´ if you think it should be translated. `"%s: %d"´ is -an example of string not requiring translation! - -

- - -

3.4 Marking Translatable Strings

- - -

-In PO mode, one set of features is meant more for the programmer than -for the translator, and allows him to interactively mark which strings, -in a set of program sources, are translatable, and which are not. -Even if it is a fairly easy job for a programmer to find and mark -such strings by other means, using any editor of his choice, PO mode -makes this work more comfortable. Further, this gives translators -who feel a little like programmers, or programmers who feel a little -like translators, a tool letting them work at marking translatable -strings in the program sources, while simultaneously producing a set of -translation in some language, for the package being internationalized. - -

- -The set of program sources, targetted by the PO mode commands describe -here, should have an Emacs tags table constructed for your project, -prior to using these PO file commands. This is easy to do. In any -shell window, change the directory to the root of your project, then -execute a command resembling: - -

- -

-etags src/*.[hc] lib/*.[hc]
-

- -

-presuming here you want to process all `.h´ and `.c´ files -from the `src/´ and `lib/´ directories. This command will -explore all said files and create a `TAGS´ file in your root -directory, somewhat summarizing the contents using a special file -format Emacs can understand. - -

- -For packages following the GNU coding standards, there is -a make goal tags or TAGS which constructs the tag files in -all directories and for all files containing source code. - -

-Once your `TAGS´ file is ready, the following commands assist -the programmer at marking translatable strings in his set of sources. -But these commands are necessarily driven from within a PO file -window, and it is likely that you do not even have such a PO file yet. -This is not a problem at all, as you may safely open a new, empty PO -file, mainly for using these commands. This empty PO file will slowly -fill in while you mark strings as translatable in your program sources. +The comment lines beginning with #, are special because they are +not completely ignored by the programs as comments generally are. The +comma separated list of flags is used by the msgfmt +program to give the user some better diagnostic messages. Currently +there are two forms of flags defined:

, +
fuzzy: - -Search through program sources for a string which looks like a -candidate for translation (po-tags-search). - -
M-, + +This flag can be generated by the msgmerge program or it can be +inserted by the translator herself. It shows that the msgstr +string might not be a correct translation (anymore). Only the translator +can judge if the translation requires further modification, or is +acceptable as is. Once satisfied with the translation, she then removes +this fuzzy attribute. The msgmerge program inserts this +when it combined the msgid and msgstr entries after fuzzy +search only. See section 8.3.6 Fuzzy Entries. + +
c-format: - -Mark the last string found with `_()´ (po-mark-translatable). - -
M-. + +
no-c-format: - -Mark the last string found with a keyword taken from a set of possible -keywords. This command with a prefix allows some management of these -keywords (po-select-mark-and-mark). - -

- -

- -The , (po-tags-search) command searches for the next -occurrence of a string which looks like a possible candidate for -translation, and displays the program source in another Emacs window, -positioned in such a way that the string is near the top of this other -window. If the string is too big to fit whole in this window, it is -positioned so only its end is shown. In any case, the cursor -is left in the PO file window. If the shown string would be better -presented differently in different native languages, you may mark it -using M-, or M-.. Otherwise, you might rather ignore it -and skip to the next string by merely repeating the , command. - -

-A string is a good candidate for translation if it contains a sequence -of three or more letters. A string containing at most two letters in -a row will be considered as a candidate if it has more letters than -non-letters. The command disregards strings containing no letters, -or isolated letters only. It also disregards strings within comments, -or strings already marked with some keyword PO mode knows (see below). - -

-If you have never told Emacs about some `TAGS´ file to use, the -command will request that you specify one from the minibuffer, the -first time you use the command. You may later change your `TAGS´ -file by using the regular Emacs command M-x visit-tags-table, -which will ask you to name the precise `TAGS´ file you want -to use. See section `Tag Tables' in The Emacs Editor. - -

-Each time you use the , command, the search resumes from where it was -left by the previous search, and goes through all program sources, -obeying the `TAGS´ file, until all sources have been processed. -However, by giving a prefix argument to the command (C-u -,), you may request that the search be restarted all over again -from the first program source; but in this case, strings that you -recently marked as translatable will be automatically skipped. - -

-Using this , command does not prevent using of other regular -Emacs tags commands. For example, regular tags-search or -tags-query-replace commands may be used without disrupting the -independent , search sequence. However, as implemented, the -initial , command (or the , command is used with a -prefix) might also reinitialize the regular Emacs tags searching to the -first tags file, this reinitialization might be considered spurious. - -

- - -The M-, (po-mark-translatable) command will mark the -recently found string with the `_´ keyword. The M-. -(po-select-mark-and-mark) command will request that you type -one keyword from the minibuffer and use that keyword for marking -the string. Both commands will automatically create a new PO file -untranslated entry for the string being marked, and make it the -current entry (making it easy for you to immediately proceed to its -translation, if you feel like doing it right away). It is possible -that the modifications made to the program source by M-, or -M-. render some source line longer than 80 columns, forcing you -to break and re-indent this line differently. You may use the O -command from PO mode, or any other window changing command from -Emacs, to break out into the program source window, and do any -needed adjustments. You will have to use some regular Emacs command -to return the cursor to the PO file window, if you want command -, for the next string, say. - -

-The M-. command has a few built-in speedups, so you do not -have to explicitly type all keywords all the time. The first such -speedup is that you are presented with a preferred keyword, -which you may accept by merely typing RET at the prompt. -The second speedup is that you may type any non-ambiguous prefix of the -keyword you really mean, and the command will complete it automatically -for you. This also means that PO mode has to know all -your possible keywords, and that it will not accept mistyped keywords. - -

-If you reply ? to the keyword request, the command gives a -list of all known keywords, from which you may choose. When the -command is prefixed by an argument (C-u M-.), it inhibits -updating any program source or PO file buffer, and does some simple -keyword management instead. In this case, the command asks for a -keyword, written in full, which becomes a new allowed keyword for -later M-. commands. Moreover, this new keyword automatically -becomes the preferred keyword for later commands. By typing -an already known keyword in response to C-u M-., one merely -changes the preferred keyword and does nothing more. - -

-All keywords known for M-. are recognized by the , command -when scanning for strings, and strings already marked by any of those -known keywords are automatically skipped. If many PO files are opened -simultaneously, each one has its own independent set of known keywords. -There is no provision in PO mode, currently, for deleting a known -keyword, you have to quit the file (maybe using q) and reopen -it afresh. When a PO file is newly brought up in an Emacs window, only -`gettext´ and `_´ are known as keywords, and `gettext´ -is preferred for the M-. command. In fact, this is not useful to -prefer `_´, as this one is already built in the M-, command. - -

- - -

3.5 Special Comments preceding Keywords

- -

- -In C programs strings are often used within calls of functions from the -printf family. The special thing about these format strings is -that they can contain format specifiers introduced with %. Assume -we have the code - -

- -

-printf (gettext ("String `%s' has %d characters\n"), s, strlen (s));
-

- -

-A possible German translation for the above string might be: - -

- -

-"%d Zeichen lang ist die Zeichenkette `%s'"
-

- -

-A C programmer, even if he cannot speak German, will recognize that -there is something wrong here. The order of the two format specifiers -is changed but of course the arguments in the printf don't have. -This will most probably lead to problems because now the length of the -string is regarded as the address. + +These flags should not be added by a human. Instead only the +xgettext program adds them. In an automated PO file processing +system as proposed here the user changes would be thrown away again as +soon as the xgettext program generates a new template file. + +The c-format flag tells that the untranslated string and the +translation are supposed to be C format strings. The no-c-format +flag tells that they are not C format strings, even though the untranslated +string happens to look like a C format string (with `%´ directives). + +In case the c-format flag is given for a string the msgfmt +does some more tests to check to validity of the translation. +See section 10.1 Invoking the msgfmt Program, section 4.5 Special Comments preceding Keywords and section 15.3.1 C Format Strings. + +

objc-format +

+ +

no-objc-format +

+ +Likewise for Objective C, see section 15.3.2 Objective C Format Strings. -

-To prevent errors at runtime caused by translations the msgfmt -tool can check statically whether the arguments in the original and the -translation string match in type and number. If this is not the case -and the `-c´ option has been passed to msgfmt, msgfmt -will give an error and refuse to produce a MO file. Thus consequent -use of `msgfmt -c´ will catch the error, so that it cannot cause -cause problems at runtime. +

sh-format +

+ +

no-sh-format +

+ +Likewise for Shell, see section 15.3.3 Shell Format Strings. -

-If the word order in the above German translation would be correct one -would have to write +

python-format +

+ +

no-python-format +

+ +Likewise for Python, see section 15.3.4 Python Format Strings. -

lisp-format +

+ +

no-lisp-format +

+ +Likewise for Lisp, see section 15.3.5 Lisp Format Strings. -

-"%2$d Zeichen lang ist die Zeichenkette `%1$s'"
-

elisp-format +

+ +

no-elisp-format +

+ +Likewise for Emacs Lisp, see section 15.3.6 Emacs Lisp Format Strings. -

-The routines in msgfmt know about this special notation. +

librep-format +

+ +

no-librep-format +

+ +Likewise for librep, see section 15.3.7 librep Format Strings. -

-Because not all strings in a program must be format strings it is not -useful for msgfmt to test all the strings in the `.po´ file. -This might cause problems because the string might contain what looks -like a format specifier, but the string is not used in printf. +

scheme-format +

+ +

no-scheme-format +

+ +Likewise for Scheme, see section 15.3.8 Scheme Format Strings. -

-Therefore the xgettext adds a special tag to those messages it -thinks might be a format string. There is no absolute rule for this, -only a heuristic. In the `.po´ file the entry is marked using the -c-format flag in the #, comment line (see section 2.2 The Format of PO Files). +

smalltalk-format +

+ +

no-smalltalk-format +

+ +Likewise for Smalltalk, see section 15.3.9 Smalltalk Format Strings. -

- - -The careful reader now might say that this again can cause problems. -The heuristic might guess it wrong. This is true and therefore -xgettext knows about a special kind of comment which lets -the programmer take over the decision. If in the same line as or -the immediately preceding line to the gettext keyword -the xgettext program finds a comment containing the words -xgettext:c-format, it will mark the string in any case with -the c-format flag. This kind of comment should be used when -xgettext does not recognize the string as a format string but -it really is one and it should be tested. Please note that when the -comment is in the same line as the gettext keyword, it must be -before the string to be translated. +

java-format +

+ +

no-java-format +

+ +Likewise for Java, see section 15.3.10 Java Format Strings. -

-This situation happens quite often. The printf function is often -called with strings which do not contain a format specifier. Of course -one would normally use fputs but it does happen. In this case -xgettext does not recognize this as a format string but what -happens if the translation introduces a valid format specifier? The -printf function will try to access one of the parameters but none -exists because the original code does not pass any parameters. +

csharp-format +

+ +

no-csharp-format +

+ +Likewise for C#, see section 15.3.11 C# Format Strings. -

-xgettext of course could make a wrong decision the other way -round, i.e. a string marked as a format string actually is not a format -string. In this case the msgfmt might give too many warnings and -would prevent translating the `.po´ file. The method to prevent -this wrong decision is similar to the one used above, only the comment -to use must contain the string xgettext:no-c-format. +

awk-format +

+ +

no-awk-format +

+ +Likewise for awk, see section 15.3.12 awk Format Strings. -

-If a string is marked with c-format and this is not correct the -user can find out who is responsible for the decision. See -section 4.1 Invoking the xgettext Program to see how the --debug option can be -used for solving this problem. +

object-pascal-format +

+ +

no-object-pascal-format +

+ +Likewise for Object Pascal, see section 15.3.13 Object Pascal Format Strings. -

ycp-format +

+ +

no-ycp-format +

+ +Likewise for YCP, see section 15.3.14 YCP Format Strings. +

tcl-format +

+ +

no-tcl-format +

+ +Likewise for Tcl, see section 15.3.15 Tcl Format Strings. -

3.6 Special Cases of Translatable Strings

perl-format +

+ +

no-perl-format +

+ +Likewise for Perl, see section 15.3.16 Perl Format Strings. -

- -The attentive reader might now point out that it is not always possible -to mark translatable string with gettext or something like this. -Consider the following case: +

perl-brace-format +

+ +

no-perl-brace-format +

+ +Likewise for Perl brace, see section 15.3.16 Perl Format Strings. -

php-format +

+ +

no-php-format +

+ +Likewise for PHP, see section 15.3.17 PHP Format Strings. -

-{
-  static const char *messages[] = {
-    "some very meaningful message",
-    "and another one"
-  };
-  const char *string;
-  ...
-  string
-    = index > 1 ? "a default message" : messages[index];
+gcc-internal-format
+

+
+
no-gcc-internal-format
+

+
+Likewise for the GCC sources, see section 15.3.18  GCC internal Format Strings.
 
-  fputs (string);
-  ...
-}
-

qt-format +

+ +

no-qt-format +

+ +Likewise for Qt, see section 15.3.19 Qt Format Strings. -

-While it is no problem to mark the string "a default message" it -is not possible to mark the string initializers for messages. -What is to be done? We have to fulfill two tasks. First we have to mark the -strings so that the xgettext program (see section 4.1 Invoking the xgettext Program) -can find them, and second we have to translate the string at runtime -before printing them. + -

-The first task can be fulfilled by creating a new keyword, which names a -no-op. For the second we have to mark all access points to a string -from the array. So one solution can look like this: + + +A different kind of entries is used for translations which involve +plural forms.

-#define gettext_noop(String) String
-
-{
-  static const char *messages[] = {
-    gettext_noop ("some very meaningful message"),
-    gettext_noop ("and another one")
-  };
-  const char *string;
-  ...
-  string
-    = index > 1 ? gettext ("a default message") : gettext (messages[index]);
-
-  fputs (string);
-  ...
-}
+white-space
+#  translator-comments
+#. automatic-comments
+#: reference...
+#, flag...
+msgid untranslated-string-singular
+msgid_plural untranslated-string-plural
+msgstr[0] translated-string-case-0
+...
+msgstr[N] translated-string-case-n

-Please convince yourself that the string which is written by -fputs is translated in any case. How to get xgettext know -the additional keyword gettext_noop is explained in section 4.1 Invoking the xgettext Program. - -

-The above is of course not the only solution. You could also come along -with the following one: +Such an entry can look like this:

-#define gettext_noop(String) String
-
-{
-  static const char *messages[] = {
-    gettext_noop ("some very meaningful message",
-    gettext_noop ("and another one")
-  };
-  const char *string;
-  ...
-  string
-    = index > 1 ? gettext_noop ("a default message") : messages[index];
-
-  fputs (gettext (string));
-  ...
-}
+#: src/msgcmp.c:338 src/po-lex.c:699
+#, c-format
+msgid "found %d fatal error"
+msgid_plural "found %d fatal errors"
+msgstr[0] "s'ha trobat %d error fatal"
+msgstr[1] "s'han trobat %d errors fatals"

-But this has a drawback. The programmer has to take care that -he uses gettext_noop for the string "a default message". -A use of gettext could have in rare cases unpredictable results. + +It happens that some lines, usually whitespace or comments, follow the +very last entry of a PO file. Such lines are not part of any entry, +and PO mode is unable to take action on those lines. By using the +PO mode function M-x po-normalize, the translator may get +rid of those spurious lines. See section 8.3.4 Normalizing Strings in Entries.

-One advantage is that you need not make control flow analysis to make -sure the output is really translated in any case. But this analysis is -generally not very difficult. If it should be in any situation you can -use this second method in this situation. +The remainder of this section may be safely skipped by those using +PO mode, yet it may be interesting for everybody to have a better +idea of the precise format of a PO file. On the other hand, those +not having Emacs handy should carefully continue reading on.

- - -

3.7 Marking Proper Names for Translation

-Should names of persons, cities, locations etc. be marked for translation -or not? People who only know languages that can be written with Latin -letters (English, Spanish, French, German, etc.) are tempted to say "no", -because names usually do not change when transported between these languages. -However, in general when translating from one script to another, names -are translated too, usually phonetically or by transliteration. For -example, Russian or Greek names are converted to the Latin alphabet when -being translated to English, and English or French names are converted -to the Katakana script when being translated to Japanese. This is -necessary because the speakers of the target language in general cannot -read the script the name is originally written in. - -

-As a programmer, you should therefore make sure that names are marked -for translation, with a special comment telling the translators that it -is a proper name and how to pronounce it. Like this: +Each of untranslated-string and translated-string respects +the C syntax for a character string, including the surrounding quotes +and embedded backslashed escape sequences. When the time comes +to write multi-line strings, one should not use escaped newlines. +Instead, a closing quote should follow the last character on the +line to be continued, and an opening quote should resume the string +at the beginning of the following PO file line. For example:

-printf (_("Written by %s.\n"),
-        /* TRANSLATORS: This is a proper name.  See the gettext
-           manual, section Names.  Note this is actually a non-ASCII
-           name: The first name is (with Unicode escapes)
-           "Fran\u00e7ois" or (with HTML entities) "Fran&ccedil;ois".
-           Pronounciation is like "fraa-swa pee-nar".  */
-        _("Francois Pinard"));
+msgid ""
+"Here is an example of how one might continue a very long string\n"
+"for the common case the string represents multi-line output.\n"

-As a translator, you should use some care when translating names, because -it is frustrating if people see their names mutilated or distorted. If -your language uses the Latin script, all you need to do is to reproduce -the name as perfectly as you can within the usual character set of your -language. In this particular case, this means to provide a translation -containing the c-cedilla character. If your language uses a different -script and the people speaking it don't usually read Latin words, it means -transliteration; but you should still give, in parentheses, the original -writing of the name -- for the sake of the people that do read the Latin -script. Here is an example, using Greek as the target script: +In this example, the empty string is used on the first line, to +allow better alignment of the H from the word `Here´ +over the f from the word `for´. In this example, the +msgid keyword is followed by three strings, which are meant +to be concatenated. Concatenating the empty string does not change +the resulting overall string, but it is a way for us to comply with +the necessity of msgid to be followed by a string on the same +line, while keeping the multi-line presentation left-justified, as +we find this to be a cleaner disposition. The empty string could have +been omitted, but only if the string starting with `Here´ was +promoted on the first line, right after msgid.(2) It was not really necessary +either to switch between the two last quoted strings immediately after +the newline `\n´, the switch could have occurred after any +other character, we just did it this way because it is neater.

- -

-#. This is a proper name.  See the gettext
-#. manual, section Names.  Note this is actually a non-ASCII
-#. name: The first name is (with Unicode escapes)
-#. "Fran\u00e7ois" or (with HTML entities) "Fran&ccedil;ois".
-#. Pronounciation is like "fraa-swa pee-nar".
-msgid "Francois Pinard"
-msgstr "\phi\rho\alpha\sigma\omicron\alpha \pi\iota\nu\alpha\rho"
-       " (Francois Pinard)"
-

-Because translation of names is such a sensitive domain, it is a good -idea to test your translation before submitting it. + +One should carefully distinguish between end of lines marked as +`\n´ inside quotes, which are part of the represented +string, and end of lines in the PO file itself, outside string quotes, +which have no incidence on the represented string.

-The translation project http://sourceforge.net/projects/translation -has set up a POT file and translation domain consisting of program author -names, with better facilities for the translator than those presented here. -Namely, there the original name is written directly in Unicode (rather -than with Unicode escapes or HTML entities), and the pronounciation is -denoted using the International Phonetic Alphabet (see -http://www.wikipedia.org/wiki/International_Phonetic_Alphabet). - -

-However, we don't recommend this approach for all POT files in all packages, -because this would force translators to use PO files in UTF-8 encoding, -which is - in the current state of software (as of 2003) - a major hassle -for translators using GNU Emacs or XEmacs with po-mode. - -

- - -

3.8 Preparing Library Sources

- -

-When you are preparing a library, not a program, for the use of -gettext, only a few details are different. Here we assume that -the library has a translation domain and a POT file of its own. (If -it uses the translation domain and POT file of the main program, then -the previous sections apply without changes.) + +Outside strings, white lines and comments may be used freely. +Comments start at the beginning of a line with `#´ and extend +until the end of the PO file line. Comments written by translators +should have the initial `#´ immediately followed by some white +space. If the `#´ is not immediately followed by white space, +this comment is most likely generated and managed by specialized GNU +tools, and might disappear or be replaced unexpectedly when the PO +file is given to msgmerge.

- -

- -The library code doesn't call setlocale (LC_ALL, ""). It's the -responsibility of the main program to set the locale. The library's -documentation should mention this fact, so that developers of programs -using the library are aware of it. - -
- -The library code doesn't call textdomain (PACKAGE), because it -would interfere with the text domain set by the main program. - -

- -The initialization code for a program was - - -

-  setlocale (LC_ALL, "");
-  bindtextdomain (PACKAGE, LOCALEDIR);
-  textdomain (PACKAGE);
-

- -For a library it is reduced to - - -

-  bindtextdomain (PACKAGE, LOCALEDIR);
-

- -If your library's API doesn't already have an initialization function, -you need to create one, containing at least the bindtextdomain -invocation. However, you usually don't need to export and document this -initialization function: It is sufficient that all entry points of the -library call the initialization function if it hasn't been called before. -The typical idiom used to achieve this is a static boolean variable that -indicates whether the initialization function has been called. Like this: - - -

-static bool libfoo_initialized;
-
-static void
-libfoo_initialize (void)
-{
-  bindtextdomain (PACKAGE, LOCALEDIR);
-  libfoo_initialized = true;
-}
-
-/* This function is part of the exported API.  */
-struct foo *
-create_foo (...)
-{
-  /* Must ensure the initialization is performed.  */
-  if (!libfoo_initialized)
-    libfoo_initialize ();
-  ...
-}
-
-/* This function is part of the exported API.  The argument must be
-   non-NULL and have been created through create_foo().  */
-int
-foo_refcount (struct foo *argument)
-{
-  /* No need to invoke the initialization function here, because
-     create_foo() must already have been called before.  */
-  ...
-}
-

- -

- -The usual declaration of the `_´ macro in each source file was - - -
```
-#include <libintl.h>
-#define _(String) gettext (String)
-
```
- -for a program. For a library, which has its own translation domain, -it reads like this: - - -
```
-#include <libintl.h>
-#define _(String) dgettext (PACKAGE, String)
-
```
- -In other words, dgettext is used instead of gettext. -Similary, the dngettext function should be used in place of the -ngettext function. -

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_4.html b/gettext-tools/doc/gettext_4.html index 1ece238da..f8e7d37f7 100644 --- a/gettext-tools/doc/gettext_4.html +++ b/gettext-tools/doc/gettext_4.html @@ -1,546 +1,1159 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - 4 Making the PO Template File +GNU gettext utilities - 4 Preparing Program Sources -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

4 Making the PO Template File

4 Preparing Program Sources

- + + +

+ +

+For the programmer, changes to the C source code fall into three +categories. First, you have to make the localization functions +known to all modules needing message translation. Second, you should +properly trigger the operation of GNU gettext when the program +initializes, usually from the main function. Last, you should +identify and especially mark all constant strings in your program +needing translation.

-After preparing the sources, the programmer creates a PO template file. -This section explains how to use xgettext for this purpose. +Presuming that your set of programs, or package, has been adjusted +so all needed GNU gettext files are available, and your +`Makefile´ files are adjusted (see section 13 The Maintainer's View), each C module +having translated C strings should contain the line:

-xgettext creates a file named `domainname.po´. You -should then rename it to `domainname.pot´. (Why doesn't -xgettext create it under the name `domainname.pot´ -right away? The answer is: for historical reasons. When xgettext -was specified, the distinction between a PO file and PO file template -was fuzzy, and the suffix `.pot´ wasn't in use at that time.) + + +

+#include <libintl.h>
+

+ +

+Similarly, each C module containing printf()/fprintf()/... +calls with a format string that could be a translated C string (even if +the C string comes from a different C module) should contain the line: + +

+ +

+#include <libintl.h>
+

+ +

+The remaining changes to your C sources are discussed in the further +sections of this chapter.

4.1 Invoking the `xgettext` Program

4.1 Triggering `gettext` Operations

- - + +The initialization of locale data should be done with more or less +the same code in every program, as demonstrated below: + +

-xgettext [option] [inputfile] ...
+int
+main (int argc, char *argv[])
+{
+  ...
+  setlocale (LC_ALL, "");
+  bindtextdomain (PACKAGE, LOCALEDIR);
+  textdomain (PACKAGE);
+  ...
+}

-The xgettext program extracts translatable strings from given -input files. +PACKAGE and LOCALEDIR should be provided either by +`config.h´ or by the Makefile. For now consult the gettext +or hello sources for more information.

+ + +The use of LC_ALL might not be appropriate for you. +LC_ALL includes all locale categories and especially +LC_CTYPE. This later category is responsible for determining +character classes with the isalnum etc. functions from +`ctype.h´ which could especially for programs, which process some +kind of input language, be wrong. For example this would mean that a +source code using the ç (c-cedilla character) is runnable in +France but not in the U.S. +

+Some systems also have problems with parsing numbers using the +scanf functions if an other but the LC_ALL locale is used. +The standards say that additional formats but the one known in the +"C" locale might be recognized. But some systems seem to reject +numbers in the "C" locale format. In some situation, it might +also be a problem with the notation itself which makes it impossible to +recognize whether the number is in the "C" locale or the local +format. This can happen if thousands separator characters are used. +Some locales define this character according to the national +conventions to '.' which is the same character used in the +"C" locale to denote the decimal point. -

4.1.1 Input file location

+So it is sometimes necessary to replace the LC_ALL line in the +code above by a sequence of setlocale lines -

`inputfile ...´ -

-Input files. +

+{
+  ...
+  setlocale (LC_CTYPE, "");
+  setlocale (LC_MESSAGES, "");
+  ...
+}
+

`-f file´ -

`--files-from=file´ -

- - -Read the names of the input files from file instead of getting -them from the command line. +

+ + + + + + + +On all POSIX conformant systems the locale categories LC_CTYPE, +LC_MESSAGES, LC_COLLATE, LC_MONETARY, +LC_NUMERIC, and LC_TIME are available. On some systems +which are only ISO C compliant, LC_MESSAGES is missing, but +a substitute for it is defined in GNU gettext's <libintl.h>. -

`-D directory´ -

`--directory=directory´ -

- - -Add directory to the list of directories. Source files are -searched relative to this list of directories. The resulting `.po´ -file will be written relative to the current directory, though. +

+Note that changing the LC_CTYPE also affects the functions +declared in the <ctype.h> standard header. If this is not +desirable in your application (for example in a compiler's parser), +you can use a set of substitute functions which hardwire the C locale, +such as found in the <c-ctype.h> and <c-ctype.c> files +in the gettext source distribution. + +

+It is also possible to switch the locale forth and back between the +environment dependent locale and the C locale, but this approach is +normally avoided because a setlocale call is expensive, +because it is tedious to determine the places where a locale switch +is needed in a large program's source, and because switching a locale +is not multithread-safe. + +

+ +

4.2 Preparing Translatable Strings

-If inputfile is `-´, standard input is read. + +Before strings can be marked for translations, they sometimes need to +be adjusted. Usually preparing a string for translation is done right +before marking it, during the marking phase which is described in the +next sections. What you have to keep in mind while doing that is the +following.

-
4.1.2 Output file location
+Decent English style. -
+
-
`-d name´ -
-
`--default-domain=name´ -
- - -Use `name.po´ for output (instead of `messages.po´). +Entire sentences. -
`-o file´ -
-
`--output=file´ -
- - -Write output to specified file (instead of `name.po´ or -`messages.po´). +
-
`-p dir´ -
-
`--output-dir=dir´ -
- - -Output files will be placed in directory dir. +Split at paragraphs. -
+
+ +Use format strings instead of string concatenation. +

- -If the output file is `-´ or `/dev/stdout´, the output -is written to standard output. +Let's look at some examples of these guidelines.

+ +Translatable strings should be in good English style. If slang language +with abbreviations and shortcuts is used, often translators will not +understand the message and will produce very inappropriate translations. +

4.1.3 Choice of input file language

+"%s: is parameter\n"
+

`-L name´ -: -
`--language=name´ -: - - - -Specifies the language of the input files. The supported languages -are C, C++, ObjectiveC, PO, Python, -Lisp, EmacsLisp, librep, Scheme, Smalltalk, -Java, JavaProperties, C#, awk, YCP, -Tcl, Perl, PHP, GCC-source, NXStringTable, -RST, Glade. - -
`-C´ -: -
`--c++´ -: - - -This is a shorthand for --language=C++. +
-

+"No match"
+

-By default the language is guessed depending on the input file name -extension. +The ambiguity in this message makes it ununderstandable: Is the program +attempting to set something on fire? Does it mean "The given object does +not match the template"? Does it mean "The template does not fit for any +of the objects"?

+ +In both cases, adding more words to the message will help both the +translator and the English speaking user. +

+ +Translatable strings should be entire sentences. It is often not possible +to translate single verbs or adjectives in a substitutable way. -

4.1.4 Input file interpretation

`--from-code=name´ -: - -Specifies the encoding of the input files. This option is needed only -if some untranslated message strings or their corresponding comments -contain non-ASCII characters. Note that Python, Tcl, and Glade input -files are always assumed to be in UTF-8, regardless of this option. +
+Most translators will not look at the source and will thus only see the +string "File %s is %s protected", which is unintelligible. Change +this to -

+ +

+printf (rw ? "File %s is write protected" : "File %s is read protected",
+        filename);
+

-By default the input files are assumed to be in ASCII. +This way the translator will not only understand the message, she will +also be able to find the appropriate grammatical construction. The French +translator for example translates "write protected" like "protected +against writing".

+Entire sentences are also important because in many languages, the +declination of some word in a sentence depends on the gender or the +number (singular/plural) of another part of the sentence. There are +usually more interdependencies between words than in English. The +consequence is that asking a translator to translate two half-sentences +and then combining these two half-sentences through dumb string concatenation +will not work, for many languages, even though it would work for English. +That's why translators need to handle entire sentences. +

+Often sentences don't fit into a single line. If a sentence is output +using two subsequent printf statements, like this -

4.1.5 Operation mode

+printf ("Locale charset \"%s\" is different from\n", lcharset);
+printf ("input file charset \"%s\".\n", fcharset);
+

`-j´ -

`--join-existing´ -

- - -Join messages with existing file. +

+the translator would have to translate two half sentences, but nothing +in the POT file would tell her that the two half sentences belong together. +It is necessary to merge the two printf statements so that the +translator can handle the entire sentence at once and decide at which +place to insert a line break in the translation (if at all): -

`-x file´ -

`--exclude-file=file´ -

- - -Entries from file are not extracted. file should be a PO or -POT file. +

`-c [tag]´ -

`--add-comments[=tag]´ -

- - -Place comment block with tag (or those preceding keyword lines) -in output file. +

+printf ("Locale charset \"%s\" is different from\n\
+input file charset \"%s\".\n", lcharset, fcharset);
+

+You may now ask: how about two or more adjacent sentences? Like in this case: +

+ +

+puts ("Apollo 13 scenario: Stack overflow handling failed.");
+puts ("On the next stack overflow we will crash!!!");
+

+Should these two statements merged into a single one? I would recommend to +merge them if the two sentences are related to each other, because then it +makes it easier for the translator to understand and translate both. On +the other hand, if one of the two messages is a stereotypic one, occurring +in other places as well, you will do a favour to the translator by not +merging the two. (Identical messages occurring in several places are +combined by xgettext, so the translator has to handle them once only.) -

4.1.6 Language specific options

+ +Translatable strings should be limited to one paragraph; don't let a +single message be longer than ten lines. The reason is that when the +translatable string changes, the translator is faced with the task of +updating the entire translated string. Maybe only a single word will +have changed in the English string, but the translator doesn't see that +(with the current translation tools), therefore she has to proofread +the entire message. -

+ +Many GNU programs have a `--help´ output that extends over several +screen pages. It is a courtesy towards the translators to split such a +message into several ones of five to ten lines each. While doing that, +you can also attempt to split the documented options into groups, +such as the input options, the output options, and the informative +output options. This will help every user to find the option he is +looking for. -

`-a´ -

`--extract-all´ -

- - -Extract all strings. +

+ + +Hardcoded string concatenation is sometimes used to construct English +strings: -This option has an effect with most languages, namely C, C++, ObjectiveC, -Shell, Python, Lisp, EmacsLisp, librep, Java, C#, awk, Tcl, Perl, PHP, -GCC-source, Glade. +

`-k keywordspec´ -

`--keyword[=keywordspec]´ -

- - -Additional keyword to be looked for (without keywordspec means not to -use default keywords). - - -If keywordspec is a C identifer id, xgettext looks -for strings in the first argument of each call to the function or macro -id. If keywordspec is of the form -`id:argnum´, xgettext looks for strings in the -argnumth argument of the call. If keywordspec is of the form -`id:argnum1,argnum2´, xgettext looks for -strings in the argnum1st argument and in the argnum2nd argument -of the call, and treats them as singular/plural variants for a message -with plural handling. -
-The default keyword specifications, which are always looked for if not -explicitly disabled, are gettext, dgettext:2, -dcgettext:2, ngettext:1,2, dngettext:2,3, -dcngettext:2,3, and gettext_noop. -
-This option has an effect with most languages, namely C, C++, ObjectiveC, -Shell, Python, Lisp, EmacsLisp, librep, Java, C#, awk, Tcl, Perl, PHP, -GCC-source, Glade. - -

`--flag=word:arg:flag´ -

- -Specifies additional flags for strings occurring as part of the argth -argument of the function word. The possible flags are the possible -format string indicators, such as `c-format´, and their negations, -such as `no-c-format´, possibly prefixed with `pass-´. -
- -The meaning of --flag=function:arg:lang-format -is that in language lang, the specified function expects as -argth argument a format string. (For those of you familiar with -GCC function attributes, --flag=function:arg:c-format is -roughly equivalent to the declaration -`__attribute__ ((__format__ (__printf__, arg, ...)))´ attached -to function in a C source file.) -For example, if you use the `error´ function from GNU libc, you can -specify its behaviour through --flag=error:3:c-format. The effect of -this specification is that xgettext will mark as format strings all -gettext invocations that occur as argth argument of -function. -This is useful when such strings contain no format string directives: -together with the checks done by `msgfmt -c´ it will ensure that -translators cannot accidentally use format string directives that would -lead to a crash at runtime. -
- -The meaning of --flag=function:arg:pass-lang-format -is that in language lang, if the function call occurs in a -position that must yield a format string, then its argth argument -must yield a format string of the same type as well. (If you know GCC -function attributes, the --flag=function:arg:pass-c-format -option is roughly equivalent to the declaration -`__attribute__ ((__format_arg__ (arg)))´ attached to function -in a C source file.) -For example, if you use the `_´ shortcut for the gettext function, -you should use --flag=_:1:pass-c-format. The effect of this -specification is that xgettext will propagate a format string -requirement for a _("string") call to its first argument, the literal -"string", and thus mark it as a format string. -This is useful when such strings contain no format string directives: -together with the checks done by `msgfmt -c´ it will ensure that -translators cannot accidentally use format string directives that would -lead to a crash at runtime. -
-This option has an effect with most languages, namely C, C++, ObjectiveC, -Shell, Python, Lisp, EmacsLisp, librep, Scheme, Java, C#, awk, YCP, Tcl, Perl, PHP, -GCC-source. - -

`-T´ -

`--trigraphs´ -

- - - -Understand ANSI C trigraphs for input. -
-This option has an effect only with the languages C, C++, ObjectiveC. - -

`--qt´ -

- - -Recognize Qt format strings. -
-This option has an effect only with the language C++. +

+strcpy (s, "Replace ");
+strcat (s, object1);
+strcat (s, " with ");
+strcat (s, object2);
+strcat (s, "?");
+

`--debug´ -

- - -Use the flags c-format and possible-c-format to show who was -responsible for marking a message as a format string. The latter form is -used if the xgettext program decided, the format form is used if -the programmer prescribed it. +

+In order to present to the translator only entire sentences, and also +because in some languages the translator might want to swap the order +of object1 and object2, it is necessary to change this +to use a format string: -By default only the c-format form is used. The translator should -not have to care about these details. +

+sprintf (s, "Replace %s with %s?", object1, object2);
+

-This implementation of xgettext is able to process a few awkward -cases, like strings in preprocessor macros, ANSI concatenation of -adjacent strings, and escaped end of lines for continued strings. + +A similar case is compile time concatenation of strings. The ISO C 99 +include file <inttypes.h> contains a macro PRId64 that +can be used as a formatting directive for outputting an `int64_t´ +integer through printf. It expands to a constant string, usually +"d" or "ld" or "lld" or something like this, depending on the platform. +Assume you have code like

+printf ("The amount is %0" PRId64 "\n", number);
+

4.1.7 Output details

+The gettext tools and library have special support for these +<inttypes.h> macros. You can therefore simply write -

`--force-po´ -

- -Always write an output file even if no message is defined. +

+printf (gettext ("The amount is %0" PRId64 "\n"), number);
+

`-i´ -

`--indent´ -

- - -Write the .po file using indented style. +

+The PO file will contain the string "The amount is %0<PRId64>\n". +The translators will provide a translation containing "%0<PRId64>" +as well, and at runtime the gettext function's result will +contain the appropriate constant string, "d" or "ld" or "lld". -

`--no-location´ -

- -Do not write `#: filename:line´ lines. +

+This works only for the predefined <inttypes.h> macros. If +you have defined your own similar macros, let's say `MYPRId64´, +that are not known to xgettext, the solution for this problem +is to change the code like this: -

`-n´ -

`--add-location´ -

- - -Generate `#: filename:line´ lines (default). +

`--strict´ -

- -Write out a strict Uniforum conforming PO file. Note that this -Uniforum format should be avoided because it doesn't support the -GNU extensions. +

+char buf1[100];
+sprintf (buf1, "%0" MYPRId64, number);
+printf (gettext ("The amount is %s\n"), buf1);
+

`--properties-output´ -

- -Write out a Java ResourceBundle in Java .properties syntax. Note -that this file format doesn't support plural forms and silently drops -obsolete messages. +

+This means, you put the platform dependent code in one statement, and the +internationalization code in a different statement. Note that a buffer length +of 100 is safe, because all available hardware integer types are limited to +128 bits, and to print a 128 bit integer one needs at most 54 characters, +regardless whether in decimal, octal or hexadecimal. -

`--stringtable-output´ -

- -Write out a NeXTstep/GNUstep localized resource file in .strings syntax. -Note that this file format doesn't support plural forms. +

+ + +All this applies to other programming languages as well. For example, in +Java and C#, string contenation is very frequently used, because it is a +compiler built-in operator. Like in C, in Java, you would change -

`-w number´ -

`--width=number´ -

- - -Set the output page width. Long strings in the output files will be -split across multiple lines in order to ensure that each line's width -(= number of screen columns) is less or equal to the given number. +

`--no-wrap´ -

- -Do not break long message lines. Message lines whose width exceeds the -output page width will not be split into several lines. Only file reference -lines which are wider than the output page width will be split. +

+System.out.println("Replace "+object1+" with "+object2+"?");
+

`-s´ -

`--sort-output´ -

- - - -Generate sorted output. Note that using this option makes it much harder -for the translator to understand each message's context. +

+into a statement involving a format string: -

`-F´ -

`--sort-by-file´ -

- - -Sort output by file location. +

`--omit-header´ -

- -Don't write header with `msgid ""´ entry. +

+System.out.println(
+    MessageFormat.format("Replace {0} with {1}?",
+                         new Object[] { object1, object2 }));
+

- -This is useful for testing purposes because it eliminates a source -of variance for generated .gmo files. With --omit-header, -two invocations of xgettext on the same files with the same -options at different times are guaranteed to produce the same results. +

+Similarly, in C#, you would change -

`--copyright-holder=string´ -

- -Set the copyright holder in the output. string should be the -copyright holder of the surrounding package. (Note that the msgstr -strings, extracted from the package's sources, belong to the copyright -holder of the package.) Translators are expected to transfer or disclaim -the copyright for their translations, so that package maintainers can -distribute them without legal risk. If string is empty, the output -files are marked as being in the public domain; in this case, the translators -are expected to disclaim their copyright, again so that package maintainers -can distribute them without legal risk. - -The default value for string is the Free Software Foundation, Inc., -simply because xgettext was first used in the GNU project. - -

`--foreign-user´ -

- -Omit FSF copyright in output. This option is equivalent to -`--copyright-holder="´. It can be useful for packages outside the GNU -project that want their translations to be in the public domain. +

`--msgid-bugs-address=email@address´ -

- -Set the reporting address for msgid bugs. This is the email address or URL -to which the translators shall report bugs in the untranslated strings: +

+Console.WriteLine("Replace "+object1+" with "+object2+"?");
+

+into a statement involving a format string: -

Strings which are not entire sentences, see the maintainer guidelines +
-in section 3.2 Preparing Translatable Strings. -

Strings which use unclear terms or require additional context to be +

+Console.WriteLine(
+    String.Format("Replace {0} with {1}?", object1, object2));
+

-understood. -

Strings which make invalid assumptions about notation of date, time or -money. -
Pluralisation problems. -
Incorrect English spelling. +
4.3 How Marks Appear in Sources
+
+ -
Incorrect formatting. +
+
+All strings requiring translation should be marked in the C sources. Marking +is done in such a way that each translatable string appears to be +the sole argument of some function or preprocessor macro. There are +only a few such possible functions or macros meant for translation, +and their names are said to be marking keywords. The marking is +attached to strings themselves, rather than to what we do with them. +This approach has more uses. A blatant example is an error message +produced by formatting. The format string needs translation, as +well as some strings inserted through some `%s´ specification +in the format, while the result from sprintf may have so many +different instances that it is impractical to list them all in some +`error_string_out()´ routine, say. -

+This marking operation has two goals. The first goal of marking +is for triggering the retrieval of the translation, at run time. +The keyword are possibly resolved into a routine able to dynamically +return the proper translation, as far as possible or wanted, for the +argument string. Most localizable strings are found in executable +positions, that is, attached to variables or given as parameters to +functions. But this is not universal usage, and some translatable +strings appear in structured initializations. See section 4.6 Special Cases of Translatable Strings. -It can be your email address, or a mailing list address where translators -can write to without being subscribed, or the URL of a web page through -which the translators can contact you. +

+The second goal of the marking operation is to help xgettext +at properly extracting all translatable strings when it scans a set +of program sources and produces PO file templates. -The default value is empty, which means that translators will be clueless! -Don't forget to specify this option. +

+The canonical keyword for marking translatable strings is +`gettext´, it gave its name to the whole GNU gettext +package. For packages making only light use of the `gettext´ +keyword, macro or function, it is easily used as is. However, +for packages using the gettext interface more heavily, it +is usually more convenient to give the main keyword a shorter, less +obtrusive name. Indeed, the keyword might appear on a lot of strings +all over the package, and programmers usually do not want nor need +their program sources to remind them forcefully, all the time, that they +are internationalized. Further, a long keyword has the disadvantage +of using more horizontal space, forcing more indentation work on +sources for those trying to keep them within 79 or 80 columns. -

`-m [string]´ -

`--msgstr-prefix[=string]´ -

- - -Use string (or "" if not specified) as prefix for msgstr entries. +

+ +Many packages use `_´ (a simple underline) as a keyword, +and write `_("Translatable string")´ instead of `gettext +("Translatable string")´. Further, the coding rule, from GNU standards, +wanting that there is a space between the keyword and the opening +parenthesis is relaxed, in practice, for this particular usage. +So, the textual overhead per translatable string is reduced to +only three characters: the underline and the two parentheses. +However, even if GNU gettext uses this convention internally, +it does not offer it officially. The real, genuine keyword is truly +`gettext´ indeed. It is fairly easy for those wanting to use +`_´ instead of `gettext´ to declare: -

`-M [string]´ -

`--msgstr-suffix[=string]´ -

- - -Use string (or "" if not specified) as suffix for msgstr entries. +

+#include <libintl.h>
+#define _(String) gettext (String)
+

+ +

+instead of merely using `#include <libintl.h>´. + +

+Later on, the maintenance is relatively easy. If, as a programmer, +you add or modify a string, you will have to ask yourself if the +new or altered string requires translation, and include it within +`_()´ if you think it should be translated. `"%s: %d"´ is +an example of string not requiring translation! +

+ + +

4.4 Marking Translatable Strings

+ + +

+In PO mode, one set of features is meant more for the programmer than +for the translator, and allows him to interactively mark which strings, +in a set of program sources, are translatable, and which are not. +Even if it is a fairly easy job for a programmer to find and mark +such strings by other means, using any editor of his choice, PO mode +makes this work more comfortable. Further, this gives translators +who feel a little like programmers, or programmers who feel a little +like translators, a tool letting them work at marking translatable +strings in the program sources, while simultaneously producing a set of +translation in some language, for the package being internationalized. + +

+ +The set of program sources, targetted by the PO mode commands describe +here, should have an Emacs tags table constructed for your project, +prior to using these PO file commands. This is easy to do. In any +shell window, change the directory to the root of your project, then +execute a command resembling: + +

+ +

+etags src/*.[hc] lib/*.[hc]
+

+presuming here you want to process all `.h´ and `.c´ files +from the `src/´ and `lib/´ directories. This command will +explore all said files and create a `TAGS´ file in your root +directory, somewhat summarizing the contents using a special file +format Emacs can understand. -

4.1.8 Informative output

+ +For packages following the GNU coding standards, there is +a make goal tags or TAGS which constructs the tag files in +all directories and for all files containing source code. +

+Once your `TAGS´ file is ready, the following commands assist +the programmer at marking translatable strings in his set of sources. +But these commands are necessarily driven from within a PO file +window, and it is likely that you do not even have such a PO file yet. +This is not a problem at all, as you may safely open a new, empty PO +file, mainly for using these commands. This empty PO file will slowly +fill in while you mark strings as translatable in your program sources. + +

`-h´ -: -
`--help´ +
,: - - -Display this help and exit. + +Search through program sources for a string which looks like a +candidate for translation (po-tags-search). -
`-V´ +
M-,: -
`--version´ + +Mark the last string found with `_()´ (po-mark-translatable). + +
M-.: - - -Output version information and exit. + +Mark the last string found with a keyword taken from a set of possible +keywords. This command with a prefix allows some management of these +keywords (po-select-mark-and-mark).

+ +The , (po-tags-search) command searches for the next +occurrence of a string which looks like a possible candidate for +translation, and displays the program source in another Emacs window, +positioned in such a way that the string is near the top of this other +window. If the string is too big to fit whole in this window, it is +positioned so only its end is shown. In any case, the cursor +is left in the PO file window. If the shown string would be better +presented differently in different native languages, you may mark it +using M-, or M-.. Otherwise, you might rather ignore it +and skip to the next string by merely repeating the , command. + +

+A string is a good candidate for translation if it contains a sequence +of three or more letters. A string containing at most two letters in +a row will be considered as a candidate if it has more letters than +non-letters. The command disregards strings containing no letters, +or isolated letters only. It also disregards strings within comments, +or strings already marked with some keyword PO mode knows (see below). + +

+If you have never told Emacs about some `TAGS´ file to use, the +command will request that you specify one from the minibuffer, the +first time you use the command. You may later change your `TAGS´ +file by using the regular Emacs command M-x visit-tags-table, +which will ask you to name the precise `TAGS´ file you want +to use. See section `Tag Tables' in The Emacs Editor. + +

+Each time you use the , command, the search resumes from where it was +left by the previous search, and goes through all program sources, +obeying the `TAGS´ file, until all sources have been processed. +However, by giving a prefix argument to the command (C-u +,), you may request that the search be restarted all over again +from the first program source; but in this case, strings that you +recently marked as translatable will be automatically skipped. + +

+Using this , command does not prevent using of other regular +Emacs tags commands. For example, regular tags-search or +tags-query-replace commands may be used without disrupting the +independent , search sequence. However, as implemented, the +initial , command (or the , command is used with a +prefix) might also reinitialize the regular Emacs tags searching to the +first tags file, this reinitialization might be considered spurious. + +

+ + +The M-, (po-mark-translatable) command will mark the +recently found string with the `_´ keyword. The M-. +(po-select-mark-and-mark) command will request that you type +one keyword from the minibuffer and use that keyword for marking +the string. Both commands will automatically create a new PO file +untranslated entry for the string being marked, and make it the +current entry (making it easy for you to immediately proceed to its +translation, if you feel like doing it right away). It is possible +that the modifications made to the program source by M-, or +M-. render some source line longer than 80 columns, forcing you +to break and re-indent this line differently. You may use the O +command from PO mode, or any other window changing command from +Emacs, to break out into the program source window, and do any +needed adjustments. You will have to use some regular Emacs command +to return the cursor to the PO file window, if you want command +, for the next string, say. + +

+The M-. command has a few built-in speedups, so you do not +have to explicitly type all keywords all the time. The first such +speedup is that you are presented with a preferred keyword, +which you may accept by merely typing RET at the prompt. +The second speedup is that you may type any non-ambiguous prefix of the +keyword you really mean, and the command will complete it automatically +for you. This also means that PO mode has to know all +your possible keywords, and that it will not accept mistyped keywords. + +

+If you reply ? to the keyword request, the command gives a +list of all known keywords, from which you may choose. When the +command is prefixed by an argument (C-u M-.), it inhibits +updating any program source or PO file buffer, and does some simple +keyword management instead. In this case, the command asks for a +keyword, written in full, which becomes a new allowed keyword for +later M-. commands. Moreover, this new keyword automatically +becomes the preferred keyword for later commands. By typing +an already known keyword in response to C-u M-., one merely +changes the preferred keyword and does nothing more. + +

+All keywords known for M-. are recognized by the , command +when scanning for strings, and strings already marked by any of those +known keywords are automatically skipped. If many PO files are opened +simultaneously, each one has its own independent set of known keywords. +There is no provision in PO mode, currently, for deleting a known +keyword, you have to quit the file (maybe using q) and reopen +it afresh. When a PO file is newly brought up in an Emacs window, only +`gettext´ and `_´ are known as keywords, and `gettext´ +is preferred for the M-. command. In fact, this is not useful to +prefer `_´, as this one is already built in the M-, command. + +

+ + +

4.5 Special Comments preceding Keywords

+ +

+ +In C programs strings are often used within calls of functions from the +printf family. The special thing about these format strings is +that they can contain format specifiers introduced with %. Assume +we have the code + +

+ +

+printf (gettext ("String `%s' has %d characters\n"), s, strlen (s));
+

+ +

+A possible German translation for the above string might be: + +

+ +

+"%d Zeichen lang ist die Zeichenkette `%s'"
+

+ +

+A C programmer, even if he cannot speak German, will recognize that +there is something wrong here. The order of the two format specifiers +is changed but of course the arguments in the printf don't have. +This will most probably lead to problems because now the length of the +string is regarded as the address. + +

+To prevent errors at runtime caused by translations the msgfmt +tool can check statically whether the arguments in the original and the +translation string match in type and number. If this is not the case +and the `-c´ option has been passed to msgfmt, msgfmt +will give an error and refuse to produce a MO file. Thus consequent +use of `msgfmt -c´ will catch the error, so that it cannot cause +cause problems at runtime. + +

+If the word order in the above German translation would be correct one +would have to write + +

+ +

+"%2$d Zeichen lang ist die Zeichenkette `%1$s'"
+

+ +

+The routines in msgfmt know about this special notation. + +

+Because not all strings in a program must be format strings it is not +useful for msgfmt to test all the strings in the `.po´ file. +This might cause problems because the string might contain what looks +like a format specifier, but the string is not used in printf. + +

+Therefore the xgettext adds a special tag to those messages it +thinks might be a format string. There is no absolute rule for this, +only a heuristic. In the `.po´ file the entry is marked using the +c-format flag in the #, comment line (see section 3 The Format of PO Files). + +

+ + +The careful reader now might say that this again can cause problems. +The heuristic might guess it wrong. This is true and therefore +xgettext knows about a special kind of comment which lets +the programmer take over the decision. If in the same line as or +the immediately preceding line to the gettext keyword +the xgettext program finds a comment containing the words +xgettext:c-format, it will mark the string in any case with +the c-format flag. This kind of comment should be used when +xgettext does not recognize the string as a format string but +it really is one and it should be tested. Please note that when the +comment is in the same line as the gettext keyword, it must be +before the string to be translated. + +

+This situation happens quite often. The printf function is often +called with strings which do not contain a format specifier. Of course +one would normally use fputs but it does happen. In this case +xgettext does not recognize this as a format string but what +happens if the translation introduces a valid format specifier? The +printf function will try to access one of the parameters but none +exists because the original code does not pass any parameters. + +

+xgettext of course could make a wrong decision the other way +round, i.e. a string marked as a format string actually is not a format +string. In this case the msgfmt might give too many warnings and +would prevent translating the `.po´ file. The method to prevent +this wrong decision is similar to the one used above, only the comment +to use must contain the string xgettext:no-c-format. + +

+If a string is marked with c-format and this is not correct the +user can find out who is responsible for the decision. See +section 5.1 Invoking the xgettext Program to see how the --debug option can be +used for solving this problem. + +

+ + +

4.6 Special Cases of Translatable Strings

+ +

+ +The attentive reader might now point out that it is not always possible +to mark translatable string with gettext or something like this. +Consider the following case: + +

+ +

+{
+  static const char *messages[] = {
+    "some very meaningful message",
+    "and another one"
+  };
+  const char *string;
+  ...
+  string
+    = index > 1 ? "a default message" : messages[index];
+
+  fputs (string);
+  ...
+}
+

+ +

+While it is no problem to mark the string "a default message" it +is not possible to mark the string initializers for messages. +What is to be done? We have to fulfill two tasks. First we have to mark the +strings so that the xgettext program (see section 5.1 Invoking the xgettext Program) +can find them, and second we have to translate the string at runtime +before printing them. + +

+The first task can be fulfilled by creating a new keyword, which names a +no-op. For the second we have to mark all access points to a string +from the array. So one solution can look like this: + +

+ +

+#define gettext_noop(String) String
+
+{
+  static const char *messages[] = {
+    gettext_noop ("some very meaningful message"),
+    gettext_noop ("and another one")
+  };
+  const char *string;
+  ...
+  string
+    = index > 1 ? gettext ("a default message") : gettext (messages[index]);
+
+  fputs (string);
+  ...
+}
+

+ +

+Please convince yourself that the string which is written by +fputs is translated in any case. How to get xgettext know +the additional keyword gettext_noop is explained in section 5.1 Invoking the xgettext Program. + +

+The above is of course not the only solution. You could also come along +with the following one: + +

+ +

+#define gettext_noop(String) String
+
+{
+  static const char *messages[] = {
+    gettext_noop ("some very meaningful message",
+    gettext_noop ("and another one")
+  };
+  const char *string;
+  ...
+  string
+    = index > 1 ? gettext_noop ("a default message") : messages[index];
+
+  fputs (gettext (string));
+  ...
+}
+

+ +

+But this has a drawback. The programmer has to take care that +he uses gettext_noop for the string "a default message". +A use of gettext could have in rare cases unpredictable results. + +

+One advantage is that you need not make control flow analysis to make +sure the output is really translated in any case. But this analysis is +generally not very difficult. If it should be in any situation you can +use this second method in this situation. + +

+ + +

4.7 Marking Proper Names for Translation

+ +

+Should names of persons, cities, locations etc. be marked for translation +or not? People who only know languages that can be written with Latin +letters (English, Spanish, French, German, etc.) are tempted to say "no", +because names usually do not change when transported between these languages. +However, in general when translating from one script to another, names +are translated too, usually phonetically or by transliteration. For +example, Russian or Greek names are converted to the Latin alphabet when +being translated to English, and English or French names are converted +to the Katakana script when being translated to Japanese. This is +necessary because the speakers of the target language in general cannot +read the script the name is originally written in. + +

+As a programmer, you should therefore make sure that names are marked +for translation, with a special comment telling the translators that it +is a proper name and how to pronounce it. Like this: + +

+ +

+printf (_("Written by %s.\n"),
+        /* TRANSLATORS: This is a proper name.  See the gettext
+           manual, section Names.  Note this is actually a non-ASCII
+           name: The first name is (with Unicode escapes)
+           "Fran\u00e7ois" or (with HTML entities) "Fran&ccedil;ois".
+           Pronounciation is like "fraa-swa pee-nar".  */
+        _("Francois Pinard"));
+

+ +

+As a translator, you should use some care when translating names, because +it is frustrating if people see their names mutilated or distorted. If +your language uses the Latin script, all you need to do is to reproduce +the name as perfectly as you can within the usual character set of your +language. In this particular case, this means to provide a translation +containing the c-cedilla character. If your language uses a different +script and the people speaking it don't usually read Latin words, it means +transliteration; but you should still give, in parentheses, the original +writing of the name -- for the sake of the people that do read the Latin +script. Here is an example, using Greek as the target script: + +

+ +

+#. This is a proper name.  See the gettext
+#. manual, section Names.  Note this is actually a non-ASCII
+#. name: The first name is (with Unicode escapes)
+#. "Fran\u00e7ois" or (with HTML entities) "Fran&ccedil;ois".
+#. Pronounciation is like "fraa-swa pee-nar".
+msgid "Francois Pinard"
+msgstr "\phi\rho\alpha\sigma\omicron\alpha \pi\iota\nu\alpha\rho"
+       " (Francois Pinard)"
+

+ +

+Because translation of names is such a sensitive domain, it is a good +idea to test your translation before submitting it. + +

+The translation project http://sourceforge.net/projects/translation +has set up a POT file and translation domain consisting of program author +names, with better facilities for the translator than those presented here. +Namely, there the original name is written directly in Unicode (rather +than with Unicode escapes or HTML entities), and the pronounciation is +denoted using the International Phonetic Alphabet (see +http://www.wikipedia.org/wiki/International_Phonetic_Alphabet). + +

+However, we don't recommend this approach for all POT files in all packages, +because this would force translators to use PO files in UTF-8 encoding, +which is - in the current state of software (as of 2003) - a major hassle +for translators using GNU Emacs or XEmacs with po-mode. + +

+ + +

4.8 Preparing Library Sources

+ +

+When you are preparing a library, not a program, for the use of +gettext, only a few details are different. Here we assume that +the library has a translation domain and a POT file of its own. (If +it uses the translation domain and POT file of the main program, then +the previous sections apply without changes.) + +

+ +

+ +The library code doesn't call setlocale (LC_ALL, ""). It's the +responsibility of the main program to set the locale. The library's +documentation should mention this fact, so that developers of programs +using the library are aware of it. + +
+ +The library code doesn't call textdomain (PACKAGE), because it +would interfere with the text domain set by the main program. + +

+ +The initialization code for a program was + + +

+  setlocale (LC_ALL, "");
+  bindtextdomain (PACKAGE, LOCALEDIR);
+  textdomain (PACKAGE);
+

+ +For a library it is reduced to + + +

+  bindtextdomain (PACKAGE, LOCALEDIR);
+

+ +If your library's API doesn't already have an initialization function, +you need to create one, containing at least the bindtextdomain +invocation. However, you usually don't need to export and document this +initialization function: It is sufficient that all entry points of the +library call the initialization function if it hasn't been called before. +The typical idiom used to achieve this is a static boolean variable that +indicates whether the initialization function has been called. Like this: + + +

+static bool libfoo_initialized;
+
+static void
+libfoo_initialize (void)
+{
+  bindtextdomain (PACKAGE, LOCALEDIR);
+  libfoo_initialized = true;
+}
+
+/* This function is part of the exported API.  */
+struct foo *
+create_foo (...)
+{
+  /* Must ensure the initialization is performed.  */
+  if (!libfoo_initialized)
+    libfoo_initialize ();
+  ...
+}
+
+/* This function is part of the exported API.  The argument must be
+   non-NULL and have been created through create_foo().  */
+int
+foo_refcount (struct foo *argument)
+{
+  /* No need to invoke the initialization function here, because
+     create_foo() must already have been called before.  */
+  ...
+}
+

+ +

+ +The usual declaration of the `_´ macro in each source file was + + +
```
+#include <libintl.h>
+#define _(String) gettext (String)
+
```
+ +for a program. For a library, which has its own translation domain, +it reads like this: + + +
```
+#include <libintl.h>
+#define _(String) dgettext (PACKAGE, String)
+
```
+ +In other words, dgettext is used instead of gettext. +Similary, the dngettext function should be used in place of the +ngettext function. +

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_5.html b/gettext-tools/doc/gettext_5.html index e273adda1..f6c4a860e 100644 --- a/gettext-tools/doc/gettext_5.html +++ b/gettext-tools/doc/gettext_5.html @@ -1,167 +1,399 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - 5 Creating a New PO File +GNU gettext utilities - 5 Making the PO Template File -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

5 Creating a New PO File

5 Making the PO Template File

- +

-When starting a new translation, the translator creates a file called -`LANG.po´, as a copy of the `package.pot´ template -file with modifications in the initial comments (at the beginning of the file) -and in the header entry (the first entry, near the beginning of the file). +After preparing the sources, the programmer creates a PO template file. +This section explains how to use xgettext for this purpose.

-The easiest way to do so is by use of the `msginit´ program. -For example: +xgettext creates a file named `domainname.po´. You +should then rename it to `domainname.pot´. (Why doesn't +xgettext create it under the name `domainname.pot´ +right away? The answer is: for historical reasons. When xgettext +was specified, the distinction between a PO file and PO file template +was fuzzy, and the suffix `.pot´ wasn't in use at that time.)

+ + +

5.1 Invoking the `xgettext` Program

+ +

+ + +

-$ cd PACKAGE-VERSION
-$ cd po
-$ msginit
+xgettext [option] [inputfile] ...

-The alternative way is to do the copy and modifications by hand. -To do so, the translator copies `package.pot´ to -`LANG.po´. Then she modifies the initial comments and -the header entry of this file. +The xgettext program extracts translatable strings from given +input files.

5.1.1 Input file location

5.1 Invoking the `msginit` Program

- - +

`inputfile ...´ +

+Input files. -

-msginit [option]
-

`-f file´ +

`--files-from=file´ +

+ + +Read the names of the input files from file instead of getting +them from the command line. + +

`-D directory´ +

`--directory=directory´ +

- - -The msginit program creates a new PO file, initializing the meta -information with values from the user's environment. +If inputfile is `-´, standard input is read.

5.1.1 Input file location

5.1.2 Output file location

`-i inputfile´ +
`-d name´ +: +
`--default-domain=name´ +: + + +Use `name.po´ for output (instead of `messages.po´). + +
`-o file´: -
`--input=inputfile´ +
`--output=file´: - - -Input POT file. + + +Write output to specified file (instead of `name.po´ or +`messages.po´). + +
`-p dir´ +: +
`--output-dir=dir´ +: + + +Output files will be placed in directory dir.

-If no inputfile is given, the current directory is searched for the -POT file. If it is `-´, standard input is read. + +If the output file is `-´ or `/dev/stdout´, the output +is written to standard output.

5.1.2 Output file location

5.1.3 Choice of input file language

`-o file´ +
`-L name´ +: +
`--language=name´ +: + + + +Specifies the language of the input files. The supported languages +are C, C++, ObjectiveC, PO, Python, +Lisp, EmacsLisp, librep, Scheme, Smalltalk, +Java, JavaProperties, C#, awk, YCP, +Tcl, Perl, PHP, GCC-source, NXStringTable, +RST, Glade. + +
`-C´: -
`--output-file=file´ +
`--c++´: - - -Write output to specified PO file. + + +This is a shorthand for --language=C++.

-If no output file is given, it depends on the `--locale´ option or the -user's locale setting. If it is `-´, the results are written to -standard output. +By default the language is guessed depending on the input file name +extension.

5.1.3 Input file syntax

5.1.4 Input file interpretation

`-P´ +
`--from-code=name´: -
`--properties-input´ + +Specifies the encoding of the input files. This option is needed only +if some untranslated message strings or their corresponding comments +contain non-ASCII characters. Note that Python, Tcl, and Glade input +files are always assumed to be in UTF-8, regardless of this option. + +

+ +

+By default the input files are assumed to be in ASCII. + +

+ + +

5.1.5 Operation mode

+ +

`-j´ +: +
`--join-existing´: - - -Assume the input file is a Java ResourceBundle in Java .properties -syntax, not in PO file syntax. + + +Join messages with existing file. -
`--stringtable-input´ +
`-x file´: - -Assume the input file is a NeXTstep/GNUstep localized resource file in -.strings syntax, not in PO file syntax. +
`--exclude-file=file´ +: + + +Entries from file are not extracted. file should be a PO or +POT file. + +
`-c [tag]´ +: +
`--add-comments[=tag]´ +: + + +Place comment block with tag (or those preceding keyword lines) +in output file.

5.1.4 Output details

5.1.6 Language specific options

`-l ll_CC´ +
`-a´: -
`--locale=ll_CC´ +
`--extract-all´: - - -Set target locale. ll should be a language code, and CC should -be a country code. The command `locale -a´ can be used to output a list -of all installed locales. The default is the user's locale setting. + + +Extract all strings. -
`--no-translator´ +This option has an effect with most languages, namely C, C++, ObjectiveC, +Shell, Python, Lisp, EmacsLisp, librep, Java, C#, awk, Tcl, Perl, PHP, +GCC-source, Glade. + +
`-k keywordspec´ +: +
`--keyword[=keywordspec]´: - -Declares that the PO file will not have a human translator and is instead -automatically generated. + + +Additional keyword to be looked for (without keywordspec means not to +use default keywords). + + +If keywordspec is a C identifer id, xgettext looks +for strings in the first argument of each call to the function or macro +id. If keywordspec is of the form +`id:argnum´, xgettext looks for strings in the +argnumth argument of the call. If keywordspec is of the form +`id:argnum1,argnum2´, xgettext looks for +strings in the argnum1st argument and in the argnum2nd argument +of the call, and treats them as singular/plural variants for a message +with plural handling. +
+The default keyword specifications, which are always looked for if not +explicitly disabled, are gettext, dgettext:2, +dcgettext:2, ngettext:1,2, dngettext:2,3, +dcngettext:2,3, and gettext_noop. +
+This option has an effect with most languages, namely C, C++, ObjectiveC, +Shell, Python, Lisp, EmacsLisp, librep, Java, C#, awk, Tcl, Perl, PHP, +GCC-source, Glade. + +
`--flag=word:arg:flag´ +: + +Specifies additional flags for strings occurring as part of the argth +argument of the function word. The possible flags are the possible +format string indicators, such as `c-format´, and their negations, +such as `no-c-format´, possibly prefixed with `pass-´. +
+ +The meaning of --flag=function:arg:lang-format +is that in language lang, the specified function expects as +argth argument a format string. (For those of you familiar with +GCC function attributes, --flag=function:arg:c-format is +roughly equivalent to the declaration +`__attribute__ ((__format__ (__printf__, arg, ...)))´ attached +to function in a C source file.) +For example, if you use the `error´ function from GNU libc, you can +specify its behaviour through --flag=error:3:c-format. The effect of +this specification is that xgettext will mark as format strings all +gettext invocations that occur as argth argument of +function. +This is useful when such strings contain no format string directives: +together with the checks done by `msgfmt -c´ it will ensure that +translators cannot accidentally use format string directives that would +lead to a crash at runtime. +
+ +The meaning of --flag=function:arg:pass-lang-format +is that in language lang, if the function call occurs in a +position that must yield a format string, then its argth argument +must yield a format string of the same type as well. (If you know GCC +function attributes, the --flag=function:arg:pass-c-format +option is roughly equivalent to the declaration +`__attribute__ ((__format_arg__ (arg)))´ attached to function +in a C source file.) +For example, if you use the `_´ shortcut for the gettext function, +you should use --flag=_:1:pass-c-format. The effect of this +specification is that xgettext will propagate a format string +requirement for a _("string") call to its first argument, the literal +"string", and thus mark it as a format string. +This is useful when such strings contain no format string directives: +together with the checks done by `msgfmt -c´ it will ensure that +translators cannot accidentally use format string directives that would +lead to a crash at runtime. +
+This option has an effect with most languages, namely C, C++, ObjectiveC, +Shell, Python, Lisp, EmacsLisp, librep, Scheme, Java, C#, awk, YCP, Tcl, Perl, PHP, +GCC-source. + +
`-T´ +: +
`--trigraphs´ +: + + + +Understand ANSI C trigraphs for input. +
+This option has an effect only with the languages C, C++, ObjectiveC. + +
`--qt´ +: + + +Recognize Qt format strings. +
+This option has an effect only with the language C++. -
`-p´ +
`--debug´: + + +Use the flags c-format and possible-c-format to show who was +responsible for marking a message as a format string. The latter form is +used if the xgettext program decided, the format form is used if +the programmer prescribed it. + +By default only the c-format form is used. The translator should +not have to care about these details. + +

+ +

+This implementation of xgettext is able to process a few awkward +cases, like strings in preprocessor macros, ANSI concatenation of +adjacent strings, and escaped end of lines for continued strings. + +

+ + +

5.1.7 Output details

+ +

`--force-po´ +: + +Always write an output file even if no message is defined. + +
`-i´ +: +
`--indent´ +: + + +Write the .po file using indented style. + +
`--no-location´ +: + +Do not write `#: filename:line´ lines. + +
`-n´ +: +
`--add-location´ +: + + +Generate `#: filename:line´ lines (default). + +
`--strict´ +: + +Write out a strict Uniforum conforming PO file. Note that this +Uniforum format should be avoided because it doesn't support the +GNU extensions. +
`--properties-output´: - - + Write out a Java ResourceBundle in Java .properties syntax. Note that this file format doesn't support plural forms and silently drops obsolete messages.
`--stringtable-output´: - + Write out a NeXTstep/GNUstep localized resource file in .strings syntax. Note that this file format doesn't support plural forms. @@ -169,82 +401,82 @@ Note that this file format doesn't support plural forms.
`--width=number´: - - + + Set the output page width. Long strings in the output files will be split across multiple lines in order to ensure that each line's width (= number of screen columns) is less or equal to the given number.
`--no-wrap´: - + Do not break long message lines. Message lines whose width exceeds the output page width will not be split into several lines. Only file reference lines which are wider than the output page width will be split. -

- - - -

5.1.5 Informative output

- -

`-h´ +
`-s´: -
`--help´ +
`--sort-output´: - - -Display this help and exit. + + + +Generate sorted output. Note that using this option makes it much harder +for the translator to understand each message's context. -
`-V´ +
`-F´: -
`--version´ +
`--sort-by-file´: - - -Output version information and exit. - -

- + + +Sort output by file location. +

`--omit-header´ +

+ +Don't write header with `msgid ""´ entry. -

5.2 Filling in the Header Entry

- - -

-The initial comments "SOME DESCRIPTIVE TITLE", "YEAR" and -"FIRST AUTHOR <EMAIL@ADDRESS>, YEAR" ought to be replaced by sensible -information. This can be done in any text editor; if Emacs is used -and it switched to PO mode automatically (because it has recognized -the file's suffix), you can disable it by typing M-x fundamental-mode. - -

-Modifying the header entry can already be done using PO mode: in Emacs, -type M-x po-mode RET and then RET again to start editing the -entry. You should fill in the following fields. + +This is useful for testing purposes because it eliminates a source +of variance for generated .gmo files. With --omit-header, +two invocations of xgettext on the same files with the same +options at different times are guaranteed to produce the same results. -

Project-Id-Version +

`--copyright-holder=string´

-This is the name and version of the package. + +Set the copyright holder in the output. string should be the +copyright holder of the surrounding package. (Note that the msgstr +strings, extracted from the package's sources, belong to the copyright +holder of the package.) Translators are expected to transfer or disclaim +the copyright for their translations, so that package maintainers can +distribute them without legal risk. If string is empty, the output +files are marked as being in the public domain; in this case, the translators +are expected to disclaim their copyright, again so that package maintainers +can distribute them without legal risk. + +The default value for string is the Free Software Foundation, Inc., +simply because xgettext was first used in the GNU project. + +

`--foreign-user´ +

+ +Omit FSF copyright in output. This option is equivalent to +`--copyright-holder="´. It can be useful for packages outside the GNU +project that want their translations to be in the public domain. -

Report-Msgid-Bugs-To +

`--msgid-bugs-address=email@address´

-This has already been filled in by xgettext. It contains an email -address or URL where you can report bugs in the untranslated strings: + +Set the reporting address for msgid bugs. This is the email address or URL +to which the translators shall report bugs in the untranslated strings:

Strings which are not entire sentences, see the maintainer guidelines -in section 3.2 Preparing Translatable Strings. +in section 4.2 Preparing Translatable Strings.
Strings which use unclear terms or require additional context to be understood. @@ -259,171 +491,56 @@ money.

POT-Creation-Date -

-This has already been filled in by xgettext. +It can be your email address, or a mailing list address where translators +can write to without being subscribed, or the URL of a web page through +which the translators can contact you. -

PO-Revision-Date -

-You don't need to fill this in. It will be filled by the Emacs PO mode -when you save the file. +The default value is empty, which means that translators will be clueless! +Don't forget to specify this option. -

Last-Translator +

`-m [string]´

-Fill in your name and email address (without double quotes). - -

Language-Team +

`--msgstr-prefix[=string]´

-Fill in the English name of the language, and the email address or -homepage URL of the language team you are part of. - -Before starting a translation, it is a good idea to get in touch with -your translation team, not only to make sure you don't do duplicated work, -but also to coordinate difficult linguistic issues. - - -In the Free Translation Project, each translation team has its own mailing -list. The up-to-date list of teams can be found at the Free Translation -Project's homepage, http://www.iro.umontreal.ca/contrib/po/HTML/, -in the "National teams" area. + + +Use string (or "" if not specified) as prefix for msgstr entries. -

Content-Type +

`-M [string]´

- - -Replace `CHARSET´ with the character encoding used for your language, -in your locale, or UTF-8. This field is needed for correct operation of the -msgmerge and msgfmt programs, as well as for users whose -locale's character encoding differs from yours (see section 10.2.4 How to specify the output character set gettext uses). - - -You get the character encoding of your locale by running the shell command -`locale charmap´. If the result is `C´ or `ANSI_X3.4-1968´, -which is equivalent to `ASCII´ (= `US-ASCII´), it means that your -locale is not correctly configured. In this case, ask your translation -team which charset to use. `ASCII´ is not usable for any language -except Latin. - - -Because the PO files must be portable to operating systems with less advanced -internationalization facilities, the character encodings that can be used -are limited to those supported by both GNU libc and GNU -libiconv. These are: -ASCII, ISO-8859-1, ISO-8859-2, ISO-8859-3, -ISO-8859-4, ISO-8859-5, ISO-8859-6, ISO-8859-7, -ISO-8859-8, ISO-8859-9, ISO-8859-13, ISO-8859-14, -ISO-8859-15, -KOI8-R, KOI8-U, KOI8-T, -CP850, CP866, CP874, -CP932, CP949, CP950, CP1250, CP1251, -CP1252, CP1253, CP1254, CP1255, CP1256, -CP1257, GB2312, EUC-JP, EUC-KR, EUC-TW, -BIG5, BIG5-HKSCS, GBK, GB18030, SHIFT_JIS, -JOHAB, TIS-620, VISCII, GEORGIAN-PS, UTF-8. - - -In the GNU system, the following encodings are frequently used for the -corresponding languages. - - - -

ISO-8859-1 for - -Afrikaans, Albanian, Basque, Breton, Catalan, Cornish, Danish, Dutch, -English, Estonian, Faroese, Finnish, French, Galician, German, -Greenlandic, Icelandic, Indonesian, Irish, Italian, Malay, Manx, -Norwegian, Occitan, Portuguese, Spanish, Swedish, Tagalog, Uzbek, -Walloon, -
ISO-8859-2 for - -Bosnian, Croatian, Czech, Hungarian, Polish, Romanian, Serbian, Slovak, -Slovenian, -
ISO-8859-3 for Maltese, - -
ISO-8859-5 for Macedonian, Serbian, - -
ISO-8859-6 for Arabic, - -
ISO-8859-7 for Greek, - -
ISO-8859-8 for Hebrew, - -
ISO-8859-9 for Turkish, - -
ISO-8859-13 for Latvian, Lithuanian, Maori, - -
ISO-8859-14 for Welsh, - -
ISO-8859-15 for - -Basque, Catalan, Dutch, English, Finnish, French, Galician, German, Irish, -Italian, Portuguese, Spanish, Swedish, Walloon, -
KOI8-R for Russian, - -
KOI8-U for Ukrainian, - -
KOI8-T for Tajik, - -
CP1251 for Bulgarian, Byelorussian, - -
GB2312, GBK, GB18030 +
`--msgstr-suffix[=string]´ +
+ + +Use string (or "" if not specified) as suffix for msgstr entries. -for simplified writing of Chinese, -
BIG5, BIG5-HKSCS +

-for traditional writing of Chinese, -

EUC-JP for Japanese, -

EUC-KR for Korean, -

TIS-620 for Thai, +

5.1.8 Informative output

GEORGIAN-PS for Georgian, +

`-h´ +: +
`--help´ +: + + +Display this help and exit. - +
`-V´ +: +
`--version´ +: + + +Output version information and exit. - - -When single quote characters or double quote characters are used in -translations for your language, and your locale's encoding is one of the -ISO-8859-* charsets, it is best if you create your PO files in UTF-8 -encoding, instead of your locale's encoding. This is because in UTF-8 -the real quote characters can be represented (single quote characters: -U+2018, U+2019, double quote characters: U+201C, U+201D), whereas none of -ISO-8859-* charsets has them all. Users in UTF-8 locales will see the -real quote characters, whereas users in ISO-8859-* locales will see the -vertical apostrophe and the vertical double quote instead (because that's -what the character set conversion will transliterate them to). - - -To enter such quote characters under X11, you can change your keyboard -mapping using the xmodmap program. The X11 names of the quote -characters are "leftsinglequotemark", "rightsinglequotemark", -"leftdoublequotemark", "rightdoublequotemark", "singlelowquotemark", -"doublelowquotemark". - -Note that only recent versions of GNU Emacs support the UTF-8 encoding: -Emacs 20 with Mule-UCS, and Emacs 21. As of January 2001, XEmacs doesn't -support the UTF-8 encoding. - -The character encoding name can be written in either upper or lower case. -Usually upper case is preferred. - -
Content-Transfer-Encoding -: -Set this to 8bit. - -
Plural-Forms -: -This field is optional. It is only needed if the PO file has plural forms. -You can find them by searching for the `msgid_plural´ keyword. The -format of the plural forms field is described in section 10.2.5 Additional functions for plural forms.

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_6.html b/gettext-tools/doc/gettext_6.html index 0e829853a..ec3912675 100644 --- a/gettext-tools/doc/gettext_6.html +++ b/gettext-tools/doc/gettext_6.html @@ -1,206 +1,112 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - 6 Updating Existing PO Files +GNU gettext utilities - 6 Creating a New PO File -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

6 Updating Existing PO Files

- - +

6 Creating a New PO File

+ -

6.1 Invoking the `msgmerge` Program

+When starting a new translation, the translator creates a file called +`LANG.po´, as a copy of the `package.pot´ template +file with modifications in the initial comments (at the beginning of the file) +and in the header entry (the first entry, near the beginning of the file). +

- - +The easiest way to do so is by use of the `msginit´ program. +For example: + +

-msgmerge [option] def.po ref.pot
+$ cd PACKAGE-VERSION
+$ cd po
+$ msginit

-The msgmerge program merges two Uniforum style .po files together. -The def.po file is an existing PO file with translations which will -be taken over to the newly created file as long as they still match; -comments will be preserved, but extracted comments and file positions will -be discarded. The ref.pot file is the last created PO file with -up-to-date source references but old translations, or a PO Template file -(generally created by xgettext); any translations or comments -in the file will be discarded, however dot comments and file positions -will be preserved. Where an exact match cannot be found, fuzzy matching -is used to produce better results. +The alternative way is to do the copy and modifications by hand. +To do so, the translator copies `package.pot´ to +`LANG.po´. Then she modifies the initial comments and +the header entry of this file.

6.1.1 Input file location

- -

`def.po´ -: -Translations referring to old sources. - -
`ref.pot´ -: -References to the new sources. - -
`-D directory´ -: -
`--directory=directory´ -: - - -Add directory to the list of directories. Source files are -searched relative to this list of directories. The resulting `.po´ -file will be written relative to the current directory, though. - -
`-C file´ -: -
`--compendium=file´ -: - - -Specify an additional library of message translations. See section 6.11 Using Translation Compendia. -This option may be specified more than once. - -

- - - -

6.1.2 Operation mode

- -

`-U´ -: -
`--update´ -: - - -Update def.po. Do nothing if def.po is already up to date. - -

- - - -

6.1.3 Output file location

`-o file´ -: -
`--output-file=file´ -: - - -Write output to specified file. +
+ + -

+msginit [option]
+

- -The results are written to standard output if no output file is specified -or if it is `-´. + + +The msginit program creates a new PO file, initializing the meta +information with values from the user's environment.

6.1.4 Output file location in update mode

- -

-The result is written back to def.po. +

6.1.1 Input file location

`--backup=control´ +
`-i inputfile´: - - -Make a backup of def.po - -
`--suffix=suffix´ +
`--input=inputfile´: - -Override the usual backup suffix. + + +Input POT file.

- -The version control method may be selected via the --backup option -or through the VERSION_CONTROL environment variable. Here are the -values: +If no inputfile is given, the current directory is searched for the +POT file. If it is `-´, standard input is read.

`none´ -

`off´ -

-Never make backups (even if --backup is given). -

`numbered´ -

`t´ -

-Make numbered backups. +

6.1.2 Output file location

`existing´ -

`nil´ -

-Make numbered backups if numbered backups for this file already exist, -otherwise make simple backups. +

`simple´ +
`-o file´: -
`never´ +
`--output-file=file´: -Always make simple backups. + + +Write output to specified PO file.

-The backup suffix is `~´, unless set with --suffix or the -SIMPLE_BACKUP_SUFFIX environment variable. +If no output file is given, it depends on the `--locale´ option or the +user's locale setting. If it is `-´, the results are written to +standard output.

6.1.5 Operation modifiers

- -

`-m´ -: -
`--multi-domain´ -: - - -Apply ref.pot to each of the domains in def.po. - -
`-N´ -: -
`--no-fuzzy-matching´ -: - - -Do not use fuzzy matching when an exact match is not found. This may speed -up the operation considerably. -

- - - -

6.1.6 Input file syntax

6.1.3 Input file syntax

`--properties-input´: - - -Assume the input files are Java ResourceBundles in Java .properties + + +Assume the input file is a Java ResourceBundle in Java .properties syntax, not in PO file syntax.
`--stringtable-input´: - -Assume the input files are NeXTstep/GNUstep localized resource files in + +Assume the input file is a NeXTstep/GNUstep localized resource file in .strings syntax, not in PO file syntax.

6.1.7 Output details

6.1.4 Output details

`--force-po´ +
`-l ll_CC´: - -Always write an output file even if it contains no message. - -
`-i´ -: -
`--indent´ -: - - -Write the .po file using indented style. - -
`--no-location´ +
`--locale=ll_CC´: - -Do not write `#: filename:line´ lines. + + +Set target locale. ll should be a language code, and CC should +be a country code. The command `locale -a´ can be used to output a list +of all installed locales. The default is the user's locale setting. -
`--add-location´ +
`--no-translator´: - -Generate `#: filename:line´ lines (default). - -
`--strict´ -: - -Write out a strict Uniforum conforming PO file. Note that this -Uniforum format should be avoided because it doesn't support the -GNU extensions. + +Declares that the PO file will not have a human translator and is instead +automatically generated.
`-p´
`--properties-output´: - - + + Write out a Java ResourceBundle in Java .properties syntax. Note that this file format doesn't support plural forms and silently drops obsolete messages.
`--stringtable-output´: - + Write out a NeXTstep/GNUstep localized resource file in .strings syntax. Note that this file format doesn't support plural forms. @@ -277,42 +169,24 @@ Note that this file format doesn't support plural forms.
`--width=number´: - - + + Set the output page width. Long strings in the output files will be split across multiple lines in order to ensure that each line's width (= number of screen columns) is less or equal to the given number.
`--no-wrap´: - + Do not break long message lines. Message lines whose width exceeds the output page width will not be split into several lines. Only file reference lines which are wider than the output page width will be split. -
`-s´ -: -
`--sort-output´ -: - - - -Generate sorted output. Note that using this option makes it much harder -for the translator to understand each message's context. - -
`-F´ -: -
`--sort-by-file´ -: - - -Sort output by file location. -

6.1.8 Informative output

6.1.5 Informative output

`--help´: - - + + Display this help and exit.
`-V´
`--version´: - - + + Output version information and exit. -
`-v´ -: -
`--verbose´ -: - - -Increase verbosity level. - -
`-q´ -: -
`--quiet´ -: -
`--silent´ -: - - - -Suppress progress indicators. -

6.2 Translated Entries

6.2 Filling in the Header Entry

- +

-Each PO file entry for which the msgstr field has been filled with -a translation, and which is not marked as fuzzy (see section 6.3 Fuzzy Entries), -is said to be a translated entry. Only translated entries will -later be compiled by GNU msgfmt and become usable in programs. -Other entry types will be excluded; translation will not occur for them. +The initial comments "SOME DESCRIPTIVE TITLE", "YEAR" and +"FIRST AUTHOR <EMAIL@ADDRESS>, YEAR" ought to be replaced by sensible +information. This can be done in any text editor; if Emacs is used +and it switched to PO mode automatically (because it has recognized +the file's suffix), you can disable it by typing M-x fundamental-mode.

- -Some commands are more specifically related to translated entry processing. +Modifying the header entry can already be done using PO mode: in Emacs, +type M-x po-mode RET and then RET again to start editing the +entry. You should fill in the following fields.

t +
Project-Id-Version: - -Find the next translated entry (po-next-translated-entry). +This is the name and version of the package. -
T +
Report-Msgid-Bugs-To: - -Find the previous translated entry (po-previous-translated-entry). +This has already been filled in by xgettext. It contains an email +address or URL where you can report bugs in the untranslated strings: -

- - - - -The commands t (po-next-translated-entry) and T -(po-previous-translated-entry) move forwards or backwards, chasing -for an translated entry. If none is found, the search is extended and -wraps around in the PO file buffer. +

Strings which are not entire sentences, see the maintainer guidelines -
-
- -Translated entries usually result from the translator having edited in -a translation for them, section 6.6 Modifying Translations. However, if the -variable po-auto-fuzzy-on-edit is not nil, the entry having -received a new translation first becomes a fuzzy entry, which ought to -be later unfuzzied before becoming an official, genuine translated entry. -See section 6.3 Fuzzy Entries. +in section 4.2 Preparing Translatable Strings. +
Strings which use unclear terms or require additional context to be -
- - -
6.3 Fuzzy Entries
-
- +understood. +
Strings which make invalid assumptions about notation of date, time or -
-
- - -Each PO file entry may have a set of attributes, which are -qualities given a name and explicitly associated with the translation, -using a special system comment. One of these attributes -has the name fuzzy, and entries having this attribute are said -to have a fuzzy translation. They are called fuzzy entries, for short. +money. +
Pluralisation problems. -
-
-Fuzzy entries, even if they account for translated entries for -most other purposes, usually call for revision by the translator. -Those may be produced by applying the program msgmerge to -update an older translated PO files according to a new PO template -file, when this tool hypothesises that some new msgid has -been modified only slightly out of an older one, and chooses to pair -what it thinks to be the old translation for the new modified entry. -The slight alteration in the original string (the msgid string) -should often be reflected in the translated string, and this requires -the intervention of the translator. For this reason, msgmerge -might mark some entries as being fuzzy. +
Incorrect English spelling. -
-
- -Also, the translator may decide herself to mark an entry as fuzzy -for her own convenience, when she wants to remember that the entry -has to be later revisited. So, some commands are more specifically -related to fuzzy entry processing. - -
-
- -
z -
- -Find the next fuzzy entry (po-next-fuzzy-entry). +
Incorrect formatting. -
Z -
- -Find the previous fuzzy entry (po-previous-fuzzy-entry). +

TAB +

POT-Creation-Date

- -Remove the fuzzy attribute of the current entry (po-unfuzzy). - -

- -

- - - - -The commands z (po-next-fuzzy-entry) and Z -(po-previous-fuzzy-entry) move forwards or backwards, chasing for -a fuzzy entry. If none is found, the search is extended and wraps -around in the PO file buffer. - -

- - - -The command TAB (po-unfuzzy) removes the fuzzy -attribute associated with an entry, usually leaving it translated. -Further, if the variable po-auto-select-on-unfuzzy has not -the nil value, the TAB command will automatically chase -for another interesting entry to work on. The initial value of -po-auto-select-on-unfuzzy is nil. - -

-The initial value of po-auto-fuzzy-on-edit is nil. However, -if the variable po-auto-fuzzy-on-edit is set to t, any entry -edited through the RET command is marked fuzzy, as a way to -ensure some kind of double check, later. In this case, the usual paradigm -is that an entry becomes fuzzy (if not already) whenever the translator -modifies it. If she is satisfied with the translation, she then uses -TAB to pick another entry to work on, clearing the fuzzy attribute -on the same blow. If she is not satisfied yet, she merely uses SPC -to chase another entry, leaving the entry fuzzy. - -

- - -The translator may also use the DEL command -(po-fade-out-entry) over any translated entry to mark it as being -fuzzy, when she wants to easily leave a trace she wants to later return -working at this entry. - -

-Also, when time comes to quit working on a PO file buffer with the q -command, the translator is asked for confirmation, if fuzzy string -still exists. - -

- - -

6.4 Untranslated Entries

- - -

-When xgettext originally creates a PO file, unless told -otherwise, it initializes the msgid field with the untranslated -string, and leaves the msgstr string to be empty. Such entries, -having an empty translation, are said to be untranslated entries. -Later, when the programmer slightly modifies some string right in -the program, this change is later reflected in the PO file -by the appearance of a new untranslated entry for the modified string. - -

-The usual commands moving from entry to entry consider untranslated -entries on the same level as active entries. Untranslated entries -are easily recognizable by the fact they end with `msgstr ""´. - -

- -The work of the translator might be (quite naively) seen as the process -of seeking for an untranslated entry, editing a translation for -it, and repeating these actions until no untranslated entries remain. -Some commands are more specifically related to untranslated entry -processing. +This has already been filled in by xgettext. -

u +
PO-Revision-Date: - -Find the next untranslated entry (po-next-untranslated-entry). +You don't need to fill this in. It will be filled by the Emacs PO mode +when you save the file. -
U +
Last-Translator: - -Find the previous untranslated entry (po-previous-untransted-entry). +Fill in your name and email address (without double quotes). -
k +
Language-Team: - -Turn the current entry into an untranslated one (po-kill-msgstr). - -

- -

- - - - -The commands u (po-next-untranslated-entry) and U -(po-previous-untransted-entry) move forwards or backwards, -chasing for an untranslated entry. If none is found, the search is -extended and wraps around in the PO file buffer. - -

- - -An entry can be turned back into an untranslated entry by -merely emptying its translation, using the command k -(po-kill-msgstr). See section 6.6 Modifying Translations. - -

-Also, when time comes to quit working on a PO file buffer -with the q command, the translator is asked for confirmation, -if some untranslated string still exists. - -

+Fill in the English name of the language, and the email address or +homepage URL of the language team you are part of. +Before starting a translation, it is a good idea to get in touch with +your translation team, not only to make sure you don't do duplicated work, +but also to coordinate difficult linguistic issues. -

6.5 Obsolete Entries

- - -

-By obsolete PO file entries, we mean those entries which are -commented out, usually by msgmerge when it found that the -translation is not needed anymore by the package being localized. - -

-The usual commands moving from entry to entry consider obsolete -entries on the same level as active entries. Obsolete entries are -easily recognizable by the fact that all their lines start with -#, even those lines containing msgid or msgstr. - -

-Commands exist for emptying the translation or reinitializing it -to the original untranslated string. Commands interfacing with the -kill ring may force some previously saved text into the translation. -The user may interactively edit the translation. All these commands -may apply to obsolete entries, carefully leaving the entry obsolete -after the fact. - -

- -Moreover, some commands are more specifically related to obsolete -entry processing. - -

o +
Content-Type: - -Find the next obsolete entry (po-next-obsolete-entry). + + +Replace `CHARSET´ with the character encoding used for your language, +in your locale, or UTF-8. This field is needed for correct operation of the +msgmerge and msgfmt programs, as well as for users whose +locale's character encoding differs from yours (see section 11.2.4 How to specify the output character set gettext uses). -
O -: - -Find the previous obsolete entry (po-previous-obsolete-entry). + +You get the character encoding of your locale by running the shell command +`locale charmap´. If the result is `C´ or `ANSI_X3.4-1968´, +which is equivalent to `ASCII´ (= `US-ASCII´), it means that your +locale is not correctly configured. In this case, ask your translation +team which charset to use. `ASCII´ is not usable for any language +except Latin. -
DEL -: - -Make an active entry obsolete, or zap out an obsolete entry -(po-fade-out-entry). + +Because the PO files must be portable to operating systems with less advanced +internationalization facilities, the character encodings that can be used +are limited to those supported by both GNU libc and GNU +libiconv. These are: +ASCII, ISO-8859-1, ISO-8859-2, ISO-8859-3, +ISO-8859-4, ISO-8859-5, ISO-8859-6, ISO-8859-7, +ISO-8859-8, ISO-8859-9, ISO-8859-13, ISO-8859-14, +ISO-8859-15, +KOI8-R, KOI8-U, KOI8-T, +CP850, CP866, CP874, +CP932, CP949, CP950, CP1250, CP1251, +CP1252, CP1253, CP1254, CP1255, CP1256, +CP1257, GB2312, EUC-JP, EUC-KR, EUC-TW, +BIG5, BIG5-HKSCS, GBK, GB18030, SHIFT_JIS, +JOHAB, TIS-620, VISCII, GEORGIAN-PS, UTF-8. -

+ +In the GNU system, the following encodings are frequently used for the +corresponding languages. -

- - - - -The commands o (po-next-obsolete-entry) and O -(po-previous-obsolete-entry) move forwards or backwards, -chasing for an obsolete entry. If none is found, the search is -extended and wraps around in the PO file buffer. + -

-PO mode does not provide ways for un-commenting an obsolete entry -and making it active, because this would reintroduce an original -untranslated string which does not correspond to any marked string -in the program sources. This goes with the philosophy of never -introducing useless msgid values. +

ISO-8859-1 for -
-
- - - - -However, it is possible to comment out an active entry, so making -it obsolete. GNU gettext utilities will later react to the -disappearance of a translation by using the untranslated string. -The command DEL (po-fade-out-entry) pushes the current entry -a little further towards annihilation. If the entry is active (it is a -translated entry), then it is first made fuzzy. If it is already fuzzy, -then the entry is merely commented out, with confirmation. If the entry -is already obsolete, then it is completely deleted from the PO file. -It is easy to recycle the translation so deleted into some other PO file -entry, usually one which is untranslated. See section 6.6 Modifying Translations. +Afrikaans, Albanian, Basque, Breton, Catalan, Cornish, Danish, Dutch, +English, Estonian, Faroese, Finnish, French, Galician, German, +Greenlandic, Icelandic, Indonesian, Irish, Italian, Malay, Manx, +Norwegian, Occitan, Portuguese, Spanish, Swedish, Tagalog, Uzbek, +Walloon, +
ISO-8859-2 for -
-
-Here is a quite interesting problem to solve for later development of -PO mode, for those nights you are not sleepy. The idea would be that -PO mode might become bright enough, one of these days, to make good -guesses at retrieving the most probable candidate, among all obsolete -entries, for initializing the translation of a newly appeared string. -I think it might be a quite hard problem to do this algorithmically, as -we have to develop good and efficient measures of string similarity. -Right now, PO mode completely lets the decision to the translator, -when the time comes to find the adequate obsolete translation, it -merely tries to provide handy tools for helping her to do so. +Bosnian, Croatian, Czech, Hungarian, Polish, Romanian, Serbian, Slovak, +Slovenian, +
ISO-8859-3 for Maltese, -
+
ISO-8859-5 for Macedonian, Serbian, +
ISO-8859-6 for Arabic, -
6.6 Modifying Translations
-
- - +
ISO-8859-7 for Greek, -
-
-PO mode prevents direct modification of the PO file, by the usual -means Emacs gives for altering a buffer's contents. By doing so, -it pretends helping the translator to avoid little clerical errors -about the overall file format, or the proper quoting of strings, -as those errors would be easily made. Other kinds of errors are -still possible, but some may be caught and diagnosed by the batch -validation process, which the translator may always trigger by the -V command. For all other errors, the translator has to rely on -her own judgment, and also on the linguistic reports submitted to her -by the users of the translated package, having the same mother tongue. +
ISO-8859-8 for Hebrew, -
-
-When the time comes to create a translation, correct an error diagnosed -mechanically or reported by a user, the translators have to resort to -using the following commands for modifying the translations. +
ISO-8859-9 for Turkish, -
-
+
ISO-8859-13 for Latvian, Lithuanian, Maori, -
RET -
- -Interactively edit the translation (po-edit-msgstr). +
ISO-8859-14 for Welsh, -
LFD -
-
C-j -
- - -Reinitialize the translation with the original, untranslated string -(po-msgid-to-msgstr). +
ISO-8859-15 for -
k -
- -Save the translation on the kill ring, and delete it (po-kill-msgstr). +Basque, Catalan, Dutch, English, Finnish, French, Galician, German, Irish, +Italian, Portuguese, Spanish, Swedish, Walloon, +
KOI8-R for Russian, -
w -
- -Save the translation on the kill ring, without deleting it -(po-kill-ring-save-msgstr). +
KOI8-U for Ukrainian, -
y -
- -Replace the translation, taking the new from the kill ring -(po-yank-msgstr). +
KOI8-T for Tajik, -
+
CP1251 for Bulgarian, Byelorussian, -
- - -The command RET (po-edit-msgstr) opens a new Emacs -window meant to edit in a new translation, or to modify an already existing -translation. The new window contains a copy of the translation taken from -the current PO file entry, all ready for edition, expunged of all quoting -marks, fully modifiable and with the complete extent of Emacs modifying -commands. When the translator is done with her modifications, she may use -C-c C-c to close the subedit window with the automatically requoted -results, or C-c C-k to abort her modifications. See section 6.8 Details of Sub Edition, -for more information. +
GB2312, GBK, GB18030 -
-
- - - -The command LFD (po-msgid-to-msgstr) initializes, or -reinitializes the translation with the original string. This command is -normally used when the translator wants to redo a fresh translation of -the original string, disregarding any previous work. +for simplified writing of Chinese, +
BIG5, BIG5-HKSCS -
-
- -It is possible to arrange so, whenever editing an untranslated -entry, the LFD command be automatically executed. If you set -po-auto-edit-with-msgid to t, the translation gets -initialised with the original string, in case none exists already. -The default value for po-auto-edit-with-msgid is nil. +for traditional writing of Chinese, +
EUC-JP for Japanese, -
-
- -In fact, whether it is best to start a translation with an empty -string, or rather with a copy of the original string, is a matter of -taste or habit. Sometimes, the source language and the -target language are so different that is simply best to start writing -on an empty page. At other times, the source and target languages -are so close that it would be a waste to retype a number of words -already being written in the original string. A translator may also -like having the original string right under her eyes, as she will -progressively overwrite the original text with the translation, even -if this requires some extra editing work to get rid of the original. +
EUC-KR for Korean, -
-
- - - - - -The command k (po-kill-msgstr) merely empties the -translation string, so turning the entry into an untranslated -one. But while doing so, its previous contents is put apart in -a special place, known as the kill ring. The command w -(po-kill-ring-save-msgstr) has also the effect of taking a -copy of the translation onto the kill ring, but it otherwise leaves -the entry alone, and does not remove the translation from the -entry. Both commands use exactly the Emacs kill ring, which is shared -between buffers, and which is well known already to Emacs lovers. +
TIS-620 for Thai, -
-
-The translator may use k or w many times in the course -of her work, as the kill ring may hold several saved translations. -From the kill ring, strings may later be reinserted in various -Emacs buffers. In particular, the kill ring may be used for moving -translation strings between different entries of a single PO file -buffer, or if the translator is handling many such buffers at once, -even between PO files. +
GEORGIAN-PS for Georgian, -
-
-To facilitate exchanges with buffers which are not in PO mode, the -translation string put on the kill ring by the k command is fully -unquoted before being saved: external quotes are removed, multi-line -strings are concatenated, and backslash escaped sequences are turned -into their corresponding characters. In the special case of obsolete -entries, the translation is also uncommented prior to saving. +
UTF-8 for any language, including those listed above. -
-
- - -The command y (po-yank-msgstr) completely replaces the -translation of the current entry by a string taken from the kill ring. -Following Emacs terminology, we then say that the replacement -string is yanked into the PO file buffer. -See section `Yanking' in The Emacs Editor. -The first time y is used, the translation receives the value of -the most recent addition to the kill ring. If y is typed once -again, immediately, without intervening keystrokes, the translation -just inserted is taken away and replaced by the second most recent -addition to the kill ring. By repeating y many times in a row, -the translator may travel along the kill ring for saved strings, -until she finds the string she really wanted. +

-When a string is yanked into a PO file entry, it is fully and -automatically requoted for complying with the format PO files should -have. Further, if the entry is obsolete, PO mode then appropriately -push the inserted string inside comments. Once again, translators -should not burden themselves with quoting considerations besides, of -course, the necessity of the translated string itself respective to -the program using it. + + +When single quote characters or double quote characters are used in +translations for your language, and your locale's encoding is one of the +ISO-8859-* charsets, it is best if you create your PO files in UTF-8 +encoding, instead of your locale's encoding. This is because in UTF-8 +the real quote characters can be represented (single quote characters: +U+2018, U+2019, double quote characters: U+201C, U+201D), whereas none of +ISO-8859-* charsets has them all. Users in UTF-8 locales will see the +real quote characters, whereas users in ISO-8859-* locales will see the +vertical apostrophe and the vertical double quote instead (because that's +what the character set conversion will transliterate them to). -

-Note that k or w are not the only commands pushing strings -on the kill ring, as almost any PO mode command replacing translation -strings (or the translator comments) automatically saves the old string -on the kill ring. The main exceptions to this general rule are the -yanking commands themselves. + +To enter such quote characters under X11, you can change your keyboard +mapping using the xmodmap program. The X11 names of the quote +characters are "leftsinglequotemark", "rightsinglequotemark", +"leftdoublequotemark", "rightdoublequotemark", "singlelowquotemark", +"doublelowquotemark". -

- -To better illustrate the operation of killing and yanking, let's -use an actual example, taken from a common situation. When the -programmer slightly modifies some string right in the program, his -change is later reflected in the PO file by the appearance -of a new untranslated entry for the modified string, and the fact -that the entry translating the original or unmodified string becomes -obsolete. In many cases, the translator might spare herself some work -by retrieving the unmodified translation from the obsolete entry, -then initializing the untranslated entry msgstr field with -this retrieved translation. Once this done, the obsolete entry is -not wanted anymore, and may be safely deleted. +Note that only recent versions of GNU Emacs support the UTF-8 encoding: +Emacs 20 with Mule-UCS, and Emacs 21. As of January 2001, XEmacs doesn't +support the UTF-8 encoding. -

-When the translator finds an untranslated entry and suspects that a -slight variant of the translation exists, she immediately uses m -to mark the current entry location, then starts chasing obsolete -entries with o, hoping to find some translation corresponding -to the unmodified string. Once found, she uses the DEL command -for deleting the obsolete entry, knowing that DEL also kills -the translation, that is, pushes the translation on the kill ring. -Then, r returns to the initial untranslated entry, and y -then yanks the saved translation right into the msgstr -field. The translator is then free to use RET for fine -tuning the translation contents, and maybe to later use u, -then m again, for going on with the next untranslated string. - -

-When some sequence of keys has to be typed over and over again, the -translator may find it useful to become better acquainted with the Emacs -capability of learning these sequences and playing them back under request. -See section `Keyboard Macros' in The Emacs Editor. - -

- - -

6.7 Modifying Comments

- - - -

-Any translation work done seriously will raise many linguistic -difficulties, for which decisions have to be made, and the choices -further documented. These documents may be saved within the -PO file in form of translator comments, which the translator -is free to create, delete, or modify at will. These comments may -be useful to herself when she returns to this PO file after a while. - -

-Comments not having whitespace after the initial `#´, for example, -those beginning with `#.´ or `#:´, are not translator -comments, they are exclusively created by other gettext tools. -So, the commands below will never alter such system added comments, -they are not meant for the translator to modify. See section 2.2 The Format of PO Files. - -

-The following commands are somewhat similar to those modifying translations, -so the general indications given for those apply here. See section 6.6 Modifying Translations. +The character encoding name can be written in either upper or lower case. +Usually upper case is preferred. -

# +
Content-Transfer-Encoding: - -Interactively edit the translator comments (po-edit-comment). +Set this to 8bit. -
K +
Plural-Forms: - -Save the translator comments on the kill ring, and delete it -(po-kill-comment). - -
W -: - -Save the translator comments on the kill ring, without deleting it -(po-kill-ring-save-comment). - -
Y -: - -Replace the translator comments, taking the new from the kill ring -(po-yank-comment). - +This field is optional. It is only needed if the PO file has plural forms. +You can find them by searching for the `msgid_plural´ keyword. The +format of the plural forms field is described in section 11.2.5 Additional functions for plural forms.

-These commands parallel PO mode commands for modifying the translation -strings, and behave much the same way as they do, except that they handle -this part of PO file comments meant for translator usage, rather -than the translation strings. So, if the descriptions given below are -slightly succinct, it is because the full details have already been given. -See section 6.6 Modifying Translations. - -

- - -The command # (po-edit-comment) opens a new Emacs window -containing a copy of the translator comments on the current PO file entry. -If there are no such comments, PO mode understands that the translator wants -to add a comment to the entry, and she is presented with an empty screen. -Comment marks (#) and the space following them are automatically -removed before edition, and reinstated after. For translator comments -pertaining to obsolete entries, the uncommenting and recommenting operations -are done twice. Once in the editing window, the keys C-c C-c -allow the translator to tell she is finished with editing the comment. -See section 6.8 Details of Sub Edition, for further details. - -

- -Functions found on po-subedit-mode-hook, if any, are executed after -the string has been inserted in the edit buffer. - -

- - - - - - -The command K (po-kill-comment) gets rid of all -translator comments, while saving those comments on the kill ring. -The command W (po-kill-ring-save-comment) takes -a copy of the translator comments on the kill ring, but leaves -them undisturbed in the current entry. The command Y -(po-yank-comment) completely replaces the translator comments -by a string taken at the front of the kill ring. When this command -is immediately repeated, the comments just inserted are withdrawn, -and replaced by other strings taken along the kill ring. - -

-On the kill ring, all strings have the same nature. There is no -distinction between translation strings and translator -comments strings. So, for example, let's presume the translator -has just finished editing a translation, and wants to create a new -translator comment to document why the previous translation was -not good, just to remember what was the problem. Foreseeing that she -will do that in her documentation, the translator may want to quote -the previous translation in her translator comments. To do so, she -may initialize the translator comments with the previous translation, -still at the head of the kill ring. Because editing already pushed the -previous translation on the kill ring, she merely has to type M-w -prior to #, and the previous translation will be right there, -all ready for being introduced by some explanatory text. - -

-On the other hand, presume there are some translator comments already -and that the translator wants to add to those comments, instead -of wholly replacing them. Then, she should edit the comment right -away with #. Once inside the editing window, she can use the -regular Emacs commands C-y (yank) and M-y -(yank-pop) to get the previous translation where she likes. - -

- - -

6.8 Details of Sub Edition

- - -

-The PO subedit minor mode has a few peculiarities worth being described -in fuller detail. It installs a few commands over the usual editing set -of Emacs, which are described below. - -

C-c C-c -: - -Complete edition (po-subedit-exit). - -
C-c C-k -: - -Abort edition (po-subedit-abort). - -
C-c C-a -: - -Consult auxiliary PO files (po-subedit-cycle-auxiliary). - -

- -

- - - -The window's contents represents a translation for a given message, -or a translator comment. The translator may modify this window to -her heart's content. Once this is done, the command C-c C-c -(po-subedit-exit) may be used to return the edited translation into -the PO file, replacing the original translation, even if it moved out of -sight or if buffers were switched. - -

- - -If the translator becomes unsatisfied with her translation or comment, -to the extent she prefers keeping what was existent prior to the -RET or # command, she may use the command C-c C-k -(po-subedit-abort) to merely get rid of edition, while preserving -the original translation or comment. Another way would be for her to exit -normally with C-c C-c, then type U once for undoing the -whole effect of last edition. - -

- - -The command C-c C-a (po-subedit-cycle-auxiliary) -allows for glancing through translations -already achieved in other languages, directly while editing the current -translation. This may be quite convenient when the translator is fluent -at many languages, but of course, only makes sense when such completed -auxiliary PO files are already available to her (see section 6.10 Consulting Auxiliary PO Files). - -

-Functions found on po-subedit-mode-hook, if any, are executed after -the string has been inserted in the edit buffer. - -

-While editing her translation, the translator should pay attention to not -inserting unwanted RET (newline) characters at the end of -the translated string if those are not meant to be there, or to removing -such characters when they are required. Since these characters are not -visible in the editing buffer, they are easily introduced by mistake. -To help her, RET automatically puts the character < -at the end of the string being edited, but this < is not really -part of the string. On exiting the editing window with C-c C-c, -PO mode automatically removes such < and all whitespace added after -it. If the translator adds characters after the terminating <, it -looses its delimiting property and integrally becomes part of the string. -If she removes the delimiting <, then the edited string is taken -as is, with all trailing newlines, even if invisible. Also, if -the translated string ought to end itself with a genuine <, then -the delimiting < may not be removed; so the string should appear, -in the editing window, as ending with two < in a row. - -

- -When a translation (or a comment) is being edited, the translator may move -the cursor back into the PO file buffer and freely move to other entries, -browsing at will. If, with an edition pending, the translator wanders in the -PO file buffer, she may decide to start modifying another entry. Each entry -being edited has its own subedit buffer. It is possible to simultaneously -edit the translation and the comment of a single entry, or to -edit entries in different PO files, all at once. Typing RET -on a field already being edited merely resumes that particular edit. Yet, -the translator should better be comfortable at handling many Emacs windows! - -

- -Pending subedits may be completed or aborted in any order, regardless -of how or when they were started. When many subedits are pending and the -translator asks for quitting the PO file (with the q command), subedits -are automatically resumed one at a time, so she may decide for each of them. - -

- - -

6.9 C Sources Context

- - - - -

-PO mode is particularly powerful when used with PO files -created through GNU gettext utilities, as those utilities -insert special comments in the PO files they generate. -Some of these special comments relate the PO file entry to -exactly where the untranslated string appears in the program sources. - -

-When the translator gets to an untranslated entry, she is fairly -often faced with an original string which is not as informative as -it normally should be, being succinct, cryptic, or otherwise ambiguous. -Before choosing how to translate the string, she needs to understand -better what the string really means and how tight the translation has -to be. Most of the time, when problems arise, the only way left to make -her judgment is looking at the true program sources from where this -string originated, searching for surrounding comments the programmer -might have put in there, and looking around for helping clues of -any kind. - -

-Surely, when looking at program sources, the translator will receive -more help if she is a fluent programmer. However, even if she is -not versed in programming and feels a little lost in C code, the -translator should not be shy at taking a look, once in a while. -It is most probable that she will still be able to find some of the -hints she needs. She will learn quickly to not feel uncomfortable -in program code, paying more attention to programmer's comments, -variable and function names (if he dared choosing them well), and -overall organization, than to the program code itself. - -

- -The following commands are meant to help the translator at getting -program source context for a PO file entry. - -

s -: - -Resume the display of a program source context, or cycle through them -(po-cycle-source-reference). - -
M-s -: - -Display of a program source context selected by menu -(po-select-source-reference). - -
S -: - -Add a directory to the search path for source files -(po-consider-source-path). - -
M-S -: - -Delete a directory from the search path for source files -(po-ignore-source-path). - -

- -

- - - - -The commands s (po-cycle-source-reference) and M-s -(po-select-source-reference) both open another window displaying -some source program file, and already positioned in such a way that -it shows an actual use of the string to be translated. By doing -so, the command gives source program context for the string. But if -the entry has no source context references, or if all references -are unresolved along the search path for program sources, then the -command diagnoses this as an error. - -

-Even if s (or M-s) opens a new window, the cursor stays -in the PO file window. If the translator really wants to -get into the program source window, she ought to do it explicitly, -maybe by using command O. - -

-When s is typed for the first time, or for a PO file entry which -is different of the last one used for getting source context, then the -command reacts by giving the first context available for this entry, -if any. If some context has already been recently displayed for the -current PO file entry, and the translator wandered off to do other -things, typing s again will merely resume, in another window, -the context last displayed. In particular, if the translator moved -the cursor away from the context in the source file, the command will -bring the cursor back to the context. By using s many times -in a row, with no other commands intervening, PO mode will cycle to -the next available contexts for this particular entry, getting back -to the first context once the last has been shown. - -

-The command M-s behaves differently. Instead of cycling through -references, it lets the translator choose a particular reference among -many, and displays that reference. It is best used with completion, -if the translator types TAB immediately after M-s, in -response to the question, she will be offered a menu of all possible -references, as a reminder of which are the acceptable answers. -This command is useful only where there are really many contexts -available for a single string to translate. - -

- - - - -Program source files are usually found relative to where the PO -file stands. As a special provision, when this fails, the file is -also looked for, but relative to the directory immediately above it. -Those two cases take proper care of most PO files. However, it might -happen that a PO file has been moved, or is edited in a different -place than its normal location. When this happens, the translator -should tell PO mode in which directory normally sits the genuine PO -file. Many such directories may be specified, and all together, they -constitute what is called the search path for program sources. -The command S (po-consider-source-path) is used to interactively -enter a new directory at the front of the search path, and the command -M-S (po-ignore-source-path) is used to select, with completion, -one of the directories she does not want anymore on the search path. - -

- - -

6.10 Consulting Auxiliary PO Files

- - -

-PO mode is able to help the knowledgeable translator, being fluent in -many languages, at taking advantage of translations already achieved -in other languages she just happens to know. It provides these other -language translations as additional context for her own work. Moreover, -it has features to ease the production of translations for many languages -at once, for translators preferring to work in this way. - -

- - -An auxiliary PO file is an existing PO file meant for the same -package the translator is working on, but targeted to a different mother -tongue language. Commands exist for declaring and handling auxiliary -PO files, and also for showing contexts for the entry under work. - -

-Here are the auxiliary file commands available in PO mode. - -

a -: - -Seek auxiliary files for another translation for the same entry -(po-cycle-auxiliary). - -
C-c C-a -: - -Switch to a particular auxiliary file (po-select-auxiliary). - -
A -: - -Declare this PO file as an auxiliary file (po-consider-as-auxiliary). - -
M-A -: - -Remove this PO file from the list of auxiliary files -(po-ignore-as-auxiliary). - -

- -

- - - - -Command A (po-consider-as-auxiliary) adds the current -PO file to the list of auxiliary files, while command M-A -(po-ignore-as-auxiliary just removes it. - -

- - -The command a (po-cycle-auxiliary) seeks all auxiliary PO -files, round-robin, searching for a translated entry in some other language -having an msgid field identical as the one for the current entry. -The found PO file, if any, takes the place of the current PO file in -the display (its window gets on top). Before doing so, the current PO -file is also made into an auxiliary file, if not already. So, a -in this newly displayed PO file will seek another PO file, and so on, -so repeating a will eventually yield back the original PO file. - -

- - -The command C-c C-a (po-select-auxiliary) asks the translator -for her choice of a particular auxiliary file, with completion, and -then switches to that selected PO file. The command also checks if -the selected file has an msgid field identical as the one for -the current entry, and if yes, this entry becomes current. Otherwise, -the cursor of the selected file is left undisturbed. - -

-For all this to work fully, auxiliary PO files will have to be normalized, -in that way that msgid fields should be written exactly -the same way. It is possible to write msgid fields in various -ways for representing the same string, different writing would break the -proper behaviour of the auxiliary file commands of PO mode. This is not -expected to be much a problem in practice, as most existing PO files have -their msgid entries written by the same GNU gettext tools. - -

- -However, PO files initially created by PO mode itself, while marking -strings in source files, are normalised differently. So are PO -files resulting of the the `M-x normalize´ command. Until these -discrepancies between PO mode and other GNU gettext tools get -fully resolved, the translator should stay aware of normalisation issues. - -

- - -

6.11 Using Translation Compendia

- - -

- -A compendium is a special PO file containing a set of -translations recurring in many different packages. The translator can -use gettext tools to build a new compendium, to add entries to her -compendium, and to initialize untranslated entries, or to update -already translated entries, from translations kept in the compendium. - -

- - - -

6.11.1 Creating Compendia

- - - -

-Basically every PO file consisting of translated entries only can be -declared as a valid compendium. Often the translator wants to have -special compendia; let's consider two cases: concatenating PO -files and extracting a message subset from a PO file. - -

- - -

6.11.1.1 Concatenate PO Files

- -

- - -To concatenate several valid PO files into one compendium file you can -use `msgcomm´ or `msgcat´ (the latter preferred): - -

- -

-msgcat -o compendium.po file1.po file2.po
-

- -

-By default, msgcat will accumulate divergent translations -for the same string. Those occurences will be marked as fuzzy -and highly visible decorated; calling msgcat on -`file1.po´: - -

- -

-#: src/hello.c:200
-#, c-format
-msgid "Report bugs to <%s>.\n"
-msgstr "Comunicar `bugs' a <%s>.\n"
-

- -

-and `file2.po´: - -

- -

-#: src/bye.c:100
-#, c-format
-msgid "Report bugs to <%s>.\n"
-msgstr "Comunicar \"bugs\" a <%s>.\n"
-

- -

-will result in: - -

- -

-#: src/hello.c:200 src/bye.c:100
-#, fuzzy, c-format
-msgid "Report bugs to <%s>.\n"
-msgstr ""
-"#-#-#-#-#  file1.po  #-#-#-#-#\n"
-"Comunicar `bugs' a <%s>.\n"
-"#-#-#-#-#  file2.po  #-#-#-#-#\n"
-"Comunicar \"bugs\" a <%s>.\n"
-

- -

-The translator will have to resolve this "conflict" manually; she -has to decide whether the first or the second version is appropriate -(or provide a new translation), to delete the "marker lines", and -finally to remove the fuzzy mark. - -

-If the translator knows in advance the first found translation of a -message is always the best translation she can make use to the -`--use-first´ switch: - -

- -

-msgcat --use-first -o compendium.po file1.po file2.po
-

- -

-A good compendium file must not contain fuzzy or untranslated -entries. If input files are "dirty" you must preprocess the input -files or postprocess the result using `msgattrib --translated --no-fuzzy´. - -

- - -

6.11.1.2 Extract a Message Subset from a PO File

- - -

-Nobody wants to translate the same messages again and again; thus you -may wish to have a compendium file containing `getopt.c´ messages. - -

-To extract a message subset (e.g., all `getopt.c´ messages) from an -existing PO file into one compendium file you can use `msggrep´: - -

- -

-msggrep --location src/getopt.c -o compendium.po file.po
-

- - - -

6.11.2 Using Compendia

- -

-You can use a compendium file to initialize a translation from scratch -or to update an already existing translation. - -

- - -

6.11.2.1 Initialize a New Translation File

- - -

-Since a PO file with translations does not exist the translator can -merely use `/dev/null´ to fake the "old" translation file. - -

- -

-msgmerge --compendium compendium.po -o file.po /dev/null file.pot
-

- - - -

6.11.2.2 Update an Existing Translation File

- - -

-Concatenate the compendium file(s) and the existing PO, merge the -result with the POT file and remove the obsolete entries (optional, -here done using `sed´): - -

- -

-msgcat --use-first -o update.po compendium1.po compendium2.po file.po
-msgmerge update.po file.pot | sed -e '/^#~/d' > file.po
-

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_7.html b/gettext-tools/doc/gettext_7.html index adf5fd416..3f571515a 100644 --- a/gettext-tools/doc/gettext_7.html +++ b/gettext-tools/doc/gettext_7.html @@ -1,472 +1,206 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - 7 Manipulating PO Files +GNU gettext utilities - 7 Updating Existing PO Files -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

7 Manipulating PO Files

- - -

-Sometimes it is necessary to manipulate PO files in a way that is better -performed automatically than by hand. GNU gettext includes a -complete set of tools for this purpose. - -

- -When merging two packages into a single package, the resulting POT file -will be the concatenation of the two packages' POT files. Thus the -maintainer must concatenate the two existing package translations into -a single translation catalog, for each language. This is best performed -using `msgcat´. It is then the translators' duty to deal with any -possible conflicts that arose during the merge. - -

- -When a translator takes over the translation job from another translator, -but she uses a different character encoding in her locale, she will -convert the catalog to her character encoding. This is best done through -the `msgconv´ program. - -

-When a maintainer takes a source file with tagged messages from another -package, he should also take the existing translations for this source -file (and not let the translators do the same job twice). One way to do -this is through `msggrep´, another is to create a POT file for -that source file and use `msgmerge´. - -

- - -When a translator wants to adjust some translation catalog for a special -dialect or orthography -- for example, German as written in Switzerland -versus German as written in Germany -- she needs to apply some text -processing to every message in the catalog. The tool for doing this is -`msgfilter´. - -

-Another use of msgfilter is to produce approximately the POT file for -which a given PO file was made. This can be done through a filter command -like `msgfilter sed -e d | sed -e '/^# /d'´. Note that the original -POT file may have had different comments and different plural message counts, -that's why it's better to use the original POT file if available. - -

- -When a translator wants to check her translations, for example according -to orthography rules or using a non-interactive spell checker, she can do -so using the `msgexec´ program. - -

- -When third party tools create PO or POT files, sometimes duplicates cannot -be avoided. But the GNU gettext tools give an error when they -encounter duplicate msgids in the same file and in the same domain. -To merge duplicates, the `msguniq´ program can be used. - -

-`msgcomm´ is a more general tool for keeping or throwing away -duplicates, occurring in different files. - -

-`msgcmp´ can be used to check whether a translation catalog is -completely translated. - -

- -`msgattrib´ can be used to select and extract only the fuzzy -or untranslated messages of a translation catalog. - -

-`msgen´ is useful as a first step for preparing English translation -catalogs. It copies each message's msgid to its msgstr. - -

-Finally, for those applications where all these various programs are not -sufficient, a library `libgettextpo´ is provided that can be used to -write other specialized programs that process PO files. - -

7 Updating Existing PO Files

7.1 Invoking the `msgcat` Program

7.1 Invoking the `msgmerge` Program

- - + +

-msgcat [option] [inputfile]...
+msgmerge [option] def.po ref.pot

- - -The msgcat program concatenates and merges the specified PO files. -It finds messages which are common to two or more of the specified PO files. -By using the --more-than option, greater commonality may be requested -before messages are printed. Conversely, the --less-than option may be -used to specify less commonality before messages are printed (i.e. -`--less-than=2´ will only print the unique messages). Translations, -comments and extract comments will be cumulated, except that if ---use-first is specified, they will be taken from the first PO file -to define them. File positions from all PO files will be cumulated. +The msgmerge program merges two Uniforum style .po files together. +The def.po file is an existing PO file with translations which will +be taken over to the newly created file as long as they still match; +comments will be preserved, but extracted comments and file positions will +be discarded. The ref.pot file is the last created PO file with +up-to-date source references but old translations, or a PO Template file +(generally created by xgettext); any translations or comments +in the file will be discarded, however dot comments and file positions +will be preserved. Where an exact match cannot be found, fuzzy matching +is used to produce better results.

7.1.1 Input file location

`inputfile ...´ +
`def.po´: -Input files. +Translations referring to old sources. -
`-f file´ -: -
`--files-from=file´ +
`ref.pot´: - - -Read the names of the input files from file instead of getting -them from the command line. +References to the new sources.
`-D directory´
`--directory=directory´: - - + + Add directory to the list of directories. Source files are searched relative to this list of directories. The resulting `.po´ file will be written relative to the current directory, though. -

- -

-If inputfile is `-´, standard input is read. - -

- - -

7.1.2 Output file location

- -

`-o file´ +
`-C file´: -
`--output-file=file´ +
`--compendium=file´: - - -Write output to specified file. + + +Specify an additional library of message translations. See section 8.3.14 Using Translation Compendia. +This option may be specified more than once.

- -The results are written to standard output if no output file is specified -or if it is `-´. - -

7.1.3 Message selection

7.1.2 Operation mode

`-< number´ -: -
`--less-than=number´ -: - - -Print messages with less than number definitions, defaults to infinite -if not set. - -
`-> number´ -: -
`--more-than=number´ -: - - -Print messages with more than number definitions, defaults to 0 if not -set. - -
`-u´ +
`-U´: -
`--unique´ +
`--update´: - - -Shorthand for `--less-than=2´. Requests that only unique messages be -printed. + + +Update def.po. Do nothing if def.po is already up to date.

7.1.4 Input file syntax

7.1.3 Output file location

`-P´ -: -
`--properties-input´ +
`-o file´: - - -Assume the input files are Java ResourceBundles in Java .properties -syntax, not in PO file syntax. - -
`--stringtable-input´ +
`--output-file=file´: - -Assume the input files are NeXTstep/GNUstep localized resource files in -.strings syntax, not in PO file syntax. + + +Write output to specified file.

+ +The results are written to standard output if no output file is specified +or if it is `-´. +

7.1.5 Output details

- -

`-t´ -

`--to-code=name´ -

- - -Specify encoding for output. - -

`--use-first´ -

- -Use first available translation for each message. Don't merge several -translations into one. - -

`--force-po´ -

- -Always write an output file even if it contains no message. - -

`-i´ -

`--indent´ -

- - -Write the .po file using indented style. - -

`--no-location´ -

- -Do not write `#: filename:line´ lines. - -

`-n´ -

`--add-location´ -

- - -Generate `#: filename:line´ lines (default). - -

`--strict´ -

- -Write out a strict Uniforum conforming PO file. Note that this -Uniforum format should be avoided because it doesn't support the -GNU extensions. - -

`-p´ -

`--properties-output´ -

- - -Write out a Java ResourceBundle in Java .properties syntax. Note -that this file format doesn't support plural forms and silently drops -obsolete messages. -

`--stringtable-output´ -

- -Write out a NeXTstep/GNUstep localized resource file in .strings syntax. -Note that this file format doesn't support plural forms. +

7.1.4 Output file location in update mode

`-w number´ -

`--width=number´ -

+The result is written back to def.po. -

`--no-wrap´ -

`-s´ -: -
`--sort-output´ +
`--backup=control´: - - - -Generate sorted output. Note that using this option makes it much harder -for the translator to understand each message's context. + + +Make a backup of def.po -
`-F´ -: -
`--sort-by-file´ +
`--suffix=suffix´: - - -Sort output by file location. + +Override the usual backup suffix.

+ +The version control method may be selected via the --backup option +or through the VERSION_CONTROL environment variable. Here are the +values: - -

7.1.6 Informative output

- +

`-h´ +
`none´: -
`--help´ +
`off´: - - -Display this help and exit. +Never make backups (even if --backup is given). -
`-V´ +
`numbered´: -
`--version´ +
`t´: - - -Output version information and exit. - -

- - - -

7.2 Invoking the `msgconv` Program

- -

- - - -

-msgconv [option] [inputfile]
-

- -

- -The msgconv program converts a translation catalog to a different -character encoding. - -

- - -

7.2.1 Input file location

- -

`inputfile´ +
`existing´ +: +
`nil´: -Input PO file. +Make numbered backups if numbered backups for this file already exist, +otherwise make simple backups. -
`-D directory´ +
`simple´: -
`--directory=directory´ +
`never´: - - -Add directory to the list of directories. Source files are -searched relative to this list of directories. The resulting `.po´ -file will be written relative to the current directory, though. +Always make simple backups.

-If no inputfile is given or if it is `-´, standard input is read. +The backup suffix is `~´, unless set with --suffix or the +SIMPLE_BACKUP_SUFFIX environment variable.

7.2.2 Output file location

7.1.5 Operation modifiers

`-o file´ +
`-m´: -
`--output-file=file´ +
`--multi-domain´: - - -Write output to specified file. - -

- -

-The results are written to standard output if no output file is specified -or if it is `-´. - -

- - -

7.2.3 Conversion target

- -

`-t´ +
`-N´: -
`--to-code=name´ +
`--no-fuzzy-matching´: - - -Specify encoding for output. - + + +Do not use fuzzy matching when an exact match is not found. This may speed +up the operation considerably.

-The default encoding is the current locale's encoding. - -

7.2.4 Input file syntax

7.1.6 Input file syntax

`--properties-input´: - - -Assume the input file is a Java ResourceBundle in Java .properties + + +Assume the input files are Java ResourceBundles in Java .properties syntax, not in PO file syntax.
`--stringtable-input´: - -Assume the input file is a NeXTstep/GNUstep localized resource file in + +Assume the input files are NeXTstep/GNUstep localized resource files in .strings syntax, not in PO file syntax.

7.2.5 Output details

7.1.7 Output details

`--force-po´: - + Always write an output file even if it contains no message.
`-i´
`--indent´: - - + + Write the .po file using indented style.
`--no-location´: - + Do not write `#: filename:line´ lines.
`--add-location´: - + Generate `#: filename:line´ lines (default).
`--strict´: - + Write out a strict Uniforum conforming PO file. Note that this Uniforum format should be avoided because it doesn't support the GNU extensions. @@ -527,15 +261,15 @@ GNU extensions.
`--properties-output´: - - + + Write out a Java ResourceBundle in Java .properties syntax. Note that this file format doesn't support plural forms and silently drops obsolete messages.
`--stringtable-output´: - + Write out a NeXTstep/GNUstep localized resource file in .strings syntax. Note that this file format doesn't support plural forms. @@ -543,15 +277,15 @@ Note that this file format doesn't support plural forms.
`--width=number´: - - + + Set the output page width. Long strings in the output files will be split across multiple lines in order to ensure that each line's width (= number of screen columns) is less or equal to the given number.
`--no-wrap´: - + Do not break long message lines. Message lines whose width exceeds the output page width will not be split into several lines. Only file reference lines which are wider than the output page width will be split. @@ -560,8 +294,9 @@ lines which are wider than the output page width will be split.
`--sort-output´: - - + + + Generate sorted output. Note that using this option makes it much harder for the translator to understand each message's context. @@ -569,15 +304,15 @@ for the translator to understand each message's context.
`--sort-by-file´: - - + + Sort output by file location.

7.2.6 Informative output

7.1.8 Informative output

`--help´: - - + + Display this help and exit.
`-V´
`--version´: - - + + Output version information and exit. -

- - - -

7.3 Invoking the `msggrep` Program

- -

- - - -

-msggrep [option] [inputfile]
-

- -

- -The msggrep program extracts all messages of a translation catalog -that match a given pattern or belong to some given source files. - -

- - -

7.3.1 Input file location

- -

`inputfile´ -: -Input PO file. - -
`-D directory´ +
`-v´: -
`--directory=directory´ +
`--verbose´: - - -Add directory to the list of directories. Source files are -searched relative to this list of directories. The resulting `.po´ -file will be written relative to the current directory, though. - -

- -

-If no inputfile is given or if it is `-´, standard input is read. + + +Increase verbosity level. -

- - -

7.3.2 Output file location

- -

`-o file´ +
`-q´: -
`--output-file=file´ +
`--quiet´: - - -Write output to specified file. +
`--silent´ +: + + + +Suppress progress indicators.

-The results are written to standard output if no output file is specified -or if it is `-´. - -

- - -

7.3.3 Message selection

- - -

-  [-N sourcefile]... [-M domainname]...
-  [-K msgid-pattern] [-T msgstr-pattern] [-C comment-pattern]
-

- -

-A message is selected if - -

it comes from one of the specified source files, - -
or if it comes from one of the specified domains, - -
or if `-K´ is given and its key (msgid or msgid_plural) matches - - msgid-pattern, -
or if `-T´ is given and its translation (msgstr) matches - - msgstr-pattern, -
or if `-C´ is given and the translator's comment matches - - comment-pattern. -

- -

-When more than one selection criterion is specified, the set of selected -messages is the union of the selected messages of each criterion. - -

-msgid-pattern or msgstr-pattern syntax: - -

-  [-E | -F] [-e pattern | -f file]...
-

- -

-patterns are basic regular expressions by default, or extended regular -expressions if -E is given, or fixed strings if -F is given. - -

`-N sourcefile´ -: -
`--location=sourcefile´ -: - - -Select messages extracted from sourcefile. sourcefile can be -either a literal file name or a wildcard pattern. - -
`-M domainname´ -: -
`--domain=domainname´ -: - - -Select messages belonging to domain domainname. - -
`-K´ -: -
`--msgid´ -: - - -Start of patterns for the msgid. - -
`-T´ -: -
`--msgstr´ -: - - -Start of patterns for the msgstr. - -
`-C´ -: -
`--comment´ -: - - -Start of patterns for the translator's comment. - -
`-E´ -: -
`--extended-regexp´ -: - - -Specify that pattern is an extended regular expression. - -
`-F´ -: -
`--fixed-strings´ -: - - -Specify that pattern is a set of newline-separated strings. - -
`-e pattern´ -: -
`--regexp=pattern´ -: - - -Use pattern as a regular expression. - -
`-f file´ -: -
`--file=file´ -: - - -Obtain pattern from file. - -
`-i´ -: -
`--ignore-case´ -: - - -Ignore case distinctions. - -

- - - -

7.3.4 Input file syntax

- -

`-P´ -: -
`--properties-input´ -: - - -Assume the input file is a Java ResourceBundle in Java .properties -syntax, not in PO file syntax. - -
`--stringtable-input´ -: - -Assume the input file is a NeXTstep/GNUstep localized resource file in -.strings syntax, not in PO file syntax. - -

- - - -

7.3.5 Output details

- -

`--force-po´ -: - -Always write an output file even if it contains no message. - -
`--indent´ -: - -Write the .po file using indented style. - -
`--no-location´ -: - -Do not write `#: filename:line´ lines. - -
`--add-location´ -: - -Generate `#: filename:line´ lines (default). - -
`--strict´ -: - -Write out a strict Uniforum conforming PO file. Note that this -Uniforum format should be avoided because it doesn't support the -GNU extensions. - -
`-p´ -: -
`--properties-output´ -: - - -Write out a Java ResourceBundle in Java .properties syntax. Note -that this file format doesn't support plural forms and silently drops -obsolete messages. - -
`--stringtable-output´ -: - -Write out a NeXTstep/GNUstep localized resource file in .strings syntax. -Note that this file format doesn't support plural forms. - -
`-w number´ -: -
`--width=number´ -: - - -Set the output page width. Long strings in the output files will be -split across multiple lines in order to ensure that each line's width -(= number of screen columns) is less or equal to the given number. - -
`--no-wrap´ -: - -Do not break long message lines. Message lines whose width exceeds the -output page width will not be split into several lines. Only file reference -lines which are wider than the output page width will be split. - -
`--sort-output´ -: - -Generate sorted output. Note that using this option makes it much harder -for the translator to understand each message's context. - -
`--sort-by-file´ -: - -Sort output by file location. - -

- - - -

7.3.6 Informative output

- -

`-h´ -: -
`--help´ -: - - -Display this help and exit. - -
`-V´ -: -
`--version´ -: - - -Output version information and exit. - -

- - - -

7.4 Invoking the `msgfilter` Program

- -

- - - -

-msgfilter [option] filter [filter-option]
-

- -

- -The msgfilter program applies a filter to all translations of a -translation catalog. - -

- - -

7.4.1 Input file location

- -

`-i inputfile´ -: -
`--input=inputfile´ -: - - -Input PO file. - -
`-D directory´ -: -
`--directory=directory´ -: - - -Add directory to the list of directories. Source files are -searched relative to this list of directories. The resulting `.po´ -file will be written relative to the current directory, though. - -

- -

-If no inputfile is given or if it is `-´, standard input is read. - -

- - -

7.4.2 Output file location

- -

`-o file´ -: -
`--output-file=file´ -: - - -Write output to specified file. - -

- -

-The results are written to standard output if no output file is specified -or if it is `-´. - -

- - -

7.4.3 The filter

- -

-The filter can be any program that reads a translation from standard -input and writes a modified translation to standard output. A frequently -used filter is `sed´. - -

- -Note: It is your responsibility to ensure that the filter can cope -with input encoded in the translation catalog's encoding. If the -filter wants input in a particular encoding, you can in a first step -convert the translation catalog to that encoding using the `msgconv´ -program, before invoking `msgfilter´. If the filter wants input -in the locale's encoding, but you want to avoid the locale's encoding, then -you can first convert the translation catalog to UTF-8 using the -`msgconv´ program and then make `msgfilter´ work in an UTF-8 -locale, by using the LC_ALL environment variable. - -

- -Note: Most translations in a translation catalog don't end with a newline -character. For this reason, it is important that the filter -recognizes its last input line even if it ends without a newline, and that -it doesn't add an undesired trailing newline at the end. The `sed´ -program on some platforms is known to ignore the last line of input if it -is not terminated with a newline. You can use GNU sed instead; it -does not have this limitation. - -

- - -

7.4.4 Useful `filter-option`s when the `filter` is `sed´

- -

`-e script´ -: -
`--expression=script´ -: - - -Add script to the commands to be executed. - -
`-f scriptfile´ -: -
`--file=scriptfile´ -: - - -Add the contents of scriptfile to the commands to be executed. - -
`-n´ -: -
`--quiet´ -: -
`--silent´ -: - - - -Suppress automatic printing of pattern space. - -

- - - -

7.4.5 Input file syntax

- -

`-P´ -: -
`--properties-input´ -: - - -Assume the input file is a Java ResourceBundle in Java .properties -syntax, not in PO file syntax. - -
`--stringtable-input´ -: - -Assume the input file is a NeXTstep/GNUstep localized resource file in -.strings syntax, not in PO file syntax. - -

- - - -

7.4.6 Output details

- -

`--force-po´ -: - -Always write an output file even if it contains no message. - -
`--indent´ -: - -Write the .po file using indented style. - -
`--keep-header´ -: - -Keep the header entry, i.e. the message with `msgid ""´, unmodified, -instead of filtering it. By default, the header entry is subject to -filtering like any other message. - -
`--no-location´ -: - -Do not write `#: filename:line´ lines. - -
`--add-location´ -: - -Generate `#: filename:line´ lines (default). - -
`--strict´ -: - -Write out a strict Uniforum conforming PO file. Note that this -Uniforum format should be avoided because it doesn't support the -GNU extensions. - -
`-p´ -: -
`--properties-output´ -: - - -Write out a Java ResourceBundle in Java .properties syntax. Note -that this file format doesn't support plural forms and silently drops -obsolete messages. - -
`--stringtable-output´ -: - -Write out a NeXTstep/GNUstep localized resource file in .strings syntax. -Note that this file format doesn't support plural forms. - -
`-w number´ -: -
`--width=number´ -: - - -Set the output page width. Long strings in the output files will be -split across multiple lines in order to ensure that each line's width -(= number of screen columns) is less or equal to the given number. - -
`--no-wrap´ -: - -Do not break long message lines. Message lines whose width exceeds the -output page width will not be split into several lines. Only file reference -lines which are wider than the output page width will be split. - -
`-s´ -: -
`--sort-output´ -: - - -Generate sorted output. Note that using this option makes it much harder -for the translator to understand each message's context. - -
`-F´ -: -
`--sort-by-file´ -: - - -Sort output by file location. - -

- - - -

7.4.7 Informative output

- -

`-h´ -: -
`--help´ -: - - -Display this help and exit. - -
`-V´ -: -
`--version´ -: - - -Output version information and exit. - -

- - - -

7.5 Invoking the `msguniq` Program

- -

- - - -

-msguniq [option] [inputfile]
-

- -

- - -The msguniq program unifies duplicate translations in a translation -catalog. It finds duplicate translations of the same message ID. Such -duplicates are invalid input for other programs like msgfmt, -msgmerge or msgcat. By default, duplicates are merged -together. When using the `--repeated´ option, only duplicates are -output, and all other messages are discarded. Comments and extracted -comments will be cumulated, except that if `--use-first´ is -specified, they will be taken from the first translation. File positions -will be cumulated. When using the `--unique´ option, duplicates are -discarded. - -

- - -

7.5.1 Input file location

- -

`inputfile´ -: -Input PO file. - -
`-D directory´ -: -
`--directory=directory´ -: - - -Add directory to the list of directories. Source files are -searched relative to this list of directories. The resulting `.po´ -file will be written relative to the current directory, though. - -

- -

-If no inputfile is given or if it is `-´, standard input is read. - -

- - -

7.5.2 Output file location

- -

`-o file´ -: -
`--output-file=file´ -: - - -Write output to specified file. - -

- -

-The results are written to standard output if no output file is specified -or if it is `-´. - -

- - -

7.5.3 Message selection

- -

`-d´ -: -
`--repeated´ -: - - -Print only duplicates. - -
`-u´ -: -
`--unique´ -: - - -Print only unique messages, discard duplicates. - -

- - - -

7.5.4 Input file syntax

- -

`-P´ -: -
`--properties-input´ -: - - -Assume the input file is a Java ResourceBundle in Java .properties -syntax, not in PO file syntax. - -
`--stringtable-input´ -: - -Assume the input file is a NeXTstep/GNUstep localized resource file in -.strings syntax, not in PO file syntax. - -

- - - -

7.5.5 Output details

- -

`-t´ -: -
`--to-code=name´ -: - - -Specify encoding for output. - -
`--use-first´ -: - -Use first available translation for each message. Don't merge several -translations into one. - -
`--force-po´ -: - -Always write an output file even if it contains no message. - -
`-i´ -: -
`--indent´ -: - - -Write the .po file using indented style. - -
`--no-location´ -: - -Do not write `#: filename:line´ lines. - -
`-n´ -: -
`--add-location´ -: - - -Generate `#: filename:line´ lines (default). - -
`--strict´ -: - -Write out a strict Uniforum conforming PO file. Note that this -Uniforum format should be avoided because it doesn't support the -GNU extensions. - -
`-p´ -: -
`--properties-output´ -: - - -Write out a Java ResourceBundle in Java .properties syntax. Note -that this file format doesn't support plural forms and silently drops -obsolete messages. - -
`--stringtable-output´ -: - -Write out a NeXTstep/GNUstep localized resource file in .strings syntax. -Note that this file format doesn't support plural forms. - -
`-w number´ -: -
`--width=number´ -: - - -Set the output page width. Long strings in the output files will be -split across multiple lines in order to ensure that each line's width -(= number of screen columns) is less or equal to the given number. - -
`--no-wrap´ -: - -Do not break long message lines. Message lines whose width exceeds the -output page width will not be split into several lines. Only file reference -lines which are wider than the output page width will be split. - -
`-s´ -: -
`--sort-output´ -: - - -Generate sorted output. Note that using this option makes it much harder -for the translator to understand each message's context. - -
`-F´ -: -
`--sort-by-file´ -: - - -Sort output by file location. - -

- - - -

7.5.6 Informative output

- -

`-h´ -: -
`--help´ -: - - -Display this help and exit. - -
`-V´ -: -
`--version´ -: - - -Output version information and exit. - -

- - - -

7.6 Invoking the `msgcomm` Program

- -

- - - -

-msgcomm [option] [inputfile]...
-

- -

- -The msgcomm program finds messages which are common to two or more -of the specified PO files. -By using the --more-than option, greater commonality may be requested -before messages are printed. Conversely, the --less-than option may be -used to specify less commonality before messages are printed (i.e. -`--less-than=2´ will only print the unique messages). Translations, -comments and extract comments will be preserved, but only from the first -PO file to define them. File positions from all PO files will be -cumulated. - -

- - -

7.6.1 Input file location

- -

`inputfile ...´ -: -Input files. - -
`-f file´ -: -
`--files-from=file´ -: - - -Read the names of the input files from file instead of getting -them from the command line. - -
`-D directory´ -: -
`--directory=directory´ -: - - -Add directory to the list of directories. Source files are -searched relative to this list of directories. The resulting `.po´ -file will be written relative to the current directory, though. - -

- -

-If inputfile is `-´, standard input is read. - -

- - -

7.6.2 Output file location

- -

`-o file´ -: -
`--output-file=file´ -: - - -Write output to specified file. - -

- -

-The results are written to standard output if no output file is specified -or if it is `-´. - -

- - -

7.6.3 Message selection

- -

`-< number´ -: -
`--less-than=number´ -: - - -Print messages with less than number definitions, defaults to infinite -if not set. - -
`-> number´ -: -
`--more-than=number´ -: - - -Print messages with more than number definitions, defaults to 1 if not -set. - -
`-u´ -: -
`--unique´ -: - - -Shorthand for `--less-than=2´. Requests that only unique messages be -printed. - -

- - - -

7.6.4 Input file syntax

- -

`-P´ -: -
`--properties-input´ -: - - -Assume the input files are Java ResourceBundles in Java .properties -syntax, not in PO file syntax. - -
`--stringtable-input´ -: - -Assume the input files are NeXTstep/GNUstep localized resource files in -.strings syntax, not in PO file syntax. - -

- - - -

7.6.5 Output details

- -

`--force-po´ -: - -Always write an output file even if it contains no message. - -
`-i´ -: -
`--indent´ -: - - -Write the .po file using indented style. - -
`--no-location´ -: - -Do not write `#: filename:line´ lines. - -
`-n´ -: -
`--add-location´ -: - - -Generate `#: filename:line´ lines (default). - -
`--strict´ -: - -Write out a strict Uniforum conforming PO file. Note that this -Uniforum format should be avoided because it doesn't support the -GNU extensions. - -
`-p´ -: -
`--properties-output´ -: - - -Write out a Java ResourceBundle in Java .properties syntax. Note -that this file format doesn't support plural forms and silently drops -obsolete messages. - -
`--stringtable-output´ -: - -Write out a NeXTstep/GNUstep localized resource file in .strings syntax. -Note that this file format doesn't support plural forms. - -
`-w number´ -: -
`--width=number´ -: - - -Set the output page width. Long strings in the output files will be -split across multiple lines in order to ensure that each line's width -(= number of screen columns) is less or equal to the given number. - -
`--no-wrap´ -: - -Do not break long message lines. Message lines whose width exceeds the -output page width will not be split into several lines. Only file reference -lines which are wider than the output page width will be split. - -
`-s´ -: -
`--sort-output´ -: - - -Generate sorted output. Note that using this option makes it much harder -for the translator to understand each message's context. - -
`-F´ -: -
`--sort-by-file´ -: - - -Sort output by file location. - -
`--omit-header´ -: - -Don't write header with `msgid ""´ entry. - -

- - - -

7.6.6 Informative output

- -

`-h´ -: -
`--help´ -: - - -Display this help and exit. - -
`-V´ -: -
`--version´ -: - - -Output version information and exit. - -

- - - -

7.7 Invoking the `msgcmp` Program

- -

- - - -

-msgcmp [option] def.po ref.pot
-

- -

- -The msgcmp program compares two Uniforum style .po files to check that -both contain the same set of msgid strings. The def.po file is an -existing PO file with the translations. The ref.pot file is the last -created PO file, or a PO Template file (generally created by xgettext). -This is useful for checking that you have translated each and every message -in your program. Where an exact match cannot be found, fuzzy matching is -used to produce better diagnostics. - -

- - -

7.7.1 Input file location

- -

`def.po´ -: -Translations. - -
`ref.pot´ -: -References to the sources. - -
`-D directory´ -: -
`--directory=directory´ -: - - -Add directory to the list of directories. Source files are -searched relative to this list of directories. - -

- - - -

7.7.2 Operation modifiers

- -

`-m´ -: -
`--multi-domain´ -: - - -Apply ref.pot to each of the domains in def.po. - -

- - - -

7.7.3 Input file syntax

- -

`-P´ -: -
`--properties-input´ -: - - -Assume the input files are Java ResourceBundles in Java .properties -syntax, not in PO file syntax. - -
`--stringtable-input´ -: - -Assume the input files are NeXTstep/GNUstep localized resource files in -.strings syntax, not in PO file syntax. - -

- - - -

7.7.4 Informative output

- -

`-h´ -: -
`--help´ -: - - -Display this help and exit. - -
`-V´ -: -
`--version´ -: - - -Output version information and exit. - -

- - - -

7.8 Invoking the `msgattrib` Program

- -

- - - -

-msgattrib [option] [inputfile]
-

- -

- - -The msgattrib program filters the messages of a translation catalog -according to their attributes, and manipulates the attributes. - -

- - -

7.8.1 Input file location

- -

`inputfile´ -: -Input PO file. - -
`-D directory´ -: -
`--directory=directory´ -: - - -Add directory to the list of directories. Source files are -searched relative to this list of directories. The resulting `.po´ -file will be written relative to the current directory, though. - -

- -

-If no inputfile is given or if it is `-´, standard input is read. - -

- - -

7.8.2 Output file location

- -

`-o file´ -: -
`--output-file=file´ -: - - -Write output to specified file. - -

- -

-The results are written to standard output if no output file is specified -or if it is `-´. - -

- - -

7.8.3 Message selection

- -

`--translated´ -: - -Keep translated messages, remove untranslated messages. - -
`--untranslated´ -: - -Keep untranslated messages, remove translated messages. - -
`--no-fuzzy´ -: - -Remove `fuzzy' marked messages. - -
`--only-fuzzy´ -: - -Keep `fuzzy' marked messages, remove all other messsages. - -
`--no-obsolete´ -: - -Remove obsolete #~ messages. - -
`--only-obsolete´ -: - -Keep obsolete #~ messages, remove all other messages. - -

- - - -

7.8.4 Attribute manipulation

- -

- -Attributes are modified after the message selection/removal has been -performed. If the `--only-file´ or `--ignore-file´ option is -specified, the attribute modification is applied only to those messages -that are listed in the only-file and not listed in the -ignore-file. - -

`--set-fuzzy´ -: - -Set all messages `fuzzy'. - -
`--clear-fuzzy´ -: - -Set all messages non-`fuzzy'. - -
`--set-obsolete´ -: - -Set all messages obsolete. - -
`--clear-obsolete´ -: - -Set all messages non-obsolete. - -
`--only-file=file´ -: - -Limit the attribute changes to entries that are listed in file. -file should be a PO or POT file. - -
`--ignore-file=file´ -: - -Limit the attribute changes to entries that are not listed in file. -file should be a PO or POT file. - -
`--fuzzy´ -: - -Synonym for `--only-fuzzy --clear-fuzzy´: It keeps only the fuzzy -messages and removes their `fuzzy' mark. - -
`--obsolete´ -: - -Synonym for `--only-obsolete --clear-obsolete´: It keeps only the -obsolete messages and makes them non-obsolete. - -

- - - -

7.8.5 Input file syntax

- -

`-P´ -: -
`--properties-input´ -: - - -Assume the input file is a Java ResourceBundle in Java .properties -syntax, not in PO file syntax. - -
`--stringtable-input´ -: - -Assume the input file is a NeXTstep/GNUstep localized resource file in -.strings syntax, not in PO file syntax. - -

- - - -

7.8.6 Output details

- -

`--force-po´ -: - -Always write an output file even if it contains no message. - -
`-i´ -: -
`--indent´ -: - - -Write the .po file using indented style. - -
`--no-location´ -: - -Do not write `#: filename:line´ lines. - -
`-n´ -: -
`--add-location´ -: - - -Generate `#: filename:line´ lines (default). - -
`--strict´ -: - -Write out a strict Uniforum conforming PO file. Note that this -Uniforum format should be avoided because it doesn't support the -GNU extensions. - -
`-p´ -: -
`--properties-output´ -: - - -Write out a Java ResourceBundle in Java .properties syntax. Note -that this file format doesn't support plural forms and silently drops -obsolete messages. - -
`--stringtable-output´ -: - -Write out a NeXTstep/GNUstep localized resource file in .strings syntax. -Note that this file format doesn't support plural forms. - -
`-w number´ -: -
`--width=number´ -: - - -Set the output page width. Long strings in the output files will be -split across multiple lines in order to ensure that each line's width -(= number of screen columns) is less or equal to the given number. - -
`--no-wrap´ -: - -Do not break long message lines. Message lines whose width exceeds the -output page width will not be split into several lines. Only file reference -lines which are wider than the output page width will be split. - -
`-s´ -: -
`--sort-output´ -: - - -Generate sorted output. Note that using this option makes it much harder -for the translator to understand each message's context. - -
`-F´ -: -
`--sort-by-file´ -: - - -Sort output by file location. - -

- - - -

7.8.7 Informative output

- -

`-h´ -: -
`--help´ -: - - -Display this help and exit. - -
`-V´ -: -
`--version´ -: - - -Output version information and exit. - -

- - - -

7.9 Invoking the `msgen` Program

- -

- - - -

-msgen [option] inputfile
-

- -

- -The msgen program creates an English translation catalog. The -input file is the last created English PO file, or a PO Template file -(generally created by xgettext). Untranslated entries are assigned a -translation that is identical to the msgid. - -

-Note: `msginit --no-translator --locale=en´ performs a very similar -task. The main difference is that msginit cares specially about -the header entry, whereas msgen doesn't. - -

- - -

7.9.1 Input file location

- -

`inputfile´ -: -Input PO or POT file. - -
`-D directory´ -: -
`--directory=directory´ -: - - -Add directory to the list of directories. Source files are -searched relative to this list of directories. The resulting `.po´ -file will be written relative to the current directory, though. - -

- -

-If inputfile is `-´, standard input is read. - -

- - -

7.9.2 Output file location

- -

`-o file´ -: -
`--output-file=file´ -: - - -Write output to specified file. - -

- -

-The results are written to standard output if no output file is specified -or if it is `-´. - -

- - -

7.9.3 Input file syntax

- -

`-P´ -: -
`--properties-input´ -: - - -Assume the input file is a Java ResourceBundle in Java .properties -syntax, not in PO file syntax. - -
`--stringtable-input´ -: - -Assume the input file is a NeXTstep/GNUstep localized resource file in -.strings syntax, not in PO file syntax. - -

- - - -

7.9.4 Output details

- -

`--force-po´ -: - -Always write an output file even if it contains no message. - -
`-i´ -: -
`--indent´ -: - - -Write the .po file using indented style. - -
`--no-location´ -: - -Do not write `#: filename:line´ lines. - -
`--add-location´ -: - -Generate `#: filename:line´ lines (default). - -
`--strict´ -: - -Write out a strict Uniforum conforming PO file. Note that this -Uniforum format should be avoided because it doesn't support the -GNU extensions. - -
`-p´ -: -
`--properties-output´ -: - - -Write out a Java ResourceBundle in Java .properties syntax. Note -that this file format doesn't support plural forms and silently drops -obsolete messages. - -
`--stringtable-output´ -: - -Write out a NeXTstep/GNUstep localized resource file in .strings syntax. -Note that this file format doesn't support plural forms. - -
`-w number´ -: -
`--width=number´ -: - - -Set the output page width. Long strings in the output files will be -split across multiple lines in order to ensure that each line's width -(= number of screen columns) is less or equal to the given number. - -
`--no-wrap´ -: - -Do not break long message lines. Message lines whose width exceeds the -output page width will not be split into several lines. Only file reference -lines which are wider than the output page width will be split. - -
`-s´ -: -
`--sort-output´ -: - - -Generate sorted output. Note that using this option makes it much harder -for the translator to understand each message's context. - -
`-F´ -: -
`--sort-by-file´ -: - - -Sort output by file location. - -

- - - -

7.9.5 Informative output

- -

`-h´ -: -
`--help´ -: - - -Display this help and exit. - -
`-V´ -: -
`--version´ -: - - -Output version information and exit. - -

- - - -

7.10 Invoking the `msgexec` Program

- -

- - - -

-msgexec [option] command [command-option]
-

- -

- -The msgexec program applies a command to all translations of a -translation catalog. -The command can be any program that reads a translation from standard -input. It is invoked once for each translation. Its output becomes -msgexec's output. msgexec's return code is the maximum return code -across all invocations. - -

- -A special builtin command called `0´ outputs the translation, followed -by a null byte. The output of `msgexec 0´ is suitable as input for -`xargs -0´. - -

- - -During each command invocation, the environment variable -MSGEXEC_MSGID is bound to the message's msgid, and the environment -variable MSGEXEC_LOCATION is bound to the location in the PO file -of the message. - -

- -Note: It is your responsibility to ensure that the command can cope -with input encoded in the translation catalog's encoding. If the -command wants input in a particular encoding, you can in a first step -convert the translation catalog to that encoding using the `msgconv´ -program, before invoking `msgexec´. If the command wants input -in the locale's encoding, but you want to avoid the locale's encoding, then -you can first convert the translation catalog to UTF-8 using the -`msgconv´ program and then make `msgexec´ work in an UTF-8 -locale, by using the LC_ALL environment variable. - -

- - -

7.10.1 Input file location

- -

`-i inputfile´ -: -
`--input=inputfile´ -: - - -Input PO file. - -
`-D directory´ -: -
`--directory=directory´ -: - - -Add directory to the list of directories. Source files are -searched relative to this list of directories. The resulting `.po´ -file will be written relative to the current directory, though. - -

- -

-If no inputfile is given or if it is `-´, standard input is read. - -

- - -

7.10.2 Input file syntax

- -

`-P´ -: -
`--properties-input´ -: - - -Assume the input file is a Java ResourceBundle in Java .properties -syntax, not in PO file syntax. - -
`--stringtable-input´ -: - -Assume the input file is a NeXTstep/GNUstep localized resource file in -.strings syntax, not in PO file syntax. - -

- - - -

7.10.3 Informative output

- -

`-h´ -: -
`--help´ -: - - -Display this help and exit. - -
`-V´ -: -
`--version´ -: - - -Output version information and exit. - -

- - - -

7.11 Writing your own programs that process PO files

- -

-For the tasks for which a combination of `msgattrib´, `msgcat´ etc. -is not sufficient, a set of C functions is provided in a library, to make it -possible to process PO files in your own programs. When you use this library, -you don't need to write routines to parse the PO file; instead, you retreive -a pointer in memory to each of messages contained in the PO file. Functions -for writing PO files are not provided at this time. - -

-The functions are declared in the header file `<gettext-po.h>´, and are -defined in a library called `libgettextpo´. - -

Data Type: po_file_t -: -This is a pointer type that refers to the contents of a PO file, after it has -been read into memory. -

- -

Data Type: po_message_iterator_t -: -This is a pointer type that refers to an iterator that produces a sequence of -messages. -

- -

Data Type: po_message_t -: -This is a pointer type that refers to a message of a PO file, including its -translation. -

- -

Function: po_file_t po_file_read (const char *filename) -: -The po_file_read function reads a PO file into memory. The file name -is given as argument. The return value is a handle to the PO file's contents, -valid until po_file_free is called on it. In case of error, the return -value is NULL, and errno is set. -

- -

Function: void po_file_free (po_file_t file) -: -The po_file_free function frees a PO file's contents from memory, -including all messages that are only implicitly accessible through iterators. -

- -

Function: const char * const * po_file_domains (po_file_t file) -: -The po_file_domains function returns the domains for which the given -PO file has messages. The return value is a NULL terminated array -which is valid as long as the file handle is valid. For PO files which -contain no `domain´ directive, the return value contains only one domain, -namely the default domain "messages". -

- -

Function: po_message_iterator_t po_message_iterator (po_file_t file, const char *domain) -: -The po_message_iterator returns an iterator that will produce the -messages of file that belong to the given domain. If domain -is NULL, the default domain is used instead. To list the messages, -use the function po_next_message repeatedly. -

- -

Function: void po_message_iterator_free (po_message_iterator_t iterator) -: -The po_message_iterator_free function frees an iterator previously -allocated through the po_message_iterator function. -

- -

Function: po_message_t po_next_message (po_message_iterator_t iterator) -: -The po_next_message function returns the next message from -iterator and advances the iterator. It returns NULL when the -iterator has reached the end of its message list. -

- -

-The following functions returns details of a po_message_t. Recall -that the results are valid as long as the file handle is valid. - -

Function: const char * po_message_msgid (po_message_t message) -: -The po_message_msgid function returns the msgid (untranslated -English string) of a message. This is guaranteed to be non-NULL. -

- -

Function: const char * po_message_msgid_plural (po_message_t message) -: -The po_message_msgid_plural function returns the msgid_plural -(untranslated English plural string) of a message with plurals, or NULL -for a message without plural. -

- -

Function: const char * po_message_msgstr (po_message_t message) -: -The po_message_msgstr function returns the msgstr (translation) -of a message. For an untranslated message, the return value is an empty -string. -

- -

Function: const char * po_message_msgstr_plural (po_message_t message, int index) -: -The po_message_msgstr_plural function returns the -msgstr[index] of a message with plurals, or NULL when -the index is out of range or for a message without plural. -

- -

-Here is an example code how these functions can be used. - -

- -

-const char *filename = ...;
-po_file_t file = po_file_read (filename);
-
-if (file == NULL)
-  error (EXIT_FAILURE, errno, "couldn't open the PO file %s", filename);
-{
-  const char * const *domains = po_file_domains (file);
-  const char * const *domainp;
-
-  for (domainp = domains; *domainp; domainp++)
-    {
-      const char *domain = *domainp;
-      po_message_iterator_t iterator = po_message_iterator (file, domain);
-
-      for (;;)
-        {
-          po_message_t *message = po_next_message (iterator);
-
-          if (message == NULL)
-            break;
-          {
-            const char *msgid = po_message_msgid (message);
-            const char *msgstr = po_message_msgstr (message);
-
-            ...
-          }
-        }
-      po_message_iterator_free (iterator);
-    }
-}
-po_file_free (file);
-

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_8.html b/gettext-tools/doc/gettext_8.html index 03dc12556..eef482f22 100644 --- a/gettext-tools/doc/gettext_8.html +++ b/gettext-tools/doc/gettext_8.html @@ -1,868 +1,1815 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - 8 Producing Binary MO Files +GNU gettext utilities - 8 Editing PO Files -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

8 Producing Binary MO Files

8 Editing PO Files

+ + +

+ + + +

8.1 KDE's PO File Editor

+ + +

8.2 GNOME's PO File Editor

+ + +

8.3 Emacs's PO File Editor

+ + +

+ -

8.1 Invoking the `msgfmt` Program

8.3.1 Completing GNU `gettext` Installation

+ +

+ + +Once you have received, unpacked, configured and compiled the GNU +gettext distribution, the `make install´ command puts in +place the programs xgettext, msgfmt, gettext, and +msgmerge, as well as their available message catalogs. To +top off a comfortable installation, you might also want to make the +PO mode available to your Emacs users. + +

- - + + +During the installation of the PO mode, you might want to modify your +file `.emacs´, once and for all, so it contains a few lines looking +like: + +

-msgfmt [option] filename.po ...
+(setq auto-mode-alist
+      (cons '("\\.po\\'\\|\\.po\\." . po-mode) auto-mode-alist))
+(autoload 'po-mode "po-mode" "Major mode for translators to edit PO files" t)

- -The msgfmt programs generates a binary message catalog from a textual -translation description. +Later, whenever you edit some `.po´ +file, or any file having the string `.po.´ within its name, +Emacs loads `po-mode.elc´ (or `po-mode.el´) as needed, and +automatically activates PO mode commands for the associated buffer. +The string PO appears in the mode line for any buffer for +which PO mode is active. Many PO files may be active at once in a +single Emacs session.

+If you are using Emacs version 20 or newer, and have already installed +the appropriate international fonts on your system, you may also tell +Emacs how to determine automatically the coding system of every PO file. +This will often (but not always) cause the necessary fonts to be loaded +and used for displaying the translations on your Emacs screen. For this +to happen, add the lines: +

+ +

+(modify-coding-system-alist 'file "\\.po\\'\\|\\.po\\."
+                            'po-find-file-coding-system)
+(autoload 'po-find-file-coding-system "po-mode")
+

8.1.1 Input file location

+to your `.emacs´ file. If, with this, you still see boxes instead +of international characters, try a different font set (via Shift Mouse +button 1). -

`filename.po ...´ -: -
`-D directory´ -: -
`--directory=directory´ -: - - -Add directory to the list of directories. Source files are -searched relative to this list of directories. The resulting `.po´ -file will be written relative to the current directory, though. -

8.3.2 Main PO mode Commands

-If an input file is `-´, standard input is read. + + +After setting up Emacs with something similar to the lines in +section 8.3.1 Completing GNU gettext Installation, PO mode is activated for a window when Emacs finds a +PO file in that window. This puts the window read-only and establishes a +po-mode-map, which is a genuine Emacs mode, in a way that is not derived +from text mode in any way. Functions found on po-mode-hook, +if any, will be executed.

+When PO mode is active in a window, the letters `PO´ appear +in the mode line for that window. The mode line also displays how +many entries of each kind are held in the PO file. For example, +the string `132t+3f+10u+2o´ would tell the translator that the +PO mode contains 132 translated entries (see section 8.3.5 Translated Entries, +3 fuzzy entries (see section 8.3.6 Fuzzy Entries), 10 untranslated entries +(see section 8.3.7 Untranslated Entries) and 2 obsolete entries (see section 8.3.8 Obsolete Entries). Zero-coefficients items are not shown. So, in this example, if +the fuzzy entries were unfuzzied, the untranslated entries were translated +and the obsolete entries were deleted, the mode line would merely display +`145t´ for the counters. +

+The main PO commands are those which do not fit into the other categories of +subsequent sections. These allow for quitting PO mode or for managing windows +in special ways. -

8.1.2 Operation mode

- +

`-j´ +
_: -
`--java´ + +Undo last modification to the PO file (po-undo). + +
Q: - - - -Java mode: generate a Java ResourceBundle class. + +Quit processing and save the PO file (po-quit). -
`--java2´ +
q: - -Like --java, and assume Java2 (JDK 1.2 or higher). + +Quit processing, possibly after confirmation (po-confirm-and-quit). -
`--csharp´ +
0: - - -C# mode: generate a .NET .dll file containing a subclass of -GettextResourceSet. + +Temporary leave the PO file window (po-other-window). -
`--csharp-resources´ +
?: - - -C# resources mode: generate a .NET `.resources´ file. +
h +: + + +Show help about PO mode (po-help). -
`--tcl´ +
=: - - -Tcl mode: generate a tcl/msgcat `.msg´ file. + +Give some PO file statistics (po-statistics). -
`--qt´ +
V: - - -Qt mode: generate a Qt `.qm´ file. + +Batch validate the format of the whole PO file (po-validate).

+ + +The command _ (po-undo) interfaces to the Emacs +undo facility. See section `Undoing Changes' in The Emacs Editor. Each time U is typed, modifications which the translator +did to the PO file are undone a little more. For the purpose of +undoing, each PO mode command is atomic. This is especially true for +the RET command: the whole edition made by using a single +use of this command is undone at once, even if the edition itself +implied several actions. However, while in the editing window, one +can undo the edition work quite parsimoniously. +

+ + + + +The commands Q (po-quit) and q +(po-confirm-and-quit) are used when the translator is done with the +PO file. The former is a bit less verbose than the latter. If the file +has been modified, it is saved to disk first. In both cases, and prior to +all this, the commands check if any untranslated messages remain in the +PO file and, if so, the translator is asked if she really wants to leave +off working with this PO file. This is the preferred way of getting rid +of an Emacs PO file buffer. Merely killing it through the usual command +C-x k (kill-buffer) is not the tidiest way to proceed. -

8.1.3 Output file location

+ + +The command 0 (po-other-window) is another, softer way, +to leave PO mode, temporarily. It just moves the cursor to some other +Emacs window, and pops one if necessary. For example, if the translator +just got PO mode to show some source context in some other, she might +discover some apparent bug in the program source that needs correction. +This command allows the translator to change sex, become a programmer, +and have the cursor right into the window containing the program she +(or rather he) wants to modify. By later getting the cursor back +in the PO file window, or by asking Emacs to edit this file once again, +PO mode is then recovered. -

+ + + +The command h (po-help) displays a summary of all available PO +mode commands. The translator should then type any character to resume +normal PO mode operations. The command ? has the same effect +as h. -

`-o file´ -

`--output-file=file´ -

- - -Write output to specified file. +

+ + +The command = (po-statistics) computes the total number of +entries in the PO file, the ordinal of the current entry (counted from +1), the number of untranslated entries, the number of obsolete entries, +and displays all these numbers. -

`--strict´ -

- -Direct the program to work strictly following the Uniforum/Sun -implementation. Currently this only affects the naming of the output -file. If this option is not given the name of the output file is the -same as the domain name. If the strict Uniforum mode is enabled the -suffix `.mo´ is added to the file name if it is not already -present. +

+ + +The command V (po-validate) launches msgfmt in +checking and verbose +mode over the current PO file. This command first offers to save the +current PO file on disk. The msgfmt tool, from GNU gettext, +has the purpose of creating a MO file out of a PO file, and PO mode uses +the features of this program for checking the overall format of a PO file, +as well as all individual entries. -We find this behaviour of Sun's implementation rather silly and so by -default this mode is not selected. +

+ +The program msgfmt runs asynchronously with Emacs, so the +translator regains control immediately while her PO file is being studied. +Error output is collected in the Emacs `*compilation*´ buffer, +displayed in another window. The regular Emacs command C-x` +(next-error), as well as other usual compile commands, allow the +translator to reposition quickly to the offending parts of the PO file. +Once the cursor is on the line in error, the translator may decide on +any PO mode action which would help correcting the error. + +

+ +

8.3.3 Entry Positioning

-If the output file is `-´, output is written to standard output. + +The cursor in a PO file window is almost always part of +an entry. The only exceptions are the special case when the cursor +is after the last entry in the file, or when the PO file is +empty. The entry where the cursor is found to be is said to be the +current entry. Many PO mode commands operate on the current entry, +so moving the cursor does more than allowing the translator to browse +the PO file, this also selects on which entry commands operate.

+ +Some PO mode commands alter the position of the cursor in a specialized +way. A few of those special purpose positioning are described here, +the others are described in following sections (for a complete list try +C-h m): +

8.1.4 Output file location in Java mode

. +

+ +Redisplay the current entry (po-current-entry). -

n +: + +Select the entry after the current one (po-next-entry). -
`-r resource´ +
p: -
`--resource=resource´ + +Select the entry before the current one (po-previous-entry). + +
< +: + +Select the first entry in the PO file (po-first-entry). + +
>: - - -Specify the resource name. + +Select the last entry in the PO file (po-last-entry). -
`-l locale´ +
m: -
`--locale=locale´ + +Record the location of the current entry for later use +(po-push-location). + +
r: - - -Specify the locale name, either a language specification of the form ll -or a combined language and country specification of the form ll_CC. + +Return to a previously saved entry location (po-pop-location). -
`-d directory´ +
x: - -Specify the base directory of classes directory hierarchy. + +Exchange the current entry location with the previously saved one +(po-exchange-location).

-The class name is determined by appending the locale name to the resource name, -separated with an underscore. The `-d´ option is mandatory. The class -is written under the specified directory. + + +Any Emacs command able to reposition the cursor may be used +to select the current entry in PO mode, including commands which +move by characters, lines, paragraphs, screens or pages, and search +commands. However, there is a kind of standard way to display the +current entry in PO mode, which usual Emacs commands moving +the cursor do not especially try to enforce. The command . +(po-current-entry) has the sole purpose of redisplaying the +current entry properly, after the current entry has been changed by +means external to PO mode, or the Emacs screen otherwise altered.

+It is yet to be decided if PO mode helps the translator, or otherwise +irritates her, by forcing a rigid window disposition while she +is doing her work. We originally had quite precise ideas about +how windows should behave, but on the other hand, anyone used to +Emacs is often happy to keep full control. Maybe a fixed window +disposition might be offered as a PO mode option that the translator +might activate or deactivate at will, so it could be offered on an +experimental basis. If nobody feels a real need for using it, or +a compulsion for writing it, we should drop this whole idea. +The incentive for doing it should come from translators rather than +programmers, as opinions from an experienced translator are surely +more worth to me than opinions from programmers thinking about +how others should do translation. +

+ + + + +The commands n (po-next-entry) and p +(po-previous-entry) move the cursor the entry following, +or preceding, the current one. If n is given while the +cursor is on the last entry of the PO file, or if p +is given while the cursor is on the first entry, no move is done. -

8.1.5 Output file location in C# mode

+ + + + +The commands < (po-first-entry) and > +(po-last-entry) move the cursor to the first entry, or last +entry, of the PO file. When the cursor is located past the last +entry in a PO file, most PO mode commands will return an error saying +`After last entry´. Moreover, the commands < and > +have the special property of being able to work even when the cursor +is not into some PO file entry, and one may use them for nicely +correcting this situation. But even these commands will fail on a +truly empty PO file. There are development plans for the PO mode for it +to interactively fill an empty PO file from sources. See section 4.4 Marking Translatable Strings. -

+The translator may decide, before working at the translation of +a particular entry, that she needs to browse the remainder of the +PO file, maybe for finding the terminology or phraseology used +in related entries. She can of course use the standard Emacs idioms +for saving the current cursor location in some register, and use that +register for getting back, or else, use the location ring. -

`-r resource´ -

`--resource=resource´ -

- - -Specify the resource name. +

+ + + + +PO mode offers another approach, by which cursor locations may be saved +onto a special stack. The command m (po-push-location) +merely adds the location of current entry to the stack, pushing +the already saved locations under the new one. The command +r (po-pop-location) consumes the top stack element and +repositions the cursor to the entry associated with that top element. +This position is then lost, for the next r will move the cursor +to the previously saved location, and so on until no locations remain +on the stack. -

`-l locale´ -

`--locale=locale´ -

- - -Specify the locale name, either a language specification of the form ll -or a combined language and country specification of the form ll_CC. +

+If the translator wants the position to be kept on the location stack, +maybe for taking a look at the entry associated with the top +element, then go elsewhere with the intent of getting back later, she +ought to use m immediately after r. + +

+ + +The command x (po-exchange-location) simultaneously +repositions the cursor to the entry associated with the top element of +the stack of saved locations, and replaces that top element with the +location of the current entry before the move. Consequently, repeating +the x command toggles alternatively between two entries. +For achieving this, the translator will position the cursor on the +first entry, use m, then position to the second entry, and +merely use x for making the switch. + +

+ + +

8.3.4 Normalizing Strings in Entries

+ + +

+There are many different ways for encoding a particular string into a +PO file entry, because there are so many different ways to split and +quote multi-line strings, and even, to represent special characters +by backslashed escaped sequences. Some features of PO mode rely on +the ability for PO mode to scan an already existing PO file for a +particular string encoded into the msgid field of some entry. +Even if PO mode has internally all the built-in machinery for +implementing this recognition easily, doing it fast is technically +difficult. To facilitate a solution to this efficiency problem, +we decided on a canonical representation for strings. + +

+A conventional representation of strings in a PO file is currently +under discussion, and PO mode experiments with a canonical representation. +Having both xgettext and PO mode converging towards a uniform +way of representing equivalent strings would be useful, as the internal +normalization needed by PO mode could be automatically satisfied +when using xgettext from GNU gettext. An explicit +PO mode normalization should then be only necessary for PO files +imported from elsewhere, or for when the convention itself evolves. + +

+So, for achieving normalization of at least the strings of a given +PO file needing a canonical representation, the following PO mode +command is available: + +

+ +

`-d directory´ +
M-x po-normalize: - -Specify the base directory for locale dependent `.dll´ files. + +Tidy the whole PO file by making entries more uniform.

-The `-l´ and `-d´ options are mandatory. The `.dll´ file is -written in a subdirectory of the specified directory whose name depends on the -locale. +The special command M-x po-normalize, which has no associated +keys, revises all entries, ensuring that strings of both original +and translated entries use uniform internal quoting in the PO file. +It also removes any crumb after the last entry. This command may be +useful for PO files freshly imported from elsewhere, or if we ever +improve on the canonical quoting format we use. This canonical format +is not only meant for getting cleaner PO files, but also for greatly +speeding up msgid string lookup for some other PO mode commands.

+M-x po-normalize presently makes three passes over the entries. +The first implements heuristics for converting PO files for GNU +gettext 0.6 and earlier, in which msgid and msgstr +fields were using K&R style C string syntax for multi-line strings. +These heuristics may fail for comments not related to obsolete +entries and ending with a backslash; they also depend on subsequent +passes for finalizing the proper commenting of continued lines for +obsolete entries. This first pass might disappear once all oldish PO +files would have been adjusted. The second and third pass normalize +all msgid and msgstr strings respectively. They also +clean out those trailing backslashes used by XView's msgfmt +for continued lines. + +

+ +Having such an explicit normalizing command allows for importing PO +files from other sources, but also eases the evolution of the current +convention, evolution driven mostly by aesthetic concerns, as of now. +It is easy to make suggested adjustments at a later time, as the +normalizing command and eventually, other GNU gettext tools +should greatly automate conformance. A description of the canonical +string format is given below, for the particular benefit of those not +having Emacs handy, and who would nevertheless want to handcraft +their PO files in nice ways. + +

+ +Right now, in PO mode, strings are single line or multi-line. A string +goes multi-line if and only if it has embedded newlines, that +is, if it matches `[^\n]\n+[^\n]´. So, we would have: + +

+ +

+msgstr "\n\nHello, world!\n\n\n"
+

+ +

+but, replacing the space by a newline, this becomes: +

+ +

+msgstr ""
+"\n"
+"\n"
+"Hello,\n"
+"world!\n"
+"\n"
+"\n"
+

+ +

+We are deliberately using a caricatural example, here, to make the +point clearer. Usually, multi-lines are not that bad looking. +It is probable that we will implement the following suggestion. +We might lump together all initial newlines into the empty string, +and also all newlines introducing empty lines (that is, for n +> 1, the n-1'th last newlines would go together on a separate +string), so making the previous example appear: + +

+ +

+msgstr "\n\n"
+"Hello,\n"
+"world!\n"
+"\n\n"
+

8.1.6 Output file location in Tcl mode

+There are a few yet undecided little points about string normalization, +to be documented in this manual, once these questions settle. + +

+ +

8.3.5 Translated Entries

+ + +

+Each PO file entry for which the msgstr field has been filled with +a translation, and which is not marked as fuzzy (see section 8.3.6 Fuzzy Entries), +is said to be a translated entry. Only translated entries will +later be compiled by GNU msgfmt and become usable in programs. +Other entry types will be excluded; translation will not occur for them. + +

+ +Some commands are more specifically related to translated entry processing. + +

`-l locale´ -: -
`--locale=locale´ +
t: - - -Specify the locale name, either a language specification of the form ll -or a combined language and country specification of the form ll_CC. + +Find the next translated entry (po-next-translated-entry). -
`-d directory´ +
T: - -Specify the base directory of `.msg´ message catalogs. + +Find the previous translated entry (po-previous-translated-entry).

-The `-l´ and `-d´ options are mandatory. The `.msg´ file is -written in the specified directory. + + + + +The commands t (po-next-translated-entry) and T +(po-previous-translated-entry) move forwards or backwards, chasing +for an translated entry. If none is found, the search is extended and +wraps around in the PO file buffer.

+ +Translated entries usually result from the translator having edited in +a translation for them, section 8.3.9 Modifying Translations. However, if the +variable po-auto-fuzzy-on-edit is not nil, the entry having +received a new translation first becomes a fuzzy entry, which ought to +be later unfuzzied before becoming an official, genuine translated entry. +See section 8.3.6 Fuzzy Entries. +

8.1.7 Input file syntax

8.3.6 Fuzzy Entries

+ + +

+ + +Each PO file entry may have a set of attributes, which are +qualities given a name and explicitly associated with the translation, +using a special system comment. One of these attributes +has the name fuzzy, and entries having this attribute are said +to have a fuzzy translation. They are called fuzzy entries, for short. + +

+Fuzzy entries, even if they account for translated entries for +most other purposes, usually call for revision by the translator. +Those may be produced by applying the program msgmerge to +update an older translated PO files according to a new PO template +file, when this tool hypothesises that some new msgid has +been modified only slightly out of an older one, and chooses to pair +what it thinks to be the old translation for the new modified entry. +The slight alteration in the original string (the msgid string) +should often be reflected in the translated string, and this requires +the intervention of the translator. For this reason, msgmerge +might mark some entries as being fuzzy. + +

+ +Also, the translator may decide herself to mark an entry as fuzzy +for her own convenience, when she wants to remember that the entry +has to be later revisited. So, some commands are more specifically +related to fuzzy entry processing. + +

`-P´ +
z: -
`--properties-input´ + +Find the next fuzzy entry (po-next-fuzzy-entry). + +
Z: - - -Assume the input files are Java ResourceBundles in Java .properties -syntax, not in PO file syntax. + +Find the previous fuzzy entry (po-previous-fuzzy-entry). -
`--stringtable-input´ +
TAB: - -Assume the input files are NeXTstep/GNUstep localized resource files in -.strings syntax, not in PO file syntax. + +Remove the fuzzy attribute of the current entry (po-unfuzzy).

+ + + + +The commands z (po-next-fuzzy-entry) and Z +(po-previous-fuzzy-entry) move forwards or backwards, chasing for +a fuzzy entry. If none is found, the search is extended and wraps +around in the PO file buffer. + +

+ + + +The command TAB (po-unfuzzy) removes the fuzzy +attribute associated with an entry, usually leaving it translated. +Further, if the variable po-auto-select-on-unfuzzy has not +the nil value, the TAB command will automatically chase +for another interesting entry to work on. The initial value of +po-auto-select-on-unfuzzy is nil. +

+The initial value of po-auto-fuzzy-on-edit is nil. However, +if the variable po-auto-fuzzy-on-edit is set to t, any entry +edited through the RET command is marked fuzzy, as a way to +ensure some kind of double check, later. In this case, the usual paradigm +is that an entry becomes fuzzy (if not already) whenever the translator +modifies it. If she is satisfied with the translation, she then uses +TAB to pick another entry to work on, clearing the fuzzy attribute +on the same blow. If she is not satisfied yet, she merely uses SPC +to chase another entry, leaving the entry fuzzy. -

8.1.8 Input file interpretation

+ + +The translator may also use the DEL command +(po-fade-out-entry) over any translated entry to mark it as being +fuzzy, when she wants to easily leave a trace she wants to later return +working at this entry. -

+Also, when time comes to quit working on a PO file buffer with the q +command, the translator is asked for confirmation, if fuzzy string +still exists. -

`-c´ -

`--check´ -

- - -Perform all the checks implied by --check-format, --check-header, ---check-domain. +

`--check-format´ -

- - -Check language dependent format strings. -If the string represents a format string used in a -printf-like function both strings should have the same number of -`%´ format specifiers, with matching types. If the flag -c-format or possible-c-format appears in the special -comment #, for this entry a check is performed. For example, the -check will diagnose using `%.*s´ against `%s´, or `%d´ -against `%s´, or `%d´ against `%x´. It can even handle -positional parameters. +

8.3.7 Untranslated Entries

+ -Normally the xgettext program automatically decides whether a -string is a format string or not. This algorithm is not perfect, -though. It might regard a string as a format string though it is not -used in a printf-like function and so msgfmt might report -errors where there are none. +

+When xgettext originally creates a PO file, unless told +otherwise, it initializes the msgid field with the untranslated +string, and leaves the msgstr string to be empty. Such entries, +having an empty translation, are said to be untranslated entries. +Later, when the programmer slightly modifies some string right in +the program, this change is later reflected in the PO file +by the appearance of a new untranslated entry for the modified string. -To solve this problem the programmer can dictate the decision to the -xgettext program (see section 13.3.1 C Format Strings). The translator should not -consider removing the flag from the #, line. This "fix" would be -reversed again as soon as msgmerge is called the next time. +

+The usual commands moving from entry to entry consider untranslated +entries on the same level as active entries. Untranslated entries +are easily recognizable by the fact they end with `msgstr ""´. -

`--check-header´ -

- -Verify presence and contents of the header entry. See section 5.2 Filling in the Header Entry, -for a description of the various fields in the header entry. +

+ +The work of the translator might be (quite naively) seen as the process +of seeking for an untranslated entry, editing a translation for +it, and repeating these actions until no untranslated entries remain. +Some commands are more specifically related to untranslated entry +processing. -

`--check-domain´ -

- -Check for conflicts between domain directives and the --output-file -option +

`-C´ +
u: -
`--check-compatibility´ -: - - - -Check that GNU msgfmt behaves like X/Open msgfmt. This will give an error -when attempting to use the GNU extensions. + +Find the next untranslated entry (po-next-untranslated-entry). -
`--check-accelerators[=char]´ +
U: - - - - -Check presence of keyboard accelerators for menu items. This is based on -the convention used in some GUIs that a keyboard accelerator in a menu -item string is designated by an immediately preceding `&´ character. -Sometimes a keyboard accelerator is also called "keyboard mnemonic". -This check verifies that if the untranslated string has exactly one -`&´ character, the translated string has exactly one `&´ as well. -If this option is given with a char argument, this char should -be a non-alphanumeric character and is used as keyboard accelerator mark -instead of `&´. + +Find the previous untranslated entry (po-previous-untransted-entry). -
`-f´ -: -
`--use-fuzzy´ +
k: - - - -Use fuzzy entries in output. Note that using this option is usually wrong, -because fuzzy messages are exactly those which have not been validated by -a human translator. + +Turn the current entry into an untranslated one (po-kill-msgstr).

+ + + + +The commands u (po-next-untranslated-entry) and U +(po-previous-untransted-entry) move forwards or backwards, +chasing for an untranslated entry. If none is found, the search is +extended and wraps around in the PO file buffer. +

+ + +An entry can be turned back into an untranslated entry by +merely emptying its translation, using the command k +(po-kill-msgstr). See section 8.3.9 Modifying Translations. + +

+Also, when time comes to quit working on a PO file buffer +with the q command, the translator is asked for confirmation, +if some untranslated string still exists. + +

8.1.9 Output details

8.3.8 Obsolete Entries

+ + +

+By obsolete PO file entries, we mean those entries which are +commented out, usually by msgmerge when it found that the +translation is not needed anymore by the package being localized. + +

+The usual commands moving from entry to entry consider obsolete +entries on the same level as active entries. Obsolete entries are +easily recognizable by the fact that all their lines start with +#, even those lines containing msgid or msgstr. + +

+Commands exist for emptying the translation or reinitializing it +to the original untranslated string. Commands interfacing with the +kill ring may force some previously saved text into the translation. +The user may interactively edit the translation. All these commands +may apply to obsolete entries, carefully leaving the entry obsolete +after the fact. + +

+ +Moreover, some commands are more specifically related to obsolete +entry processing. + +

`-a number´ +
o: -
`--alignment=number´ + +Find the next obsolete entry (po-next-obsolete-entry). + +
O: - - -Align strings to number bytes (default: 1). + +Find the previous obsolete entry (po-previous-obsolete-entry). -
`--no-hash´ +
DEL: - -Don't include a hash table in the binary file. Lookup will be more expensive -at run time (binary search instead of hash table lookup). + +Make an active entry obsolete, or zap out an obsolete entry +(po-fade-out-entry).

+ + + + +The commands o (po-next-obsolete-entry) and O +(po-previous-obsolete-entry) move forwards or backwards, +chasing for an obsolete entry. If none is found, the search is +extended and wraps around in the PO file buffer. +

+PO mode does not provide ways for un-commenting an obsolete entry +and making it active, because this would reintroduce an original +untranslated string which does not correspond to any marked string +in the program sources. This goes with the philosophy of never +introducing useless msgid values. -

8.1.10 Informative output

+ + + + +However, it is possible to comment out an active entry, so making +it obsolete. GNU gettext utilities will later react to the +disappearance of a translation by using the untranslated string. +The command DEL (po-fade-out-entry) pushes the current entry +a little further towards annihilation. If the entry is active (it is a +translated entry), then it is first made fuzzy. If it is already fuzzy, +then the entry is merely commented out, with confirmation. If the entry +is already obsolete, then it is completely deleted from the PO file. +It is easy to recycle the translation so deleted into some other PO file +entry, usually one which is untranslated. See section 8.3.9 Modifying Translations. + +

+Here is a quite interesting problem to solve for later development of +PO mode, for those nights you are not sleepy. The idea would be that +PO mode might become bright enough, one of these days, to make good +guesses at retrieving the most probable candidate, among all obsolete +entries, for initializing the translation of a newly appeared string. +I think it might be a quite hard problem to do this algorithmically, as +we have to develop good and efficient measures of string similarity. +Right now, PO mode completely lets the decision to the translator, +when the time comes to find the adequate obsolete translation, it +merely tries to provide handy tools for helping her to do so. + +

+ + +

8.3.9 Modifying Translations

+ + + +

+PO mode prevents direct modification of the PO file, by the usual +means Emacs gives for altering a buffer's contents. By doing so, +it pretends helping the translator to avoid little clerical errors +about the overall file format, or the proper quoting of strings, +as those errors would be easily made. Other kinds of errors are +still possible, but some may be caught and diagnosed by the batch +validation process, which the translator may always trigger by the +V command. For all other errors, the translator has to rely on +her own judgment, and also on the linguistic reports submitted to her +by the users of the translated package, having the same mother tongue. + +

+When the time comes to create a translation, correct an error diagnosed +mechanically or reported by a user, the translators have to resort to +using the following commands for modifying the translations. +

`-h´ +
RET: -
`--help´ -: - - -Display this help and exit. + +Interactively edit the translation (po-edit-msgstr). -
`-V´ +
LFD: -
`--version´ +
C-j: - - -Output version information and exit. + + +Reinitialize the translation with the original, untranslated string +(po-msgid-to-msgstr). -
`--statistics´ +
k: - -Print statistics about translations. + +Save the translation on the kill ring, and delete it (po-kill-msgstr). -
`-v´ +
w: -
`--verbose´ + +Save the translation on the kill ring, without deleting it +(po-kill-ring-save-msgstr). + +
y: - - -Increase verbosity level. + +Replace the translation, taking the new from the kill ring +(po-yank-msgstr).

+ + +The command RET (po-edit-msgstr) opens a new Emacs +window meant to edit in a new translation, or to modify an already existing +translation. The new window contains a copy of the translation taken from +the current PO file entry, all ready for edition, expunged of all quoting +marks, fully modifiable and with the complete extent of Emacs modifying +commands. When the translator is done with her modifications, she may use +C-c C-c to close the subedit window with the automatically requoted +results, or C-c C-k to abort her modifications. See section 8.3.11 Details of Sub Edition, +for more information. +

+ + + +The command LFD (po-msgid-to-msgstr) initializes, or +reinitializes the translation with the original string. This command is +normally used when the translator wants to redo a fresh translation of +the original string, disregarding any previous work. -

8.2 Invoking the `msgunfmt` Program

+ +It is possible to arrange so, whenever editing an untranslated +entry, the LFD command be automatically executed. If you set +po-auto-edit-with-msgid to t, the translation gets +initialised with the original string, in case none exists already. +The default value for po-auto-edit-with-msgid is nil. +

- - + +In fact, whether it is best to start a translation with an empty +string, or rather with a copy of the original string, is a matter of +taste or habit. Sometimes, the source language and the +target language are so different that is simply best to start writing +on an empty page. At other times, the source and target languages +are so close that it would be a waste to retype a number of words +already being written in the original string. A translator may also +like having the original string right under her eyes, as she will +progressively overwrite the original text with the translation, even +if this requires some extra editing work to get rid of the original. + +

+ + + + + +The command k (po-kill-msgstr) merely empties the +translation string, so turning the entry into an untranslated +one. But while doing so, its previous contents is put apart in +a special place, known as the kill ring. The command w +(po-kill-ring-save-msgstr) has also the effect of taking a +copy of the translation onto the kill ring, but it otherwise leaves +the entry alone, and does not remove the translation from the +entry. Both commands use exactly the Emacs kill ring, which is shared +between buffers, and which is well known already to Emacs lovers. + +

+The translator may use k or w many times in the course +of her work, as the kill ring may hold several saved translations. +From the kill ring, strings may later be reinserted in various +Emacs buffers. In particular, the kill ring may be used for moving +translation strings between different entries of a single PO file +buffer, or if the translator is handling many such buffers at once, +even between PO files. + +

+To facilitate exchanges with buffers which are not in PO mode, the +translation string put on the kill ring by the k command is fully +unquoted before being saved: external quotes are removed, multi-line +strings are concatenated, and backslash escaped sequences are turned +into their corresponding characters. In the special case of obsolete +entries, the translation is also uncommented prior to saving. + +

+ + +The command y (po-yank-msgstr) completely replaces the +translation of the current entry by a string taken from the kill ring. +Following Emacs terminology, we then say that the replacement +string is yanked into the PO file buffer. +See section `Yanking' in The Emacs Editor. +The first time y is used, the translation receives the value of +the most recent addition to the kill ring. If y is typed once +again, immediately, without intervening keystrokes, the translation +just inserted is taken away and replaced by the second most recent +addition to the kill ring. By repeating y many times in a row, +the translator may travel along the kill ring for saved strings, +until she finds the string she really wanted. + +

+When a string is yanked into a PO file entry, it is fully and +automatically requoted for complying with the format PO files should +have. Further, if the entry is obsolete, PO mode then appropriately +push the inserted string inside comments. Once again, translators +should not burden themselves with quoting considerations besides, of +course, the necessity of the translated string itself respective to +the program using it. + +

+Note that k or w are not the only commands pushing strings +on the kill ring, as almost any PO mode command replacing translation +strings (or the translator comments) automatically saves the old string +on the kill ring. The main exceptions to this general rule are the +yanking commands themselves. + +

+ +To better illustrate the operation of killing and yanking, let's +use an actual example, taken from a common situation. When the +programmer slightly modifies some string right in the program, his +change is later reflected in the PO file by the appearance +of a new untranslated entry for the modified string, and the fact +that the entry translating the original or unmodified string becomes +obsolete. In many cases, the translator might spare herself some work +by retrieving the unmodified translation from the obsolete entry, +then initializing the untranslated entry msgstr field with +this retrieved translation. Once this done, the obsolete entry is +not wanted anymore, and may be safely deleted. + +

+When the translator finds an untranslated entry and suspects that a +slight variant of the translation exists, she immediately uses m +to mark the current entry location, then starts chasing obsolete +entries with o, hoping to find some translation corresponding +to the unmodified string. Once found, she uses the DEL command +for deleting the obsolete entry, knowing that DEL also kills +the translation, that is, pushes the translation on the kill ring. +Then, r returns to the initial untranslated entry, and y +then yanks the saved translation right into the msgstr +field. The translator is then free to use RET for fine +tuning the translation contents, and maybe to later use u, +then m again, for going on with the next untranslated string. + +

+When some sequence of keys has to be typed over and over again, the +translator may find it useful to become better acquainted with the Emacs +capability of learning these sequences and playing them back under request. +See section `Keyboard Macros' in The Emacs Editor. + +

-msgunfmt [option] [file]...
-

8.3.10 Modifying Comments

- -The msgunfmt program converts a binary message catalog to a -Uniforum style .po file. + +

+Any translation work done seriously will raise many linguistic +difficulties, for which decisions have to be made, and the choices +further documented. These documents may be saved within the +PO file in form of translator comments, which the translator +is free to create, delete, or modify at will. These comments may +be useful to herself when she returns to this PO file after a while. +

+Comments not having whitespace after the initial `#´, for example, +those beginning with `#.´ or `#:´, are not translator +comments, they are exclusively created by other gettext tools. +So, the commands below will never alter such system added comments, +they are not meant for the translator to modify. See section 3 The Format of PO Files. -

8.2.1 Operation mode

+The following commands are somewhat similar to those modifying translations, +so the general indications given for those apply here. See section 8.3.9 Modifying Translations. +

`-j´ -: -
`--java´ +
#: - - - -Java mode: input is a Java ResourceBundle class. + +Interactively edit the translator comments (po-edit-comment). -
`--csharp´ +
K: - - -C# mode: input is a .NET .dll file containing a subclass of -GettextResourceSet. + +Save the translator comments on the kill ring, and delete it +(po-kill-comment). -
`--csharp-resources´ +
W: - - -C# resources mode: input is a .NET `.resources´ file. + +Save the translator comments on the kill ring, without deleting it +(po-kill-ring-save-comment). -
`--tcl´ +
Y: - - -Tcl mode: input is a tcl/msgcat `.msg´ file. + +Replace the translator comments, taking the new from the kill ring +(po-yank-comment).

+These commands parallel PO mode commands for modifying the translation +strings, and behave much the same way as they do, except that they handle +this part of PO file comments meant for translator usage, rather +than the translation strings. So, if the descriptions given below are +slightly succinct, it is because the full details have already been given. +See section 8.3.9 Modifying Translations. +

+ + +The command # (po-edit-comment) opens a new Emacs window +containing a copy of the translator comments on the current PO file entry. +If there are no such comments, PO mode understands that the translator wants +to add a comment to the entry, and she is presented with an empty screen. +Comment marks (#) and the space following them are automatically +removed before edition, and reinstated after. For translator comments +pertaining to obsolete entries, the uncommenting and recommenting operations +are done twice. Once in the editing window, the keys C-c C-c +allow the translator to tell she is finished with editing the comment. +See section 8.3.11 Details of Sub Edition, for further details. -

8.2.2 Input file location

- -

+ +Functions found on po-subedit-mode-hook, if any, are executed after +the string has been inserted in the edit buffer. -

`file ...´ -

-Input .mo files. +

+ + + + + + +The command K (po-kill-comment) gets rid of all +translator comments, while saving those comments on the kill ring. +The command W (po-kill-ring-save-comment) takes +a copy of the translator comments on the kill ring, but leaves +them undisturbed in the current entry. The command Y +(po-yank-comment) completely replaces the translator comments +by a string taken at the front of the kill ring. When this command +is immediately repeated, the comments just inserted are withdrawn, +and replaced by other strings taken along the kill ring. -

+On the kill ring, all strings have the same nature. There is no +distinction between translation strings and translator +comments strings. So, for example, let's presume the translator +has just finished editing a translation, and wants to create a new +translator comment to document why the previous translation was +not good, just to remember what was the problem. Foreseeing that she +will do that in her documentation, the translator may want to quote +the previous translation in her translator comments. To do so, she +may initialize the translator comments with the previous translation, +still at the head of the kill ring. Because editing already pushed the +previous translation on the kill ring, she merely has to type M-w +prior to #, and the previous translation will be right there, +all ready for being introduced by some explanatory text. +

-If no input file is given or if it is `-´, standard input is read. +On the other hand, presume there are some translator comments already +and that the translator wants to add to those comments, instead +of wholly replacing them. Then, she should edit the comment right +away with #. Once inside the editing window, she can use the +regular Emacs commands C-y (yank) and M-y +(yank-pop) to get the previous translation where she likes.

8.2.3 Input file location in Java mode

8.3.11 Details of Sub Edition

+ + +

+The PO subedit minor mode has a few peculiarities worth being described +in fuller detail. It installs a few commands over the usual editing set +of Emacs, which are described below. +

`-r resource´ -: -
`--resource=resource´ +
C-c C-c: - - -Specify the resource name. + +Complete edition (po-subedit-exit). -
`-l locale´ +
C-c C-k: -
`--locale=locale´ + +Abort edition (po-subedit-abort). + +
C-c C-a: - - -Specify the locale name, either a language specification of the form ll -or a combined language and country specification of the form ll_CC. + +Consult auxiliary PO files (po-subedit-cycle-auxiliary).

-The class name is determined by appending the locale name to the resource name, -separated with an underscore. The class is located using the CLASSPATH. + + + +The window's contents represents a translation for a given message, +or a translator comment. The translator may modify this window to +her heart's content. Once this is done, the command C-c C-c +(po-subedit-exit) may be used to return the edited translation into +the PO file, replacing the original translation, even if it moved out of +sight or if buffers were switched.

+ + +If the translator becomes unsatisfied with her translation or comment, +to the extent she prefers keeping what was existent prior to the +RET or # command, she may use the command C-c C-k +(po-subedit-abort) to merely get rid of edition, while preserving +the original translation or comment. Another way would be for her to exit +normally with C-c C-c, then type U once for undoing the +whole effect of last edition. +

+ + +The command C-c C-a (po-subedit-cycle-auxiliary) +allows for glancing through translations +already achieved in other languages, directly while editing the current +translation. This may be quite convenient when the translator is fluent +at many languages, but of course, only makes sense when such completed +auxiliary PO files are already available to her (see section 8.3.13 Consulting Auxiliary PO Files). -

8.2.4 Input file location in C# mode

+Functions found on po-subedit-mode-hook, if any, are executed after +the string has been inserted in the edit buffer. -

+While editing her translation, the translator should pay attention to not +inserting unwanted RET (newline) characters at the end of +the translated string if those are not meant to be there, or to removing +such characters when they are required. Since these characters are not +visible in the editing buffer, they are easily introduced by mistake. +To help her, RET automatically puts the character < +at the end of the string being edited, but this < is not really +part of the string. On exiting the editing window with C-c C-c, +PO mode automatically removes such < and all whitespace added after +it. If the translator adds characters after the terminating <, it +looses its delimiting property and integrally becomes part of the string. +If she removes the delimiting <, then the edited string is taken +as is, with all trailing newlines, even if invisible. Also, if +the translated string ought to end itself with a genuine <, then +the delimiting < may not be removed; so the string should appear, +in the editing window, as ending with two < in a row. -

`-r resource´ -

`--resource=resource´ -

- - -Specify the resource name. +

+ +When a translation (or a comment) is being edited, the translator may move +the cursor back into the PO file buffer and freely move to other entries, +browsing at will. If, with an edition pending, the translator wanders in the +PO file buffer, she may decide to start modifying another entry. Each entry +being edited has its own subedit buffer. It is possible to simultaneously +edit the translation and the comment of a single entry, or to +edit entries in different PO files, all at once. Typing RET +on a field already being edited merely resumes that particular edit. Yet, +the translator should better be comfortable at handling many Emacs windows! -

`-l locale´ -

`--locale=locale´ -

- - -Specify the locale name, either a language specification of the form ll -or a combined language and country specification of the form ll_CC. +

+ +Pending subedits may be completed or aborted in any order, regardless +of how or when they were started. When many subedits are pending and the +translator asks for quitting the PO file (with the q command), subedits +are automatically resumed one at a time, so she may decide for each of them. -

`-d directory´ -

- -Specify the base directory for locale dependent `.dll´ files. +

8.3.12 C Sources Context

-The `-l´ and `-d´ options are mandatory. The `.msg´ file is -located in a subdirectory of the specified directory whose name depends on the -locale. + + +

+PO mode is particularly powerful when used with PO files +created through GNU gettext utilities, as those utilities +insert special comments in the PO files they generate. +Some of these special comments relate the PO file entry to +exactly where the untranslated string appears in the program sources. +

+When the translator gets to an untranslated entry, she is fairly +often faced with an original string which is not as informative as +it normally should be, being succinct, cryptic, or otherwise ambiguous. +Before choosing how to translate the string, she needs to understand +better what the string really means and how tight the translation has +to be. Most of the time, when problems arise, the only way left to make +her judgment is looking at the true program sources from where this +string originated, searching for surrounding comments the programmer +might have put in there, and looking around for helping clues of +any kind. + +

+Surely, when looking at program sources, the translator will receive +more help if she is a fluent programmer. However, even if she is +not versed in programming and feels a little lost in C code, the +translator should not be shy at taking a look, once in a while. +It is most probable that she will still be able to find some of the +hints she needs. She will learn quickly to not feel uncomfortable +in program code, paying more attention to programmer's comments, +variable and function names (if he dared choosing them well), and +overall organization, than to the program code itself. -

8.2.5 Input file location in Tcl mode

+ +The following commands are meant to help the translator at getting +program source context for a PO file entry. +

`-l locale´ +
s +: + +Resume the display of a program source context, or cycle through them +(po-cycle-source-reference). + +
M-s: -
`--locale=locale´ + +Display of a program source context selected by menu +(po-select-source-reference). + +
S: - - -Specify the locale name, either a language specification of the form ll -or a combined language and country specification of the form ll_CC. + +Add a directory to the search path for source files +(po-consider-source-path). -
`-d directory´ +
M-S: - -Specify the base directory of `.msg´ message catalogs. + +Delete a directory from the search path for source files +(po-ignore-source-path).

-The `-l´ and `-d´ options are mandatory. The `.msg´ file is -located in the specified directory. + + + + +The commands s (po-cycle-source-reference) and M-s +(po-select-source-reference) both open another window displaying +some source program file, and already positioned in such a way that +it shows an actual use of the string to be translated. By doing +so, the command gives source program context for the string. But if +the entry has no source context references, or if all references +are unresolved along the search path for program sources, then the +command diagnoses this as an error.

+Even if s (or M-s) opens a new window, the cursor stays +in the PO file window. If the translator really wants to +get into the program source window, she ought to do it explicitly, +maybe by using command O. +

+When s is typed for the first time, or for a PO file entry which +is different of the last one used for getting source context, then the +command reacts by giving the first context available for this entry, +if any. If some context has already been recently displayed for the +current PO file entry, and the translator wandered off to do other +things, typing s again will merely resume, in another window, +the context last displayed. In particular, if the translator moved +the cursor away from the context in the source file, the command will +bring the cursor back to the context. By using s many times +in a row, with no other commands intervening, PO mode will cycle to +the next available contexts for this particular entry, getting back +to the first context once the last has been shown. -

8.2.6 Output file location

+The command M-s behaves differently. Instead of cycling through +references, it lets the translator choose a particular reference among +many, and displays that reference. It is best used with completion, +if the translator types TAB immediately after M-s, in +response to the question, she will be offered a menu of all possible +references, as a reminder of which are the acceptable answers. +This command is useful only where there are really many contexts +available for a single string to translate. -

`-o file´ -: -
`--output-file=file´ -: - - -Write output to specified file. +
-

8.3.13 Consulting Auxiliary PO Files

-The results are written to standard output if no output file is specified -or if it is `-´. +

+PO mode is able to help the knowledgeable translator, being fluent in +many languages, at taking advantage of translations already achieved +in other languages she just happens to know. It provides these other +language translations as additional context for her own work. Moreover, +it has features to ease the production of translations for many languages +at once, for translators preferring to work in this way. +

+ + +An auxiliary PO file is an existing PO file meant for the same +package the translator is working on, but targeted to a different mother +tongue language. Commands exist for declaring and handling auxiliary +PO files, and also for showing contexts for the entry under work. -

8.2.7 Output details

+Here are the auxiliary file commands available in PO mode. +

`--force-po´ +
a: - -Always write an output file even if it contains no message. + +Seek auxiliary files for another translation for the same entry +(po-cycle-auxiliary). -
`-i´ -: -
`--indent´ +
C-c C-a: - - -Write the .po file using indented style. + +Switch to a particular auxiliary file (po-select-auxiliary). -
`--strict´ +
A: - -Write out a strict Uniforum conforming PO file. Note that this -Uniforum format should be avoided because it doesn't support the -GNU extensions. + +Declare this PO file as an auxiliary file (po-consider-as-auxiliary). -
`-p´ +
M-A: -
`--properties-output´ -: - - -Write out a Java ResourceBundle in Java .properties syntax. Note -that this file format doesn't support plural forms and silently drops -obsolete messages. + +Remove this PO file from the list of auxiliary files +(po-ignore-as-auxiliary). -
`--stringtable-output´ -: - -Write out a NeXTstep/GNUstep localized resource file in .strings syntax. -Note that this file format doesn't support plural forms. +

`-w number´ -

`--width=number´ -

+ + + + +Command A (po-consider-as-auxiliary) adds the current +PO file to the list of auxiliary files, while command M-A +(po-ignore-as-auxiliary just removes it. -

`--no-wrap´ -

+ + +The command a (po-cycle-auxiliary) seeks all auxiliary PO +files, round-robin, searching for a translated entry in some other language +having an msgid field identical as the one for the current entry. +The found PO file, if any, takes the place of the current PO file in +the display (its window gets on top). Before doing so, the current PO +file is also made into an auxiliary file, if not already. So, a +in this newly displayed PO file will seek another PO file, and so on, +so repeating a will eventually yield back the original PO file. -

`-s´ -

`--sort-output´ -

- - - -Generate sorted output. Note that using this option makes it much harder -for the translator to understand each message's context. +

+ + +The command C-c C-a (po-select-auxiliary) asks the translator +for her choice of a particular auxiliary file, with completion, and +then switches to that selected PO file. The command also checks if +the selected file has an msgid field identical as the one for +the current entry, and if yes, this entry becomes current. Otherwise, +the cursor of the selected file is left undisturbed. -

+For all this to work fully, auxiliary PO files will have to be normalized, +in that way that msgid fields should be written exactly +the same way. It is possible to write msgid fields in various +ways for representing the same string, different writing would break the +proper behaviour of the auxiliary file commands of PO mode. This is not +expected to be much a problem in practice, as most existing PO files have +their msgid entries written by the same GNU gettext tools. +

+ +However, PO files initially created by PO mode itself, while marking +strings in source files, are normalised differently. So are PO +files resulting of the the `M-x normalize´ command. Until these +discrepancies between PO mode and other GNU gettext tools get +fully resolved, the translator should stay aware of normalisation issues. +

8.2.8 Informative output

8.3.14 Using Translation Compendia

+ -

`-h´ -

`--help´ -

- - -Display this help and exit. +

+ +A compendium is a special PO file containing a set of +translations recurring in many different packages. The translator can +use gettext tools to build a new compendium, to add entries to her +compendium, and to initialize untranslated entries, or to update +already translated entries, from translations kept in the compendium. -

`-V´ -

`--version´ -

- - -Output version information and exit. +

`-v´ -

`--verbose´ -

- - -Increase verbosity level. -

8.3.14.1 Creating Compendia

+ + + +

+Basically every PO file consisting of translated entries only can be +declared as a valid compendium. Often the translator wants to have +special compendia; let's consider two cases: concatenating PO +files and extracting a message subset from a PO file. +

+ + +

8.3.14.2 Concatenate PO Files

8.3 The Format of GNU MO Files

- - + + +To concatenate several valid PO files into one compendium file you can +use `msgcomm´ or `msgcat´ (the latter preferred):

+ +

+msgcat -o compendium.po file1.po file2.po
+

-The format of the generated MO files is best described by a picture, -which appears below. +By default, msgcat will accumulate divergent translations +for the same string. Those occurences will be marked as fuzzy +and highly visible decorated; calling msgcat on +`file1.po´:

+ +

+#: src/hello.c:200
+#, c-format
+msgid "Report bugs to <%s>.\n"
+msgstr "Comunicar `bugs' a <%s>.\n"
+

- -The first two words serve the identification of the file. The magic -number will always signal GNU MO files. The number is stored in the -byte order of the generating machine, so the magic number really is -two numbers: 0x950412de and 0xde120495. The second -word describes the current revision of the file format. For now the -revision is 0. This might change in future versions, and ensures -that the readers of MO files can distinguish new formats from old -ones, so that both can be handled correctly. The version is kept -separate from the magic number, instead of using different magic -numbers for different formats, mainly because `/etc/magic´ is -not updated often. It might be better to have magic separated from -internal format version identification. +and `file2.po´:

+ +

+#: src/bye.c:100
+#, c-format
+msgid "Report bugs to <%s>.\n"
+msgstr "Comunicar \"bugs\" a <%s>.\n"
+

-Follow a number of pointers to later tables in the file, allowing -for the extension of the prefix part of MO files without having to -recompile programs reading them. This might become useful for later -inserting a few flag bits, indication about the charset used, new -tables, or other things. +will result in:

+ +

+#: src/hello.c:200 src/bye.c:100
+#, fuzzy, c-format
+msgid "Report bugs to <%s>.\n"
+msgstr ""
+"#-#-#-#-#  file1.po  #-#-#-#-#\n"
+"Comunicar `bugs' a <%s>.\n"
+"#-#-#-#-#  file2.po  #-#-#-#-#\n"
+"Comunicar \"bugs\" a <%s>.\n"
+

-Then, at offset O and offset T in the picture, two tables -of string descriptors can be found. In both tables, each string -descriptor uses two 32 bits integers, one for the string length, -another for the offset of the string in the MO file, counting in bytes -from the start of the file. The first table contains descriptors -for the original strings, and is sorted so the original strings -are in increasing lexicographical order. The second table contains -descriptors for the translated strings, and is parallel to the first -table: to find the corresponding translation one has to access the -array slot in the second array with the same index. +The translator will have to resolve this "conflict" manually; she +has to decide whether the first or the second version is appropriate +(or provide a new translation), to delete the "marker lines", and +finally to remove the fuzzy mark.

-Having the original strings sorted enables the use of simple binary -search, for when the MO file does not contain an hashing table, or -for when it is not practical to use the hashing table provided in -the MO file. This also has another advantage, as the empty string -in a PO file GNU gettext is usually translated into -some system information attached to that particular MO file, and the -empty string necessarily becomes the first in both the original and -translated tables, making the system information very easy to find. +If the translator knows in advance the first found translation of a +message is always the best translation she can make use to the +`--use-first´ switch:

+ +

+msgcat --use-first -o compendium.po file1.po file2.po
+

- -The size S of the hash table can be zero. In this case, the -hash table itself is not contained in the MO file. Some people might -prefer this because a precomputed hashing table takes disk space, and -does not win that much speed. The hash table contains indices -to the sorted array of strings in the MO file. Conflict resolution is -done by double hashing. The precise hashing algorithm used is fairly -dependent on GNU gettext code, and is not documented here. +A good compendium file must not contain fuzzy or untranslated +entries. If input files are "dirty" you must preprocess the input +files or postprocess the result using `msgattrib --translated --no-fuzzy´.

+ + +

8.3.14.3 Extract a Message Subset from a PO File

-As for the strings themselves, they follow the hash file, and each -is terminated with a NUL, and this NUL is not counted in -the length which appears in the string descriptor. The msgfmt -program has an option selecting the alignment for MO file strings. -With this option, each string is separately aligned so it starts at -an offset which is a multiple of the alignment value. On some RISC -machines, a correct alignment will speed things up. +

- -Plural forms are stored by letting the plural of the original string -follow the singular of the original string, separated through a -NUL byte. The length which appears in the string descriptor -includes both. However, only the singular of the original string -takes part in the hash table lookup. The plural variants of the -translation are all stored consecutively, separated through a -NUL byte. Here also, the length in the string descriptor -includes all of them. +Nobody wants to translate the same messages again and again; thus you +may wish to have a compendium file containing `getopt.c´ messages.

-Nothing prevents a MO file from having embedded NULs in strings. -However, the program interface currently used already presumes -that strings are NUL terminated, so embedded NULs are -somewhat useless. But the MO file format is general enough so other -interfaces would be later possible, if for example, we ever want to -implement wide characters right in MO files, where NUL bytes may -accidently appear. (No, we don't want to have wide characters in MO -files. They would make the file unnecessarily large, and the -`wchar_t´ type being platform dependent, MO files would be -platform dependent as well.) +To extract a message subset (e.g., all `getopt.c´ messages) from an +existing PO file into one compendium file you can use `msggrep´: + +

+ +

+msggrep --location src/getopt.c -o compendium.po file.po
+

+ + + +

8.3.14.4 Using Compendia

+ +

+You can use a compendium file to initialize a translation from scratch +or to update an already existing translation. + +

+ + +

8.3.14.5 Initialize a New Translation File

+ + +

+Since a PO file with translations does not exist the translator can +merely use `/dev/null´ to fake the "old" translation file. + +

+ +

+msgmerge --compendium compendium.po -o file.po /dev/null file.pot
+

+ + + +

8.3.14.6 Update an Existing Translation File

-This particular issue has been strongly debated in the GNU -gettext development forum, and it is expectable that MO file -format will evolve or change over time. It is even possible that many -formats may later be supported concurrently. But surely, we have to -start somewhere, and the MO file format described here is a good start. -Nothing is cast in concrete, and the format may later evolve fairly -easily, so we should feel comfortable with the current approach. +Concatenate the compendium file(s) and the existing PO, merge the +result with the POT file and remove the obsolete entries (optional, +here done using `sed´):

-        byte
-             +------------------------------------------+
-          0  | magic number = 0x950412de                |
-             |                                          |
-          4  | file format revision = 0                 |
-             |                                          |
-          8  | number of strings                        |  == N
-             |                                          |
-         12  | offset of table with original strings    |  == O
-             |                                          |
-         16  | offset of table with translation strings |  == T
-             |                                          |
-         20  | size of hashing table                    |  == S
-             |                                          |
-         24  | offset of hashing table                  |  == H
-             |                                          |
-             .                                          .
-             .    (possibly more entries later)         .
-             .                                          .
-             |                                          |
-          O  | length & offset 0th string  ----------------.
-      O + 8  | length & offset 1st string  ------------------.
-              ...                                    ...   | |
-O + ((N-1)*8)| length & offset (N-1)th string           |  | |
-             |                                          |  | |
-          T  | length & offset 0th translation  ---------------.
-      T + 8  | length & offset 1st translation  -----------------.
-              ...                                    ...   | | | |
-T + ((N-1)*8)| length & offset (N-1)th translation      |  | | | |
-             |                                          |  | | | |
-          H  | start hash table                         |  | | | |
-              ...                                    ...   | | | |
-  H + S * 4  | end hash table                           |  | | | |
-             |                                          |  | | | |
-             | NUL terminated 0th string  <----------------' | | |
-             |                                          |    | | |
-             | NUL terminated 1st string  <------------------' | |
-             |                                          |      | |
-              ...                                    ...       | |
-             |                                          |      | |
-             | NUL terminated 0th translation  <---------------' |
-             |                                          |        |
-             | NUL terminated 1st translation  <-----------------'
-             |                                          |
-              ...                                    ...
-             |                                          |
-             +------------------------------------------+
+msgcat --use-first -o update.po compendium1.po compendium2.po file.po
+msgmerge update.po file.pot | sed -e '/^#~/d' > file.po

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents. diff --git a/gettext-tools/doc/gettext_9.html b/gettext-tools/doc/gettext_9.html index 8ebac2f2a..e88fe4a37 100644 --- a/gettext-tools/doc/gettext_9.html +++ b/gettext-tools/doc/gettext_9.html @@ -1,135 +1,2653 @@ + from gettext.texi on 21 July 2005 --> -GNU gettext utilities - 9 The User's View +GNU gettext utilities - 9 Manipulating PO Files -Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.

9 The User's View

9 Manipulating PO Files

+ + +

+Sometimes it is necessary to manipulate PO files in a way that is better +performed automatically than by hand. GNU gettext includes a +complete set of tools for this purpose. + +

+ +When merging two packages into a single package, the resulting POT file +will be the concatenation of the two packages' POT files. Thus the +maintainer must concatenate the two existing package translations into +a single translation catalog, for each language. This is best performed +using `msgcat´. It is then the translators' duty to deal with any +possible conflicts that arose during the merge. + +

+ +When a translator takes over the translation job from another translator, +but she uses a different character encoding in her locale, she will +convert the catalog to her character encoding. This is best done through +the `msgconv´ program. + +

+When a maintainer takes a source file with tagged messages from another +package, he should also take the existing translations for this source +file (and not let the translators do the same job twice). One way to do +this is through `msggrep´, another is to create a POT file for +that source file and use `msgmerge´. + +

+ + +When a translator wants to adjust some translation catalog for a special +dialect or orthography -- for example, German as written in Switzerland +versus German as written in Germany -- she needs to apply some text +processing to every message in the catalog. The tool for doing this is +`msgfilter´. + +

+Another use of msgfilter is to produce approximately the POT file for +which a given PO file was made. This can be done through a filter command +like `msgfilter sed -e d | sed -e '/^# /d'´. Note that the original +POT file may have had different comments and different plural message counts, +that's why it's better to use the original POT file if available. + +

+ +When a translator wants to check her translations, for example according +to orthography rules or using a non-interactive spell checker, she can do +so using the `msgexec´ program. + +

+ +When third party tools create PO or POT files, sometimes duplicates cannot +be avoided. But the GNU gettext tools give an error when they +encounter duplicate msgids in the same file and in the same domain. +To merge duplicates, the `msguniq´ program can be used. + +

+`msgcomm´ is a more general tool for keeping or throwing away +duplicates, occurring in different files. + +

+`msgcmp´ can be used to check whether a translation catalog is +completely translated. + +

+ +`msgattrib´ can be used to select and extract only the fuzzy +or untranslated messages of a translation catalog. + +

+`msgen´ is useful as a first step for preparing English translation +catalogs. It copies each message's msgid to its msgstr. + +

+Finally, for those applications where all these various programs are not +sufficient, a library `libgettextpo´ is provided that can be used to +write other specialized programs that process PO files. + +

+ + + +

9.1 Invoking the `msgcat` Program

+ +

+ + + +

+msgcat [option] [inputfile]...
+

+ +

+ + +The msgcat program concatenates and merges the specified PO files. +It finds messages which are common to two or more of the specified PO files. +By using the --more-than option, greater commonality may be requested +before messages are printed. Conversely, the --less-than option may be +used to specify less commonality before messages are printed (i.e. +`--less-than=2´ will only print the unique messages). Translations, +comments and extract comments will be cumulated, except that if +--use-first is specified, they will be taken from the first PO file +to define them. File positions from all PO files will be cumulated. + +

+ + +

9.1.1 Input file location

+ +

`inputfile ...´ +: +Input files. + +
`-f file´ +: +
`--files-from=file´ +: + + +Read the names of the input files from file instead of getting +them from the command line. + +
`-D directory´ +: +
`--directory=directory´ +: + + +Add directory to the list of directories. Source files are +searched relative to this list of directories. The resulting `.po´ +file will be written relative to the current directory, though. + +

+ +

+If inputfile is `-´, standard input is read. + +

+ + +

9.1.2 Output file location

+ +

`-o file´ +: +
`--output-file=file´ +: + + +Write output to specified file. + +

+ +

+ +The results are written to standard output if no output file is specified +or if it is `-´. + +

+ + +

9.1.3 Message selection

+ +

`-< number´ +: +
`--less-than=number´ +: + + +Print messages with less than number definitions, defaults to infinite +if not set. + +
`-> number´ +: +
`--more-than=number´ +: + + +Print messages with more than number definitions, defaults to 0 if not +set. + +
`-u´ +: +
`--unique´ +: + + +Shorthand for `--less-than=2´. Requests that only unique messages be +printed. + +

+ + + +

9.1.4 Input file syntax

+ +

`-P´ +: +
`--properties-input´ +: + + +Assume the input files are Java ResourceBundles in Java .properties +syntax, not in PO file syntax. + +
`--stringtable-input´ +: + +Assume the input files are NeXTstep/GNUstep localized resource files in +.strings syntax, not in PO file syntax. + +

+ + + +

9.1.5 Output details

+ +

`-t´ +: +
`--to-code=name´ +: + + +Specify encoding for output. + +
`--use-first´ +: + +Use first available translation for each message. Don't merge several +translations into one. + +
`--force-po´ +: + +Always write an output file even if it contains no message. + +
`-i´ +: +
`--indent´ +: + + +Write the .po file using indented style. + +
`--no-location´ +: + +Do not write `#: filename:line´ lines. + +
`-n´ +: +
`--add-location´ +: + + +Generate `#: filename:line´ lines (default). + +
`--strict´ +: + +Write out a strict Uniforum conforming PO file. Note that this +Uniforum format should be avoided because it doesn't support the +GNU extensions. + +
`-p´ +: +
`--properties-output´ +: + + +Write out a Java ResourceBundle in Java .properties syntax. Note +that this file format doesn't support plural forms and silently drops +obsolete messages. + +
`--stringtable-output´ +: + +Write out a NeXTstep/GNUstep localized resource file in .strings syntax. +Note that this file format doesn't support plural forms. + +
`-w number´ +: +
`--width=number´ +: + + +Set the output page width. Long strings in the output files will be +split across multiple lines in order to ensure that each line's width +(= number of screen columns) is less or equal to the given number. + +
`--no-wrap´ +: + +Do not break long message lines. Message lines whose width exceeds the +output page width will not be split into several lines. Only file reference +lines which are wider than the output page width will be split. + +
`-s´ +: +
`--sort-output´ +: + + + +Generate sorted output. Note that using this option makes it much harder +for the translator to understand each message's context. + +
`-F´ +: +
`--sort-by-file´ +: + + +Sort output by file location. + +

+ + + +

9.1.6 Informative output

+ +

`-h´ +: +
`--help´ +: + + +Display this help and exit. + +
`-V´ +: +
`--version´ +: + + +Output version information and exit. + +

+ + + +

9.2 Invoking the `msgconv` Program

+ +

+ + + +

+msgconv [option] [inputfile]
+

+ +

+ +The msgconv program converts a translation catalog to a different +character encoding. + +

+ + +

9.2.1 Input file location

+ +

`inputfile´ +: +Input PO file. + +
`-D directory´ +: +
`--directory=directory´ +: + + +Add directory to the list of directories. Source files are +searched relative to this list of directories. The resulting `.po´ +file will be written relative to the current directory, though. + +

+ +

+If no inputfile is given or if it is `-´, standard input is read. + +

+ + +

9.2.2 Output file location

+ +

`-o file´ +: +
`--output-file=file´ +: + + +Write output to specified file. + +

+ +

+The results are written to standard output if no output file is specified +or if it is `-´. + +

+ + +

9.2.3 Conversion target

+ +

`-t´ +: +
`--to-code=name´ +: + + +Specify encoding for output. + +

+ +

+The default encoding is the current locale's encoding. + +

+ + +

9.2.4 Input file syntax

+ +

`-P´ +: +
`--properties-input´ +: + + +Assume the input file is a Java ResourceBundle in Java .properties +syntax, not in PO file syntax. + +
`--stringtable-input´ +: + +Assume the input file is a NeXTstep/GNUstep localized resource file in +.strings syntax, not in PO file syntax. + +

+ + + +

9.2.5 Output details

+ +

`--force-po´ +: + +Always write an output file even if it contains no message. + +
`-i´ +: +
`--indent´ +: + + +Write the .po file using indented style. + +
`--no-location´ +: + +Do not write `#: filename:line´ lines. + +
`--add-location´ +: + +Generate `#: filename:line´ lines (default). + +
`--strict´ +: + +Write out a strict Uniforum conforming PO file. Note that this +Uniforum format should be avoided because it doesn't support the +GNU extensions. + +
`-p´ +: +
`--properties-output´ +: + + +Write out a Java ResourceBundle in Java .properties syntax. Note +that this file format doesn't support plural forms and silently drops +obsolete messages. + +
`--stringtable-output´ +: + +Write out a NeXTstep/GNUstep localized resource file in .strings syntax. +Note that this file format doesn't support plural forms. + +
`-w number´ +: +
`--width=number´ +: + + +Set the output page width. Long strings in the output files will be +split across multiple lines in order to ensure that each line's width +(= number of screen columns) is less or equal to the given number. + +
`--no-wrap´ +: + +Do not break long message lines. Message lines whose width exceeds the +output page width will not be split into several lines. Only file reference +lines which are wider than the output page width will be split. + +
`-s´ +: +
`--sort-output´ +: + + +Generate sorted output. Note that using this option makes it much harder +for the translator to understand each message's context. + +
`-F´ +: +
`--sort-by-file´ +: + + +Sort output by file location. + +

+ + + +

9.2.6 Informative output

+ +

`-h´ +: +
`--help´ +: + + +Display this help and exit. + +
`-V´ +: +
`--version´ +: + + +Output version information and exit. + +

+ + + +

9.3 Invoking the `msggrep` Program

+ +

+ + + +

+msggrep [option] [inputfile]
+

+ +

+ +The msggrep program extracts all messages of a translation catalog +that match a given pattern or belong to some given source files. + +

+ + +

9.3.1 Input file location

+ +

`inputfile´ +: +Input PO file. + +
`-D directory´ +: +
`--directory=directory´ +: + + +Add directory to the list of directories. Source files are +searched relative to this list of directories. The resulting `.po´ +file will be written relative to the current directory, though. + +

+ +

+If no inputfile is given or if it is `-´, standard input is read. + +

+ + +

9.3.2 Output file location

+ +

`-o file´ +: +
`--output-file=file´ +: + + +Write output to specified file. + +

+ +

+The results are written to standard output if no output file is specified +or if it is `-´. + +

+ + +

9.3.3 Message selection

+ + +

+  [-N sourcefile]... [-M domainname]...
+  [-K msgid-pattern] [-T msgstr-pattern] [-C comment-pattern]
+

+ +

+A message is selected if + +

it comes from one of the specified source files, + +
or if it comes from one of the specified domains, + +
or if `-K´ is given and its key (msgid or msgid_plural) matches + + msgid-pattern, +
or if `-T´ is given and its translation (msgstr) matches + + msgstr-pattern, +
or if `-C´ is given and the translator's comment matches + + comment-pattern. +

+ +

+When more than one selection criterion is specified, the set of selected +messages is the union of the selected messages of each criterion. + +

+msgid-pattern or msgstr-pattern syntax: + +

+  [-E | -F] [-e pattern | -f file]...
+

+ +

+patterns are basic regular expressions by default, or extended regular +expressions if -E is given, or fixed strings if -F is given. + +

`-N sourcefile´ +: +
`--location=sourcefile´ +: + + +Select messages extracted from sourcefile. sourcefile can be +either a literal file name or a wildcard pattern. + +
`-M domainname´ +: +
`--domain=domainname´ +: + + +Select messages belonging to domain domainname. + +
`-K´ +: +
`--msgid´ +: + + +Start of patterns for the msgid. + +
`-T´ +: +
`--msgstr´ +: + + +Start of patterns for the msgstr. + +
`-C´ +: +
`--comment´ +: + + +Start of patterns for the translator's comment. + +
`-E´ +: +
`--extended-regexp´ +: + + +Specify that pattern is an extended regular expression. + +
`-F´ +: +
`--fixed-strings´ +: + + +Specify that pattern is a set of newline-separated strings. + +
`-e pattern´ +: +
`--regexp=pattern´ +: + + +Use pattern as a regular expression. + +
`-f file´ +: +
`--file=file´ +: + + +Obtain pattern from file. + +
`-i´ +: +
`--ignore-case´ +: + + +Ignore case distinctions. + +

+ + + +

9.3.4 Input file syntax

+ +

`-P´ +: +
`--properties-input´ +: + + +Assume the input file is a Java ResourceBundle in Java .properties +syntax, not in PO file syntax. + +
`--stringtable-input´ +: + +Assume the input file is a NeXTstep/GNUstep localized resource file in +.strings syntax, not in PO file syntax. + +

+ + + +

9.3.5 Output details

+ +

`--force-po´ +: + +Always write an output file even if it contains no message. + +
`--indent´ +: + +Write the .po file using indented style. + +
`--no-location´ +: + +Do not write `#: filename:line´ lines. + +
`--add-location´ +: + +Generate `#: filename:line´ lines (default). + +
`--strict´ +: + +Write out a strict Uniforum conforming PO file. Note that this +Uniforum format should be avoided because it doesn't support the +GNU extensions. + +
`-p´ +: +
`--properties-output´ +: + + +Write out a Java ResourceBundle in Java .properties syntax. Note +that this file format doesn't support plural forms and silently drops +obsolete messages. + +
`--stringtable-output´ +: + +Write out a NeXTstep/GNUstep localized resource file in .strings syntax. +Note that this file format doesn't support plural forms. + +
`-w number´ +: +
`--width=number´ +: + + +Set the output page width. Long strings in the output files will be +split across multiple lines in order to ensure that each line's width +(= number of screen columns) is less or equal to the given number. + +
`--no-wrap´ +: + +Do not break long message lines. Message lines whose width exceeds the +output page width will not be split into several lines. Only file reference +lines which are wider than the output page width will be split. + +
`--sort-output´ +: + +Generate sorted output. Note that using this option makes it much harder +for the translator to understand each message's context. + +
`--sort-by-file´ +: + +Sort output by file location. + +

+ + + +

9.3.6 Informative output

+ +

`-h´ +: +
`--help´ +: + + +Display this help and exit. + +
`-V´ +: +
`--version´ +: + + +Output version information and exit. + +

+ + + +

9.4 Invoking the `msgfilter` Program

+ +

+ + + +

+msgfilter [option] filter [filter-option]
+

+ +

+ +The msgfilter program applies a filter to all translations of a +translation catalog. + +

+ + +

9.4.1 Input file location

+ +

`-i inputfile´ +: +
`--input=inputfile´ +: + + +Input PO file. + +
`-D directory´ +: +
`--directory=directory´ +: + + +Add directory to the list of directories. Source files are +searched relative to this list of directories. The resulting `.po´ +file will be written relative to the current directory, though. + +

+ +

+If no inputfile is given or if it is `-´, standard input is read. + +

+ + +

9.4.2 Output file location

+ +

`-o file´ +: +
`--output-file=file´ +: + + +Write output to specified file. + +

+ +

+The results are written to standard output if no output file is specified +or if it is `-´. + +

+ + +

9.4.3 The filter

+ +

+The filter can be any program that reads a translation from standard +input and writes a modified translation to standard output. A frequently +used filter is `sed´. + +

+ +Note: It is your responsibility to ensure that the filter can cope +with input encoded in the translation catalog's encoding. If the +filter wants input in a particular encoding, you can in a first step +convert the translation catalog to that encoding using the `msgconv´ +program, before invoking `msgfilter´. If the filter wants input +in the locale's encoding, but you want to avoid the locale's encoding, then +you can first convert the translation catalog to UTF-8 using the +`msgconv´ program and then make `msgfilter´ work in an UTF-8 +locale, by using the LC_ALL environment variable. + +

+ +Note: Most translations in a translation catalog don't end with a newline +character. For this reason, it is important that the filter +recognizes its last input line even if it ends without a newline, and that +it doesn't add an undesired trailing newline at the end. The `sed´ +program on some platforms is known to ignore the last line of input if it +is not terminated with a newline. You can use GNU sed instead; it +does not have this limitation. + +

+ + +

9.4.4 Useful `filter-option`s when the `filter` is `sed´

+ +

`-e script´ +: +
`--expression=script´ +: + + +Add script to the commands to be executed. + +
`-f scriptfile´ +: +
`--file=scriptfile´ +: + + +Add the contents of scriptfile to the commands to be executed. + +
`-n´ +: +
`--quiet´ +: +
`--silent´ +: + + + +Suppress automatic printing of pattern space. + +

+ + + +

9.4.5 Input file syntax

+ +

`-P´ +: +
`--properties-input´ +: + + +Assume the input file is a Java ResourceBundle in Java .properties +syntax, not in PO file syntax. + +
`--stringtable-input´ +: + +Assume the input file is a NeXTstep/GNUstep localized resource file in +.strings syntax, not in PO file syntax. + +

+ + + +

9.4.6 Output details

+ +

`--force-po´ +: + +Always write an output file even if it contains no message. + +
`--indent´ +: + +Write the .po file using indented style. + +
`--keep-header´ +: + +Keep the header entry, i.e. the message with `msgid ""´, unmodified, +instead of filtering it. By default, the header entry is subject to +filtering like any other message. + +
`--no-location´ +: + +Do not write `#: filename:line´ lines. + +
`--add-location´ +: + +Generate `#: filename:line´ lines (default). + +
`--strict´ +: + +Write out a strict Uniforum conforming PO file. Note that this +Uniforum format should be avoided because it doesn't support the +GNU extensions. + +
`-p´ +: +
`--properties-output´ +: + + +Write out a Java ResourceBundle in Java .properties syntax. Note +that this file format doesn't support plural forms and silently drops +obsolete messages. + +
`--stringtable-output´ +: + +Write out a NeXTstep/GNUstep localized resource file in .strings syntax. +Note that this file format doesn't support plural forms. + +
`-w number´ +: +
`--width=number´ +: + + +Set the output page width. Long strings in the output files will be +split across multiple lines in order to ensure that each line's width +(= number of screen columns) is less or equal to the given number. + +
`--no-wrap´ +: + +Do not break long message lines. Message lines whose width exceeds the +output page width will not be split into several lines. Only file reference +lines which are wider than the output page width will be split. + +
`-s´ +: +
`--sort-output´ +: + + +Generate sorted output. Note that using this option makes it much harder +for the translator to understand each message's context. + +
`-F´ +: +
`--sort-by-file´ +: + + +Sort output by file location. + +

+ + + +

9.4.7 Informative output

+ +

`-h´ +: +
`--help´ +: + + +Display this help and exit. + +
`-V´ +: +
`--version´ +: + + +Output version information and exit. + +

+ + + +

9.5 Invoking the `msguniq` Program

+ +

+ + + +

+msguniq [option] [inputfile]
+

+ +

+ + +The msguniq program unifies duplicate translations in a translation +catalog. It finds duplicate translations of the same message ID. Such +duplicates are invalid input for other programs like msgfmt, +msgmerge or msgcat. By default, duplicates are merged +together. When using the `--repeated´ option, only duplicates are +output, and all other messages are discarded. Comments and extracted +comments will be cumulated, except that if `--use-first´ is +specified, they will be taken from the first translation. File positions +will be cumulated. When using the `--unique´ option, duplicates are +discarded. + +

+ + +

9.5.1 Input file location

+ +

`inputfile´ +: +Input PO file. + +
`-D directory´ +: +
`--directory=directory´ +: + + +Add directory to the list of directories. Source files are +searched relative to this list of directories. The resulting `.po´ +file will be written relative to the current directory, though. + +

+ +

+If no inputfile is given or if it is `-´, standard input is read. + +

+ + +

9.5.2 Output file location

+ +

`-o file´ +: +
`--output-file=file´ +: + + +Write output to specified file. + +

+ +

+The results are written to standard output if no output file is specified +or if it is `-´. + +

+ + +

9.5.3 Message selection

+ +

`-d´ +: +
`--repeated´ +: + + +Print only duplicates. + +
`-u´ +: +
`--unique´ +: + + +Print only unique messages, discard duplicates. + +

+ + + +

9.5.4 Input file syntax

+ +

`-P´ +: +
`--properties-input´ +: + + +Assume the input file is a Java ResourceBundle in Java .properties +syntax, not in PO file syntax. + +
`--stringtable-input´ +: + +Assume the input file is a NeXTstep/GNUstep localized resource file in +.strings syntax, not in PO file syntax. + +

+ + + +

9.5.5 Output details

+ +

`-t´ +: +
`--to-code=name´ +: + + +Specify encoding for output. + +
`--use-first´ +: + +Use first available translation for each message. Don't merge several +translations into one. + +
`--force-po´ +: + +Always write an output file even if it contains no message. + +
`-i´ +: +
`--indent´ +: + + +Write the .po file using indented style. + +
`--no-location´ +: + +Do not write `#: filename:line´ lines. + +
`-n´ +: +
`--add-location´ +: + + +Generate `#: filename:line´ lines (default). + +
`--strict´ +: + +Write out a strict Uniforum conforming PO file. Note that this +Uniforum format should be avoided because it doesn't support the +GNU extensions. + +
`-p´ +: +
`--properties-output´ +: + + +Write out a Java ResourceBundle in Java .properties syntax. Note +that this file format doesn't support plural forms and silently drops +obsolete messages. + +
`--stringtable-output´ +: + +Write out a NeXTstep/GNUstep localized resource file in .strings syntax. +Note that this file format doesn't support plural forms. + +
`-w number´ +: +
`--width=number´ +: + + +Set the output page width. Long strings in the output files will be +split across multiple lines in order to ensure that each line's width +(= number of screen columns) is less or equal to the given number. + +
`--no-wrap´ +: + +Do not break long message lines. Message lines whose width exceeds the +output page width will not be split into several lines. Only file reference +lines which are wider than the output page width will be split. + +
`-s´ +: +
`--sort-output´ +: + + +Generate sorted output. Note that using this option makes it much harder +for the translator to understand each message's context. + +
`-F´ +: +
`--sort-by-file´ +: + + +Sort output by file location. + +

+ + + +

9.5.6 Informative output

+ +

`-h´ +: +
`--help´ +: + + +Display this help and exit. + +
`-V´ +: +
`--version´ +: + + +Output version information and exit. + +

+ + + +

9.6 Invoking the `msgcomm` Program

+ +

+ + + +

+msgcomm [option] [inputfile]...
+

+ +

+ +The msgcomm program finds messages which are common to two or more +of the specified PO files. +By using the --more-than option, greater commonality may be requested +before messages are printed. Conversely, the --less-than option may be +used to specify less commonality before messages are printed (i.e. +`--less-than=2´ will only print the unique messages). Translations, +comments and extract comments will be preserved, but only from the first +PO file to define them. File positions from all PO files will be +cumulated. + +

+ + +

9.6.1 Input file location

+ +

`inputfile ...´ +: +Input files. + +
`-f file´ +: +
`--files-from=file´ +: + + +Read the names of the input files from file instead of getting +them from the command line. + +
`-D directory´ +: +
`--directory=directory´ +: + + +Add directory to the list of directories. Source files are +searched relative to this list of directories. The resulting `.po´ +file will be written relative to the current directory, though. + +

+ +

+If inputfile is `-´, standard input is read. + +

+ + +

9.6.2 Output file location

+ +

`-o file´ +: +
`--output-file=file´ +: + + +Write output to specified file. + +

+ +

+The results are written to standard output if no output file is specified +or if it is `-´. + +

+ + +

9.6.3 Message selection

+ +

`-< number´ +: +
`--less-than=number´ +: + + +Print messages with less than number definitions, defaults to infinite +if not set. + +
`-> number´ +: +
`--more-than=number´ +: + + +Print messages with more than number definitions, defaults to 1 if not +set. + +
`-u´ +: +
`--unique´ +: + + +Shorthand for `--less-than=2´. Requests that only unique messages be +printed. + +

+ + + +

9.6.4 Input file syntax

+ +

`-P´ +: +
`--properties-input´ +: + + +Assume the input files are Java ResourceBundles in Java .properties +syntax, not in PO file syntax. + +
`--stringtable-input´ +: + +Assume the input files are NeXTstep/GNUstep localized resource files in +.strings syntax, not in PO file syntax. + +

+ + + +

9.6.5 Output details

+ +

`--force-po´ +: + +Always write an output file even if it contains no message. + +
`-i´ +: +
`--indent´ +: + + +Write the .po file using indented style. + +
`--no-location´ +: + +Do not write `#: filename:line´ lines. + +
`-n´ +: +
`--add-location´ +: + + +Generate `#: filename:line´ lines (default). + +
`--strict´ +: + +Write out a strict Uniforum conforming PO file. Note that this +Uniforum format should be avoided because it doesn't support the +GNU extensions. + +
`-p´ +: +
`--properties-output´ +: + + +Write out a Java ResourceBundle in Java .properties syntax. Note +that this file format doesn't support plural forms and silently drops +obsolete messages. + +
`--stringtable-output´ +: + +Write out a NeXTstep/GNUstep localized resource file in .strings syntax. +Note that this file format doesn't support plural forms. + +
`-w number´ +: +
`--width=number´ +: + + +Set the output page width. Long strings in the output files will be +split across multiple lines in order to ensure that each line's width +(= number of screen columns) is less or equal to the given number. + +
`--no-wrap´ +: + +Do not break long message lines. Message lines whose width exceeds the +output page width will not be split into several lines. Only file reference +lines which are wider than the output page width will be split. + +
`-s´ +: +
`--sort-output´ +: + + +Generate sorted output. Note that using this option makes it much harder +for the translator to understand each message's context. +
`-F´ +: +
`--sort-by-file´ +: + + +Sort output by file location. + +
`--omit-header´ +: + +Don't write header with `msgid ""´ entry. + +

+ + + +

9.6.6 Informative output

+ +

`-h´ +: +
`--help´ +: + + +Display this help and exit. + +
`-V´ +: +
`--version´ +: + + +Output version information and exit. + +

+ + + +

9.7 Invoking the `msgcmp` Program

+ +

+ + + +

+msgcmp [option] def.po ref.pot
+

+ +

+ +The msgcmp program compares two Uniforum style .po files to check that +both contain the same set of msgid strings. The def.po file is an +existing PO file with the translations. The ref.pot file is the last +created PO file, or a PO Template file (generally created by xgettext). +This is useful for checking that you have translated each and every message +in your program. Where an exact match cannot be found, fuzzy matching is +used to produce better diagnostics. + +

+ + +

9.7.1 Input file location

+ +

`def.po´ +: +Translations. + +
`ref.pot´ +: +References to the sources. + +
`-D directory´ +: +
`--directory=directory´ +: + + +Add directory to the list of directories. Source files are +searched relative to this list of directories. + +

+ + + +

9.7.2 Operation modifiers

+ +

`-m´ +: +
`--multi-domain´ +: + + +Apply ref.pot to each of the domains in def.po. + +

+ + + +

9.7.3 Input file syntax

+ +

`-P´ +: +
`--properties-input´ +: + + +Assume the input files are Java ResourceBundles in Java .properties +syntax, not in PO file syntax. + +
`--stringtable-input´ +: + +Assume the input files are NeXTstep/GNUstep localized resource files in +.strings syntax, not in PO file syntax. + +

+ + + +

9.7.4 Informative output

+ +

`-h´ +: +
`--help´ +: + + +Display this help and exit. + +
`-V´ +: +
`--version´ +: + + +Output version information and exit. + +

+ + + +

9.8 Invoking the `msgattrib` Program

+ +

+ + + +

+msgattrib [option] [inputfile]
+

+ +

+ + +The msgattrib program filters the messages of a translation catalog +according to their attributes, and manipulates the attributes. + +

+ + +

9.8.1 Input file location

+ +

`inputfile´ +: +Input PO file. + +
`-D directory´ +: +
`--directory=directory´ +: + + +Add directory to the list of directories. Source files are +searched relative to this list of directories. The resulting `.po´ +file will be written relative to the current directory, though. + +

+ +

+If no inputfile is given or if it is `-´, standard input is read. + +

+ + +

9.8.2 Output file location

+ +

`-o file´ +: +
`--output-file=file´ +: + + +Write output to specified file. + +

+ +

+The results are written to standard output if no output file is specified +or if it is `-´. + +

+ + +

9.8.3 Message selection

+ +

`--translated´ +: + +Keep translated messages, remove untranslated messages. + +
`--untranslated´ +: + +Keep untranslated messages, remove translated messages. + +
`--no-fuzzy´ +: + +Remove `fuzzy' marked messages. + +
`--only-fuzzy´ +: + +Keep `fuzzy' marked messages, remove all other messsages. + +
`--no-obsolete´ +: + +Remove obsolete #~ messages. + +
`--only-obsolete´ +: + +Keep obsolete #~ messages, remove all other messages. + +

+ + + +

9.8.4 Attribute manipulation

+ +

+ +Attributes are modified after the message selection/removal has been +performed. If the `--only-file´ or `--ignore-file´ option is +specified, the attribute modification is applied only to those messages +that are listed in the only-file and not listed in the +ignore-file. + +

`--set-fuzzy´ +: + +Set all messages `fuzzy'. + +
`--clear-fuzzy´ +: + +Set all messages non-`fuzzy'. + +
`--set-obsolete´ +: + +Set all messages obsolete. + +
`--clear-obsolete´ +: + +Set all messages non-obsolete. + +
`--only-file=file´ +: + +Limit the attribute changes to entries that are listed in file. +file should be a PO or POT file. + +
`--ignore-file=file´ +: + +Limit the attribute changes to entries that are not listed in file. +file should be a PO or POT file. + +
`--fuzzy´ +: + +Synonym for `--only-fuzzy --clear-fuzzy´: It keeps only the fuzzy +messages and removes their `fuzzy' mark. + +
`--obsolete´ +: + +Synonym for `--only-obsolete --clear-obsolete´: It keeps only the +obsolete messages and makes them non-obsolete. + +

+ + + +

9.8.5 Input file syntax

+ +

`-P´ +: +
`--properties-input´ +: + + +Assume the input file is a Java ResourceBundle in Java .properties +syntax, not in PO file syntax. + +
`--stringtable-input´ +: + +Assume the input file is a NeXTstep/GNUstep localized resource file in +.strings syntax, not in PO file syntax. + +

+ + + +

9.8.6 Output details

+ +

`--force-po´ +: + +Always write an output file even if it contains no message. + +
`-i´ +: +
`--indent´ +: + + +Write the .po file using indented style. + +
`--no-location´ +: + +Do not write `#: filename:line´ lines. + +
`-n´ +: +
`--add-location´ +: + + +Generate `#: filename:line´ lines (default). + +
`--strict´ +: + +Write out a strict Uniforum conforming PO file. Note that this +Uniforum format should be avoided because it doesn't support the +GNU extensions. + +
`-p´ +: +
`--properties-output´ +: + + +Write out a Java ResourceBundle in Java .properties syntax. Note +that this file format doesn't support plural forms and silently drops +obsolete messages. + +
`--stringtable-output´ +: + +Write out a NeXTstep/GNUstep localized resource file in .strings syntax. +Note that this file format doesn't support plural forms. + +
`-w number´ +: +
`--width=number´ +: + + +Set the output page width. Long strings in the output files will be +split across multiple lines in order to ensure that each line's width +(= number of screen columns) is less or equal to the given number. + +
`--no-wrap´ +: + +Do not break long message lines. Message lines whose width exceeds the +output page width will not be split into several lines. Only file reference +lines which are wider than the output page width will be split. + +
`-s´ +: +
`--sort-output´ +: + + +Generate sorted output. Note that using this option makes it much harder +for the translator to understand each message's context. + +
`-F´ +: +
`--sort-by-file´ +: + + +Sort output by file location. + +

+ + + +

9.8.7 Informative output

+ +

`-h´ +: +
`--help´ +: + + +Display this help and exit. + +
`-V´ +: +
`--version´ +: + + +Output version information and exit. + +

+ + + +

9.9 Invoking the `msgen` Program

+ +

+ + + +

+msgen [option] inputfile
+

+ +

+ +The msgen program creates an English translation catalog. The +input file is the last created English PO file, or a PO Template file +(generally created by xgettext). Untranslated entries are assigned a +translation that is identical to the msgid. + +

+Note: `msginit --no-translator --locale=en´ performs a very similar +task. The main difference is that msginit cares specially about +the header entry, whereas msgen doesn't. + +

+ + +

9.9.1 Input file location

+ +

`inputfile´ +: +Input PO or POT file. + +
`-D directory´ +: +
`--directory=directory´ +: + + +Add directory to the list of directories. Source files are +searched relative to this list of directories. The resulting `.po´ +file will be written relative to the current directory, though. + +

+ +

+If inputfile is `-´, standard input is read. + +

+ + +

9.9.2 Output file location

+ +

`-o file´ +: +
`--output-file=file´ +: + + +Write output to specified file. + +

+ +

+The results are written to standard output if no output file is specified +or if it is `-´. + +

+ + +

9.9.3 Input file syntax

+ +

`-P´ +: +
`--properties-input´ +: + + +Assume the input file is a Java ResourceBundle in Java .properties +syntax, not in PO file syntax. + +
`--stringtable-input´ +: + +Assume the input file is a NeXTstep/GNUstep localized resource file in +.strings syntax, not in PO file syntax. + +

+ + + +

9.9.4 Output details

+ +

`--force-po´ +: + +Always write an output file even if it contains no message. + +
`-i´ +: +
`--indent´ +: + + +Write the .po file using indented style. + +
`--no-location´ +: + +Do not write `#: filename:line´ lines. + +
`--add-location´ +: + +Generate `#: filename:line´ lines (default). + +
`--strict´ +: + +Write out a strict Uniforum conforming PO file. Note that this +Uniforum format should be avoided because it doesn't support the +GNU extensions. + +
`-p´ +: +
`--properties-output´ +: + + +Write out a Java ResourceBundle in Java .properties syntax. Note +that this file format doesn't support plural forms and silently drops +obsolete messages. + +
`--stringtable-output´ +: + +Write out a NeXTstep/GNUstep localized resource file in .strings syntax. +Note that this file format doesn't support plural forms. + +
`-w number´ +: +
`--width=number´ +: + + +Set the output page width. Long strings in the output files will be +split across multiple lines in order to ensure that each line's width +(= number of screen columns) is less or equal to the given number. + +
`--no-wrap´ +: + +Do not break long message lines. Message lines whose width exceeds the +output page width will not be split into several lines. Only file reference +lines which are wider than the output page width will be split. + +
`-s´ +: +
`--sort-output´ +: + + +Generate sorted output. Note that using this option makes it much harder +for the translator to understand each message's context. + +
`-F´ +: +
`--sort-by-file´ +: + + +Sort output by file location. + +

+ + + +

9.9.5 Informative output

+ +

`-h´ +: +
`--help´ +: + + +Display this help and exit. + +
`-V´ +: +
`--version´ +: + + +Output version information and exit. + +

+ + + +

9.10 Invoking the `msgexec` Program

+ +

+ + + +

+msgexec [option] command [command-option]
+

+ +

+ +The msgexec program applies a command to all translations of a +translation catalog. +The command can be any program that reads a translation from standard +input. It is invoked once for each translation. Its output becomes +msgexec's output. msgexec's return code is the maximum return code +across all invocations. + +

+ +A special builtin command called `0´ outputs the translation, followed +by a null byte. The output of `msgexec 0´ is suitable as input for +`xargs -0´. + +

+ + +During each command invocation, the environment variable +MSGEXEC_MSGID is bound to the message's msgid, and the environment +variable MSGEXEC_LOCATION is bound to the location in the PO file +of the message. + +

-When GNU gettext will truly have reached its goal, average users -should feel some kind of astonished pleasure, seeing the effect of -that strange kind of magic that just makes their own native language -appear everywhere on their screens. As for naive users, they would -ideally have no special pleasure about it, merely taking their own -language for granted, and becoming rather unhappy otherwise. + +Note: It is your responsibility to ensure that the command can cope +with input encoded in the translation catalog's encoding. If the +command wants input in a particular encoding, you can in a first step +convert the translation catalog to that encoding using the `msgconv´ +program, before invoking `msgexec´. If the command wants input +in the locale's encoding, but you want to avoid the locale's encoding, then +you can first convert the translation catalog to UTF-8 using the +`msgconv´ program and then make `msgexec´ work in an UTF-8 +locale, by using the LC_ALL environment variable.

+ + +

9.10.1 Input file location

+ +

`-i inputfile´ +: +
`--input=inputfile´ +: + + +Input PO file. + +
`-D directory´ +: +
`--directory=directory´ +: + + +Add directory to the list of directories. Source files are +searched relative to this list of directories. The resulting `.po´ +file will be written relative to the current directory, though. + +

+ +

+If no inputfile is given or if it is `-´, standard input is read. + +

+ + +

9.10.2 Input file syntax

+ +

`-P´ +: +
`--properties-input´ +: + + +Assume the input file is a Java ResourceBundle in Java .properties +syntax, not in PO file syntax. + +
`--stringtable-input´ +: + +Assume the input file is a NeXTstep/GNUstep localized resource file in +.strings syntax, not in PO file syntax. + +

+ + + +

9.10.3 Informative output

+ +

`-h´ +: +
`--help´ +: + + +Display this help and exit. + +
`-V´ +: +
`--version´ +: + + +Output version information and exit. + +

+ + + +

9.11 Writing your own programs that process PO files

-So, let's try to describe here how we would like the magic to operate, -as we want the users' view to be the simplest, among all ways one -could look at GNU gettext. All other software engineers: -programmers, translators, maintainers, should work together in such a -way that the magic becomes possible. This is a long and progressive -undertaking, and information is available about the progress of the -Translation Project. +For the tasks for which a combination of `msgattrib´, `msgcat´ etc. +is not sufficient, a set of C functions is provided in a library, to make it +possible to process PO files in your own programs. When you use this library, +you don't need to write routines to parse the PO file; instead, you retreive +a pointer in memory to each of messages contained in the PO file. Functions +for writing PO files are not provided at this time.

-When a package is distributed, there are two kinds of users: -installers who fetch the distribution, unpack it, configure -it, compile it and install it for themselves or others to use; and -end users that call programs of the package, once these have -been installed at their site. GNU gettext is offering magic -for both installers and end users. +The functions are declared in the header file `<gettext-po.h>´, and are +defined in a library called `libgettextpo´.

Data Type: po_file_t +: +This is a pointer type that refers to the contents of a PO file, after it has +been read into memory. +

Data Type: po_message_iterator_t +: +This is a pointer type that refers to an iterator that produces a sequence of +messages. +

Data Type: po_message_t +: +This is a pointer type that refers to a message of a PO file, including its +translation. +

9.1 The Current `ABOUT-NLS´ Matrix

- - - +

Function: po_file_t po_file_read (const char *filename) +: +The po_file_read function reads a PO file into memory. The file name +is given as argument. The return value is a handle to the PO file's contents, +valid until po_file_free is called on it. In case of error, the return +value is NULL, and errno is set. +

-Languages are not equally supported in all packages using GNU -gettext. To know if some package uses GNU gettext, one -may check the distribution for the `ABOUT-NLS´ information file, for -some `ll.po´ files, often kept together into some `po/´ -directory, or for an `intl/´ directory. Internationalized packages -have usually many `ll.po´ files, where ll represents -the language. section 9.3 Magic for End Users for a complete description of the format -for ll. +

Function: void po_file_free (po_file_t file) +: +The po_file_free function frees a PO file's contents from memory, +including all messages that are only implicitly accessible through iterators. +

-More generally, a matrix is available for showing the current state -of the Translation Project, listing which packages are prepared for -multi-lingual messages, and which languages are supported by each. -Because this information changes often, this matrix is not kept within -this GNU gettext manual. This information is often found in -file `ABOUT-NLS´ from various distributions, but is also as old as -the distribution itself. A recent copy of this `ABOUT-NLS´ file, -containing up-to-date information, should generally be found on the -Translation Project sites, and also on most GNU archive sites. +

Function: const char * const * po_file_domains (po_file_t file) +: +The po_file_domains function returns the domains for which the given +PO file has messages. The return value is a NULL terminated array +which is valid as long as the file handle is valid. For PO files which +contain no `domain´ directive, the return value contains only one domain, +namely the default domain "messages". +

Function: po_message_iterator_t po_message_iterator (po_file_t file, const char *domain) +: +The po_message_iterator returns an iterator that will produce the +messages of file that belong to the given domain. If domain +is NULL, the default domain is used instead. To list the messages, +use the function po_next_message repeatedly. +

Function: void po_message_iterator_free (po_message_iterator_t iterator) +: +The po_message_iterator_free function frees an iterator previously +allocated through the po_message_iterator function. +

9.2 Magic for Installers

- - +

Function: po_message_t po_next_message (po_message_iterator_t iterator) +: +The po_next_message function returns the next message from +iterator and advances the iterator. It returns NULL when the +iterator has reached the end of its message list. +

-By default, packages fully using GNU gettext, internally, -are installed in such a way that they to allow translation of -messages. At configuration time, those packages should -automatically detect whether the underlying host system already provides -the GNU gettext functions. If not, -the GNU gettext library should be automatically prepared -and used. Installers may use special options at configuration -time for changing this behavior. The command `./configure ---with-included-gettext´ bypasses system gettext to -use the included GNU gettext instead, -while `./configure --disable-nls´ -produces programs totally unable to translate messages. +The following functions returns details of a po_message_t. Recall +that the results are valid as long as the file handle is valid.

- -Internationalized packages have usually many `ll.po´ -files. Unless -translations are disabled, all those available are installed together -with the package. However, the environment variable LINGUAS -may be set, prior to configuration, to limit the installed set. -LINGUAS should then contain a space separated list of two-letter -codes, stating which languages are allowed. +

Function: const char * po_message_msgid (po_message_t message) +: +The po_message_msgid function returns the msgid (untranslated +English string) of a message. This is guaranteed to be non-NULL. +

Function: const char * po_message_msgid_plural (po_message_t message) +: +The po_message_msgid_plural function returns the msgid_plural +(untranslated English plural string) of a message with plurals, or NULL +for a message without plural. +

Function: const char * po_message_msgstr (po_message_t message) +: +The po_message_msgstr function returns the msgstr (translation) +of a message. For an untranslated message, the return value is an empty +string. +

9.3 Magic for End Users

- - - +

Function: const char * po_message_msgstr_plural (po_message_t message, int index) +: +The po_message_msgstr_plural function returns the +msgstr[index] of a message with plurals, or NULL when +the index is out of range or for a message without plural. +

- -We consider here those packages using GNU gettext internally, -and for which the installers did not disable translation at -configure time. Then, users only have to set the LANG -environment variable to the appropriate `ll_CC´ -combination prior to using the programs in the package. See section 9.1 The Current `ABOUT-NLS´ Matrix. -For example, let's presume a German site. At the shell prompt, users -merely have to execute `setenv LANG de_DE´ (in csh) or -`export LANG; LANG=de_DE´ (in sh). They could even do -this from their `.login´ or `.profile´ file. +Here is an example code how these functions can be used.

+ +

+const char *filename = ...;
+po_file_t file = po_file_read (filename);
+
+if (file == NULL)
+  error (EXIT_FAILURE, errno, "couldn't open the PO file %s", filename);
+{
+  const char * const *domains = po_file_domains (file);
+  const char * const *domainp;
+
+  for (domainp = domains; *domainp; domainp++)
+    {
+      const char *domain = *domainp;
+      po_message_iterator_t iterator = po_message_iterator (file, domain);
+
+      for (;;)
+        {
+          po_message_t *message = po_next_message (iterator);
+
+          if (message == NULL)
+            break;
+          {
+            const char *msgid = po_message_msgid (message);
+            const char *msgstr = po_message_msgstr (message);
+
+            ...
+          }
+        }
+      po_message_iterator_free (iterator);
+    }
+}
+po_file_free (file);
+

-Go to the first, previous, next, last section, table of contents. +Go to the first, previous, next, last section, table of contents.