GNU gettext utilities: GNU gettext utilities

jpayne@68: jpayne@68:

1. Introduction jpayne@68:
- 1.1 The Purpose of GNU gettext
- 1.2 I18n, L10n, and Such
- 1.3 Aspects in Native Language Support
- 1.4 Files Conveying Translations
- 1.5 Overview of GNU gettext
2. The User's View jpayne@68:
- 2.1 Operating System Installation
- 2.2 Setting the Locale Used by GUI Programs
- 2.3 Setting the Locale through Environment Variables jpayne@68:
  - 2.3.1 Locale Names
  - 2.3.2 Locale Environment Variables
  - 2.3.3 Specifying a Priority List of Languages
- 2.4 Obtaining good output in a Windows console
- 2.5 Installing Translations for Particular Programs
3. The Format of PO Files
4. Preparing Program Sources jpayne@68:
- 4.1 Importing the gettext declaration
- 4.2 Triggering gettext Operations
- 4.3 Preparing Translatable Strings
- 4.4 How Marks Appear in Sources
- 4.5 Marking Translatable Strings
- 4.6 Special Comments preceding Keywords
- 4.7 Special Cases of Translatable Strings
- 4.8 Letting Users Report Translation Bugs
- 4.9 Marking Proper Names for Translation
- 4.10 Preparing Library Sources
5. Making the PO Template File jpayne@68:
- 5.1 Invoking the xgettext Program jpayne@68:
  - 5.1.1 Input file location
  - 5.1.2 Output file location
  - 5.1.3 Choice of input file language
  - 5.1.4 Input file interpretation
  - 5.1.5 Operation mode
  - 5.1.6 Language specific options
  - 5.1.7 Output details
  - 5.1.8 Informative output
  jpayne@68:
6. Creating a New PO File jpayne@68:
- 6.1 Invoking the msginit Program jpayne@68:
  - 6.1.1 Input file location
  - 6.1.2 Output file location
  - 6.1.3 Input file syntax
  - 6.1.4 Output details
  - 6.1.5 Informative output
- 6.2 Filling in the Header Entry
7. Updating Existing PO Files jpayne@68:
- 7.1 Invoking the msgmerge Program jpayne@68:
  - 7.1.1 Input file location
  - 7.1.2 Operation mode
  - 7.1.3 Output file location
  - 7.1.4 Output file location in update mode
  - 7.1.5 Operation modifiers
  - 7.1.6 Input file syntax
  - 7.1.7 Output details
  - 7.1.8 Informative output
  jpayne@68:
8. Editing PO Files jpayne@68:
- 8.1 KDE's PO File Editor
- 8.2 GNOME's PO File Editor
- 8.3 Emacs's PO File Editor jpayne@68:
  - 8.3.1 Completing GNU gettext Installation
  - 8.3.2 Main PO mode Commands
  - 8.3.3 Entry Positioning
  - 8.3.4 Normalizing Strings in Entries
  - 8.3.5 Translated Entries
  - 8.3.6 Fuzzy Entries
  - 8.3.7 Untranslated Entries
  - 8.3.8 Obsolete Entries
  - 8.3.9 Modifying Translations
  - 8.3.10 Modifying Comments
  - 8.3.11 Details of Sub Edition
  - 8.3.12 C Sources Context
  - 8.3.13 Consulting Auxiliary PO Files
- 8.4 Using Translation Compendia jpayne@68:
  - 8.4.1 Creating Compendia jpayne@68:
    - 8.4.1.1 Concatenate PO Files
    - 8.4.1.2 Extract a Message Subset from a PO File
  - 8.4.2 Using Compendia jpayne@68:
    - 8.4.2.1 Initialize a New Translation File
    - 8.4.2.2 Update an Existing Translation File
    jpayne@68:
  jpayne@68:
9. Manipulating PO Files jpayne@68:
- 9.1 Invoking the msgcat Program jpayne@68:
  - 9.1.1 Input file location
  - 9.1.2 Output file location
  - 9.1.3 Message selection
  - 9.1.4 Input file syntax
  - 9.1.5 Output details
  - 9.1.6 Informative output
- 9.2 Invoking the msgconv Program jpayne@68:
  - 9.2.1 Input file location
  - 9.2.2 Output file location
  - 9.2.3 Conversion target
  - 9.2.4 Input file syntax
  - 9.2.5 Output details
  - 9.2.6 Informative output
- 9.3 Invoking the msggrep Program jpayne@68:
  - 9.3.1 Input file location
  - 9.3.2 Output file location
  - 9.3.3 Message selection
  - 9.3.4 Input file syntax
  - 9.3.5 Output details
  - 9.3.6 Informative output
  - 9.3.7 Examples
