Mercurial > babel > old > babel-test

annotate doc/cmdline.txt @ 64:0406c51c5463

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
`read_po` now returns a `Catalog`.
author cmlenz
date Fri, 08 Jun 2007 13:15:32 +0000
parents 1e724c305460
children dd5c3ba59eae
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 Command-Line Interface
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 includes a command-line interface for working with message catalogs,
52
1e724c305460 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
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
9 systems.
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
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
12 .. contents:: Contents
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
13 :depth: 2
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
14 .. sectnum::
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
15
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
16
52
1e724c305460 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
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
18
52
1e724c305460 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
1e724c305460 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
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
21
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
22 options:
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
23 --version show program's version number and exit
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
24 -h, --help show this help message and exit
52
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 2
diff changeset
25
1e724c305460 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.
1e724c305460 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.
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 2
diff changeset
28
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 2
diff changeset
29
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 2
diff changeset
30 extract
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 2
diff changeset
31 =======
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 2
diff changeset
32
1e724c305460 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
1e724c305460 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::
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 2
diff changeset
35
1e724c305460 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
1e724c305460 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> ...
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 2
diff changeset
38
1e724c305460 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 2
diff changeset
39 options:
1e724c305460 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
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
41 --charset=CHARSET charset to use in the output
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
42 -k KEYWORDS, --keyword=KEYWORDS
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
43 keywords to look for in addition to the defaults. You
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
44 can specify multiple -k flags on the command line.
52
1e724c305460 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
1e724c305460 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
1e724c305460 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
1e724c305460 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
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
49 --no-location do not include location comments with filename and
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
50 line number
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
51 --omit-header do not include msgid "" entry in header
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
52 -o OUTPUT, --output=OUTPUT
b2492365f186 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
53 path to the output POT file
52
1e724c305460 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
1e724c305460 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)
1e724c305460 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
1e724c305460 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
Copyright (C) 2012-2017 Edgewall Software