| blob | 91a9e293f31d460e74e6a3500a21f82bbfbb9c77 |
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.24.
2 .TH XGETTEXT "1" "June 2010" "GNU gettext-tools 0.18.1" GNU
3 .SH NAME
4 xgettext \- extract gettext strings from source
5 .SH SYNOPSIS
6 .B xgettext
7 [\fIOPTION\fR] [\fIINPUTFILE\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=\fIFILE\fR
21 get list of input files from FILE
22 .TP
23 \fB\-D\fR, \fB\-\-directory\fR=\fIDIRECTORY\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=\fINAME\fR
30 use NAME.po for output (instead of messages.po)
31 .TP
32 \fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR
33 write output to specified file
34 .TP
35 \fB\-p\fR, \fB\-\-output\-dir\fR=\fIDIR\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=\fINAME\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 GCC-source, NXStringTable, RST, Glade)
47 .TP
48 \fB\-C\fR, \fB\-\-c\fR++
49 shorthand for \fB\-\-language\fR=\fIC\fR++
50 .PP
51 By default the language is guessed depending on the input file name extension.
52 .SS "Input file interpretation:"
53 .TP
54 \fB\-\-from\-code\fR=\fINAME\fR
55 encoding of input files
56 (except for Python, Tcl, Glade)
57 .PP
58 By default the input files are assumed to be in ASCII.
59 .SS "Operation mode:"
60 .TP
61 \fB\-j\fR, \fB\-\-join\-existing\fR
62 join messages with existing file
63 .TP
64 \fB\-x\fR, \fB\-\-exclude\-file\fR=\fIFILE\fR.po
65 entries from FILE.po are not extracted
66 .TP
67 \fB\-cTAG\fR, \fB\-\-add\-comments\fR=\fITAG\fR
68 place comment blocks starting with TAG and
69 preceding keyword lines in output file
70 .TP
71 \fB\-c\fR, \fB\-\-add\-comments\fR
72 place all comment blocks preceding keyword lines
73 in output file
74 .SS "Language specific options:"
75 .TP
76 \fB\-a\fR, \fB\-\-extract\-all\fR
77 extract all strings
78 (only languages C, C++, ObjectiveC, Shell,
79 Python, Lisp, EmacsLisp, librep, Scheme, Java,
80 C#, awk, Tcl, Perl, PHP, GCC-source, Glade)
81 .TP
82 \fB\-kWORD\fR, \fB\-\-keyword\fR=\fIWORD\fR
83 look for WORD as an additional keyword
84 .TP
85 \fB\-k\fR, \fB\-\-keyword\fR
86 do not to use default keywords
87 (only languages C, C++, ObjectiveC, Shell,
88 Python, Lisp, EmacsLisp, librep, Scheme, Java,
89 C#, awk, Tcl, Perl, PHP, GCC-source, Glade)
90 .TP
91 \fB\-\-flag\fR=\fIWORD\fR:ARG:FLAG
92 additional flag for strings inside the argument
93 number ARG of keyword WORD
94 .IP
95 (only languages C, C++, ObjectiveC, Shell,
96 Python, Lisp, EmacsLisp, librep, Scheme, Java,
97 C#, awk, YCP, Tcl, Perl, PHP, GCC-source)
98 .TP
99 \fB\-T\fR, \fB\-\-trigraphs\fR
100 understand ANSI C trigraphs for input
101 (only languages C, C++, ObjectiveC)
102 .TP
103 \fB\-\-qt\fR
104 recognize Qt format strings
105 (only language C++)
106 .TP
107 \fB\-\-kde\fR
108 recognize KDE 4 format strings
109 (only language C++)
110 .TP
111 \fB\-\-boost\fR
112 recognize Boost format strings
113 (only language C++)
114 .TP
115 \fB\-\-debug\fR
116 more detailed formatstring recognition result
117 .SS "Output details:"
118 .TP
119 \fB\-\-color\fR
120 use colors and other text attributes always
121 .TP
122 \fB\-\-color\fR=\fIWHEN\fR
123 use colors and other text attributes if WHEN.
124 WHEN may be 'always', 'never', 'auto', or 'html'.
125 .TP
126 \fB\-\-style\fR=\fISTYLEFILE\fR
127 specify CSS style rule file for \fB\-\-color\fR
128 .TP
129 \fB\-e\fR, \fB\-\-no\-escape\fR
130 do not use C escapes in output (default)
131 .TP
132 \fB\-E\fR, \fB\-\-escape\fR
133 use C escapes in output, no extended chars
134 .TP
135 \fB\-\-force\-po\fR
136 write PO file even if empty
137 .TP
138 \fB\-i\fR, \fB\-\-indent\fR
139 write the .po file using indented style
140 .TP
141 \fB\-\-no\-location\fR
142 do not write '#: filename:line' lines
143 .TP
144 \fB\-n\fR, \fB\-\-add\-location\fR
145 generate '#: filename:line' lines (default)
146 .TP
147 \fB\-\-strict\fR
148 write out strict Uniforum conforming .po file
149 .TP
150 \fB\-\-properties\-output\fR
151 write out a Java .properties file
152 .TP
153 \fB\-\-stringtable\-output\fR
154 write out a NeXTstep/GNUstep .strings file
155 .TP
156 \fB\-w\fR, \fB\-\-width\fR=\fINUMBER\fR
157 set output page width
158 .TP
159 \fB\-\-no\-wrap\fR
160 do not break long message lines, longer than
161 the output page width, into several lines
162 .TP
163 \fB\-s\fR, \fB\-\-sort\-output\fR
164 generate sorted output
165 .TP
166 \fB\-F\fR, \fB\-\-sort\-by\-file\fR
167 sort output by file location
168 .TP
169 \fB\-\-omit\-header\fR
170 don't write header with `msgid ""' entry
171 .TP
172 \fB\-\-copyright\-holder\fR=\fISTRING\fR
173 set copyright holder in output
174 .TP
175 \fB\-\-foreign\-user\fR
176 omit FSF copyright in output for foreign user
177 .TP
178 \fB\-\-package\-name\fR=\fIPACKAGE\fR
179 set package name in output
180 .TP
181 \fB\-\-package\-version\fR=\fIVERSION\fR
182 set package version in output
183 .TP
184 \fB\-\-msgid\-bugs\-address\fR=\fIEMAIL\fR@ADDRESS
185 set report address for msgid bugs
186 .TP
187 \fB\-m[STRING]\fR, \fB\-\-msgstr\-prefix\fR[=\fISTRING\fR]
188 use STRING or "" as prefix for msgstr
189 values
190 .TP
191 \fB\-M[STRING]\fR, \fB\-\-msgstr\-suffix\fR[=\fISTRING\fR]
192 use STRING or "" as suffix for msgstr
193 values
194 .SS "Informative output:"
195 .TP
196 \fB\-h\fR, \fB\-\-help\fR
197 display this help and exit
198 .TP
199 \fB\-V\fR, \fB\-\-version\fR
200 output version information and exit
201 .SH AUTHOR
202 Written by Ulrich Drepper.
203 .SH "REPORTING BUGS"
204 Report bugs to <bug-gnu-gettext@gnu.org>.
205 .SH COPYRIGHT
206 Copyright \(co 1995-1998, 2000-2010 Free Software Foundation, Inc.
207 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
208 .br
209 This is free software: you are free to change and redistribute it.
210 There is NO WARRANTY, to the extent permitted by law.
211 .SH "SEE ALSO"
212 The full documentation for
213 .B xgettext
214 is maintained as a Texinfo manual. If the
215 .B info
216 and
217 .B xgettext
218 programs are properly installed at your site, the command
219 .IP
220 .B info xgettext
221 .PP
222 should give you access to the complete manual.