richedit: Modify ME_GetTextW() to honor CR and LF encodings.
[wine] / README
CommitLineData
3a5816f8
AJ
11. INTRODUCTION
2
692389d0
DR
3Wine is a program which allows running Microsoft Windows programs
4(including DOS, Windows 3.x and Win32 executables) on Unix. It
0ff60a08 5consists of a program loader which loads and executes a Microsoft
3d2a38cf
AM
6Windows binary, and a library (called Winelib) that implements Windows
7API calls using their Unix or X11 equivalents. The library may also
8be used for porting Win32 code into native Unix executables.
3a5816f8 9
89894ffc
MG
10Wine is free software, released under the GNU LGPL; see the file
11LICENSE for the details.
3a5816f8 12
4e474034 13
d6baf1bb 142. QUICK START
3a5816f8 15
581fc926 16Whenever you compile from source, it is recommended to use the Wine
a0ff2b4a
AM
17Installer to build and install Wine. From the top-level directory
18of the Wine source (which contains this file), run:
d6baf1bb
AJ
19
20./tools/wineinstall
21
4e474034
AJ
22Run programs as "wine program". For more information and problem
23resolution, read the rest of this file, the Wine man page, and
12f9bb7a 24especially the wealth of information found at http://www.winehq.org.
d6baf1bb 25
4e474034 26
d6baf1bb 273. REQUIREMENTS
401710d7 28
0ff60a08 29To compile and run Wine, you must have one of the following:
f41aeca9 30
c08b948f 31 Linux version 2.0.36 or above
fef243cd 32 FreeBSD 6.2 or later
c08b948f
AM
33 Solaris x86 2.5 or later
34 NetBSD-current
bb8e625b 35 Mac OS X 10.4 or later
c08b948f
AM
36
37As Wine requires kernel-level thread support to run, only the operating
fef243cd
GP
38systems mentioned above are supported. Other operating systems which
39support kernel threads may be supported in the future.
f41aeca9 40
c9ec8846 41Linux info:
c08b948f
AM
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),
4fe7ee8c 44 it's best to have a current kernel such as 2.4.x or 2.6.x.
c9ec8846
AM
45
46FreeBSD info:
3f4c41b9
AE
47 Wine should build on FreeBSD 5.x, but versions before FreeBSD 7.0 will
48 generally not work properly. FreeBSD 6.3 has patches available to allow
49 Wine to run. See <http://wiki.freebsd.org/Wine> for more information.
a93fb4a0
GP
50
51 More information can be found in the FreeBSD ports tree at
52 <ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/>.
c9ec8846
AM
53
54Solaris info:
d2b22894 55 You will most likely need to build Wine with the GNU toolchain
2895e7f4 56 (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
a5589d56 57 will be used by gcc. Recompiling gcc after installing gas or
2895e7f4
GP
58 symlinking cc, as and ld to the gnu tools is said to be necessary.
59
9048c49b
BJY
60NetBSD info:
61 Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
62 turned on in your kernel.
63
bb8e625b 64Mac OS X info:
4e474034 65 You need Xcode 2.4 or later to build properly on x86.
c08b948f
AM
66
67
68Supported file systems:
2895e7f4
GP
69 Wine should run on most file systems. However, Wine will fail to start
70 if umsdos is used for the /tmp directory. A few compatibility problems have
3f4c41b9
AE
71 also been reported using files accessed through Samba. Also, NTFS does not
72 provide all the file system features needed by some applications.
73 Using a native Linux file system such as ext3 is recommended.
c9ec8846 74
c08b948f
AM
75Basic requirements:
76 You need to have the X11 development include files installed
2d979b6a 77 (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
ca851392 78
c08b948f
AM
79Build tool requirements:
80 On x86 Systems gcc >= 2.7.2 is required.
81 Versions earlier than 2.7.2.3 may have problems when certain files
82 are compiled with optimization, often due to problems with header file
4e474034 83 management.
c165bca8 84
c08b948f 85 Of course you also need "make" (most likely GNU make).
c9ec8846 86
2d979b6a 87 You also need flex version 2.5 or later and bison.
a5589d56 88
c08b948f 89Optional support libraries:
4e474034
AJ
90 Run ./configure --verbose to see the optional libraries that could
91 be used but aren't found on your system.
92
6abb89c3 93
d6baf1bb 944. COMPILATION
a69b88b2 95
c9ec8846
AM
96In case you chose to not use wineinstall, run the following commands
97to build Wine:
401710d7 98
d6baf1bb
AJ
99./configure
100make depend
101make
102
a5589d56 103This will build the program "wine" and numerous support libraries/binaries.
a0b2b1d0 104The program "wine" will load and run Windows executables.
1af53cbb
AM
105The library "libwine" ("Winelib") can be used to compile and link
106Windows source code under Unix.
d6baf1bb 107
1af53cbb 108To see compile configuration options, do ./configure --help.
e2bfa4c7 109
3a5816f8
AJ
110To upgrade to a new release by using a patch file, first cd to the
111top-level directory of the release (the one containing this README
112file). Then do a "make clean", and patch the release with:
113
4e474034 114 bunzip2 -c patch-file | patch -p1
f41aeca9 115
3a5816f8 116where "patch-file" is the name of the patch file (something like
4e474034 117wine-0.9.x.diff.bz2). You can then re-run "./configure", and then
d6baf1bb 118run "make depend && make".
5f721f81 119
4e474034 120
d6baf1bb 1215. SETUP
8d24ae6d 122
7e56f684 123Once Wine has been built correctly, you can do "make install"; this
38a3d264
JJ
124will install the wine executable, the Wine man page, and a few other
125needed files.
7e56f684 126
de53c487
AM
127Don't forget to uninstall any conflicting previous Wine installation
128first. Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
129before installing.
130
12f9bb7a
DP
131See the Support area at http://www.winehq.org/ for configuration
132hints.
8d24ae6d 133
a0ff2b4a
AM
134In case of library loading errors
135(e.g. "Error while loading shared libraries: libntdll.so"), make sure
136to add the library path to /etc/ld.so.conf and run ldconfig as root.
137
4e474034 138
d6baf1bb 1396. RUNNING PROGRAMS
8d24ae6d 140
38a3d264 141When invoking Wine, you may specify the entire path to the executable,
8d24ae6d
AJ
142or a filename only.
143
692389d0 144For example: to run Solitaire:
8d24ae6d 145
c08b948f
AM
146 wine sol (using the search Path as specified in
147 wine sol.exe the config file to locate the file)
148
149 wine c:\\windows\\sol.exe (using DOS filename syntax)
5f721f81 150
c08b948f 151 wine /usr/windows/sol.exe (using Unix filename syntax)
5f721f81 152
f950d973 153 wine sol.exe /parameter1 -parameter2 parameter3
c08b948f 154 (calling program with parameters)
f41aeca9 155
4e474034
AJ
156Wine is not yet complete, so several programs may crash. In that crash
157you will be dropped into the debugger so that you can investigate and
158fix the problem. For more information on how to do this, please check
159the debugging section of the Wine Developer's Guide.
8d24ae6d 160
a6d83eba 161
12f9bb7a 1627. GETTING MORE INFORMATION
46ea8b3f 163
3d2a38cf 164WWW: A great deal of information about Wine is available from WineHQ at
c0232546 165 http://www.winehq.org/ : various Wine Guides, application database,
3d2a38cf 166 bug tracking. This is probably the best starting point.
8cd93514 167
c0232546 168FAQ: The Wine FAQ is located at http://www.winehq.org/FAQ
46ea8b3f 169
ac3a9a32
AP
170Usenet: You can discuss Wine-related issues and get help
171 on comp.emulators.ms-windows.wine.
0ff60a08 172
c0232546 173Bugs: Report bugs to Wine Bugzilla at http://bugs.winehq.org
ac3a9a32
AP
174 Please search the bugzilla database to check whether your
175 problem is already found before posting a bug report. You can
176 also post bug reports to comp.emulators.ms-windows.wine.
46ea8b3f 177
344ed41d 178IRC: Online help is available at channel #WineHQ on irc.freenode.net.
8cd93514 179
4e474034
AJ
180GIT: The current Wine development tree is available through GIT.
181 Go to http://www.winehq.org/site/git for more information.
8d24ae6d 182
3d2a38cf 183Mailing lists:
4e474034
AJ
184 There are several mailing lists for Wine users and developers;
185 see http://www.winehq.org/forums for more information.
186
187Wiki: The Wine Wiki is located at http://wiki.winehq.org
3d2a38cf 188
b6e84187 189If you add something, or fix a bug, please send a patch (in 'diff -u'
c0232546 190format) to wine-patches@winehq.org list for inclusion in the next
ac3a9a32 191release.
8d24ae6d 192
3a5816f8
AJ
193--
194Alexandre Julliard
c0232546 195julliard@winehq.org