Mercurial > babel > old > babel-test

annotate doc/setup.txt @ 554:70f2c13f5f43

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