SCons/Tool/msgfmt.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
   4 SPDX-License-Identifier: MIT
   5 SPDX-FileType: DOCUMENTATION
   6
   7 This file is processed by the bin/SConsDoc.py module.
   8 -->
   9
  10 <!DOCTYPE sconsdoc [
  11 <!ENTITY % scons SYSTEM '../../doc/scons.mod'>
  12 %scons;
  13 <!ENTITY % builders-mod SYSTEM '../../doc/generated/builders.mod'>
  14 %builders-mod;
  15 <!ENTITY % functions-mod SYSTEM '../../doc/generated/functions.mod'>
  16 %functions-mod;
  17 <!ENTITY % tools-mod SYSTEM '../../doc/generated/tools.mod'>
  18 %tools-mod;
  19 <!ENTITY % variables-mod SYSTEM '../../doc/generated/variables.mod'>
  20 %variables-mod;
  21 ]>
  22
  23 <sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
  24           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  25           xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  26
  27 <tool name="msgfmt">
  28 <summary>
  29 <para>
  30 This scons tool is a part of scons &t-link-gettext; toolset. It provides scons
  31 interface to <command>msgfmt(1)</command> command, which generates binary
  32 message catalog (<literal>MO</literal>) from a textual translation description
  33 (<literal>PO</literal>).
  34 </para>
  35 </summary>
  36 <sets>
  37 <item>MOSUFFIX</item>
  38 <item>MSGFMT</item>
  39 <item>MSGFMTCOM</item>
  40 <item>MSGFMTCOMSTR</item>
  41 <item>MSGFMTFLAGS</item>
  42 <item>POSUFFIX</item>
  43 </sets>
  44 <uses>
  45 <item>LINGUAS_FILE</item>
  46 </uses>
  47 </tool>
  48
  49 <builder name="MOFiles">
  50 <summary>
  51 <para>
  52 This builder belongs to &t-link-msgfmt; tool. The builder compiles
  53 <literal>PO</literal> files to <literal>MO</literal> files.
  54 </para>
  55
  56 <para>
  57 <emphasis>Example 1</emphasis>.
  58 Create <filename>pl.mo</filename> and <filename>en.mo</filename> by compiling
  59 <filename>pl.po</filename> and <filename>en.po</filename>:
  60 </para>
  61 <example_commands>
  62   # ...
  63   env.MOFiles(['pl', 'en'])
  64 </example_commands>
  65
  66 <para>
  67 <emphasis>Example 2</emphasis>.
  68 Compile files for languages defined in <filename>LINGUAS</filename> file:
  69 </para>
  70 <example_commands>
  71   # ...
  72   env.MOFiles(LINGUAS_FILE = 1)
  73 </example_commands>
  74
  75 <para>
  76 <emphasis>Example 3</emphasis>.
  77 Create <filename>pl.mo</filename> and <filename>en.mo</filename> by compiling
  78 <filename>pl.po</filename> and <filename>en.po</filename> plus files for
  79 languages defined in <filename>LINGUAS</filename> file:
  80 </para>
  81 <example_commands>
  82   # ...
  83   env.MOFiles(['pl', 'en'], LINGUAS_FILE = 1)
  84 </example_commands>
  85
  86 <para>
  87 <emphasis>Example 4</emphasis>.
  88 Compile files for languages defined in <filename>LINGUAS</filename> file
  89 (another version):
  90 </para>
  91 <example_commands>
  92   # ...
  93   env['LINGUAS_FILE'] = 1
  94   env.MOFiles()
  95 </example_commands>
  96 </summary>
  97 </builder>
  98 <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
  99 <cvar name="MOSUFFIX">
 100 <summary>
 101 <para>
 102 Suffix used for <literal>MO</literal> files (default: <literal>'.mo'</literal>).
 103 See &t-link-msgfmt; tool and &b-link-MOFiles; builder.
 104 </para>
 105 </summary>
 106 </cvar>
 107 <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
 108 <cvar name="MSGFMT">
 109 <summary>
 110 <para>
 111 Absolute path to <command>msgfmt(1)</command> binary, found by
 112 <function>Detect()</function>.
 113 See &t-link-msgfmt; tool and &b-link-MOFiles; builder.
 114 </para>
 115 </summary>
 116 </cvar>
 117 <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
 118 <cvar name="MSGFMTCOM">
 119 <summary>
 120 <para>
 121 Complete command line to run <command>msgfmt(1)</command> program.
 122 See &t-link-msgfmt; tool and &b-link-MOFiles; builder.
 123 </para>
 124 </summary>
 125 </cvar>
 126 <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
 127 <cvar name="MSGFMTCOMSTR">
 128 <summary>
 129 <para>
 130 String to display when <command>msgfmt(1)</command> is invoked
 131 (default: <literal>''</literal>, which means ``print &cv-link-MSGFMTCOM;'').
 132 See &t-link-msgfmt; tool and &b-link-MOFiles; builder.
 133 </para>
 134 </summary>
 135 </cvar>
 136 <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
 137 <cvar name="MSGFMTFLAGS">
 138 <summary>
 139 <para>
 140 Additional flags to <command>msgfmt(1)</command>.
 141 See &t-link-msgfmt; tool and &b-link-MOFiles; builder.
 142 </para>
 143 </summary>
 144 </cvar>
 145
 146 </sconsdoc>