summaryrefslogtreecommitdiff
path: root/gettext-tools/man/xgettext.1.html
blob: d43fdbecc3a790caadf496b5c90f9878ea61b64b (plain)
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
<!-- Creator     : groff version 1.22.3 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
       h1      { text-align: center }
</style>
<title>XGETTEXT</title>

</head>
<body>

<h1 align="center">XGETTEXT</h1>

<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#AUTHOR">AUTHOR</a><br>
<a href="#REPORTING BUGS">REPORTING BUGS</a><br>
<a href="#COPYRIGHT">COPYRIGHT</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>

<hr>


<h2>NAME
<a name="NAME"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">xgettext
&minus; extract gettext strings from source</p>

<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>



<p style="margin-left:11%; margin-top: 1em"><b>xgettext</b>
[<i>OPTION</i>] [<i>INPUTFILE</i>]...</p>

<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">Extract
translatable strings from given input files.</p>

<p style="margin-left:11%; margin-top: 1em">Mandatory
arguments to long options are mandatory for short options
too. Similarly for optional arguments.</p>

<p style="margin-left:11%; margin-top: 1em"><b>Input file
location:</b> <br>
INPUTFILE ...</p>

<p style="margin-left:22%;">input files</p>

<p style="margin-left:11%;"><b>&minus;f</b>,
<b>&minus;&minus;files&minus;from</b>=<i>FILE</i></p>

<p style="margin-left:22%;">get list of input files from
FILE</p>

<p style="margin-left:11%;"><b>&minus;D</b>,
<b>&minus;&minus;directory</b>=<i>DIRECTORY</i></p>

<p style="margin-left:22%;">add DIRECTORY to list for input
files search</p>

<p style="margin-left:11%; margin-top: 1em">If input file
is -, standard input is read.</p>

<p style="margin-left:11%; margin-top: 1em"><b>Output file
location: <br>
&minus;d</b>,
<b>&minus;&minus;default&minus;domain</b>=<i>NAME</i></p>

<p style="margin-left:22%;">use NAME.po for output (instead
of messages.po)</p>

<p style="margin-left:11%;"><b>&minus;o</b>,
<b>&minus;&minus;output</b>=<i>FILE</i></p>

<p style="margin-left:22%;">write output to specified
file</p>

<p style="margin-left:11%;"><b>&minus;p</b>,
<b>&minus;&minus;output&minus;dir</b>=<i>DIR</i></p>

<p style="margin-left:22%;">output files will be placed in
directory DIR</p>

<p style="margin-left:11%; margin-top: 1em">If output file
is -, output is written to standard output.</p>

<p style="margin-left:11%; margin-top: 1em"><b>Choice of
input file language: <br>
&minus;L</b>, <b>&minus;&minus;language</b>=<i>NAME</i></p>

<p style="margin-left:22%;">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)</p>

<p style="margin-left:11%;"><b>&minus;C</b>,
<b>&minus;&minus;c</b>++</p>

<p style="margin-left:22%;">shorthand for
<b>&minus;&minus;language</b>=<i>C</i>++</p>

<p style="margin-left:11%; margin-top: 1em">By default the
language is guessed depending on the input file name
extension.</p>

<p style="margin-left:11%; margin-top: 1em"><b>Input file
interpretation: <br>
&minus;&minus;from&minus;code</b>=<i>NAME</i></p>

<p style="margin-left:22%;">encoding of input files (except
for Python, Tcl, Glade)</p>

<p style="margin-left:11%; margin-top: 1em">By default the
input files are assumed to be in ASCII.</p>

<p style="margin-left:11%; margin-top: 1em"><b>Operation
mode: <br>
&minus;j</b>, <b>&minus;&minus;join&minus;existing</b></p>

<p style="margin-left:22%;">join messages with existing
file</p>

<p style="margin-left:11%;"><b>&minus;x</b>,
<b>&minus;&minus;exclude&minus;file</b>=<i>FILE</i>.po</p>

<p style="margin-left:22%;">entries from FILE.po are not
extracted</p>

<p style="margin-left:11%;"><b>&minus;cTAG</b>,
<b>&minus;&minus;add&minus;comments</b>=<i>TAG</i></p>

<p style="margin-left:22%;">place comment blocks starting
with TAG and preceding keyword lines in output file</p>

<p style="margin-left:11%;"><b>&minus;c</b>,
<b>&minus;&minus;add&minus;comments</b></p>

<p style="margin-left:22%;">place all comment blocks
preceding keyword lines in output file</p>


<p style="margin-left:11%;"><b>&minus;&minus;check</b>=<i>NAME</i></p>

