tools/winemaker.man.in

   1 .\" -*- nroff -*-
   2 .TH WINEMAKER 1 "Aug 2009" "@PACKAGE_STRING@" "Wine Developers Manual"
   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 " ] [ " "--mfc " "| " "--nomfc "
  17 ]
  18 .br
  19   [
  20 .IR               "--guiexe " "| " "--windows " "| " "--cuiexe " "| " "--console " "| " "--dll " "| " "--nodlls "
  21 ]
  22 .br
  23   [
  24 .IR               "-Dmacro[=defn] " "] [ " "-Idir " "] [ " "-Pdir " "] [ " "-idll" "] [ " "-Ldir " "] [ " "-llibrary "
  25 ]
  26 .br
  27   [
  28 .IR               "--interactive " "] [ " "--single-target name "
  29 ]
  30 .br
  31   [
  32 .IR               "--generated-files " "] [ " "--nogenerated-files " "]
  33 ]
  34 .br
  35   [
  36 .IR               "--wine64 " "]
  37 .br
  38 .IR               "work_directory" "| " "project_file" "| " "workspace_file"
  39
  40 .SH DESCRIPTION
  41 .PP
  42 .B winemaker
  43 is a perl script designed to help you bootstrap the
  44 process of converting your Windows sources to Winelib programs.
  45 .PP
  46 In order to do this winemaker can perform the following operations:
  47 .PP
  48 - rename your source files and directories to lowercase in the event they
  49 got all uppercased during the transfer.
  50 .PP
  51 - perform Dos to Unix (CRLF to LF) conversions.
  52 .PP
  53 - scan the include statements and resource file references to replace the
  54 backslashes with forward slashes.
  55 .PP
  56 - during the above step winemaker will also perform a case insensitive search
  57 of the referenced file in the include path and rewrite the include statement
  58 with the right case if necessary.
  59 .PP
  60 - winemaker will also check other more exotic issues like '#pragma pack'
  61 usage, use of "afxres.h" in non MFC projects, and more. Whenever it
  62 encounters something out of the ordinary, winemaker will warn you about it.
  63 .PP
  64 - winemaker can also scan a complete directory tree at once, guess what are
  65 the executables and libraries you are trying to build, match them with
  66 source files, and generate the corresponding Makefile.in files.
  67 .PP
  68 - finally winemaker will generate a global Makefile for normal use.
  69 .PP
  70 - winemaker knows about MFC-based project and will generate customized files.
  71 .PP
  72 - winemaker can read existing Projectfiles. It supports dsp, dsw, vcproj and sln files.
  73 .PP
  74 .SH OPTIONS
  75 .TP
  76 .I --nobanner
  77 Disables the printing of the banner.
  78 .TP
  79 .I --backup
  80 Directs winemaker to perform a backup of all the source files in which it
  81 makes changes. This is the default.
  82 .TP
  83 .I --nobackup
  84 Tells winemaker not to backup modified source files.
  85 .TP
  86 .I --nosource-fix
  87 Directs winemaker not to try fixing the source files (e.g. Dos to Unix
  88 conversion). This prevents complaints if the files are readonly.
  89 .TP
  90 .I --lower-all
  91 Tells winemaker to rename all files and directories to lowercase.
  92 .TP
  93 .I --lower-uppercase
  94 Tells winemaker to only rename files and directories that have an all
  95 uppercase name.
  96 So "HELLO.C" would be renamed but not "World.c".
  97 .TP
  98 .I --lower-none
  99 Tells winemaker not to rename files and directories to lower case. Note
 100 that this does not prevent the renaming of a file if its extension cannot
 101 be handled as is, e.g. ".Cxx". This is the default.
 102 .TP
 103 .I "--lower-include "
 104 Tells winemaker that if it does not find the file corresponding to an
 105 include statement (or other form of file reference for resource files),
 106 then it should convert that filename to lowercase. This is the default.
 107 .TP
 108 .I "--nolower-include "
 109 Tells winemaker not to modify the include statement if it cannot find the
 110 referenced file.
 111 .TP
 112 .IR "--guiexe " "| " "--windows"
 113 Specifies that whenever winemaker finds an executable target, or a target of
 114 unknown type, it should assume that it is a graphical application.
 115 This is the default.
 116 .TP
 117 .IR "--cuiexe " "| " "--console"
 118 Specifies that whenever winemaker finds an executable target, or a target of
 119 unknown type, it should assume that it is a console application.
 120 .TP
 121 .I --dll
 122 This option tells winemaker that whenever it finds a target of unknown type,
 123 i.e. for which it does not know whether it is an executable or a library,
 124 it should assume it is a library.
 125 .TP
 126 .I --nodlls
 127 This option tells winemaker not to use the standard set of winelib libraries
 128 for imports. That is, any DLL your code uses must be explicitly passed to
 129 winemaker with -i options.
 130 The standard set of libraries is: advapi32.dll, comdlg32.dll, gdi32.dll,
 131 kernel32.dll, odbc32.dll, ole32.dll, oleaut32.dll, shell32.dll, user32.dll,
 132 winspool.drv.
 133 .TP
 134 .I --mfc
 135 Specifies that the targets are MFC based. In such a case winemaker the include
 136 and library paths accordingly, and links the target with the MFC library.
 137 .TP
 138 .I --nomfc
 139 Specifies that targets are not MFC-based. This option disables use of MFC libraries
 140 even if winemaker encounters files "stdafx.cpp" or "stdafx.h" that would cause it
 141 to enable MFC automatically if neither --nomfc nor --mfc was specified.
 142 .TP
 143 .I -Dmacro[=defn]
 144 Adds the specified macro definition to the global list of macro definitions.
 145 .TP
 146 .I -Idir
 147 Appends the specified directory to the global include path.
 148 .TP
 149 .I -Pdir
 150 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 .I -Ldir
 156 Appends the specified directory to the global library path.
 157 .TP
 158 .I -llibrary
 159 Adds the specified library to the global list of libraries to link with.
 160 .TP
 161 .I --interactive
 162 Puts winemaker in interactive mode. In this mode winemaker will ask you to
 163 confirm each directory's list of targets, and then to provide directory and
 164 target specific options.
 165 .TP
 166 .I --single-target name
 167 Specifies that there is only one target, and that it is called "name".
 168 .TP
 169 .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 .TP
 175 .I --wine64
 176 Tells winemaker to generate a 64-bit Makefile.
 177
 178 .SH EXAMPLES
 179 .PP
 180 Here is a typical winemaker use:
 181 .PP
 182 $ winemaker --lower-uppercase -DSTRICT .
 183 .PP
 184 The above tells winemaker to scan the current directory and its
 185 subdirectories for source files. Whenever if finds a file or directory which
 186 name is all uppercase, it should rename it to lowercase. It should then fix
 187 all these source files for compilation with Winelib and generate Makefiles.
 188 The '-DSTRICT' specifies that the STRICT macro must be set when compiling
 189 these sources. Finally winemaker will create a Makefile.
 190 .PP
 191 The next step would be:
 192 .PP
 193 $ make
 194 .PP
 195 If at this point you get compilation errors (which is quite likely for a
 196 reasonably sized project) then you should consult the Winelib User Guide to
 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 $ make
 204 .PP
 205 For an existing project-file you would have to run the following commands:
 206 .PP
 207 $ winemaker --lower-all myproject.dsp
 208 .br
 209 $ make
 210 .PP
 211
 212 .SH TODO / BUGS
 213 .PP
 214 In some cases you will have to edit the Makefile or sourcefiles by yourself.
 215 .PP
 216 Assuming that the windows executable/library is available, we could
 217 use winedump to determine what kind of executable it is (graphical
 218 or console), which libraries it is linked with, and which functions it
 219 exports (for libraries). We could then restore all these settings for the
 220 corresponding Winelib target.
 221 .PP
 222 Furthermore winemaker is not very good at finding the library containing the
 223 executable: it must either be in the current directory or in the
 224 .IR LD_LIBRARY_PATH .
 225 .PP
 226 Winemaker does not support message files and the message compiler yet.
 227 .PP
 228
 229 .SH SEE ALSO
 230 .PP
 231 The Winelib User Guide:
 232 .PP
 233 http://www.winehq.org/docs/winelib-guide/index
 234 .PP
 235 .BR wine (1)
 236 .PP
 237
 238 .SH AUTHOR
 239 Francois Gouget <fgouget@codeweavers.com> for CodeWeavers