1OCAML-GETTEXT(5)                                              OCAML-GETTEXT(5)
2
3
4

NAME

6       ocaml-gettext  - common options to manage internationalisation in OCaml
7       program through ocaml-gettext library.
8

SYNOPSIS

10       [--gettext-failsafe [{ignore} | {inform-stderr}  |  {raise-exception}]]
11       [--gettext-disable]  [--gettext-domain-dir  {textdomain} {dir}] [--get‐
12       text-dir  {dir}]  [--gettext-language  {language}]   [--gettext-codeset
13       {codeset}]
14

DESCRIPTION

16       This  section describes briefly the common options provided by programs
17       using ocaml-gettext library.
18
19       --gettext-failsafe ignore
20              Defines the behaviour of ocaml-gettext regarding any error  that
21              could  be  encountered  during the processing of string transla‐
22              tion.  ignore is the default behaviour.  The string returned  is
23              the  original string untranslated.  This behaviour is consistent
24              and allows to have a usable output, even if it is not perfect.
25
26       --gettext-failsafe inform-stderr
27              Same behaviour as ignore, except that a message  is  printed  on
28              stderr,
29
30       --gettext-failsafe raise-exception
31              Stops  the  program by raising an exception when an error is en‐
32              countered.
33
34       --gettext-disable
35              Disables any translation made by  ocaml-gettext.   All  transla‐
36              tions return the original string untranslated.
37
38       --gettext-domain-dir textdomain dir
39              Defines  a  dir  to search for a specific domain.  This could be
40              useful if MO files are stored in a non standard directory.
41
42       --gettext-dir dir
43              Adds a directory to search for MO files.
44
45       --gettext-language language
46              Sets the language to use in ocaml-gettext library.  The language
47              should  be POSIX compliant.  The language should follow the fol‐
48              lowing convention:  lang[_territory][.charset][@modifier].   The
49              lang  and  territory  should  be  two letters ISO code.  Charset
50              should be a valid ISO character set (at least recognised by  the
51              underlying  charset  recoding routine).  For example, valid lan‐
52              guages are: fr_FR.ISO-8859-1@euro, de_DE.UTF-8.
53
54       --gettext-codeset codeset
55              Sets the codeset for output.
56
57       Users should be aware that these command line options, apply  only  for
58       strings  after  the  initialisation of the library.  This means that if
59       the options initially guessed by ocaml-gettext don't match the  command
60       line  provided, there should be some untranslated string, because these
61       strings are translated before parsing options.   This  is  particularly
62       true  for  the  usage  message itself (--help): even if the strings are
63       translated, they are translated before setting the correct option.
64
65       Some options (--gettext-codeset for example) are  overrided  internally
66       for  particular use.  It should be required to always translate strings
67       to UTF-8 in graphical user interface (because GTK2 requires it).
68

AUTHORS

70       Sylvain Le Gall.
71
72
73
74                                  2008-04-29                  OCAML-GETTEXT(5)
Impressum