summaryrefslogtreecommitdiffstats
path: root/doc/msgunfmt.texi
diff options
context:
space:
mode:
authorBruno Haible <bruno@clisp.org>2001-10-26 09:27:48 +0000
committerBruno Haible <bruno@clisp.org>2001-10-26 09:27:48 +0000
commit478e4bee98fb93846cc79d4d0e029818c4d49c28 (patch)
treed597e78b04206372365f8ccdc94ca88d141c9f29 /doc/msgunfmt.texi
parent738d90fd26b609548adfe4ef8429582b387b2b09 (diff)
downloadexternal_gettext-478e4bee98fb93846cc79d4d0e029818c4d49c28.zip
external_gettext-478e4bee98fb93846cc79d4d0e029818c4d49c28.tar.gz
external_gettext-478e4bee98fb93846cc79d4d0e029818c4d49c28.tar.bz2
Document all the programs.
Diffstat (limited to 'doc/msgunfmt.texi')
-rw-r--r--doc/msgunfmt.texi101
1 files changed, 101 insertions, 0 deletions
diff --git a/doc/msgunfmt.texi b/doc/msgunfmt.texi
new file mode 100644
index 0000000..f8f68d2
--- /dev/null
+++ b/doc/msgunfmt.texi
@@ -0,0 +1,101 @@
+@example
+msgunfmt [@var{option}] [@var{file}]...
+@end example
+
+The @code{msgunfmt} program converts a binary message catalog to a
+Uniforum style .po file.
+
+@subsection Operation mode
+
+@table @samp
+@item -j
+@itemx --java
+Java mode: generate a Java @code{ResourceBundle} class.
+
+@end table
+
+@subsection Input file location
+
+@table @samp
+@item @var{file} @dots{}
+Input .mo files.
+
+@end table
+
+If no input @var{file} is given or if it is @samp{-}, standard input is read.
+
+@subsection Input file location in Java mode
+
+@table @samp
+@item -r @var{resource}
+@itemx --resource=@var{resource}
+Specify the resource name.
+
+@item -l @var{locale}
+@itemx --locale=@var{locale}
+Specify the locale name, either a language specification of the form @var{ll}
+or a combined language and country specification of the form @var{ll_CC}.
+
+@end table
+
+The class name is determined by appending the locale name to the resource name,
+separated with an underscore. The class is located using the @code{CLASSPATH}.
+
+@subsection Output file location
+
+@table @samp
+@item -o @var{file}
+@itemx --output-file=@var{file}
+Write output to specified file.
+
+@end table
+
+The results are written to standard output if no output file is specified
+or if it is @samp{-}.
+
+@subsection Output details
+
+@c --no-escape and --escape omitted on purpose. They are not useful.
+
+@table @samp
+@item --force-po
+Always write an output file even if it contains no message.
+
+@item -i
+@itemx --indent
+Write the .po file using indented style.
+
+@item --strict
+Write out a strict Uniforum conforming PO file. Note that this
+Uniforum format should be avoided because it doesn't support the
+GNU extensions.
+
+@item -w @var{number}
+@itemx --width=@var{number}
+Set the output page width. Long strings in the output files will be
+split across multiple lines in order to ensure that each line's width
+(= number of screen columns) is less or equal to the given @var{number}.
+
+@item -s
+@itemx --sort-output
+Generate sorted output. Note that using this option makes it much harder
+for the translator to understand each message's context.
+
+@end table
+
+@subsection Informative output
+
+@table @samp
+@item -h
+@itemx --help
+Display this help and exit.
+
+@item -V
+@itemx --version
+Output version information and exit.
+
+@item -v
+@itemx --verbose
+Increase verbosity level.
+
+@end table