winemaker.man.in 7.81 KB
Newer Older
1
.\" -*- nroff -*-
2
.TH WINEMAKER 1 "May 2009" "@PACKAGE_STRING@" "Wine Developers Manual"
3 4 5 6 7
.SH NAME
winemaker \- generate a build infrastructure for compiling Windows programs on Unix
.SH SYNOPSIS
.B "winemaker "
[
8
.IR               "--nobanner " "] [ " "--backup " "| " "--nobackup " "] [ "--nosource-fix "
9 10 11 12 13
]
.br
  [
.IR               "--lower-none " "| " "--lower-all " "| " "--lower-uppercase "
]
14 15
.br
  [
16
.IR               "--lower-include " "| " "--nolower-include " ] [ " "--mfc " "| " "--nomfc "
17
]
18 19
.br
  [
20
.IR               "--guiexe " "| " "--windows " "| " "--cuiexe " "| " "--console " "| " "--dll " "| " "--nodlls "
21 22 23
]
.br
  [
24
.IR               "-Dmacro[=defn] " "] [ " "-Idir " "] [ " "-Pdir " "] [ " "-idll" "] [ " "-Ldir " "] [ " "-llibrary "
25 26 27 28 29
]
.br
  [
.IR               "--interactive " "] [ " "--single-target name "
]
30 31
.br
  [
32
.IR               "--generated-files " "] [ " "--nogenerated-files " "] 
33 34 35 36
]
.br
  [
.IR               "--wine64 " "]
37 38
.br
.IR               "work_directory" "| " "project_file" "| " "workspace_file"
39 40 41 42

.SH DESCRIPTION
.PP
.B winemaker
43
is a perl script designed to help you bootstrap the
Francois Gouget's avatar
Francois Gouget committed
44
process of converting your Windows sources to Winelib programs.
45 46 47
.PP
In order to do this winemaker can perform the following operations:
.PP
48
- rename your source files and directories to lowercase in the event they
49 50 51 52
got all uppercased during the transfer.
.PP
- perform Dos to Unix (CRLF to LF) conversions.
.PP
53
- scan the include statements and resource file references to replace the
54 55
backslashes with forward slashes.
.PP
56 57
- during the above step winemaker will also perform a case insensitive search
of the referenced file in the include path and rewrite the include statement
58 59
with the right case if necessary.
.PP
60 61
- winemaker will also check other more exotic issues like '#pragma pack'
usage, use of "afxres.h" in non MFC projects, and more. Whenever it
62 63
encounters something out of the ordinary, winemaker will warn you about it.
.PP
64 65
- winemaker can also scan a complete directory tree at once, guess what are
the executables and libraries you are trying to build, match them with
66 67
source files, and generate the corresponding Makefile.in files.
.PP
68
- finally winemaker will generate a global Makefile for normal use.
69 70 71
.PP
- winemaker knows about MFC-based project and will generate customized files.
.PP
72 73
- winemaker can read existing Projectfiles. It supports dsp, dsw, vcproj and sln files.
.PP
74 75 76 77 78 79
.SH OPTIONS
.TP
.I --nobanner
Disables the printing of the banner.
.TP
.I --backup
80
Directs winemaker to perform a backup of all the source files in which it
81 82 83 84 85
makes changes. This is the default.
.TP
.I --nobackup
Tells winemaker not to backup modified source files.
.TP
86 87 88 89
.I --nosource-fix
Directs winemaker not to try fixing the source files (e.g. Dos to Unix
conversion). This prevents complaints if the files are readonly.
.TP
90 91 92 93
.I --lower-all
Tells winemaker to rename all files and directories to lowercase.
.TP
.I --lower-uppercase
94 95
Tells winemaker to only rename files and directories that have an all
uppercase name.
96 97 98
So "HELLO.C" would be renamed but not "World.c".
.TP
.I --lower-none
99 100
Tells winemaker not to rename files and directories to lower case. Note
that this does not prevent the renaming of a file if its extension cannot
101 102
be handled as is, e.g. ".Cxx". This is the default.
.TP
103
.I "--lower-include "
104 105
Tells winemaker that if it does not find the file corresponding to an
include statement (or other form of file reference for resource files),
106 107
then it should convert that filename to lowercase. This is the default.
.TP
108
.I "--nolower-include "
109
Tells winemaker not to modify the include statement if it cannot find the
110 111
referenced file.
.TP
112
.IR "--guiexe " "| " "--windows"
113
Specifies that whenever winemaker finds an executable target, or a target of
114 115 116 117
unknown type, it should assume that it is a graphical application.
This is the default.
.TP
.IR "--cuiexe " "| " "--console"
118
Specifies that whenever winemaker finds an executable target, or a target of
119 120 121
unknown type, it should assume that it is a console application.
.TP
.I --dll
122 123
This option tells winemaker that whenever it finds a target of unknown type,
i.e. for which it does not know whether it is an executable or a library,
124 125
it should assume it is a library.
.TP
126 127 128 129 130 131 132 133
.I --nodlls
This option tells winemaker not to use the standard set of winelib libraries
for imports. That is, any DLL your code uses must be explicitly passed to
winemaker with -i options.
The standard set of libraries is: advapi32.dll, comdlg32.dll, gdi32.dll,
kernel32.dll, odbc32.dll, ole32.dll, oleaut32.dll, shell32.dll, user32.dll,
winspool.drv.
.TP
134
.I --mfc
135 136
Specifies that the targets are MFC based. In such a case winemaker the include 
and library paths accordingly, and links the target with the MFC library.
137 138
.TP
.I --nomfc
139 140 141
Specifies that targets are not MFC-based. This option disables use of MFC libraries
even if winemaker encounters files "stdafx.cpp" or "stdafx.h" that would cause it
to enable MFC automatically if neither --nomfc nor --mfc was specified.
142 143
.TP
.I -Dmacro[=defn]
144
Adds the specified macro definition to the global list of macro definitions.
145 146 147 148
.TP
.I -Idir
Appends the specified directory to the global include path.
.TP
149 150
.I -Pdir
Appends the specified directory to the global dll path.
151
.TP
152
.I -idll
153
Adds the Winelib library to the global list of Winelib libraries to import.
154
.TP
155 156 157
.I -Ldir
Appends the specified directory to the global library path.
.TP
158 159 160 161
.I -llibrary
Adds the specified library to the global list of libraries to link with.
.TP
.I --interactive
162 163
Puts winemaker in interactive mode. In this mode winemaker will ask you to
confirm each directory's list of targets, and then to provide directory and
164 165 166 167
target specific options.
.TP
.I --single-target name
Specifies that there is only one target, and that it is called "name".
168 169
.TP
.I --generated-files
170
Tells winemaker to generate the build the Makefile. This is the default.
171
.TP
172
.I --nogenerated-files
173
Tells winemaker not to generate the Makefile.
174 175 176
.TP
.I --wine64
Tells winemaker to generate a 64-bit Makefile.
177 178 179 180 181

.SH EXAMPLES
.PP
Here is a typical winemaker use:
.PP
182
$ winemaker --lower-uppercase -DSTRICT .
183
.PP
184 185 186 187 188
The above tells winemaker to scan the current directory and its
subdirectories for source files. Whenever if finds a file or directory which
name is all uppercase, it should rename it to lowercase. It should then fix
all these source files for compilation with Winelib and generate Makefiles.
The '-DSTRICT' specifies that the STRICT macro must be set when compiling
189
these sources. Finally winemaker will create a Makefile.
190 191 192 193 194
.PP
The next step would be:
.PP
$ make
.PP
195 196
If at this point you get compilation errors (which is quite likely for a
reasonably sized project) then you should consult the Winelib User Guide to
Francois Gouget's avatar
Francois Gouget committed
197
find tips on how to resolve them.
198
.PP
199
For an MFC-based project you would have to run the following commands instead:
200
.PP
201
$ winemaker --lower-uppercase --mfc .
202
.br
203 204 205 206 207
$ make
.PP
For an existing project-file you would have to run the following commands:
.PP
$ winemaker --lower-all myproject.dsp
208 209 210 211 212 213
.br
$ make
.PP

.SH TODO / BUGS
.PP
214
In some cases you will have to edit the Makefile or sourcefiles by yourself.
215
.PP
216 217 218 219 220
Assuming that the windows executable/library is available, we could
use a pedump-like tool to determine what kind of executable it is (graphical
or console), which libraries it is linked with, and which functions it
exports (for libraries). We could then restore all these settings for the
corresponding Winelib target. The problem is that we should have such a tool
221 222
available under the Wine license first.
.PP
223 224
Furthermore it is not very good at finding the library containing the
executable: it must either be in the current directory or in the
225 226 227 228 229 230 231
.IR LD_LIBRARY_PATH .
.PP
Winemaker does not support message files and the message compiler yet.
.PP

.SH SEE ALSO
.PP
Francois Gouget's avatar
Francois Gouget committed
232
The Winelib User Guide:
233
.PP
234
http://www.winehq.org/docs/winelib-guide/index
235 236 237 238 239 240
.PP
.BR wine (1)
.PP

.SH AUTHOR
Francois Gouget <fgouget@codeweavers.com> for CodeWeavers