- 9.4 Invoking the msgfilter Program jpayne@68:
  - 9.4.1 Input file location
  - 9.4.2 Output file location
  - 9.4.3 The filter
  - 9.4.4 Useful filter-options when the filter is ‘sed’
  - 9.4.5 Built-in filters
  - 9.4.6 Input file syntax
  - 9.4.7 Output details
  - 9.4.8 Informative output
  - 9.4.9 Examples
- 9.5 Invoking the msguniq Program jpayne@68:
  - 9.5.1 Input file location
  - 9.5.2 Output file location
  - 9.5.3 Message selection
  - 9.5.4 Input file syntax
  - 9.5.5 Output details
  - 9.5.6 Informative output
- 9.6 Invoking the msgcomm Program jpayne@68:
  - 9.6.1 Input file location
  - 9.6.2 Output file location
  - 9.6.3 Message selection
  - 9.6.4 Input file syntax
  - 9.6.5 Output details
  - 9.6.6 Informative output
- 9.7 Invoking the msgcmp Program jpayne@68:
  - 9.7.1 Input file location
  - 9.7.2 Operation modifiers
  - 9.7.3 Input file syntax
  - 9.7.4 Informative output
- 9.8 Invoking the msgattrib Program jpayne@68:
  - 9.8.1 Input file location
  - 9.8.2 Output file location
  - 9.8.3 Message selection
  - 9.8.4 Attribute manipulation
  - 9.8.5 Input file syntax
  - 9.8.6 Output details
  - 9.8.7 Informative output
- 9.9 Invoking the msgen Program jpayne@68:
  - 9.9.1 Input file location
  - 9.9.2 Output file location
  - 9.9.3 Input file syntax
  - 9.9.4 Output details
  - 9.9.5 Informative output
- 9.10 Invoking the msgexec Program jpayne@68:
  - 9.10.1 Input file location
  - 9.10.2 Input file syntax
  - 9.10.3 Informative output
- 9.11 Highlighting parts of PO files jpayne@68:
  - 9.11.1 The --color option
  - 9.11.2 The environment variable TERM
  - 9.11.3 The --style option
  - 9.11.4 Style rules for PO files
  - 9.11.5 Customizing less for viewing PO files
- 9.12 Other tools for manipulating PO files
- 9.13 Writing your own programs that process PO files jpayne@68:
  - 9.13.1 Error Handling
  - 9.13.2 po_file_t API
  - 9.13.3 po_message_iterator_t API
  - 9.13.4 po_message_t API
  - 9.13.5 PO Header Entry API
  - 9.13.6 po_filepos_t API
  - 9.13.7 Format Type API
  - 9.13.8 Checking API
  jpayne@68:
10. Producing Binary MO Files jpayne@68:
- 10.1 Invoking the msgfmt Program jpayne@68:
  - 10.1.1 Input file location
  - 10.1.2 Operation mode
  - 10.1.3 Output file location
  - 10.1.4 Output file location in Java mode
  - 10.1.5 Output file location in C# mode
  - 10.1.6 Output file location in Tcl mode
  - 10.1.7 Desktop Entry mode operations
  - 10.1.8 XML mode operations
  - 10.1.9 Input file syntax
  - 10.1.10 Input file interpretation
  - 10.1.11 Output details
  - 10.1.12 Informative output
- 10.2 Invoking the msgunfmt Program jpayne@68:
  - 10.2.1 Operation mode
  - 10.2.2 Input file location
  - 10.2.3 Input file location in Java mode
  - 10.2.4 Input file location in C# mode
  - 10.2.5 Input file location in Tcl mode
  - 10.2.6 Output file location
  - 10.2.7 Output details
  - 10.2.8 Informative output
- 10.3 The Format of GNU MO Files
11. The Programmer's View jpayne@68:
- 11.1 About catgets jpayne@68:
  - 11.1.1 The Interface
  - 11.1.2 Problems with the catgets Interface?!
- 11.2 About gettext jpayne@68:
  - 11.2.1 The Interface
  - 11.2.2 Solving Ambiguities
  - 11.2.3 Locating Message Catalog Files
  - 11.2.4 How to specify the output character set gettext uses
  - 11.2.5 Using contexts for solving ambiguities
  - 11.2.6 Additional functions for plural forms
  - 11.2.7 Optimization of the *gettext functions
- 11.3 Comparing the Two Interfaces
- 11.4 Using libintl.a in own programs
- 11.5 Being a gettext grok
- 11.6 Temporary Notes for the Programmers Chapter jpayne@68:
  - 11.6.1 Temporary - Two Possible Implementations
  - 11.6.2 Temporary - About catgets
  - 11.6.3 Temporary - Why a single implementation
  - 11.6.4 Temporary - Notes
  jpayne@68:
