winebuild.man.in 15 KB
Newer Older
1
.TH WINEBUILD 1 "October 2005" "@PACKAGE_STRING@" "Wine Developers Manual"
2 3 4
.SH NAME
winebuild \- Wine dll builder
.SH SYNOPSIS
5 6
.B winebuild
.RI [ options ]\ [ inputfile ...]
7 8
.SH DESCRIPTION
.B winebuild
9 10
generates the assembly files that are necessary to build a Wine dll,
which is basically a Win32 dll encapsulated inside a Unix library.
11 12 13 14 15 16 17 18 19 20
.PP
.B winebuild
has different modes, depending on what kind of file it is asked to
generate. The mode is specified by one of the mode options specified
below. In addition to the mode option, various other command-line
option can be specified, as described in the \fBOPTIONS\fR section.
.SH "MODE OPTIONS"
You have to specify exactly one of the following options, depending on
what you want winebuild to generate.
.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 \fB-E\fR option. The resulting file must be
25 26
assembled and linked to the other object files to build a working Wine
dll.  In this mode, the
27 28 29 30 31 32
.I input files
should be the list of all object files that will be linked into the
final dll, to allow
.B winebuild
to get the list of all undefined symbols that need to be imported from
other dlls.
33
.TP
34
.BI \--exe
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 38
since an executable need not export functions. Some executables however
do export functions, and for those a .spec/.def file can be specified via
39 40
the \fB-E\fR option. The executable is named from the .spec/.def file name if
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
43 44
.I input files.
.TP
45 46
.BI \--def
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.
48
.TP
49
.BI \--implib
50
Build a .a import library from a spec file. The .spec file is
51
specified via the \fB-E\fR option.
52
.TP
53 54 55 56 57 58
.B \--resources
Generate a .o file containing all the input resources. This is useful
when building with a PE compiler, since the PE binutils cannot handle
multiple resource files as input. For a standard Unix build, the
resource files are automatically included when building the spec file,
so there's no need for an intermediate .o file.
59 60
.SH OPTIONS
.TP
61 62 63 64
.BI \--as-cmd= as-command
Specify the command to use to compile assembly files; the default is
\fBas\fR.
.TP
65
.BI \-b,\ --target= cpu-manufacturer\fR[\fB-\fIkernel\fR]\fB-\fIos
66 67 68 69
Specify the target CPU and platform on which the generated code will
be built. The target specification is in the standard autoconf format
as returned by config.sub.
.TP
70 71 72 73
.BI \--cc-cmd= cc-command
Specify the C compiler to use to compile assembly files; the default
is to instead use the assembler specified with \fB--as-cmd\fR.
.TP
74 75 76 77 78 79
.BI \-d,\ --delay-lib= name
Set the delayed import mode for the specified library, which must be
one of the libraries imported with the \fB-l\fR option. Delayed mode
means that the library won't be loaded until a function imported from
it is actually called.
.TP
80 81 82
.BI \-D\  symbol
Ignored for compatibility with the C compiler.
.TP
83
.BI \-e,\ --entry= function
84 85 86 87
Specify the module entry point function; if not specified, the default
is
.B DllMain
for dlls, and
88
.B main
89 90 91 92
for executables (if the standard C
.B main
is not defined,
.B WinMain
93
is used instead). This is only valid for Win32 modules.
94
.TP
95 96 97 98 99
.BI \-E,\ --export= filename
Specify a .spec file (see \fBSPEC FILE SYNTAX\fR for details), 
or a standard Windows .def file that defines the exports
of the DLL or executable that is being built.
.TP
100 101 102 103 104 105 106 107
.B \--external-symbols
Allow linking to external symbols directly from the spec
file. Normally symbols exported by a dll have to be defined in the dll
itself; this option makes it possible to use symbols defined in
another Unix library (for symbols defined in another dll, a
.I forward
specification must be used instead).
.TP
108 109 110 111
.BI \-f\  option
Specify a code generation option. Currently \fB\-fPIC\fR and
\fB\-fasynchronous-unwind-tables\fR are supported. Other options are
ignored for compatibility with the C compiler.
112
.TP
113 114 115 116 117
.B \--fake-module
Create a fake PE module for a dll or exe, instead of the normal
assembly or object file. The PE module contains the resources for the
module, but no executable code.
.TP
118
.BI \-F,\ --filename= filename
119 120 121
Set the file name of the module. The default is to use the base name
of the spec file (without any extension).
.TP
122
.B \-h, --help
123 124
Display a usage message and exit.
.TP
125
.BI \-H,\ --heap= size
126 127 128
Specify the size of the module local heap in bytes (only valid for
Win16 modules); default is no local heap.
.TP
129
.BI \-I\  directory
130 131
Ignored for compatibility with the C compiler.
.TP
132
.B \-k, --kill-at
133 134 135
Remove the stdcall decorations from the symbol names in the
generated .def file. Only meaningful in \fB--def\fR mode.
.TP
136 137 138
.BI \-K\  flags
Ignored for compatibility with the C compiler.
.TP
139 140 141 142
.BI \--large-address-aware
Set a flag in the executable to notify the loader that this
application supports address spaces larger than 2 gigabytes.
.TP
143 144 145 146
.BI \--ld-cmd= ld-command
Specify the command to use to link the object files; the default is
\fBld\fR.
.TP
147
.BI \-L,\ --library-path= directory
148 149 150
Append the specified directory to the list of directories that are
searched for import libraries.
.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 155
option.
.TP
156
.B \-m16, -m32, -m64
157
Generate respectively 16-bit, 32-bit or 64-bit code.
158
.TP
159
.BI \-marm,\ \-mthumb,\ \-march= option ,\ \-mcpu= option
160 161
Set code generation options for the assembler.
.TP
162
.BI \-M,\ --main-module= module
163 164 165
When building a 16-bit dll, set the name of its 32-bit counterpart to
\fImodule\fR. This is used to enforce that the load order for the
16-bit dll matches that of the 32-bit one.
166
.TP
167
.BI \-N,\ --dll-name= dllname
168 169 170 171 172
Set the internal name of the module. It is only used in Win16
modules. The default is to use the base name of the spec file (without
any extension). This is used for KERNEL, since it lives in
KRNL386.EXE. It shouldn't be needed otherwise.
.TP
173 174 175 176
.BI \--nm-cmd= nm-command
Specify the command to use to get the list of undefined symbols; the
default is \fBnm\fR.
.TP
177
.BI --nxcompat= yes\fR|\fIno
178 179 180
Specify whether the module is compatible with no-exec support. The
default is yes.
.TP
181
.BI \-o,\ --output= file
182
Set the name of the output file (default is standard output). If the
183
output file name ends in .o, the text output is sent to a
184 185
temporary file that is then assembled to produce the specified .o
file.
186
.TP
187
.BI \-r,\ --res= rsrc.res
188
Load resources from the specified binary resource file. The
189
\fIrsrc.res\fR file can be produced from a source resource file with
190
.BR wrc (1)
191
(or with a Windows resource compiler).
192 193 194 195 196 197 198
.br
This option is only necessary for Win16 resource files, the Win32 ones
can simply listed as
.I input files
and will automatically be handled correctly (though the
.B \-r
option will also work for Win32 files).
199
.TP
200 201 202
.B --save-temps
Do not delete the various temporary files that \fBwinebuild\fR generates.
.TP
203
.BI --subsystem= subsystem\fR[\fB:\fImajor\fR[\fB.\fIminor\fR]]
204 205 206 207 208 209 210 211 212
Set the subsystem of the executable, which can be one of the following:
.br
.B console
for a command line executable,
.br
.B windows
for a graphical executable,
.br
.B native
213 214 215 216
for a native-mode dll,
.br
.B wince
for a ce dll.
217 218 219 220 221 222 223 224 225
.br
The entry point of a command line executable is a normal C \fBmain\fR
function. A \fBwmain\fR function can be used instead if you need the
argument array to use Unicode strings. A graphical executable has a
\fBWinMain\fR entry point.
.br
Optionally a major and minor subsystem version can also be specified;
the default subsystem version is 4.0.
.TP
226 227 228 229 230
.BI \-u,\ --undefined= symbol
Add \fIsymbol\fR to the list of undefined symbols when invoking the
linker. This makes it possible to force a specific module of a static
library to be included when resolving imports.
.TP
231 232
.B \-v, --verbose
Display the various subcommands being invoked by
233
.BR winebuild .
234
.TP
235 236 237 238
.B \--version
Display the program version and exit.
.TP
.B \-w, --warnings
239 240 241
Turn on warnings.
.SH "SPEC FILE SYNTAX"
.SS "General syntax"
242 243
A spec file should contain a list of ordinal declarations. The general
syntax is the following:
244 245
.PP
.I ordinal functype
246
.RI [ flags ]\  exportname \ \fB(\fR\ [ args... ] \ \fB) \ [ handler ]
247 248 249 250
.br
.IB ordinal\  variable
.RI [ flags ]\  exportname \ \fB(\fR\ [ data... ] \ \fB)
.br
251
.IB ordinal\  extern
252
.RI [ flags ]\  exportname \ [ symbolname ]
253
.br
254
.IB ordinal\  stub
255
.RI [ flags ]\  exportname \ [\ \fB( args... \fB)\fR\ ]
256 257 258 259
.br
.IB ordinal\  equate
.RI [ flags ]\  exportname\ data
.br
260
.BI #\  comments
261
.PP
262 263
Declarations must fit on a single line, except if the end of line is
escaped using a backslash character. The
264
.B #
265 266
character anywhere in a line causes the rest of the line to be ignored
as a comment.
267
.PP
268 269 270 271 272 273 274 275 276 277 278 279 280 281
.I ordinal
specifies the ordinal number corresponding to the entry point, or '@'
for automatic ordinal allocation (Win32 only).
.PP
.I flags
is a series of optional flags, preceded by a '-' character. The
supported flags are:
.RS
.TP
.B -norelay
The entry point is not displayed in relay debugging traces (Win32
only).
.TP
.B -noname
282 283
The entry point will be exported by ordinal instead of by name. The
name is still available for importing.
284
.TP
285 286 287
.B -ret16
The function returns a 16-bit value (Win16 only).
.TP
288 289 290 291
.B -ret64
The function returns a 64-bit value (Win32 only).
.TP
.B -register
292
The function uses CPU register to pass arguments.
293
.TP
294 295 296
.B -private
The function cannot be imported from other dlls, it can only be
accessed through GetProcAddress.
297 298 299 300
.TP
.B -ordinal
The entry point will be imported by ordinal instead of by name. The
name is still exported.
301
.TP
302
.BI -arch= cpu\fR[\fB,\fIcpu\fR]
303 304
The entry point is only available on the specified CPU
architecture(s). The names \fBwin32\fR and \fBwin64\fR match all
305
32-bit or 64-bit CPU architectures respectively. In 16-bit dlls,
306 307
specifying \fB-arch=win32\fR causes the entry point to be exported
from the 32-bit wrapper module.
308 309 310 311
.SS "Function ordinals"
Syntax:
.br
.I ordinal functype
312
.RI [ flags ]\  exportname \ \fB(\fR\ [ args... ] \ \fB) \ [ handler ]
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
.br

