1 .TH WINEDUMP 1 "February 2004" "Wine Manpage" "Wine Developers Manual"
3 winedump \- A Wine DLL tool
5 .BR "winedump " [ "-h " "| "
11 .RI "] [" "mode_options" ]
14 is a Wine tool which aims to help:
16 A: Reimplementing a Win32 DLL for use within Wine, or
18 B: Compiling a Win32 application with Winelib that uses x86 DLL's
20 For both tasks in order to be able to link to the Win functions some
21 glue code is needed. This 'glue' comes in the form of a \fI.spec\fR file.
22 The \fI.spec\fR file, along with some dummy code, is used to create a
23 Wine .so corresponding to the Windows DLL. The \fBwinebuild\fR program
24 can then resolve calls made to DLL functions.
26 Creating a \fI.spec\fR file is a labour intensive task during which it is
27 easy to make a mistake. The idea of \fBwinedump\fR is to automate this task
28 and create the majority of the support code needed for your DLL. In
29 addition you can have \fBwinedump\fR create code to help you re-implement a
30 DLL, by providing tracing of calls to the DLL, and (in some cases)
31 automatically determining the parameters, calling conventions, and
32 return values of the DLL's functions.
34 Another use for this tool is to display (dump) information about a 32bit
35 DLL or PE format image file. When used in this way \fBwinedump\fR functions
36 similarly to tools such as pedump provided by many Win32 compiler
39 Finally \fBwinedump\fR can be also used to demangle C++ symbols.
42 can be used in several different modes. The first argument to the
43 program determines the mode winedump will run in.
46 Basic usage help is printed.
48 To dump the contents of a PE file.
50 For generating .spec files and stub DLL's.
53 Used to demangle C++ symbols.
55 Mode options depend on the mode given as the first argument.
60 The program prints the help info and than exits.
64 Dumps the content of the dll named \fI<dll>\fR.
66 Turns on symbol demangling.
68 Dumps file header information.
69 This option dumps only the standard PE header structures,
70 along with the COFF sections available in the file.
71 .IP "\fB-j \fIsect_name\fR"
72 Dumps only the content of section sect_name (import,
74 To dump only a given directory, specify them using this
75 option. Currently only the import, export and debug
76 directories are implemented.
79 This command prints all available information about the
80 file. You may wish to pipe the output through more/less or
81 into a file, since a lot of output will be produced.
85 Use dll for input file and generate implementation code.
87 Look for prototypes in '\fIdir\fR' (implies \fB-c\fR). In the case of
88 Windows DLL's, this could be either the standard include
89 directory from your compiler, or a SDK include directory.
90 If you have a text document with prototypes (such as
91 documentation) that can be used also, however you may need
92 to delete some non-code lines to ensure that prototypes are
94 The '\fIdir\fR' argument can also be a file specification (e.g.
95 "include/*"). If it contains wildcards you must quote it to
96 prevent the shell from expanding it.
97 If you have no prototypes, specify /dev/null for '\fIdir\fR'.
98 Winedump may still be able to generate some working stub
101 Generate skeleton code (requires \fB-I\fR).
102 This option tells winedump to create function stubs for each
103 function in the DLL. As winedump reads each exported symbol
104 from the source DLL, it first tries to demangle the name. If
105 the name is a C++ symbol, the arguments, class and return
106 value are all encoded into the symbol name. Winedump
107 converts this information into a C function prototype. If
108 this fails, the file(s) specified in the \fB-I\fR argument are
109 scanned for a function prototype. If one is found it is used
110 for the next step of the process, code generation.
112 TRACE arguments (implies \fB-c\fR).
113 This option produces the same code as \fB-c\fR, except that
114 arguments are printed out when the function is called.
115 Structs that are passed by value are printed as "struct",
116 and functions that take variable argument lists print "...".
117 .IP "\fB-f \fIdll\fR"
118 Forward calls to '\fIdll\fR' (implies \fB-t\fR).
119 This is the most complicated level of code generation. The
120 same code is generated as \fB-t\fR, however support is added for
121 forwarding calls to another DLL. The DLL to forward to is
122 given as '\fIdll\fR'.
124 Generate documentation.
125 By default, winedump generates a standard comment at the
126 header of each function it generates. Passing this option
127 makes winedump output a full header template for standard
128 Wine documentation, listing the parameters and return value
130 .IP "\fB-o \fIname\fR"
131 Set the output dll name (default: \fIdll\fR).
132 By default, if winedump is run on DLL 'foo', it creates
133 files 'foo.spec', 'foo_main.c' etc, and prefixes any
134 functions generated with 'FOO_'. If '-o bar' is given,
135 these will become 'bar.spec', 'bar_main.c' and 'BAR_'
137 This option is mostly useful when generating a forwarding DLL.
139 Assume __cdecl calls (default: __stdcall).
140 If winebuild cannot determine the calling convention,
141 __stdcall is used by default, unless this option has
143 Unless \fB-q\fR is given, a warning will be printed for every
144 function that winedump determines the calling convention
145 for and which does not match the assumed calling convention.
146 .IP "\fB-s \fInum\fR"
147 Start prototype search after symbol '\fInum\fR'.
148 .IP "\fB-e \fInum\fR"
149 End prototype search after symbol '\fInum\fR'.
150 By passing the \fB-s\fR or \fB-e\fR options you can have winedump try to
151 generate code for only some functions in your DLL. This may
152 be used to generate a single function, for example, if you
153 wanted to add functionality to an existing DLL.
154 .IP "\fB-S \fIsymfile\fR"
155 Search only prototype names found in '\fIsymfile\fR'.
156 If you want to only generate code for a subset of exported
157 functions from your source DLL, you can use this option to
158 provide a text file containing the names of the symbols to
159 extract, one per line. Only the symbols present in this file
160 will be used in your output DLL.
162 Don't show progress (quiet).
163 No output is printed unless a fatal error is encountered.
165 Show lots of detail while working (verbose).
166 There are 3 levels of output while winedump is running. The
167 default level, when neither -q or -v are given, prints the
168 number of exported functions found in the dll, followed by
169 the name of each function as it is processed, and a status
170 indication of whether it was processed OK. With -v given, a
171 lot of information is dumped while winedump works: this is
172 intended to help debug any problems.
176 Demangles C++ symbol '\fI<sym>\fR' and then exits.
180 Perl script used to retrieve a function prototype.
190 This is the .spec file.
196 These are the source code files containing the minimum set
197 of code to build a stub DLL. The C file contains one
198 function, FOO_Init, which does nothing (but must be
203 This is a template for 'configure' to produce a makefile. It
204 is designed for a DLL that will be inserted into the Wine
209 A shell script for adding
211 to the Wine source tree.
213 C++ name demangling is currently under development. Since the
214 algorithm used is not documented, it must be decoded. Many simple
215 prototypes are already working however.
217 Jon P. Griffiths <jon_p_griffiths at yahoo dot com>
219 Michael Stefaniuc <mstefani at redhat dot com>
221 .BR winedump "'s README file"
223 The Winelib User Guide
225 The Wine Developers Guide
projects / wine / blob