12. The Translator's View jpayne@68:
- 12.1 Introduction 0
- 12.2 Introduction 1
- 12.3 Discussions
- 12.4 Organization jpayne@68:
  - 12.4.1 Central Coordination
  - 12.4.2 National Teams jpayne@68:
    - 12.4.2.1 Sub-Cultures
    - 12.4.2.2 Organizational Ideas
  - 12.4.3 Mailing Lists
- 12.5 Information Flow
- 12.6 Translating plural forms
- 12.7 Prioritizing messages: How to determine which messages to translate first
13. The Maintainer's View jpayne@68:
- 13.1 Flat or Non-Flat Directory Structures
- 13.2 Prerequisite Works
- 13.3 Invoking the gettextize Program
- 13.4 Files You Must Create or Alter jpayne@68:
  - 13.4.1 ‘POTFILES.in’ in ‘po/’
  - 13.4.2 ‘LINGUAS’ in ‘po/’
  - 13.4.3 ‘Makevars’ in ‘po/’
  - 13.4.4 Extending ‘Makefile’ in ‘po/’
  - 13.4.5 ‘configure.ac’ at top level
  - 13.4.6 ‘config.guess’, ‘config.sub’ at top level
  - 13.4.7 ‘mkinstalldirs’ at top level
  - 13.4.8 ‘aclocal.m4’ at top level
  - 13.4.9 ‘config.h.in’ at top level
  - 13.4.10 ‘Makefile.in’ at top level
  - 13.4.11 ‘Makefile.in’ in ‘src/’
  - 13.4.12 ‘gettext.h’ in ‘lib/’
- 13.5 Autoconf macros for use in ‘configure.ac’ jpayne@68:
  - 13.5.1 AM_GNU_GETTEXT in ‘gettext.m4’
  - 13.5.2 AM_GNU_GETTEXT_VERSION in ‘gettext.m4’
  - 13.5.3 AM_GNU_GETTEXT_NEED in ‘gettext.m4’
  - 13.5.4 AM_PO_SUBDIRS in ‘po.m4’
  - 13.5.5 AM_XGETTEXT_OPTION in ‘po.m4’
  - 13.5.6 AM_ICONV in ‘iconv.m4’
- 13.6 Integrating with Version Control Systems jpayne@68:
  - 13.6.1 Avoiding version mismatch in distributed development
  - 13.6.2 Files to put under version control
  - 13.6.3 Put PO Files under Version Control
  - 13.6.4 Invoking the autopoint Program jpayne@68:
    - 13.6.4.1 Options
    - 13.6.4.2 Informative output
    jpayne@68:
- 13.7 Creating a Distribution Tarball
14. The Installer's and Distributor's View
15. Other Programming Languages jpayne@68:
- 15.1 The Language Implementor's View
- 15.2 The Programmer's View
- 15.3 The Translator's View jpayne@68:
  - 15.3.1 C Format Strings
  - 15.3.2 Objective C Format Strings
  - 15.3.3 C++ Format Strings
  - 15.3.4 Python Format Strings
  - 15.3.5 Java Format Strings
  - 15.3.6 C# Format Strings
  - 15.3.7 JavaScript Format Strings
  - 15.3.8 Scheme Format Strings
  - 15.3.9 Lisp Format Strings
  - 15.3.10 Emacs Lisp Format Strings
  - 15.3.11 librep Format Strings
  - 15.3.12 Ruby Format Strings
  - 15.3.13 Shell Format Strings
  - 15.3.14 awk Format Strings
  - 15.3.15 Lua Format Strings
  - 15.3.16 Object Pascal Format Strings
  - 15.3.17 Smalltalk Format Strings
  - 15.3.18 Qt Format Strings
  - 15.3.19 Qt Format Strings
  - 15.3.20 KDE Format Strings
  - 15.3.21 KUIT Format Strings
  - 15.3.22 Boost Format Strings
  - 15.3.23 Tcl Format Strings
  - 15.3.24 Perl Format Strings
  - 15.3.25 PHP Format Strings
  - 15.3.26 GCC internal Format Strings
  - 15.3.27 GFC internal Format Strings
  - 15.3.28 YCP Format Strings
