README

   1 1. INTRODUCTION
   2
   3 Wine is a program which allows running Microsoft Windows programs
   4 (including DOS, Windows 3.x and Win32 executables) on Unix.  It
   5 consists of a program loader which loads and executes a Microsoft
   6 Windows binary, and a library that implements Windows API calls using
   7 their Unix or X11 equivalents. The library may also be used for
   8 porting Win32 code into native Unix executables.
   9
  10 Wine is free software, and its license (contained in the file LICENSE)
  11 is BSD style.  Basically, you can do anything with it except claim
  12 that you wrote it.
  13
  14 2. QUICK START
  15
  16 Whenever you compile from source, it is recommended to use the Wine
  17 Installer to build and install wine.  From the top-level Wine
  18 directory (which contains this file), run:
  19
  20 ./tools/wineinstall
  21
  22 Run programs as "wine [options] program".  For more information and
  23 problem resolution, read the rest of this file, the Wine manpage,
  24 and the files in the documentation directory in the Wine source.
  25
  26 3. REQUIREMENTS
  27
  28 To compile and run Wine, you must have one of the following:
  29
  30         Linux version 2.0.36 or above
  31         FreeBSD-current or FreeBSD 3.0 or later
  32         Solaris x86 2.5 or later
  33
  34 Linux info:
  35   Although Linux version 2.0.x will mostly work, certain features
  36   (specifically LDT sharing) required for properly supporting Win32
  37   threads were not implemented until kernel version 2.2.  If you get
  38   consistent thread-related crashes, you may want to upgrade to 2.2.
  39   Also, some bugs were fixed and additional features were added
  40   late in the Linux 2.0.x series, so if you have a very old Linux kernel,
  41   you may want to upgrade to at least the latest 2.0.x release.
  42
  43 FreeBSD info:
  44   On FreeBSD, you may want to apply an LDT sharing patch too
  45   (unless you are tracking -current where it finally has
  46   been committed just recently), and there also is a small sigtrap
  47   fix thats needed for wine's debugger. (Actually now that its using
  48   ptrace() by default it may no longer make a difference but it still
  49   doesn't hurt...) And if you're running a system from the -stable
  50   branch older than Nov 15 1999, like a 3.3-RELEASE, then you also
  51   need to apply a signal handling change that was MFC'd at that date.
  52   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
  53   turned on in your kernel.
  54   More information including patches for the -stable branch is in
  55   the ports tree:
  56   ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/ports/emulators/wine/files/
  57
  58 Solaris info:
  59   You will most likely need to build wine with the GNU toolchain
  60   (gcc, gas, etc.)
  61
  62 Wine requires kernel-level threads to run. Currently, only Linux
  63 version 2.0 or later, FreeBSD-current or FreeBSD 3.0 or later,
  64 and Solaris x86 version 2.5 or later are supported.
  65 Other operating systems which support kernel threads may be supported
  66 in the future.
  67
  68 You need to have the X11 development include files installed
  69 (called xlib6g-dev in Debian and XFree86-devel in RedHat).
  70 To use wine's support for multi-threaded applications, your X libraries
  71 must be reentrant, which is probably the default by now.
  72 If you have libc6 (glibc2), or you compiled the X libraries yourself,
  73 they were probably compiled with the reentrant option enabled.
  74
  75 You also need to have libXpm installed on your system. The sources for
  76 it are available at ftp.x.org and all its mirror sites in the directory
  77 /contrib/libraries. If you are using RedHat, libXpm is distributed as the
  78 xpm and xpm-devel packages. Debian distributes libXpm as xpm4.7, xpm4g,
  79 and xpm4g-dev. SuSE calls these packages xpm and xpm-devel.
  80
  81 On x86 Systems gcc >= 2.7.2 is required.
  82 Versions earlier than 2.7.2.3 may have problems when certain files
  83 are compiled with optimization, often due to problems with header file
  84 management. pgcc currently doesn't work with wine. The cause of this problem
  85 is unknown.
  86
  87 You also need flex version 2.5 or later and yacc.
  88 Bison will work as a replacement for yacc. If you are
  89 using RedHat or Debian, install the flex and bison packages.
  90
  91 4. COMPILATION
  92
  93 In case you chose to not use wineinstall, run the following commands
  94 to build Wine:
  95
  96 ./configure
  97 make depend
  98 make
  99
 100 This will build the program "wine" and numerous support libraries/binaries.
 101 The program "wine" will load and run Windows executables.
 102 The library "libwine" ("Winelib") can be used to compile and link
 103 Windows source code under Unix.
 104
 105 To see compile configuration options, do ./configure --help.
 106
 107 To upgrade to a new release by using a patch file, first cd to the
 108 top-level directory of the release (the one containing this README
 109 file). Then do a "make clean", and patch the release with:
 110
 111     gunzip -c patch-file | patch -p1
 112
 113 where "patch-file" is the name of the patch file (something like
 114 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
 115 run "make depend && make".
 116
 117
 118 5. SETUP
 119
 120 Once Wine has been built correctly, you can do "make install"; this
 121 will install the wine executable, the Wine man page, and a few other
 122 needed files.
 123
 124 Wine requires a configuration file named wine.conf. Its default
 125 location is /usr/local/etc, but you can supply a different name when
 126 configuring wine by using the --prefix or --sysconfdir options to
 127 ./configure. You can also override the global configuration file with
 128 a file named "config" in your ~/.wine directory.
 129
 130 The format of this file is explained in the man page. The file
 131 documentation/samples/config contains an example configuration file
 132 which has to be adapted and copied to one of the two locations
 133 mentioned above.
 134
 135 See http://www.winehq.com/config.html for further configuration hints.
 136
 137
 138 6. RUNNING PROGRAMS
 139
 140 When invoking Wine, you may specify the entire path to the executable,
 141 or a filename only.
 142
 143 For example: to run Solitaire:
 144
 145         wine sol                   (using the searchpath to locate the file)
 146         wine sol.exe
 147
 148         wine c:\\windows\\sol.exe  (using a DOS filename)
 149
 150         wine /usr/windows/sol.exe  (using a Unix filename)
 151
 152 Note: the path of the file will also be added to the path when
 153       a full name is supplied on the commandline.
 154
 155 Wine is not yet complete, so some programs may crash. Provided you set up
 156 winedbg correctly according to documentation/debugger.sgml, you will be dropped
 157 into a debugger so that you can investigate and fix the problem. For more
 158 information on how to do this, please read the file documentation/debugging.
 159 If you post a bug report, please read the file documentation/bugreports to
 160 see what information is required.
 161
 162 You should backup all your important files that you give Wine access
 163 to, or use a special Wine copy of them, as there have been some cases
 164 of users reporting file corruption. Do NOT run Explorer, for instance,
 165 if you don't have a proper backup, as it renames/cripples several
 166 directories sometimes.
 167
 168
 169 7. GETTING MORE INFORMATION
 170
 171 DOCU:   grep -i "SearchString" `find documentation/`|more
 172
 173 FAQ:    The Wine FAQ is located at http://www.winehq.com/FAQ
 174
 175 WWW:    A great deal of information about Wine is available from WineHQ at
 176         http://www.winehq.com/, especially various user guides.
 177         Untested patches against the current release
 178         are available on the wine-patches mailing list; see
 179         http://www.winehq.com/dev.shtml#ml for more information.
 180
 181 HOWTO:  The Wine HOWTO is available at
 182         http://www.westfalen.de/witch/wine-HOWTO.txt .
 183
 184 Usenet: Please browse old messages on http://www.dejanews.com/ to check whether
 185         your problem is already fixed before posting a bug report to the
 186         newsgroup.
 187
 188         The best place to get help or to report bugs is the Usenet newsgroup
 189         comp.emulators.ms-windows.wine. Please read the file
 190         documentation/bugreports to see what information should be included
 191         in a bug report.
 192
 193 IRC:    Online help is available at channel #WineHQ on IRCnet.
 194
 195 CVS:    The current Wine development tree is available through CVS.
 196         Go to http://www.winehq.com/dev.shtml for more information.
 197
 198 If you add something, or fix a bug, please send a patch ('diff -u'
 199 format preferred) to julliard@winehq.com for inclusion in the next
 200 release.
 201
 202 --
 203 Alexandre Julliard
 204 julliard@winehq.com