Handle 0 length buffers in MSI_FormatRecordW.
[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, released under the GNU LGPL; see the file
11 LICENSE for the details.
12
13 2. QUICK START
14
15 Whenever you compile from source, it is recommended to use the Wine
16 Installer to build and install Wine.  From the top-level directory
17 of the Wine source (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 man page,
23 the files in the documentation directory of the Wine source
24 (see "DOCUMENTATION"), and especially the wealth of information
25 found at http://www.winehq.org.
26
27 3. REQUIREMENTS
28
29 To compile and run Wine, you must have one of the following:
30
31   Linux version 2.0.36 or above
32   FreeBSD 5.3 or later
33   Solaris x86 2.5 or later
34   NetBSD-current
35
36 As Wine requires kernel-level thread support to run, only the operating
37 systems mentioned above are supported.
38 Other operating systems which support kernel threads may be supported
39 in the future.
40
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.
45
46 FreeBSD info:
47   Wine should build on FreeBSD 4.x and FreeBSD 5.x, but versions before
48   FreeBSD 5.3 will generally not work properly.
49  
50   More information can be found in the FreeBSD ports tree at
51   <ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/>.
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
64
65 Supported file systems:
66   Wine should run on most file systems. However, Wine will fail to start
67   if umsdos is used for the /tmp directory. A few compatibility problems have
68   also been reported using files accessed through Samba. Also, as NTFS
69   can only be used safely with readonly access for now, we recommend against
70   using NTFS, as Windows programs need write access almost everywhere.
71   In case of NTFS files, copy over to a writable location.
72
73 Basic requirements:
74   You need to have the X11 development include files installed
75   (called xlib6g-dev in Debian and XFree86-devel in RedHat).
76
77 Build tool requirements:
78   On x86 Systems gcc >= 2.7.2 is required.
79   Versions earlier than 2.7.2.3 may have problems when certain files
80   are compiled with optimization, often due to problems with header file
81   management. pgcc currently doesn't work with Wine. The cause of this problem
82   is unknown.
83
84   Of course you also need "make" (most likely GNU make).
85
86   You also need flex version 2.5 or later and bison.  If you are
87   using RedHat or Debian, install the flex and bison packages.
88
89 Optional support libraries:
90   If you want CUPS printing support, please install both cups and cups-devel
91   packages.
92
93 For requirements in case you intend to build the documentation yourself,
94 see "DOCUMENTATION" section.
95
96 4. COMPILATION
97
98 In case you chose to not use wineinstall, run the following commands
99 to build Wine:
100
101 ./configure
102 make depend
103 make
104
105 This will build the program "wine" and numerous support libraries/binaries.
106 The program "wine" will load and run Windows executables.
107 The library "libwine" ("Winelib") can be used to compile and link
108 Windows source code under Unix.
109
110 To see compile configuration options, do ./configure --help.
111
112 To upgrade to a new release by using a patch file, first cd to the
113 top-level directory of the release (the one containing this README
114 file). Then do a "make clean", and patch the release with:
115
116     gunzip -c patch-file | patch -p1
117
118 where "patch-file" is the name of the patch file (something like
119 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
120 run "make depend && make".
121
122 5. SETUP
123
124 Once Wine has been built correctly, you can do "make install"; this
125 will install the wine executable, the Wine man page, and a few other
126 needed files.
127
128 Don't forget to uninstall any conflicting previous Wine installation
129 first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
130 before installing.
131
132 If you want to read the documentation supplied with the Wine source,
133 see the "DOCUMENTATION" section.
134
135 Wine requires a configuration file named named "config" in your
136 ~/.wine directory. The format of this file is explained in the config file
137 man page (documentation/wine.conf.man).
138 The file documentation/samples/config contains an example configuration file
139 which has to be adapted and copied to the location mentioned above.
140
141 See the Support area at http://www.winehq.org/ for further
142 configuration hints.
143
144 In case of library loading errors
145 (e.g. "Error while loading shared libraries: libntdll.so"), make sure
146 to add the library path to /etc/ld.so.conf and run ldconfig as root.
147
148 6. RUNNING PROGRAMS
149
150 When invoking Wine, you may specify the entire path to the executable,
151 or a filename only.
152
153 For example: to run Solitaire:
154
155         wine sol                   (using the search Path as specified in
156         wine sol.exe                the config file to locate the file)
157
158         wine c:\\windows\\sol.exe  (using DOS filename syntax)
159
160         wine /usr/windows/sol.exe  (using Unix filename syntax)
161
162         wine sol.exe /parameter1 -parameter2 parameter3
163                                    (calling program with parameters)
164
165 Note: the path of the file will also be added to the path when
166       a full name is supplied on the commandline.
167
168 Wine is not yet complete, so several programs may crash. Provided you set up
169 winedbg correctly according to documentation/debugger.sgml, you will be dropped
170 into a debugger so that you can investigate and fix the problem.
171 For more information on how to do this, please read the file
172 documentation/debugging.sgml.
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 doc"
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.org/ : 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.org/FAQ
202
203 Usenet: You can discuss Wine-related issues and get help
204         on comp.emulators.ms-windows.wine.
205
206 Bugs:   Report bugs to Wine Bugzilla at http://bugs.winehq.org
207         Please search the bugzilla database to check whether your
208         problem is already found before posting a bug report.  You can
209         also post bug reports to comp.emulators.ms-windows.wine.
210         Please read the file documentation/bugs.sgml to see what
211         information is required.
212
213 IRC:    Online help is available at channel #WineHQ on irc.freenode.net.
214
215 CVS:    The current Wine development tree is available through CVS.
216         Go to http://www.winehq.org/cvs for more information.
217
218 Mailing lists:
219         There are several mailing lists for Wine developers; see
220         http://www.winehq.org/forums for more information.
221
222 If you add something, or fix a bug, please send a patch (in 'diff -u'
223 format) to wine-patches@winehq.org list for inclusion in the next
224 release.
225
226 --
227 Alexandre Julliard
228 julliard@winehq.org