- 15.4 The Maintainer's View
- 15.5 Individual Programming Languages jpayne@68:
  - 15.5.1 C, C++, Objective C
  - 15.5.2 Python
  - 15.5.3 Java
  - 15.5.4 C#
  - 15.5.5 JavaScript
  - 15.5.6 GNU guile - Scheme
  - 15.5.7 GNU clisp - Common Lisp
  - 15.5.8 GNU clisp C sources
  - 15.5.9 Emacs Lisp
  - 15.5.10 librep
  - 15.5.11 Ruby
  - 15.5.12 sh - Shell Script jpayne@68:
    - 15.5.12.1 Preparing Shell Scripts for Internationalization
    - 15.5.12.2 Contents of gettext.sh
    - 15.5.12.3 Invoking the gettext program
    - 15.5.12.4 Invoking the ngettext program
    - 15.5.12.5 Invoking the envsubst program
    - 15.5.12.6 Invoking the eval_gettext function
    - 15.5.12.7 Invoking the eval_ngettext function
    - 15.5.12.8 Invoking the eval_pgettext function
    - 15.5.12.9 Invoking the eval_npgettext function
  - 15.5.13 bash - Bourne-Again Shell Script
  - 15.5.14 GNU awk
  - 15.5.15 Lua
  - 15.5.16 Pascal - Free Pascal Compiler
  - 15.5.17 GNU Smalltalk
  - 15.5.18 Vala
  - 15.5.19 wxWidgets library
  - 15.5.20 Tcl - Tk's scripting language
  - 15.5.21 Perl jpayne@68:
    - 15.5.21.1 General Problems Parsing Perl Code
    - 15.5.21.2 Which keywords will xgettext look for?
    - 15.5.21.3 How to Extract Hash Keys
    - 15.5.21.4 What are Strings And Quote-like Expressions?
    - 15.5.21.5 Invalid Uses Of String Interpolation
    - 15.5.21.6 Valid Uses Of String Interpolation
    - 15.5.21.7 When To Use Parentheses
    - 15.5.21.8 How To Grok with Long Lines
    - 15.5.21.9 Bugs, Pitfalls, And Things That Do Not Work
  - 15.5.22 PHP Hypertext Preprocessor
  - 15.5.23 Pike
  - 15.5.24 GNU Compiler Collection sources
  - 15.5.25 YCP - YaST2 scripting language
  jpayne@68:
16. Other Data Formats jpayne@68:
- 16.1 Internationalizable Data Formats jpayne@68:
  - 16.1.1 POT - Portable Object Template
  - 16.1.2 Resource String Table
  - 16.1.3 Glade - GNOME user interface description
  - 16.1.4 GSettings - GNOME user configuration schema
  - 16.1.5 AppData - freedesktop.org application description
  - 16.1.6 Preparing Rules for XML Internationalization jpayne@68:
    - 16.1.6.1 Two Use-cases of Translated Strings in XML
    jpayne@68:
- 16.2 Localized Data Formats jpayne@68:
  - 16.2.1 Editable Message Catalogs jpayne@68:
    - 16.2.1.1 PO - Portable Object
    - 16.2.1.2 Java .properties
    - 16.2.1.3 NeXTstep/GNUstep .strings
  - 16.2.2 Compiled Message Catalogs jpayne@68:
    - 16.2.2.1 MO - Machine Object
    - 16.2.2.2 Java ResourceBundle
    - 16.2.2.3 C# Satellite Assembly
    - 16.2.2.4 C# Resource
    - 16.2.2.5 Tcl message catalog
    - 16.2.2.6 Qt message catalog
  - 16.2.3 Desktop Entry files jpayne@68:
    - 16.2.3.1 How to handle icons in Desktop Entry files
  - 16.2.4 XML files
  jpayne@68:
17. Concluding Remarks jpayne@68:
- 17.1 History of GNU gettext
- 17.2 Notes on the Free Translation Project jpayne@68:
  - 17.2.1 INSTALL Matters
  - 17.2.2 Using This Package
  - 17.2.3 Translating Teams
  - 17.2.4 Available Packages
  - 17.2.5 Using gettext in new packages
- 17.3 Related Readings
A. Language Codes jpayne@68:
- A.1 Usual Language Codes
- A.2 Rare Language Codes
B. Country Codes
C. Licenses jpayne@68:
- C.1 GNU GENERAL PUBLIC LICENSE
- C.2 GNU LESSER GENERAL PUBLIC LICENSE
- C.3 GNU Free Documentation License
Program Index
Option Index
Variable Index
PO Mode Index
Autoconf Macro Index
General Index

jpayne@68:

This manual documents the GNU gettext tools and the GNU libintl library, jpayne@68: version 0.22.5. jpayne@68:

jpayne@68: jpayne@68: This document was generated by Bruno Haible on February, 21 2024 using texi2html 1.78a. jpayne@68: jpayne@68:
jpayne@68: jpayne@68:

GNU `gettext` utilities

Table of Contents