winecoreaudio: Fix a leak.
[wine/multimedia.git] / README
blobbaa6ab31bf4082ae09a59fb08236a88984b36a62
1 1. INTRODUCTION
3 Wine is a program which allows running Microsoft Windows programs
4 (including DOS, Windows 3.x, Win32, and Win64 executables) on Unix.
5 It consists of a program loader which loads and executes a Microsoft
6 Windows binary, and a library (called Winelib) that implements Windows
7 API calls using their Unix or X11 equivalents.  The library may also
8 be used for porting Windows code into native Unix executables.
10 Wine is free software, released under the GNU LGPL; see the file
11 LICENSE for the details.
14 2. QUICK START
16 Whenever you compile from source, it is recommended to use the Wine
17 Installer to build and install Wine.  From the top-level directory
18 of the Wine source (which contains this file), run:
20 ./tools/wineinstall
22 Run programs as "wine program".  For more information and problem
23 resolution, read the rest of this file, the Wine man page, and
24 especially the wealth of information found at http://www.winehq.org.
27 3. REQUIREMENTS
29 To compile and run Wine, you must have one of the following:
31   Linux version 2.0.36 or above
32   FreeBSD 6.3 or later
33   Solaris x86 9 or later
34   NetBSD-current
35   Mac OS X 10.4 or later
37 As Wine requires kernel-level thread support to run, only the operating
38 systems mentioned above are supported.  Other operating systems which
39 support kernel threads may be supported in the future.
41 Linux info:
42   While Linux 2.2.x should still work and Linux 2.0.x may still work
43   (older 2.0.x versions had thread-related crashes),
44   it's best to have a current kernel such as 2.4.x or 2.6.x.
46 FreeBSD info:
47   Wine will generally not work properly on versions before FreeBSD
48   6.3 or 7.0, and FreeBSD 6.3 has additional patches available. See
49   http://wiki.freebsd.org/Wine for more information.
51 Solaris info:
52   You will most likely need to build Wine with the GNU toolchain
53   (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
54   will be used by gcc. Recompiling gcc after installing gas or
55   symlinking cc, as and ld to the gnu tools is said to be necessary.
57 NetBSD info:
58   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
59   turned on in your kernel.
61 Mac OS X info:
62   You need Xcode 2.4 or later to build properly on x86.
65 Supported file systems:
66   Wine should run on most file systems. A few compatibility problems
67   have also been reported using files accessed through Samba. Also,
68   NTFS does not provide all the file system features needed by some
69   applications.  Using a native Linux file system such as ext3 is
70   recommended.
72 Basic requirements:
73   You need to have the X11 development include files installed
74   (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
76   Of course you also need "make" (most likely GNU make).
78   You also need flex version 2.5.33 or later and bison.
80 Optional support libraries:
81   Configure will display notices when optional libraries are not found
82   on your system. See http://wiki.winehq.org/Recommended_Packages for
83   hints about the packages you should install.
85   On 64-bit platforms, if compiling Wine as 32-bit (default), you have
86   to make sure to install the 32-bit versions of these libraries; see
87   http://wiki.winehq.org/WineOn64bit for details. If you want a true
88   64-bit Wine (or a mixed 32-bit and 64-bit Wine setup), see
89   http://wiki.winehq.org/Wine64 for details.
91 4. COMPILATION
93 In case you chose to not use wineinstall, run the following commands
94 to build Wine:
96 ./configure
97 make
99 This will build the program "wine" and numerous support libraries/binaries.
100 The program "wine" will load and run Windows executables.
101 The library "libwine" ("Winelib") can be used to compile and link
102 Windows source code under Unix.
104 To see compile configuration options, do ./configure --help.
106 5. SETUP
108 Once Wine has been built correctly, you can do "make install"; this
109 will install the wine executable and libraries, the Wine man page, and
110 other needed files.
112 Don't forget to uninstall any conflicting previous Wine installation
113 first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
114 before installing.
116 Once installed, you can run the "winecfg" configuration tool. See the
117 Support area at http://www.winehq.org/ for configuration hints.
120 6. RUNNING PROGRAMS
122 When invoking Wine, you may specify the entire path to the executable,
123 or a filename only.
125 For example: to run Notepad:
127     wine notepad            (using the search Path as specified in
128     wine notepad.exe         the registry to locate the file)
130     wine c:\\windows\\notepad.exe      (using DOS filename syntax)
132     wine ~/.wine/drive_c/windows/notepad.exe  (using Unix filename syntax)
134     wine notepad.exe readme.txt          (calling program with parameters)
136 Wine is not perfect, so some programs may crash. If that happens you
137 will get a crash log that you should attach to your report when filing
138 a bug.
141 7. GETTING MORE INFORMATION
143 WWW:    A great deal of information about Wine is available from WineHQ at
144         http://www.winehq.org/ : various Wine Guides, application database,
145         bug tracking. This is probably the best starting point.
147 FAQ:    The Wine FAQ is located at http://www.winehq.org/FAQ
149 Wiki:   The Wine Wiki is located at http://wiki.winehq.org
151 Mailing lists:
152         There are several mailing lists for Wine users and developers;
153         see http://www.winehq.org/forums for more information.
155 Bugs:   Report bugs to Wine Bugzilla at http://bugs.winehq.org
156         Please search the bugzilla database to check whether your
157         problem is already known or fixed before posting a bug report.
159 IRC:    Online help is available at channel #WineHQ on irc.freenode.net.
161 Git:    The current Wine development tree is available through Git.
162         Go to http://www.winehq.org/git for more information.
164 If you add something, or fix a bug, please send a patch (preferably
165 using git-format-patch) to the wine-patches@winehq.org list for
166 inclusion in the next release.
169 Alexandre Julliard
170 julliard@winehq.org