comdlg32: Fix test under win98.
[wine] / README
diff --git a/README b/README
index ab6a0bd..baa4929 100644 (file)
--- a/README
+++ b/README
@@ -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
 LICENSE for the details.
 
+
 2. QUICK START
 
 Whenever you compile from source, it is recommended to use the Wine
@@ -18,39 +19,34 @@ of the Wine source (which contains this file), run:
 
 ./tools/wineinstall
 
-Run programs as "wine [options] program".  For more information and
-problem resolution, read the rest of this file, the Wine man page,
-the files in the documentation directory of the Wine source
-(see "DOCUMENTATION"), and especially the wealth of information
-found at http://www.winehq.org.
+Run programs as "wine program".  For more information and problem
+resolution, read the rest of this file, the Wine man page, and
+especially the wealth of information found at http://www.winehq.org.
+
 
 3. REQUIREMENTS
 
 To compile and run Wine, you must have one of the following:
 
   Linux version 2.0.36 or above
-  FreeBSD 5.3 or later
-  Solaris x86 2.5 or later
+  FreeBSD 7.0 or later
+  Solaris x86 9 or later
   NetBSD-current
+  Mac OS X 10.4 or later
 
 As Wine requires kernel-level thread support to run, only the operating
-systems mentioned above are supported.
-Other operating systems which support kernel threads may be supported
-in the future.
+systems mentioned above are supported.  Other operating systems which
+support kernel threads may be supported in the future.
 
 Linux info:
   While Linux 2.2.x should still work and Linux 2.0.x may still work
   (older 2.0.x versions had thread-related crashes),
-  it's best to have a current kernel such as 2.4.x.
+  it's best to have a current kernel such as 2.4.x or 2.6.x.
 
 FreeBSD info:
-  Wine should build on FreeBSD 4.x and FreeBSD 5.x before 5.3, but will
-  generally not work on these systems due to issues with threading and
-  mmap().  In fact, even on FreeBSD 5.3 you will need the kernel patch
-  posted at <http://www.freebsd.org/cgi/query-pr.cgi?pr=73092>.
-  More information can be found in the FreeBSD ports tree at
-  <ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/>.
+  Wine will generally not work properly on versions before FreeBSD
+  7.0. FreeBSD 6.3 has patches available to allow Wine to run. See
+  <http://wiki.freebsd.org/Wine> for more information.
 
 Solaris info:
   You will most likely need to build Wine with the GNU toolchain
@@ -62,41 +58,33 @@ NetBSD info:
   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
   turned on in your kernel.
 
+Mac OS X info:
+  You need Xcode 2.4 or later to build properly on x86.
 
 
 Supported file systems:
-  Wine should run on most file systems. However, Wine will fail to start
-  if umsdos is used for the /tmp directory. A few compatibility problems have
-  also been reported using files accessed through Samba. Also, as NTFS
-  can only be used safely with readonly access for now, we recommend against
-  using NTFS, as Windows programs need write access almost everywhere.
-  In case of NTFS files, copy over to a writable location.
+  Wine should run on most file systems. A few compatibility problems
+  have also been reported using files accessed through Samba. Also,
+  NTFS does not provide all the file system features needed by some
+  applications.  Using a native Linux file system such as ext3 is
+  recommended.
 
 Basic requirements:
   You need to have the X11 development include files installed
