documentation/winemaker.man

   1 .\" -*- nroff -*-
   2 .TH WINEMAKER 1 "September 27, 2001" "Version 0.5.8" "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 " "] [ "--nosource-fix "
   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 " "] [ " "--nogenerated-specs "
  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 --nosource-fix
  85 Directs winemaker not to try fixing the source files (e.g. Dos to Unix
  86 conversion). This prevents complaints if the files are readonly.
  87 .TP
  88 .I --lower-all
  89 Tells winemaker to rename all files and directories to lowercase.
  90 .TP
  91 .I --lower-uppercase
  92 Tells winemaker to only rename files and directories that have an all
  93 uppercase name.
  94 So "HELLO.C" would be renamed but not "World.c".
  95 .TP
  96 .I --lower-none
  97 Tells winemaker not to rename files and directories to lower case. Note
  98 that this does not prevent the renaming of a file if its extension cannot
  99 be handled as is, e.g. ".Cxx". This is the default.
 100 .TP
 101 .I "--lower-include "
 102 Tells winemaker that if it does not find the file corresponding to an
 103 include statement (or other form of file reference for resource files),
 104 then it should convert that filename to lowercase. This is the default.
 105 .TP
 106 .I "--nolower-include "
 107 Tells winemaker not to modify the include statement if it cannot find the
 108 referenced file.
 109 .TP
 110 .IR "--guiexe " "| " "--windows"
 111 Specifies that whenever winemaker finds an executable target, or a target of
 112 unknown type, it should assume that it is a graphical application.
 113 This is the default.
 114 .TP
 115 .IR "--cuiexe " "| " "--console"
 116 Specifies that whenever winemaker finds an executable target, or a target of
 117 unknown type, it should assume that it is a console application.
 118 .TP
 119 .I --dll
 120 This option tells winemaker that whenever it finds a target of unknown type,
 121 i.e. for which it does not know whether it is an executable or a library,
 122 it should assume it is a library.
 123 .TP
 124 .I --wrap
 125 Specifies that executable targets should be built as libraries and a small
 126 executable wrapper generated for them. This technique is sometimes required
 127 to solve initialization problems occuring on the application startup.
 128 .TP
 129 .I --nowrap
 130 Specifies that no wrapper should be generated for executable targets. This is
 131 the default.
 132 .TP
 133 .I --mfc
 134 Specifies that the targets are MFC based. In such a case winemaker generates a
 135 configure script with MFC specific options, modifies the include and
 136 library paths accordingly, links the target with the MFC library and
 137 generates wrappers for these targets that are executables.
 138 .TP
 139 .I --nomfc
 140 Specifies that targets are not MFC-based. This is the default.
 141 .TP
 142 .I -Dmacro[=defn]
 143 Adds the specified macro definition to the global list of macro definitions.
 144 .TP
 145 .I -Idir
 146 Appends the specified directory to the global include path.
 147 .TP
 148 .I -Ldir
 149 Appends the specified directory to the global library path.
 150 .TP
 151 .I -idll
 152 Adds the Winelib library to the global list of Winelib libraries to import
 153 in the spec file.
 154 .TP
 155 .I -llibrary
 156 Adds the specified library to the global list of libraries to link with.
 157 .TP
 158 .I --interactive
 159 Puts winemaker in interactive mode. In this mode winemaker will ask you to
 160 confirm each directory's list of targets, and then to provide directory and
 161 target specific options.
 162 .TP
 163 .I --single-target name
 164 Specifies that there is only one target, and that it is called "name".
 165 .TP
 166 .I --generated-files
 167 Tells winemaker to generate the build infrastructure files, i.e. the spec
 168 files, the wrapper files, the Makefile.in files, the Make.rules.in file, the
 169 configure.in file and the configure script. This is the default.
 170 .TP
 171 .I --nogenerated-files
 172 Tells winemaker not to generate any of the above files.
 173 .TP
 174 .I --nogenerated-specs
 175 Tells winemaker not to generate the spec files when generating files.  This is
 176 particularly useful when using winemaker to generate a build environment and
 177 you already have a spec file.
 178
 179 .SH EXAMPLES
 180 .PP
 181 Here is a typical winemaker use:
 182 .PP
 183 $ winemaker --lower-uppercase -DSTRICT
 184 .PP
 185 The above tells winemaker to scan the current directory and its
 186 subdirectories for source files. Whenever if finds a file or directory which
 187 name is all uppercase, it should rename it to lowercase. It should then fix
 188 all these source files for compilation with Winelib and generate Makefiles.
 189 The '-DSTRICT' specifies that the STRICT macro must be set when compiling
 190 these sources. Finally winemaker will create a global Makefile.in and
 191 configure.in, and run autoconf to generate the configure script.
 192 .PP
 193 The next step would be:
 194 .PP
 195 $ ./configure --with-wine=/usr/local/opt/wine
 196 .PP
 197 This generates the makefiles from the Makefile.in files. The generated
 198 makefiles will fetch the Winelib headers and libraries from the Wine
 199 installation located in /usr/local/opt/wine.
 200 .PP
 201 And finally:
 202 .PP
 203 $ make
 204 .PP
 205 If at this point you get compilation errors (which is quite likely for a
 206 reasonably sized project) then you should consult the Winelib User Guide to
 207 find tips on how to resolve them.
 208 .PP
 209 For an MFC-based project one would have run the following commands instead:
 210 .PP
 211 $ winemaker --lower-uppercase --mfc
 212 .br
 213 $ ./configure --with-wine=/usr/local/opt/wine \\
 214 .br
 215               --with-mfc=/usr/local/opt/mfc
 216 .br
 217 $ make
 218 .PP
 219
 220 .SH TODO / BUGS
 221 .PP
 222 Winemaker should support the Visual Studio project files (.dsp for newer
 223 versions and .mak for some older versions). This would allow it to be much
 224 more accurate, especially for the macro, include and library path
 225 settings.
 226 .PP
 227 Assuming that the windows executable/library is available, we could
 228 use a pedump-like tool to determine what kind of executable it is (graphical
 229 or console), which libraries it is linked with, and which functions it
 230 exports (for libraries). We could then restore all these settings for the
 231 corresponding Winelib target. The problem is that we should have such a tool
 232 available under the Wine license first.
 233 .PP
 234 The wrapper code should be generic, i.e. you should be able to have just one
 235 wrapper and specify which library to load using an option.
 236 .PP
 237 Furthermore it is not very good at finding the library containing the
 238 executable: it must either be in the current directory or in the
 239 .IR LD_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