Correct tests involved with processing the LVIF_DI_SETITEM flag.
[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 (called Winelib) that implements Windows
7 API calls using their Unix or X11 equivalents.  The library may also
8 be used for 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 man page,
24 the files in the documentation directory in the Wine source
25 (see "DOCUMENTATION"), and especially the wealth of information
26 found at http://www.winehq.com.
27
28 3. REQUIREMENTS
29
30 To compile and run Wine, you must have one of the following:
31
32         Linux version 2.0.36 or above
33         FreeBSD 4.x or FreeBSD 5-CURRENT
34         Solaris x86 2.5 or later
35         NetBSD-current
36
37 Linux info:
38   Although Linux version 2.0.x will mostly work, certain features
39   (specifically LDT sharing) required for properly supporting Win32
40   threads were not implemented until kernel version 2.2.  If you get
41   consistent thread-related crashes, you may want to upgrade to 2.2.
42   Also, some bugs were fixed and additional features were added
43   late in the Linux 2.0.x series, so if you have a very old Linux kernel,
44   you may want to upgrade to at least the latest 2.0.x release.
45
46 FreeBSD info:
47   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
48   turned on in your kernel.
49   More information including patches for the 4-STABLE branch is in the
50   ports tree:
51   ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/ports/emulators/wine/files/
52
53 Solaris info:
54   You will most likely need to build Wine with the GNU toolchain
55   (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
56   will be used by gcc. Recompiling gcc after installing gas or 
57   symlinking cc, as and ld to the gnu tools is said to be necessary.
58
59 NetBSD info:
60   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
61   turned on in your kernel.
62
63 File systems info:
64   Wine should run on most file systems. However, Wine will fail to start
65   if umsdos is used for the /tmp directory. A few compatibility problems have
66   also been reported using files accessed through Samba.
67
68 Wine requires kernel-level threads to run. Currently, only Linux
69 version 2.0 or later, FreeBSD-current or FreeBSD 3.0 or later,
70 Solaris x86 version 2.5 or later, and NetBSD-current are supported.
71 Other operating systems which support kernel threads may be supported
72 in the future.
73
74 You need to have the X11 development include files installed
75 (called xlib6g-dev in Debian and XFree86-devel in RedHat).
76 To use Wine's support for multi-threaded applications, your X libraries
77 must be reentrant, which is probably the default by now.
78 If you have libc6 (glibc2), or you compiled the X libraries yourself,
79 they were probably compiled with the reentrant option enabled.
80
81 On x86 Systems gcc >= 2.7.2 is required.
82 Versions earlier than 2.7.2.3 may have problems when certain files
83 are compiled with optimization, often due to problems with header file
84 management. pgcc currently doesn't work with Wine. The cause of this problem
85 is unknown.
86
87 You also need flex version 2.5 or later and yacc.
88 Bison will work as a replacement for yacc. If you are
89 using RedHat or Debian, install the flex and bison packages.
90
91 For requirements in case you intend to build the documentation yourself,
92 see "DOCUMENTATION" section.
93
94 4. COMPILATION
95
96 In case you chose to not use wineinstall, run the following commands
97 to build Wine:
98
99 ./configure
100 make depend
101 make
102
103 This will build the program "wine" and numerous support libraries/binaries.  
104 The program "wine" will load and run Windows executables.
105 The library "libwine" ("Winelib") can be used to compile and link
106 Windows source code under Unix.
107
108 To see compile configuration options, do ./configure --help.
109
110 To upgrade to a new release by using a patch file, first cd to the
111 top-level directory of the release (the one containing this README
112 file). Then do a "make clean", and patch the release with:
113
114     gunzip -c patch-file | patch -p1
115
116 where "patch-file" is the name of the patch file (something like
117 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
118 run "make depend && make".
119
120 5. SETUP
121
122 Once Wine has been built correctly, you can do "make install"; this
123 will install the wine executable, the Wine man page, and a few other
124 needed files.
125
126 Don't forget to uninstall any conflicting previous Wine installation
127 first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
128 before installing.
129
130 If you want to read the documentation supplied with the Wine source,
131 then see the "DOCUMENTATION" section.
132
133 Wine requires a configuration file named named "config" in your
134 ~/.wine directory. The format of this file is explained in the config file
135 man page (documentation/wine.conf.man).
136 The file documentation/samples/config contains an example configuration file
137 which has to be adapted and copied to the location mentioned above.
138
139 Don't forget to add vital registry entries by applying winedefault.reg
140 with programs/regapi/. See documentation/ for details.
141
142 See http://www.winehq.com/support.shtml for further configuration hints.
143
144 In order to verify the correctness of the environment you need for
145 Wine to run successfully, run "./tools/winecheck | less".  You'll get
146 a percentage score indicating "Wine configuration correctness".
147 As this program is alpha, it doesn't run a truly thorough test yet, though,
148 so it should be taken as a first verification step only.
149
150 6. RUNNING PROGRAMS
151
152 When invoking Wine, you may specify the entire path to the executable,
153 or a filename only.
154
155 For example: to run Solitaire:
156
157         wine sol                   (using the searchpath to locate the file)
158         wine sol.exe
159
160         wine c:\\windows\\sol.exe  (using a DOS filename)
161
162         wine /usr/windows/sol.exe  (using a Unix filename)
163
164 Note: the path of the file will also be added to the path when
165       a full name is supplied on the commandline.
166
167 Wine is not yet complete, so several programs may crash. Provided you set up
168 winedbg correctly according to documentation/debugger.sgml, you will be dropped
169 into a debugger so that you can investigate and fix the problem. For more
170 information on how to do this, please read the file documentation/debugging.
171 If you post a bug report, please read the file documentation/bugreports to
172 see what information is required.
173
174 You should backup all your important files that you give Wine access
175 to, or use a special Wine copy of them, as there have been some cases
176 of users reporting file corruption. Do NOT run Explorer, for instance,
177 if you don't have a proper backup, as it renames/cripples several
178 directories sometimes. Not even other MS apps such as e.g. Messenger are safe,
179 as they launch Explorer somehow. This particular corruption (!$!$!$!$.pfr)
180 can at least partially be fixed by using
181 http://home.nexgo.de/andi.mohr/download/decorrupt_explorer
182
183 7. DOCUMENTATION
184
185 Some documentation (various Wine Guides etc.) can be found in the
186 documentation/ directory (apart from also being available on WineHQ).
187
188 If you want to process the SGML files in there, then you can run "make"
189 in the documentation/ directory.
190 Doing so requires the sgml tools package (for db2html, db2ps, db2pdf) named:
191 Debian:         docbook-utils
192 Mandrake:       sgml-tools-A.B.C-DDmdk
193 SuSE:           docbktls-A.BB.C-DD
194
195 8. GETTING MORE INFORMATION
196
197 WWW:    A great deal of information about Wine is available from WineHQ at
198         http://www.winehq.com/ : various Wine Guides, application database,
199         bug tracking. This is probably the best starting point.
200
201 FAQ:    The Wine FAQ is located at http://www.winehq.com/FAQ
202
203 HOWTO:  The Wine HOWTO (outdated !) is available at
204         http://www.westfalen.de/witch/wine-HOWTO.txt .
205
206 Usenet: The best place to get help or to report bugs is the Usenet newsgroup
207         comp.emulators.ms-windows.wine. Please read the file 
208         documentation/bugreports to see what information should be included 
209         in a bug report.
210
211         Please browse old messages on http://groups.google.com/ to check
212         whether your problem is already fixed before posting a bug report
213         to the newsgroup. 
214
215 IRC:    Online help is available at channel #WineHQ on irc.openprojects.net.
216
217 CVS:    The current Wine development tree is available through CVS.
218         Go to http://www.winehq.com/dev.shtml for more information.
219
220 Mailing lists:
221         There are several mailing lists for Wine developers; see 
222         http://www.winehq.com/dev.shtml#ml for more information.
223
224 If you add something, or fix a bug, please send a patch (in 'diff -u'
225 format) to julliard@winehq.com or to the wine-patches@winehq.com
226 mailing list for inclusion in the next release.
227
228 --
229 Alexandre Julliard
230 julliard@winehq.com