-  (called xlib6g-dev in Debian and XFree86-devel in RedHat).
-
-Build tool requirements:
-  On x86 Systems gcc >= 2.7.2 is required.
-  Versions earlier than 2.7.2.3 may have problems when certain files
-  are compiled with optimization, often due to problems with header file
-  management. pgcc currently doesn't work with Wine. The cause of this problem
-  is unknown.
+  (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
 
   Of course you also need "make" (most likely GNU make).
 
-  You also need flex version 2.5 or later and bison.  If you are
-  using RedHat or Debian, install the flex and bison packages.
+  You also need flex version 2.5 or later and bison.
 
 Optional support libraries:
-  If you want CUPS printing support, please install both cups and cups-devel
-  packages.
+  Configure will display notices when optional libraries are not found
+  on your system. See http://wiki.winehq.org/Recommended_Packages for
+  hints about the packages you should install.
 
-  For the automatic processing of the test suite scripts, you also need
-  libperl development header support (libperl-dev package on Debian).
-
-For requirements in case you intend to build the documentation yourself,
-see "DOCUMENTATION" section.
+  On 64-bit platforms you have to make sure to install the 32-bit
+  versions of these libraries; see http://wiki.winehq.org/WineOn64bit
+  for details.
 
 4. COMPILATION
 
@@ -118,12 +106,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
 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
-Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
+wine-1.0.x.diff.bz2). You can then re-run "./configure", and then
 run "make depend && make".
 
+
 5. SETUP
 
 Once Wine has been built correctly, you can do "make install"; this
@@ -134,70 +123,34 @@ Don't forget to uninstall any conflicting previous Wine installation
 first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
 before installing.
 
-If you want to read the documentation supplied with the Wine source,
-see the "DOCUMENTATION" section.
-
-Wine requires a configuration file named named "config" in your
-~/.wine directory. The format of this file is explained in the config file
-man page (documentation/wine.conf.man).
-The file documentation/samples/config contains an example configuration file
-which has to be adapted and copied to the location mentioned above.
+Once installed, you can run the "winecfg" configuration tool. See the
+Support area at http://www.winehq.org/ for configuration hints.
 
-See the Support area at http://www.winehq.org/ for further
-configuration hints.
-
-In case of library loading errors
-(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.
 
 6. RUNNING PROGRAMS
 
 When invoking Wine, you may specify the entire path to the executable,
 or a filename only.
 
-For example: to run Solitaire:
+For example: to run Notepad:
 
-       wine sol                   (using the search Path as specified in
-       wine sol.exe                the config file to locate the file)
+       wine notepad               (using the search Path as specified in
+       wine notepad.exe            the config file to locate the file)
 
-       wine c:\\windows\\sol.exe  (using DOS filename syntax)
+       wine c:\\windows\\notepad.exe  (using DOS filename syntax)
 
-       wine /usr/windows/sol.exe  (using Unix filename syntax)
+       wine ~/.wine/drive_c/windows/notepad.exe  (using Unix filename syntax)
 
-        wine sol.exe /parameter1 -parameter2 parameter3
+        wine notepad.exe /parameter1 -parameter2 parameter3
                                   (calling program with parameters)
 
-Note: the path of the file will also be added to the path when
-      a full name is supplied on the commandline.
-
-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
+Wine is not yet complete, so several programs may crash. In that crash
+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.
 
-7. DOCUMENTATION
 
-Some documentation (various Wine Guides etc.) can be found in the
-documentation/ directory (apart from also being available on WineHQ).
-
-If you want to process the SGML files in there, then you can run "make doc"
-in the documentation/ directory.
-Doing so requires the sgml tools package (for db2html, db2ps, db2pdf) named:
-Debian:                docbook-utils
-Mandrake:      sgml-tools-A.B.C-DDmdk
-SuSE:          docbktls-A.BB.C-DD
-
-8. GETTING MORE INFORMATION
+7. GETTING MORE INFORMATION
 
 WWW:   A great deal of information about Wine is available from WineHQ at
        http://www.winehq.org/ : various Wine Guides, application database,
@@ -212,17 +165,17 @@ Bugs:     Report bugs to Wine Bugzilla at http://bugs.winehq.org
        Please search the bugzilla database to check whether your
        problem is already found before posting a bug report.  You can
        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.
 
-CVS:   The current Wine development tree is available through CVS.
-       Go to http://www.winehq.org/cvs for more information.
+GIT:   The current Wine development tree is available through GIT.
+       Go to http://www.winehq.org/site/git for more information.
 
 Mailing lists:
-       There are several mailing lists for Wine developers; see
-       http://www.winehq.org/forums for more information.
+       There are several mailing lists for Wine users and developers;
+       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'
 format) to wine-patches@winehq.org list for inclusion in the next