Mercurial > babel > mirror

annotate doc/cmdline.txt @ 57:d930a3dfbf3d trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* The `extract_messages` distutils command now operators on configurable input directories again, instead of the complete current directory. The `input_dirs` default to the package directories. * Add a pseudo extractor called ?ignore? for #10.
author cmlenz
date Fri, 08 Jun 2007 11:28:15 +0000
parents 6b9c32893007
children 9bc73c0bf7e5
rev   line source
2
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
1 .. -*- mode: rst; encoding: utf-8 -*-
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
2
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
3 ======================
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
4 Command-Line Interface
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
5 ======================
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
6
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
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
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
9 systems.
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
10
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
11
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
12 .. contents:: Contents
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
13 :depth: 2
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
14 .. sectnum::
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
15
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
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
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
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
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
21
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
22 options:
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
23 --version show program's version number and exit
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
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
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
41 --charset=CHARSET charset to use in the output
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
42 -k KEYWORDS, --keyword=KEYWORDS
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
43 keywords to look for in addition to the defaults. You
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
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
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
49 --no-location do not include location comments with filename and
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
50 line number
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
51 --omit-header do not include msgid "" entry in header
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
52 -o OUTPUT, --output=OUTPUT
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
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
Copyright (C) 2012-2017 Edgewall Software