Mercurial > babel > old > mirror

annotate doc/setup.txt @ 270:1d25ca7199b0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix typo in documentation of the default extraction methods. Thanks to Ramiro Morales for pointing out the mistake.
author cmlenz
date Wed, 22 Aug 2007 11:32:09 +0000
parents 76fdd2ce5c51
children ac79e52d2689
rev   line source
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
1 .. -*- mode: rst; encoding: utf-8 -*-
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
2
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
3 ================================
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
4 Distutils/Setuptools Integration
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
5 ================================
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
6
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
7 Babel provides commands for integration into ``setup.py`` scripts, based on
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
8 either the ``distutils`` package that is part of the Python standard library,
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
9 or the third-party ``setuptools`` package.
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
10
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
11 These commands are available by default when Babel has been properly installed,
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
12 and ``setup.py`` is using ``setuptools``. For projects that use plain old
42
cf94e70a77f3 Syntax highlighting for the docs.
cmlenz
parents: 4
diff changeset
13 ``distutils``, the commands need to be registered explicitly, for example:
cf94e70a77f3 Syntax highlighting for the docs.
cmlenz
parents: 4
diff changeset
14
cf94e70a77f3 Syntax highlighting for the docs.
cmlenz
parents: 4
diff changeset
15 .. code-block:: python
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
16
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
17 from distutils.core import setup
56
27d55a07c897 Rename the `babel.catalog` package to `babel.messages` for consistency with the other package names.
cmlenz
parents: 53
diff changeset
18 from babel.messages import frontend as babel
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
19
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
20 setup(
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
21 ...
254
76fdd2ce5c51 Fix typo on distutils/setuptools doc page.
cmlenz
parents: 193
diff changeset
22 cmdclass = {'compile_catalog': babel.compile_catalog,
76fdd2ce5c51 Fix typo on distutils/setuptools doc page.
cmlenz
parents: 193
diff changeset
23 'extract_messages': babel.extract_messages,
76fdd2ce5c51 Fix typo on distutils/setuptools doc page.
cmlenz
parents: 193
diff changeset
24 'init_catalog': babel.init_catalog,
76fdd2ce5c51 Fix typo on distutils/setuptools doc page.
cmlenz
parents: 193
diff changeset
25 'update_catalog': babel.update_catalog}
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
26 )
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
27
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
28
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
29 .. contents:: Contents
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
30 :depth: 2
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
31 .. sectnum::
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
32
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
33
162
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
34 compile_catalog
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
35 ===============
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
36
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
37 The ``compile_catalog`` command is similar to the GNU ``msgfmt`` tool, in that
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
38 it takes a message catalog from a PO file and compiles it to a binary MO file.
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
39
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
40 If the command has been correctly installed or registered, a project's
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
41 ``setup.py`` script should allow you to use the command::
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
42
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
43 $ ./setup.py compile_catalog --help
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
44 Global options:
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
45 --verbose (-v) run verbosely (default)
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
46 --quiet (-q) run quietly (turns verbosity off)
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
47 --dry-run (-n) don't actually do anything
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
48 --help (-h) show detailed help message
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
49
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
50 Options for 'compile_catalog' command:
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
51 ...
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
52
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
53 Running the command will produce a PO template file::
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
54
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
55 $ ./setup.py compile_catalog --directory foobar/locale --locale pt_BR
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
56 running compile_catalog
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
57 compiling catalog to to foobar/locale/pt_BR/LC_MESSAGES/messages.mo
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
58
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
59
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
60 Options
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
61 -------
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
62
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
63 The ``compile_catalog`` command accepts the following options:
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
64
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
65 +-----------------------------+----------------------------------------------+
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
66 | Option | Description |
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
67 +=============================+==============================================+
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
68 | ``--domain`` | domain of the PO file (defaults to |
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
69 | | lower-cased project name) |
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
70 +-----------------------------+----------------------------------------------+
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
71 | ``--directory`` (``-d``) | name of the base directory |
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
72 +-----------------------------+----------------------------------------------+
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
73 | ``--input-file`` (``-i``) | name of the input file |
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
74 +-----------------------------+----------------------------------------------+
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
75 | ``--output-file`` (``-o``) | name of the output file |
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
76 +-----------------------------+----------------------------------------------+
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
77 | ``--locale`` | locale for the new localized string |
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
78 +-----------------------------+----------------------------------------------+
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
79 | ``--use-fuzzy`` | also include "fuzzy" translations |
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
80 +-----------------------------+----------------------------------------------+
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
81
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
82 If ``directory`` is specified, but ``output-file`` is not, the default filename
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
83 of the output file will be::
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
84
179
6138ea7ef7a8 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 162
diff changeset
85 <directory>/<locale>/LC_MESSAGES/<domain>.mo
6138ea7ef7a8 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 162
diff changeset
86
6138ea7ef7a8 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 162
diff changeset
87 If neither the ``input_file`` nor the ``locale`` option is set, this command
6138ea7ef7a8 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 162
diff changeset
88 looks for all catalog files in the base directory that match the given domain,
6138ea7ef7a8 * Instead of an extra `compile-all` option on the `compile` (or `compile_catalog`) command, compilation of all catalogs is performed when neither an `input_file` nor a `locale` is specified.
cmlenz
parents: 162
diff changeset
89 and compiles each of them to MO files in the same directory.
162
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
90
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
91 These options can either be specified on the command-line, or in the
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
92 ``setup.cfg`` file.
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
93
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
94
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
95 extract_messages
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
96 ================
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
97
92
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
98 The ``extract_messages`` command is comparable to the GNU ``xgettext`` program:
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
99 it can extract localizable messages from a variety of difference source files,
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
100 and generate a PO (portable object) template file from the collected messages.
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
101
162
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
102 If the command has been correctly installed or registered, a project's
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
103 ``setup.py`` script should allow you to use the command::
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
104
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
105 $ ./setup.py extract_messages --help
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
106 Global options:
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
107 --verbose (-v) run verbosely (default)
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
108 --quiet (-q) run quietly (turns verbosity off)
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
109 --dry-run (-n) don't actually do anything
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
110 --help (-h) show detailed help message
79
7cf16a49e8b2 Updated frontend screens for added sorting features.
cmlenz
parents: 64
diff changeset
111
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
112 Options for 'extract_messages' command:
92
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
113 ...
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
114
53
52dbebdd3789 Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 51
diff changeset
115 Running the command will produce a PO template file::
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
116
51
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
117 $ ./setup.py extract_messages --output-file foobar/locale/messages.pot
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
118 running extract_messages
51
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
119 extracting messages from foobar/__init__.py
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
120 extracting messages from foobar/core.py
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
121 ...
53
52dbebdd3789 Fixed a bug regarding plural msgid's handling when writing the `.pot` file.
palgarvio
parents: 51
diff changeset
122 writing PO template file to foobar/locale/messages.pot
51
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
123
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
124
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
125 Method Mapping
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
126 --------------
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
127
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
128 The mapping of file patterns to extraction methods (and options) can be
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
129 specified using a configuration file that is pointed to using the
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
130 ``--mapping-file`` option shown above. Alternatively, you can configure the
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
131 mapping directly in ``setup.py`` using a keyword argument to the ``setup()``
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
132 function:
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
133
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
134 .. code-block:: python
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
135
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
136 setup(...
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
137
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
138 message_extractors = {
64
7eb6fea17864 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 56
diff changeset
139 'foobar': [
119
c84f629da9de Made new frontend tests more ''unit-y'', i.e. calling the APIs directly instead of launching the scripts.
cmlenz
parents: 92
diff changeset
140 ('**.py', 'python', None),
c84f629da9de Made new frontend tests more ''unit-y'', i.e. calling the APIs directly instead of launching the scripts.
cmlenz
parents: 92
diff changeset
141 ('**/templates/**.html', 'genshi', None),
c84f629da9de Made new frontend tests more ''unit-y'', i.e. calling the APIs directly instead of launching the scripts.
cmlenz
parents: 92
diff changeset
142 ('**/templates/**.txt', 'genshi', {
146
24b5de939850 Some doc fixes.
cmlenz
parents: 119
diff changeset
143 'template_class': 'genshi.template:TextTemplate'
64
7eb6fea17864 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 56
diff changeset
144 })
7eb6fea17864 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 56
diff changeset
145 ],
51
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
146 },
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
147
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
148 ...
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
149 )
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
150
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
151
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
152 Options
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
153 -------
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
154
92
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
155 The ``extract_messages`` command accepts the following options:
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
156
51
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
157 +-----------------------------+----------------------------------------------+
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
158 | Option | Description |
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
159 +=============================+==============================================+
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
160 | ``--charset`` | charset to use in the output file |
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
161 +-----------------------------+----------------------------------------------+
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
162 | ``--keywords`` (``-k``) | space-separated list of keywords to look for |
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
163 | | in addition to the defaults |
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
164 +-----------------------------+----------------------------------------------+
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
165 | ``--no-default-keywords`` | do not include the default keywords |
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
166 +-----------------------------+----------------------------------------------+
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
167 | ``--mapping-file`` (``-F``) | path to the mapping configuration file |
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
168 +-----------------------------+----------------------------------------------+
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
169 | ``--no-location`` | do not include location comments with |
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
170 | | filename and line number |
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
171 +-----------------------------+----------------------------------------------+
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
172 | ``--omit-header`` | do not include msgid "" entry in header |
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
173 +-----------------------------+----------------------------------------------+
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
174 | ``--output-file`` (``-o``) | name of the output file |
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
175 +-----------------------------+----------------------------------------------+
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
176 | ``--width`` (``-w``) | set output line width (default 76) |
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
177 +-----------------------------+----------------------------------------------+
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
178 | ``--no-wrap`` | do not break long message lines, longer than |
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
179 | | the output line width, into several lines |
3664c93860f1 Support a `message_extractors` keyword argument directly in `setup()`. Closes #4.
cmlenz
parents: 42
diff changeset
180 +-----------------------------+----------------------------------------------+
64
7eb6fea17864 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 56
diff changeset
181 | ``--input-dirs`` | directories that should be scanned for |
7eb6fea17864 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 56
diff changeset
182 | | messages |
7eb6fea17864 The order of extraction methods is now preserved (see #10).
cmlenz
parents: 56
diff changeset
183 +-----------------------------+----------------------------------------------+
92
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
184 | ``--sort-output`` | generate sorted output (default False) |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
185 +-----------------------------+----------------------------------------------+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
186 | ``--sort-by-file`` | sort output by file location (default False) |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
187 +-----------------------------+----------------------------------------------+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
188 | ``--msgid-bugs-address`` | set email address for message bug reports |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
189 +-----------------------------+----------------------------------------------+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
190 | ``--copyright-holder`` | set copyright holder in output |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
191 +-----------------------------+----------------------------------------------+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
192 | ``--add-comments (-c)`` | place comment block with TAG (or those |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
193 | | preceding keyword lines) in output file. |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
194 | | Separate multiple TAGs with commas(,) |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
195 +-----------------------------+----------------------------------------------+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
196
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
197 These options can either be specified on the command-line, or in the
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
198 ``setup.cfg`` file. In the latter case, the options above become entries of the
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
199 section ``[extract_messages]``, and the option names are changed to use
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
200 underscore characters instead of dashes, for example:
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
201
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
202 .. code-block:: ini
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
203
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
204 [extract_messages]
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
205 keywords = _, gettext, ngettext
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
206 mapping_file = babel.cfg
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
207 width = 80
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
208
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
209 This would be equivalent to invoking the command from the command-line as
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
210 follows::
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
211
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
212 $ setup.py extract_messages -k _ -k gettext -k ngettext -F mapping.cfg -w 80
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
213
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
214 Any path names are interpreted relative to the location of the ``setup.py``
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
215 file. For boolean options, use "true" or "false" values.
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
216
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
217
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
218 init_catalog
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
219 ============
92
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
220
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
221 The ``init_catalog`` command is basically equivalent to the GNU ``msginit``
92
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
222 program: it creates a new translation catalog based on a PO template file (POT).
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
223
162
661cb602781d Add MO file generation. Closes #21.
cmlenz
parents: 146
diff changeset
224 If the command has been correctly installed or registered, a project's
92
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
225 ``setup.py`` script should allow you to use the command::
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
226
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
227 $ ./setup.py init_catalog --help
92
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
228 Global options:
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
229 --verbose (-v) run verbosely (default)
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
230 --quiet (-q) run quietly (turns verbosity off)
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
231 --dry-run (-n) don't actually do anything
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
232 --help (-h) show detailed help message
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
233
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
234 Options for 'init_catalog' command:
92
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
235 ...
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
236
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
237 Running the command will produce a PO file::
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
238
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
239 $ ./setup.py init_catalog -l fr -i foobar/locales/messages.pot \
92
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
240 -o foobar/locales/fr/messages.po
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
241 running init_catalog
92
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
242 creating catalog 'foobar/locales/fr/messages.po' based on 'foobar/locales/messages.pot'
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
243
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
244
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
245 Options
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
246 -------
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
247
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
248 The ``init_catalog`` command accepts the following options:
92
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
249
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
250 +-----------------------------+----------------------------------------------+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
251 | Option | Description |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
252 +=============================+==============================================+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
253 | ``--domain`` | domain of the PO file (defaults to |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
254 | | lower-cased project name) |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
255 +-----------------------------+----------------------------------------------+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
256 | ``--input-file`` (``-i``) | name of the input file |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
257 +-----------------------------+----------------------------------------------+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
258 | ``--output-dir`` (``-d``) | name of the output directory |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
259 +-----------------------------+----------------------------------------------+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
260 | ``--output-file`` (``-o``) | name of the output file |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
261 +-----------------------------+----------------------------------------------+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
262 | ``--locale`` | locale for the new localized string |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
263 +-----------------------------+----------------------------------------------+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
264 | ``--omit-header`` | do not include msgid "" entry in header |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
265 +-----------------------------+----------------------------------------------+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
266 | ``--first-author`` | name of the first author |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
267 +-----------------------------+----------------------------------------------+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
268 | ``--first-author-email`` | email address of the first author |
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
269 +-----------------------------+----------------------------------------------+
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
270
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
271 If ``output-dir`` is specified, but ``output-file`` is not, the default filename
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
272 of the output file will be::
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
273
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
274 <output_dir>/<locale>/LC_MESSAGES/<domain>.po
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
275
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
276 These options can either be specified on the command-line, or in the
6d1a7777003e Some doc improvements on distutils integration.
cmlenz
parents: 82
diff changeset
277 ``setup.cfg`` file.
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
278
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
279
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
280 update_catalog
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
281 ==============
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
282
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
283 The ``update_catalog`` command is basically equivalent to the GNU ``msgmerge``
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
284 program: it updates an existing translations catalog based on a PO template
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
285 file (POT).
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
286
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
287 If the command has been correctly installed or registered, a project's
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
288 ``setup.py`` script should allow you to use the command::
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
289
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
290 $ ./setup.py update_catalog --help
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
291 Global options:
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
292 --verbose (-v) run verbosely (default)
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
293 --quiet (-q) run quietly (turns verbosity off)
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
294 --dry-run (-n) don't actually do anything
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
295 --help (-h) show detailed help message
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
296
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
297 Options for 'update_catalog' command:
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
298 ...
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
299
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
300 Running the command will update a PO file::
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
301
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
302 $ ./setup.py update_catalog -l fr -i foobar/locales/messages.pot \
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
303 -o foobar/locales/fr/messages.po
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
304 running update_catalog
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
305 updating catalog 'foobar/locales/fr/messages.po' based on 'foobar/locales/messages.pot'
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
306
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
307
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
308 Options
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
309 -------
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
310
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
311 The ``update_catalog`` command accepts the following options:
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
312
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
313 +-----------------------------+----------------------------------------------+
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
314 | Option | Description |
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
315 +=============================+==============================================+
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
316 | ``--domain`` | domain of the PO file (defaults to |
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
317 | | lower-cased project name) |
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
318 +-----------------------------+----------------------------------------------+
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
319 | ``--input-file`` (``-i``) | name of the input file |
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
320 +-----------------------------+----------------------------------------------+
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
321 | ``--output-dir`` (``-d``) | name of the output directory |
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
322 +-----------------------------+----------------------------------------------+
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
323 | ``--output-file`` (``-o``) | name of the output file |
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
324 +-----------------------------+----------------------------------------------+
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
325 | ``--locale`` | locale for the new localized string |
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
326 +-----------------------------+----------------------------------------------+
193
b5e58a22ebd2 Add an option to the frontend commands for catalog updating that removes completely any obsolete messages, instead of putting them comments.
cmlenz
parents: 183
diff changeset
327 | ``--ignore-obsolete`` | do not include obsolete messages in the |
b5e58a22ebd2 Add an option to the frontend commands for catalog updating that removes completely any obsolete messages, instead of putting them comments.
cmlenz
parents: 183
diff changeset
328 | | output |
b5e58a22ebd2 Add an option to the frontend commands for catalog updating that removes completely any obsolete messages, instead of putting them comments.
cmlenz
parents: 183
diff changeset
329 +-----------------------------+----------------------------------------------+
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
330
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
331 If ``output-dir`` is specified, but ``output-file`` is not, the default filename
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
332 of the output file will be::
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
333
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
334 <output_dir>/<locale>/LC_MESSAGES/<domain>.po
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
335
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
336 If neither the ``input_file`` nor the ``locale`` option is set, this command
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
337 looks for all catalog files in the base directory that match the given domain,
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
338 and updates each of them.
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
339
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
340 These options can either be specified on the command-line, or in the
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
341 ``setup.cfg`` file.
Copyright (C) 2012-2017 Edgewall Software