| blob | 3762b742ac29aa8597793b32c457dfd58088ea0f |
1 .\" -*- nroff -*-
2 .TH WINEBUILD 1 "October 2005" "@PACKAGE_STRING@" "Wine Developers Manual"
3 .SH NAME
4 winebuild \- Wine dll builder
5 .SH SYNOPSIS
6 .BI winebuild\ [options]\ [input\ files]
7 .SH DESCRIPTION
8 .B winebuild
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.
11 .PP
12 .B winebuild
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.
17 .SH "MODE OPTIONS"
18 You have to specify exactly one of the following options, depending on
19 what you want winebuild to generate.
20 .TP
21 .BI \--dll
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
27 .I input files
28 should be the list of all object files that will be linked into the
29 final dll, to allow
30 .B winebuild
31 to get the list of all undefined symbols that need to be imported from
32 other dlls.
33 .TP
34 .BI \--exe
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
43 .I input files.
44 .TP
45 .BI \--def
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.
48 .TP
49 .BI \--implib
50 Build a PE import library from a spec file. The .spec file is
51 specified via the -E option.
52 .TP
53 .B \--resources
54 Generate a .o file containing all the input resources. This is useful
55 when building with a PE compiler, since the PE binutils cannot handle
56 multiple resource files as input. For a standard Unix build, the
57 resource files are automatically included when building the spec file,
58 so there's no need for an intermediate .o file.
59 .SH OPTIONS
60 .TP
61 .BI \--as-cmd= as-command
62 Specify the command to use to compile assembly files; the default is
63 \fBas\fR.
64 .TP
65 .BI \-b,\ --target= cpu-manufacturer[-kernel]-os
66 Specify the target CPU and platform on which the generated code will
67 be built. The target specification is in the standard autoconf format
68 as returned by config.sub.
69 .TP
70 .BI \--cc-cmd= cc-command
71 Specify the C compiler to use to compile assembly files; the default
72 is to instead use the assembler specified with \fB--as-cmd\fR.
73 .TP
74 .BI \-d,\ --delay-lib= name
75 Set the delayed import mode for the specified library, which must be
76 one of the libraries imported with the \fB-l\fR option. Delayed mode
77 means that the library won't be loaded until a function imported from
78 it is actually called.
79 .TP
80 .BI \-D\ symbol
81 Ignored for compatibility with the C compiler.
82 .TP
83 .BI \-e,\ --entry= function
84 Specify the module entry point function; if not specified, the default
85 is
86 .B DllMain
87 for dlls, and
88 .B main
89 for executables (if the standard C
90 .B main
91 is not defined,
92 .B WinMain
93 is used instead). This is only valid for Win32 modules.
94 .TP
95 .BI \-E,\ --export= filename
96 Specify a .spec file (see \fBSPEC FILE SYNTAX\fR for details),
97 or a standard Windows .def file that defines the exports
98 of the DLL or executable that is being built.
99 .TP
100 .B \--external-symbols
101 Allow linking to external symbols directly from the spec
102 file. Normally symbols exported by a dll have to be defined in the dll
103 itself; this option makes it possible to use symbols defined in
104 another Unix library (for symbols defined in another dll, a
105 .I forward
106 specification must be used instead).
107 .TP
108 .BI \-f\ option
109 Specify a code generation option. Currently \fB\-fPIC\fR and
110 \fB\-fasynchronous-unwind-tables\fR are supported. Other options are
111 ignored for compatibility with the C compiler.
112 .TP
113 .B \--fake-module
114 Create a fake PE module for a dll or exe, instead of the normal
115 assembly or object file. The PE module contains the resources for the
116 module, but no executable code.
117 .TP
118 .BI \-F,\ --filename= filename
119 Set the file name of the module. The default is to use the base name
120 of the spec file (without any extension).
121 .TP
122 .B \-h, --help
123 Display a usage message and exit.
124 .TP
125 .BI \-H,\ --heap= size
126 Specify the size of the module local heap in bytes (only valid for
127 Win16 modules); default is no local heap.
128 .TP
129 .BI \-I\ directory
130 Ignored for compatibility with the C compiler.
131 .TP
132 .B \-k, --kill-at
133 Remove the stdcall decorations from the symbol names in the
134 generated .def file. Only meaningful in \fB--def\fR mode.
135 .TP
136 .BI \-K\ flags
137 Ignored for compatibility with the C compiler.
138 .TP
139 .BI \--large-address-aware
140 Set a flag in the executable to notify the loader that this
141 application supports address spaces larger than 2 gigabytes.
142 .TP
143 .BI \--ld-cmd= ld-command
144 Specify the command to use to link the object files; the default is
145 \fBld\fR.
146 .TP
147 .BI \-L,\ --library-path= directory
148 Append the specified directory to the list of directories that are
149 searched for import libraries.
150 .TP
151 .BI \-l,\ --library= name
152 Import the specified library, looking for a corresponding
153 \fIlibname.def\fR file in the directories specified with the \fB-L\fR
154 option.
155 .TP
156 .B \-m16, -m32, -m64
157 Generate 16-bit, 32-bit, respectively 64-bit code.
158 .TP
159 .BI \-M,\ --main-module= module
160 When building a 16-bit dll, set the name of its 32-bit counterpart to
161 \fImodule\fR. This is used to enforce that the load order for the
162 16-bit dll matches that of the 32-bit one.
163 .TP
164 .BI \-N,\ --dll-name= dllname
165 Set the internal name of the module. It is only used in Win16
166 modules. The default is to use the base name of the spec file (without
167 any extension). This is used for KERNEL, since it lives in
168 KRNL386.EXE. It shouldn't be needed otherwise.
169 .TP
170 .BI \--nm-cmd= nm-command
171 Specify the command to use to get the list of undefined symbols; the
172 default is \fBnm\fR.
173 .TP
174 .BI --nxcompat= yes|no
175 Specify whether the module is compatible with no-exec support. The
176 default is yes.
177 .TP
178 .BI \-o,\ --output= file
179 Set the name of the output file (default is standard output). If the
180 output file name end in \fB.o\fR, the text output is sent to a
181 temporary file that is then assembled to produce the specified .o
182 file.
183 .TP
184 .BI \-r,\ --res= rsrc.res
185 Load resources from the specified binary resource file. The
186 \fIrsrc.res\fR file can be produced from a source resource file with
187 .BR wrc(1)
188 (or with a Windows resource compiler).
189 .br
190 This option is only necessary for Win16 resource files, the Win32 ones
191 can simply listed as
192 .I input files
193 and will automatically be handled correctly (though the
194 .B \-r
195 option will also work for Win32 files).
196 .TP
197 .B --save-temps
198 Do not delete the various temporary files that \fBwinebuild\fR generates.
199 .TP
200 .BI --subsystem= subsystem[:major[.minor]]
201 Set the subsystem of the executable, which can be one of the following:
202 .br
203 .B console
204 for a command line executable,
205 .br
206 .B windows
207 for a graphical executable,
208 .br
209 .B native
210 for a native-mode dll,
211 .br
212 .B wince
213 for a ce dll.
214 .br
215 The entry point of a command line executable is a normal C \fBmain\fR
216 function. A \fBwmain\fR function can be used instead if you need the
217 argument array to use Unicode strings. A graphical executable has a
218 \fBWinMain\fR entry point.
219 .br
220 Optionally a major and minor subsystem version can also be specified;
221 the default subsystem version is 4.0.
222 .TP
223 .BI \-u,\ --undefined= symbol
224 Add \fIsymbol\fR to the list of undefined symbols when invoking the
225 linker. This makes it possible to force a specific module of a static
226 library to be included when resolving imports.
227 .TP
228 .B \-v, --verbose
229 Display the various subcommands being invoked by
230 .B winebuild.
231 .TP
232 .B \--version
233 Display the program version and exit.
234 .TP
235 .B \-w, --warnings
236 Turn on warnings.
237 .SH "SPEC FILE SYNTAX"
238 .SS "General syntax"
239 A spec file should contain a list of ordinal declarations. The general
240 syntax is the following:
241 .PP
242 .I ordinal functype
243 .RI [ flags ]\ exportname \ \fB(\fR\ [ args... ] \ \fB) \ [ handler ]
244 .br
245 .IB ordinal\ variable
246 .RI [ flags ]\ exportname \ \fB(\fR\ [ data... ] \ \fB)
247 .br
248 .IB ordinal\ extern
249 .RI [ flags ]\ exportname \ [ symbolname ]
250 .br
251 .IB ordinal\ stub
252 .RI [ flags ]\ exportname \ [\ \fB( args... \fB)\fR\ ]
253 .br
254 .IB ordinal\ equate
255 .RI [ flags ]\ exportname\ data
256 .br
257 .BI #\ comments
258 .PP
259 Declarations must fit on a single line, except if the end of line is
260 escaped using a backslash character. The
261 .B #
262 character anywhere in a line causes the rest of the line to be ignored
263 as a comment.
264 .PP
265 .I ordinal
266 specifies the ordinal number corresponding to the entry point, or '@'
267 for automatic ordinal allocation (Win32 only).
268 .PP
269 .I flags
270 is a series of optional flags, preceded by a '-' character. The
271 supported flags are:
272 .RS
273 .TP
274 .B -norelay
275 The entry point is not displayed in relay debugging traces (Win32
276 only).
277 .TP
278 .B -noname
279 The entry point will be exported by ordinal instead of by name. The
280 name is still available for importing.
281 .TP
282 .B -ret16
283 The function returns a 16-bit value (Win16 only).
284 .TP
285 .B -ret64
286 The function returns a 64-bit value (Win32 only).
287 .TP
288 .B -register
289 The function uses CPU register to pass arguments.
290 .TP
291 .B -private
292 The function cannot be imported from other dlls, it can only be
293 accessed through GetProcAddress.
294 .TP
295 .B -ordinal
296 The entry point will be imported by ordinal instead of by name. The
297 name is still exported.
298 .TP
299 .BI -arch= cpu[,cpu]
300 The entry point is only available on the specified CPU
301 architecture(s). The names \fBwin32\fR and \fBwin64\fR match all
302 32-bit, respectively 64-bit, CPU architectures. In 16-bit dlls,
303 specifying \fB-arch=win32\fR causes the entry point to be exported
304 from the 32-bit wrapper module.
305 .SS "Function ordinals"
306 Syntax:
307 .br
308 .I ordinal functype
309 .RI [ flags ]\ exportname \ \fB(\fR\ [ args... ] \ \fB) \ [ handler ]
310 .br
312 This declaration defines a function entry point. The prototype defined by
313 .IR exportname \ \fB(\fR\ [ args... ] \ \fB)
314 specifies the name available for dynamic linking and the format of the
315 arguments. '@' can be used instead of
316 .I exportname
317 for ordinal-only exports.
318 .PP
319 .I functype
320 should be one of:
321 .RS
322 .TP
323 .B stdcall
324 for a normal Win32 function
325 .TP
326 .B pascal
327 for a normal Win16 function
328 .TP
329 .B cdecl
330 for a Win16 or Win32 function using the C calling convention
331 .TP
332 .B varargs
333 for a Win16 or Win32 function using the C calling convention with a
334 variable number of arguments
335 .TP
336 .B thiscall
337 for a Win32 function using the
338 .I thiscall
339 calling convention (first parameter in %ecx register on i386)
340 .RE
341 .PP
342 .I args
343 should be one or several of:
344 .RS
345 .TP
346 .B word
347 (16-bit unsigned value)
348 .TP
349 .B s_word
350 (16-bit signed word)
351 .TP
352 .B long
353 (pointer-sized integer value)
354 .TP
355 .B int64
356 (64-bit integer value)
357 .TP
358 .B int128
359 (128-bit integer value)
360 .TP
361 .B float
362 (32-bit floating point value)
363 .TP
364 .B double
365 (64-bit floating point value)
366 .TP
367 .B ptr
368 (linear pointer)
369 .TP
370 .B str
371 (linear pointer to a null-terminated ASCII string)
372 .TP
373 .B wstr
374 (linear pointer to a null-terminated Unicode string)
375 .TP
376 .B segptr
377 (segmented pointer)
378 .TP
379 .B segstr
380 (segmented pointer to a null-terminated ASCII string).
381 .HP
382 Note: The 16-bit and segmented pointer types are only valid for Win16
383 functions.
384 .RE
385 .PP
386 .I handler
387 is the name of the actual C function that will implement that entry
388 point in 32-bit mode. The handler can also be specified as
389 .IB dllname . function
390 to define a forwarded function (one whose implementation is in another
391 dll). If
392 .I handler
393 is not specified, it is assumed to be identical to
394 .I exportname.
395 .PP
396 This first example defines an entry point for the 32-bit GetFocus()
397 call:
398 .IP
399 @ stdcall GetFocus() GetFocus
400 .PP
401 This second example defines an entry point for the 16-bit
402 CreateWindow() call (the ordinal 100 is just an example); it also
403 shows how long lines can be split using a backslash:
404 .IP
405 100 pascal CreateWindow(ptr ptr long s_word s_word s_word \\
406 s_word word word word ptr) WIN_CreateWindow
407 .PP
408 To declare a function using a variable number of arguments, specify
409 the function as
410 .B varargs
411 and declare it in the C file with a '...' parameter for a Win32
412 function, or with an extra VA_LIST16 argument for a Win16 function.
413 See the wsprintf* functions in user.exe.spec and user32.spec for an
414 example.
415 .SS "Variable ordinals"
416 Syntax:
417 .br
418 .IB ordinal\ variable
419 .RI [ flags ]\ exportname \ \fB(\fR\ [ data... ] \ \fB)
420 .PP
421 This declaration defines data storage as 32-bit words at the ordinal
422 specified.
423 .I exportname
424 will be the name available for dynamic
425 linking.
426 .I data
427 can be a decimal number or a hex number preceded by "0x". The
428 following example defines the variable VariableA at ordinal 2 and
429 containing 4 ints:
430 .IP
431 2 variable VariableA(-1 0xff 0 0)
432 .PP
433 This declaration only works in Win16 spec files. In Win32 you should
434 use
435 .B extern
436 instead (see below).
437 .SS "Extern ordinals"
438 Syntax:
439 .br
440 .IB ordinal\ extern
441 .RI [ flags ]\ exportname \ [ symbolname ]
442 .PP
443 This declaration defines an entry that simply maps to a C symbol
444 (variable or function). It only works in Win32 spec files.
445 .I exportname
446 will point to the symbol
447 .I symbolname
448 that must be defined in the C code. Alternatively, it can be of the
449 form
450 .IB dllname . symbolname
451 to define a forwarded symbol (one whose implementation is in another
452 dll). If
453 .I symbolname
454 is not specified, it is assumed to be identical to
455 .I exportname.
456 .SS "Stub ordinals"
457 Syntax:
458 .br
459 .IB ordinal\ stub
460 .RI [ flags ]\ exportname \ [\ \fB( args... \fB)\fR\ ]
461 .PP
462 This declaration defines a stub function. It makes the name and
463 ordinal available for dynamic linking, but will terminate execution
464 with an error message if the function is ever called.
465 .SS "Equate ordinals"
466 Syntax:
467 .br
468 .IB ordinal\ equate
469 .RI [ flags ]\ exportname\ data
470 .PP
471 This declaration defines an ordinal as an absolute value.
472 .I exportname
473 will be the name available for dynamic linking.
474 .I data
475 can be a decimal number or a hex number preceded by "0x".
476 .SH AUTHORS
477 .B winebuild
478 has been worked on by many people over the years. The main authors are
479 Robert J. Amstadt, Alexandre Julliard, Martin von Loewis, Ulrich
480 Weigand and Eric Youngdale. Many other Wine developers have
481 contributed, please check the file Changelog in the Wine distribution
482 for the complete details.
483 .SH BUGS
484 It is not yet possible to use a PE-format dll in an import
485 specification; only Wine dlls can be imported.
486 .PP
487 If you find a bug, please submit a bug report at
488 .UR http://bugs.winehq.org
489 .B http://bugs.winehq.org.
490 .UE
491 .SH AVAILABILITY
492 .B winebuild
493 is part of the wine distribution, which is available through WineHQ,
494 the
495 .B wine
496 development headquarters, at
497 .UR http://www.winehq.org/
498 .B http://www.winehq.org/.
499 .UE
500 .SH "SEE ALSO"
501 .BR wine (1),
502 .BR winegcc (1),
503 .BR wrc (1).