Commit | Line | Data |
---|---|---|
16b2b71c NC |
1 | .\" Automatically generated by Pod::Man version 1.02 |
2 | .\" Wed May 30 12:24:30 2001 | |
3 | .\" | |
4 | .\" Standard preamble: | |
5 | .\" ====================================================================== | |
6 | .de Sh \" Subsection heading | |
0285c67d NC |
7 | .br |
8 | .if t .Sp | |
9 | .ne 5 | |
10 | .PP | |
11 | \fB\\$1\fR | |
12 | .PP | |
13 | .. | |
16b2b71c | 14 | .de Sp \" Vertical space (when we can't use .PP) |
0285c67d NC |
15 | .if t .sp .5v |
16 | .if n .sp | |
17 | .. | |
16b2b71c | 18 | .de Ip \" List item |
0285c67d NC |
19 | .br |
20 | .ie \\n(.$>=3 .ne \\$3 | |
21 | .el .ne 3 | |
22 | .IP "\\$1" \\$2 | |
23 | .. | |
16b2b71c | 24 | .de Vb \" Begin verbatim text |
0285c67d NC |
25 | .ft CW |
26 | .nf | |
27 | .ne \\$1 | |
28 | .. | |
16b2b71c | 29 | .de Ve \" End verbatim text |
0285c67d NC |
30 | .ft R |
31 | ||
32 | .fi | |
33 | .. | |
16b2b71c NC |
34 | .\" Set up some character translations and predefined strings. \*(-- will |
35 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
36 | .\" double quote, and \*(R" will give a right double quote. | will give a | |
37 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used | |
38 | .\" to do unbreakable dashes and therefore won't be available. \*(C` and | |
39 | .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<> | |
0285c67d | 40 | .tr \(*W-|\(bv\*(Tr |
16b2b71c | 41 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
0285c67d | 42 | .ie n \{\ |
16b2b71c NC |
43 | . ds -- \(*W- |
44 | . ds PI pi | |
45 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
46 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
47 | . ds L" "" | |
48 | . ds R" "" | |
49 | . ds C` ` | |
50 | . ds C' ' | |
0285c67d NC |
51 | 'br\} |
52 | .el\{\ | |
16b2b71c NC |
53 | . ds -- \|\(em\| |
54 | . ds PI \(*p | |
55 | . ds L" `` | |
56 | . ds R" '' | |
0285c67d | 57 | 'br\} |
16b2b71c NC |
58 | .\" |
59 | .\" If the F register is turned on, we'll generate index entries on stderr | |
60 | .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and | |
61 | .\" index entries marked with X<> in POD. Of course, you'll have to process | |
62 | .\" the output yourself in some meaningful fashion. | |
63 | .if \nF \{\ | |
64 | . de IX | |
65 | . tm Index:\\$1\t\\n%\t"\\$2" | |
66 | . . | |
67 | . nr % 0 | |
68 | . rr F | |
0285c67d | 69 | .\} |
16b2b71c NC |
70 | .\" |
71 | .\" For nroff, turn off justification. Always turn off hyphenation; it | |
72 | .\" makes way too many mistakes in technical documents. | |
73 | .hy 0 | |
74 | .\" | |
75 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
76 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
0285c67d | 77 | .bd B 3 |
16b2b71c | 78 | . \" fudge factors for nroff and troff |
0285c67d | 79 | .if n \{\ |
16b2b71c NC |
80 | . ds #H 0 |
81 | . ds #V .8m | |
82 | . ds #F .3m | |
83 | . ds #[ \f1 | |
84 | . ds #] \fP | |
0285c67d NC |
85 | .\} |
86 | .if t \{\ | |
16b2b71c NC |
87 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
88 | . ds #V .6m | |
89 | . ds #F 0 | |
90 | . ds #[ \& | |
91 | . ds #] \& | |
0285c67d | 92 | .\} |
16b2b71c | 93 | . \" simple accents for nroff and troff |
0285c67d | 94 | .if n \{\ |
16b2b71c NC |
95 | . ds ' \& |
96 | . ds ` \& | |
97 | . ds ^ \& | |
98 | . ds , \& | |
99 | . ds ~ ~ | |
100 | . ds / | |
0285c67d NC |
101 | .\} |
102 | .if t \{\ | |
16b2b71c NC |
103 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
104 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
105 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
106 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
107 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
108 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
0285c67d | 109 | .\} |
16b2b71c | 110 | . \" troff and (daisy-wheel) nroff accents |
0285c67d NC |
111 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
112 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
0285c67d NC |
113 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
114 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
115 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
116 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
117 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
118 | .ds ae a\h'-(\w'a'u*4/10)'e | |
119 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
16b2b71c | 120 | . \" corrections for vroff |
0285c67d NC |
121 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
122 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
16b2b71c | 123 | . \" for low resolution devices (crt and lpr) |
0285c67d NC |
124 | .if \n(.H>23 .if \n(.V>19 \ |
125 | \{\ | |
16b2b71c NC |
126 | . ds : e |
127 | . ds 8 ss | |
128 | . ds o a | |
129 | . ds d- d\h'-1'\(ga | |
130 | . ds D- D\h'-1'\(hy | |
131 | . ds th \o'bp' | |
132 | . ds Th \o'LP' | |
133 | . ds ae ae | |
134 | . ds Ae AE | |
0285c67d NC |
135 | .\} |
136 | .rm #[ #] #H #V #F C | |
16b2b71c NC |
137 | .\" ====================================================================== |
138 | .\" | |
139 | .IX Title "WINDRES.1 1" | |
140 | .TH WINDRES.1 1 "binutils-2.11.90" "2001-05-30" "GNU" | |
141 | .UC | |
0285c67d NC |
142 | .SH "NAME" |
143 | windres \- manipulate Windows resources. | |
144 | .SH "SYNOPSIS" | |
16b2b71c | 145 | .IX Header "SYNOPSIS" |
0285c67d NC |
146 | windres [options] [input-file] [output-file] |
147 | .SH "DESCRIPTION" | |
16b2b71c NC |
148 | .IX Header "DESCRIPTION" |
149 | \&\f(CW\*(C`windres\*(C'\fR reads resources from an input file and copies them into | |
0285c67d | 150 | an output file. Either file may be in one of three formats: |
16b2b71c NC |
151 | .Ip "\f(CW\*(C`rc\*(C'\fR" 4 |
152 | .IX Item "rc" | |
0285c67d | 153 | A text format read by the Resource Compiler. |
16b2b71c NC |
154 | .Ip "\f(CW\*(C`res\*(C'\fR" 4 |
155 | .IX Item "res" | |
0285c67d | 156 | A binary format generated by the Resource Compiler. |
16b2b71c NC |
157 | .Ip "\f(CW\*(C`coff\*(C'\fR" 4 |
158 | .IX Item "coff" | |
0285c67d NC |
159 | A \s-1COFF\s0 object or executable. |
160 | .PP | |
161 | The exact description of these different formats is available in | |
162 | documentation from Microsoft. | |
163 | .PP | |
16b2b71c | 164 | When \f(CW\*(C`windres\*(C'\fR converts from the \f(CW\*(C`rc\*(C'\fR format to the \f(CW\*(C`res\*(C'\fR |
0285c67d | 165 | format, it is acting like the Windows Resource Compiler. When |
16b2b71c NC |
166 | \&\f(CW\*(C`windres\*(C'\fR converts from the \f(CW\*(C`res\*(C'\fR format to the \f(CW\*(C`coff\*(C'\fR |
167 | format, it is acting like the Windows \f(CW\*(C`CVTRES\*(C'\fR program. | |
0285c67d | 168 | .PP |
16b2b71c | 169 | When \f(CW\*(C`windres\*(C'\fR generates an \f(CW\*(C`rc\*(C'\fR file, the output is similar |
0285c67d | 170 | but not identical to the format expected for the input. When an input |
16b2b71c | 171 | \&\f(CW\*(C`rc\*(C'\fR file refers to an external filename, an output \f(CW\*(C`rc\*(C'\fR file |
0285c67d NC |
172 | will instead include the file contents. |
173 | .PP | |
16b2b71c | 174 | If the input or output format is not specified, \f(CW\*(C`windres\*(C'\fR will |
0285c67d | 175 | guess based on the file name, or, for the input file, the file contents. |
16b2b71c | 176 | A file with an extension of \fI.rc\fR will be treated as an \f(CW\*(C`rc\*(C'\fR |
0285c67d | 177 | file, a file with an extension of \fI.res\fR will be treated as a |
16b2b71c NC |
178 | \&\f(CW\*(C`res\*(C'\fR file, and a file with an extension of \fI.o\fR or |
179 | \&\fI.exe\fR will be treated as a \f(CW\*(C`coff\*(C'\fR file. | |
0285c67d | 180 | .PP |
16b2b71c NC |
181 | If no output file is specified, \f(CW\*(C`windres\*(C'\fR will print the resources |
182 | in \f(CW\*(C`rc\*(C'\fR format to standard output. | |
0285c67d | 183 | .PP |
16b2b71c | 184 | The normal use is for you to write an \f(CW\*(C`rc\*(C'\fR file, use \f(CW\*(C`windres\*(C'\fR |
0285c67d NC |
185 | to convert it to a \s-1COFF\s0 object file, and then link the \s-1COFF\s0 file into |
186 | your application. This will make the resources described in the | |
16b2b71c | 187 | \&\f(CW\*(C`rc\*(C'\fR file available to Windows. |
0285c67d | 188 | .SH "OPTIONS" |
16b2b71c NC |
189 | .IX Header "OPTIONS" |
190 | .Ip "\f(CW\*(C`\-i \f(CIfilename\f(CW\*(C'\fR" 4 | |
191 | .IX Item "-i filename" | |
192 | .Ip "\f(CW\*(C`\-\-input \f(CIfilename\f(CW\*(C'\fR" 4 | |
193 | .IX Item "--input filename" | |
0285c67d | 194 | The name of the input file. If this option is not used, then |
16b2b71c NC |
195 | \&\f(CW\*(C`windres\*(C'\fR will use the first non-option argument as the input file |
196 | name. If there are no non-option arguments, then \f(CW\*(C`windres\*(C'\fR will | |
197 | read from standard input. \f(CW\*(C`windres\*(C'\fR can not read a \s-1COFF\s0 file from | |
0285c67d | 198 | standard input. |
16b2b71c NC |
199 | .Ip "\f(CW\*(C`\-o \f(CIfilename\f(CW\*(C'\fR" 4 |
200 | .IX Item "-o filename" | |
201 | .Ip "\f(CW\*(C`\-\-output \f(CIfilename\f(CW\*(C'\fR" 4 | |
202 | .IX Item "--output filename" | |
0285c67d | 203 | The name of the output file. If this option is not used, then |
16b2b71c | 204 | \&\f(CW\*(C`windres\*(C'\fR will use the first non-option argument, after any used |
0285c67d | 205 | for the input file name, as the output file name. If there is no |
16b2b71c NC |
206 | non-option argument, then \f(CW\*(C`windres\*(C'\fR will write to standard output. |
207 | \&\f(CW\*(C`windres\*(C'\fR can not write a \s-1COFF\s0 file to standard output. | |
208 | .Ip "\f(CW\*(C`\-I \f(CIformat\f(CW\*(C'\fR" 4 | |
209 | .IX Item "-I format" | |
210 | .Ip "\f(CW\*(C`\-\-input\-format \f(CIformat\f(CW\*(C'\fR" 4 | |
211 | .IX Item "--input-format format" | |
0285c67d | 212 | The input format to read. \fIformat\fR may be \fBres\fR, \fBrc\fR, or |
16b2b71c | 213 | \&\fBcoff\fR. If no input format is specified, \f(CW\*(C`windres\*(C'\fR will |
0285c67d | 214 | guess, as described above. |
16b2b71c NC |
215 | .Ip "\f(CW\*(C`\-O \f(CIformat\f(CW\*(C'\fR" 4 |
216 | .IX Item "-O format" | |
217 | .Ip "\f(CW\*(C`\-\-output\-format \f(CIformat\f(CW\*(C'\fR" 4 | |
218 | .IX Item "--output-format format" | |
0285c67d | 219 | The output format to generate. \fIformat\fR may be \fBres\fR, |
16b2b71c NC |
220 | \&\fBrc\fR, or \fBcoff\fR. If no output format is specified, |
221 | \&\f(CW\*(C`windres\*(C'\fR will guess, as described above. | |
222 | .Ip "\f(CW\*(C`\-F \f(CItarget\f(CW\*(C'\fR" 4 | |
223 | .IX Item "-F target" | |
224 | .Ip "\f(CW\*(C`\-\-target \f(CItarget\f(CW\*(C'\fR" 4 | |
225 | .IX Item "--target target" | |
0285c67d | 226 | Specify the \s-1BFD\s0 format to use for a \s-1COFF\s0 file as input or output. This |
16b2b71c NC |
227 | is a \s-1BFD\s0 target name; you can use the \f(CW\*(C`\-\-help\*(C'\fR option to see a list |
228 | of supported targets. Normally \f(CW\*(C`windres\*(C'\fR will use the default | |
229 | format, which is the first one listed by the \f(CW\*(C`\-\-help\*(C'\fR option. | |
230 | \&\f(CW@ref\fR{Target Selection}. | |
231 | .Ip "\f(CW\*(C`\-\-preprocessor \f(CIprogram\f(CW\*(C'\fR" 4 | |
232 | .IX Item "--preprocessor program" | |
233 | When \f(CW\*(C`windres\*(C'\fR reads an \f(CW\*(C`rc\*(C'\fR file, it runs it through the C | |
0285c67d NC |
234 | preprocessor first. This option may be used to specify the preprocessor |
235 | to use, including any leading arguments. The default preprocessor | |
16b2b71c NC |
236 | argument is \f(CW\*(C`gcc \-E \-xc\-header \-DRC_INVOKED\*(C'\fR. |
237 | .Ip "\f(CW\*(C`\-\-include\-dir \f(CIdirectory\f(CW\*(C'\fR" 4 | |
238 | .IX Item "--include-dir directory" | |
239 | Specify an include directory to use when reading an \f(CW\*(C`rc\*(C'\fR file. | |
240 | \&\f(CW\*(C`windres\*(C'\fR will pass this to the preprocessor as an \f(CW\*(C`\-I\*(C'\fR | |
241 | option. \f(CW\*(C`windres\*(C'\fR will also search this directory when looking for | |
242 | files named in the \f(CW\*(C`rc\*(C'\fR file. | |
243 | .Ip "\f(CW\*(C`\-D \f(CItarget\f(CW\*(C'\fR" 4 | |
244 | .IX Item "-D target" | |
245 | .Ip "\f(CW\*(C`\-\-define \f(CIsym\f(CW[=\f(CIval\f(CW]\*(C'\fR" 4 | |
246 | .IX Item "--define sym[=val]" | |
247 | Specify a \f(CW\*(C`\-D\*(C'\fR option to pass to the preprocessor when reading an | |
248 | \&\f(CW\*(C`rc\*(C'\fR file. | |
249 | .Ip "\f(CW\*(C`\-v\*(C'\fR" 4 | |
250 | .IX Item "-v" | |
0285c67d NC |
251 | Enable verbose mode. This tells you what the preprocessor is if you |
252 | didn't specify one. | |
16b2b71c NC |
253 | .Ip "\f(CW\*(C`\-\-language \f(CIval\f(CW\*(C'\fR" 4 |
254 | .IX Item "--language val" | |
255 | Specify the default language to use when reading an \f(CW\*(C`rc\*(C'\fR file. | |
256 | \&\fIval\fR should be a hexadecimal language code. The low eight bits are | |
0285c67d | 257 | the language, and the high eight bits are the sublanguage. |
16b2b71c NC |
258 | .Ip "\f(CW\*(C`\-\-use\-temp\-file\*(C'\fR" 4 |
259 | .IX Item "--use-temp-file" | |
0285c67d NC |
260 | Use a temporary file to instead of using popen to read the output of |
261 | the preprocessor. Use this option if the popen implementation is buggy | |
262 | on the host (eg., certain non-English language versions of Windows 95 and | |
263 | Windows 98 are known to have buggy popen where the output will instead | |
264 | go the console). | |
16b2b71c NC |
265 | .Ip "\f(CW\*(C`\-\-no\-use\-temp\-file\*(C'\fR" 4 |
266 | .IX Item "--no-use-temp-file" | |
0285c67d NC |
267 | Use popen, not a temporary file, to read the output of the preprocessor. |
268 | This is the default behaviour. | |
16b2b71c NC |
269 | .Ip "\f(CW\*(C`\-\-help\*(C'\fR" 4 |
270 | .IX Item "--help" | |
0285c67d | 271 | Prints a usage summary. |
16b2b71c NC |
272 | .Ip "\f(CW\*(C`\-\-version\*(C'\fR" 4 |
273 | .IX Item "--version" | |
274 | Prints the version number for \f(CW\*(C`windres\*(C'\fR. | |
275 | .Ip "\f(CW\*(C`\-\-yydebug\*(C'\fR" 4 | |
276 | .IX Item "--yydebug" | |
277 | If \f(CW\*(C`windres\*(C'\fR is compiled with \f(CW\*(C`YYDEBUG\*(C'\fR defined as \f(CW\*(C`1\*(C'\fR, | |
0285c67d NC |
278 | this will turn on parser debugging. |
279 | .SH "SEE ALSO" | |
16b2b71c | 280 | .IX Header "SEE ALSO" |
0285c67d NC |
281 | the Info entries for \fIbinutils\fR. |
282 | .SH "COPYRIGHT" | |
16b2b71c | 283 | .IX Header "COPYRIGHT" |
0285c67d NC |
284 | Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. |
285 | .PP | |
286 | Permission is granted to copy, distribute and/or modify this document | |
16b2b71c | 287 | under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1 |
0285c67d NC |
288 | or any later version published by the Free Software Foundation; |
289 | with no Invariant Sections, with no Front-Cover Texts, and with no | |
290 | Back-Cover Texts. A copy of the license is included in the | |
16b2b71c | 291 | section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R". |