Debian Codegraph @

upstream/debian-trixie/man1/xgettext.1

raw
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
2 .TH XGETTEXT "1" "December 2024" "GNU gettext-tools 0.23.1" "User Commands"
3 .SH NAME
4 xgettext \- extract gettext strings from source
5 .SH SYNOPSIS
6 .B xgettext
7 [\fI\,OPTION\/\fR] [\fI\,INPUTFILE\/\fR]...
8 .SH DESCRIPTION
9 .\" Add any additional description here
10 .PP
11 Extract translatable strings from given input files.
12 .PP
13 Mandatory arguments to long options are mandatory for short options too.
14 Similarly for optional arguments.
15 .SS "Input file location:"
16 .TP
17 INPUTFILE ...
18 input files
19 .TP
20 \fB\-f\fR, \fB\-\-files\-from\fR=\fI\,FILE\/\fR
21 get list of input files from FILE
22 .TP
23 \fB\-D\fR, \fB\-\-directory\fR=\fI\,DIRECTORY\/\fR
24 add DIRECTORY to list for input files search
25 .PP
26 If input file is \-, standard input is read.
27 .SS "Output file location:"
28 .TP
29 \fB\-d\fR, \fB\-\-default\-domain\fR=\fI\,NAME\/\fR
30 use NAME.po for output (instead of messages.po)
31 .TP
32 \fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR
33 write output to specified file
34 .TP
35 \fB\-p\fR, \fB\-\-output\-dir\fR=\fI\,DIR\/\fR
36 output files will be placed in directory DIR
37 .PP
38 If output file is \-, output is written to standard output.
39 .SS "Choice of input file language:"
40 .TP
41 \fB\-L\fR, \fB\-\-language\fR=\fI\,NAME\/\fR
42 recognise the specified language
43 (C, C++, ObjectiveC, PO, Shell, Python, Lisp,
44 EmacsLisp, librep, Scheme, Guile, Smalltalk,
45 Java, JavaProperties, C#, awk, YCP, Tcl, Perl,
46 PHP, Ruby, GCC\-source, NXStringTable, RST, RSJ,
47 Glade, Lua, JavaScript, Vala, Desktop)
48 .TP
49 \fB\-C\fR, \fB\-\-c\fR++
50 shorthand for \fB\-\-language\fR=\fI\,C\/\fR++
51 .PP
52 By default the language is guessed depending on the input file name extension.
53 .SS "Input file interpretation:"
54 .TP
55 \fB\-\-from\-code\fR=\fI\,NAME\/\fR
56 encoding of input files
57 (except for Python, Tcl, Glade)
58 .PP
59 By default the input files are assumed to be in ASCII.
60 .SS "Operation mode:"
61 .TP
62 \fB\-j\fR, \fB\-\-join\-existing\fR
63 join messages with existing file
64 .TP
65 \fB\-x\fR, \fB\-\-exclude\-file\fR=\fI\,FILE\/\fR.po
66 entries from FILE.po are not extracted
67 .TP
68 \fB\-cTAG\fR, \fB\-\-add\-comments\fR=\fI\,TAG\/\fR
69 place comment blocks starting with TAG and
70 preceding keyword lines in output file
71 .TP
72 \fB\-c\fR, \fB\-\-add\-comments\fR
73 place all comment blocks preceding keyword lines
74 in output file
75 .TP
76 \fB\-\-check\fR=\fI\,NAME\/\fR
77 perform syntax check on messages
78 (ellipsis\-unicode, space\-ellipsis,
79 .IP
80 quote\-unicode, bullet\-unicode)
81 .TP
82 \fB\-\-sentence\-end\fR=\fI\,TYPE\/\fR
83 type describing the end of sentence
84 (single\-space, which is the default,
85 .IP
86 or double\-space)
87 .SS "Language specific options:"
88 .TP
89 \fB\-a\fR, \fB\-\-extract\-all\fR
90 extract all strings
91 (only languages C, C++, ObjectiveC, Shell,
92 Python, Lisp, EmacsLisp, librep, Scheme, Java,
93 C#, awk, Tcl, Perl, PHP, GCC\-source, Glade,
94 Lua, JavaScript, Vala)
95 .TP
96 \fB\-kWORD\fR, \fB\-\-keyword\fR=\fI\,WORD\/\fR
97 look for WORD as an additional keyword
98 .TP
99 \fB\-k\fR, \fB\-\-keyword\fR
100 do not to use default keywords
101 (only languages C, C++, ObjectiveC, Shell,
102 Python, Lisp, EmacsLisp, librep, Scheme, Java,
103 C#, awk, Tcl, Perl, PHP, GCC\-source, Glade,
104 Lua, JavaScript, Vala, Desktop)
105 .TP
106 \fB\-\-flag\fR=\fI\,WORD\/\fR:ARG:FLAG
107 additional flag for strings inside the argument
108 number ARG of keyword WORD
109 .TP
110 (only languages C, C++, ObjectiveC, Shell,
111 Python, Lisp, EmacsLisp, librep, Scheme, Java,
112 C#, awk, YCP, Tcl, Perl, PHP, GCC\-source,
113 Lua, JavaScript, Vala)
114 .TP
115 \fB\-\-tag\fR=\fI\,WORD\/\fR:FORMAT
116 defines the behaviour of tagged template literals
117 with tag WORD
118 .IP
119 (only language JavaScript)
120 .TP
121 \fB\-T\fR, \fB\-\-trigraphs\fR
122 understand ANSI C trigraphs for input
123 (deprecated; only languages C, C++, ObjectiveC)
124 .TP
125 \fB\-\-its\fR=\fI\,FILE\/\fR
126 apply ITS rules from FILE
127 (only XML based languages)
128 .TP
129 \fB\-\-qt\fR
130 recognize Qt format strings
131 (only language C++)
132 .TP
133 \fB\-\-kde\fR
134 recognize KDE 4 format strings
135 (only language C++)
136 .TP
137 \fB\-\-boost\fR
138 recognize Boost format strings
139 (only language C++)
140 .TP
141 \fB\-\-debug\fR
142 more detailed formatstring recognition result
143 .SS "Output details:"
144 .TP
145 \fB\-\-color\fR
146 use colors and other text attributes always
147 .TP
148 \fB\-\-color\fR=\fI\,WHEN\/\fR
149 use colors and other text attributes if WHEN.
150 WHEN may be 'always', 'never', 'auto', or 'html'.
151 .TP
152 \fB\-\-style\fR=\fI\,STYLEFILE\/\fR
153 specify CSS style rule file for \fB\-\-color\fR
154 .TP
155 \fB\-e\fR, \fB\-\-no\-escape\fR
156 do not use C escapes in output (default)
157 .TP
158 \fB\-E\fR, \fB\-\-escape\fR
159 use C escapes in output, no extended chars
160 .TP
161 \fB\-\-force\-po\fR
162 write PO file even if empty
163 .TP
164 \fB\-i\fR, \fB\-\-indent\fR
165 write the .po file using indented style
166 .TP
167 \fB\-\-no\-location\fR
168 do not write '#: filename:line' lines
169 .TP
170 \fB\-n\fR, \fB\-\-add\-location\fR
171 generate '#: filename:line' lines (default)
172 .TP
173 \fB\-\-strict\fR
174 write out strict Uniforum conforming .po file
175 .TP
176 \fB\-\-properties\-output\fR
177 write out a Java .properties file
178 .TP
179 \fB\-\-stringtable\-output\fR
180 write out a NeXTstep/GNUstep .strings file
181 .TP
182 \fB\-\-itstool\fR
183 write out itstool comments
184 .TP
185 \fB\-w\fR, \fB\-\-width\fR=\fI\,NUMBER\/\fR
186 set output page width
187 .TP
188 \fB\-\-no\-wrap\fR
189 do not break long message lines, longer than
190 the output page width, into several lines
191 .TP
192 \fB\-s\fR, \fB\-\-sort\-output\fR
193 generate sorted output (deprecated)
194 .TP
195 \fB\-F\fR, \fB\-\-sort\-by\-file\fR
196 sort output by file location
197 .TP
198 \fB\-\-omit\-header\fR
199 don't write header with 'msgid ""' entry
200 .TP
201 \fB\-\-copyright\-holder\fR=\fI\,STRING\/\fR
202 set copyright holder in output
203 .TP
204 \fB\-\-foreign\-user\fR
205 omit FSF copyright in output for foreign user
206 .TP
207 \fB\-\-package\-name\fR=\fI\,PACKAGE\/\fR
208 set package name in output
209 .TP
210 \fB\-\-package\-version\fR=\fI\,VERSION\/\fR
211 set package version in output
212 .TP
213 \fB\-\-msgid\-bugs\-address\fR=\fI\,EMAIL\/\fR@ADDRESS
214 set report address for msgid bugs
215 .TP
216 \fB\-m[STRING]\fR, \fB\-\-msgstr\-prefix\fR[=\fI\,STRING\/\fR]
217 use STRING or "" as prefix for msgstr
218 values
219 .TP
220 \fB\-M[STRING]\fR, \fB\-\-msgstr\-suffix\fR[=\fI\,STRING\/\fR]
221 use STRING or "" as suffix for msgstr
222 values
223 .SS "Informative output:"
224 .TP
225 \fB\-h\fR, \fB\-\-help\fR
226 display this help and exit
227 .TP
228 \fB\-V\fR, \fB\-\-version\fR
229 output version information and exit
230 .TP
231 \fB\-v\fR, \fB\-\-verbose\fR
232 increase verbosity level
233 .SH AUTHOR
234 Written by Ulrich Drepper.
235 .SH "REPORTING BUGS"
236 Report bugs in the bug tracker at <https://savannah.gnu.org/projects/gettext>
237 or by email to <bug\[email protected]>.
238 .SH COPYRIGHT
239 Copyright \(co 1995\-2024 Free Software Foundation, Inc.
240 License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>
241 .br
242 This is free software: you are free to change and redistribute it.
243 There is NO WARRANTY, to the extent permitted by law.
244 .SH "SEE ALSO"
245 The full documentation for
246 .B xgettext
247 is maintained as a Texinfo manual. If the
248 .B info
249 and
250 .B xgettext
251 programs are properly installed at your site, the command
252 .IP
253 .B info xgettext
254 .PP
255 should give you access to the complete manual.