'\" t
.\"     Title: OCAML-GETTEXT
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 2008-04-29
.\"    Manual: [FIXME: manual]
.\"    Source: ocaml-gettext
.\"  Language: English
.\"
.TH "OCAML\-GETTEXT" "5" "2008\-04\-29" "ocaml-gettext" "[FIXME: manual]"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocaml-gettext \- common options to manage internationalisation in OCaml program through ocaml\-gettext library\&.
.SH "SYNOPSIS"
.HP \w'\ 'u
[\-\-gettext\-failsafe\ 
.br
[{ignore}\ |\ {inform\-stderr}\ |\ {raise\-exception}]]
.br
[\-\-gettext\-disable] [\-\-gettext\-domain\-dir\ {\fItextdomain\fR}\ {\fIdir\fR}]
.br
[\-\-gettext\-dir\ {\fIdir\fR}]
.br
[\-\-gettext\-language\ {\fIlanguage\fR}]
.br
[\-\-gettext\-codeset\ {\fIcodeset\fR}]
.br

.SH "OCAML\-GETTEXT OPTIONS"
.PP
This section describes briefly the common options provided by programs using ocaml\-gettext library\&.
.PP
\fB\-\-gettext\-failsafe ignore\fR
.RS 4
Defines the behaviour of ocaml\-gettext regarding any error that could be encountered during the processing of string translation\&.
\fBignore\fR
is the default behaviour\&. The string returned is the original string untranslated\&. This behaviour is consistent and allows to have a usable output, even if it is not perfect\&.
.RE
.PP
\fB\-\-gettext\-failsafe inform\-stderr\fR
.RS 4
Same behaviour as
\fBignore\fR, except that a message is printed on stderr,
.RE
.PP
\fB\-\-gettext\-failsafe raise\-exception\fR
.RS 4
Stops the program by raising an exception when an error is encountered\&.
.RE
.PP
\fB\-\-gettext\-disable\fR
.RS 4
Disables any translation made by ocaml\-gettext\&. All translations return the original string untranslated\&.
.RE
.PP
\fB\-\-gettext\-domain\-dir \fR\fB\fItextdomain\fR\fR\fB \fR\fB\fIdir\fR\fR\fB \fR
.RS 4
Defines a dir to search for a specific domain\&. This could be useful if MO files are stored in a non standard directory\&.
.RE
.PP
\fB\-\-gettext\-dir \fR\fB\fIdir\fR\fR
.RS 4
Adds a directory to search for MO files\&.
.RE
.PP
\fB\-\-gettext\-language \fR\fB\fIlanguage\fR\fR
.RS 4
Sets the language to use in ocaml\-gettext library\&. The language should be POSIX compliant\&. The language should follow the following convention: lang[_territory][\&.charset][@modifier]\&. The lang and territory should be two letters ISO code\&. Charset should be a valid ISO character set (at least recognised by the underlying charset recoding routine)\&. For example, valid languages are: fr_FR\&.ISO\-8859\-1@euro, de_DE\&.UTF\-8\&.
.RE
.PP
\fB\-\-gettext\-codeset \fR\fB\fIcodeset\fR\fR
.RS 4
Sets the codeset for output\&.
.RE
.PP
Users should be aware that these command line options, apply only for strings after the initialisation of the library\&. This means that if the options initially guessed by ocaml\-gettext don\*(Aqt match the command line provided, there should be some untranslated string, because these strings are translated before parsing options\&. This is particularly true for the usage message itself (\fB\-\-help\fR): even if the strings are translated, they are translated before setting the correct option\&.
.PP
Some options (\fB\-\-gettext\-codeset\fR
for example) are overrided internally for particular use\&. It should be required to always translate strings to UTF\-8 in graphical user interface (because GTK2 requires it)\&.