summaryrefslogtreecommitdiffstats
path: root/gettext-tools
diff options
context:
space:
mode:
authorBruno Haible <bruno@clisp.org>2003-02-13 20:19:43 +0000
committerBruno Haible <bruno@clisp.org>2009-06-23 12:09:00 +0200
commit9ad5c8038c0c694682fabe5c77b6e355e3370494 (patch)
tree148f8959b0e632b647946acbd1202bd08c54d84a /gettext-tools
parentd80ffdc718dd1d2bd4f7bb185c897c84f5016367 (diff)
downloadexternal_gettext-9ad5c8038c0c694682fabe5c77b6e355e3370494.zip
external_gettext-9ad5c8038c0c694682fabe5c77b6e355e3370494.tar.gz
external_gettext-9ad5c8038c0c694682fabe5c77b6e355e3370494.tar.bz2
Move doc/msgcat.texi to gettext-tools/doc/msgcat.texi.
Diffstat (limited to 'gettext-tools')
-rw-r--r--gettext-tools/doc/msgcat.texi172
1 files changed, 172 insertions, 0 deletions
diff --git a/gettext-tools/doc/msgcat.texi b/gettext-tools/doc/msgcat.texi
new file mode 100644
index 0000000..795ced5
--- /dev/null
+++ b/gettext-tools/doc/msgcat.texi
@@ -0,0 +1,172 @@
+@pindex msgcat
+@cindex @code{msgcat} program, usage
+@example
+msgcat [@var{option}] [@var{inputfile}]...
+@end example
+
+@cindex concatenate PO files
+@cindex merge PO files
+The @code{msgcat} program concatenates and merges the specified PO files.
+It finds messages which are common to two or more of the specified PO files.
+By using the @code{--more-than} option, greater commonality may be requested
+before messages are printed. Conversely, the @code{--less-than} option may be
+used to specify less commonality before messages are printed (i.e.
+@samp{--less-than=2} will only print the unique messages). Translations,
+comments and extract comments will be cumulated, except that if
+@code{--use-first} is specified, they will be taken from the first PO file
+to define them. File positions from all PO files will be cumulated.
+
+@subsection Input file location
+
+@table @samp
+@item @var{inputfile} @dots{}
+Input files.
+
+@item -f @var{file}
+@itemx --files-from=@var{file}
+@opindex -f@r{, @code{msgcat} option}
+@opindex --files-from@r{, @code{msgcat} option}
+Read the names of the input files from @var{file} instead of getting
+them from the command line.
+
+@item -D @var{directory}
+@itemx --directory=@var{directory}
+@opindex -D@r{, @code{msgcat} option}
+@opindex --directory@r{, @code{msgcat} option}
+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}
+@opindex -o@r{, @code{msgcat} option}
+@opindex --output-file@r{, @code{msgcat} option}
+Write output to specified file.
+
+@end table
+
+@cindex standard output, and @code{msgcat}
+The results are written to standard output if no output file is specified
+or if it is @samp{-}.
+
+@subsection Message selection
+
+@table @samp
+@item -< @var{number}
+@itemx --less-than=@var{number}
+@opindex -<@r{, @code{msgcat} option}
+@opindex --less-than@r{, @code{msgcat} option}
+Print messages with less than @var{number} definitions, defaults to infinite
+if not set.
+
+@item -> @var{number}
+@itemx --more-than=@var{number}
+@opindex ->@r{, @code{msgcat} option}
+@opindex --more-than@r{, @code{msgcat} option}
+Print messages with more than @var{number} definitions, defaults to 0 if not
+set.
+
+@item -u
+@itemx --unique
+@opindex -u@r{, @code{msgcat} option}
+@opindex --unique@r{, @code{msgcat} option}
+Shorthand for @samp{--less-than=2}. Requests that only unique messages be
+printed.
+
+@end table
+
+@subsection Output details
+
+@c --no-escape and --escape omitted on purpose. They are not useful.
+
+@table @samp
+@item -t
+@itemx --to-code=@var{name}
+@opindex -t@r{, @code{msgcat} option}
+@opindex --to-code@r{, @code{msgcat} option}
+Specify encoding for output.
+
+@item --use-first
+@opindex --use-first@r{, @code{msgcat} option}
+Use first available translation for each message. Don't merge several
+translations into one.
+
+@item --force-po
+@opindex --force-po@r{, @code{msgcat} option}
+Always write an output file even if it contains no message.
+
+@item -i
+@itemx --indent
+@opindex -i@r{, @code{msgcat} option}
+@opindex --indent@r{, @code{msgcat} option}
+Write the .po file using indented style.
+
+@item --no-location
+@opindex --no-location@r{, @code{msgcat} option}
+Do not write @samp{#: @var{filename}:@var{line}} lines.
+
+@item -n
+@itemx --add-location
+@opindex -n@r{, @code{msgcat} option}
+@opindex --add-location@r{, @code{msgcat} option}
+Generate @samp{#: @var{filename}:@var{line}} lines (default).
+
+@item --strict
+@opindex --strict@r{, @code{msgcat} option}
+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}
+@opindex -w@r{, @code{msgcat} option}
+@opindex --width@r{, @code{msgcat} option}
+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 --no-wrap
+@opindex --no-wrap@r{, @code{msgcat} option}
+Do not break long message lines. Message lines whose width exceeds the
+output page width will not be split into several lines. Only file reference
+lines which are wider than the output page width will be split.
+
+@item -s
+@itemx --sort-output
+@opindex -s@r{, @code{msgcat} option}
+@opindex --sort-output@r{, @code{msgcat} option}
+@cindex sorting @code{msgcat} 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
+@opindex -F@r{, @code{msgcat} option}
+@opindex --sort-by-file@r{, @code{msgcat} option}
+Sort output by file location.
+
+@end table
+
+@subsection Informative output
+
+@table @samp
+@item -h
+@itemx --help
+@opindex -h@r{, @code{msgcat} option}
+@opindex --help@r{, @code{msgcat} option}
+Display this help and exit.
+
+@item -V
+@itemx --version
+@opindex -V@r{, @code{msgcat} option}
+@opindex --version@r{, @code{msgcat} option}
+Output version information and exit.
+
+@end table