239 lines
6.2 KiB
Groff
Executable File
239 lines
6.2 KiB
Groff
Executable File
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.24.
|
|
.TH XGETTEXT "1" "July 2015" "GNU gettext-tools 0.19.5.1" GNU
|
|
.SH NAME
|
|
xgettext \- extract gettext strings from source
|
|
.SH SYNOPSIS
|
|
.B xgettext
|
|
[\fIOPTION\fR] [\fIINPUTFILE\fR]...
|
|
.SH DESCRIPTION
|
|
.\" Add any additional description here
|
|
.PP
|
|
Extract translatable strings from given input files.
|
|
.PP
|
|
Mandatory arguments to long options are mandatory for short options too.
|
|
Similarly for optional arguments.
|
|
.SS "Input file location:"
|
|
.TP
|
|
INPUTFILE ...
|
|
input files
|
|
.TP
|
|
\fB\-f\fR, \fB\-\-files\-from\fR=\fIFILE\fR
|
|
get list of input files from FILE
|
|
.TP
|
|
\fB\-D\fR, \fB\-\-directory\fR=\fIDIRECTORY\fR
|
|
add DIRECTORY to list for input files search
|
|
.PP
|
|
If input file is -, standard input is read.
|
|
.SS "Output file location:"
|
|
.TP
|
|
\fB\-d\fR, \fB\-\-default\-domain\fR=\fINAME\fR
|
|
use NAME.po for output (instead of messages.po)
|
|
.TP
|
|
\fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR
|
|
write output to specified file
|
|
.TP
|
|
\fB\-p\fR, \fB\-\-output\-dir\fR=\fIDIR\fR
|
|
output files will be placed in directory DIR
|
|
.PP
|
|
If output file is -, output is written to standard output.
|
|
.SS "Choice of input file language:"
|
|
.TP
|
|
\fB\-L\fR, \fB\-\-language\fR=\fINAME\fR
|
|
recognise the specified language
|
|
(C, C++, ObjectiveC, PO, Shell, Python, Lisp,
|
|
EmacsLisp, librep, Scheme, Smalltalk, Java,
|
|
JavaProperties, C#, awk, YCP, Tcl, Perl, PHP,
|
|
GCC-source, NXStringTable, RST, Glade, Lua,
|
|
JavaScript, Vala, Desktop)
|
|
.TP
|
|
\fB\-C\fR, \fB\-\-c\fR++
|
|
shorthand for \fB\-\-language\fR=\fIC\fR++
|
|
.PP
|
|
By default the language is guessed depending on the input file name extension.
|
|
.SS "Input file interpretation:"
|
|
.TP
|
|
\fB\-\-from\-code\fR=\fINAME\fR
|
|
encoding of input files
|
|
(except for Python, Tcl, Glade)
|
|
.PP
|
|
By default the input files are assumed to be in ASCII.
|
|
.SS "Operation mode:"
|
|
.TP
|
|
\fB\-j\fR, \fB\-\-join\-existing\fR
|
|
join messages with existing file
|
|
.TP
|
|
\fB\-x\fR, \fB\-\-exclude\-file\fR=\fIFILE\fR.po
|
|
entries from FILE.po are not extracted
|
|
.TP
|
|
\fB\-cTAG\fR, \fB\-\-add\-comments\fR=\fITAG\fR
|
|
place comment blocks starting with TAG and
|
|
preceding keyword lines in output file
|
|
.TP
|
|
\fB\-c\fR, \fB\-\-add\-comments\fR
|
|
place all comment blocks preceding keyword lines
|
|
in output file
|
|
.TP
|
|
\fB\-\-check\fR=\fINAME\fR
|
|
perform syntax check on messages
|
|
(ellipsis-unicode, space-ellipsis,
|
|
.IP
|
|
quote-unicode)
|
|
.TP
|
|
\fB\-\-sentence\-end\fR=\fITYPE\fR
|
|
type describing the end of sentence
|
|
(single-space, which is the default,
|
|
.IP
|
|
or double-space)
|
|
.SS "Language specific options:"
|
|
.TP
|
|
\fB\-a\fR, \fB\-\-extract\-all\fR
|
|
extract all strings
|
|
(only languages C, C++, ObjectiveC, Shell,
|
|
Python, Lisp, EmacsLisp, librep, Scheme, Java,
|
|
C#, awk, Tcl, Perl, PHP, GCC-source, Glade,
|
|
Lua, JavaScript, Vala)
|
|
.TP
|
|
\fB\-kWORD\fR, \fB\-\-keyword\fR=\fIWORD\fR
|
|
look for WORD as an additional keyword
|
|
.TP
|
|
\fB\-k\fR, \fB\-\-keyword\fR
|
|
do not to use default keywords
|
|
(only languages C, C++, ObjectiveC, Shell,
|
|
Python, Lisp, EmacsLisp, librep, Scheme, Java,
|
|
C#, awk, Tcl, Perl, PHP, GCC-source, Glade,
|
|
Lua, JavaScript, Vala, Desktop)
|
|
.TP
|
|
\fB\-\-flag\fR=\fIWORD\fR:ARG:FLAG
|
|
additional flag for strings inside the argument
|
|
number ARG of keyword WORD
|
|
.IP
|
|
(only languages C, C++, ObjectiveC, Shell,
|
|
Python, Lisp, EmacsLisp, librep, Scheme, Java,
|
|
C#, awk, YCP, Tcl, Perl, PHP, GCC-source,
|
|
Lua, JavaScript, Vala)
|
|
.TP
|
|
\fB\-T\fR, \fB\-\-trigraphs\fR
|
|
understand ANSI C trigraphs for input
|
|
(only languages C, C++, ObjectiveC)
|
|
.TP
|
|
\fB\-\-qt\fR
|
|
recognize Qt format strings
|
|
(only language C++)
|
|
.TP
|
|
\fB\-\-kde\fR
|
|
recognize KDE 4 format strings
|
|
(only language C++)
|
|
.TP
|
|
\fB\-\-boost\fR
|
|
recognize Boost format strings
|
|
(only language C++)
|
|
.TP
|
|
\fB\-\-debug\fR
|
|
more detailed formatstring recognition result
|
|
.SS "Output details:"
|
|
.TP
|
|
\fB\-\-color\fR
|
|
use colors and other text attributes always
|
|
.TP
|
|
\fB\-\-color\fR=\fIWHEN\fR
|
|
use colors and other text attributes if WHEN.
|
|
WHEN may be 'always', 'never', 'auto', or 'html'.
|
|
.TP
|
|
\fB\-\-style\fR=\fISTYLEFILE\fR
|
|
specify CSS style rule file for \fB\-\-color\fR
|
|
.TP
|
|
\fB\-e\fR, \fB\-\-no\-escape\fR
|
|
do not use C escapes in output (default)
|
|
.TP
|
|
\fB\-E\fR, \fB\-\-escape\fR
|
|
use C escapes in output, no extended chars
|
|
.TP
|
|
\fB\-\-force\-po\fR
|
|
write PO file even if empty
|
|
.TP
|
|
\fB\-i\fR, \fB\-\-indent\fR
|
|
write the .po file using indented style
|
|
.TP
|
|
\fB\-\-no\-location\fR
|
|
do not write '#: filename:line' lines
|
|
.TP
|
|
\fB\-n\fR, \fB\-\-add\-location\fR
|
|
generate '#: filename:line' lines (default)
|
|
.TP
|
|
\fB\-\-strict\fR
|
|
write out strict Uniforum conforming .po file
|
|
.TP
|
|
\fB\-\-properties\-output\fR
|
|
write out a Java .properties file
|
|
.TP
|
|
\fB\-\-stringtable\-output\fR
|
|
write out a NeXTstep/GNUstep .strings file
|
|
.TP
|
|
\fB\-w\fR, \fB\-\-width\fR=\fINUMBER\fR
|
|
set output page width
|
|
.TP
|
|
\fB\-\-no\-wrap\fR
|
|
do not break long message lines, longer than
|
|
the output page width, into several lines
|
|
.TP
|
|
\fB\-s\fR, \fB\-\-sort\-output\fR
|
|
generate sorted output
|
|
.TP
|
|
\fB\-F\fR, \fB\-\-sort\-by\-file\fR
|
|
sort output by file location
|
|
.TP
|
|
\fB\-\-omit\-header\fR
|
|
don't write header with 'msgid ""' entry
|
|
.TP
|
|
\fB\-\-copyright\-holder\fR=\fISTRING\fR
|
|
set copyright holder in output
|
|
.TP
|
|
\fB\-\-foreign\-user\fR
|
|
omit FSF copyright in output for foreign user
|
|
.TP
|
|
\fB\-\-package\-name\fR=\fIPACKAGE\fR
|
|
set package name in output
|
|
.TP
|
|
\fB\-\-package\-version\fR=\fIVERSION\fR
|
|
set package version in output
|
|
.TP
|
|
\fB\-\-msgid\-bugs\-address\fR=\fIEMAIL\fR@ADDRESS
|
|
set report address for msgid bugs
|
|
.TP
|
|
\fB\-m[STRING]\fR, \fB\-\-msgstr\-prefix\fR[=\fISTRING\fR]
|
|
use STRING or "" as prefix for msgstr
|
|
values
|
|
.TP
|
|
\fB\-M[STRING]\fR, \fB\-\-msgstr\-suffix\fR[=\fISTRING\fR]
|
|
use STRING or "" as suffix for msgstr
|
|
values
|
|
.SS "Informative output:"
|
|
.TP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
display this help and exit
|
|
.TP
|
|
\fB\-V\fR, \fB\-\-version\fR
|
|
output version information and exit
|
|
.SH AUTHOR
|
|
Written by Ulrich Drepper.
|
|
.SH "REPORTING BUGS"
|
|
Report bugs to <bug-gnu-gettext@gnu.org>.
|
|
.SH COPYRIGHT
|
|
Copyright \(co 1995-1998, 2000-2013 Free Software Foundation, Inc.
|
|
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
|
|
.br
|
|
This is free software: you are free to change and redistribute it.
|
|
There is NO WARRANTY, to the extent permitted by law.
|
|
.SH "SEE ALSO"
|
|
The full documentation for
|
|
.B xgettext
|
|
is maintained as a Texinfo manual. If the
|
|
.B info
|
|
and
|
|
.B xgettext
|
|
programs are properly installed at your site, the command
|
|
.IP
|
|
.B info xgettext
|
|
.PP
|
|
should give you access to the complete manual.
|