1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH XGETTEXT "1" "February 2023" "GNU gettext-tools 0.21" "User Commands"
.SH NAME
xgettext \- extract gettext strings from source
.SH SYNOPSIS
.B xgettext
[\fI\,OPTION\/\fR] [\fI\,INPUTFILE\/\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=\fI\,FILE\/\fR
get list of input files from FILE
.TP
\fB\-D\fR, \fB\-\-directory\fR=\fI\,DIRECTORY\/\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=\fI\,NAME\/\fR
use NAME.po for output (instead of messages.po)
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR
write output to specified file
.TP
\fB\-p\fR, \fB\-\-output\-dir\fR=\fI\,DIR\/\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=\fI\,NAME\/\fR
recognise the specified language
(C, C++, ObjectiveC, PO, Shell, Python, Lisp,
EmacsLisp, librep, Scheme, Smalltalk, Java,
JavaProperties, C#, awk, YCP, Tcl, Perl, PHP,
Ruby, GCC\-source, NXStringTable, RST, RSJ,
Glade, Lua, JavaScript, Vala, Desktop)
.TP
\fB\-C\fR, \fB\-\-c\fR++
shorthand for \fB\-\-language\fR=\fI\,C\/\fR++
.PP
By default the language is guessed depending on the input file name extension.
.SS "Input file interpretation:"
.TP
\fB\-\-from\-code\fR=\fI\,NAME\/\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=\fI\,FILE\/\fR.po
entries from FILE.po are not extracted
.TP
\fB\-cTAG\fR, \fB\-\-add\-comments\fR=\fI\,TAG\/\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=\fI\,NAME\/\fR
perform syntax check on messages
(ellipsis\-unicode, space\-ellipsis,
.IP
quote\-unicode, bullet\-unicode)
.TP
\fB\-\-sentence\-end\fR=\fI\,TYPE\/\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=\fI\,WORD\/\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=\fI\,WORD\/\fR:ARG:FLAG
additional flag for strings inside the argument
number ARG of keyword WORD
.TP
(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\-\-its\fR=\fI\,FILE\/\fR
apply ITS rules from FILE
(only XML based languages)
.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=\fI\,WHEN\/\fR
use colors and other text attributes if WHEN.
WHEN may be 'always', 'never', 'auto', or 'html'.
.TP
\fB\-\-style\fR=\fI\,STYLEFILE\/\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\-\-itstool\fR
write out itstool comments
.TP
\fB\-w\fR, \fB\-\-width\fR=\fI\,NUMBER\/\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=\fI\,STRING\/\fR
set copyright holder in output
.TP
\fB\-\-foreign\-user\fR
omit FSF copyright in output for foreign user
.TP
\fB\-\-package\-name\fR=\fI\,PACKAGE\/\fR
set package name in output
.TP
\fB\-\-package\-version\fR=\fI\,VERSION\/\fR
set package version in output
.TP
\fB\-\-msgid\-bugs\-address\fR=\fI\,EMAIL\/\fR@ADDRESS
set report address for msgid bugs
.TP
\fB\-m[STRING]\fR, \fB\-\-msgstr\-prefix\fR[=\fI\,STRING\/\fR]
use STRING or "" as prefix for msgstr
values
.TP
\fB\-M[STRING]\fR, \fB\-\-msgstr\-suffix\fR[=\fI\,STRING\/\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
.TP
\fB\-v\fR, \fB\-\-verbose\fR
increase verbosity level
.SH AUTHOR
Written by Ulrich Drepper.
.SH "REPORTING BUGS"
Report bugs in the bug tracker at <https://savannah.gnu.org/projects/gettext>
or by email to <bug\-gettext@gnu.org>.
.SH COPYRIGHT
Copyright \(co 1995\-2020 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <https://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.
|
