2 .TH WINEBUILD 1 "October 2005" "@PACKAGE_STRING@" "Wine Developers Manual"
4 winebuild \- Wine dll builder
6 .BI winebuild\ [options]\ [input\ files]
9 generates the assembly files that are necessary to build a Wine dll,
10 which is basically a Win32 dll encapsulated inside a Unix library.
13 has different modes, depending on what kind of file it is asked to
14 generate. The mode is specified by one of the mode options specified
15 below. In addition to the mode option, various other command-line
16 option can be specified, as described in the \fBOPTIONS\fR section.
18 You have to specify exactly one of the following options, depending on
19 what you want winebuild to generate.
22 Build an assembly file from a .spec file (see \fBSPEC FILE SYNTAX\fR
23 for details), or from a standard Windows .def file. The .spec/.def
24 file is specified via the -E option. The resulting file must be
25 assembled and linked to the other object files to build a working Wine
26 dll. In this mode, the
28 should be the list of all object files that will be linked into the
31 to get the list of all undefined symbols that need to be imported from
35 Build an assembly file for an executable. This is basically the same as
36 the --dll mode except that it doesn't require a .spec/.def file as input,
37 since an executable need not export functions. Some executables however
38 do export functions, and for those a .spec/.def file can be specified via
39 the -E option. The executable is named from the .spec/.def file name if
40 present, or explicitly through the -F option. The resulting file must be
41 assembled and linked to the other object files to build a working Wine
42 executable, and all the other object files must be listed as
46 Build a .def file from a spec file. The .spec file is specified via the
47 -E option. This is used when building dlls with a PE (Win32) compiler.
50 Build a PE import library from a spec file. The .spec file is
51 specified via the -E option.
54 Generate the assembly code for the 16-bit relay routines. This is for
55 Wine internal usage only, you should never need to use this option.
58 Generate the assembly code for the 32-bit relay routines. This is for
59 Wine internal usage only, you should never need to use this option.
62 Generate a .o file containing all the input resources. This is useful
63 when building with a PE compiler, since the PE binutils cannot handle
64 multiple resource files as input. For a standard Unix build, the
65 resource files are automatically included when building the spec file,
66 so there's no need for an intermediate .o file.
69 .BI \--as-cmd= as-command
70 Specify the command to use to compile assembly files; the default is
73 .BI \-b,\ --target= cpu-manufacturer[-kernel]-os
74 Specify the target CPU and platform on which the generated code will
75 be built. The target specification is in the standard autoconf format
76 as returned by config.sub.
78 .BI \-d,\ --delay-lib= name
79 Set the delayed import mode for the specified library, which must be
80 one of the libraries imported with the \fB-l\fR option. Delayed mode
81 means that the library won't be loaded until a function imported from
82 it is actually called.
85 Ignored for compatibility with the C compiler.
87 .BI \-e,\ --entry= function
88 Specify the module entry point function; if not specified, the default
93 for executables (if the standard C
97 is used instead). This is only valid for Win32 modules.
99 .BI \-E,\ --export= filename
100 Specify a .spec file (see \fBSPEC FILE SYNTAX\fR for details),
101 or a standard Windows .def file that defines the exports
102 of the DLL or executable that is being built.
104 .B \--external-symbols
105 Allow linking to external symbols directly from the spec
106 file. Normally symbols exported by a dll have to be defined in the dll
107 itself; this option makes it possible to use symbols defined in
108 another Unix library (for symbols defined in another dll, a
110 specification must be used instead).
113 Ignored for compatibility with the C compiler.
116 Create a fake PE module for a dll or exe, instead of the normal
117 assembly or object file. The PE module contains the resources for the
118 module, but no executable code.
120 .BI \-F,\ --filename= filename
121 Set the file name of the module. The default is to use the base name
122 of the spec file (without any extension).
125 Display a usage message and exit.
127 .BI \-H,\ --heap= size
128 Specify the size of the module local heap in bytes (only valid for
129 Win16 modules); default is no local heap.
131 .BI \-i,\ --ignore= [-]symbol[,[-]symbol]
132 Specify a list of symbols that should be ignored when resolving
133 undefined symbols against the imported libraries. This forces these
134 symbols to be resolved from the Unix C library (or from another Unix
135 library linked with the application). If a symbol is prefixed by '-'
136 it is removed from the list instead of being added; a stand-alone '-'
137 clears the whole list.
140 Ignored for compatibility with the C compiler.
143 Remove the stdcall decorations from the symbol names in the
144 generated .def file. Only meaningful in \fB--def\fR mode.
147 Ignored for compatibility with the C compiler.
149 .BI \--large-address-aware
150 Set a flag in the executable to notify the loader that this
151 application supports address spaces larger than 2 gigabytes.
153 .BI \--ld-cmd= ld-command
154 Specify the command to use to link the object files; the default is
157 .BI \-L,\ --library-path= directory
158 Append the specified directory to the list of directories that are
159 searched for import libraries.
161 .BI \-l,\ --library= name
162 Import the specified library, looking for a corresponding
163 \fIlibname.def\fR file in the directories specified with the \fB-L\fR
167 Generate 32-bit, respectively 64-bit code.
169 .BI \-M,\ --main-module= module
170 When building a 16-bit dll, set the name of its 32-bit counterpart to
171 \fImodule\fR. This is used to enforce that the load order for the
172 16-bit dll matches that of the 32-bit one.
174 .BI \-N,\ --dll-name= dllname
175 Set the internal name of the module. It is only used in Win16
176 modules. The default is to use the base name of the spec file (without
177 any extension). This is used for KERNEL, since it lives in
178 KRNL386.EXE. It shouldn't be needed otherwise.
180 .BI \--nm-cmd= nm-command
181 Specify the command to use to get the list of undefined symbols; the
184 .BI --nxcompat= yes|no
185 Specify whether the module is compatible with no-exec support. The
188 .BI \-o,\ --output= file
189 Set the name of the output file (default is standard output). If the
190 output file name end in \fB.o\fR, the text output is sent to a
191 temporary file that is then assembled to produce the specified .o
194 .BI \-r,\ --res= rsrc.res
195 Load resources from the specified binary resource file. The
196 \fIrsrc.res\fR file can be produced from a source resource file with
198 (or with a Windows resource compiler).
200 This option is only necessary for Win16 resource files, the Win32 ones
203 and will automatically be handled correctly (though the
205 option will also work for Win32 files).
208 Do not delete the various temporary files that \fBwinebuild\fR generates.
210 .BI --subsystem= subsystem[:major[.minor]]
211 Set the subsystem of the executable, which can be one of the following:
214 for a command line executable,
217 for a graphical executable,
220 for a native-mode dll,
225 The entry point of a command line executable is a normal C \fBmain\fR
226 function. A \fBwmain\fR function can be used instead if you need the
227 argument array to use Unicode strings. A graphical executable has a
228 \fBWinMain\fR entry point.
230 Optionally a major and minor subsystem version can also be specified;
231 the default subsystem version is 4.0.
233 .BI \-u,\ --undefined= symbol
234 Add \fIsymbol\fR to the list of undefined symbols when invoking the
235 linker. This makes it possible to force a specific module of a static
236 library to be included when resolving imports.
239 Display the various subcommands being invoked by
243 Display the program version and exit.
247 .SH "SPEC FILE SYNTAX"
249 A spec file should contain a list of ordinal declarations. The general
250 syntax is the following:
253 .RI [ flags ]\ exportname \ \fB(\fR\ [ args... ] \ \fB) \ [ handler ]
255 .IB ordinal\ variable
256 .RI [ flags ]\ exportname \ \fB(\fR\ [ data... ] \ \fB)
259 .RI [ flags ]\ exportname \ [ symbolname ]
262 .RI [ flags ]\ exportname
265 .RI [ flags ]\ exportname\ data
269 Declarations must fit on a single line, except if the end of line is
270 escaped using a backslash character. The
272 character anywhere in a line causes the rest of the line to be ignored
276 specifies the ordinal number corresponding to the entry point, or '@'
277 for automatic ordinal allocation (Win32 only).
280 is a series of optional flags, preceded by a '-' character. The
285 The entry point is not displayed in relay debugging traces (Win32
289 The entry point will be exported by ordinal instead of by name. The
290 name is still available for importing.
293 The function returns a 16-bit value (Win16 only).
296 The function returns a 64-bit value (Win32 only).
299 The function uses CPU register to pass arguments.
302 The function cannot be imported from other dlls, it can only be
303 accessed through GetProcAddress.
306 The entry point will be imported by ordinal instead of by name. The
307 name is still exported.
310 The entry point is only available on the specified CPU
311 architecture(s). The names \fBwin32\fR and \fBwin64\fR match all
312 32-bit, respectively 64-bit, CPU architectures. In 16-bit dlls,
313 specifying \fB-arch=win32\fR causes the entry point to be exported
314 from the 32-bit wrapper module.
315 .SS "Function ordinals"
319 .RI [ flags ]\ exportname \ \fB(\fR\ [ args... ] \ \fB) \ [ handler ]
322 This declaration defines a function entry point. The prototype defined by
323 .IR exportname \ \fB(\fR\ [ args... ] \ \fB)
324 specifies the name available for dynamic linking and the format of the
325 arguments. '@' can be used instead of
327 for ordinal-only exports.
334 for a normal Win32 function
337 for a normal Win16 function
340 for a Win16 or Win32 function using the C calling convention
343 for a Win16 or Win32 function using the C calling convention with a
344 variable number of arguments
348 should be one or several of:
352 (16-bit unsigned value)
367 (linear pointer to a null-terminated ASCII string)
370 (linear pointer to a null-terminated Unicode string)
376 (segmented pointer to a null-terminated ASCII string).
378 .RB Only\ ptr ,\ str ,\ wstr ,\ long\ and\ double
379 are valid for Win32 functions.
383 is the name of the actual C function that will implement that entry
384 point in 32-bit mode. The handler can also be specified as
385 .IB dllname . function
386 to define a forwarded function (one whose implementation is in another
389 is not specified, it is assumed to be identical to
392 This first example defines an entry point for the 32-bit GetFocus()
395 @ stdcall GetFocus() GetFocus
397 This second example defines an entry point for the 16-bit
398 CreateWindow() call (the ordinal 100 is just an example); it also
399 shows how long lines can be split using a backslash:
401 100 pascal CreateWindow(ptr ptr long s_word s_word s_word \\
402 s_word word word word ptr) WIN_CreateWindow
404 To declare a function using a variable number of arguments, specify
407 and declare it in the C file with a '...' parameter for a Win32
408 function, or with an extra VA_LIST16 argument for a Win16 function.
409 See the wsprintf* functions in user.exe.spec and user32.spec for an
411 .SS "Variable ordinals"
414 .IB ordinal\ variable
415 .RI [ flags ]\ exportname \ \fB(\fR\ [ data... ] \ \fB)
417 This declaration defines data storage as 32-bit words at the ordinal
420 will be the name available for dynamic
423 can be a decimal number or a hex number preceded by "0x". The
424 following example defines the variable VariableA at ordinal 2 and
427 2 variable VariableA(-1 0xff 0 0)
429 This declaration only works in Win16 spec files. In Win32 you should
433 .SS "Extern ordinals"
437 .RI [ flags ]\ exportname \ [ symbolname ]
439 This declaration defines an entry that simply maps to a C symbol
440 (variable or function). It only works in Win32 spec files.
442 will point to the symbol
444 that must be defined in the C code. Alternatively, it can be of the
446 .IB dllname . symbolname
447 to define a forwarded symbol (one whose implementation is in another
450 is not specified, it is assumed to be identical to
456 .RI [ flags ]\ exportname
458 This declaration defines a stub function. It makes the name and
459 ordinal available for dynamic linking, but will terminate execution
460 with an error message if the function is ever called.
461 .SS "Equate ordinals"
465 .RI [ flags ]\ exportname\ data
467 This declaration defines an ordinal as an absolute value.
469 will be the name available for dynamic linking.
471 can be a decimal number or a hex number preceded by "0x".
474 has been worked on by many people over the years. The main authors are
475 Robert J. Amstadt, Alexandre Julliard, Martin von Loewis, Ulrich
476 Weigand and Eric Youngdale. Many other Wine developers have
477 contributed, please check the file Changelog in the Wine distribution
478 for the complete details.
480 It is not yet possible to use a PE-format dll in an import
481 specification; only Wine dlls can be imported.
483 If you find a bug, please submit a bug report at
484 .UR http://bugs.winehq.org
485 .B http://bugs.winehq.org.
489 is part of the wine distribution, which is available through WineHQ,
492 development headquarters, at
493 .UR http://www.winehq.org/
494 .B http://www.winehq.org/.
projects / wine / blob