| blob | 17b856ab6361a7e36768a5394491cef21badb53b |
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.24.
2 .TH XGETTEXT "1" "April 2005" "GNU gettext-tools 0.14.4" 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\-c\fR, \fB\-\-add\-comments\fR[=\fITAG\fR]
68 place comment block with TAG (or those
69 preceding keyword lines) in output file
70 .SS "Language specific options:"
71 .TP
72 \fB\-a\fR, \fB\-\-extract\-all\fR
73 extract all strings
74 (only languages C, C++, ObjectiveC, Shell,
75 Python, Lisp, EmacsLisp, librep, Scheme, Java,
76 C#, awk, Tcl, Perl, PHP, GCC-source, Glade)
77 .TP
78 \fB\-k\fR, \fB\-\-keyword\fR[=\fIWORD\fR]
79 additional keyword to be looked for (without
80 WORD means not to use default keywords)
81 .IP
82 (only languages C, C++, ObjectiveC, Shell,
83 Python, Lisp, EmacsLisp, librep, Scheme, Java,
84 C#, awk, Tcl, Perl, PHP, GCC-source, Glade)
85 .TP
86 \fB\-\-flag\fR=\fIWORD\fR:ARG:FLAG
87 additional flag for strings inside the argument
88 number ARG of keyword WORD
89 .IP
90 (only languages C, C++, ObjectiveC, Shell,
91 Python, Lisp, EmacsLisp, librep, Scheme, Java,
92 C#, awk, YCP, Tcl, Perl, PHP, GCC-source)
93 .TP
94 \fB\-T\fR, \fB\-\-trigraphs\fR
95 understand ANSI C trigraphs for input
96 (only languages C, C++, ObjectiveC)
97 .TP
98 \fB\-\-qt\fR
99 recognize Qt format strings
100 (only language C++)
101 .TP
102 \fB\-\-debug\fR
103 more detailed formatstring recognition result
104 .SS "Output details:"
105 .TP
106 \fB\-e\fR, \fB\-\-no\-escape\fR
107 do not use C escapes in output (default)
108 .TP
109 \fB\-E\fR, \fB\-\-escape\fR
110 use C escapes in output, no extended chars
111 .TP
112 \fB\-\-force\-po\fR
113 write PO file even if empty
114 .TP
115 \fB\-i\fR, \fB\-\-indent\fR
116 write the .po file using indented style
117 .TP
118 \fB\-\-no\-location\fR
119 do not write '#: filename:line' lines
120 .TP
121 \fB\-n\fR, \fB\-\-add\-location\fR
122 generate '#: filename:line' lines (default)
123 .TP
124 \fB\-\-strict\fR
125 write out strict Uniforum conforming .po file
126 .TP
127 \fB\-\-properties\-output\fR
128 write out a Java .properties file
129 .TP
130 \fB\-\-stringtable\-output\fR
131 write out a NeXTstep/GNUstep .strings file
132 .TP
133 \fB\-w\fR, \fB\-\-width\fR=\fINUMBER\fR
134 set output page width
135 .TP
136 \fB\-\-no\-wrap\fR
137 do not break long message lines, longer than
138 the output page width, into several lines
139 .TP
140 \fB\-s\fR, \fB\-\-sort\-output\fR
141 generate sorted output
142 .TP
143 \fB\-F\fR, \fB\-\-sort\-by\-file\fR
144 sort output by file location
145 .TP
146 \fB\-\-omit\-header\fR
147 don't write header with `msgid ""' entry
148 .TP
149 \fB\-\-copyright\-holder\fR=\fISTRING\fR
150 set copyright holder in output
151 .TP
152 \fB\-\-foreign\-user\fR
153 omit FSF copyright in output for foreign user
154 .TP
155 \fB\-\-msgid\-bugs\-address\fR=\fIEMAIL\fR@ADDRESS
156 set report address for msgid bugs
157 .TP
158 \fB\-m\fR, \fB\-\-msgstr\-prefix\fR[=\fISTRING\fR]
159 use STRING or "" as prefix for msgstr entries
160 .TP
161 \fB\-M\fR, \fB\-\-msgstr\-suffix\fR[=\fISTRING\fR]
162 use STRING or "" as suffix for msgstr entries
163 .SS "Informative output:"
164 .TP
165 \fB\-h\fR, \fB\-\-help\fR
166 display this help and exit
167 .TP
168 \fB\-V\fR, \fB\-\-version\fR
169 output version information and exit
170 .SH AUTHOR
171 Written by Ulrich Drepper.
172 .SH "REPORTING BUGS"
173 Report bugs to <bug-gnu-gettext@gnu.org>.
174 .SH COPYRIGHT
175 Copyright \(co 1995-1998, 2000-2005 Free Software Foundation, Inc.
176 .br
177 This is free software; see the source for copying conditions. There is NO
178 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
179 .SH "SEE ALSO"
180 The full documentation for
181 .B xgettext
182 is maintained as a Texinfo manual. If the
183 .B info
184 and
185 .B xgettext
186 programs are properly installed at your site, the command
187 .IP
188 .B info xgettext
189 .PP
190 should give you access to the complete manual.