diff doc/cmdline.txt @ 177:a7766f92f944

* 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. * The `--use-fuzzy` option works again from the command-line.
author cmlenz
date Wed, 27 Jun 2007 14:29:17 +0000
parents 9c84b9fa5d30
children 9a1acb41e7dd
line wrap: on
line diff
--- a/doc/cmdline.txt
+++ b/doc/cmdline.txt
@@ -20,17 +20,55 @@
     usage: babel subcommand [options] [args]
 
     options:
-      --version             show program's version number and exit
-      -h, --help            show this help message and exit
+      --version   show program's version number and exit
+      -h, --help  show this help message and exit
 
     subcommands:
-      extract   extract messages from source files and generate a POT file
-      init      create new message catalogs from a template
+      compile     compile message catalogs to MO files
+      extract     extract messages from source files and generate a POT file
+      init        create new message catalogs from a template
 
 The ``babel`` script provides a number of sub-commands that do the actual work.
 Those sub-commands are described below.
 
 
+compile
+=======
+
+The ``compile`` sub-command can be used to compile translation catalogs into
+binary MO files::
+
+    $ babel compile --help
+    usage: babel compile [options] 
+    
+    compile message catalogs to MO files
+    
+    options:
+      -h, --help            show this help message and exit
+      -D DOMAIN, --domain=DOMAIN
+                            domain of MO and PO files (default 'messages')
+      -d DIR, --directory=DIR
+                            base directory of catalog files
+      -l LOCALE, --locale=LOCALE
+                            locale of the catalog
+      -i FILE, --input-file=FILE
+                            name of the input file
+      -o FILE, --output-file=FILE
+                            name of the output file (default
+                            '<output_dir>/<locale>/LC_MESSAGES/<domain>.mo')
+      -f, --use-fuzzy       also include fuzzy translations (default False)
+
+If ``directory`` is specified, but ``output-file`` is not, the default filename
+of the output file will be::
+
+    <directory>/<locale>/LC_MESSAGES/<domain>.mo
+
+If neither the ``input_file`` nor the ``locale`` option is set, this command
+looks for all catalog files in the base directory that match the given domain,
+and compiles each of them to MO files in the same directory.
+
+
+
 extract
 =======
 
Copyright (C) 2012-2017 Edgewall Software