winedbg: Removed unneeded variable from print_basic.
[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
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 directory
18 of the Wine source (which contains this file), run:
19
20 ./tools/wineinstall
21
22 Run programs as "wine program".  For more information and problem
23 resolution, read the rest of this file, the Wine man page, and
24 especially the wealth of information found at http://www.winehq.org.
25
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 6.2 or later
33   Solaris x86 2.5 or later
34   NetBSD-current
35   Mac OS X 10.4 or later
36
37 As Wine requires kernel-level thread support to run, only the operating
38 systems mentioned above are supported.  Other operating systems which
39 support kernel threads may be supported 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 or 2.6.x.
45
46 FreeBSD info:
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.
50  
51   More information can be found in the FreeBSD ports tree at
52   <ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/>.
53
54 Solaris info:
55   You will most likely need to build Wine with the GNU toolchain
56   (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
57   will be used by gcc. Recompiling gcc after installing gas or
58   symlinking cc, as and ld to the gnu tools is said to be necessary.
59
60 NetBSD info:
61   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
62   turned on in your kernel.
63
64 Mac OS X info:
65   You need Xcode 2.4 or later to build properly on x86.
66
67
68 Supported file systems:
69   Wine should run on most file systems. A few compatibility problems
70   have also been reported using files accessed through Samba. Also,
71   NTFS does not provide all the file system features needed by some
72   applications.  Using a native Linux file system such as ext3 is
73   recommended.
74
75 Basic requirements:
76   You need to have the X11 development include files installed
77   (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
78
79   Of course you also need "make" (most likely GNU make).
80
81   You also need flex version 2.5 or later and bison.
82
83 Optional support libraries:
84   Configure will display notices when optional libraries are not found
85   on your system. See http://wiki.winehq.org/Recommended_Packages for
86   hints about the packages you should install.
87
88   On 64-bit platforms you have to make sure to install the 32-bit
89   versions of these libraries; see http://wiki.winehq.org/WineOn64bit
90   for details.
91
92 4. COMPILATION
93
94 In case you chose to not use wineinstall, run the following commands
95 to build Wine:
96
97 ./configure
98 make depend
99 make
100
101 This will build the program "wine" and numerous support libraries/binaries.
102 The program "wine" will load and run Windows executables.
103 The library "libwine" ("Winelib") can be used to compile and link
104 Windows source code under Unix.
105
106 To see compile configuration options, do ./configure --help.
107
108 To upgrade to a new release by using a patch file, first cd to the
109 top-level directory of the release (the one containing this README
110 file). Then do a "make clean", and patch the release with:
111
112     bunzip2 -c patch-file | patch -p1
113
114 where "patch-file" is the name of the patch file (something like
115 wine-0.9.x.diff.bz2). You can then re-run "./configure", and then
116 run "make depend && make".
117
118
119 5. SETUP
120
121 Once Wine has been built correctly, you can do "make install"; this
122 will install the wine executable, the Wine man page, and a few other
123 needed files.
124
125 Don't forget to uninstall any conflicting previous Wine installation
126 first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
127 before installing.
128
129 Once installed, you can run the "winecfg" configuration tool. See the
130 Support area at http://www.winehq.org/ for configuration hints.
131
132
133 6. RUNNING PROGRAMS
134
135 When invoking Wine, you may specify the entire path to the executable,
136 or a filename only.
137
138 For example: to run Solitaire:
139
140         wine sol                   (using the search Path as specified in
141         wine sol.exe                the config file to locate the file)
142
143         wine c:\\windows\\sol.exe  (using DOS filename syntax)
144
145         wine ~/.wine/drive_c/windows/sol.exe  (using Unix filename syntax)
146
147         wine sol.exe /parameter1 -parameter2 parameter3
148                                    (calling program with parameters)
149
150 Wine is not yet complete, so several programs may crash. In that crash
151 you will be dropped into the debugger so that you can investigate and
152 fix the problem.  For more information on how to do this, please check
153 the debugging section of the Wine Developer's Guide.
154
155
156 7. GETTING MORE INFORMATION
157
158 WWW:    A great deal of information about Wine is available from WineHQ at
159         http://www.winehq.org/ : various Wine Guides, application database,
160         bug tracking. This is probably the best starting point.
161
162 FAQ:    The Wine FAQ is located at http://www.winehq.org/FAQ
163
164 Usenet: You can discuss Wine-related issues and get help
165         on comp.emulators.ms-windows.wine.
166
167 Bugs:   Report bugs to Wine Bugzilla at http://bugs.winehq.org
168         Please search the bugzilla database to check whether your
169         problem is already found before posting a bug report.  You can
170         also post bug reports to comp.emulators.ms-windows.wine.
171
172 IRC:    Online help is available at channel #WineHQ on irc.freenode.net.
173
174 GIT:    The current Wine development tree is available through GIT.
175         Go to http://www.winehq.org/site/git for more information.
176
177 Mailing lists:
178         There are several mailing lists for Wine users and developers;
179         see http://www.winehq.org/forums for more information.
180
181 Wiki:   The Wine Wiki is located at http://wiki.winehq.org
182
183 If you add something, or fix a bug, please send a patch (in 'diff -u'
184 format) to wine-patches@winehq.org list for inclusion in the next
185 release.
186
187 --
188 Alexandre Julliard
189 julliard@winehq.org