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 Although Linux version 2.0.x will mostly work, certain features
  35 (specifically LDT sharing) required for properly supporting Win32
  36 threads were not implemented until kernel version 2.2.  If you get
  37 consistent thread-related crashes, you may want to upgrade to 2.2.
  38
  39 Similarly if you are on FreeBSD you may want to apply an LDT sharing
  40 patch too (unless you are tracking -current where it finally has
  41 been committed just recently), and there also is a small sigtrap
  42 fix thats needed for wine's debugger. (Actually now that its using
  43 ptrace() by default it may no longer make a difference but it still
  44 doesn't hurt...) And if you're running a system from the -stable
  45 branch older than Nov 15 1999, like a 3.3-RELEASE, then you also
  46 need to apply a signal handling change that was MFC'd at that date.
  47 More information including patches for the -stable branch is in
  48 the ports tree:
  49 ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/ports/emulators/wine/files/
  50
  51 You need to have the X11 development include files installed
  52 (called xlib6g-dev in Debian and XFree86-devel-4.0.1-1 in RedHat).
  53
  54 You also need to have libXpm installed on your system. The sources for
  55 it are available at ftp.x.org and all its mirror sites in the directory
  56 /contrib/libraries. If you are using RedHat, libXpm is distributed as the
  57 xpm and xpm-devel packages. Debian distributes libXpm as xpm4.7, xpm4g,
  58 and xpm4g-dev 3.4j. SuSE calls these packages xpm and xpm-devel.
  59
  60 On x86 Systems gcc >= 2.7.2 is required. You also need flex version 2.5
  61 or later and yacc. Bison will work as a replacement for yacc. If you are
  62 using RedHat, install the flex and bison packages.
  63
  64 4. COMPILATION
  65
  66 To build Wine, run the following commands:
  67
  68 ./configure
  69 make depend
  70 make
  71
  72 This will build the library "libwine.a" and the program "wine".
  73 The program "wine" will load and run Windows executables.
  74 The library "libwine.a" can be used to compile and link Windows source
  75 code under Unix.
  76
  77 If you do not intend to compile Windows source code, use
  78 "./configure --disable-lib" to skip building the library and reduce disk
  79 space requirements. If you have an ELF compiler (which you probably do),
  80 you can use "./configure --enable-dll" to build a shared library instead.
  81 To see other configuration options, do ./configure --help.
  82
  83 To upgrade to a new release by using a patch file, first cd to the
  84 top-level directory of the release (the one containing this README
  85 file). Then do a "make clean", and patch the release with:
  86
  87     gunzip -c patch-file | patch -p1
  88
  89 where "patch-file" is the name of the patch file (something like
  90 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
  91 run "make depend && make".
  92
  93
  94 5. SETUP
  95
  96 Once Wine has been built correctly, you can do "make install"; this
  97 will install the wine executable, the Wine man page, and a few other
  98 needed files.
  99
 100 Wine requires a configuration file named wine.conf. Its default location is
 101 /usr/local/etc, but you can supply a different name when configuring wine by
 102 using the --prefix or --sysconfdir options to ./configure. You can also override
 103 the global configuration file with a .winerc file in your home directory.
 104
 105 The format of this file is explained in the man page. The file
 106 wine.ini contains an example configuration file which has to be adapted
 107 and copied to one of the two locations mentioned above.
 108
 109 See http://www.winehq.com/config.html for further configuration hints.
 110
 111
 112 6. RUNNING PROGRAMS
 113
 114 When invoking Wine, you may specify the entire path to the executable,
 115 or a filename only.
 116
 117 For example: to run Solitaire:
 118
 119         wine sol                   (using the searchpath to locate the file)
 120         wine sol.exe
 121
 122         wine c:\\windows\\sol.exe  (using a DOS filename)
 123
 124         wine /usr/windows/sol.exe  (using a Unix filename)
 125
 126 Note: the path of the file will also be added to the path when
 127       a full name is supplied on the commandline.
 128
 129 Wine is not yet complete, so some programs may crash. Provided you set up
 130 winedbg correctly according to documentation/debugger.sgml, you will be dropped
 131 into a debugger so that you can investigate and fix the problem. For more
 132 information on how to do this, please read the file documentation/debugging.
 133 If you post a bug report, please read the file documentation/bugreports to
 134 see what information is required.
 135
 136
 137 7. GETTING MORE INFORMATION
 138
 139 DOCU:   grep -i "SearchString" `find documentation/`|more
 140
 141 FAQ:    The Wine FAQ is located at http://www.winehq.com/faq.html.
 142
 143 WWW:    A great deal of information about Wine is available from WineHQ at
 144         http://www.winehq.com/. Untested patches against the current release
 145         are available on the wine-patches mailing list; see
 146         http://www.winehq.com/dev.html#ml for more information.
 147
 148 HOWTO:  The Wine HOWTO is available at
 149         http://www.westfalen.de/witch/wine-HOWTO.txt .
 150
 151 Usenet: Please browse old messages on http://www.dejanews.com/ to check whether
 152         your problem is already fixed before posting a bug report to the
 153         newsgroup.
 154
 155         The best place to get help or to report bugs is the Usenet newsgroup
 156         comp.emulators.ms-windows.wine. Please read the file
 157         documentation/bugreports to see what information should be included
 158         in a bug report.
 159
 160 IRC:    Online help is available at channel #WineHQ on IRCnet.
 161
 162 CVS:    The current Wine development tree is available through CVS.
 163         Go to http://www.winehq.com/dev.html for more information.
 164
 165 If you add something, or fix a bug, please send a patch ('diff -u'
 166 format preferred) to julliard@winehq.com for inclusion in the next
 167 release.
 168
 169 --
 170 Alexandre Julliard
 171 julliard@winehq.com