Bring the man page in line with the latest version of winemaker.
[wine] / documentation / winemaker.man
1 .\" -*- nroff -*-
2 .TH WINEMAKER 1 "November 1, 2000" "Version 0.5.1" "Windows On Unix"
3 .SH NAME
4 winemaker \- generate a build infrastructure for compiling Windows programs on Unix
5 .SH SYNOPSIS
6 .B "winemaker "
7 [
8 .IR               "--nobanner " "] [ " "--backup " "| " "--nobackup "
9 ]
10 .br
11   [
12 .IR               "--lower-none " "| " "--lower-all " "| " "--lower-uppercase "
13 ]
14 .br
15   [
16 .IR               "--lower-include " "| " "--nolower-include "
17 ]
18 .br
19   [
20 .IR               "--guiexe " "| " "--windows " "| " "--cuiexe " "| " "--console " "| " "--dll "
21 ]
22 .br
23   [
24 .IR               "--wrap " "| " "--nowrap " "] [ " "--mfc " "| " "--nomfc "
25 ]
26 .br
27   [
28 .IR               "-Dmacro[=defn] " "] [ " "-Idir " "] [ " "-Ldir " "] [ " "-idll" "] [ " "-llibrary "
29 ]
30 .br
31   [
32 .IR               "--interactive " "] [ " "--single-target name "
33 ]
34 .br
35   [
36 .IR               "--generated-files " "] [ " "--nogenerated-files "
37 ]
38
39 .SH DESCRIPTION
40 .PP
41 .B winemaker
42 is a perl script designed to help you bootstrap the 
43 process of converting your Windows sources to WineLib programs.
44 .PP
45 In order to do this winemaker can perform the following operations:
46 .PP
47 - rename your source files and directories to lowercase in the event they 
48 got all uppercased during the transfer.
49 .PP
50 - perform Dos to Unix (CRLF to LF) conversions.
51 .PP
52 - scan the include statements and resource file references to replace the 
53 backslashes with forward slashes.
54 .PP
55 - during the above step winemaker will also perform a case insensitive search 
56 of the referenced file in the include path and rewrite the include statement 
57 with the right case if necessary.
58 .PP
59 - winemaker will also check other more exotic issues like '#pragma pack' 
60 usage, use of "afxres.h" in non MFC projects, and more. Whenever it 
61 encounters something out of the ordinary, winemaker will warn you about it.
62 .PP
63 - winemaker can also scan a complete directory tree at once, guess what are 
64 the executables and libraries you are trying to build, match them with 
65 source files, and generate the corresponding Makefile.in files.
66 .PP
67 - finally winemaker will generate a global Makefile.in file calling out to all 
68 the others, and a configure script customized for use with WineLib.
69 .PP
70 - winemaker knows about MFC-based project and will generate customized files.
71 .PP
72 .SH OPTIONS
73 .TP
74 .I --nobanner
75 Disables the printing of the banner.
76 .TP
77 .I --backup
78 Directs winemaker to perform a backup of all the source files in which it 
79 makes changes. This is the default.
80 .TP
81 .I --nobackup
82 Tells winemaker not to backup modified source files.
83 .TP
84 .I --lower-all
85 Tells winemaker to rename all files and directories to lowercase.
86 .TP
87 .I --lower-uppercase
88 Tells winemaker to only rename files and directories that have an all 
89 uppercase name. 
90 So "HELLO.C" would be renamed but not "World.c".
91 .TP
92 .I --lower-none
93 Tells winemaker not to rename files and directories to lower case. Note 
94 that this does not prevent the renaming of a file if its extension cannot 
95 be handled as is, e.g. ".Cxx". This is the default.
96 .TP
97 .I "--lower-include "
98 Tells winemaker that if it does not find the file corresponding to an 
99 include statement (or other form of file reference for resource files), 
100 then it should convert that filename to lowercase. This is the default.
101 .TP
102 .I "--nolower-include "
103 Tells winemaker not to modify the include statement if it cannot find the 
104 referenced file.
105 .TP
106 .IR "--guiexe " "| " "--windows"
107 Specifies that whenever winemaker finds an executable target, or a target of 
108 unknown type, it should assume that it is a graphical application.
109 This is the default.
110 .TP
111 .IR "--cuiexe " "| " "--console"
112 Specifies that whenever winemaker finds an executable target, or a target of 
113 unknown type, it should assume that it is a console application.
114 .TP
115 .I --dll
116 This option tells winemaker that whenever it finds a target of unknown type, 
117 i.e. for which it does not know whether it is an executable or a library, 
118 it should assume it is a library.
119 .TP
120 .I --wrap
121 Specifies that executable targets should be built as libraries and a small 
122 executable wrapper generated for them. This technique is sometimes required 
123 to solve initialization problems occuring on the application startup.
124 .TP
125 .I --nowrap
126 Specifies that no wrapper should be generated for executable targets. This is 
127 the default.
128 .TP
129 .I --mfc
130 Specifies that the targets are MFC based. In such a case winemaker generates a 
131 configure script with MFC specific options, modifies the include and 
132 library paths accordingly, links the target with the MFC library and 
133 generates wrappers for these targets that are executables.
134 .TP
135 .I --nomfc
136 Specifies that targets are not MFC-based. This is the default.
137 .TP
138 .I -Dmacro[=defn]
139 Adds the specified macro definition to the global list of macro definitions. 
140 .TP
141 .I -Idir
142 Appends the specified directory to the global include path.
143 .TP
144 .I -Ldir
145 Appends the specified directory to the global library path.
146 .TP
147 .I -idll
148 Adds the Winelib library to the global list of Winelib libraries to import 
149 in the spec file.
150 .TP
151 .I -llibrary
152 Adds the specified library to the global list of libraries to link with.
153 .TP
154 .I --interactive
155 Puts winemaker in interactive mode. In this mode winemaker will ask you to 
156 confirm each directory's list of targets, and then to provide directory and 
157 target specific options.
158 .TP
159 .I --single-target name
160 Specifies that there is only one target, and that it is called "name".
161 .TP
162 .I --generated-files
163 Tells winemaker to generate the build infrastructure files, i.e. the spec 
164 files, the wrapper files, the Makefile.in files, the Make.rules.in file, the 
165 configure.in file and the configure script. This is the default.
166 .TP
167 .I --nogenerated-files
168 Tells winemaker not to generate any of the above files.
169
170 .SH EXAMPLES
171 .PP
172 Here is a typical winemaker use:
173 .PP
174 $ winemaker --lower-uppercase -DSTRICT
175 .PP
176 The above tells winemaker to scan the current directory and its 
177 subdirectories for source files. Whenever if finds a file or directory which 
178 name is all uppercase, it should rename it to lowercase. It should then fix 
179 all these source files for compilation with WineLib and generate Makefiles. 
180 The '-DSTRICT' specifies that the STRICT macro must be set when compiling 
181 these sources. Finally winemaker will create a global Makefile.in and 
182 configure.in, and run autoconf to generate the configure script.
183 .PP
184 The next step would be:
185 .PP
186 $ ./configure --with-wine=/usr/local/opt/wine
187 .PP
188 This generates the makefiles from the Makefile.in files. The generated 
189 makefiles will fetch the WineLib headers and libraries from the Wine 
190 installation located in /usr/local/opt/wine.
191 .PP
192 And finally:
193 .PP
194 $ make
195 .PP
196 If at this point you get compilation errors (which quite likely for a 
197 reasonable sized project) then you should consult the WineLib User Guide to 
198 find tips about how to resolve them.
199 .PP
200 For an MFC-based project one would have run the following commands instead:
201 .PP
202 $ winemaker --lower-uppercase --mfc
203 .br
204 $ ./configure --with-wine=/usr/local/opt/wine \\
205 .br
206               --with-mfc=/usr/local/opt/mfc
207 .br
208 $ make
209 .PP
210
211 .SH TODO / BUGS
212 .PP
213 Winemaker should support the Visual Studio project files (.dsp for newer 
214 versions and .mak for some older versions). This would allow it to be much 
215 more accurate, especially for the macro, include path and library path 
216 settings.
217 .PP
218 Assuming that we have the windows executable/library available, we could 
219 use a pedump-like tool to determine what kind of executable it is (graphical 
220 or console), which libraries it is linked with, and which functions it 
221 exports (for libraries). We could then restore all these settings for the 
222 corresponding WineLib target. The problem is that we should have such a tool 
223 available under the Wine license first.
224 .PP
225 The wrapper code should be generic, i.e. you should be able to have just one 
226 wrapper and specify which library to load using an option.
227 .PP
228 Furthermore it is not very good at finding the library containing the 
229 executable: it must either be in the current directory or in the 
230 .IR LD_LIBRARY_PATH .
231 .PP
232 The current way we link with libraries is not very good: with link, in the 
233 Unix sense, with all of them, and with none in the WineLib sense. But we 
234 lack a good means of detecting which libraries we should link with. 
235 Furthermore this area will change significantly when winebuild make sit 
236 possible to really link in the WineLib sense (i.e. via the spec file).
237 .PP
238 Work remains to be done on the configure script. Especially in the area of 
239 detecting headers and libraries that are already in the include/library path.
240 .PP
241 Winemaker does not support message files and the message compiler yet.
242 .PP
243
244 .SH SEE ALSO
245 .PP
246 The WineLib User Guide:
247 .PP
248 http://wine.codeweavers.com/docs/winelib-user/
249 .PP
250 .BR wine (1)
251 .PP
252
253 .SH AUTHOR
254 Francois Gouget <fgouget@codeweavers.com> for CodeWeavers