Correctly implement ACM_STREAMOPENF_QUERY flag in acmOpenStream.
[wine] / 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 For the impatient, use the Wine Installer to build and install wine.
17 From the top-level Wine directory (which contains this file), run:
18
19 ./tools/wineinstall
20
21 Run programs as "wine [options] program".  For more information and
22 problem resolution, read the rest of this file, the Wine manpage,
23 and the files in the documentation directory in the Wine source.
24
25 3. REQUIREMENTS
26
27 To compile and run Wine, you must have one of the following:
28
29         Linux version 2.0.36 or above
30         FreeBSD-current or FreeBSD 3.0 or later
31         Solaris x86 2.5 or later
32
33 Although Linux version 2.0.x will mostly work, certain features
34 (specifically LDT sharing) required for properly supporting Win32
35 threads were not implemented until kernel version 2.2.  If you get
36 consistent thread-related crashes, you may want to upgrade to 2.2.
37
38 Similarly if you are on FreeBSD you may want to apply an LDT sharing
39 patch too (unfortunately this one still isn't in the tree, neither
40 -current nor -stable), and there also is a small sigtrap fix thats
41 needed for wine's debugger. (Actually now that its using ptrace() by
42 default it may no longer make a difference but it still doesn't hurt...)
43 And if you're running a system from the -stable branch older than
44 Nov 15 1999, like a 3.3-RELEASE, then you also need to apply a signal
45 handling change that was MFC'd at that date.  More information including
46 patches for the -stable branch is in the ports tree:
47 ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/ports/emulators/wine/files/
48 (the signal handling patch, patch-3.3-sys-fsgs, and the latest README
49 haven't yet been committed as i write this, if they still aren't there
50 when you look, go here:
51 http://www.jelal.kn-bremen.de/freebsd/ports/emulators/wine/files/ )
52
53 You also need to have libXpm installed on your system. The sources for
54 it are available at ftp.x.org and all its mirror sites in the directory
55 /contrib/libraries. If you are using RedHat, libXpm is distributed as the
56 xpm and xpm-devel packages. Debian distributes libXpm as xpm4.7, xpm4g,
57 and xpm4g-dev 3.4j. SuSE calls these packages xpm and xpm-devel.
58
59 On x86 Systems gcc >= 2.7.2 is required. You also need flex version 2.5
60 or later and yacc. Bison will work as a replacement for yacc. If you are
61 using RedHat, install the flex and bison packages.
62
63 4. COMPILATION
64
65 To build Wine, run the following commands:
66
67 ./configure
68 make depend
69 make
70
71 This will build the library "libwine.a" and the program "wine".  
72 The program "wine" will load and run Windows executables.
73 The library "libwine.a" can be used to compile and link Windows source
74 code under Unix.
75
76 If you do not intend to compile Windows source code, use
77 "./configure --disable-lib" to skip building the library and reduce disk
78 space requirements. If you have an ELF compiler (which you probably do),
79 you can use "./configure --enable-dll" to build a shared library instead.
80 To see other configuration options, do ./configure --help.
81
82 To upgrade to a new release by using a patch file, first cd to the
83 top-level directory of the release (the one containing this README
84 file). Then do a "make clean", and patch the release with:
85
86     gunzip -c patch-file | patch -p1
87
88 where "patch-file" is the name of the patch file (something like
89 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
90 run "make depend && make".
91
92
93 5. SETUP
94
95 Once Wine has been built correctly, you can do "make install"; this
96 will install the wine executable, the Wine man page, and a few other
97 needed files.
98
99 Wine requires a configuration file named wine.conf. Its default location is
100 /usr/local/etc, but you can supply a different name when configuring wine by
101 using the --prefix or --sysconfdir options to ./configure. You can also override
102 the global configuration file with a .winerc file in your home directory.
103
104 The format of this file is explained in the man page. The file
105 wine.ini contains an example configuration file which has to be adapted
106 and copied to one of the two locations mentioned above.
107
108 See http://www.winehq.com/config.html for further configuration hints.
109
110
111 6. RUNNING PROGRAMS
112
113 When invoking Wine, you may specify the entire path to the executable,
114 or a filename only.
115
116 For example: to run Solitaire:
117
118         wine sol                   (using the searchpath to locate the file)
119         wine sol.exe
120
121         wine c:\\windows\\sol.exe  (using a DOS filename)
122
123         wine /usr/windows/sol.exe  (using a Unix filename)
124
125 Note: the path of the file will also be added to the path when
126       a full name is supplied on the commandline.
127
128 Wine is not yet complete, so some programs may crash. 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
135 7. GETTING MORE INFORMATION
136
137 FAQ:    The Wine FAQ is located at http://www.winehq.com/faq.html.
138
139 WWW:    A great deal of information about Wine is available from WineHQ at
140         http://www.winehq.com/. Untested patches against the current release
141         are available on the wine-patches mailing list; see 
142         http://www.winehq.com/dev.html#ml for more information.
143
144 HOWTO:  A pre-release version of the Wine HOWTO is available at
145         http://www.westfalen.de/witch/wine-HOWTO.txt .
146
147 Usenet: Please browse old messages on http://www.dejanews.com/ to check whether 
148         your problem is already fixed before posting a bug report to the 
149         newsgroup. 
150
151         The best place to get help or to report bugs is the Usenet newsgroup
152         comp.emulators.ms-windows.wine. Please read the file 
153         documentation/bugreports to see what information should be included 
154         in a bug report.
155
156 CVS:    The current Wine development tree is available through CVS.
157         Go to http://www.winehq.com/dev.html for more information.
158
159 If you add something, or fix a bug, please send a patch ('diff -u'
160 format preferred) to julliard@lrc.epfl.ch for inclusion in the next
161 release.
162
163 --
164 Alexandre Julliard
165 julliard@lrc.epfl.ch