comdlg32: Fix test under win98.
[wine] / README
diff --git a/README b/README
index 6ccc1f4..baa4929 100644 (file)
--- a/README
+++ b/README
 Wine is a program which allows running Microsoft Windows programs
 (including DOS, Windows 3.x and Win32 executables) on Unix.  It
 consists of a program loader which loads and executes a Microsoft
-Windows binary, and a library that implements Windows API calls using
-their Unix or X11 equivalents. The library may also be used for
-porting Win32 code into native Unix executables.
+Windows binary, and a library (called Winelib) that implements Windows
+API calls using their Unix or X11 equivalents.  The library may also
+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.
 
-Wine is free software, and its license (contained in the file LICENSE)
-is BSD style.  Basically, you can do anything with it except claim
-that you wrote it.
 
 2. QUICK START
 
-For the impatient, use the Wine Installer to build and install wine.
-From the top-level Wine directory (which contains this file), run:
+Whenever you compile from source, it is recommended to use the Wine
+Installer to build and install Wine.  From the top-level directory
+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 manpage,
-and the files in the documentation directory in the Wine source.
+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-current or FreeBSD 3.0 or later
-       Solaris x86 2.5 or later
-
-Although Linux version 2.0.x will mostly work, certain features
-(specifically LDT sharing) required for properly supporting Win32
-threads were not implemented until kernel version 2.2.  If you get
-consistent thread-related crashes, you may want to upgrade to 2.2.
-
-Similarly if you are on FreeBSD you may want to apply an LDT sharing
-patch too (unfortunately this one still isn't in the tree, neither
--current nor -stable), and there also is a small sigtrap fix thats
-needed for wine's debugger. (Actually now that its using ptrace() by
-default it may no longer make a difference but it still doesn't hurt...)
-And if you're running a system from the -stable branch older than
-Nov 15 1999, like a 3.3-RELEASE, then you also need to apply a signal
-handling change that was MFC'd at that date.  More information including
-patches for the -stable branch is in the ports tree:
-ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/ports/emulators/wine/files/
-(the signal handling patch, patch-3.3-sys-fsgs, and the latest README
-haven't yet been committed as i write this, if they still aren't there
-when you look, go here:
-http://www.jelal.kn-bremen.de/freebsd/ports/emulators/wine/files/ )
-
-You also need to have libXpm installed on your system. The sources for
-it are available at ftp.x.org and all its mirror sites in the directory
-/contrib/libraries. If you are using RedHat, libXpm is distributed as the
-xpm and xpm-devel packages. Debian distributes libXpm as xpm4.7, xpm4g,
-and xpm4g-dev 3.4j. SuSE calls these packages xpm and xpm-devel.
-
-On x86 Systems gcc >= 2.7.2 is required. You also need flex version 2.5
-or later and yacc. Bison will work as a replacement for yacc. If you are
-using RedHat, install the flex and bison packages.
+  Linux version 2.0.36 or above
+  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.
+
+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 or 2.6.x.
+
+FreeBSD info:
+  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
+  (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
+  will be used by gcc. Recompiling gcc after installing gas or
+  symlinking cc, as and ld to the gnu tools is said to be necessary.
+
+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. 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 Red Hat).
+
+  Of course you also need "make" (most likely GNU make).
+
+  You also need flex version 2.5 or later and bison.
+
+Optional support libraries:
+  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.
+
+  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
 
-To build Wine, run the following commands:
+In case you chose to not use wineinstall, run the following commands
+to build Wine:
 
 ./configure
 make depend
 make
 
-This will build the library "libwine.a" and the program "wine".  
+This will build the program "wine" and numerous support libraries/binaries.
 The program "wine" will load and run Windows executables.
-The library "libwine.a" can be used to compile and link Windows source
-code under Unix.
+The library "libwine" ("Winelib") can be used to compile and link
+Windows source code under Unix.
 
-If you do not intend to compile Windows source code, use
-"./configure --disable-lib" to skip building the library and reduce disk
-space requirements. If you have an ELF compiler (which you probably do),
-you can use "./configure --enable-dll" to build a shared library instead.
-To see other configuration options, do ./configure --help.
+To see compile configuration options, do ./configure --help.
 
 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".
 
 
@@ -96,16 +119,12 @@ Once Wine has been built correctly, you can do "make install"; this
 will install the wine executable, the Wine man page, and a few other
 needed files.
 
-Wine requires a configuration file named wine.conf. Its default location is
-/usr/local/etc, but you can supply a different name when configuring wine by
-using the --prefix or --sysconfdir options to ./configure. You can also override
-the global configuration file with a .winerc file in your home directory.
+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.
 
-The format of this file is explained in the man page. The file
-wine.ini contains an example configuration file which has to be adapted
-and copied to one of the two locations mentioned above.
-
-See http://www.winehq.com/config.html for further configuration hints.
+Once installed, you can run the "winecfg" configuration tool. See the
+Support area at http://www.winehq.org/ for configuration hints.
 
 
 6. RUNNING PROGRAMS
@@ -113,53 +132,55 @@ See http://www.winehq.com/config.html for further configuration hints.
 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 searchpath to locate the file)
-       wine sol.exe
+       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 a DOS filename)
+       wine c:\\windows\\notepad.exe  (using DOS filename syntax)
 
-       wine /usr/windows/sol.exe  (using a Unix filename)
+       wine ~/.wine/drive_c/windows/notepad.exe  (using Unix filename syntax)
 
-Note: the path of the file will also be added to the path when
-      a full name is supplied on the commandline.
+        wine notepad.exe /parameter1 -parameter2 parameter3
+                                  (calling program with parameters)
 
-Wine is not yet complete, so some programs may crash. 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.
-If you post a bug report, please read the file documentation/bugreports to
-see what information is required.
+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. GETTING MORE INFORMATION
 
-FAQ:   The Wine FAQ is located at http://www.winehq.com/faq.html.
-
 WWW:   A great deal of information about Wine is available from WineHQ at
-       http://www.winehq.com/. Untested patches against the current release
-       are available on the wine-patches mailing list; see 
-       http://www.winehq.com/dev.html#ml for more information.
+       http://www.winehq.org/ : various Wine Guides, application database,
+       bug tracking. This is probably the best starting point.
+
+FAQ:   The Wine FAQ is located at http://www.winehq.org/FAQ
+
+Usenet:        You can discuss Wine-related issues and get help
+       on comp.emulators.ms-windows.wine.
+
+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.
 
-HOWTO: A pre-release version of the Wine HOWTO is available at
-       http://www.westfalen.de/witch/wine-HOWTO.txt .
+IRC:   Online help is available at channel #WineHQ on irc.freenode.net.
 
-Usenet:        Please browse old messages on http://www.dejanews.com/ to check whether 
-       your problem is already fixed before posting a bug report to the 
-       newsgroup. 
+GIT:   The current Wine development tree is available through GIT.
+       Go to http://www.winehq.org/site/git for more information.
 
-       The best place to get help or to report bugs is the Usenet newsgroup
-       comp.emulators.ms-windows.wine. Please read the file 
-       documentation/bugreports to see what information should be included 
-       in a bug report.
+Mailing lists:
+       There are several mailing lists for Wine users and developers;
+       see http://www.winehq.org/forums for more information.
 
-CVS:   The current Wine development tree is available through CVS.
-       Go to http://www.winehq.com/dev.html 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 ('diff -u'
-format preferred) to julliard@lrc.epfl.ch for inclusion in the next
+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
 release.
 
 --
 Alexandre Julliard
-julliard@lrc.epfl.ch
+julliard@winehq.org