From: Bruno Haible Date: Tue, 12 Jun 2001 13:21:16 +0000 (+0000) Subject: Automatically generated documentation. X-Git-Tag: v0.11~663 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a7c1a777f7e2e74f2dab84f0b33360ddfc764299;p=thirdparty%2Fgettext.git Automatically generated documentation. --- diff --git a/man/bind_textdomain_codeset.3 b/man/bind_textdomain_codeset.3 new file mode 100644 index 000000000..a25f24c89 --- /dev/null +++ b/man/bind_textdomain_codeset.3 @@ -0,0 +1,72 @@ +.\" Copyright (c) Bruno Haible +.\" +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" References consulted: +.\" GNU glibc-2 source code and manual +.\" GNU gettext source code and manual +.\" LI18NUX 2000 Globalization Specification +.\" +.TH BIND_TEXTDOMAIN_CODESET 3 "May 2001" "GNU gettext 0.11" +.SH NAME +bind_textdomain_codeset \- set encoding of message translations +.SH SYNOPSIS +.nf +.B #include +.sp +.BI "char * bind_textdomain_codeset (const char * " domainname , +.BI " const char * " codeset ); +.fi +.SH DESCRIPTION +The \fBbind_textdomain_codeset\fP function sets the output codeset for message +catalogs for domain \fIdomainname\fP. +.PP +A message domain is a set of translatable \fImsgid\fP messages. Usually, +every software package has its own message domain. +.PP +By default, the \fBgettext\fP family of functions returns translated messages +in the locale's character encoding, which can be retrieved as +\fBnl_langinfo(CODESET)\fP. The need for calling \fBbind_textdomain_codeset\fP +arises for programs which store strings in a locale independent way (e.g. +UTF-8) and want to avoid an extra character set conversion on the returned +translated messages. +.PP +\fIdomainname\fP must be a non-empty string. +.PP +If \fIcodeset\fP is not NULL, it must be a valid encoding name which can be +used for the \fBiconv_open\fP function. The \fBbind_textdomain_codeset\fP +function sets the output codeset for message catalogs belonging to domain +\fIdomainname\fP to \fIcodeset\fP. The function makes copies of the argument +strings as needed. +.PP +If \fIcodeset\fP is NULL, the function returns the previously set codeset for +domain \fIdomainname\fP. The default is NULL, denoting the locale's character +encoding. +.SH "RETURN VALUE" +If successful, the \fBbind_textdomain_codeset\fP function returns the current +codeset for domain \fIdomainname\fP, after possibly changing it. The resulting +string is valid until the next \fBbind_textdomain_codeset\fP call for the same +\fIdomainname\fP and must not be modified or freed. If a memory allocation +failure occurs, it sets \fBerrno\fP to \fBENOMEM\fP and returns NULL. If no +codeset has been set for domain \fIdomainname\fP, it returns NULL. +.SH ERRORS +The following error can occur, among others: +.TP +.B ENOMEM +Not enough memory available. +.SH BUGS +The return type ought to be \fBconst char *\fP, but is \fBchar *\fP to avoid +warnings in C code predating ANSI C. +.SH "SEE ALSO" +.BR gettext (3), +.BR dgettext (3), +.BR dcgettext (3), +.BR ngettext (3), +.BR dngettext (3), +.BR dcngettext (3), +.BR textdomain (3), +.BR nl_langinfo (3), +.BR iconv_open (3) diff --git a/man/bind_textdomain_codeset.3.html b/man/bind_textdomain_codeset.3.html new file mode 100644 index 000000000..beb9875c5 --- /dev/null +++ b/man/bind_textdomain_codeset.3.html @@ -0,0 +1,154 @@ + + + + +BIND_TEXTDOMAIN_CODESET + + + +

BIND_TEXTDOMAIN_CODESET

+NAME
+SYNOPSIS
+DESCRIPTION
+RETURN VALUE
+ERRORS
+BUGS
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+bind_textdomain_codeset - set encoding of message translations

+ +

SYNOPSIS

+ + + +

#include <libintl.h>
+
+char * bind_textdomain_codeset (const char * domainname,
+                                const char * codeset);
+

+ +

DESCRIPTION

+ + + +

+The bind_textdomain_codeset function sets the output +codeset for message catalogs for domain +domainname.

+ + + +

+A message domain is a set of translatable msgid +messages. Usually, every software package has its own +message domain.

+ + + +

+By default, the gettext family of functions returns +translated messages in the locale's character encoding, +which can be retrieved as nl_langinfo(CODESET). The +need for calling bind_textdomain_codeset arises for +programs which store strings in a locale independent way +(e.g. UTF-8) and want to avoid an extra character set +conversion on the returned translated messages.

+ + + +

+domainname must be a non-empty string.

+ + + +

+If codeset is not NULL, it must be a valid encoding +name which can be used for the iconv_open function. +The bind_textdomain_codeset function sets the output +codeset for message catalogs belonging to domain +domainname to codeset. The function makes +copies of the argument strings as needed.

+ + + +

+If codeset is NULL, the function returns the +previously set codeset for domain domainname. The +default is NULL, denoting the locale's character +encoding.

+ +

RETURN VALUE

+ + + +

+If successful, the bind_textdomain_codeset function +returns the current codeset for domain domainname, +after possibly changing it. The resulting string is valid +until the next bind_textdomain_codeset call for the +same domainname and must not be modified or freed. If +a memory allocation failure occurs, it sets errno to +ENOMEM and returns NULL. If no codeset has been set +for domain domainname, it returns NULL.

+ +

ERRORS

+ + + +

+The following error can occur, among others:

+ + + +

+ENOMEM

+ + + +

+Not enough memory available.

+ +

BUGS

+ + + +

+The return type ought to be const char *, but is +char * to avoid warnings in C code predating ANSI +C.

+ +

BINDTEXTDOMAIN

+NAME
+SYNOPSIS
+DESCRIPTION
+RETURN VALUE
+ERRORS
+BUGS
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+bindtextdomain - set directory containing message catalogs

+ +

SYNOPSIS

+ + + +

#include <libintl.h>
+
+char * bindtextdomain (const char * domainname, const char * dirname);
+

+ +

DESCRIPTION

+ + + +

+The bindtextdomain function sets the base directory +of the hierarchy containing message catalogs for a given +message domain.

+ + + +

+A message domain is a set of translatable msgid +messages. Usually, every software package has its own +message domain. The need for calling bindtextdomain +arises because packages are not always installed with the +same prefix as the <libintl.h> header and the +libc/libintl libraries.

+ + + +

+Message catalogs will be expected at the pathnames +dirname/locale/category/domainname.mo, +where locale is a locale name and category is +a locale facet such as LC_MESSAGES.

+ + + +

+domainname must be a non-empty string.

+ + + +

+If dirname is not NULL, the base directory for +message catalogs belonging to domain domainname is +set to dirname. The function makes copies of the +argument strings as needed. If the program wishes to call +the chdir function, it is important that +dirname be an absolute pathname; otherwise it cannot +be guaranteed that the message catalogs will be +found.

+ + + +

+If dirname is NULL, the function returns the +previously set base directory for domain +domainname.

+ +

RETURN VALUE

+ + + +

+If successful, the bindtextdomain function returns +the current base directory for domain domainname, +after possibly changing it. The resulting string is valid +until the next bindtextdomain call for the same +domainname and must not be modified or freed. If a +memory allocation failure occurs, it sets errno to +ENOMEM and returns NULL.

+ +

ERRORS

+ + + +

+The following error can occur, among others:

+ + + +

+ENOMEM

+ + + +

+Not enough memory available.

+ +

BUGS

+ + + +

+The return type ought to be const char *, but is +char * to avoid warnings in C code predating ANSI +C.

+ +

GETTEXT

+NAME
+SYNOPSIS
+DESCRIPTION
+AUTHOR
+REPORTING BUGS
+COPYRIGHT
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+gettext - translate message

+ +

SYNOPSIS

+ + + +

+gettext [OPTION] [[TEXTDOMAIN] +MSGID]
+gettext [OPTION] -s +[MSGID]...

+ +

DESCRIPTION

+ + + +

+The gettext program translates a natural language +message into the user's language, by looking up the +translation in a message catalog.

+ + + +

+Display native language translation of a textual +message.

+ + + +

+-d, --domain=TEXTDOMAIN

+ + + +

+retrieve translated messages from TEXTDOMAIN

+ + + +

+-e

+ + + +

+enable expansion of some escape sequences

+ + + +

+-E

+ + + +

+(ignored for compatibility)

+ + + +

+-h, --help

+ + + +

+display this help and exit

+ + + +

+-n

+ + + +

+suppress trailing newline

+ + + +

+-V, --version

+ + + +

+display 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. Standard +search directory: +/home/haible/gnu/arch/linuxlibc6/share/locale

+ +

AUTHOR

+ + + +

+Written by Ulrich Drepper.

+ +

REPORTING BUGS

+ + + +

+Report bugs to <bug-gnu-utils@gnu.org>.

+ +

COPYRIGHT

+ + + +

+Copyright 1995-1997, 2000, 2001 Free Software Foundation, +Inc.
+This is free software; see the source for copying +conditions. There is NO warranty; not even for +MERCHANTABILITY or FITNESS FOR A PARTICULAR +PURPOSE.

+ +

GETTEXT

+NAME
+SYNOPSIS
+DESCRIPTION
+RETURN VALUE
+ERRORS
+BUGS
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+gettext, dgettext, dcgettext - translate message

+ +

SYNOPSIS

+ + + +

#include <libintl.h>
+
+char * gettext (const char * msgid);
+char * dgettext (const char * domainname, const char * msgid);
+char * dcgettext (const char * domainname, const char * msgid,
+                  int category);
+

+ +

DESCRIPTION

+ + + +

+The gettext, dgettext and dcgettext +functions attempt to translate a text string into the user's +native language, by looking up the translation in a message +catalog.

+ + + +

+The msgid argument identifies the message to be +translated. By convention, it is the English version of the +message, with non-ASCII characters replaced by ASCII +approximations. This choice allows the translators to work +with message catalogs, called PO files, that contain both +the English and the translated versions of each message, and +can be installed using the msgfmt +utility.

+ + + +

+A message domain is a set of translatable msgid +messages. Usually, every software package has its own +message domain. The domain name is used to determine the +message catalog where the translation is looked up; it must +be a non-empty string. For the gettext function, it +is specified through a preceding textdomain call. For +the dgettext and dcgettext functions, it is +passed as the domainname argument; if this argument +is NULL, the domain name specified through a preceding +textdomain call is used instead.

+ + + +

+Translation lookup operates in the context of the current +locale. For the gettext and dgettext +functions, the LC_MESSAGES locale facet is used. It +is determined by a preceding call to the setlocale +function. setlocale(LC_ALL,"") initializes +the LC_MESSAGES locale based on the first nonempty +value of the three environment variables LC_ALL, +LC_MESSAGES, LANG; see setlocale(3). +For the dcgettext function, the locale facet is +determined by the category argument, which should be +one of the LC_xxx constants defined in the +<locale.h> header, excluding LC_ALL. In both +cases, the functions also use the LC_CTYPE locale +facet in order to convert the translated message from the +translator's codeset to the current locale's codeset, unless +overridden by a prior call to the +bind_textdomain_codeset function.

+ + + +

+The message catalog used by the functions is at the pathname +dirname/locale/category/domainname.mo. +Here dirname is the directory specified through +bindtextdomain. Its default is system and +configuration dependent; typically it is +prefix/share/locale, where prefix is the +installation prefix of the package. locale is the +name of the current locale facet; the GNU implementation +also tries generalizations, such as the language name +without the territory name. category is +LC_MESSAGES for the gettext and +dgettext functions, or the argument passed to the +dcgettext function.

+ + + +

+If the LANGUAGE environment variable is set to a +nonempty value, and the locale is not the "C" +locale, the value of LANGUAGE is assumed to contain a +colon separated list of locale names. The functions will +attempt to look up a translation of msgid in each of +the locales in turn. This is a GNU extension.

+ + + +

+In the "C" locale, or if none of the used catalogs +contain a translation for msgid, the gettext, +dgettext and dcgettext functions return +msgid.

+ +

RETURN VALUE

+ + + +

+If a translation was found in one of the specified catalogs, +it is converted to the locale's codeset and returned. The +resulting string is statically allocated and must not be +modified or freed. Otherwise msgid is +returned.

+ +

ERRORS

+ + + +

+errno is not modified.

+ +

BUGS

+ + + +

+The return type ought to be const char *, but is +char * to avoid warnings in C code predating ANSI +C.

+ + + +

+When an empty string is used for msgid, the functions +may return a nonempty string.

+ +

LT-MSGCAT

+NAME
+SYNOPSIS
+DESCRIPTION
+AUTHOR
+REPORTING BUGS
+COPYRIGHT
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+msgcat - combines several message catalogs

+ +

SYNOPSIS

+ + + +

+lt-msgcat [OPTION] +[INPUTFILE]...

+ +

DESCRIPTION

+ + + +

+Concatenates and merges the specified PO files. Find +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.

+ + + +

+Mandatory arguments to long options are mandatory for short +options too.

+ + + +

+Input file location:

+ + + +

+INPUTFILE ...

+ + + +

+input files

+ + + +

+-f, --files-from=FILE

+ + + +

+get list of input files from FILE

+ + + +

+-D, --directory=DIRECTORY

+ + + +

+add DIRECTORY to list for input files search

+ + + +

+If input file is -, standard input is read.

+ + + +

+Output file location:

+ + + +

+-o, --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 -.

+ + + +

+Message selection:

+ + + +

+-<, --less-than=NUMBER

+ + + +

+print messages with less than this many definitions, +defaults to infinite if not set

+ + + +

+->, --more-than=NUMBER

+ + + +

+print messages with more than this many definitions, +defaults to 1 if not set

+ + + +

+-u, --unique

+ + + +

+shorthand for --less-than=2, requests that +only unique messages be printed

+ + + +

+Output details:

+ + + +

+-t, --to-code=NAME

+ + + +

+encoding for output

+ + + +

+--use-first

+ + + +

+use first available translation for each message, don't +merge several translations

+ + + +

+-e, --no-escape

+ + + +

+do not use C escapes in output (default)

+ + + +

+-E, --escape

+ + + +

+use C escapes in output, no extended chars

+ + + +

+--force-po

+ + + +

+write PO file even if empty

+ + + +

+-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 strict Uniforum conforming .po file

+ + + +

+-w, --width=NUMBER

+ + + +

+set output page width

+ + + +

+-s, --sort-output

+ + + +

+generate sorted output and remove duplicates

+ + + +

+-F, --sort-by-file

+ + + +

+sort output by file location

+ + + +

+Informative output:

+ + + +

+-h, --help

+ + + +

+display this help and exit

+ + + +

+-V, --version

+ + + +

+output version information and exit

+ +

AUTHOR

+ + + +

+Written by Bruno Haible.

+ +

REPORTING BUGS

+ + + +

+Report bugs to <bug-gnu-utils@gnu.org>.

+ +

COPYRIGHT

+ + + +

+Copyright 2001 Free Software Foundation, Inc.
+This is free software; see the source for copying +conditions. There is NO warranty; not even for +MERCHANTABILITY or FITNESS FOR A PARTICULAR +PURPOSE.

+ +

MSGCMP

+NAME
+SYNOPSIS
+DESCRIPTION
+AUTHOR
+REPORTING BUGS
+COPYRIGHT
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+msgcmp - compare message catalog and template

+ +

SYNOPSIS

+ + + +

+msgcmp [OPTION] def.po +ref.pot

+ +

DESCRIPTION

+ + + +

+Compare 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.

+ + + +

+Mandatory arguments to long options are mandatory for short +options too.

+ + + +

+Input file location:

+ + + +

+def.po

+ + + +

+translations

+ + + +

+ref.pot

+ + + +

+references to the sources

+ + + +

+-D, --directory=DIRECTORY

+ + + +

+add DIRECTORY to list for input files search

+ + + +

+Operation modifiers:

+ + + +

+-m, --multi-domain

+ + + +

+apply ref.pot to each of the domains in def.po

+ + + +

+Informative output:

+ + + +

+-h, --help

+ + + +

+display this help and exit

+ + + +

+-V, --version

+ + + +

+output version information and exit

+ +

AUTHOR

+ + + +

+Written by Peter Miller.

+ +

REPORTING BUGS

+ + + +

+Report bugs to <bug-gnu-utils@gnu.org>.

+ +

COPYRIGHT

+ + + +

+Copyright 1995-1998, 2000, 2001 Free Software Foundation, +Inc.
+This is free software; see the source for copying +conditions. There is NO warranty; not even for +MERCHANTABILITY or FITNESS FOR A PARTICULAR +PURPOSE.

+ +

MSGCOMM

+NAME
+SYNOPSIS
+DESCRIPTION
+AUTHOR
+REPORTING BUGS
+COPYRIGHT
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+msgcomm - match two message catalogs

+ +

SYNOPSIS

+ + + +

+msgcomm [OPTION] +[INPUTFILE]...

+ +

DESCRIPTION

+ + + +

+Find 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.

+ + + +

+Mandatory arguments to long options are mandatory for short +options too.

+ + + +

+Input file location:

+ + + +

+INPUTFILE ...

+ + + +

+input files

+ + + +

+-f, --files-from=FILE

+ + + +

+get list of input files from FILE

+ + + +

+-D, --directory=DIRECTORY

+ + + +

+add DIRECTORY to list for input files search

+ + + +

+If input file is -, standard input is read.

+ + + +

+Output file location:

+ + + +

+-o, --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 -.

+ + + +

+Message selection:

+ + + +

+-<, --less-than=NUMBER

+ + + +

+print messages with less than this many definitions, +defaults to infinite if not set

+ + + +

+->, --more-than=NUMBER

+ + + +

+print messages with more than this many definitions, +defaults to 1 if not set

+ + + +

+-u, --unique

+ + + +

+shorthand for --less-than=2, requests that +only unique messages be printed

+ + + +

+Output details:

+ + + +

+-e, --no-escape

+ + + +

+do not use C escapes in output (default)

+ + + +

+-E, --escape

+ + + +

+use C escapes in output, no extended chars

+ + + +

+--force-po

+ + + +

+write PO file even if empty

+ + + +

+-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 strict Uniforum conforming .po file

+ + + +

+-w, --width=NUMBER

+ + + +

+set output page width

+ + + +

+-s, --sort-output

+ + + +

+generate sorted output and remove duplicates

+ + + +

+-F, --sort-by-file

+ + + +

+sort output by file location

+ + + +

+--omit-header

+ + + +

+don't write header with `msgid ""' +entry

+ + + +

+Informative output:

+ + + +

+-h, --help

+ + + +

+display this help and exit

+ + + +

+-V, --version

+ + + +

+output version information and exit

+ +

AUTHOR

+ + + +

+Written by Peter Miller.

+ +

REPORTING BUGS

+ + + +

+Report bugs to <bug-gnu-utils@gnu.org>.

+ +

COPYRIGHT

+ + + +

+ +

LT-MSGCONV

+NAME
+SYNOPSIS
+DESCRIPTION
+AUTHOR
+REPORTING BUGS
+COPYRIGHT
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+msgconv - character set conversion for message catalog

+ +

SYNOPSIS

+ + + +

+lt-msgconv [OPTION] +[INPUTFILE]

+ +

DESCRIPTION

+ + + +

+Converts a translation catalog to a different character +encoding.

+ + + +

+Mandatory arguments to long options are mandatory for short +options too.

+ + + +

+Input file location:

+ + + +

+INPUTFILE

+ + + +

+input PO file

+ + + +

+-D, --directory=DIRECTORY

+ + + +

+add DIRECTORY to list for input files search

+ + + +

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

+ + + +

+Output file location:

+ + + +

+-o, --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 -.

+ + + +

+Conversion target:

+ + + +

+-t, --to-code=NAME

+ + + +

+encoding for output

+ + + +

+The default encoding is the current locale's +encoding.

+ + + +

+Output details:

+ + + +

+-e, --no-escape

+ + + +

+do not use C escapes in output (default)

+ + + +

+-E, --escape

+ + + +

+use C escapes in output, no extended chars

+ + + +

+--force-po

+ + + +

+write PO file even if empty

+ + + +

+-i, --indent

+ + + +

+indented output style

+ + + +

+--no-location

+ + + +

+suppress '#: filename:line' lines

+ + + +

+--add-location

+ + + +

+preserve '#: filename:line' lines (default)

+ + + +

+--strict

+ + + +

+strict Uniforum output style

+ + + +

+-w, --width=NUMBER

+ + + +

+set output page width

+ + + +

+-s, --sort-output

+ + + +

+generate sorted output and remove duplicates

+ + + +

+-F, --sort-by-file

+ + + +

+sort output by file location

+ + + +

+Informative output:

+ + + +

+-h, --help

+ + + +

+display this help and exit

+ + + +

+-V, --version

+ + + +

+output version information and exit

+ +

AUTHOR

+ + + +

+Written by Bruno Haible.

+ +

REPORTING BUGS

+ + + +

+Report bugs to <bug-gnu-utils@gnu.org>.

+ +

COPYRIGHT

+ + + +

+ +

LT-MSGEN

+NAME
+SYNOPSIS
+DESCRIPTION
+AUTHOR
+REPORTING BUGS
+COPYRIGHT
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+msgen - create English message catalog

+ +

SYNOPSIS

+ + + +

+lt-msgen [OPTION] +INPUTFILE

+ +

DESCRIPTION

+ + + +

+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, and +are marked fuzzy.

+ + + +

+Mandatory arguments to long options are mandatory for short +options too.

+ + + +

+Input file location:

+ + + +

+INPUTFILE

+ + + +

+input PO or POT file

+ + + +

+-D, --directory=DIRECTORY

+ + + +

+add DIRECTORY to list for input files search

+ + + +

+If input file is -, standard input is read.

+ + + +

+Output file location:

+ + + +

+-o, --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 -.

+ + + +

+Output details:

+ + + +

+-e, --no-escape

+ + + +

+do not use C escapes in output (default)

+ + + +

+-E, --escape

+ + + +

+use C escapes in output, no extended chars

+ + + +

+--force-po

+ + + +

+write PO file even if empty

+ + + +

+-i, --indent

+ + + +

+indented output style

+ + + +

+--no-location

+ + + +

+suppress '#: filename:line' lines

+ + + +

+--add-location

+ + + +

+preserve '#: filename:line' lines (default)

+ + + +

+--strict

+ + + +

+strict Uniforum output style

+ + + +

+-w, --width=NUMBER

+ + + +

+set output page width

+ + + +

+-s, --sort-output

+ + + +

+generate sorted output and remove duplicates

+ + + +

+-F, --sort-by-file

+ + + +

+sort output by file location

+ + + +

+Informative output:

+ + + +

+-h, --help

+ + + +

+display this help and exit

+ + + +

+-V, --version

+ + + +

+output version information and exit

+ +

AUTHOR

+ + + +

+Written by Bruno Haible.

+ +

REPORTING BUGS

+ + + +

+Report bugs to <bug-gnu-utils@gnu.org>.

+ +

COPYRIGHT

+ + + +

+ +

MSGFMT

+NAME
+SYNOPSIS
+DESCRIPTION
+AUTHOR
+REPORTING BUGS
+COPYRIGHT
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+msgfmt - compile message catalog to binary format

+ +

SYNOPSIS

+ + + +

+msgfmt [OPTION] filename.po +...

+ +

DESCRIPTION

+ + + +

+Generate binary message catalog from textual translation +description.

+ + + +

+Mandatory arguments to long options are mandatory for short +options too.

+ + + +

+Input file location:

+ + + +

+filename.po ...

+ + + +

+input files

+ + + +

+-D, --directory=DIRECTORY

+ + + +

+add DIRECTORY to list for input files search

+ + + +

+If input file is -, standard input is read.

+ + + +

+Output file location:

+ + + +

+-o, --output-file=FILE

+ + + +

+write output to specified file

+ + + +

+--strict

+ + + +

+enable strict Uniforum mode

+ + + +

+If output file is -, output is written to standard +output.

+ + + +

+Input file interpretation:

+ + + +

+-c, --check

+ + + +

+perform language dependent checks on strings

+ + + +

+-f, --use-fuzzy

+ + + +

+use fuzzy entries in output

+ + + +

+Output details:

+ + + +

+-a, --alignment=NUMBER

+ + + +

+align strings to NUMBER bytes (default: 1)

+ + + +

+--no-hash

+ + + +

+binary file will not include the hash table

+ + + +

+Informative output:

+ + + +

+-h, --help

+ + + +

+display this help and exit

+ + + +

+-V, --version

+ + + +

+output version information and exit

+ + + +

+--statistics

+ + + +

+print statistics about translations

+ + + +

+-v, --verbose

+ + + +

+list input file anomalies

+ + + +

+Giving the -v option more than once increases the +verbosity level.

+ +

AUTHOR

+ + + +

+Written by Ulrich Drepper.

+ +

REPORTING BUGS

+ + + +

+Report bugs to <bug-gnu-utils@gnu.org>.

+ +

COPYRIGHT

+ + + +

+ +

LT-MSGGREP

+NAME
+SYNOPSIS
+DESCRIPTION
+AUTHOR
+REPORTING BUGS
+COPYRIGHT
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+msggrep - pattern matching on message catalog

+ +

SYNOPSIS

+ + + +

+lt-msggrep [OPTION] +[INPUTFILE]

+ +

DESCRIPTION

+ + + +

+Extracts all messages of a translation catalog that match a +given pattern or belong to some given source +files.

+ + + +

+Mandatory arguments to long options are mandatory for short +options too.

+ + + +

+Input file location:

+ + + +

+INPUTFILE

+ + + +

+input PO file

+ + + +

+-D, --directory=DIRECTORY

+ + + +

+add DIRECTORY to list for input files search

+ + + +

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

+ + + +

+Output file location:

+ + + +

+-o, --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 -.

+ + + +

+Message selection:

+ + + +

+[-N SOURCEFILE]... [-M DOMAINNAME]... [-K MSGID-PATTERN] [-T +MSGSTR-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. +PATTERNs are basic regular expressions by default, or +extended regular expressions if -E is given, or fixed +strings if -F is given.

+ + + +

+-N, --location=SOURCEFILE

+ + + +

+select messages extracted from SOURCEFILE

+ + + +

+-M, --domain=DOMAINNAME

+ + + +

+select messages belonging to domain DOMAINNAME

+ + + +

+-K, --msgid

+ + + +

+start of patterns for the msgid

+ + + +

+-T, --msgstr

+ + + +

+start of patterns for the msgstr

+ + + +

+-E, --extended-regexp

+ + + +

+PATTERN is an extended regular expression

+ + + +

+-F, --fixed-strings

+ + + +

+PATTERN is a set of newline-separated strings

+ + + +

+-e, --regexp=PATTERN

+ + + +

+use PATTERN as a regular expression

+ + + +

+-f, --file=FILE

+ + + +

+obtain PATTERN from FILE

+ + + +

+-i, --ignore-case

+ + + +

+ignore case distinctions

+ + + +

+Output details:

+ + + +

+--no-escape

+ + + +

+do not use C escapes in output (default)

+ + + +

+--escape

+ + + +

+use C escapes in output, no extended chars

+ + + +

+--force-po

+ + + +

+write PO file even if empty

+ + + +

+--indent

+ + + +

+indented output style

+ + + +

+--no-location

+ + + +

+suppress '#: filename:line' lines

+ + + +

+--add-location

+ + + +

+preserve '#: filename:line' lines (default)

+ + + +

+--strict

+ + + +

+strict Uniforum output style

+ + + +

+-w, --width=NUMBER

+ + + +

+set output page width

+ + + +

+--sort-output

+ + + +

+generate sorted output and remove duplicates

+ + + +

+--sort-by-file

+ + + +

+sort output by file location

+ + + +

+Informative output:

+ + + +

+-h, --help

+ + + +

+display this help and exit

+ + + +

+-V, --version

+ + + +

+output version information and exit

+ +

AUTHOR

+ + + +

+Written by Bruno Haible.

+ +

REPORTING BUGS

+ + + +

+Report bugs to <bug-gnu-utils@gnu.org>.

+ +

COPYRIGHT

+ + + +

+ +

MSGMERGE

+NAME
+SYNOPSIS
+DESCRIPTION
+AUTHOR
+REPORTING BUGS
+COPYRIGHT
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+msgmerge - merge message catalog and template

+ +

SYNOPSIS

+ + + +

+msgmerge [OPTION] def.po +ref.pot

+ +

DESCRIPTION

+ + + +

+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.

+ + + +

+Mandatory arguments to long options are mandatory for short +options too.

+ + + +

+Input file location:

+ + + +

+def.po

+ + + +

+translations referring to old sources

+ + + +

+ref.pot

+ + + +

+references to new sources

+ + + +

+-D, --directory=DIRECTORY

+ + + +

+add DIRECTORY to list for input files search

+ + + +

+-C, --compendium=FILE

+ + + +

+additional library of message translations, may be specified +more than once

+ + + +

+Output file location:

+ + + +

+-o, --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 -.

+ + + +

+Operation modifiers:

+ + + +

+-m, --multi-domain

+ + + +

+apply ref.pot to each of the domains in def.po

+ + + +

+Output details:

+ + + +

+-e, --no-escape

+ + + +

+do not use C escapes in output (default)

+ + + +

+-E, --escape

+ + + +

+use C escapes in output, no extended chars

+ + + +

+--force-po

+ + + +

+write PO file even if empty

+ + + +

+-i, --indent

+ + + +

+indented output style

+ + + +

+--no-location

+ + + +

+suppress '#: filename:line' lines

+ + + +

+--add-location

+ + + +

+preserve '#: filename:line' lines (default)

+ + + +

+--strict

+ + + +

+strict Uniforum output style

+ + + +

+-w, --width=NUMBER

+ + + +

+set output page width

+ + + +

+-s, --sort-output

+ + + +

+generate sorted output and remove duplicates

+ + + +

+-F, --sort-by-file

+ + + +

+sort output by file location

+ + + +

+Informative output:

+ + + +

+-h, --help

+ + + +

+display this help and exit

+ + + +

+-V, --version

+ + + +

+output version information and exit

+ + + +

+-v, --verbose

+ + + +

+increase verbosity level

+ + + +

+-q, --quiet, --silent

+ + + +

+suppress progress indicators

+ +

AUTHOR

+ + + +

+Written by Peter Miller.

+ +

REPORTING BUGS

+ + + +

+Report bugs to <bug-gnu-utils@gnu.org>.

+ +

COPYRIGHT

+ + + +

+ +

LT-MSGSED

+NAME
+SYNOPSIS
+DESCRIPTION
+AUTHOR
+REPORTING BUGS
+COPYRIGHT
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+msgsed - stream editing of message catalog

+ +

SYNOPSIS

+ + + +

+lt-msgsed [OPTION] +[INPUTFILE]

+ +

DESCRIPTION

+ + + +

+Applies a sed script to all translations of a translation +catalog.

+ + + +

+Mandatory arguments to long options are mandatory for short +options too.

+ + + +

+Input file location:

+ + + +

+INPUTFILE

+ + + +

+input PO file

+ + + +

+-D, --directory=DIRECTORY

+ + + +

+add DIRECTORY to list for input files search

+ + + +

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

+ + + +

+Output file location:

+ + + +

+-o, --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 -.

+ + + +

+Sed options:

+ + + +

+-e, --expression=SCRIPT

+ + + +

+add SCRIPT to the commands to be executed

+ + + +

+-f, --file=SCRIPTFILE

+ + + +

+add the contents of SCRIPTFILE to the commands to be +executed

+ + + +

+-n, --quiet, --silent

+ + + +

+suppress automatic printing of pattern space

+ + + +

+Output details:

+ + + +

+--no-escape

+ + + +

+do not use C escapes in output (default)

+ + + +

+-E, --escape

+ + + +

+use C escapes in output, no extended chars

+ + + +

+--force-po

+ + + +

+write PO file even if empty

+ + + +

+-i, --indent

+ + + +

+indented output style

+ + + +

+--no-location

+ + + +

+suppress '#: filename:line' lines

+ + + +

+--add-location

+ + + +

+preserve '#: filename:line' lines (default)

+ + + +

+--strict

+ + + +

+strict Uniforum output style

+ + + +

+-w, --width=NUMBER

+ + + +

+set output page width

+ + + +

+-s, --sort-output

+ + + +

+generate sorted output and remove duplicates

+ + + +

+-F, --sort-by-file

+ + + +

+sort output by file location

+ + + +

+Informative output:

+ + + +

+-h, --help

+ + + +

+display this help and exit

+ + + +

+-V, --version

+ + + +

+output version information and exit

+ +

AUTHOR

+ + + +

+Written by Bruno Haible.

+ +

REPORTING BUGS

+ + + +

+Report bugs to <bug-gnu-utils@gnu.org>.

+ +

COPYRIGHT

+ + + +

+ +

MSGUNFMT

+NAME
+SYNOPSIS
+DESCRIPTION
+AUTHOR
+REPORTING BUGS
+COPYRIGHT
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+msgunfmt - uncompile message catalog from binary format

+ +

SYNOPSIS

+ + + +

+msgunfmt [OPTION] +[FILE]...

+ +

DESCRIPTION

+ + + +

+Convert binary message catalog to Uniforum style .po +file.

+ + + +

+Mandatory arguments to long options are mandatory for short +options too.

+ + + +

+Input file location:

+ + + +

+FILE ...

+ + + +

+input .mo files

+ + + +

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

+ + + +

+Output file location:

+ + + +

+-o, --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 -.

+ + + +

+Output details:

+ + + +

+-e, --no-escape

+ + + +

+do not use C escapes in output (default)

+ + + +

+-E, --escape

+ + + +

+use C escapes in output, no extended chars

+ + + +

+--force-po

+ + + +

+write PO file even if empty

+ + + +

+-i, --indent

+ + + +

+write indented output style

+ + + +

+--strict

+ + + +

+write strict uniforum style

+ + + +

+-w, --width=NUMBER

+ + + +

+set output page width

+ + + +

+-s, --sort-output

+ + + +

+generate sorted output and remove duplicates

+ + + +

+Informative output:

+ + + +

+-h, --help

+ + + +

+display this help and exit

+ + + +

+-V, --version

+ + + +

+output version information and exit

+ +

AUTHOR

+ + + +

+Written by Ulrich Drepper.

+ +

REPORTING BUGS

+ + + +

+Report bugs to <bug-gnu-utils@gnu.org>.

+ +

COPYRIGHT

+ + + +

+ +

NGETTEXT

+NAME
+SYNOPSIS
+DESCRIPTION
+AUTHOR
+REPORTING BUGS
+COPYRIGHT
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+ngettext - translate message and choose plural form

+ +

SYNOPSIS

+ + + +

+ngettext [OPTION] [TEXTDOMAIN] MSGID +MSGID-PLURAL COUNT

+ +

DESCRIPTION

+ + + +

+The ngettext program translates a natural language +message into the user's language, by looking up the +translation in a message catalog, and chooses the +appropriate plural form, which depends on the number +COUNT and the language of the message catalog where +the translation was found.

+ + + +

+Display native language translation of a textual message +whose grammatical form depends on a number.

+ + + +

+-d, --domain=TEXTDOMAIN

+ + + +

+retrieve translated message from TEXTDOMAIN

+ + + +

+-e

+ + + +

+enable expansion of some escape sequences

+ + + +

+-E

+ + + +

+(ignored for compatibility)

+ + + +

+-h, --help

+ + + +

+display this help and exit

+ + + +

+-V, --version

+ + + +

+display version information and exit

+ + + +

+[TEXTDOMAIN]

+ + + +

+retrieve translated message from TEXTDOMAIN

+ + + +

+MSGID MSGID-PLURAL

+ + + +

+translate MSGID (singular) / MSGID-PLURAL +(plural)

+ + + +

+COUNT

+ + + +

+choose singular/plural form based on this value

+ + + +

+ +

AUTHOR

+ + + +

+Written by Ulrich Drepper.

+ +

REPORTING BUGS

+ + + +

+Report bugs to <bug-gnu-utils@gnu.org>.

+ +

COPYRIGHT

+ + + +

+ +

NGETTEXT

+NAME
+SYNOPSIS
+DESCRIPTION
+RETURN VALUE
+ERRORS
+BUGS
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+ngettext, dngettext, dcngettext - translate message and choose plural form

+ +

SYNOPSIS

+ + + +

#include <libintl.h>
+
+char * ngettext (const char * msgid, const char * msgid_plural,
+                 unsigned long int n);
+char * dngettext (const char * domainname,
+                  const char * msgid, const char * msgid_plural,
+                  unsigned long int n);
+char * dcngettext (const char * domainname,
+                   const char * msgid, const char * msgid_plural,
+                   unsigned long int n, int category);
+

+ +

DESCRIPTION

+ + + +

+The ngettext, dngettext and dcngettext +functions attempt to translate a text string into the user's +native language, by looking up the appropriate plural form +of the translation in a message catalog.

+ + + +

+Plural forms are grammatical variants depending on the a +number. Some languages have two forms, called singular and +plural. Other languages have three forms, called singular, +dual and plural. There are also languages with four +forms.

+ + + +

+The ngettext, dngettext and dcngettext +functions work like the gettext, dgettext and +dcgettext functions, respectively. Additionally, they +choose the appropriate plural form, which depends on the +number n and the language of the message catalog +where the translation was found.

+ + + +

+In the "C" locale, or if none of the used catalogs +contain a translation for msgid, the ngettext, +dngettext and dcngettext functions return +msgid if n == 1, or msgid_plural if +n != 1.

+ +

RETURN VALUE

+ + + +

+If a translation was found in one of the specified catalogs, +the appropriate plural form is converted to the locale's +codeset and returned. The resulting string is statically +allocated and must not be modified or freed. Otherwise +msgid or msgid_plural is returned, as +described above.

+ +

ERRORS

+ + + +

+errno is not modified.

+ +

BUGS

+ + + +

+The return type ought to be const char *, but is +char * to avoid warnings in C code predating ANSI +C.

+ +

TEXTDOMAIN

+NAME
+SYNOPSIS
+DESCRIPTION
+RETURN VALUE
+ERRORS
+BUGS
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+textdomain - set domain for future gettext() calls

+ +

SYNOPSIS

+ + + +

#include <libintl.h>
+
+char * textdomain (const char * domainname);
+

+ +

DESCRIPTION

+ + + +

+The textdomain function sets or retrieves the current +message domain.

+ + + +

+The current message domain is used by the gettext, +ngettext functions, and by the dgettext, +dcgettext, dngettext and dcngettext +functions when called with a NULL domainname +argument.

+ + + +

+If domainname is not NULL, the current message domain +is set to domainname. The string the function stores +internally is a copy of the domainname +argument.

+ + + +

+If domainname is NULL, the function returns the +current message domain.

+ +

RETURN VALUE

+ + + +

+If successful, the textdomain function returns the +current message domain, after possibly changing it. The +resulting string is valid until the next textdomain +call and must not be modified or freed. If a memory +allocation failure occurs, it sets errno to +ENOMEM and returns NULL.

+ +

ERRORS

+ + + +

+The following error can occur, among others:

+ + + +

+ENOMEM

+ + + +

+Not enough memory available.

+ +

BUGS

+ + + +

+The return type ought to be const char *, but is +char * to avoid warnings in C code predating ANSI +C.

+ +

XGETTEXT

+NAME
+SYNOPSIS
+DESCRIPTION
+AUTHOR
+REPORTING BUGS
+COPYRIGHT
+SEE ALSO
+ +

+ + + +

NAME

+ + +

+xgettext - extract gettext strings from source

+ +

SYNOPSIS

+ + + +

+xgettext [OPTION] +[INPUTFILE]...

+ +

DESCRIPTION

+ + + +

+Extract translatable strings from given input +files.

+ + + +

+Mandatory arguments to long options are mandatory for short +options too. Similarly for optional arguments.

+ + + +

+Input file location:

+ + + +

+INPUTFILE ...

+ + + +

+input files

+ + + +

+-f, --files-from=FILE

+ + + +

+get list of input files from FILE

+ + + +

+-D, --directory=DIRECTORY

+ + + +

+add DIRECTORY to list for input files search

+ + + +

+If input file is -, standard input is read.

+ + + +

+Output file location:

+ + + +

+-d, --default-domain=NAME

+ + + +

+use NAME.po for output (instead of messages.po)

+ + + +

+-o, --output=FILE

+ + + +

+write output to specified file

+ + + +

+-p, --output-dir=DIR

+ + + +

+output files will be placed in directory DIR

+ + + +

+If output file is -, output is written to standard +output.

+ + + +

+Choice of input file language:

+ + + +

+-L, --language=NAME

+ + + +

+recognise the specified language (C, C++, PO)

+ + + +

+-C, --c++

+ + + +

+shorthand for --language=C++

+ + + +

+By default the language is guessed depending on the input +file name extension.

+ + + +

+Operation mode:

+ + + +

+-j, --join-existing

+ + + +

+join messages with existing file

+ + + +

+-x, --exclude-file=FILE.po

+ + + +

+entries from FILE.po are not extracted

+ + + +

+-c, --add-comments[=TAG]

+ + + +

+place comment block with TAG (or those preceding keyword +lines) in output file

+ + + +

+Language=C/C++ specific options:

+ + + +

+-a, --extract-all

+ + + +

+extract all strings

+ + + +

+-k, --keyword[=WORD]

+ + + +

+additional keyword to be looked for (without WORD means not +to use default keywords)

+ + + +

+-T, --trigraphs

+ + + +

+understand ANSI C trigraphs for input

+ + + +

+--debug

+ + + +

+more detailed formatstring recognition result

+ + + +

+Output details:

+ + + +

+-e, --no-escape

+ + + +

+do not use C escapes in output (default)

+ + + +

+-E, --escape

+ + + +

+use C escapes in output, no extended chars

+ + + +

+--force-po

+ + + +

+write PO file even if empty

+ + + +

+-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 strict Uniforum conforming .po file

+ + + +

+-w, --width=NUMBER

+ + + +

+set output page width

+ + + +

+-s, --sort-output

+ + + +

+generate sorted output and remove duplicates

+ + + +

+-F, --sort-by-file

+ + + +

+sort output by file location

+ + + +

+--omit-header

+ + + +

+don't write header with `msgid ""' +entry

+ + + +

+--foreign-user

+ + + +

+omit FSF copyright in output for foreign user

+ + + +

+-m, +--msgstr-prefix[=STRING]

+ + + +

+use STRING or "" as prefix for msgstr +entries

+ + + +

+-M, +--msgstr-suffix[=STRING]

+ + + +

+use STRING or "" as suffix for msgstr +entries

+ + + +

+Informative output:

+ + + +

+-h, --help

+ + + +

+display this help and exit

+ + + +

+-V, --version

+ + + +

+output version information and exit

+ +

AUTHOR

+ + + +

+Written by Ulrich Drepper.

+ +

REPORTING BUGS

+ + + +

+Report bugs to <bug-gnu-utils@gnu.org>.

+ +

COPYRIGHT

+ + + +

+ +