This declaration defines a function entry point.  The prototype defined by
.IR exportname \ \fB(\fR\ [ args... ] \ \fB)
specifies the name available for dynamic linking and the format of the
arguments. '@' can be used instead of
.I exportname
for ordinal-only exports.
.PP
.I functype
should be one of:
.RS
.TP
.B stdcall
for a normal Win32 function
.TP
329 330 331
.B pascal
for a normal Win16 function
.TP
332
.B cdecl
333
for a Win16 or Win32 function using the C calling convention
334 335
.TP
.B varargs
336 337
for a Win16 or Win32 function using the C calling convention with a
variable number of arguments
338 339 340 341 342
.TP
.B thiscall
for a Win32 function using the
.I thiscall
calling convention (first parameter in %ecx register on i386)
343 344 345 346 347 348 349 350 351 352 353 354 355
.RE
.PP
.I args
should be one or several of:
.RS
.TP
.B word
(16-bit unsigned value)
.TP
.B s_word
(16-bit signed word)
.TP
.B long
356 357 358 359 360 361 362 363 364 365
(pointer-sized integer value)
.TP
.B int64
(64-bit integer value)
.TP
.B int128
(128-bit integer value)
.TP
.B float
(32-bit floating point value)
366 367
.TP
.B double
368
(64-bit floating point value)
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
.TP
.B ptr
(linear pointer)
.TP
.B str
(linear pointer to a null-terminated ASCII string)
.TP
.B wstr
(linear pointer to a null-terminated Unicode string)
.TP
.B segptr
(segmented pointer)
.TP
.B segstr
(segmented pointer to a null-terminated ASCII string).
.HP
385 386
Note: The 16-bit and segmented pointer types are only valid for Win16
functions.
387 388 389 390
.RE
.PP
.I handler
is the name of the actual C function that will implement that entry
391 392 393
point in 32-bit mode. The handler can also be specified as
.IB dllname . function
to define a forwarded function (one whose implementation is in another
394 395 396 397
dll). If
.I handler
is not specified, it is assumed to be identical to
.I exportname.
398
.PP
399
This first example defines an entry point for the 32-bit GetFocus()
400 401 402 403
call:
.IP
@ stdcall GetFocus() GetFocus
.PP
404 405 406 407 408 409 410
This second example defines an entry point for the 16-bit
CreateWindow() call (the ordinal 100 is just an example); it also
shows how long lines can be split using a backslash:
.IP
100 pascal CreateWindow(ptr ptr long s_word s_word s_word \\
    s_word word word word ptr) WIN_CreateWindow
