Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/doc/gettext/xgettext.1.html @ 68:5028fdace37b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 16:23:26 -0400
parents
children
comparison
equal deleted inserted replaced
67:0e9998148a16 68:5028fdace37b
1 <!-- Creator : groff version 1.22.3 -->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
3 "http://www.w3.org/TR/html4/loose.dtd">
4 <html>
5 <head>
6 <meta name="generator" content="groff -Thtml, see www.gnu.org">
7 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
8 <meta name="Content-Style" content="text/css">
9 <style type="text/css">
10 p { margin-top: 0; margin-bottom: 0; vertical-align: top }
11 pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
12 table { margin-top: 0; margin-bottom: 0; vertical-align: top }
13 h1 { text-align: center }
14 </style>
15 <title>XGETTEXT</title>
16
17 </head>
18 <body>
19
20 <h1 align="center">XGETTEXT</h1>
21
22 <a href="#NAME">NAME</a><br>
23 <a href="#SYNOPSIS">SYNOPSIS</a><br>
24 <a href="#DESCRIPTION">DESCRIPTION</a><br>
25 <a href="#AUTHOR">AUTHOR</a><br>
26 <a href="#REPORTING BUGS">REPORTING BUGS</a><br>
27 <a href="#COPYRIGHT">COPYRIGHT</a><br>
28 <a href="#SEE ALSO">SEE ALSO</a><br>
29
30 <hr>
31
32
33 <h2>NAME
34 <a name="NAME"></a>
35 </h2>
36
37
38 <p style="margin-left:11%; margin-top: 1em">xgettext
39 - extract gettext strings from source</p>
40
41 <h2>SYNOPSIS
42 <a name="SYNOPSIS"></a>
43 </h2>
44
45
46
47 <p style="margin-left:11%; margin-top: 1em"><b>xgettext</b>
48 [<i>OPTION</i>] [<i>INPUTFILE</i>]...</p>
49
50 <h2>DESCRIPTION
51 <a name="DESCRIPTION"></a>
52 </h2>
53
54
55 <p style="margin-left:11%; margin-top: 1em">Extract
56 translatable strings from given input files.</p>
57
58 <p style="margin-left:11%; margin-top: 1em">Mandatory
59 arguments to long options are mandatory for short options
60 too. Similarly for optional arguments.</p>
61
62 <p style="margin-left:11%; margin-top: 1em"><b>Input file
63 location:</b> <br>
64 INPUTFILE ...</p>
65
66 <p style="margin-left:22%;">input files</p>
67
68 <p style="margin-left:11%;"><b>-f</b>,
69 <b>--files-from</b>=<i>FILE</i></p>
70
71 <p style="margin-left:22%;">get list of input files from
72 FILE</p>
73
74 <p style="margin-left:11%;"><b>-D</b>,
75 <b>--directory</b>=<i>DIRECTORY</i></p>
76
77 <p style="margin-left:22%;">add DIRECTORY to list for input
78 files search</p>
79
80 <p style="margin-left:11%; margin-top: 1em">If input file
81 is -, standard input is read.</p>
82
83 <p style="margin-left:11%; margin-top: 1em"><b>Output file
84 location: <br>
85 -d</b>,
86 <b>--default-domain</b>=<i>NAME</i></p>
87
88 <p style="margin-left:22%;">use NAME.po for output (instead
89 of messages.po)</p>
90
91 <p style="margin-left:11%;"><b>-o</b>,
92 <b>--output</b>=<i>FILE</i></p>
93
94 <p style="margin-left:22%;">write output to specified
95 file</p>
96
97 <p style="margin-left:11%;"><b>-p</b>,
98 <b>--output-dir</b>=<i>DIR</i></p>
99
100 <p style="margin-left:22%;">output files will be placed in
101 directory DIR</p>
102
103 <p style="margin-left:11%; margin-top: 1em">If output file
104 is -, output is written to standard output.</p>
105
106 <p style="margin-left:11%; margin-top: 1em"><b>Choice of
107 input file language: <br>
108 -L</b>, <b>--language</b>=<i>NAME</i></p>
109
110 <p style="margin-left:22%;">recognise the specified
111 language (C, C++, ObjectiveC, PO, Shell, Python, Lisp,
112 EmacsLisp, librep, Scheme, Smalltalk, Java, JavaProperties,
113 C#, awk, YCP, Tcl, Perl, PHP, Ruby, GCC-source,
114 NXStringTable, RST, RSJ, Glade, Lua, JavaScript, Vala,
115 Desktop)</p>
116
117 <p style="margin-left:11%;"><b>-C</b>,
118 <b>--c</b>++</p>
119
120 <p style="margin-left:22%;">shorthand for
121 <b>--language</b>=<i>C</i>++</p>
122
123 <p style="margin-left:11%; margin-top: 1em">By default the
124 language is guessed depending on the input file name
125 extension.</p>
126
127 <p style="margin-left:11%; margin-top: 1em"><b>Input file
128 interpretation: <br>
129 --from-code</b>=<i>NAME</i></p>
130
131 <p style="margin-left:22%;">encoding of input files (except
132 for Python, Tcl, Glade)</p>
133
134 <p style="margin-left:11%; margin-top: 1em">By default the
135 input files are assumed to be in ASCII.</p>
136
137 <p style="margin-left:11%; margin-top: 1em"><b>Operation
138 mode: <br>
139 -j</b>, <b>--join-existing</b></p>
140
141 <p style="margin-left:22%;">join messages with existing
142 file</p>
143
144 <p style="margin-left:11%;"><b>-x</b>,
145 <b>--exclude-file</b>=<i>FILE</i>.po</p>
146
147 <p style="margin-left:22%;">entries from FILE.po are not
148 extracted</p>
149
150 <p style="margin-left:11%;"><b>-cTAG</b>,
151 <b>--add-comments</b>=<i>TAG</i></p>
152
153 <p style="margin-left:22%;">place comment blocks starting
154 with TAG and preceding keyword lines in output file</p>
155
156 <p style="margin-left:11%;"><b>-c</b>,
157 <b>--add-comments</b></p>
158
159 <p style="margin-left:22%;">place all comment blocks
160 preceding keyword lines in output file</p>
161
162
163 <p style="margin-left:11%;"><b>--check</b>=<i>NAME</i></p>
164
165 <p style="margin-left:22%;">perform syntax check on
166 messages (ellipsis-unicode, space-ellipsis,</p>
167
168
169 <p style="margin-left:22%; margin-top: 1em">quote-unicode,
170 bullet-unicode)</p>
171
172
173 <p style="margin-left:11%;"><b>--sentence-end</b>=<i>TYPE</i></p>
174
175 <p style="margin-left:22%;">type describing the end of
176 sentence (single-space, which is the default,</p>
177
178 <p style="margin-left:22%; margin-top: 1em">or
179 double-space)</p>
180
181 <p style="margin-left:11%; margin-top: 1em"><b>Language
182 specific options: <br>
183 -a</b>, <b>--extract-all</b></p>
184
185 <p style="margin-left:22%;">extract all strings (only
186 languages C, C++, ObjectiveC, Shell, Python, Lisp,
187 EmacsLisp, librep, Scheme, Java, C#, awk, Tcl, Perl, PHP,
188 GCC-source, Glade, Lua, JavaScript, Vala)</p>
189
190 <p style="margin-left:11%;"><b>-kWORD</b>,
191 <b>--keyword</b>=<i>WORD</i></p>
192
193 <p style="margin-left:22%;">look for WORD as an additional
194 keyword</p>
195
196 <p style="margin-left:11%;"><b>-k</b>,
197 <b>--keyword</b></p>
198
199 <p style="margin-left:22%;">do not to use default keywords
200 (only languages C, C++, ObjectiveC, Shell, Python, Lisp,
201 EmacsLisp, librep, Scheme, Java, C#, awk, Tcl, Perl, PHP,
202 GCC-source, Glade, Lua, JavaScript, Vala, Desktop)</p>
203
204
205 <p style="margin-left:11%;"><b>--flag</b>=<i>WORD</i>:ARG:FLAG</p>
206
207 <p style="margin-left:22%;">additional flag for strings
208 inside the argument number ARG of keyword WORD</p>
209
210 <p style="margin-left:11%;">(only languages C, C++,
211 ObjectiveC, Shell,</p>
212
213 <p style="margin-left:22%;">Python, Lisp, EmacsLisp,
214 librep, Scheme, Java, C#, awk, YCP, Tcl, Perl, PHP,
215 GCC-source, Lua, JavaScript, Vala)</p>
216
217 <p style="margin-left:11%;"><b>-T</b>,
218 <b>--trigraphs</b></p>
219
220 <p style="margin-left:22%;">understand ANSI C trigraphs for
221 input (only languages C, C++, ObjectiveC)</p>
222
223
224 <p style="margin-left:11%;"><b>--its</b>=<i>FILE</i></p>
225
226 <p style="margin-left:22%;">apply ITS rules from FILE (only
227 XML based languages)</p>
228
229 <table width="100%" border="0" rules="none" frame="void"
230 cellspacing="0" cellpadding="0">
231 <tr valign="top" align="left">
232 <td width="11%"></td>
233 <td width="7%">
234
235
236 <p><b>--qt</b></p></td>
237 <td width="4%"></td>
238 <td width="76%">
239
240
241 <p>recognize Qt format strings (only language C++)</p></td>
242 <td width="2%">
243 </td></tr>
244 <tr valign="top" align="left">
245 <td width="11%"></td>
246 <td width="7%">
247
248
249 <p><b>--kde</b></p></td>
250 <td width="4%"></td>
251 <td width="76%">
252
253
254 <p>recognize KDE 4 format strings (only language C++)</p></td>
255 <td width="2%">
256 </td></tr>
257 </table>
258
259 <p style="margin-left:11%;"><b>--boost</b></p>
260
261 <p style="margin-left:22%;">recognize Boost format strings
262 (only language C++)</p>
263
264 <p style="margin-left:11%;"><b>--debug</b></p>
265
266 <p style="margin-left:22%;">more detailed formatstring
267 recognition result</p>
268
269 <p style="margin-left:11%; margin-top: 1em"><b>Output
270 details: <br>
271 --color</b></p>
272
273 <p style="margin-left:22%;">use colors and other text
274 attributes always</p>
275
276
277 <p style="margin-left:11%;"><b>--color</b>=<i>WHEN</i></p>
278
279 <p style="margin-left:22%;">use colors and other text
280 attributes if WHEN. WHEN may be &rsquo;always&rsquo;,
281 &rsquo;never&rsquo;, &rsquo;auto&rsquo;, or
282 &rsquo;html&rsquo;.</p>
283
284
285 <p style="margin-left:11%;"><b>--style</b>=<i>STYLEFILE</i></p>
286
287 <p style="margin-left:22%;">specify CSS style rule file for
288 <b>--color</b></p>
289
290 <p style="margin-left:11%;"><b>-e</b>,
291 <b>--no-escape</b></p>
292
293 <p style="margin-left:22%;">do not use C escapes in output
294 (default)</p>
295
296 <p style="margin-left:11%;"><b>-E</b>,
297 <b>--escape</b></p>
298
299 <p style="margin-left:22%;">use C escapes in output, no
300 extended chars</p>
301
302
303 <p style="margin-left:11%;"><b>--force-po</b></p>
304
305 <p style="margin-left:22%;">write PO file even if empty</p>
306
307 <p style="margin-left:11%;"><b>-i</b>,
308 <b>--indent</b></p>
309
310 <p style="margin-left:22%;">write the .po file using
311 indented style</p>
312
313
314 <p style="margin-left:11%;"><b>--no-location</b></p>
315
316 <p style="margin-left:22%;">do not write &rsquo;#:
317 filename:line&rsquo; lines</p>
318
319 <p style="margin-left:11%;"><b>-n</b>,
320 <b>--add-location</b></p>
321
322 <p style="margin-left:22%;">generate &rsquo;#:
323 filename:line&rsquo; lines (default)</p>
324
325
326 <p style="margin-left:11%;"><b>--strict</b></p>
327
328 <p style="margin-left:22%;">write out strict Uniforum
329 conforming .po file</p>
330
331
332 <p style="margin-left:11%;"><b>--properties-output</b></p>
333
334 <p style="margin-left:22%;">write out a Java .properties
335 file</p>
336
337
338 <p style="margin-left:11%;"><b>--stringtable-output</b></p>
339
340 <p style="margin-left:22%;">write out a NeXTstep/GNUstep
341 .strings file</p>
342
343
344 <p style="margin-left:11%;"><b>--itstool</b></p>
345
346 <p style="margin-left:22%;">write out itstool comments</p>
347
348 <p style="margin-left:11%;"><b>-w</b>,
349 <b>--width</b>=<i>NUMBER</i></p>
350
351 <p style="margin-left:22%;">set output page width</p>
352
353
354 <p style="margin-left:11%;"><b>--no-wrap</b></p>
355
356 <p style="margin-left:22%;">do not break long message
357 lines, longer than the output page width, into several
358 lines</p>
359
360 <p style="margin-left:11%;"><b>-s</b>,
361 <b>--sort-output</b></p>
362
363 <p style="margin-left:22%;">generate sorted output
364 (deprecated)</p>
365
366 <p style="margin-left:11%;"><b>-F</b>,
367 <b>--sort-by-file</b></p>
368
369 <p style="margin-left:22%;">sort output by file
370 location</p>
371
372
373 <p style="margin-left:11%;"><b>--omit-header</b></p>
374
375 <p style="margin-left:22%;">don&rsquo;t write header with
376 &rsquo;msgid &quot;&quot;&rsquo; entry</p>
377
378
379 <p style="margin-left:11%;"><b>--copyright-holder</b>=<i>STRING</i></p>
380
381 <p style="margin-left:22%;">set copyright holder in
382 output</p>
383
384
385 <p style="margin-left:11%;"><b>--foreign-user</b></p>
386
387 <p style="margin-left:22%;">omit FSF copyright in output
388 for foreign user</p>
389
390
391 <p style="margin-left:11%;"><b>--package-name</b>=<i>PACKAGE</i></p>
392
393 <p style="margin-left:22%;">set package name in output</p>
394
395
396 <p style="margin-left:11%;"><b>--package-version</b>=<i>VERSION</i></p>
397
398 <p style="margin-left:22%;">set package version in
399 output</p>
400
401
402 <p style="margin-left:11%;"><b>--msgid-bugs-address</b>=<i>EMAIL</i>@ADDRESS</p>
403
404 <p style="margin-left:22%;">set report address for msgid
405 bugs</p>
406
407 <p style="margin-left:11%;"><b>-m[STRING]</b>,
408 <b>--msgstr-prefix</b>[=<i>STRING</i>]</p>
409
410 <p style="margin-left:22%;">use STRING or &quot;&quot; as
411 prefix for msgstr values</p>
412
413 <p style="margin-left:11%;"><b>-M[STRING]</b>,
414 <b>--msgstr-suffix</b>[=<i>STRING</i>]</p>
415
416 <p style="margin-left:22%;">use STRING or &quot;&quot; as
417 suffix for msgstr values</p>
418
419 <p style="margin-left:11%; margin-top: 1em"><b>Informative
420 output: <br>
421 -h</b>, <b>--help</b></p>
422
423 <p style="margin-left:22%;">display this help and exit</p>
424
425 <p style="margin-left:11%;"><b>-V</b>,
426 <b>--version</b></p>
427
428 <p style="margin-left:22%;">output version information and
429 exit</p>
430
431 <p style="margin-left:11%;"><b>-v</b>,
432 <b>--verbose</b></p>
433
434 <p style="margin-left:22%;">increase verbosity level</p>
435
436 <h2>AUTHOR
437 <a name="AUTHOR"></a>
438 </h2>
439
440
441 <p style="margin-left:11%; margin-top: 1em">Written by
442 Ulrich Drepper.</p>
443
444 <h2>REPORTING BUGS
445 <a name="REPORTING BUGS"></a>
446 </h2>
447
448
449 <p style="margin-left:11%; margin-top: 1em">Report bugs in
450 the bug tracker at
451 &lt;https://savannah.gnu.org/projects/gettext&gt; or by
452 email to &lt;bug-gettext@gnu.org&gt;.</p>
453
454 <h2>COPYRIGHT
455 <a name="COPYRIGHT"></a>
456 </h2>
457
458
459 <p style="margin-left:11%; margin-top: 1em">Copyright
460 &copy; 1995-2023 Free Software Foundation, Inc.
461 License GPLv3+: GNU GPL version 3 or later
462 &lt;https://gnu.org/licenses/gpl.html&gt; <br>
463 This is free software: you are free to change and
464 redistribute it. There is NO WARRANTY, to the extent
465 permitted by law.</p>
466
467 <h2>SEE ALSO
468 <a name="SEE ALSO"></a>
469 </h2>
470
471
472 <p style="margin-left:11%; margin-top: 1em">The full
473 documentation for <b>xgettext</b> is maintained as a Texinfo
474 manual. If the <b>info</b> and <b>xgettext</b> programs are
475 properly installed at your site, the command</p>
476
477 <p style="margin-left:22%; margin-top: 1em"><b>info
478 xgettext</b></p>
479
480 <p style="margin-left:11%; margin-top: 1em">should give you
481 access to the complete manual.</p>
482 <hr>
483 </body>
484 </html>