| blob | c5d6a60777beb54f87639a2d81bc2b6f142e4e68 |
1 .\" -*- nroff -*-
2 .TH WRC 1 "October 2005" "@PACKAGE_STRING@" "Wine Developers Manual"
3 .SH NAME
4 wrc \- Wine Resource Compiler
5 .SH SYNOPSIS
6 .BI "wrc " "[options] " "[inputfiles]"
7 .SH DESCRIPTION
8 .B wrc
9 compiles resources from \fBinputfile\fR
10 into win16 and win32 compatible binary format.
11 .PP
12 The source\-file is preprocessed with a builtin ANSI\-C compatible
13 preprocessor before the resources are compiled. See \fBPREPROCESSOR\fR
14 below.
15 .PP
16 .B wrc
17 takes a series of \fBinputfile\fR as argument. The resources are read from
18 standard input if no inputfile is given. If the output file is not
19 specified with \fI-o\fR, then \fBwrc\fR will write the output to
20 \fBinputfile.res\fR with \fB.rc\fR stripped, or to \fBwrc.tab.res\fR if
21 no inputfile was given.
22 .SH OPTIONS
23 .TP
24 .BI \-b,\ --target= cpu-manufacturer[-kernel]-os
25 Specify the target CPU and platform on which the generated code will
26 be built. The target specification is in the standard autoconf format
27 as returned by config.sub.
28 .TP
29 .I \fB\-D\fR, \fB\-\-define\fR=\fIid[=val]\fR
30 Define preprocessor identifier \fIid\fR to (optionally) value \fIval\fR.
31 See also
32 .B PREPROCESSOR
33 below.
34 .TP
35 .I \fB\-\-debug\fR=\fInn\fR
36 Set debug level to \fInn\fR. The value is a bitmask consisting of
37 1=verbose, 2=dump internals, 4=resource parser trace, 8=preprocessor
38 messages, 16=preprocessor scanner and 32=preprocessor parser trace.
39 .TP
40 .I \fB\-\-endianess\fR=\fIe\fR
41 Win32 only; set output byte\-ordering, where \fIe\fR is one of n[ative],
42 l[ittle] or b[ig]. Only resources in source-form can be reorderd. Native
43 ordering depends on the system on which \fBwrc\fR was built. You can see
44 the native ordering by typing \fIwrc \-h\fR.
45 .TP
46 .I \fB\-E\fR
47 Preprocess only. The output is written to standard output if no
48 outputfile was selected. The output is compatible with what gcc would
49 generate.
50 .TP
51 .I \fB\-h\fR, \fB\-\-help\fR
52 Prints a summary message and exits.
53 .TP
54 .I \fB\-i\fR, \fB\-\-input\fR=\fIfile\fR
55 The name of the input file. If this option is not used, then \fBwrc\fR
56 will use the first non-option argument as the input file name. If there
57 are no non-option arguments, then \fBwrc\fR will read from standard input.
58 .TP
59 .I \fB\-I\fR, \fB\-\-include\-dir\fR=\fIfile\fR
60 Add \fIpath\fR to include search directories. \fIPath\fR may contain
61 multiple directories, separated with ':'. It is allowed to specify
62 \fI\-I\fR multiple times. Include files are searched in the order in
63 with the \fI\-I\fR options were specified.
64 .br
65 The search is compatible with gcc, in which '<>' quoted filenames are
66 searched exclusively via the \fI\-I\fR set path, whereas the '""' quoted
67 filenames are first tried to be opened in the current directory. Also
68 resource statements with file references are located in the same way.
69 .TP
70 .I \fB\-J\fR, \fB\-\-input\-format\fR=\fIformat\fR
71 Sets the input format. Valid options are 'rc' or 'rc16'. Setting the
72 input to 'rc16' disables the recognition of win32 keywords.
73 .TP
74 .I \fB\-l\fR, \fB\-\-language\fR=\fIlan\fR
75 Set default language to \fIlan\fR. Default is the neutral language 0
76 (i.e. "LANGUAGE 0, 0").
77 .TP
78 .B \-m16, -m32, -m64
79 Generate resources for 16-bit, 32-bit, respectively 64-bit
80 platforms. The only difference between 32-bit and 64-bit is whether
81 the _WIN64 preprocessor symbol is defined.
82 .TP
83 .I \fB\-\-nostdinc\fR
84 Do not search the standard include path, look for include files only
85 in the directories explicitly specified with the \fI\-I\fR option.
86 .TP
87 .I \fB\-\-no\-use\-temp\-file\fR
88 Ignored for compatibility with \fIwindres\fR.
89 .TP
90 .I \fB\-o\fR, \fB\-fo\fR, \fB\-\-output\fR=\fIfile\fR
91 Write output to \fIfile\fR. Default is \fBinputfile.res\fR
92 with \fB.rc\fR stripped or \fBwrc.tab.res\fR if input is read
93 from standard input.
94 .TP
95 .I \fB\-O\fR, \fB\-\-output\-format\fR=\fIformat\fR
96 Sets the output format. The supported formats are 'res' and 'res16'.
97 If this option is not specified, format defaults to 'res'.
98 .TP
99 .I \fB\-\-pedantic\fR
100 Enable pedantic warnings. Notably redefinition of #define statements can
101 be discovered with this option.
102 .TP
103 .I \fB\-r\fR
104 Ignored for compatibility with \fIrc\fR.
105 .TP
106 .I \fB\-\-preprocessor\fR=\fIprogram\fR
107 This option may be used to specify the preprocessor to use, including any
108 leading arguments. If not specified, \fBwrc\fR uses its builtin processor.
109 To disable preprocessing, use \fB--preprocessor=cat\fR.
110 .TP
111 .I \fB\-U\fR, \fB\-\-undefine\fR=\fIid\fR
112 Undefine preprocessor identifier \fIid\fR. Please note that only macros
113 defined up to this point are undefined by this command. However, these
114 include the special macros defined automatically by \fIwrc\fR.
115 See also
116 .B PREPROCESSOR
117 below.
118 .TP
119 .I \fB\-\-use\-temp\-file\fR
120 Ignored for compatibility with \fIwindres\fR.
121 .TP
122 .I \fB\-v\fR, \fB\-\-verbose\fR
123 Turns on verbose mode (equivalent to -d 1).
124 .TP
125 .I \fB\-\-version\fR
126 Print version end exit.
127 .SH PREPROCESSOR
128 The preprocessor is ANSI\-C compatible with some of the extensions of
129 the gcc preprocessor.
130 .PP
131 The preprocessor recognizes these directives: #include, #define (both
132 simple and macro), #undef, #if, #ifdef, #ifndef, #elif, #else, #endif,
133 #error, #warning, #line, # (both null\- and line\-directive), #pragma
134 (ignored), #ident (ignored).
135 .PP
136 The preprocessor sets by default several defines:
137 .br
138 RC_INVOKED set to 1
139 .br
140 __WRC__ Major version of wrc
141 .br
142 __WRC_MINOR__ Minor version of wrc
143 .br
144 __WRC_PATCHLEVEL__ Patch level
145 .PP
146 Win32 compilation mode also sets _WIN32 to 1.
147 .PP
148 Special macros __FILE__, __LINE__, __TIME__ and __DATE__ are also
149 recognized and expand to their respective equivalent.
150 .SH "LANGUAGE SUPPORT"
151 Language, version and characteristics can be bound to all resource types that
152 have inline data, such as RCDATA. This is an extension to Microsoft's resource
153 compiler, which lacks this support completely. Only VERSIONINFO cannot have
154 version and characteristics attached, but languages are propagated properly if
155 you declare it correctly before the VERSIONINFO resource starts.
156 .PP
157 Example:
158 .PP
159 1 RCDATA DISCARDABLE
160 .br
161 LANGUAGE 1, 0
162 .br
163 VERSION 312
164 .br
165 CHARACTERISTICS 876
166 .br
167 {
168 .br
169 1, 2, 3, 4, 5, "and whatever more data you want"
170 .br
171 '00 01 02 03 04 05 06 07 08'
172 .br
173 }
174 .SH AUTHORS
175 .B wrc
176 was written by Bertho A. Stultiens and is a nearly complete rewrite of
177 the first wine resource compiler (1994) by Martin von Loewis.
178 Additional resource\-types were contributed Ulrich Czekalla and Albert
179 den Haan. Many cleanups by Dimitrie O. Paun in 2002-2003.
180 Bugfixes have been contributed by many Wine developers.
181 .SH BUGS
182 \- The preprocessor recognizes variable argument macros, but does not
183 expanded them correctly.
184 .br
185 \- Error reporting should be more precise, as currently the column and
186 line number reported are those of the next token.
187 .br
188 \- Default memory options should differ between win16 and win32.
189 .PP
190 There is no support for:
191 .br
192 \- RT_DLGINCLUDE, RT_VXD, RT_PLUGPLAY and RT_HTML (unknown format)
193 .br
194 \- PUSHBOX control is unsupported due to lack of original functionality.
195 .PP
196 Fonts are parsed and generated, but there is no support for the
197 generation of the FONTDIR yet. The user must supply the FONTDIR
198 resource in the source to match the FONT resources.
199 .SH AVAILABILITY
200 .B wrc
201 is part of the Wine distribution, which is available through
202 WineHQ, the Wine development headquarters, at
203 .I http://www.winehq.org/.
204 .SH "SEE ALSO"
205 .BR wine (1)