2 .TH WINEBUILD 1 "July 2002" "@PACKAGE_STRING@" "Wine dll builder"
4 winebuild \- Wine dll builder
6 .BI winebuild\ [options]\ [input\ files]
9 generates the C and assembly files that are necessary to build a Wine
10 dll, which is basically a Win32 dll encapsulated inside a Unix
14 has different modes, depending on what kind of file it is asked to
15 generate. The mode is specified by one of the mode options specified
16 below. In addition to the mode option, various other command-line
17 option can be specified, as described in the \fBOPTIONS\fR section.
19 You have to specify exactly one of the following options, depending on
20 what you want winebuild to generate.
22 .BI \--spec\ file.spec
23 Build a C file from a spec file (see \fBSPEC FILE SYNTAX\fR for
24 details). The resulting C file must be compiled and linked to the
25 other object files to build a working Wine dll.
29 should be the list of all object files that will be linked into the
32 to get the list of all undefined symbols that need to be imported from
36 Build a C file for the named executable. This is basically the same as
37 the --spec mode except that it doesn't require a .spec file as input,
38 since an executable doesn't export functions. The resulting C file
39 must be compiled and linked to the other object files to build a
40 working Wine executable, and all the other object files must be listed
45 Build a .def file from a spec file. This is used when building dlls
46 with a PE (Win32) compiler.
49 Build a C file containing the definitions for debugging channels. In
52 should be a list of C files to search for debug channel
53 definitions. The resulting C file must be compiled and linked with the
57 Build a C file containing the glue code for the 16-bit calls contained
60 These calls must be specified in the source files using special
61 markers, as described in the \fBGLUE FUNCTIONS\fR section.
64 Generate the assembly code for the 16-bit relay routines. This is for
65 Wine internal usage only, you should never need to use this option.
68 Generate the assembly code for the 32-bit relay routines. This is for
69 Wine internal usage only, you should never need to use this option.
73 Change to the specified directory before reading source files. Only
75 .BR \--debug\ and\ --glue\ modes.
78 Ignored for compatibility with the C compiler.
81 Specify the module entry point function; if not specified, the default
88 for CUI or GUI executables respectively. This is only valid for Win32
92 Ignored for compatibility with the C compiler.
95 Display a usage message and exit.
98 Specify the size of the module local heap in bytes (only valid for
99 Win16 modules); default is no local heap.
102 Ignored for compatibility with the C compiler.
105 Ignored for compatibility with the C compiler.
108 Append the specified directory to the list of directories that are
109 searched for import libraries.
112 Import the specified library, looking for a corresponding
113 \fIlib.dll.so\fR file in the directories specified with the \fB-L\fR
117 Same as the \fB-l\fR option, but import the specified library in
118 delayed mode (i.e. the library won't be loaded until a function
119 imported from it is actually called).
122 Specify that we are building a 16-bit dll, that will ultimately be
123 linked together with the 32-bit dll specified in \fImodule\fR. Only
124 meaningful in \fB--spec\fR mode.
127 Set the executable mode, which can be one of the following:
130 for a command line ASCII executable,
133 for a graphical ASCII executable,
136 for a command line Unicode executable,
139 for a graphical Unicode executable.
141 A command line executable entry point is a normal C \fBmain\fR
142 function. A graphical executable has a \fBWinMain\fR entry point
143 instead. The ASCII/Unicode distinction applies to the strings that are
144 passed to the entry point.
146 This option is only meaningful in \fB--exe\fR mode.
149 Set the internal name of the module. It is only used in Win16
150 modules. The default is to use the base name of the spec file (without
151 any extension). This is used for KERNEL, since it lives in
152 KRNL386.EXE. It shouldn't be needed otherwise.
155 Set the name of the output file (default is standard output).
158 Load resources from the specified binary resource file. The
159 \fIrsrc.res\fR can be produced from a source resource file with
161 (or with a Windows resource compiler).
165 .SH "SPEC FILE SYNTAX"
167 A spec file should contain a number of optional directives, and then a
168 list of ordinal declarations. The general syntax is the following:
170 .RB [ ignore\ (\ [ \fIsymbols...\fR ]\ )\ ]
175 .RI [ flags ]\ exportname \ \fB(\fR\ [ args... ] \ \fB)\fI\ handler
177 .IB ordinal\ variable
178 .RI [ flags ]\ exportname \ \fB(\fR\ [ data... ] \ \fB)
181 .RI [ flags ]\ exportname
184 .RI [ flags ]\ exportname\ data
187 .RI [ flags ]\ exportname\ symbolname
190 .RI [ flags ]\ exportname\ forwardname
191 .SS "Optional directives"
193 specifies a list of symbols that should be ignored when
194 resolving undefined symbols against the imported libraries.
196 Lines whose first character is a
198 will be ignored as comments.
199 .SS "Ordinal specifications"
201 specifies the ordinal number corresponding to the entry point, or '@'
202 for automatic ordinal allocation (Win32 only).
205 is a series of optional flags, preceded by a '-' character. The
210 The entry point is not made available for importing from Winelib
211 applications (Win32 only).
214 The entry point is not displayed in relay debugging traces (Win32
218 The entry point will be imported by ordinal instead of by name.
221 The function returns a 64-bit value (Win32 only).
224 The entry point is only available on i386 platforms.
227 The function uses CPU register to pass arguments.
230 The function is an interrupt handler routine.
231 .SS "Function ordinals"
235 .RI [ flags ]\ exportname \ \fB(\fR\ [ args... ] \ \fB)\fI\ handler
238 This declaration defines a function entry point. The prototype defined by
239 .IR exportname \ \fB(\fR\ [ args... ] \ \fB)
240 specifies the name available for dynamic linking and the format of the
241 arguments. '@' can be used instead of
243 for ordinal-only exports.
250 for a normal Win32 function
253 for a Win32 function using the C calling convention
256 for a Win32 function taking a variable number of arguments
259 for a Win16 function returning a 32-bit value
262 for a Win16 function returning a 16-bit value.
266 should be one or several of:
270 (16-bit unsigned value)
285 (linear pointer to a null-terminated ASCII string)
288 (linear pointer to a null-terminated Unicode string)
294 (segmented pointer to a null-terminated ASCII string).
296 .RB Only\ ptr ,\ str ,\ wstr ,\ long\ and\ double
297 are valid for Win32 functions.
301 is the name of the actual C function that will implement that entry
302 point in 32-bit mode.
304 This first example defines an entry point for the 16-bit
305 CreateWindow() call (the ordinal 100 is just an example):
307 100 pascal CreateWindow(ptr ptr long s_word s_word s_word s_word word word word ptr) WIN_CreateWindow
309 This second example defines an entry point for the 32-bit GetFocus()
312 @ stdcall GetFocus() GetFocus
314 To declare a function using a variable number of arguments in Win16,
315 specify the function as taking no arguments. The arguments are then
316 available with CURRENT_STACK16->args. In Win32, specify the function
319 and declare it with a '...' parameter in the C file. See the
320 wsprintf* functions in user.spec and user32.spec for an example.
321 .SS "Variable ordinals"
324 .IB ordinal\ variable
325 .RI [ flags ]\ exportname \ \fB(\fR\ [ data... ] \ \fB)
327 This declaration defines data storage as 32-bit words at the ordinal
330 will be the name available for dynamic
333 can be a decimal number or a hex number preceeded by "0x". The
334 following example defines the variable VariableA at ordinal 2 and
337 2 variable VariableA(-1 0xff 0 0)
342 .RI [ flags ]\ exportname
344 This declaration defines a stub function. It makes the name and
345 ordinal available for dynamic linking, but will terminate execution
346 with an error message if the function is ever called.
347 .SS "Equate ordinals"
351 .RI [ flags ]\ exportname\ data
353 This declaration defines an ordinal as an absolute value.
355 will be the name available for dynamic linking.
357 can be a decimal number or a hex number preceeded by "0x".
358 .SS "Extern ordinals"
362 .RI [ flags ]\ exportname\ symbolname
364 This declaration defines an entry that simply maps to a C symbol
365 (variable or function).
367 will point to the symbol
369 that must be defined in C code. This declaration only works in Win32
371 .SS "Forwarded ordinals"
375 .RI [ flags ]\ exportname\ forwardname
377 This declaration defines an entry that is forwarded to another entry
378 point (kind of a symbolic link).
383 that must be of the form
385 This declaration only works in Win32 spec files.
387 Glue functions are used to call down to 16-bit code from a 32-bit
388 function. This is done by declaring a special type of function
389 prototype in the source file that needs to call to 16-bit code, and
390 processing the source file through
393 These prototypes must be of one of the following forms:
395 .B extern WORD CALLBACK \fIprefix\fB_CallTo16_word_\fIxxx\fB( FARPROC16 func, \fIargs\fB );
397 .B extern LONG CALLBACK \fIprefix\fB_CallTo16_long_\fIxxx\fB( FARPROC16 func, \fIargs\fB );
401 can be anything you need to make the function names unique inside a
404 characters specify the type of the arguments, with one letter for each
405 argument. A \fBw\fR indicates a WORD argument, a \fBl\fR indicates a
408 All the CallTo16 prototypes must be located between the special
410 .B ### start build ###
412 .B ### stop build ###
413 (which have to be inside C comments of course).
415 Here's what a real life example looks like:
417 .B /* ### start build ### */
419 .B extern WORD CALLBACK PRTDRV_CallTo16_word_ww(FARPROC16,WORD,WORD);
421 .B /* ### stop build ### */
424 has been worked on by many people over the years. The main authors are
425 Robert J. Amstadt, Alexandre Julliard, Martin von Loewis, Ulrich
426 Weigand and Eric Youngdale. Many other Wine developers have
427 contributed, please check the file Changelog in the Wine distribution
428 for the complete details.
430 It is not yet possible to use a PE-format dll in an import
431 specification; only Wine dlls can be imported.
433 If you find a bug, please submit a bug report at
434 .UR http://bugs.winehq.com
435 .B http://bugs.winehq.com.
439 is part of the wine distribution, which is available through WineHQ,
442 development headquarters, at
443 .UR http://www.winehq.com/
444 .B http://www.winehq.com/.