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