+++ /dev/null
-.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
-.\"
-.\" 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.6-pre2"
-.SH NAME
-bind_textdomain_codeset \- set encoding of message translations
-.SH SYNOPSIS
-.nf
-.B #include <libintl.h>
-.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)
+++ /dev/null
-.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
-.\"
-.\" 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 BINDTEXTDOMAIN 3 "May 2001" "GNU gettext 0.11.6-pre2"
-.SH NAME
-bindtextdomain \- set directory containing message catalogs
-.SH SYNOPSIS
-.nf
-.B #include <libintl.h>
-.sp
-.BI "char * bindtextdomain (const char * " domainname ", const char * " dirname );
-.fi
-.SH DESCRIPTION
-The \fBbindtextdomain\fP function sets the base directory of the hierarchy
-containing message catalogs for a given message domain.
-.PP
-A message domain is a set of translatable \fImsgid\fP messages. Usually,
-every software package has its own message domain. The need for calling
-\fBbindtextdomain\fP arises because packages are not always installed with
-the same prefix as the <libintl.h> header and the libc/libintl libraries.
-.PP
-Message catalogs will be expected at the pathnames
-\fIdirname\fP/\fIlocale\fP/\fIcategory\fP/\fIdomainname\fP.mo,
-where \fIlocale\fP is a locale name and \fIcategory\fP is a locale facet such
-as \fBLC_MESSAGES\fP.
-.PP
-\fIdomainname\fP must be a non-empty string.
-.PP
-If \fIdirname\fP is not NULL, the base directory for message catalogs belonging
-to domain \fIdomainname\fP is set to \fIdirname\fP. The function makes copies
-of the argument strings as needed. If the program wishes to call the
-\fBchdir\fP function, it is important that \fIdirname\fP be an absolute
-pathname; otherwise it cannot be guaranteed that the message catalogs will
-be found.
-.PP
-If \fIdirname\fP is NULL, the function returns the previously set base
-directory for domain \fIdomainname\fP.
-.SH "RETURN VALUE"
-If successful, the \fBbindtextdomain\fP function returns the current base
-directory for domain \fIdomainname\fP, after possibly changing it. The
-resulting string is valid until the next \fBbindtextdomain\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.
-.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 realpath (3)
+++ /dev/null
-.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
-.\"
-.\" 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 GETTEXT 3 "May 2001" "GNU gettext 0.11.6-pre2"
-.SH NAME
-gettext, dgettext, dcgettext \- translate message
-.SH SYNOPSIS
-.nf
-.B #include <libintl.h>
-.sp
-.BI "char * gettext (const char * " msgid );
-.BI "char * dgettext (const char * " domainname ", const char * " msgid );
-.BI "char * dcgettext (const char * " domainname ", const char * " msgid ,
-.BI " int " category );
-.fi
-.SH DESCRIPTION
-The \fBgettext\fP, \fBdgettext\fP and \fBdcgettext\fP functions attempt to
-translate a text string into the user's native language, by looking up the
-translation in a message catalog.
-.PP
-The \fImsgid\fP 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 \fBmsgfmt\fP utility.
-.PP
-A message domain is a set of translatable \fImsgid\fP 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 \fBgettext\fP function, it is specified through
-a preceding \fBtextdomain\fP call. For the \fBdgettext\fP and \fBdcgettext\fP
-functions, it is passed as the \fIdomainname\fP argument; if this argument is
-NULL, the domain name specified through a preceding \fBtextdomain\fP call is
-used instead.
-.PP
-Translation lookup operates in the context of the current locale. For the
-\fBgettext\fP and \fBdgettext\fP functions, the \fBLC_MESSAGES\fP locale
-facet is used. It is determined by a preceding call to the \fBsetlocale\fP
-function. \fBsetlocale(LC_ALL,"")\fP initializes the \fBLC_MESSAGES\fP locale
-based on the first nonempty value of the three environment variables
-\fBLC_ALL\fP, \fBLC_MESSAGES\fP, \fBLANG\fP; see \fBsetlocale\fP(3). For the
-\fBdcgettext\fP function, the locale facet is determined by the \fIcategory\fP
-argument, which should be one of the \fBLC_xxx\fP constants defined in the
-<locale.h> header, excluding \fBLC_ALL\fP. In both cases, the functions also
-use the \fBLC_CTYPE\fP 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 \fBbind_textdomain_codeset\fP function.
-.PP
-The message catalog used by the functions is at the pathname
-\fIdirname\fP/\fIlocale\fP/\fIcategory\fP/\fIdomainname\fP.mo. Here
-\fIdirname\fP is the directory specified through \fBbindtextdomain\fP. Its
-default is system and configuration dependent; typically it is
-\fIprefix\fP/share/locale, where \fIprefix\fP is the installation prefix of the
-package. \fIlocale\fP is the name of the current locale facet; the GNU
-implementation also tries generalizations, such as the language name without
-the territory name. \fIcategory\fP is \fBLC_MESSAGES\fP for the \fBgettext\fP
-and \fBdgettext\fP functions, or the argument passed to the \fBdcgettext\fP
-function.
-.PP
-If the \fBLANGUAGE\fP environment variable is set to a nonempty value, and the
-locale is not the "C" locale, the value of \fBLANGUAGE\fP is assumed to contain
-a colon separated list of locale names. The functions will attempt to look up
-a translation of \fImsgid\fP in each of the locales in turn. This is a GNU
-extension.
-.PP
-In the "C" locale, or if none of the used catalogs contain a translation for
-\fImsgid\fP, the \fBgettext\fP, \fBdgettext\fP and \fBdcgettext\fP functions
-return \fImsgid\fP.
-.SH "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 \fImsgid\fP is returned.
-.SH ERRORS
-\fBerrno\fP is not modified.
-.SH BUGS
-The return type ought to be \fBconst char *\fP, but is \fBchar *\fP to avoid
-warnings in C code predating ANSI C.
-.PP
-When an empty string is used for \fImsgid\fP, the functions may return a
-nonempty string.
-.SH "SEE ALSO"
-.BR ngettext (3),
-.BR dngettext (3),
-.BR dcngettext (3),
-.BR setlocale (3),
-.BR textdomain (3),
-.BR bindtextdomain (3),
-.BR bind_textdomain_codeset (3),
-.BR msgfmt (1)
+++ /dev/null
-.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
-.\"
-.\" 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 NGETTEXT 3 "May 2001" "GNU gettext 0.11.6-pre2"
-.SH NAME
-ngettext, dngettext, dcngettext \- translate message and choose plural form
-.SH SYNOPSIS
-.nf
-.B #include <libintl.h>
-.sp
-.BI "char * ngettext (const char * " msgid ", const char * " msgid_plural ,
-.BI " unsigned long int " n );
-.BI "char * dngettext (const char * " domainname ,
-.BI " const char * " msgid ", const char * " msgid_plural ,
-.BI " unsigned long int " n );
-.BI "char * dcngettext (const char * " domainname ,
-.BI " const char * " msgid ", const char * " msgid_plural ,
-.BI " unsigned long int " n ", int " category );
-.fi
-.SH DESCRIPTION
-The \fBngettext\fP, \fBdngettext\fP and \fBdcngettext\fP 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.
-.PP
-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.
-.PP
-The \fBngettext\fP, \fBdngettext\fP and \fBdcngettext\fP functions work like
-the \fBgettext\fP, \fBdgettext\fP and \fBdcgettext\fP functions, respectively.
-Additionally, they choose the appropriate plural form, which depends on the
-number \fIn\fP and the language of the message catalog where the translation
-was found.
-.PP
-In the "C" locale, or if none of the used catalogs contain a translation for
-\fImsgid\fP, the \fBngettext\fP, \fBdngettext\fP and \fBdcngettext\fP functions
-return \fImsgid\fP if \fIn\fP == 1, or \fImsgid_plural\fP if \fIn\fP != 1.
-.SH "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
-\fImsgid\fP or \fImsgid_plural\fP is returned, as described above.
-.SH ERRORS
-\fBerrno\fP is not modified.
-.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)
+++ /dev/null
-.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
-.\"
-.\" 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 TEXTDOMAIN 3 "May 2001" "GNU gettext 0.11.6-pre2"
-.SH NAME
-textdomain \- set domain for future gettext() calls
-.SH SYNOPSIS
-.nf
-.B #include <libintl.h>
-.sp
-.BI "char * textdomain (const char * " domainname );
-.fi
-.SH DESCRIPTION
-The \fBtextdomain\fP function sets or retrieves the current message domain.
-.PP
-A message domain is a set of translatable \fImsgid\fP messages. Usually,
-every software package has its own message domain. The domain name is used
-to determine the message catalog where a translation is looked up; it must
-be a non-empty string.
-.PP
-The current message domain is used by the \fBgettext\fP, \fBngettext\fP
-functions, and by the \fBdgettext\fP, \fBdcgettext\fP, \fBdngettext\fP and
-\fBdcngettext\fP functions when called with a NULL domainname argument.
-.PP
-If \fIdomainname\fP is not NULL, the current message domain is set to
-\fIdomainname\fP. The string the function stores internally is a copy of the
-\fIdomainname\fP argument.
-.PP
-If \fIdomainname\fP is NULL, the function returns the current message domain.
-.SH "RETURN VALUE"
-If successful, the \fBtextdomain\fP function returns the current message
-domain, after possibly changing it. The resulting string is valid until the
-next \fBtextdomain\fP call and must not be modified or freed. If a memory
-allocation failure occurs, it sets \fBerrno\fP to \fBENOMEM\fP and 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 ngettext (3),
-.BR bindtextdomain (3),
-.BR bind_textdomain_codeset (3)
projects / thirdparty / gettext.git / commitdiff
