| blob | 2b0f0b72917127ef544608f8a7ac6dfbe1163edf |
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,\ --ignore= [-]symbol[,[-]symbol]
126 Specify a list of symbols that should be ignored when resolving
127 undefined symbols against the imported libraries. This forces these
128 symbols to be resolved from the Unix C library (or from another Unix
129 library linked with the application). If a symbol is prefixed by '-'
130 it is removed from the list instead of being added; a stand-alone '-'
131 clears the whole list.
132 .TP
133 .BI \-I\ directory
134 Ignored for compatibility with the C compiler.
135 .TP
136 .B \-k, --kill-at
137 Remove the stdcall decorations from the symbol names in the
138 generated .def file. Only meaningful in \fB--def\fR mode.
139 .TP
140 .BI \-K\ flags
141 Ignored for compatibility with the C compiler.
142 .TP
143 .BI \--large-address-aware
144 Set a flag in the executable to notify the loader that this
145 application supports address spaces larger than 2 gigabytes.
146 .TP
147 .BI \--ld-cmd= ld-command
148 Specify the command to use to link the object files; the default is
149 \fBld\fR.
150 .TP
151 .BI \-L,\ --library-path= directory
152 Append the specified directory to the list of directories that are
153 searched for import libraries.
154 .TP
155 .BI \-l,\ --library= name
156 Import the specified library, looking for a corresponding
157 \fIlibname.def\fR file in the directories specified with the \fB-L\fR
158 option.
159 .TP
160 .B \-m32, -m64
161 Generate 32-bit, respectively 64-bit code.
162 .TP
163 .BI \-M,\ --main-module= module
164 When building a 16-bit dll, set the name of its 32-bit counterpart to
165 \fImodule\fR. This is used to enforce that the load order for the
166 16-bit dll matches that of the 32-bit one.
167 .TP
168 .BI \-N,\ --dll-name= dllname
169 Set the internal name of the module. It is only used in Win16
170 modules. The default is to use the base name of the spec file (without
171 any extension). This is used for KERNEL, since it lives in
172 KRNL386.EXE. It shouldn't be needed otherwise.
173 .TP
174 .BI \--nm-cmd= nm-command
175 Specify the command to use to get the list of undefined symbols; the
176 default is \fBnm\fR.
177 .TP
178 .BI --nxcompat= yes|no
179 Specify whether the module is compatible with no-exec support. The
180 default is yes.
181 .TP
182 .BI \-o,\ --output= file
183 Set the name of the output file (default is standard output). If the
184 output file name end in \fB.o\fR, the text output is sent to a
185 temporary file that is then assembled to produce the specified .o
186 file.
187 .TP
188 .BI \-r,\ --res= rsrc.res
189 Load resources from the specified binary resource file. The
190 \fIrsrc.res\fR file can be produced from a source resource file with
191 .BR wrc(1)
192 (or with a Windows resource compiler).
193 .br
194 This option is only necessary for Win16 resource files, the Win32 ones
195 can simply listed as
196 .I input files
197 and will automatically be handled correctly (though the
198 .B \-r
199 option will also work for Win32 files).
200 .TP
201 .B --save-temps
202 Do not delete the various temporary files that \fBwinebuild\fR generates.
203 .TP
204 .BI --subsystem= subsystem[:major[.minor]]
205 Set the subsystem of the executable, which can be one of the following:
206 .br
207 .B console
208 for a command line executable,
209 .br
210 .B windows
211 for a graphical executable,
212 .br
213 .B native
214 for a native-mode dll,
215 .br
216 .B win16
217 for a 16-bit module.
218 .br
219 The entry point of a command line executable is a normal C \fBmain\fR
220 function. A \fBwmain\fR function can be used instead if you need the
221 argument array to use Unicode strings. A graphical executable has a
222 \fBWinMain\fR entry point.
223 .br
224 Optionally a major and minor subsystem version can also be specified;
225 the default subsystem version is 4.0.
226 .TP
227 .BI \-u,\ --undefined= symbol
228 Add \fIsymbol\fR to the list of undefined symbols when invoking the
229 linker. This makes it possible to force a specific module of a static
230 library to be included when resolving imports.
231 .TP
232 .B \-v, --verbose
233 Display the various subcommands being invoked by
234 .B winebuild.
235 .TP
236 .B \--version
237 Display the program version and exit.
238 .TP
239 .B \-w, --warnings
240 Turn on warnings.
241 .SH "SPEC FILE SYNTAX"
242 .SS "General syntax"
243 A spec file should contain a list of ordinal declarations. The general
244 syntax is the following:
245 .PP
246 .I ordinal functype
247 .RI [ flags ]\ exportname \ \fB(\fR\ [ args... ] \ \fB) \ [ handler ]
248 .br
249 .IB ordinal\ variable
250 .RI [ flags ]\ exportname \ \fB(\fR\ [ data... ] \ \fB)
251 .br
252 .IB ordinal\ extern
253 .RI [ flags ]\ exportname \ [ symbolname ]
254 .br
255 .IB ordinal\ stub
256 .RI [ flags ]\ exportname
257 .br
258 .IB ordinal\ equate
259 .RI [ flags ]\ exportname\ data
260 .br
261 .BI #\ comments
262 .PP
263 Declarations must fit on a single line, except if the end of line is
264 escaped using a backslash character. The
265 .B #
266 character anywhere in a line causes the rest of the line to be ignored
267 as a comment.
268 .PP
269 .I ordinal
270 specifies the ordinal number corresponding to the entry point, or '@'
271 for automatic ordinal allocation (Win32 only).
272 .PP
273 .I flags
274 is a series of optional flags, preceded by a '-' character. The
275 supported flags are:
276 .RS
277 .TP
278 .B -norelay
279 The entry point is not displayed in relay debugging traces (Win32
280 only).
281 .TP
282 .B -noname
283 The entry point will be exported by ordinal instead of by name. The
284 name is still available for importing.
285 .TP
286 .B -ret16
287 The function returns a 16-bit value (Win16 only).
288 .TP
289 .B -ret64
290 The function returns a 64-bit value (Win32 only).
291 .TP
292 .B -register
293 The function uses CPU register to pass arguments.
294 .TP
295 .B -private
296 The function cannot be imported from other dlls, it can only be
297 accessed through GetProcAddress.
298 .TP
299 .B -ordinal
300 The entry point will be imported by ordinal instead of by name. The
301 name is still exported.
302 .TP
303 .BI -arch= cpu[,cpu]
304 The entry point is only available on the specified CPU
305 architecture(s). The names \fBwin32\fR and \fBwin64\fR match all
306 32-bit, respectively 64-bit, CPU architectures. In 16-bit dlls,
307 specifying \fB-arch=win32\fR causes the entry point to be exported
308 from the 32-bit wrapper module.
309 .SS "Function ordinals"
310 Syntax:
311 .br
312 .I ordinal functype
313 .RI [ flags ]\ exportname \ \fB(\fR\ [ args... ] \ \fB) \ [ handler ]
314 .br
316 This declaration defines a function entry point. The prototype defined by
317 .IR exportname \ \fB(\fR\ [ args... ] \ \fB)
318 specifies the name available for dynamic linking and the format of the
319 arguments. '@' can be used instead of
320 .I exportname
321 for ordinal-only exports.
322 .PP
323 .I functype
324 should be one of:
325 .RS
326 .TP
327 .B stdcall
328 for a normal Win32 function
329 .TP
330 .B pascal
331 for a normal Win16 function
332 .TP
333 .B cdecl
334 for a Win16 or Win32 function using the C calling convention
335 .TP
336 .B varargs
337 for a Win16 or Win32 function using the C calling convention with a
338 variable number of arguments
339 .RE
340 .PP
341 .I args
342 should be one or several of:
343 .RS
344 .TP
345 .B word
346 (16-bit unsigned value)
347 .TP
348 .B s_word
349 (16-bit signed word)
350 .TP
351 .B long
352 (32-bit value)
353 .TP
354 .B double
355 (64-bit value)
356 .TP
357 .B ptr
358 (linear pointer)
359 .TP
360 .B str
361 (linear pointer to a null-terminated ASCII string)
362 .TP
363 .B wstr
364 (linear pointer to a null-terminated Unicode string)
365 .TP
366 .B segptr
367 (segmented pointer)
368 .TP
369 .B segstr
370 (segmented pointer to a null-terminated ASCII string).
371 .HP
372 .RB Only\ ptr ,\ str ,\ wstr ,\ long\ and\ double
373 are valid for Win32 functions.
374 .RE
375 .PP
376 .I handler
377 is the name of the actual C function that will implement that entry
378 point in 32-bit mode. The handler can also be specified as
379 .IB dllname . function
380 to define a forwarded function (one whose implementation is in another
381 dll). If
382 .I handler
383 is not specified, it is assumed to be identical to
384 .I exportname.
385 .PP
386 This first example defines an entry point for the 32-bit GetFocus()
387 call:
388 .IP
389 @ stdcall GetFocus() GetFocus
390 .PP
391 This second example defines an entry point for the 16-bit
392 CreateWindow() call (the ordinal 100 is just an example); it also
393 shows how long lines can be split using a backslash:
394 .IP
395 100 pascal CreateWindow(ptr ptr long s_word s_word s_word \\
396 s_word word word word ptr) WIN_CreateWindow
397 .PP
398 To declare a function using a variable number of arguments, specify
399 the function as
400 .B varargs
401 and declare it in the C file with a '...' parameter for a Win32
402 function, or with an extra VA_LIST16 argument for a Win16 function.
403 See the wsprintf* functions in user.exe.spec and user32.spec for an
404 example.
405 .SS "Variable ordinals"
406 Syntax:
407 .br
408 .IB ordinal\ variable
409 .RI [ flags ]\ exportname \ \fB(\fR\ [ data... ] \ \fB)
410 .PP
411 This declaration defines data storage as 32-bit words at the ordinal
412 specified.
413 .I exportname
414 will be the name available for dynamic
415 linking.
416 .I data
417 can be a decimal number or a hex number preceded by "0x". The
418 following example defines the variable VariableA at ordinal 2 and
419 containing 4 ints:
420 .IP
421 2 variable VariableA(-1 0xff 0 0)
422 .PP
423 This declaration only works in Win16 spec files. In Win32 you should
424 use
425 .B extern
426 instead (see below).
427 .SS "Extern ordinals"
428 Syntax:
429 .br
430 .IB ordinal\ extern
431 .RI [ flags ]\ exportname \ [ symbolname ]
432 .PP
433 This declaration defines an entry that simply maps to a C symbol
434 (variable or function). It only works in Win32 spec files.
435 .I exportname
436 will point to the symbol
437 .I symbolname
438 that must be defined in the C code. Alternatively, it can be of the
439 form
440 .IB dllname . symbolname
441 to define a forwarded symbol (one whose implementation is in another
442 dll). If
443 .I symbolname
444 is not specified, it is assumed to be identical to
445 .I exportname.
446 .SS "Stub ordinals"
447 Syntax:
448 .br
449 .IB ordinal\ stub
450 .RI [ flags ]\ exportname
451 .PP
452 This declaration defines a stub function. It makes the name and
453 ordinal available for dynamic linking, but will terminate execution
454 with an error message if the function is ever called.
455 .SS "Equate ordinals"
456 Syntax:
457 .br
458 .IB ordinal\ equate
459 .RI [ flags ]\ exportname\ data
460 .PP
461 This declaration defines an ordinal as an absolute value.
462 .I exportname
463 will be the name available for dynamic linking.
464 .I data
465 can be a decimal number or a hex number preceded by "0x".
466 .SH AUTHORS
467 .B winebuild
468 has been worked on by many people over the years. The main authors are
469 Robert J. Amstadt, Alexandre Julliard, Martin von Loewis, Ulrich
470 Weigand and Eric Youngdale. Many other Wine developers have
471 contributed, please check the file Changelog in the Wine distribution
472 for the complete details.
473 .SH BUGS
474 It is not yet possible to use a PE-format dll in an import
475 specification; only Wine dlls can be imported.
476 .PP
477 If you find a bug, please submit a bug report at
478 .UR http://bugs.winehq.org
479 .B http://bugs.winehq.org.
480 .UE
481 .SH AVAILABILITY
482 .B winebuild
483 is part of the wine distribution, which is available through WineHQ,
484 the
485 .B wine
486 development headquarters, at
487 .UR http://www.winehq.org/
488 .B http://www.winehq.org/.
489 .UE
490 .SH "SEE ALSO"
491 .BR wine (1),
492 .BR winegcc (1),
493 .BR wrc (1).