Mercurial > babel > mirror

annotate doc/cmdline.txt @ 139:17a8b4cf6411 trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initialized change log.
author cmlenz
date Wed, 20 Jun 2007 10:07:37 +0000
parents 116e34b8cefa
children beb8a9eabe6d 969a4d694710
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
73
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
26 subcommands:
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
27 extract extract messages from source files and generate a POT file
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
28 init create new message catalogs from a template
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
29
52
6b9c32893007 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 2
diff changeset
30 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
31 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
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
6b9c32893007 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 2
diff changeset
34 extract
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
6b9c32893007 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 2
diff changeset
37 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
38 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
39
6b9c32893007 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 2
diff changeset
40 $ 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
41 usage: babel extract [options] dir1 <dir2> ...
77
c75fa55a65b9 Updated frontend screens for added sorting features.
cmlenz
parents: 73
diff changeset
42
c75fa55a65b9 Updated frontend screens for added sorting features.
cmlenz
parents: 73
diff changeset
43 extract messages from source files and generate a POT file
c75fa55a65b9 Updated frontend screens for added sorting features.
cmlenz
parents: 73
diff changeset
44
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 options:
6b9c32893007 Support sub-commands in command-line interface, and renamed the generated script wrapper to `babel`. See #9.
cmlenz
parents: 2
diff changeset
46 -h, --help show this help message and exit
2
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
47 --charset=CHARSET charset to use in the output
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
48 -k KEYWORDS, --keyword=KEYWORDS
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
49 keywords to look for in addition to the defaults. You
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
50 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
51 --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
52 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
53 -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
54 path to the extraction mapping file
2
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
55 --no-location do not include location comments with filename and
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
56 line number
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
57 --omit-header do not include msgid "" entry in header
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
58 -o OUTPUT, --output=OUTPUT
20896f1e91c6 Forgot to check in the doc directory.
cmlenz
parents:
diff changeset
59 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
60 -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
61 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
62 --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
63 output line width, into several lines
77
c75fa55a65b9 Updated frontend screens for added sorting features.
cmlenz
parents: 73
diff changeset
64 --sort-output generate sorted output (default False)
c75fa55a65b9 Updated frontend screens for added sorting features.
cmlenz
parents: 73
diff changeset
65 --sort-by-file sort output by file location (default False)
78
d0d8d6cd8601 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 77
diff changeset
66 --msgid-bugs-address=EMAIL@ADDRESS
d0d8d6cd8601 Fixed the plurals header on `Catalog` which should only be written if it's not a catalog template.
palgarvio
parents: 77
diff changeset
67 set report address for msgid
79
450ac2291ca5 Implemented item 4 from #12. Set the copyright holder in the output.
palgarvio
parents: 78
diff changeset
68 --copyright-holder=COPYRIGHT_HOLDER
450ac2291ca5 Implemented item 4 from #12. Set the copyright holder in the output.
palgarvio
parents: 78
diff changeset
69 set copyright holder in output
80
116e34b8cefa Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
70 -c TAG, --add-comments=TAG
116e34b8cefa Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
71 place comment block with TAG (or those preceding
116e34b8cefa Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
72 keyword lines) in output file. One TAG per argument
116e34b8cefa Added support for translator comments at the API and frontends levels.(See #12, item 1). Updated docs and tests accordingly.
palgarvio
parents: 79
diff changeset
73 call
73
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
74
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
75
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
76 init
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
77 ====
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
78
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
79 The `init` sub-command creates a new translations catalog based on a PO
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
80 template file::
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
81
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
82 $ babel init --help
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
83 usage: babel init [options]
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
84
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
85 create new message catalogs from a template
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
86
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
87 options:
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
88 -h, --help show this help message and exit
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
89 -D DOMAIN, --domain=DOMAIN
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
90 domain of PO file (defaults to lower-cased project
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
91 name)
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
92 -i INPUT_FILE, --input-file=INPUT_FILE
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
93 name of the input file
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
94 -d OUTPUT_DIR, --output-dir=OUTPUT_DIR
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
95 path to output directory
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
96 -o OUTPUT_FILE, --output-file=OUTPUT_FILE
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
97 name of the output file (default
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
98 '<output_dir>/<locale>/<domain>.po')
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
99 -l LOCALE, --locale=LOCALE
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
100 locale for the new localized catalog
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
101 --first-author=FIRST_AUTHOR_NAME
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
102 name of first author
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
103 --first-author-email=FIRST_AUTHOR_EMAIL
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
104 email of first author
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
105 --project-name=NAME the project name
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
106 --project-version=VERSION
9bc73c0bf7e5 Extended the docs a bit.
cmlenz
parents: 52
diff changeset
107 the project version
Copyright (C) 2012-2017 Edgewall Software