Small lighting fix.
[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.com.
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 4.x or FreeBSD 5-CURRENT 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   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG
48   options turned on in your kernel.  More information is in the ports
49   tree: ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/
50
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.
56
57 NetBSD info:
58   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
59   turned on in your kernel.
60
61
62
63 Supported file systems:
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. Also, as NTFS
67   can only be used safely with readonly access for now, we recommend against
68   using NTFS, as Windows programs need write access almost everywhere.
69   In case of NTFS files, copy over to a writable location.
70
71 Basic requirements:
72   You need to have the X11 development include files installed
73   (called xlib6g-dev in Debian and XFree86-devel in RedHat).
74
75 Build tool requirements:
76   On x86 Systems gcc >= 2.7.2 is required.
77   Versions earlier than 2.7.2.3 may have problems when certain files
78   are compiled with optimization, often due to problems with header file
79   management. pgcc currently doesn't work with Wine. The cause of this problem
80   is unknown.
81
82   Of course you also need "make" (most likely GNU make).
83
84   You also need flex version 2.5 or later and yacc.
85   Bison will work as a replacement for yacc. If you are
86   using RedHat or Debian, install the flex and bison packages.
87
88 Optional support libraries:
89   If you want CUPS printing support, please install both cups and cups-devel
90   packages.
91
92   For the automatic processing of the test suite scripts, you also need
93   libperl development header support (libperl-dev package on Debian).
94
95 For requirements in case you intend to build the documentation yourself,
96 see "DOCUMENTATION" section.
97
98 4. COMPILATION
99
100 In case you chose to not use wineinstall, run the following commands
101 to build Wine:
102
103 ./configure
104 make depend
105 make
106
107 This will build the program "wine" and numerous support libraries/binaries.
108 The program "wine" will load and run Windows executables.
109 The library "libwine" ("Winelib") can be used to compile and link
110 Windows source code under Unix.
111
112 To see compile configuration options, do ./configure --help.
113
114 To upgrade to a new release by using a patch file, first cd to the
115 top-level directory of the release (the one containing this README
116 file). Then do a "make clean", and patch the release with:
117
118     gunzip -c patch-file | patch -p1
119
120 where "patch-file" is the name of the patch file (something like
121 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
122 run "make depend && make".
123
124 5. SETUP
125
126 Once Wine has been built correctly, you can do "make install"; this
127 will install the wine executable, the Wine man page, and a few other
128 needed files.
129
130 Don't forget to uninstall any conflicting previous Wine installation
131 first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
132 before installing.
133
134 If you want to read the documentation supplied with the Wine source,
135 see the "DOCUMENTATION" section.
136
137 Wine requires a configuration file named named "config" in your
138 ~/.wine directory. The format of this file is explained in the config file
139 man page (documentation/wine.conf.man).
140 The file documentation/samples/config contains an example configuration file
141 which has to be adapted and copied to the location mentioned above.
142
143 Don't forget to add vital registry entries by applying winedefault.reg
144 with programs/regedit/. See documentation/ directory for details.
145
146 See the Support area at http://www.winehq.com/ for further
147 configuration hints.
148
149 In case of library loading errors
150 (e.g. "Error while loading shared libraries: libntdll.so"), make sure
151 to add the library path to /etc/ld.so.conf and run ldconfig as root.
152
153 In order to verify the correctness of the environment you need for
154 Wine to run successfully, you may run "./tools/winecheck | less".
155 You'll get a percentage score indicating "Wine configuration correctness".
156 As this program is alpha, it doesn't run a truly thorough test yet, though,
157 so it should be taken as a first verification step only.
158
159 See wine.conf man page on how to switch to text mode only support if desired.
160
161 6. RUNNING PROGRAMS
162
163 When invoking Wine, you may specify the entire path to the executable,
164 or a filename only.
165
166 For example: to run Solitaire:
167
168         wine sol                   (using the search Path as specified in
169         wine sol.exe                the config file to locate the file)
170
171         wine c:\\windows\\sol.exe  (using DOS filename syntax)
172
173         wine /usr/windows/sol.exe  (using Unix filename syntax)
174
175         wine -- sol.exe /parameter1 -parameter2 parameter3
176                                    (calling program with parameters)
177
178 Note: the path of the file will also be added to the path when
179       a full name is supplied on the commandline.
180
181 Wine is not yet complete, so several programs may crash. Provided you set up
182 winedbg correctly according to documentation/debugger.sgml, you will be dropped
183 into a debugger so that you can investigate and fix the problem.
184 For more information on how to do this, please read the file
185 documentation/debugging.sgml.
186
187 You should backup all your important files that you give Wine access
188 to, or use a special Wine copy of them, as there have been some cases
189 of users reporting file corruption. Do NOT run Explorer, for instance,
190 if you don't have a proper backup, as it renames/cripples several
191 directories sometimes. Not even other MS apps such as e.g. Messenger are safe,
192 as they launch Explorer somehow. This particular corruption (!$!$!$!$.pfr)
193 can at least partially be fixed by using
194 http://home.nexgo.de/andi.mohr/download/decorrupt_explorer
195
196 7. DOCUMENTATION
197
198 Some documentation (various Wine Guides etc.) can be found in the
199 documentation/ directory (apart from also being available on WineHQ).
200
201 If you want to process the SGML files in there, then you can run "make doc"
202 in the documentation/ directory.
203 Doing so requires the sgml tools package (for db2html, db2ps, db2pdf) named:
204 Debian:         docbook-utils
205 Mandrake:       sgml-tools-A.B.C-DDmdk
206 SuSE:           docbktls-A.BB.C-DD
207
208 8. GETTING MORE INFORMATION
209
210 WWW:    A great deal of information about Wine is available from WineHQ at
211         http://www.winehq.com/ : various Wine Guides, application database,
212         bug tracking. This is probably the best starting point.
213
214 FAQ:    The Wine FAQ is located at http://www.winehq.com/FAQ
215
216 Usenet: You can discuss Wine-related issues and get help
217         on comp.emulators.ms-windows.wine.
218
219 Bugs:   Report bugs to Wine Bugzilla at http://bugs.winehq.com
220         Please search the bugzilla database to check whether your
221         problem is already found before posting a bug report.  You can
222         also post bug reports to comp.emulators.ms-windows.wine.
223         Please read the file documentation/bugs.sgml to see what
224         information is required.
225
226 IRC:    Online help is available at channel #WineHQ on irc.freenode.net.
227
228 CVS:    The current Wine development tree is available through CVS.
229         Go to http://www.winehq.com/cvs for more information.
230
231 Mailing lists:
232         There are several mailing lists for Wine developers; see
233         http://www.winehq.com/forums for more information.
234
235 If you add something, or fix a bug, please send a patch (in 'diff -u'
236 format) to wine-patches@winehq.com list for inclusion in the next
237 release.
238
239 --
240 Alexandre Julliard
241 julliard@winehq.com