Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man1/xgettext.1 @ 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 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
2 .TH XGETTEXT "1" "February 2024" "GNU gettext-tools 0.22.5" "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, Smalltalk, Java,
45 JavaProperties, C#, awk, YCP, Tcl, Perl, PHP,
46 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\-T\fR, \fB\-\-trigraphs\fR
116 understand ANSI C trigraphs for input
117 (only languages C, C++, ObjectiveC)
118 .TP
119 \fB\-\-its\fR=\fI\,FILE\/\fR
120 apply ITS rules from FILE
121 (only XML based languages)
122 .TP
123 \fB\-\-qt\fR
124 recognize Qt format strings
125 (only language C++)
126 .TP
127 \fB\-\-kde\fR
128 recognize KDE 4 format strings
129 (only language C++)
130 .TP
131 \fB\-\-boost\fR
132 recognize Boost format strings
133 (only language C++)
134 .TP
135 \fB\-\-debug\fR
136 more detailed formatstring recognition result
137 .SS "Output details:"
138 .TP
139 \fB\-\-color\fR
140 use colors and other text attributes always
141 .TP
142 \fB\-\-color\fR=\fI\,WHEN\/\fR
143 use colors and other text attributes if WHEN.
144 WHEN may be 'always', 'never', 'auto', or 'html'.
145 .TP
146 \fB\-\-style\fR=\fI\,STYLEFILE\/\fR
147 specify CSS style rule file for \fB\-\-color\fR
148 .TP
149 \fB\-e\fR, \fB\-\-no\-escape\fR
150 do not use C escapes in output (default)
151 .TP
152 \fB\-E\fR, \fB\-\-escape\fR
153 use C escapes in output, no extended chars
154 .TP
155 \fB\-\-force\-po\fR
156 write PO file even if empty
157 .TP
158 \fB\-i\fR, \fB\-\-indent\fR
159 write the .po file using indented style
160 .TP
161 \fB\-\-no\-location\fR
162 do not write '#: filename:line' lines
163 .TP
164 \fB\-n\fR, \fB\-\-add\-location\fR
165 generate '#: filename:line' lines (default)
166 .TP
167 \fB\-\-strict\fR
168 write out strict Uniforum conforming .po file
169 .TP
170 \fB\-\-properties\-output\fR
171 write out a Java .properties file
172 .TP
173 \fB\-\-stringtable\-output\fR
174 write out a NeXTstep/GNUstep .strings file
175 .TP
176 \fB\-\-itstool\fR
177 write out itstool comments
178 .TP
179 \fB\-w\fR, \fB\-\-width\fR=\fI\,NUMBER\/\fR
180 set output page width
181 .TP
182 \fB\-\-no\-wrap\fR
183 do not break long message lines, longer than
184 the output page width, into several lines
185 .TP
186 \fB\-s\fR, \fB\-\-sort\-output\fR
187 generate sorted output (deprecated)
188 .TP
189 \fB\-F\fR, \fB\-\-sort\-by\-file\fR
190 sort output by file location
191 .TP
192 \fB\-\-omit\-header\fR
193 don't write header with 'msgid ""' entry
194 .TP
195 \fB\-\-copyright\-holder\fR=\fI\,STRING\/\fR
196 set copyright holder in output
197 .TP
198 \fB\-\-foreign\-user\fR
199 omit FSF copyright in output for foreign user
200 .TP
201 \fB\-\-package\-name\fR=\fI\,PACKAGE\/\fR
202 set package name in output
203 .TP
204 \fB\-\-package\-version\fR=\fI\,VERSION\/\fR
205 set package version in output
206 .TP
207 \fB\-\-msgid\-bugs\-address\fR=\fI\,EMAIL\/\fR@ADDRESS
208 set report address for msgid bugs
209 .TP
210 \fB\-m[STRING]\fR, \fB\-\-msgstr\-prefix\fR[=\fI\,STRING\/\fR]
211 use STRING or "" as prefix for msgstr
212 values
213 .TP
214 \fB\-M[STRING]\fR, \fB\-\-msgstr\-suffix\fR[=\fI\,STRING\/\fR]
215 use STRING or "" as suffix for msgstr
216 values
217 .SS "Informative output:"
218 .TP
219 \fB\-h\fR, \fB\-\-help\fR
220 display this help and exit
221 .TP
222 \fB\-V\fR, \fB\-\-version\fR
223 output version information and exit
224 .TP
225 \fB\-v\fR, \fB\-\-verbose\fR
226 increase verbosity level
227 .SH AUTHOR
228 Written by Ulrich Drepper.
229 .SH "REPORTING BUGS"
230 Report bugs in the bug tracker at <https://savannah.gnu.org/projects/gettext>
231 or by email to <bug\-gettext@gnu.org>.
232 .SH COPYRIGHT
233 Copyright \(co 1995\-2023 Free Software Foundation, Inc.
234 License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>
235 .br
236 This is free software: you are free to change and redistribute it.
237 There is NO WARRANTY, to the extent permitted by law.
238 .SH "SEE ALSO"
239 The full documentation for
240 .B xgettext
241 is maintained as a Texinfo manual. If the
242 .B info
243 and
244 .B xgettext
245 programs are properly installed at your site, the command
246 .IP
247 .B info xgettext
248 .PP
249 should give you access to the complete manual.