<p style="margin-left:22%;">perform syntax check on
messages (ellipsis-unicode, space-ellipsis,</p>


<p style="margin-left:22%; margin-top: 1em">quote-unicode)</p>


<p style="margin-left:11%;"><b>&minus;&minus;sentence&minus;end</b>=<i>TYPE</i></p>

<p style="margin-left:22%;">type describing the end of
sentence (single-space, which is the default,</p>

<p style="margin-left:22%; margin-top: 1em">or
double-space)</p>

<p style="margin-left:11%; margin-top: 1em"><b>Language
specific options: <br>
&minus;a</b>, <b>&minus;&minus;extract&minus;all</b></p>

<p style="margin-left:22%;">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)</p>

<p style="margin-left:11%;"><b>&minus;kWORD</b>,
<b>&minus;&minus;keyword</b>=<i>WORD</i></p>

<p style="margin-left:22%;">look for WORD as an additional
keyword</p>

<p style="margin-left:11%;"><b>&minus;k</b>,
<b>&minus;&minus;keyword</b></p>

<p style="margin-left:22%;">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)</p>


<p style="margin-left:11%;"><b>&minus;&minus;flag</b>=<i>WORD</i>:ARG:FLAG</p>

<p style="margin-left:22%;">additional flag for strings
inside the argument number ARG of keyword WORD</p>

<p style="margin-left:22%; margin-top: 1em">(only languages
C, C++, ObjectiveC, Shell, Python, Lisp, EmacsLisp, librep,
Scheme, Java, C#, awk, YCP, Tcl, Perl, PHP, GCC-source, Lua,
JavaScript, Vala)</p>

<p style="margin-left:11%;"><b>&minus;T</b>,
<b>&minus;&minus;trigraphs</b></p>

<p style="margin-left:22%;">understand ANSI C trigraphs for
input (only languages C, C++, ObjectiveC)</p>

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="7%">


<p><b>&minus;&minus;qt</b></p></td>
<td width="4%"></td>
<td width="76%">


<p>recognize Qt format strings (only language C++)</p></td>
<td width="2%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="7%">


<p><b>&minus;&minus;kde</b></p></td>
<td width="4%"></td>
<td width="76%">


<p>recognize KDE 4 format strings (only language C++)</p></td>
<td width="2%">
</td></tr>
</table>

<p style="margin-left:11%;"><b>&minus;&minus;boost</b></p>

<p style="margin-left:22%;">recognize Boost format strings
(only language C++)</p>

<p style="margin-left:11%;"><b>&minus;&minus;debug</b></p>

<p style="margin-left:22%;">more detailed formatstring
recognition result</p>

<p style="margin-left:11%; margin-top: 1em"><b>Output
details: <br>
&minus;&minus;color</b></p>

<p style="margin-left:22%;">use colors and other text
attributes always</p>


<p style="margin-left:11%;"><b>&minus;&minus;color</b>=<i>WHEN</i></p>

<p style="margin-left:22%;">use colors and other text
attributes if WHEN. WHEN may be &rsquo;always&rsquo;,
&rsquo;never&rsquo;, &rsquo;auto&rsquo;, or
&rsquo;html&rsquo;.</p>


<p style="margin-left:11%;"><b>&minus;&minus;style</b>=<i>STYLEFILE</i></p>

<p style="margin-left:22%;">specify CSS style rule file for
<b>&minus;&minus;color</b></p>

<p style="margin-left:11%;"><b>&minus;e</b>,
<b>&minus;&minus;no&minus;escape</b></p>

<p style="margin-left:22%;">do not use C escapes in output
(default)</p>

<p style="margin-left:11%;"><b>&minus;E</b>,
<b>&minus;&minus;escape</b></p>

<p style="margin-left:22%;">use C escapes in output, no
extended chars</p>


<p style="margin-left:11%;"><b>&minus;&minus;force&minus;po</b></p>

<p style="margin-left:22%;">write PO file even if empty</p>

<p style="margin-left:11%;"><b>&minus;i</b>,
<b>&minus;&minus;indent</b></p>

<p style="margin-left:22%;">write the .po file using
indented style</p>


<p style="margin-left:11%;"><b>&minus;&minus;no&minus;location</b></p>

<p style="margin-left:22%;">do not write &rsquo;#:
filename:line&rsquo; lines</p>

<p style="margin-left:11%;"><b>&minus;n</b>,
<b>&minus;&minus;add&minus;location</b></p>

<p style="margin-left:22%;">generate &rsquo;#:
filename:line&rsquo; lines (default)</p>


<p style="margin-left:11%;"><b>&minus;&minus;strict</b></p>

