doc/commands/LocalePath.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   3   "../docbook-xml/docbookx.dtd"
   4 [
   5 <!ENTITY % myents SYSTEM "../fvwm.ent" >
   6 %myents;
   7 ]>
   8
   9 <!-- $Id: LocalePath.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='LocalePath'>
  12 <title>LocalePath</title>
  13
  14 <cmdsynopsis>
  15         <command>LocalePath</command
  16         ><arg choice='plain'
  17                 ><replaceable>path</replaceable
  18         ></arg>
  19 </cmdsynopsis>
  20
  21 <para>Specifies a colon separated list of "locale path" in which to
  22 search for string translations. A locale path is constituted by a
  23 directory path and a text domain separated by a semicolon
  24 (';'). As an example the default locale path is:</para>
  25
  26 <programlisting>
  27 /install_prefix/share/locale;fvwm
  28 </programlisting>
  29
  30 <para>where install_prefix is the fvwm installation directory. With such
  31 a locale path translations are searched for in</para>
  32
  33 <programlisting>
  34 /install_prefix/share/locale/lang/LC_MESSAGES/fvwm.mo
  35 </programlisting>
  36
  37 <para>where
  38 <emphasis remap='I'>lang</emphasis>
  39 depends on the locale. If no directory is given the default
  40 directory path is assumed. If no text domain is given,
  41 <command>fvwm</command>
  42 is assumed. Without argument the default locale path is restored.</para>
  43
  44 <para>As for the
  45 <fvwmref cmd="ImagePath"/>
  46 command,
  47 <replaceable>path</replaceable>
  48 may contain environment variables and a '+' to append or prepend
  49 the locale path easily.</para>
  50
  51 <para>For example, the fvwm-themes package uses</para>
  52
  53 <programlisting>
  54 LocalePath ";fvwm-themes:+"
  55 </programlisting>
  56
  57 <para>to add locale catalogs.</para>
  58
  59 <para>The default fvwm catalog contains a few strings used by the fvwm
  60 executable itself (Desk and Geometry) and strings used in some
  61 default configuration files and
  62 <fvwmref mod="FvwmForm"/>
  63 configuration. You can take a look at the po/ subdirectory of the
  64 fvwm source to get the list of the strings with a possible
  65 translation in various languages. At present, very few languages
  66 are supported.</para>
  67
  68 <para>The main use of locale catalogs is via the "$[gt.string]"
  69 parameter:</para>
  70
  71 <programlisting>
  72 <fvwmref cmd="DestroyMenu"/> MenuFvwmWindowOps
  73 <fvwmref cmd="AddToMenu"/>   MenuFvwmWindowOps "$[gt.Window Ops]" <fvwmref cmd="Title"/>
  74 + "$[gt.&amp;Move]"              <fvwmref cmd="Move"/>
  75 + "$[gt.&amp;Resize]"            <fvwmref cmd="Resize"/>
  76 + "$[gt.R&amp;aise]"             <fvwmref cmd="Raise"/>
  77 + "$[gt.&amp;Lower]"             <fvwmref cmd="Lower"/>
  78 + "$[gt.(De)&amp;Iconify]"       <fvwmref cmd="Iconify"/>
  79 + "$[gt.(Un)&amp;Stick]"         <fvwmref cmd="Stick"/>
  80 + "$[gt.(Un)Ma&amp;ximize]"      <fvwmref cmd="Maximize"/>
  81 + "" <fvwmref cmd="Nop"/>
  82 + "$[gt.&amp;Close]"             <fvwmref cmd="Close"/>
  83 + "$[gt.&amp;Destroy]"           <fvwmref cmd="Destroy"/>
  84 </programlisting>
  85
  86 <para>gives a menu in the locale languages if translations are
  87 available.</para>
  88
  89 <para>Note that the
  90 <fvwmref mod="FvwmTaskBar"/>
  91 module has its own catalog and that the
  92 <fvwmref mod="FvwmScript"/>
  93 module has a set of special instructions for string
  94 translation. It is out of the scope of this discussion to explain
  95 how to build locale catalogs. Please refer to the <acronym>GNU</acronym> gettext
  96 documentation.</para>
  97
  98 </section>