Wine is free software, released under the GNU LGPL; see the file
LICENSE for the details.
+
2. QUICK START
Whenever you compile from source, it is recommended to use the Wine
./tools/wineinstall
-Run programs as "wine [options] program". For more information and
-problem resolution, read the rest of this file, the Wine man page,
-the files in the documentation directory of the Wine source
-(see "DOCUMENTATION"), and especially the wealth of information
-found at http://www.winehq.com.
+Run programs as "wine program". For more information and problem
+resolution, read the rest of this file, the Wine man page, and
+especially the wealth of information found at http://www.winehq.org.
+
3. REQUIREMENTS
To compile and run Wine, you must have one of the following:
- Linux version 2.0.36 or above
- FreeBSD 4.x or FreeBSD 5-CURRENT
- Solaris x86 2.5 or later
- NetBSD-current
+ Linux version 2.0.36 or above
+ FreeBSD 5.3 or later
+ Solaris x86 2.5 or later
+ NetBSD-current
+ MacOS X 10.4 or later
+
+As Wine requires kernel-level thread support to run, only the operating
+systems mentioned above are supported.
+Other operating systems which support kernel threads may be supported
+in the future.
Linux info:
- Although Linux version 2.0.x will mostly work, certain features
- (specifically LDT sharing) required for properly supporting Win32
- threads were not implemented until kernel version 2.2. If you get
- consistent thread-related crashes, you may want to upgrade to at least 2.2.
- Also, some bugs were fixed and additional features were added
- late in the Linux 2.0.x series, so if you have a very old Linux kernel,
- you may want to upgrade to at least the latest 2.0.x release.
+ While Linux 2.2.x should still work and Linux 2.0.x may still work
+ (older 2.0.x versions had thread-related crashes),
+ it's best to have a current kernel such as 2.4.x or 2.6.x.
FreeBSD info:
- Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
- turned on in your kernel.
- More information including patches for the 4-STABLE branch is in the
- ports tree:
- ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/ports/emulators/wine/files/
+ Wine should build on FreeBSD 4.x and FreeBSD 5.x, but versions before
+ FreeBSD 5.3 will generally not work properly.
+
+ More information can be found in the FreeBSD ports tree at
+ <ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/>.
Solaris info:
You will most likely need to build Wine with the GNU toolchain
(gcc, gas, etc.). Warning : installing gas does *not* ensure that it
- will be used by gcc. Recompiling gcc after installing gas or
+ will be used by gcc. Recompiling gcc after installing gas or
symlinking cc, as and ld to the gnu tools is said to be necessary.
NetBSD info:
Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
turned on in your kernel.
-File systems info:
+MacOS info:
+ You need Xcode 2.4 or later to build properly on x86.
+
+
+Supported file systems:
Wine should run on most file systems. However, Wine will fail to start
if umsdos is used for the /tmp directory. A few compatibility problems have
also been reported using files accessed through Samba. Also, as NTFS
using NTFS, as Windows programs need write access almost everywhere.
In case of NTFS files, copy over to a writable location.
-Wine requires kernel-level threads to run. Currently, only Linux
-version 2.0 or later, FreeBSD-current or FreeBSD 3.0 or later,
-Solaris x86 version 2.5 or later, and NetBSD-current are supported.
-Other operating systems which support kernel threads may be supported
-in the future.
+Basic requirements:
+ You need to have the X11 development include files installed
+ (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
-You need to have the X11 development include files installed
-(called xlib6g-dev in Debian and XFree86-devel in RedHat).
-To use Wine's support for multi-threaded applications, your X libraries
-must be reentrant, which is probably the default by now.
-If you have libc6 (glibc2), or you compiled the X libraries yourself,
-they were probably compiled with the reentrant option enabled.
+Build tool requirements:
+ On x86 Systems gcc >= 2.7.2 is required.
+ Versions earlier than 2.7.2.3 may have problems when certain files
+ are compiled with optimization, often due to problems with header file
+ management.
-On x86 Systems gcc >= 2.7.2 is required.
-Versions earlier than 2.7.2.3 may have problems when certain files
-are compiled with optimization, often due to problems with header file
-management. pgcc currently doesn't work with Wine. The cause of this problem
-is unknown.
+ Of course you also need "make" (most likely GNU make).
-You also need flex version 2.5 or later and yacc.
-Bison will work as a replacement for yacc. If you are
-using RedHat or Debian, install the flex and bison packages.
+ You also need flex version 2.5 or later and bison.
+
+Optional support libraries:
+ Run ./configure --verbose to see the optional libraries that could
+ be used but aren't found on your system.
-For requirements in case you intend to build the documentation yourself,
-see "DOCUMENTATION" section.
4. COMPILATION
make depend
make
-This will build the program "wine" and numerous support libraries/binaries.
+This will build the program "wine" and numerous support libraries/binaries.
The program "wine" will load and run Windows executables.
The library "libwine" ("Winelib") can be used to compile and link
Windows source code under Unix.
top-level directory of the release (the one containing this README
file). Then do a "make clean", and patch the release with:
- gunzip -c patch-file | patch -p1
+ bunzip2 -c patch-file | patch -p1
where "patch-file" is the name of the patch file (something like
-Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
+wine-0.9.x.diff.bz2). You can then re-run "./configure", and then
run "make depend && make".
+
5. SETUP
Once Wine has been built correctly, you can do "make install"; this
first. Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
before installing.
-If you want to read the documentation supplied with the Wine source,
-see the "DOCUMENTATION" section.
-
-Wine requires a configuration file named named "config" in your
-~/.wine directory. The format of this file is explained in the config file
-man page (documentation/wine.conf.man).
-The file documentation/samples/config contains an example configuration file
-which has to be adapted and copied to the location mentioned above.
-
-Don't forget to add vital registry entries by applying winedefault.reg
-with programs/regapi/. See documentation/ directory for details.
-
-See http://www.winehq.com/support/ for further configuration hints.
+See the Support area at http://www.winehq.org/ for configuration
+hints.
In case of library loading errors
(e.g. "Error while loading shared libraries: libntdll.so"), make sure
to add the library path to /etc/ld.so.conf and run ldconfig as root.
-In order to verify the correctness of the environment you need for
-Wine to run successfully, you may run "./tools/winecheck | less".
-You'll get a percentage score indicating "Wine configuration correctness".
-As this program is alpha, it doesn't run a truly thorough test yet, though,
-so it should be taken as a first verification step only.
-
-See wine.conf man page on how to switch to text mode only support if desired.
6. RUNNING PROGRAMS
For example: to run Solitaire:
- wine sol (using the searchpath to locate the file)
- wine sol.exe
+ wine sol (using the search Path as specified in
+ wine sol.exe the config file to locate the file)
- wine c:\\windows\\sol.exe (using a DOS filename)
+ wine c:\\windows\\sol.exe (using DOS filename syntax)
- wine /usr/windows/sol.exe (using a Unix filename)
+ wine /usr/windows/sol.exe (using Unix filename syntax)
-Note: the path of the file will also be added to the path when
- a full name is supplied on the commandline.
+ wine sol.exe /parameter1 -parameter2 parameter3
+ (calling program with parameters)
-Wine is not yet complete, so several programs may crash. Provided you set up
-winedbg correctly according to documentation/debugger.sgml, you will be dropped
-into a debugger so that you can investigate and fix the problem.
-For more information on how to do this, please read the file
-documentation/debugging.sgml.
+Wine is not yet complete, so several programs may crash. In that crash
+you will be dropped into the debugger so that you can investigate and
+fix the problem. For more information on how to do this, please check
+the debugging section of the Wine Developer's Guide.
-You should backup all your important files that you give Wine access
-to, or use a special Wine copy of them, as there have been some cases
-of users reporting file corruption. Do NOT run Explorer, for instance,
-if you don't have a proper backup, as it renames/cripples several
-directories sometimes. Not even other MS apps such as e.g. Messenger are safe,
-as they launch Explorer somehow. This particular corruption (!$!$!$!$.pfr)
-can at least partially be fixed by using
-http://home.nexgo.de/andi.mohr/download/decorrupt_explorer
-7. DOCUMENTATION
-
-Some documentation (various Wine Guides etc.) can be found in the
-documentation/ directory (apart from also being available on WineHQ).
-
-If you want to process the SGML files in there, then you can run "make"
-in the documentation/ directory.
-Doing so requires the sgml tools package (for db2html, db2ps, db2pdf) named:
-Debian: docbook-utils
-Mandrake: sgml-tools-A.B.C-DDmdk
-SuSE: docbktls-A.BB.C-DD
-
-8. GETTING MORE INFORMATION
+7. GETTING MORE INFORMATION
WWW: A great deal of information about Wine is available from WineHQ at
- http://www.winehq.com/ : various Wine Guides, application database,
+ http://www.winehq.org/ : various Wine Guides, application database,
bug tracking. This is probably the best starting point.
-FAQ: The Wine FAQ is located at http://www.winehq.com/FAQ
+FAQ: The Wine FAQ is located at http://www.winehq.org/FAQ
Usenet: You can discuss Wine-related issues and get help
on comp.emulators.ms-windows.wine.
-Bugs: Report bugs to Wine Bugzilla at http://bugs.winehq.com/.
+Bugs: Report bugs to Wine Bugzilla at http://bugs.winehq.org
Please search the bugzilla database to check whether your
problem is already found before posting a bug report. You can
also post bug reports to comp.emulators.ms-windows.wine.
- Please read the file documentation/bugs.sgml to see what
- information is required.
-HOWTO: The Wine HOWTO (outdated !) is available at
- http://www.westfalen.de/witch/wine-HOWTO.txt .
+IRC: Online help is available at channel #WineHQ on irc.freenode.net.
-IRC: Online help is available at channel #WineHQ on irc.openprojects.net.
-
-CVS: The current Wine development tree is available through CVS.
- Go to http://www.winehq.com/development/ for more information.
+GIT: The current Wine development tree is available through GIT.
+ Go to http://www.winehq.org/site/git for more information.
Mailing lists:
- There are several mailing lists for Wine developers; see
- http://www.winehq.com/development/#ml for more information.
+ There are several mailing lists for Wine users and developers;
+ see http://www.winehq.org/forums for more information.
+
+Wiki: The Wine Wiki is located at http://wiki.winehq.org
If you add something, or fix a bug, please send a patch (in 'diff -u'
-format) to wine-patches@winehq.com list for inclusion in the next
+format) to wine-patches@winehq.org list for inclusion in the next
release.
--
Alexandre Julliard
-julliard@winehq.com
+julliard@winehq.org