| 1 |
.\" Copyright (c) Bruno Haible <[email protected]> |
| 2 |
.\" |
| 3 |
.\" This is free documentation; you can redistribute it and/or |
| 4 |
.\" modify it under the terms of the GNU General Public License as |
| 5 |
.\" published by the Free Software Foundation; either version 2 of |
| 6 |
.\" the License, or (at your option) any later version. |
| 7 |
.\" |
| 8 |
.\" References consulted: |
| 9 |
.\" GNU glibc-2 source code and manual |
| 10 |
.\" GNU gettext source code and manual |
| 11 |
.\" LI18NUX 2000 Globalization Specification |
| 12 |
.\" |
| 13 |
.TH TEXTDOMAIN 3 "May 2001" "GNU gettext 0.26" |
| 14 |
.SH NAME |
| 15 |
textdomain \- set domain for future gettext() calls |
| 16 |
.SH SYNOPSIS |
| 17 |
.nf |
| 18 |
.B #include <libintl.h> |
| 19 |
.sp |
| 20 |
.BI "char * textdomain (const char * " domainname ); |
| 21 |
.fi |
| 22 |
.SH DESCRIPTION |
| 23 |
The \fBtextdomain\fP function sets or retrieves the current message domain. |
| 24 |
.PP |
| 25 |
A message domain is a set of translatable \fImsgid\fP messages. Usually, |
| 26 |
every software package has its own message domain. The domain name is used |
| 27 |
to determine the message catalog where a translation is looked up; it must |
| 28 |
be a non-empty string. |
| 29 |
.PP |
| 30 |
The current message domain is used by the \fBgettext\fP, \fBngettext\fP |
| 31 |
functions, and by the \fBdgettext\fP, \fBdcgettext\fP, \fBdngettext\fP and |
| 32 |
\fBdcngettext\fP functions when called with a NULL domainname argument. |
| 33 |
.PP |
| 34 |
If \fIdomainname\fP is not NULL, the current message domain is set to |
| 35 |
\fIdomainname\fP. The string the function stores internally is a copy of the |
| 36 |
\fIdomainname\fP argument. |
| 37 |
.PP |
| 38 |
If \fIdomainname\fP is NULL, the function returns the current message domain. |
| 39 |
.SH "RETURN VALUE" |
| 40 |
If successful, the \fBtextdomain\fP function returns the current message |
| 41 |
domain, after possibly changing it. The resulting string is valid until the |
| 42 |
next \fBtextdomain\fP call and must not be modified or freed. If a memory |
| 43 |
allocation failure occurs, it sets \fBerrno\fP to \fBENOMEM\fP and returns |
| 44 |
NULL. |
| 45 |
.SH ERRORS |
| 46 |
The following error can occur, among others: |
| 47 |
.TP |
| 48 |
.B ENOMEM |
| 49 |
Not enough memory available. |
| 50 |
.SH BUGS |
| 51 |
The return type ought to be \fBconst char *\fP, but is \fBchar *\fP to avoid |
| 52 |
warnings in C code predating ANSI C. |
| 53 |
.SH "SEE ALSO" |
| 54 |
.BR gettext (3), |
| 55 |
.BR ngettext (3), |
| 56 |
.BR bindtextdomain (3), |
| 57 |
.BR bind_textdomain_codeset (3) |