1 .TH WINEBUILD 1 "October 2005" "@PACKAGE_STRING@" "Wine Developers Manual"
3 winebuild \- Wine dll builder
6 .RI [ options ]\ [ inputfile ...]
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 \fB-E\fR 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 \fB--dll\fR 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 \fB-E\fR option. The executable is named from the .spec/.def file name if
40 present, or explicitly through the \fB-F\fR 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 \fB-E\fR option. This is used when building dlls with a PE (Win32) compiler.
50 Build a .a import library from a spec file. The .spec file is
51 specified via the \fB-E\fR option. If the output library name ends
52 in .delay.a, a delayed import library is built.
55 Mark a PE module as a Wine builtin module, by adding the "Wine builtin
56 DLL" signature string after the DOS header.
59 Generate a .o file containing all the input resources. This is useful
60 when building with a PE compiler, since the PE binutils cannot handle
61 multiple resource files as input. For a standard Unix build, the
62 resource files are automatically included when building the spec file,
63 so there's no need for an intermediate .o file.
66 .BI \--as-cmd= as-command
67 Specify the command to use to compile assembly files; the default is
70 .BI \-b,\ --target= cpu-manufacturer\fR[\fB-\fIkernel\fR]\fB-\fIos
71 Specify the target CPU and platform on which the generated code will
72 be built. The target specification is in the standard autoconf format
73 as returned by config.sub.
76 Add the directory to the search path for the various binutils tools
77 like \fBas\fR, \fBnm\fR and \fBld\fR.
79 .BI \--cc-cmd= cc-command
80 Specify the C compiler to use to compile assembly files; the default
81 is to instead use the assembler specified with \fB--as-cmd\fR.
83 .BI \-d,\ --delay-lib= name
84 Set the delayed import mode for the specified library, which must be
85 one of the libraries imported with the \fB-l\fR option. Delayed mode
86 means that the library won't be loaded until a function imported from
87 it is actually called.
90 Ignored for compatibility with the C compiler.
92 .BI \-e,\ --entry= function
93 Specify the module entry point function; if not specified, the default
98 for executables (if the standard C
102 is used instead). This is only valid for Win32 modules.
104 .BI \-E,\ --export= filename
105 Specify a .spec file (see \fBSPEC FILE SYNTAX\fR for details),
106 or a standard Windows .def file that defines the exports
107 of the DLL or executable that is being built.
109 .B \--external-symbols
110 Allow linking to external symbols directly from the spec
111 file. Normally symbols exported by a dll have to be defined in the dll
112 itself; this option makes it possible to use symbols defined in
113 another Unix library (for symbols defined in another dll, a
115 specification must be used instead).
118 Specify a code generation option. Currently \fB\-fPIC\fR and
119 \fB\-fasynchronous-unwind-tables\fR are supported. Other options are
120 ignored for compatibility with the C compiler.
123 Create a fake PE module for a dll or exe, instead of the normal
124 assembly or object file. The PE module contains the resources for the
125 module, but no executable code.
127 .BI \-F,\ --filename= filename
128 Set the file name of the module. The default is to use the base name
129 of the spec file (without any extension).
132 Display a usage message and exit.
134 .BI \-H,\ --heap= size
135 Specify the size of the module local heap in bytes (only valid for
136 Win16 modules); default is no local heap.
139 Ignored for compatibility with the C compiler.
142 Remove the stdcall decorations from the symbol names in the
143 generated .def file. Only meaningful in \fB--def\fR mode.
146 Ignored for compatibility with the C compiler.
148 .BI \--large-address-aware
149 Set a flag in the executable to notify the loader that this
150 application supports address spaces larger than 2 gigabytes.
152 .BI \--ld-cmd= ld-command
153 Specify the command to use to link the object files; the default is
156 .BI \-L,\ --library-path= directory
157 Append the specified directory to the list of directories that are
158 searched for import libraries.
160 .BI \-l,\ --library= name
161 Import the specified library, looking for a corresponding
162 \fIlibname.def\fR file in the directories specified with the \fB-L\fR
166 Generate respectively 16-bit, 32-bit or 64-bit code.
168 .BI \-marm,\ \-mthumb,\ \-march= option ,\ \-mcpu= option ,\ \-mfpu= option ,\ \-mfloat-abi= option
169 Set code generation options for the assembler.
172 Build a library that imports standard functions from the Unix C
173 library instead of the Windows runtime.
175 .BI \-M,\ --main-module= module
176 When building a 16-bit dll, set the name of its 32-bit counterpart to
177 \fImodule\fR. This is used to enforce that the load order for the
178 16-bit dll matches that of the 32-bit one.
180 .BI \-N,\ --dll-name= dllname
181 Set the internal name of the module. It is only used in Win16
182 modules. The default is to use the base name of the spec file (without
183 any extension). This is used for KERNEL, since it lives in
184 KRNL386.EXE. It shouldn't be needed otherwise.
186 .BI \--nm-cmd= nm-command
187 Specify the command to use to get the list of undefined symbols; the
190 .BI --nxcompat= yes\fR|\fIno
191 Specify whether the module is compatible with no-exec support. The
194 .BI \-o,\ --output= file
195 Set the name of the output file (default is standard output). If the
196 output file name ends in .o, the text output is sent to a
197 temporary file that is then assembled to produce the specified .o
200 .BI \-r,\ --res= rsrc.res
201 Load resources from the specified binary resource file. The
202 \fIrsrc.res\fR file can be produced from a source resource file with
204 (or with a Windows resource compiler).
206 This option is only necessary for Win16 resource files, the Win32 ones
209 and will automatically be handled correctly (though the
211 option will also work for Win32 files).
214 Do not delete the various temporary files that \fBwinebuild\fR generates.
216 .BI --subsystem= subsystem\fR[\fB:\fImajor\fR[\fB.\fIminor\fR]]
217 Set the subsystem of the executable, which can be one of the following:
220 for a command line executable,
223 for a graphical executable,
226 for a native-mode dll,
231 The entry point of a command line executable is a normal C \fBmain\fR
232 function. A \fBwmain\fR function can be used instead if you need the
233 argument array to use Unicode strings. A graphical executable has a
234 \fBWinMain\fR entry point.
236 Optionally a major and minor subsystem version can also be specified;
237 the default subsystem version is 4.0.
239 .BI \-u,\ --undefined= symbol
240 Add \fIsymbol\fR to the list of undefined symbols when invoking the
241 linker. This makes it possible to force a specific module of a static
242 library to be included when resolving imports.
245 Display the various subcommands being invoked by
249 Display the program version and exit.
253 .SH "SPEC FILE SYNTAX"
255 A spec file should contain a list of ordinal declarations. The general
256 syntax is the following:
259 .RI [ flags ]\ exportname \ \fB(\fR\ [ args... ] \ \fB) \ [ handler ]
261 .IB ordinal\ variable
262 .RI [ flags ]\ exportname \ \fB(\fR\ [ data... ] \ \fB)
265 .RI [ flags ]\ exportname \ [ symbolname ]
268 .RI [ flags ]\ exportname \ [\ \fB( args... \fB)\fR\ ]
271 .RI [ flags ]\ exportname\ data
275 Declarations must fit on a single line, except if the end of line is
276 escaped using a backslash character. The
278 character anywhere in a line causes the rest of the line to be ignored
282 specifies the ordinal number corresponding to the entry point, or '@'
283 for automatic ordinal allocation (Win32 only).
286 is a series of optional flags, preceded by a '-' character. The
291 The entry point is not displayed in relay debugging traces (Win32
295 The entry point will be exported by ordinal instead of by name. The
296 name is still available for importing.
299 The function returns a 16-bit value (Win16 only).
302 The function returns a 64-bit value (Win32 only).
305 The function uses CPU register to pass arguments.
308 The function cannot be imported from other dlls, it can only be
309 accessed through GetProcAddress.
312 The entry point will be imported by ordinal instead of by name. The
313 name is still exported.
316 The function uses the
318 calling convention (first parameter in %ecx register on i386).
321 The function uses the
323 calling convention (first two parameters in %ecx/%edx registers on
327 The function is imported from another module. This can be used instead
330 specification when an application expects to find the function's
331 implementation inside the dll.
333 .B -arch=\fR[\fB!\fR]\fIcpu\fR[\fB,\fIcpu\fR]
334 The entry point is only available on the specified CPU
335 architecture(s). The names \fBwin32\fR and \fBwin64\fR match all
336 32-bit or 64-bit CPU architectures respectively. In 16-bit dlls,
337 specifying \fB-arch=win32\fR causes the entry point to be exported
338 from the 32-bit wrapper module. A CPU name can be prefixed with
339 \fB!\fR to exclude only that specific architecture.
341 .SS "Function ordinals"
345 .RI [ flags ]\ exportname \ \fB(\fR\ [ args... ] \ \fB) \ [ handler ]
348 This declaration defines a function entry point. The prototype defined by
349 .IR exportname \ \fB(\fR\ [ args... ] \ \fB)
350 specifies the name available for dynamic linking and the format of the
351 arguments. '@' can be used instead of
353 for ordinal-only exports.
360 for a normal Win32 function
363 for a normal Win16 function
366 for a Win16 or Win32 function using the C calling convention
369 for a Win16 or Win32 function using the C calling convention with a
370 variable number of arguments
374 should be one or several of:
378 (16-bit unsigned value)
384 (pointer-sized integer value)
387 (64-bit integer value)
390 (128-bit integer value)
393 (32-bit floating point value)
396 (64-bit floating point value)
402 (linear pointer to a null-terminated ASCII string)
405 (linear pointer to a null-terminated Unicode string)
411 (segmented pointer to a null-terminated ASCII string).
413 Note: The 16-bit and segmented pointer types are only valid for Win16
418 is the name of the actual C function that will implement that entry
419 point in 32-bit mode. The handler can also be specified as
420 .IB dllname . function
421 to define a forwarded function (one whose implementation is in another
424 is not specified, it is assumed to be identical to
427 This first example defines an entry point for the 32-bit GetFocus()
430 @ stdcall GetFocus() GetFocus
432 This second example defines an entry point for the 16-bit
433 CreateWindow() call (the ordinal 100 is just an example); it also
434 shows how long lines can be split using a backslash:
436 100 pascal CreateWindow(ptr ptr long s_word s_word s_word \\
437 s_word word word word ptr) WIN_CreateWindow
439 To declare a function using a variable number of arguments, specify
442 and declare it in the C file with a '...' parameter for a Win32
443 function, or with an extra VA_LIST16 argument for a Win16 function.
444 See the wsprintf* functions in user.exe.spec and user32.spec for an
446 .SS "Variable ordinals"
449 .IB ordinal\ variable
450 .RI [ flags ]\ exportname \ \fB(\fR\ [ data... ] \ \fB)
452 This declaration defines data storage as 32-bit words at the ordinal
455 will be the name available for dynamic
458 can be a decimal number or a hex number preceded by "0x". The
459 following example defines the variable VariableA at ordinal 2 and
462 2 variable VariableA(-1 0xff 0 0)
464 This declaration only works in Win16 spec files. In Win32 you should
468 .SS "Extern ordinals"
472 .RI [ flags ]\ exportname \ [ symbolname ]
474 This declaration defines an entry that simply maps to a C symbol
475 (variable or function). It only works in Win32 spec files.
477 will point to the symbol
479 that must be defined in the C code. Alternatively, it can be of the
481 .IB dllname . symbolname
482 to define a forwarded symbol (one whose implementation is in another
485 is not specified, it is assumed to be identical to
491 .RI [ flags ]\ exportname \ [\ \fB( args... \fB)\fR\ ]
493 This declaration defines a stub function. It makes the name and
494 ordinal available for dynamic linking, but will terminate execution
495 with an error message if the function is ever called.
496 .SS "Equate ordinals"
500 .RI [ flags ]\ exportname\ data
502 This declaration defines an ordinal as an absolute value.
504 will be the name available for dynamic linking.
506 can be a decimal number or a hex number preceded by "0x".
509 has been worked on by many people over the years. The main authors are
510 Robert J. Amstadt, Alexandre Julliard, Martin von Loewis, Ulrich
511 Weigand and Eric Youngdale. Many other people have contributed new features
512 and bug fixes. For a complete list, see the git commit logs.
514 It is not yet possible to use a PE-format dll in an import
515 specification; only Wine dlls can be imported.
517 Bugs can be reported on the
518 .UR https://bugs.winehq.org
523 is part of the Wine distribution, which is available through WineHQ,
525 .UR https://www.winehq.org/
526 .B Wine development headquarters
533 .UR https://www.winehq.org/help
534 .B Wine documentation and support