Automatically generated.

author: Bruno Haible <bruno@clisp.org> 2003-02-17 21:28:16 +0000
committer: Bruno Haible <bruno@clisp.org> 2009-06-23 12:10:09 +0200
commit: 20b6d01237b2d514ab49527d171c0c31d376ef15 (patch)
tree: 60b1acea83f16975ffedb71ea08b4b0b924b07bd /gettext-runtime/man/gettext.3.html
parent: 3517cf98eaa5aebd0f58383d398fe42a09cb8518 (diff)
download: external_gettext-20b6d01237b2d514ab49527d171c0c31d376ef15.zip
external_gettext-20b6d01237b2d514ab49527d171c0c31d376ef15.tar.gz
external_gettext-20b6d01237b2d514ab49527d171c0c31d376ef15.tar.bz2
1 files changed, 191 insertions, 0 deletions
diff --git a/gettext-runtime/man/gettext.3.html b/gettext-runtime/man/gettext.3.html
new file mode 100644
index 0000000..889251b
--- /dev/null
+++ b/gettext-runtime/man/gettext.3.html
@@ -0,0 +1,191 @@
+<html>
+<head>
+<meta name="generator" content="groff -Thtml, see www.gnu.org">
+<meta name="Content-Style" content="text/css">
+<title>GETTEXT</title>
+</head>
+<body>
+
+<h1 align=center>GETTEXT</h1>
+<a href="#NAME">NAME</a><br>
+<a href="#SYNOPSIS">SYNOPSIS</a><br>
+<a href="#DESCRIPTION">DESCRIPTION</a><br>
+<a href="#RETURN VALUE">RETURN VALUE</a><br>
+<a href="#ERRORS">ERRORS</a><br>
+<a href="#BUGS">BUGS</a><br>
+<a href="#SEE ALSO">SEE ALSO</a><br>
+
+<hr>
+<!-- Creator     : groff version 1.17 -->
+<a name="NAME"></a>
+<h2>NAME</h2>
+<table width="100%" border=0 rules="none" frame="void"
+       cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="10%"></td><td width="90%">
+gettext, dgettext, dcgettext - translate message</td></table>
+<a name="SYNOPSIS"></a>
+<h2>SYNOPSIS</h2>
+
+<table width="100%" border=0 rules="none" frame="void"
+       cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="10%"></td><td width="90%">
+<pre><b>#include &lt;libintl.h&gt;
+
+char * gettext (const char *</b> <i>msgid</i><b>);
+char * dgettext (const char *</b> <i>domainname</i><b>, const char *</b> <i>msgid</i><b>);
+char * dcgettext (const char *</b> <i>domainname</i><b>, const char *</b> <i>msgid</i><b>,
+                  int</b> <i>category</i><b>);
+</b></pre></td></table>
+<a name="DESCRIPTION"></a>
+<h2>DESCRIPTION</h2>
+
+<table width="100%" border=0 rules="none" frame="void"
+       cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="10%"></td><td width="90%">
+The <b>gettext</b>, <b>dgettext</b> and <b>dcgettext</b>
+functions attempt to translate a text string into the user's
+native language, by looking up the translation in a message
+catalog.</td></table>
+
+<table width="100%" border=0 rules="none" frame="void"
+       cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="10%"></td><td width="90%">
+The <i>msgid</i> 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 <b>msgfmt</b>
+utility.</td></table>
+
+<table width="100%" border=0 rules="none" frame="void"
+       cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="10%"></td><td width="90%">
+A message domain is a set of translatable <i>msgid</i>
+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 <b>gettext</b> function, it
+is specified through a preceding <b>textdomain</b> call. For
+the <b>dgettext</b> and <b>dcgettext</b> functions, it is
+passed as the <i>domainname</i> argument; if this argument
+is NULL, the domain name specified through a preceding
+<b>textdomain</b> call is used instead.</td></table>
+
+<table width="100%" border=0 rules="none" frame="void"
+       cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="10%"></td><td width="90%">
+Translation lookup operates in the context of the current
+locale. For the <b>gettext</b> and <b>dgettext</b>
+functions, the <b>LC_MESSAGES</b> locale facet is used. It
+is determined by a preceding call to the <b>setlocale</b>
+function. <b>setlocale(LC_ALL,&quot;&quot;)</b> initializes
+the <b>LC_MESSAGES</b> locale based on the first nonempty
+value of the three environment variables <b>LC_ALL</b>,
+<b>LC_MESSAGES</b>, <b>LANG</b>; see <b>setlocale</b>(3).
+For the <b>dcgettext</b> function, the locale facet is
+determined by the <i>category</i> argument, which should be
+one of the <b>LC_xxx</b> constants defined in the
+&lt;locale.h&gt; header, excluding <b>LC_ALL</b>. In both
+cases, the functions also use the <b>LC_CTYPE</b> 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
+<b>bind_textdomain_codeset</b> function.</td></table>
+
+<table width="100%" border=0 rules="none" frame="void"
+       cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="10%"></td><td width="90%">
+The message catalog used by the functions is at the pathname
+<i>dirname</i>/<i>locale</i>/<i>category</i>/<i>domainname</i>.mo.
+Here <i>dirname</i> is the directory specified through
+<b>bindtextdomain</b>. Its default is system and
+configuration dependent; typically it is
+<i>prefix</i>/share/locale, where <i>prefix</i> is the
+installation prefix of the package. <i>locale</i> is the
+name of the current locale facet; the GNU implementation
+also tries generalizations, such as the language name
+without the territory name. <i>category</i> is
+<b>LC_MESSAGES</b> for the <b>gettext</b> and
+<b>dgettext</b> functions, or the argument passed to the
+<b>dcgettext</b> function.</td></table>
+
+<table width="100%" border=0 rules="none" frame="void"
+       cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="10%"></td><td width="90%">
+If the <b>LANGUAGE</b> environment variable is set to a
+nonempty value, and the locale is not the &quot;C&quot;
+locale, the value of <b>LANGUAGE</b> is assumed to contain a
+colon separated list of locale names. The functions will
+attempt to look up a translation of <i>msgid</i> in each of
+the locales in turn. This is a GNU extension.</td></table>
+
+<table width="100%" border=0 rules="none" frame="void"
+       cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="10%"></td><td width="90%">
+In the &quot;C&quot; locale, or if none of the used catalogs
+contain a translation for <i>msgid</i>, the <b>gettext</b>,
+<b>dgettext</b> and <b>dcgettext</b> functions return
+<i>msgid</i>.</td></table>
+<a name="RETURN VALUE"></a>
+<h2>RETURN VALUE</h2>
+
+<table width="100%" border=0 rules="none" frame="void"
+       cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="10%"></td><td width="90%">
+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 <i>msgid</i> is
+returned.</td></table>
+<a name="ERRORS"></a>
+<h2>ERRORS</h2>
+
+<table width="100%" border=0 rules="none" frame="void"
+       cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="10%"></td><td width="90%">
+<b>errno</b> is not modified.</td></table>
+<a name="BUGS"></a>
+<h2>BUGS</h2>
+
+<table width="100%" border=0 rules="none" frame="void"
+       cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="10%"></td><td width="90%">
+The return type ought to be <b>const char *</b>, but is
+<b>char *</b> to avoid warnings in C code predating ANSI
+C.</td></table>
+
+<table width="100%" border=0 rules="none" frame="void"
+       cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="10%"></td><td width="90%">
+When an empty string is used for <i>msgid</i>, the functions
+may return a nonempty string.</td></table>
+<a name="SEE ALSO"></a>
+<h2>SEE ALSO</h2>
+
+<table width="100%" border=0 rules="none" frame="void"
+       cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="10%"></td><td width="90%">
+<b>ngettext</b>(3), <b>dngettext</b>(3),
+<b>dcngettext</b>(3), <b>setlocale</b>(3),
+<b>textdomain</b>(3), <b>bindtextdomain</b>(3),
+<b>bind_textdomain_codeset</b>(3),
+<b>msgfmt</b>(1)</td></table>
+<hr>
+</body>
+</html>
author	Bruno Haible <bruno@clisp.org>	2003-02-17 21:28:16 +0000
committer	Bruno Haible <bruno@clisp.org>	2009-06-23 12:10:09 +0200
commit	20b6d01237b2d514ab49527d171c0c31d376ef15 (patch)
tree	60b1acea83f16975ffedb71ea08b4b0b924b07bd /gettext-runtime/man/gettext.3.html
parent	3517cf98eaa5aebd0f58383d398fe42a09cb8518 (diff)
download	external_gettext-20b6d01237b2d514ab49527d171c0c31d376ef15.zip external_gettext-20b6d01237b2d514ab49527d171c0c31d376ef15.tar.gz external_gettext-20b6d01237b2d514ab49527d171c0c31d376ef15.tar.bz2