Documentation updates.

This commit is contained in:
Alexandre Julliard 2006-08-23 15:59:14 +02:00
parent 6bcbc126ed
commit 4e4740346d
2 changed files with 27 additions and 33 deletions

56
README
View File

@ -10,6 +10,7 @@ be used for porting Win32 code into native Unix executables.
Wine is free software, released under the GNU LGPL; see the file Wine is free software, released under the GNU LGPL; see the file
LICENSE for the details. LICENSE for the details.
2. QUICK START 2. QUICK START
Whenever you compile from source, it is recommended to use the Wine Whenever you compile from source, it is recommended to use the Wine
@ -18,10 +19,11 @@ of the Wine source (which contains this file), run:
./tools/wineinstall ./tools/wineinstall
Run programs as "wine [options] program". For more information and Run programs as "wine program". For more information and problem
problem resolution, read the rest of this file, the Wine man page, and resolution, read the rest of this file, the Wine man page, and
especially the wealth of information found at http://www.winehq.org. especially the wealth of information found at http://www.winehq.org.
3. REQUIREMENTS 3. REQUIREMENTS
To compile and run Wine, you must have one of the following: To compile and run Wine, you must have one of the following:
@ -30,6 +32,7 @@ To compile and run Wine, you must have one of the following:
FreeBSD 5.3 or later FreeBSD 5.3 or later
Solaris x86 2.5 or later Solaris x86 2.5 or later
NetBSD-current NetBSD-current
MacOS X 10.4 or later
As Wine requires kernel-level thread support to run, only the operating As Wine requires kernel-level thread support to run, only the operating
systems mentioned above are supported. systems mentioned above are supported.
@ -58,6 +61,8 @@ NetBSD info:
Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
turned on in your kernel. turned on in your kernel.
MacOS info:
You need Xcode 2.4 or later to build properly on x86.
Supported file systems: Supported file systems:
@ -76,17 +81,16 @@ Build tool requirements:
On x86 Systems gcc >= 2.7.2 is required. On x86 Systems gcc >= 2.7.2 is required.
Versions earlier than 2.7.2.3 may have problems when certain files Versions earlier than 2.7.2.3 may have problems when certain files
are compiled with optimization, often due to problems with header file are compiled with optimization, often due to problems with header file
management. pgcc currently doesn't work with Wine. The cause of this problem management.
is unknown.
Of course you also need "make" (most likely GNU make). Of course you also need "make" (most likely GNU make).
You also need flex version 2.5 or later and bison. You also need flex version 2.5 or later and bison.
Optional support libraries: Optional support libraries:
If you want CUPS printing support, please install both cups and cups-devel Run ./configure --verbose to see the optional libraries that could
packages. be used but aren't found on your system.
Install the libxml2 package to get a functional msxml implementation.
4. COMPILATION 4. COMPILATION
@ -108,12 +112,13 @@ To upgrade to a new release by using a patch file, first cd to the
top-level directory of the release (the one containing this README top-level directory of the release (the one containing this README
file). Then do a "make clean", and patch the release with: file). Then do a "make clean", and patch the release with:
gunzip -c patch-file | patch -p1 bunzip2 -c patch-file | patch -p1
where "patch-file" is the name of the patch file (something like where "patch-file" is the name of the patch file (something like
Wine-yymmdd.diff.gz). You can then re-run "./configure", and then wine-0.9.x.diff.bz2). You can then re-run "./configure", and then
run "make depend && make". run "make depend && make".
5. SETUP 5. SETUP
Once Wine has been built correctly, you can do "make install"; this Once Wine has been built correctly, you can do "make install"; this
@ -131,6 +136,7 @@ In case of library loading errors
(e.g. "Error while loading shared libraries: libntdll.so"), make sure (e.g. "Error while loading shared libraries: libntdll.so"), make sure
to add the library path to /etc/ld.so.conf and run ldconfig as root. to add the library path to /etc/ld.so.conf and run ldconfig as root.
6. RUNNING PROGRAMS 6. RUNNING PROGRAMS
When invoking Wine, you may specify the entire path to the executable, When invoking Wine, you may specify the entire path to the executable,
@ -148,23 +154,11 @@ For example: to run Solitaire:
wine sol.exe /parameter1 -parameter2 parameter3 wine sol.exe /parameter1 -parameter2 parameter3
(calling program with parameters) (calling program with parameters)
Note: the path of the file will also be added to the path when Wine is not yet complete, so several programs may crash. In that crash
a full name is supplied on the commandline. you will be dropped into the debugger so that you can investigate and
fix the problem. For more information on how to do this, please check
the debugging section of the Wine Developer's Guide.
Wine is not yet complete, so several programs may crash. Provided you set up
winedbg correctly according to documentation/debugger.sgml, you will be dropped
into a debugger so that you can investigate and fix the problem.
For more information on how to do this, please read the file
documentation/debugging.sgml.
You should backup all your important files that you give Wine access
to, or use a special Wine copy of them, as there have been some cases
of users reporting file corruption. Do NOT run Explorer, for instance,
if you don't have a proper backup, as it renames/cripples several
directories sometimes. Not even other MS apps such as e.g. Messenger are safe,
as they launch Explorer somehow. This particular corruption (!$!$!$!$.pfr)
can at least partially be fixed by using
http://home.nexgo.de/andi.mohr/download/decorrupt_explorer
7. GETTING MORE INFORMATION 7. GETTING MORE INFORMATION
@ -181,17 +175,17 @@ Bugs: Report bugs to Wine Bugzilla at http://bugs.winehq.org
Please search the bugzilla database to check whether your Please search the bugzilla database to check whether your
problem is already found before posting a bug report. You can problem is already found before posting a bug report. You can
also post bug reports to comp.emulators.ms-windows.wine. also post bug reports to comp.emulators.ms-windows.wine.
Please read the file documentation/bugs.sgml to see what
information is required.
IRC: Online help is available at channel #WineHQ on irc.freenode.net. IRC: Online help is available at channel #WineHQ on irc.freenode.net.
CVS: The current Wine development tree is available through CVS. GIT: The current Wine development tree is available through GIT.
Go to http://www.winehq.org/cvs for more information. Go to http://www.winehq.org/site/git for more information.
Mailing lists: Mailing lists:
There are several mailing lists for Wine developers; see There are several mailing lists for Wine users and developers;
http://www.winehq.org/forums for more information. see http://www.winehq.org/forums for more information.
Wiki: The Wine Wiki is located at http://wiki.winehq.org
If you add something, or fix a bug, please send a patch (in 'diff -u' If you add something, or fix a bug, please send a patch (in 'diff -u'
format) to wine-patches@winehq.org list for inclusion in the next format) to wine-patches@winehq.org list for inclusion in the next

View File

@ -280,10 +280,10 @@ The most recent public version of
can be downloaded from can be downloaded from
.I http://www.winehq.org/download .I http://www.winehq.org/download
.PP .PP
The latest snapshot of the code may be obtained via CVS. For information The latest snapshot of the code may be obtained via GIT. For information
on how to do this, please see on how to do this, please see
.I .I
http://www.winehq.org/cvs http://www.winehq.org/site/git
.PP .PP
WineHQ, the WineHQ, the
.B wine .B wine