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 an 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
  15 2. COMPILATION
  16
  17 To compile Wine, you must have one of:
  18
  19         Linux version 0.99.13 or above
  20         NetBSD-current
  21         FreeBSD-current or FreeBSD 1.1 or later
  22         OpenBSD/i386 2.1 or later
  23         Solaris x86 2.5 or later
  24
  25 You also need to have libXpm installed on your system. The sources for
  26 it are probably available on the ftp site where you got Wine. They can
  27 also be found on ftp.x.org and all its mirror sites.
  28
  29 On x86 Systems gcc >= 2.7.0 is required. You will probably need flex too.
  30
  31 To build Wine, first do a "./configure" and then a "make depend; make".
  32 This will build the library "libwine.a" and the program "wine".
  33
  34 The program "wine" will load and run Windows executables.
  35 The library "libwine.a" can be used to compile and link Windows source
  36 code under Unix.  If you have an ELF compiler, you can use
  37 "./configure --enable-dll" to build a shared library instead.
  38
  39 To upgrade to a new release by using a patch file, first cd to the
  40 top-level directory of the release (the one containing this README
  41 file). Then do a "make clean", and patch the release with:
  42
  43     gunzip -c patch-file | patch -p1
  44
  45 where "patch-file" is the name of the patch file (something like
  46 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
  47 run "make depend; make".
  48
  49
  50 3. SETUP
  51
  52 Once Wine has been built correctly, you can do "make install"; this
  53 will install the wine executable and the man page.
  54
  55 Wine requires you to have a file /usr/local/etc/wine.conf (you can
  56 supply a different name when configuring wine) or a file called .winerc
  57 in your home directory.
  58
  59 The format of this file is explained in the man page. The file
  60 wine.ini contains a config file example.
  61
  62
  63 4. RUNNING PROGRAMS
  64
  65 When invoking Wine, you must specify the entire path to the executable,
  66 or a filename only.
  67
  68 For example: to run Solitaire:
  69
  70         wine sol                   (using the searchpath to locate the file)
  71         wine sol.exe
  72
  73         wine c:\\windows\\sol.exe  (using a DOS filename)
  74
  75         wine /usr/windows/sol.exe  (using a Unix filename)
  76
  77 Note: the path of the file will also be added to the path when
  78       a full name is supplied on the commandline.
  79
  80 Wine is not yet complete, so some programs may crash. You will be dropped
  81 into a debugger so that you can investigate and fix the problem.
  82
  83 5. GETTING MORE INFORMATION
  84
  85 Usenet: The best place to get help or to report bugs is the Usenet newsgroup
  86         comp.emulators.ms-windows.wine. The Wine FAQ is posted there every
  87         month.
  88
  89 WWW:    Please browse old messages on http://www.dejanews.com/ to check whether
  90         your problem is already fixed before posting a bug report to the
  91         newsgroup.
  92
  93         A great deal of information about Wine is available from WineHQ at
  94         http://www.winehq.com/. Untested patches against the current release
  95         are available on the wine-patches mailing list; see
  96         http://www.winehq.com/dev.html#ml for more information.
  97
  98 CVS:    The current Wine development tree is available through CVS.
  99         Go to http://www.winehq.com/dev.html for more information.
 100
 101 FAQ:    The Wine FAQ is located at http://pw1.netcom.com/~dagar/wine.html.
 102
 103
 104 If you add something, or fix a bug, please send a patch ('diff -u'
 105 format preferred) to julliard@lrc.epfl.ch for inclusion in the next
 106 release.
 107
 108 --
 109 Alexandre Julliard
 110 julliard@lrc.epfl.ch