Mercurial > babel > mirror
annotate doc/cmdline.txt @ 68:269941aa0e55 trunk
Add back POT header broken in previous check-in.
author | cmlenz |
---|---|
date | Fri, 08 Jun 2007 15:47:00 +0000 |
parents | 6b9c32893007 |
children | 9bc73c0bf7e5 |
rev | line source |
---|---|
2 | 1 .. -*- mode: rst; encoding: utf-8 -*- |
2 | |
3 ====================== | |
4 Command-Line Interface | |
5 ====================== | |
6 | |
7 Babel includes a command-line interface for working with message catalogs, | |
52
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
8 similar to the various GNU ``gettext`` tools commonly available on Linux/Unix |
2 | 9 systems. |
10 | |
11 | |
12 .. contents:: Contents | |
13 :depth: 2 | |
14 .. sectnum:: | |
15 | |
16 | |
52
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
17 When properly installed, Babel provides a script called ``babel``:: |
2 | 18 |
52
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
19 $ babel --help |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
20 usage: babel subcommand [options] [args] |
2 | 21 |
22 options: | |
23 --version show program's version number and exit | |
24 -h, --help show this help message and exit | |
52
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
25 |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
26 The ``babel`` script provides a number of sub-commands that do the actual work. |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
27 Those sub-commands are described below. |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
28 |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
29 |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
30 extract |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
31 ======= |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
32 |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
33 The ``extract`` sub-command can be used to extract localizable messages from |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
34 a collection of source files:: |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
35 |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
36 $ babel extract --help |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
37 usage: babel extract [options] dir1 <dir2> ... |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
38 |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
39 options: |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
40 -h, --help show this help message and exit |
2 | 41 --charset=CHARSET charset to use in the output |
42 -k KEYWORDS, --keyword=KEYWORDS | |
43 keywords to look for in addition to the defaults. You | |
44 can specify multiple -k flags on the command line. | |
52
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
45 --no-default-keywords |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
46 do not include the default keywords |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
47 -F MAPPING_FILE, --mapping=MAPPING_FILE |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
48 path to the extraction mapping file |
2 | 49 --no-location do not include location comments with filename and |
50 line number | |
51 --omit-header do not include msgid "" entry in header | |
52 -o OUTPUT, --output=OUTPUT | |
53 path to the output POT file | |
52
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
54 -w WIDTH, --width=WIDTH |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
55 set output line width (default 76) |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
56 --no-wrap do not break long message lines, longer than the |
6b9c32893007
Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents:
2
diff
changeset
|
57 output line width, into several lines |