Documentation updates.

README

@@ -31,39 +31,67 @@ To compile and run Wine, you must have one of the following:
 	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 (unless you are tracking -current where it finally has
-been committed just recently), 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/
+Linux info:
+  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.
+  Also, some bugs were fixed and additional features were added
+  late in the Linux 2.0.x series, so if you have a very old Linux kernel,
+  you may want to upgrade to at least the latest 2.0.x release.
+
+FreeBSD info:
+  On FreeBSD, you may want to apply an LDT sharing patch too
+  (unless you are tracking -current where it finally has
+  been committed just recently), 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.
+  Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
+  turned on in your kernel.
+  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/
+
+Solaris info:
+  You will most likely need to build wine with the GNU toolchain
+  (gcc, gas, etc.)
+
+Wine requires kernel-level threads to run. Currently, only Linux
+version 2.0 or later, FreeBSD-current or FreeBSD 3.0 or later,
+and Solaris x86 version 2.5 or later are supported.
+Other operating systems which support kernel threads may be supported
+in the future.
 
 You need to have the X11 development include files installed
-(called xlib6g-dev in Debian and XFree86-devel-4.0.1-1 in RedHat).
+(called xlib6g-dev in Debian and XFree86-devel in RedHat).
+To use wine's support for multi-threaded applications, your X libraries
+must be reentrant, which is probably the default by now.
+If you have libc6 (glibc2), or you compiled the X libraries yourself,
+they were probably compiled with the reentrant option enabled.
 
 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.
+and xpm4g-dev. 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.
+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.
+
+You also need flex version 2.5 or later and yacc.
+Bison will work as a replacement for yacc. If you are
+using RedHat or Debian, install the flex and bison packages.
 
 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
@@ -142,10 +170,11 @@ directories sometimes.
 
 DOCU:	grep -i "SearchString" `find documentation/`|more
 
-FAQ:	The Wine FAQ is located at http://www.winehq.com/faq.html.
+FAQ:	The Wine FAQ is located at http://www.winehq.com/FAQ
 
 WWW:	A great deal of information about Wine is available from WineHQ at
-	http://www.winehq.com/. Untested patches against the current release
+	http://www.winehq.com/, especially various user guides.
+        Untested patches against the current release
 	are available on the wine-patches mailing list; see 
 	http://www.winehq.com/dev.shtml#ml for more information.
 

debugger/README

@@ -107,6 +107,8 @@ EXAMPLES:
 	Here is an example of how I tracked down a bug in Wine.  The program
 is something that just maps and dumps the contents of a Win32 executable.
 It was dying for some reason.
+Note that this example is rather old and does not necessarily use current
+syntax !
 
 Start the first time through.
 

documentation/wine.man.in

@@ -28,82 +28,9 @@ Using Windows ME or Win2000 components with Wine is more problematic than
 using none at all or the ones from older Windows versions.
 A large percentage of the API has been implemented,
 although there are still several major pieces of work left to do.
-.SH REQUIREMENTS
-.B wine
-requires kernel-level threads to run. Currently, only Linux version 2.0
-or later, FreeBSD-current or FreeBSD 3.0 or later, and Solaris x86
-version 2.5 or later are supported. Other operating systems which support
-kernel threads may be supported in the future.
-.PP
-Although Linux version 2.0 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. Also, some bugs were fixed and
-additional features were added late in the Linux 2.0.x series, so if you have
-a very old Linux kernel, you may want to upgrade to at least the latest 2.0.x
-release.
-.PP
-If you have FreeBSD, make sure you have the USER_LDT,
-SYSVSHM, SYSVSEM, and SYSVMSG options turned on in your kernel. If you
-are building 
-.B wine 
-on Solaris, you will most likely need to build wine with the GNU toolchain 
-(gcc, gas, etc.)
-.PP
-.B X
-must be installed.  To use 
-.B wine's 
-support for multithreaded applications, your X libraries must be reentrant.  
-If you have libc6 (glibc2), or you 
-compiled the X libraries yourself, they were probably compiled with the 
-reentrant option enabled.  
-.PP
-.B libXpm
-must be installed.  If you're using Red Hat, make sure the following
-packages are installed: XFree86-devel, xpm, and xpm-devel. If you're
-using Debian, the packages you need are xpm4g and xpm4g-dev. If you 
-have some other distribution, please send a list of packages required
-to the address listed in the 
-.B
-BUGS
-section to get it included in this man page.
-.PP
-.B gcc
-2.7.2 or later is required to build
-.B wine.
-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.
-.B
-pgcc
-currently doesn't work with 
-.B wine.  
-The cause of this problem is unknown. 
-.PP
-.B flex
-version 2.5 or later and 
-.B yacc
-are required.  Bison can be used in replace of yacc. If you have Redhat
-or Debian, make sure the bison and flex packages are installed.
-.SH INSTALLATION
-To install 
-.B wine,
-run either "tools/wineinstall" (recommended), or do it the hard way:
-run "./configure" in the top-level directory of the source, which will 
-detect your specific setup and create the Makefiles.  You can run 
-"./configure --help" to see the available configuration options.  Then do 
-"make depend && make" to build the
-.B wine
-executable, and then "make install" to install it. By default,
-.B wine
-is installed in the /usr/local/ hierarchy (current configuration has it in
-the @prefix@ hierarchy); you can specify a different path with
-the --prefix or --sysconfdir options when running
-.B configure.
-.PP
-For more information, see the 
-.I README
-file contained in the source distribution.
+.SH REQUIREMENTS AND INSTALLATION
+Read the README file in the Wine source distribution to know what Wine
+requires and how it is installed from source.
 .SH OPTIONS
 .TP
 .I --debugmsg [xxx]#name[,[xxx1]#name1][,<+|->relay=yyy1[:yyy2]]

objects/font.c

@@ -1760,7 +1760,7 @@ INT16 WINAPI AddFontResource16( LPCSTR filename )
  */
 INT WINAPI AddFontResourceA( LPCSTR str )
 {
-    FIXME("(%s): stub! Read \"documentation/fonts\" how to install "
+    FIXME("(%s): stub! Read the Wine User Guide on how to install "
             "this font manually.\n", debugres_a(str));
     return 1;
 }
@@ -1771,7 +1771,7 @@ INT WINAPI AddFontResourceA( LPCSTR str )
  */
 INT WINAPI AddFontResourceW( LPCWSTR str )
 {
-    FIXME("(%s): stub! Read \"documentation/fonts\" how to install "
+    FIXME("(%s): stub! Read the Wine User Guide on how to install "
             "this font manually.\n", debugres_w(str));
     return 1;
 }
@@ -1781,7 +1781,7 @@ INT WINAPI AddFontResourceW( LPCWSTR str )
  */
 BOOL16 WINAPI RemoveFontResource16( LPCSTR str )
 {
-    FIXME("(%s): stub\n",	debugres_a(str));
+    FIXME("(%s): stub\n", debugres_a(str));
     return TRUE;
 }