.PP
411 412
To declare a function using a variable number of arguments, specify
the function as
413
.B varargs
414 415 416 417
and declare it in the C file with a '...' parameter for a Win32
function, or with an extra VA_LIST16 argument for a Win16 function.
See the wsprintf* functions in user.exe.spec and user32.spec for an
example.
418 419 420 421 422 423 424 425 426 427 428 429
.SS "Variable ordinals"
Syntax:
.br
.IB ordinal\  variable
.RI [ flags ]\  exportname \ \fB(\fR\ [ data... ] \ \fB)
.PP
This declaration defines data storage as 32-bit words at the ordinal
specified.
.I exportname
will be the name available for dynamic
linking.
.I data
430
can be a decimal number or a hex number preceded by "0x".  The
431 432 433 434
following example defines the variable VariableA at ordinal 2 and
containing 4 ints:
.IP
2 variable VariableA(-1 0xff 0 0)
435 436 437 438 439 440 441 442 443
.PP
This declaration only works in Win16 spec files. In Win32 you should
use
.B extern
instead (see below).
.SS "Extern ordinals"
Syntax:
.br
.IB ordinal\  extern
444
.RI [ flags ]\  exportname \ [ symbolname ]
445 446 447 448 449 450 451 452 453 454
.PP
This declaration defines an entry that simply maps to a C symbol
(variable or function). It only works in Win32 spec files.
.I exportname
will point to the symbol
.I symbolname
that must be defined in the C code. Alternatively, it can be of the
form
.IB dllname . symbolname
to define a forwarded symbol (one whose implementation is in another
455 456 457 458
dll). If
.I symbolname
is not specified, it is assumed to be identical to
.I exportname.
459 460 461 462
.SS "Stub ordinals"
Syntax:
.br
.IB ordinal\  stub
463
.RI [ flags ]\  exportname \ [\ \fB( args... \fB)\fR\ ]
464 465 466 467 468 469 470 471 472 473 474 475 476 477
.PP
This declaration defines a stub function. It makes the name and
ordinal available for dynamic linking, but will terminate execution
with an error message if the function is ever called.
.SS "Equate ordinals"
Syntax:
.br
.IB ordinal\  equate
.RI [ flags ]\  exportname\ data
.PP
This declaration defines an ordinal as an absolute value.
.I exportname
will be the name available for dynamic linking.
.I data
478
can be a decimal number or a hex number preceded by "0x".
479 480 481 482
.SH AUTHORS
.B winebuild
has been worked on by many people over the years. The main authors are
Robert J. Amstadt, Alexandre Julliard, Martin von Loewis, Ulrich
483 484
Weigand and Eric Youngdale. Many other people have contributed new features
and bug fixes. For a complete list, see the git commit logs.
485 486 487 488
.SH BUGS
It is not yet possible to use a PE-format dll in an import
specification; only Wine dlls can be imported.
.PP
489
Bugs can be reported on the
490
.UR http://bugs.winehq.org
491 492
.B Wine bug tracker
.UE .
493 494
.SH AVAILABILITY
.B winebuild
495
is part of the Wine distribution, which is available through WineHQ,
496
the
497
.UR http://www.winehq.org/
498 499
.B Wine development headquarters
.UE .
500 501
.SH "SEE ALSO"
.BR wine (1),
502
.BR winegcc (1),
503 504 505 506 507
.BR wrc (1),
.br
.UR http://www.winehq.org/help
.B Wine documentation and support
.UE .