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 program "wine" and numerous support libraries/binaries.
  73 The program "wine" will load and run Windows executables.
  74 The library "libwine" ("Winelib") can be used to compile and link
  75 Windows source code under Unix.
  76
  77 To see compile configuration options, do ./configure --help.
  78
  79 To upgrade to a new release by using a patch file, first cd to the
  80 top-level directory of the release (the one containing this README
  81 file). Then do a "make clean", and patch the release with:
  82
  83     gunzip -c patch-file | patch -p1
  84
  85 where "patch-file" is the name of the patch file (something like
  86 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
  87 run "make depend && make".
  88
  89
  90 5. SETUP
  91
  92 Once Wine has been built correctly, you can do "make install"; this
  93 will install the wine executable, the Wine man page, and a few other
  94 needed files.
  95
  96 Wine requires a configuration file named wine.conf. Its default
  97 location is /usr/local/etc, but you can supply a different name when
  98 configuring wine by using the --prefix or --sysconfdir options to
  99 ./configure. You can also override the global configuration file with
 100 a file named "config" in your ~/.wine directory.
 101
 102 The format of this file is explained in the man page. The file
 103 documentation/samples/config contains an example configuration file
 104 which has to be adapted and copied to one of the two locations
 105 mentioned above.
 106
 107 See http://www.winehq.com/config.html for further configuration hints.
 108
 109
 110 6. RUNNING PROGRAMS
 111
 112 When invoking Wine, you may specify the entire path to the executable,
 113 or a filename only.
 114
 115 For example: to run Solitaire:
 116
 117         wine sol                   (using the searchpath to locate the file)
 118         wine sol.exe
 119
 120         wine c:\\windows\\sol.exe  (using a DOS filename)
 121
 122         wine /usr/windows/sol.exe  (using a Unix filename)
 123
 124 Note: the path of the file will also be added to the path when
 125       a full name is supplied on the commandline.
 126
 127 Wine is not yet complete, so some programs may crash. Provided you set up
 128 winedbg correctly according to documentation/debugger.sgml, you will be dropped
 129 into a debugger so that you can investigate and fix the problem. For more
 130 information on how to do this, please read the file documentation/debugging.
 131 If you post a bug report, please read the file documentation/bugreports to
 132 see what information is required.
 133
 134 You should backup all your important files that you give Wine access
 135 to, or use a special Wine copy of them, as there have been some cases
 136 of users reporting file corruption. Do NOT run Explorer, for instance,
 137 if you don't have a proper backup, as it renames/cripples several
 138 directories sometimes.
 139
 140
 141 7. GETTING MORE INFORMATION
 142
 143 DOCU:   grep -i "SearchString" `find documentation/`|more
 144
 145 FAQ:    The Wine FAQ is located at http://www.winehq.com/faq.html.
 146
 147 WWW:    A great deal of information about Wine is available from WineHQ at
 148         http://www.winehq.com/. Untested patches against the current release
 149         are available on the wine-patches mailing list; see
 150         http://www.winehq.com/dev.shtml#ml for more information.
 151
 152 HOWTO:  The Wine HOWTO is available at
 153         http://www.westfalen.de/witch/wine-HOWTO.txt .
 154
 155 Usenet: Please browse old messages on http://www.dejanews.com/ to check whether
 156         your problem is already fixed before posting a bug report to the
 157         newsgroup.
 158
 159         The best place to get help or to report bugs is the Usenet newsgroup
 160         comp.emulators.ms-windows.wine. Please read the file
 161         documentation/bugreports to see what information should be included
 162         in a bug report.
 163
 164 IRC:    Online help is available at channel #WineHQ on IRCnet.
 165
 166 CVS:    The current Wine development tree is available through CVS.
 167         Go to http://www.winehq.com/dev.shtml for more information.
 168
 169 If you add something, or fix a bug, please send a patch ('diff -u'
 170 format preferred) to julliard@winehq.com for inclusion in the next
 171 release.
 172
 173 --
 174 Alexandre Julliard
 175 julliard@winehq.com