Commit | Line | Data |
---|---|---|
0285c67d NC |
1 | .rn '' }` |
2 | ''' $RCSfile$$Revision$$Date$ | |
3 | ''' | |
4 | ''' $Log$ | |
5 | ''' Revision 1.1 2001/03/25 20:32:25 nickc | |
6 | ''' Automate generate on man pages | |
7 | ''' | |
8 | ''' | |
9 | .de Sh | |
10 | .br | |
11 | .if t .Sp | |
12 | .ne 5 | |
13 | .PP | |
14 | \fB\\$1\fR | |
15 | .PP | |
16 | .. | |
17 | .de Sp | |
18 | .if t .sp .5v | |
19 | .if n .sp | |
20 | .. | |
21 | .de Ip | |
22 | .br | |
23 | .ie \\n(.$>=3 .ne \\$3 | |
24 | .el .ne 3 | |
25 | .IP "\\$1" \\$2 | |
26 | .. | |
27 | .de Vb | |
28 | .ft CW | |
29 | .nf | |
30 | .ne \\$1 | |
31 | .. | |
32 | .de Ve | |
33 | .ft R | |
34 | ||
35 | .fi | |
36 | .. | |
37 | ''' | |
38 | ''' | |
39 | ''' Set up \*(-- to give an unbreakable dash; | |
40 | ''' string Tr holds user defined translation string. | |
41 | ''' Bell System Logo is used as a dummy character. | |
42 | ''' | |
43 | .tr \(*W-|\(bv\*(Tr | |
44 | .ie n \{\ | |
45 | .ds -- \(*W- | |
46 | .ds PI pi | |
47 | .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
48 | .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
49 | .ds L" "" | |
50 | .ds R" "" | |
51 | ''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of | |
52 | ''' \*(L" and \*(R", except that they are used on ".xx" lines, | |
53 | ''' such as .IP and .SH, which do another additional levels of | |
54 | ''' double-quote interpretation | |
55 | .ds M" """ | |
56 | .ds S" """ | |
57 | .ds N" """"" | |
58 | .ds T" """"" | |
59 | .ds L' ' | |
60 | .ds R' ' | |
61 | .ds M' ' | |
62 | .ds S' ' | |
63 | .ds N' ' | |
64 | .ds T' ' | |
65 | 'br\} | |
66 | .el\{\ | |
67 | .ds -- \(em\| | |
68 | .tr \*(Tr | |
69 | .ds L" `` | |
70 | .ds R" '' | |
71 | .ds M" `` | |
72 | .ds S" '' | |
73 | .ds N" `` | |
74 | .ds T" '' | |
75 | .ds L' ` | |
76 | .ds R' ' | |
77 | .ds M' ` | |
78 | .ds S' ' | |
79 | .ds N' ` | |
80 | .ds T' ' | |
81 | .ds PI \(*p | |
82 | 'br\} | |
83 | .\" If the F register is turned on, we'll generate | |
84 | .\" index entries out stderr for the following things: | |
85 | .\" TH Title | |
86 | .\" SH Header | |
87 | .\" Sh Subsection | |
88 | .\" Ip Item | |
89 | .\" X<> Xref (embedded | |
90 | .\" Of course, you have to process the output yourself | |
91 | .\" in some meaninful fashion. | |
92 | .if \nF \{ | |
93 | .de IX | |
94 | .tm Index:\\$1\t\\n%\t"\\$2" | |
95 | .. | |
96 | .nr % 0 | |
97 | .rr F | |
98 | .\} | |
99 | .TH WINDRES.1 1 "binutils-2.11.90" "23/Mar/101" "GNU" | |
100 | .UC | |
101 | .if n .hy 0 | |
102 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
103 | .de CQ \" put $1 in typewriter font | |
104 | .ft CW | |
105 | 'if n "\c | |
106 | 'if t \\&\\$1\c | |
107 | 'if n \\&\\$1\c | |
108 | 'if n \&" | |
109 | \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 | |
110 | '.ft R | |
111 | .. | |
112 | .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 | |
113 | . \" AM - accent mark definitions | |
114 | .bd B 3 | |
115 | . \" fudge factors for nroff and troff | |
116 | .if n \{\ | |
117 | . ds #H 0 | |
118 | . ds #V .8m | |
119 | . ds #F .3m | |
120 | . ds #[ \f1 | |
121 | . ds #] \fP | |
122 | .\} | |
123 | .if t \{\ | |
124 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
125 | . ds #V .6m | |
126 | . ds #F 0 | |
127 | . ds #[ \& | |
128 | . ds #] \& | |
129 | .\} | |
130 | . \" simple accents for nroff and troff | |
131 | .if n \{\ | |
132 | . ds ' \& | |
133 | . ds ` \& | |
134 | . ds ^ \& | |
135 | . ds , \& | |
136 | . ds ~ ~ | |
137 | . ds ? ? | |
138 | . ds ! ! | |
139 | . ds / | |
140 | . ds q | |
141 | .\} | |
142 | .if t \{\ | |
143 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
144 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
145 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
146 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
147 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
148 | . ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' | |
149 | . ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' | |
150 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
151 | . ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' | |
152 | .\} | |
153 | . \" troff and (daisy-wheel) nroff accents | |
154 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
155 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
156 | .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] | |
157 | .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' | |
158 | .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' | |
159 | .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] | |
160 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
161 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
162 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
163 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
164 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
165 | .ds ae a\h'-(\w'a'u*4/10)'e | |
166 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
167 | .ds oe o\h'-(\w'o'u*4/10)'e | |
168 | .ds Oe O\h'-(\w'O'u*4/10)'E | |
169 | . \" corrections for vroff | |
170 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
171 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
172 | . \" for low resolution devices (crt and lpr) | |
173 | .if \n(.H>23 .if \n(.V>19 \ | |
174 | \{\ | |
175 | . ds : e | |
176 | . ds 8 ss | |
177 | . ds v \h'-1'\o'\(aa\(ga' | |
178 | . ds _ \h'-1'^ | |
179 | . ds . \h'-1'. | |
180 | . ds 3 3 | |
181 | . ds o a | |
182 | . ds d- d\h'-1'\(ga | |
183 | . ds D- D\h'-1'\(hy | |
184 | . ds th \o'bp' | |
185 | . ds Th \o'LP' | |
186 | . ds ae ae | |
187 | . ds Ae AE | |
188 | . ds oe oe | |
189 | . ds Oe OE | |
190 | .\} | |
191 | .rm #[ #] #H #V #F C | |
192 | .SH "NAME" | |
193 | windres \- manipulate Windows resources. | |
194 | .SH "SYNOPSIS" | |
195 | windres [options] [input-file] [output-file] | |
196 | .SH "DESCRIPTION" | |
197 | \f(CWwindres\fR reads resources from an input file and copies them into | |
198 | an output file. Either file may be in one of three formats: | |
199 | .Ip "\f(CWrc\fR" 4 | |
200 | A text format read by the Resource Compiler. | |
201 | .Ip "\f(CWres\fR" 4 | |
202 | A binary format generated by the Resource Compiler. | |
203 | .Ip "\f(CWcoff\fR" 4 | |
204 | A \s-1COFF\s0 object or executable. | |
205 | .PP | |
206 | The exact description of these different formats is available in | |
207 | documentation from Microsoft. | |
208 | .PP | |
209 | When \f(CWwindres\fR converts from the \f(CWrc\fR format to the \f(CWres\fR | |
210 | format, it is acting like the Windows Resource Compiler. When | |
211 | \f(CWwindres\fR converts from the \f(CWres\fR format to the \f(CWcoff\fR | |
212 | format, it is acting like the Windows \f(CWCVTRES\fR program. | |
213 | .PP | |
214 | When \f(CWwindres\fR generates an \f(CWrc\fR file, the output is similar | |
215 | but not identical to the format expected for the input. When an input | |
216 | \f(CWrc\fR file refers to an external filename, an output \f(CWrc\fR file | |
217 | will instead include the file contents. | |
218 | .PP | |
219 | If the input or output format is not specified, \f(CWwindres\fR will | |
220 | guess based on the file name, or, for the input file, the file contents. | |
221 | A file with an extension of \fI.rc\fR will be treated as an \f(CWrc\fR | |
222 | file, a file with an extension of \fI.res\fR will be treated as a | |
223 | \f(CWres\fR file, and a file with an extension of \fI.o\fR or | |
224 | \&\fI.exe\fR will be treated as a \f(CWcoff\fR file. | |
225 | .PP | |
226 | If no output file is specified, \f(CWwindres\fR will print the resources | |
227 | in \f(CWrc\fR format to standard output. | |
228 | .PP | |
229 | The normal use is for you to write an \f(CWrc\fR file, use \f(CWwindres\fR | |
230 | to convert it to a \s-1COFF\s0 object file, and then link the \s-1COFF\s0 file into | |
231 | your application. This will make the resources described in the | |
232 | \f(CWrc\fR file available to Windows. | |
233 | .SH "OPTIONS" | |
234 | .Ip "\f(CW-i \fIfilename\fR\fR" 4 | |
235 | .Ip "\f(CW--input \fIfilename\fR\fR" 4 | |
236 | The name of the input file. If this option is not used, then | |
237 | \f(CWwindres\fR will use the first non-option argument as the input file | |
238 | name. If there are no non-option arguments, then \f(CWwindres\fR will | |
239 | read from standard input. \f(CWwindres\fR can not read a \s-1COFF\s0 file from | |
240 | standard input. | |
241 | .Ip "\f(CW-o \fIfilename\fR\fR" 4 | |
242 | .Ip "\f(CW--output \fIfilename\fR\fR" 4 | |
243 | The name of the output file. If this option is not used, then | |
244 | \f(CWwindres\fR will use the first non-option argument, after any used | |
245 | for the input file name, as the output file name. If there is no | |
246 | non-option argument, then \f(CWwindres\fR will write to standard output. | |
247 | \f(CWwindres\fR can not write a \s-1COFF\s0 file to standard output. | |
248 | .Ip "\f(CW-I \fIformat\fR\fR" 4 | |
249 | .Ip "\f(CW--input-format \fIformat\fR\fR" 4 | |
250 | The input format to read. \fIformat\fR may be \fBres\fR, \fBrc\fR, or | |
251 | \fBcoff\fR. If no input format is specified, \f(CWwindres\fR will | |
252 | guess, as described above. | |
253 | .Ip "\f(CW-O \fIformat\fR\fR" 4 | |
254 | .Ip "\f(CW--output-format \fIformat\fR\fR" 4 | |
255 | The output format to generate. \fIformat\fR may be \fBres\fR, | |
256 | \fBrc\fR, or \fBcoff\fR. If no output format is specified, | |
257 | \f(CWwindres\fR will guess, as described above. | |
258 | .Ip "\f(CW-F \fItarget\fR\fR" 4 | |
259 | .Ip "\f(CW--target \fItarget\fR\fR" 4 | |
260 | Specify the \s-1BFD\s0 format to use for a \s-1COFF\s0 file as input or output. This | |
261 | is a \s-1BFD\s0 target name; you can use the \f(CW--help\fR option to see a list | |
262 | of supported targets. Normally \f(CWwindres\fR will use the default | |
263 | format, which is the first one listed by the \f(CW--help\fR option. | |
264 | \f(CW@ref\fR{Target Selection}. | |
265 | .Ip "\f(CW--preprocessor \fIprogram\fR\fR" 4 | |
266 | When \f(CWwindres\fR reads an \f(CWrc\fR file, it runs it through the C | |
267 | preprocessor first. This option may be used to specify the preprocessor | |
268 | to use, including any leading arguments. The default preprocessor | |
269 | argument is \f(CWgcc -E -xc-header -DRC_INVOKED\fR. | |
270 | .Ip "\f(CW--include-dir \fIdirectory\fR\fR" 4 | |
271 | Specify an include directory to use when reading an \f(CWrc\fR file. | |
272 | \f(CWwindres\fR will pass this to the preprocessor as an \f(CW-I\fR | |
273 | option. \f(CWwindres\fR will also search this directory when looking for | |
274 | files named in the \f(CWrc\fR file. | |
275 | .Ip "\f(CW-D \fItarget\fR\fR" 4 | |
276 | .Ip "\f(CW--define \fIsym\fR[=\fIval\fR]\fR" 4 | |
277 | Specify a \f(CW-D\fR option to pass to the preprocessor when reading an | |
278 | \f(CWrc\fR file. | |
279 | .Ip "\f(CW-v\fR" 4 | |
280 | Enable verbose mode. This tells you what the preprocessor is if you | |
281 | didn't specify one. | |
282 | .Ip "\f(CW--language \fIval\fR\fR" 4 | |
283 | Specify the default language to use when reading an \f(CWrc\fR file. | |
284 | \fIval\fR should be a hexadecimal language code. The low eight bits are | |
285 | the language, and the high eight bits are the sublanguage. | |
286 | .Ip "\f(CW--use-temp-file\fR" 4 | |
287 | Use a temporary file to instead of using popen to read the output of | |
288 | the preprocessor. Use this option if the popen implementation is buggy | |
289 | on the host (eg., certain non-English language versions of Windows 95 and | |
290 | Windows 98 are known to have buggy popen where the output will instead | |
291 | go the console). | |
292 | .Ip "\f(CW--no-use-temp-file\fR" 4 | |
293 | Use popen, not a temporary file, to read the output of the preprocessor. | |
294 | This is the default behaviour. | |
295 | .Ip "\f(CW--help\fR" 4 | |
296 | Prints a usage summary. | |
297 | .Ip "\f(CW--version\fR" 4 | |
298 | Prints the version number for \f(CWwindres\fR. | |
299 | .Ip "\f(CW--yydebug\fR" 4 | |
300 | If \f(CWwindres\fR is compiled with \f(CWYYDEBUG\fR defined as \f(CW1\fR, | |
301 | this will turn on parser debugging. | |
302 | .SH "SEE ALSO" | |
303 | the Info entries for \fIbinutils\fR. | |
304 | .SH "COPYRIGHT" | |
305 | Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. | |
306 | .PP | |
307 | Permission is granted to copy, distribute and/or modify this document | |
308 | under the terms of the GNU Free Documentation License, Version 1.1 | |
309 | or any later version published by the Free Software Foundation; | |
310 | with no Invariant Sections, with no Front-Cover Texts, and with no | |
311 | Back-Cover Texts. A copy of the license is included in the | |
312 | section entitled \*(L"GNU Free Documentation License\*(R". | |
313 | ||
314 | .rn }` '' | |
315 | .IX Title "WINDRES.1 1" | |
316 | .IX Name "windres - manipulate Windows resources." | |
317 | ||
318 | .IX Header "NAME" | |
319 | ||
320 | .IX Header "SYNOPSIS" | |
321 | ||
322 | .IX Header "DESCRIPTION" | |
323 | ||
324 | .IX Item "\f(CWrc\fR" | |
325 | ||
326 | .IX Item "\f(CWres\fR" | |
327 | ||
328 | .IX Item "\f(CWcoff\fR" | |
329 | ||
330 | .IX Header "OPTIONS" | |
331 | ||
332 | .IX Item "\f(CW-i \fIfilename\fR\fR" | |
333 | ||
334 | .IX Item "\f(CW--input \fIfilename\fR\fR" | |
335 | ||
336 | .IX Item "\f(CW-o \fIfilename\fR\fR" | |
337 | ||
338 | .IX Item "\f(CW--output \fIfilename\fR\fR" | |
339 | ||
340 | .IX Item "\f(CW-I \fIformat\fR\fR" | |
341 | ||
342 | .IX Item "\f(CW--input-format \fIformat\fR\fR" | |
343 | ||
344 | .IX Item "\f(CW-O \fIformat\fR\fR" | |
345 | ||
346 | .IX Item "\f(CW--output-format \fIformat\fR\fR" | |
347 | ||
348 | .IX Item "\f(CW-F \fItarget\fR\fR" | |
349 | ||
350 | .IX Item "\f(CW--target \fItarget\fR\fR" | |
351 | ||
352 | .IX Item "\f(CW--preprocessor \fIprogram\fR\fR" | |
353 | ||
354 | .IX Item "\f(CW--include-dir \fIdirectory\fR\fR" | |
355 | ||
356 | .IX Item "\f(CW-D \fItarget\fR\fR" | |
357 | ||
358 | .IX Item "\f(CW--define \fIsym\fR[=\fIval\fR]\fR" | |
359 | ||
360 | .IX Item "\f(CW-v\fR" | |
361 | ||
362 | .IX Item "\f(CW--language \fIval\fR\fR" | |
363 | ||
364 | .IX Item "\f(CW--use-temp-file\fR" | |
365 | ||
366 | .IX Item "\f(CW--no-use-temp-file\fR" | |
367 | ||
368 | .IX Item "\f(CW--help\fR" | |
369 | ||
370 | .IX Item "\f(CW--version\fR" | |
371 | ||
372 | .IX Item "\f(CW--yydebug\fR" | |
373 | ||
374 | .IX Header "SEE ALSO" | |
375 | ||
376 | .IX Header "COPYRIGHT" | |
377 |