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