diff options
author | Bruno Haible <bruno@clisp.org> | 2003-02-13 20:23:30 +0000 |
---|---|---|
committer | Bruno Haible <bruno@clisp.org> | 2009-06-23 12:09:01 +0200 |
commit | b0b60dddcc47e1165ca6679792afb57f0a57a416 (patch) | |
tree | c2dae800839da11aca1ebd3732d0f79219be188b /doc | |
parent | 0cb77b26b6b27b1d5009f831f25ae0932f928db2 (diff) | |
download | external_gettext-b0b60dddcc47e1165ca6679792afb57f0a57a416.zip external_gettext-b0b60dddcc47e1165ca6679792afb57f0a57a416.tar.gz external_gettext-b0b60dddcc47e1165ca6679792afb57f0a57a416.tar.bz2 |
Move doc/xgettext.texi to gettext-tools/doc/xgettext.texi.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/xgettext.texi | 301 |
1 files changed, 0 insertions, 301 deletions
diff --git a/doc/xgettext.texi b/doc/xgettext.texi deleted file mode 100644 index 4c0ba4c..0000000 --- a/doc/xgettext.texi +++ /dev/null @@ -1,301 +0,0 @@ -@pindex xgettext -@cindex @code{xgettext} program, usage -@example -xgettext [@var{option}] [@var{inputfile}] @dots{} -@end example - -The @code{xgettext} program extracts translatable strings from given -input files. - -@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{xgettext} option} -@opindex --files-from@r{, @code{xgettext} 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{xgettext} option} -@opindex --directory@r{, @code{xgettext} 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 -d @var{name} -@itemx --default-domain=@var{name} -@opindex -d@r{, @code{xgettext} option} -@opindex --default-domain@r{, @code{xgettext} option} -Use @file{@var{name}.po} for output (instead of @file{messages.po}). - -@item -o @var{file} -@itemx --output=@var{file} -@opindex -o@r{, @code{xgettext} option} -@opindex --output@r{, @code{xgettext} option} -Write output to specified file (instead of @file{@var{name}.po} or -@file{messages.po}). - -@item -p @var{dir} -@itemx --output-dir=@var{dir} -@opindex -p@r{, @code{xgettext} option} -@opindex --output-dir@r{, @code{xgettext} option} -Output files will be placed in directory @var{dir}. - -@end table - -@cindex output to stdout, @code{xgettext} -If the output @var{file} is @samp{-} or @samp{/dev/stdout}, the output -is written to standard output. - -@subsection Choice of input file language - -@table @samp -@item -L @var{name} -@itemx --language=@var{name} -@opindex -L@r{, @code{xgettext} option} -@opindex --language@r{, @code{xgettext} option} -@cindex supported languages, @code{xgettext} -Specifies the language of the input files. The supported languages -are @code{C}, @code{C++}, @code{ObjectiveC}, @code{PO}, @code{Python}, -@code{Lisp}, @code{EmacsLisp}, @code{librep}, @code{Smalltalk}, @code{Java}, -@code{awk}, @code{YCP}, @code{Tcl}, @code{PHP}, @code{RST}, @code{Glade}. - -@item -C -@itemx --c++ -@opindex -C@r{, @code{xgettext} option} -@opindex --c++@r{, @code{xgettext} option} -This is a shorthand for @code{--language=C++}. - -@end table - -By default the language is guessed depending on the input file name -extension. - -@subsection Input file interpretation - -@table @samp -@item --from-code=@var{name} -@opindex --from-code@r{, @code{xgettext} option} -Specifies the encoding of the input files. This option is needed only -if some untranslated message strings or their corresponding comments -contain non-ASCII characters. Note that Python, Tcl, and Glade input -files are always assumed to be in UTF-8, regardless of this option. - -@end table - -By default the input files are assumed to be in ASCII. - -@subsection Operation mode - -@table @samp -@item -j -@itemx --join-existing -@opindex -j@r{, @code{xgettext} option} -@opindex --join-existing@r{, @code{xgettext} option} -Join messages with existing file. - -@item -x @var{file} -@itemx --exclude-file=@var{file} -@opindex -x@r{, @code{xgettext} option} -@opindex --exclude-file@r{, @code{xgettext} option} -Entries from @var{file} are not extracted. @var{file} should be a PO or -POT file. - -@item -c [@var{tag}] -@itemx --add-comments[=@var{tag}] -@opindex -c@r{, @code{xgettext} option} -@opindex --add-comments@r{, @code{xgettext} option} -Place comment block with @var{tag} (or those preceding keyword lines) -in output file. - -@end table - -@subsection Language=C/C++ specific options - -@table @samp -@item -a -@itemx --extract-all -@opindex -a@r{, @code{xgettext} option} -@opindex --extract-all@r{, @code{xgettext} option} -Extract all strings. - -@item -k @var{keywordspec} -@itemx --keyword[=@var{keywordspec}] -@opindex -k@r{, @code{xgettext} option} -@opindex --keyword@r{, @code{xgettext} option} -Additional keyword to be looked for (without @var{keywordspec} means not to -use default keywords). - -@cindex adding keywords, @code{xgettext} -If @var{keywordspec} is a C identifer @var{id}, @code{xgettext} looks -for strings in the first argument of each call to the function or macro -@var{id}. If @var{keywordspec} is of the form -@samp{@var{id}:@var{argnum}}, @code{xgettext} looks for strings in the -@var{argnum}th argument of the call. If @var{keywordspec} is of the form -@samp{@var{id}:@var{argnum1},@var{argnum2}}, @code{xgettext} looks for -strings in the @var{argnum1}st argument and in the @var{argnum2}nd argument -of the call, and treats them as singular/plural variants for a message -with plural handling. - -The default keyword specifications, which are always looked for if not -explicitly disabled, are @code{gettext}, @code{dgettext:2}, -@code{dcgettext:2}, @code{ngettext:1,2}, @code{dngettext:2,3}, -@code{dcngettext:2,3}, and @code{gettext_noop}. - -@item -T -@itemx --trigraphs -@opindex -T@r{, @code{xgettext} option} -@opindex --trigraphs@r{, @code{xgettext} option} -@cindex C trigraphs -Understand ANSI C trigraphs for input. - -@itemx --debug -@opindex --debug@r{, @code{xgettext} option} -@cindex debugging messages marked as format strings -Use the flags @kbd{c-format} and @kbd{possible-c-format} to show who was -responsible for marking a message as a format string. The latter form is -used if the @code{xgettext} program decided, the format form is used if -the programmer prescribed it. - -By default only the @kbd{c-format} form is used. The translator should -not have to care about these details. - -@end table - -This implementation of @code{xgettext} is able to process a few awkward -cases, like strings in preprocessor macros, ANSI concatenation of -adjacent strings, and escaped end of lines for continued strings. - -@subsection Output details - -@c --no-escape and --escape omitted on purpose. They are not useful. - -@table @samp -@item --force-po -@opindex --force-po@r{, @code{xgettext} option} -Always write an output file even if no message is defined. - -@item -i -@itemx --indent -@opindex -i@r{, @code{xgettext} option} -@opindex --indent@r{, @code{xgettext} option} -Write the .po file using indented style. - -@item --no-location -@opindex --no-location@r{, @code{xgettext} option} -Do not write @samp{#: @var{filename}:@var{line}} lines. - -@item -n -@itemx --add-location -@opindex -n@r{, @code{xgettext} option} -@opindex --add-location@r{, @code{xgettext} option} -Generate @samp{#: @var{filename}:@var{line}} lines (default). - -@item --strict -@opindex --strict@r{, @code{xgettext} 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{xgettext} option} -@opindex --width@r{, @code{xgettext} 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{xgettext} 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{xgettext} option} -@opindex --sort-output@r{, @code{xgettext} option} -@cindex sorting output of @code{xgettext} -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{xgettext} option} -@opindex --sort-by-file@r{, @code{xgettext} option} -Sort output by file location. - -@item --omit-header -@opindex --omit-header@r{, @code{xgettext} option} -Don't write header with @samp{msgid ""} entry. - -@cindex testing @file{.po} files for equivalence -This is useful for testing purposes because it eliminates a source -of variance for generated @code{.gmo} files. With @code{--omit-header}, -two invocations of @code{xgettext} on the same files with the same -options at different times are guaranteed to produce the same results. - -@item --copyright-holder=@var{string} -@opindex --copyright-holder@r{, @code{xgettext} option} -Set the copyright holder in the output. @var{string} should be the -copyright holder of the surrounding package. (Note that the msgstr -strings, extracted from the package's sources, belong to the copyright -holder of the package.) Translators are expected to transfer or disclaim -the copyright for their translations, so that package maintainers can -distribute them without legal risk. If @var{string} is empty, the output -files are marked as being in the public domain; in this case, the translators -are expected to disclaim their copyright, again so that package maintainers -can distribute them without legal risk. - -The default value for @var{string} is the Free Software Foundation, Inc., -simply because @code{xgettext} was first used in the GNU project. - -@item --foreign-user -@opindex --foreign-user@r{, @code{xgettext} option} -Omit FSF copyright in output. This option is equivalent to -@samp{--copyright-holder=''}. It can be useful for packages outside the GNU -project that want their translations to be in the public domain. - -@item -m [@var{string}] -@itemx --msgstr-prefix[=@var{string}] -@opindex -m@r{, @code{xgettext} option} -@opindex --msgstr-prefix@r{, @code{xgettext} option} -Use @var{string} (or "" if not specified) as prefix for msgstr entries. - -@item -M [@var{string}] -@itemx --msgstr-suffix[=@var{string}] -@opindex -M@r{, @code{xgettext} option} -@opindex --msgstr-suffix@r{, @code{xgettext} option} -Use @var{string} (or "" if not specified) as suffix for msgstr entries. - -@end table - -@subsection Informative output - -@table @samp -@item -h -@itemx --help -@opindex -h@r{, @code{xgettext} option} -@opindex --help@r{, @code{xgettext} option} -Display this help and exit. - -@item -V -@itemx --version -@opindex -V@r{, @code{xgettext} option} -@opindex --version@r{, @code{xgettext} option} -Output version information and exit. - -@end table |