Mercurial > babel > old > mirror

annotate doc/cmdline.txt @ 183:e927dffc9ab4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
author cmlenz
date Thu, 28 Jun 2007 10:28:25 +0000
parents 6138ea7ef7a8
children a16401b8b989
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 Command-Line Interface
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 includes a command-line interface for working with message catalogs,
54
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
8 similar to the various GNU ``gettext`` tools commonly available on Linux/Unix
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
9 systems.
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
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
12 .. contents:: Contents
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
13 :depth: 2
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
14 .. sectnum::
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
15
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
16
54
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
17 When properly installed, Babel provides a script called ``babel``::
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
18
54
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
19 $ babel --help
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
20 usage: babel subcommand [options] [args]
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
21
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
22 options:
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: 82
diff changeset
23 --version show program's version number and exit
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: 82
diff changeset
24 -h, --help show this help message and exit
54
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
25
75
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
26 subcommands:
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: 82
diff changeset
27 compile compile message catalogs to MO files
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: 82
diff changeset
28 extract extract messages from source files and generate a POT file
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
29 init create new message catalogs from a POT file
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
30 update update existing message catalogs from a POT file
75
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
31
54
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
32 The ``babel`` script provides a number of sub-commands that do the actual work.
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
33 Those sub-commands are described below.
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
34
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
35
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: 82
diff changeset
36 compile
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: 82
diff changeset
37 =======
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: 82
diff changeset
38
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: 82
diff changeset
39 The ``compile`` sub-command can be used to compile translation catalogs into
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: 82
diff changeset
40 binary MO files::
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: 82
diff changeset
41
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: 82
diff changeset
42 $ babel compile --help
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: 82
diff changeset
43 usage: babel compile [options]
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: 82
diff changeset
44
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: 82
diff changeset
45 compile message catalogs to MO files
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: 82
diff changeset
46
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: 82
diff changeset
47 options:
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: 82
diff changeset
48 -h, --help show this help message and exit
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: 82
diff changeset
49 -D DOMAIN, --domain=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: 82
diff changeset
50 domain of MO and PO files (default 'messages')
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: 82
diff changeset
51 -d DIR, --directory=DIR
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: 82
diff changeset
52 base directory of catalog files
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: 82
diff changeset
53 -l LOCALE, --locale=LOCALE
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: 82
diff changeset
54 locale of the catalog
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: 82
diff changeset
55 -i FILE, --input-file=FILE
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: 82
diff changeset
56 name of the input file
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: 82
diff changeset
57 -o FILE, --output-file=FILE
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: 82
diff changeset
58 name of the output file (default
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: 82
diff changeset
59 '<output_dir>/<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: 82
diff changeset
60 -f, --use-fuzzy also include fuzzy translations (default False)
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: 82
diff changeset
61
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: 82
diff changeset
62 If ``directory`` is specified, but ``output-file`` is not, the default filename
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: 82
diff changeset
63 of the output file will be::
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: 82
diff changeset
64
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: 82
diff changeset
65 <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: 82
diff changeset
66
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: 82
diff changeset
67 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: 82
diff changeset
68 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: 82
diff changeset
69 and compiles each of them to MO files in the same directory.
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: 82
diff changeset
70
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: 82
diff changeset
71
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: 82
diff changeset
72
54
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
73 extract
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
74 =======
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
75
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
76 The ``extract`` sub-command can be used to extract localizable messages from
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
77 a collection of source files::
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
78
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
79 $ babel extract --help
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
80 usage: babel extract [options] dir1 <dir2> ...
79
7cf16a49e8b2 Updated frontend screens for added sorting features.
cmlenz
parents: 75
diff changeset
81
7cf16a49e8b2 Updated frontend screens for added sorting features.
cmlenz
parents: 75
diff changeset
82 extract messages from source files and generate a POT file
7cf16a49e8b2 Updated frontend screens for added sorting features.
cmlenz
parents: 75
diff changeset
83
54
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
84 options:
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
85 -h, --help show this help message and exit
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
86 --charset=CHARSET charset to use in the output
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
87 -k KEYWORDS, --keyword=KEYWORDS
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
88 keywords to look for in addition to the defaults. You
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
89 can specify multiple -k flags on the command line.
54
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
90 --no-default-keywords
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
91 do not include the default keywords
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
92 -F MAPPING_FILE, --mapping=MAPPING_FILE
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
93 path to the extraction mapping file
4
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
94 --no-location do not include location comments with filename and
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
95 line number
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
96 --omit-header do not include msgid "" entry in header
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
97 -o OUTPUT, --output=OUTPUT
2cada72b40ae Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
98 path to the output POT file
54
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
99 -w WIDTH, --width=WIDTH
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
100 set output line width (default 76)
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
101 --no-wrap do not break long message lines, longer than the
cc3c6cfe909d Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 4
diff changeset
102 output line width, into several lines
79
7cf16a49e8b2 Updated frontend screens for added sorting features.
cmlenz
parents: 75
diff changeset
103 --sort-output generate sorted output (default False)
7cf16a49e8b2 Updated frontend screens for added sorting features.
cmlenz
parents: 75
diff changeset
104 --sort-by-file sort output by file location (default False)
80
8e2e9d549693 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 79
diff changeset
105 --msgid-bugs-address=EMAIL@ADDRESS
8e2e9d549693 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 79
diff changeset
106 set report address for msgid
81
51f73a110a84 Implemented item 4 from #12. Set the copyright holder in the output.
palgarvio
parents: 80
diff changeset
107 --copyright-holder=COPYRIGHT_HOLDER
51f73a110a84 Implemented item 4 from #12. Set the copyright holder in the output.
palgarvio
parents: 80
diff changeset
108 set copyright holder in output
82
f421e5576d26 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 81
diff changeset
109 -c TAG, --add-comments=TAG
f421e5576d26 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 81
diff changeset
110 place comment block with TAG (or those preceding
f421e5576d26 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 81
diff changeset
111 keyword lines) in output file. One TAG per argument
f421e5576d26 Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 81
diff changeset
112 call
75
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
113
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
114
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
115 init
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
116 ====
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
117
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
118 The `init` sub-command creates a new translations catalog based on a PO
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
119 template file::
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
120
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
121 $ babel init --help
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
122 usage: babel init [options]
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
123
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
124 create new message catalogs from a POT file
75
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
125
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
126 options:
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
127 -h, --help show this help message and exit
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
128 -D DOMAIN, --domain=DOMAIN
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
129 domain of PO file (defaults to lower-cased project
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
130 name)
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
131 -i INPUT_FILE, --input-file=INPUT_FILE
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
132 name of the input file
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
133 -d OUTPUT_DIR, --output-dir=OUTPUT_DIR
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
134 path to output directory
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
135 -o OUTPUT_FILE, --output-file=OUTPUT_FILE
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
136 name of the output file (default
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
137 '<output_dir>/<locale>/<domain>.po')
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
138 -l LOCALE, --locale=LOCALE
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
139 locale for the new localized catalog
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
140 --first-author=FIRST_AUTHOR_NAME
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
141 name of first author
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
142 --first-author-email=FIRST_AUTHOR_EMAIL
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
143 email of first author
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
144 --project-name=NAME the project name
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
145 --project-version=VERSION
98b27ffe1c3a Extended the docs a bit.
cmlenz
parents: 54
diff changeset
146 the project version
183
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
147
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
148
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
149 update
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
150 ======
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
151
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
152 The `update` sub-command updates an existing new translations catalog based on
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
153 a PO template file::
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
154
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
155 $ babel update --help
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
156 usage: babel update [options]
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
157
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
158 update existing message catalogs from a POT file
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
159
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
160 options:
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
161 -h, --help show this help message and exit
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
162 -D DOMAIN, --domain=DOMAIN
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
163 domain of PO file (default 'messages')
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
164 -i FILE, --input-file=FILE
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
165 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
166 -d DIR, --output-dir=DIR
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
167 path to output directory
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
168 -o FILE, --output-file=FILE
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
169 name of the output file (default
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
170 '<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
171 -l LOCALE, --locale=LOCALE
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
172 locale of the translations catalog
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
173
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
174 If ``output_dir`` is specified, but ``output-file`` is not, the default
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
175 filename 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
176
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
177 <directory>/<locale>/LC_MESSAGES/<domain>.mo
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
178
e927dffc9ab4 The frontends now provide ways to update existing translations catalogs from a template. Closes #22.
cmlenz
parents: 179
diff changeset
179 If neither the ``output_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
180 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
181 and updates each of them.
Copyright (C) 2012-2017 Edgewall Software