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