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