diff options
Diffstat (limited to 'src/engine/SCons/Tool/msginit.xml')
| -rw-r--r-- | src/engine/SCons/Tool/msginit.xml | 113 |
1 files changed, 85 insertions, 28 deletions
diff --git a/src/engine/SCons/Tool/msginit.xml b/src/engine/SCons/Tool/msginit.xml index d095654..ca298f6 100644 --- a/src/engine/SCons/Tool/msginit.xml +++ b/src/engine/SCons/Tool/msginit.xml @@ -1,36 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> <!-- -Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation +Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation This file is processed by the bin/SConsDoc.py module. See its __doc__ string for a discussion of the format. --> + +<!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/scons.xsd scons.xsd"> + <tool name="msginit"> <summary> +<para> This scons tool is a part of scons &t-link-gettext; toolset. It provides scons interface to <command>msginit(1)</command> program, which creates new <literal>PO</literal> file, initializing the meta information with values from user's environment (or options). +</para> </summary> <sets> -MSGINIT -MSGINITCOM -MSGINITCOMSTR -MSGINITFLAGS -POAUTOINIT -POCREATE_ALIAS -POSUFFIX -POTSUFFIX -_MSGINITLOCALE +<item>MSGINIT</item> +<item>MSGINITCOM</item> +<item>MSGINITCOMSTR</item> +<item>MSGINITFLAGS</item> +<item>POAUTOINIT</item> +<item>POCREATE_ALIAS</item> +<item>POSUFFIX</item> +<item>POTSUFFIX</item> +<item>_MSGINITLOCALE</item> </sets> <uses> -POTDOMAIN -LINGUAS_FILE -POAUTOINIT +<item>POTDOMAIN</item> +<item>LINGUAS_FILE</item> +<item>POAUTOINIT</item> </uses> </tool> <builder name="POInit"> <summary> +<para> This builder belongs to &t-link-msginit; tool. The builder initializes missing <literal>PO</literal> file(s) if &cv-link-POAUTOINIT; is set. If &cv-link-POAUTOINIT; is not set (default), &b-POInit; prints instruction for @@ -42,127 +64,162 @@ instead</emphasis>. &b-link-POUpdate; chooses intelligently between always uses <command>msginit(1)</command> and should be regarded as builder for special purposes or for temporary use (e.g. for quick, one time initialization of a bunch of <literal>PO</literal> files) or for tests. +</para> +<para> Target nodes defined through &b-POInit; are not built by default (they're <literal>Ignore</literal>d from <literal>'.'</literal> node) but are added to special <literal>Alias</literal> (<literal>'po-create'</literal> by default). The alias name may be changed through the &cv-link-POCREATE_ALIAS; construction variable. All <literal>PO</literal> files defined through &b-POInit; may be easily initialized by <command>scons po-create</command>. +</para> +<para> <emphasis>Example 1</emphasis>. Initialize <filename>en.po</filename> and <filename>pl.po</filename> from <filename>messages.pot</filename>: -<example> +</para> +<example_commands> # ... env.POInit(['en', 'pl']) # messages.pot --> [en.po, pl.po] -</example> +</example_commands> +<para> <emphasis>Example 2</emphasis>. Initialize <filename>en.po</filename> and <filename>pl.po</filename> from <filename>foo.pot</filename>: -<example> +</para> +<example_commands> # ... env.POInit(['en', 'pl'], ['foo']) # foo.pot --> [en.po, pl.po] -</example> +</example_commands> +<para> <emphasis>Example 3</emphasis>. Initialize <filename>en.po</filename> and <filename>pl.po</filename> from <filename>foo.pot</filename> but using &cv-link-POTDOMAIN; construction variable: -<example> +</para> +<example_commands> # ... env.POInit(['en', 'pl'], POTDOMAIN='foo') # foo.pot --> [en.po, pl.po] -</example> +</example_commands> +<para> <emphasis>Example 4</emphasis>. Initialize <literal>PO</literal> files for languages defined in <filename>LINGUAS</filename> file. The files will be initialized from template <filename>messages.pot</filename>: -<example> +</para> +<example_commands> # ... env.POInit(LINGUAS_FILE = 1) # needs 'LINGUAS' file -</example> +</example_commands> +<para> <emphasis>Example 5</emphasis>. Initialize <filename>en.po</filename> and <filename>pl.pl</filename> <literal>PO</literal> files plus files for languages defined in <filename>LINGUAS</filename> file. The files will be initialized from template <filename>messages.pot</filename>: -<example> +</para> +<example_commands> # ... env.POInit(['en', 'pl'], LINGUAS_FILE = 1) -</example> +</example_commands> +<para> <emphasis>Example 6</emphasis>. You may preconfigure your environment first, and then initialize <literal>PO</literal> files: -<example> +</para> +<example_commands> # ... env['POAUTOINIT'] = 1 env['LINGUAS_FILE'] = 1 env['POTDOMAIN'] = 'foo' env.POInit() -</example> +</example_commands> +<para> which has same efect as: -<example> +</para> +<example_commands> # ... env.POInit(POAUTOINIT = 1, LINGUAS_FILE = 1, POTDOMAIN = 'foo') -</example> +</example_commands> </summary> </builder> <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% --> <cvar name="POCREATE_ALIAS"> <summary> +<para> Common alias for all <literal>PO</literal> files created with &b-POInit; builder (default: <literal>'po-create'</literal>). See &t-link-msginit; tool and &b-link-POInit; builder. +</para> </summary> </cvar> <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% --> <cvar name="POSUFFIX"> <summary> +<para> Suffix used for <literal>PO</literal> files (default: <literal>'.po'</literal>) See &t-link-msginit; tool and &b-link-POInit; builder. +</para> </summary> </cvar> <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% --> <cvar name="MSGINIT"> <summary> +<para> Path to <command>msginit(1)</command> program (found via <literal>Detect()</literal>). See &t-link-msginit; tool and &b-link-POInit; builder. +</para> </summary> </cvar> <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% --> <cvar name="MSGINITCOM"> <summary> +<para> Complete command line to run <command>msginit(1)</command> program. See &t-link-msginit; tool and &b-link-POInit; builder. +</para> </summary> </cvar> <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% --> <cvar name="MSGINITCOMSTR"> <summary> +<para> String to display when <command>msginit(1)</command> is invoked (default: <literal>''</literal>, which means ``print &cv-link-MSGINITCOM;''). See &t-link-msginit; tool and &b-link-POInit; builder. +</para> </summary> </cvar> <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% --> <cvar name="MSGINITFLAGS"> <summary> +<para> List of additional flags to <command>msginit(1)</command> (default: <literal>[]</literal>). See &t-link-msginit; tool and &b-link-POInit; builder. +</para> </summary> </cvar> <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% --> <cvar name="_MSGINITLOCALE"> <summary> +<para> Internal ``macro''. Computes locale (language) name based on target filename (default: <literal>'${TARGET.filebase}' </literal>). -</summary> +</para> +<para> See &t-link-msginit; tool and &b-link-POInit; builder. +</para> +</summary> </cvar> + +</sconsdoc>
\ No newline at end of file |