<p style="margin-left:22%;">write out strict Uniforum
conforming .po file</p>


<p style="margin-left:11%;"><b>&minus;&minus;properties&minus;output</b></p>

<p style="margin-left:22%;">write out a Java .properties
file</p>


<p style="margin-left:11%;"><b>&minus;&minus;stringtable&minus;output</b></p>

<p style="margin-left:22%;">write out a NeXTstep/GNUstep
.strings file</p>


<p style="margin-left:11%;"><b>&minus;&minus;its</b>=<i>FILE</i></p>

<p style="margin-left:22%;">apply ITS rules from FILE</p>


<p style="margin-left:11%;"><b>&minus;&minus;itstool</b></p>

<p style="margin-left:22%;">write out itstool comments</p>

<p style="margin-left:11%;"><b>&minus;w</b>,
<b>&minus;&minus;width</b>=<i>NUMBER</i></p>

<p style="margin-left:22%;">set output page width</p>


<p style="margin-left:11%;"><b>&minus;&minus;no&minus;wrap</b></p>

<p style="margin-left:22%;">do not break long message
lines, longer than the output page width, into several
lines</p>

<p style="margin-left:11%;"><b>&minus;s</b>,
<b>&minus;&minus;sort&minus;output</b></p>

<p style="margin-left:22%;">generate sorted output</p>

<p style="margin-left:11%;"><b>&minus;F</b>,
<b>&minus;&minus;sort&minus;by&minus;file</b></p>

<p style="margin-left:22%;">sort output by file
location</p>


<p style="margin-left:11%;"><b>&minus;&minus;omit&minus;header</b></p>

<p style="margin-left:22%;">don&rsquo;t write header with
&rsquo;msgid &quot;&quot;&rsquo; entry</p>


<p style="margin-left:11%;"><b>&minus;&minus;copyright&minus;holder</b>=<i>STRING</i></p>

<p style="margin-left:22%;">set copyright holder in
output</p>


<p style="margin-left:11%;"><b>&minus;&minus;foreign&minus;user</b></p>

<p style="margin-left:22%;">omit FSF copyright in output
for foreign user</p>


<p style="margin-left:11%;"><b>&minus;&minus;package&minus;name</b>=<i>PACKAGE</i></p>

<p style="margin-left:22%;">set package name in output</p>


<p style="margin-left:11%;"><b>&minus;&minus;package&minus;version</b>=<i>VERSION</i></p>

<p style="margin-left:22%;">set package version in
output</p>


<p style="margin-left:11%;"><b>&minus;&minus;msgid&minus;bugs&minus;address</b>=<i>EMAIL</i>@ADDRESS</p>

<p style="margin-left:22%;">set report address for msgid
bugs</p>

<p style="margin-left:11%;"><b>&minus;m[STRING]</b>,
<b>&minus;&minus;msgstr&minus;prefix</b>[=<i>STRING</i>]</p>

<p style="margin-left:22%;">use STRING or &quot;&quot; as
prefix for msgstr values</p>

<p style="margin-left:11%;"><b>&minus;M[STRING]</b>,
<b>&minus;&minus;msgstr&minus;suffix</b>[=<i>STRING</i>]</p>

<p style="margin-left:22%;">use STRING or &quot;&quot; as
suffix for msgstr values</p>

<p style="margin-left:11%; margin-top: 1em"><b>Informative
output: <br>
&minus;h</b>, <b>&minus;&minus;help</b></p>

<p style="margin-left:22%;">display this help and exit</p>

<p style="margin-left:11%;"><b>&minus;V</b>,
<b>&minus;&minus;version</b></p>

<p style="margin-left:22%;">output version information and
exit</p>

<h2>AUTHOR
<a name="AUTHOR"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">Written by
Ulrich Drepper.</p>

<h2>REPORTING BUGS
<a name="REPORTING BUGS"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">Report bugs to
&lt;bug-gnu-gettext@gnu.org&gt;.</p>

<h2>COPYRIGHT
<a name="COPYRIGHT"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">Copyright
&copy; 1995-1998, 2000-2013 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later
&lt;http://gnu.org/licenses/gpl.html&gt; <br>
This is free software: you are free to change and
redistribute it. There is NO WARRANTY, to the extent
permitted by law.</p>

<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">The full
documentation for <b>xgettext</b> is maintained as a Texinfo
manual. If the <b>info</b> and <b>xgettext</b> programs are
properly installed at your site, the command</p>

<p style="margin-left:22%; margin-top: 1em"><b>info
xgettext</b></p>

<p style="margin-left:11%; margin-top: 1em">should give you
access to the complete manual.</p>
<hr>
</body>
</html>