git.oblomov.eu Git - wine/blob - tools/winebuild/winebuild.man.in

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