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