summaryrefslogtreecommitdiffstats
path: root/doc/msgen.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/msgen.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/msgen.texi')
-rw-r--r--doc/msgen.texi89
1 files changed, 89 insertions, 0 deletions
diff --git a/doc/msgen.texi b/doc/msgen.texi
new file mode 100644
index 0000000..32bca0e
--- /dev/null
+++ b/doc/msgen.texi
@@ -0,0 +1,89 @@
+@example
+msgen [@var{option}] @var{inputfile}
+@end example
+
+The @code{msgen} program creates an English translation catalog. The
+input file is the last created English PO file, or a PO Template file
+(generally created by xgettext). Untranslated entries are assigned a
+translation that is identical to the msgid, and are marked fuzzy.
+
+@subsection Input file location
+
+@table @samp
+@item @var{inputfile}
+Input PO or POT file.
+
+@item -D @var{directory}
+@itemx --directory=@var{directory}
+Add @var{directory} to the list of directories. Source files are
+searched relative to this list of directories. The resulting @file{.po}
+file will be written relative to the current directory, though.
+
+@end table
+
+If @var{inputfile} is @samp{-}, standard input is read.
+
+@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 --no-location
+Do not write @samp{#: @var{filename}:@var{line}} lines.
+
+@item --add-location
+Generate @samp{#: @var{filename}:@var{line}} lines (default).
+
+@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.
+
+@item -F
+@itemx --sort-by-file
+Sort output by file location.
+
+@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.
+
+@end table