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