Documentation updates.

BUGS

@@ -1,3 +1,6 @@
+For information on how to post a useful bug report, please
+read documentation/bugreports.
+
 This is intended to be a place where you should look first if
 you want to contribute to Wine development. Add your e-mail
 address to the corresponding entry if you are working on/have 

documentation/bugreports

@@ -0,0 +1,52 @@
+How to Report a Bug
+-------------------
+
+Some simple advice on making your bug report more useful (and thus more
+likely to get answered and fixed):
+
+1) Post as much information as possible.  
+
+	This means we need more information than,
+	"MS Word crashes whenever I run it.  Do you know why?"  Include at 
+	least the following information:
+
+	- Version of Wine you're using (run 'wine -v')
+	- Operating system you're using, what distribution (if any), and what
+		version.
+	- Compiler and version (run 'gcc -v')
+	- Program you're trying to run, its version number, and a URL for 
+		where the program can be obtained (if available).
+	- Command line you used to start wine
+	- Any other information you think may be relevant or helpful.
+
+2) Re-run the program with the -debugmsg +relay option 
+   (i.e., 'wine -debugmsg +relay sol.exe').
+
+	If Wine crashes while running your program, it is important that we
+	have this information to have a chance at figuring out what is causing
+	the crash.  This can put out quite a lot (several MB) of information,
+	though, so it's best to output it to a file.  When the Wine-dbg> prompt
+	appears, type 'quit'.
+
+	To accomplish this, use the following commands:
+
+	wine -debugmsg +relay [other_options] program_name | tee filename.out
+	head -100 filename.out > report_file
+
+	'report_file' will now contain the last hundred lines of the debugging
+	output, including the register dump and backtrace, which are the most
+	important pieces of information.  Please do not delete this part, even
+	if you don't understand what it means.
+
+3) Post your report to the newsgroup comp.emulators.ms-windows.wine
+
+	In your post, include all of the information from part 1), and insert
+	the text from the output file in part 2).  If you do this, your chances
+	of receiving some sort of helpful response should be very good.
+
+4) Questions and comments
+
+	If after reading this document there is something you couldn't figure
+	out, or think could be explained better, or that should have been
+	included, please post to comp.emulators.ms-windows.wine to let us know
+	how this document can be improved.

documentation/debugging

@@ -1,36 +1,7 @@
-This file describes where to start debugging Wine and how to write
+This file describes where to start debugging Wine. If at any point
-useful bug reports.
+you get stuck and want to ask for help, please read the file
-
+documentation/bugreports for information on how to write useful bug 
-To avoid debugging
+reports.
-==================
-
-Sometimes you can bring applications to run by using some of the
-native Windows DLL's, together with Wine. Here are some Tips by
-Juergen Schmied on how to proceed. This assumes that your C:\windows
-directory in the configuration file does not point to a native Windows
-installation but is in a separate Unix file system. (For instance,
-C:\windows is really /home/ego/wine/drives/c).
-
-- Create empty C:\windows and C:\windows\system directories.
-  Do not point Wine to a Windows directory full of old installations
-  and a messy registry. (Wine creates a special registry in your home
-  directory, in $HOME/.wine/*.reg. Perhaps you have to remove these
-  files).
-- Run the application with   -debugmsg +module,+file   to find out
-  which files are needed. Copy the required DLL's one by one to the
-  C:\windows\system directory.
-- Note that some network DLL's are not needed even though Wine is
-  looking for them. Do not copy the MPR.DLL into the directory,
-  use the internal implementation.
-- Copy SHELL/SHELL32 and COMDLG/COMDLG32 COMMCTRL/COMCTL32
-  only as pairs to your Wine directory (these DLL's are
-  "clean" to use)
-- Be consistent: Use only DLLS from the same Windows version
-  together.
-- Put regedit.exe in the C:\windows directory (office95 imports
-  a *.reg file when it runs with a empty registry, don't know
-  about office97).
-
 
 Crashes
 =======

documentation/no-windows

@@ -0,0 +1,29 @@
+Running Wine without Windows
+==================
+
+Sometimes you can bring applications to run by using some of the
+native Windows DLL's, together with Wine. Here are some Tips by
+Juergen Schmied on how to proceed. This assumes that your C:\windows
+directory in the configuration file does not point to a native Windows
+installation but is in a separate Unix file system. (For instance,
+C:\windows is really /home/ego/wine/drives/c).
+
+- Create empty C:\windows and C:\windows\system directories.
+  Do not point Wine to a Windows directory full of old installations
+  and a messy registry. (Wine creates a special registry in your home
+  directory, in $HOME/.wine/*.reg. Perhaps you have to remove these
+  files).
+- Run the application with   -debugmsg +module,+file   to find out
+  which files are needed. Copy the required DLL's one by one to the
+  C:\windows\system directory.
+- Note that some network DLL's are not needed even though Wine is
+  looking for them. Do not copy the MPR.DLL into the directory,
+  use the internal implementation.
+- Copy SHELL/SHELL32 and COMDLG/COMDLG32 COMMCTRL/COMCTL32
+  only as pairs to your Wine directory (these DLL's are
+  "clean" to use)
+- Be consistent: Use only DLLS from the same Windows version
+  together.
+- Put regedit.exe in the C:\windows directory (office95 imports
+  a *.reg file when it runs with a empty registry, don't know
+  about office97).

documentation/wine.man

@@ -1,23 +1,15 @@
 .\" -*- nroff -*-
-.TH WINE 1 "October 20, 1998" "Version 981018" "Windows On Unix"
+.TH WINE 1 "November 22, 1998" "Version 981108" "Windows On Unix"
 .SH NAME
 wine \- run Windows programs on Unix
 .SH SYNOPSIS
-.B wine
+.BI "wine " "[wine_options]"
-[
+"
-.I wine_options
+.BI "program_name [program_args]"
-] "
+" "
-.I program_name
+.IB "[program_name [program_args] "
-[
+"
-.I program_args
+.BI "..." " ]"
-] "
-[ "
-.I program_name
-[
-.I program_args
-]"
-.I ...
-]
 .SH DESCRIPTION
 .B wine
 .I program
@@ -36,26 +28,33 @@ will run under any Linux kernel more recent than 0.99.13, or
 under recent releases of NetBSD/i386, FreeBSD and OpenBSD/i386.
 .PP
 The current support for multithreaded applications relies on the 
-.B clone(2)
+.BR clone (2)
 system call, which is currently available only on Linux systems running
-libc6 (glibc2).
+libc6 (aka glibc2).
 .PP
 .B X
 must be installed.  To use Wine's support for multithreaded applications,
 your X libraries must be reetrant.  If you have libc6 (glibc2), or you 
-compiled the libraries yourself, they were probably compiled with the 
+compiled the X libraries yourself, they were probably compiled with the 
 reetrant option enabled.  
 .PP
 .B libXpm
 must be installed.  If you're using Red Hat, the name of the package is
-XFree86-devel.  The sources may be obtained via FTP from ftp.Xfree86.org 
+XFree86-devel.  If you're using Debian, the packages you need are xpm4g
-or its mirrors.
+and xpm4g-dev. If you have some other distribution, please send email to
+the address listed in the 
+.B
+BUGS
+section to get it included in this man page.
 .PP
 .B gcc
 2.7.x 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.
+.B
+pgcc
+currently doesn't work with wine.  The cause of this problem is unknown. 
 .SH INSTALLATION
 To install 
 .B Wine,
@@ -66,12 +65,12 @@ detect your specific setup and create the Makefiles.  You can run
 .B wine
 executable, and then "make install" to install it. By default,
 .B wine
-is installed in /usr/local/bin; you can specify a different path with
+is installed in the /usr/local/ heirarchy; you can specify a different path with
 the --prefix option when running
 .B configure.
 .PP
 For more information, see the 
-.B README
+.I README
 file contained in the source distribution.
 .SH OPTIONS
 .TP
@@ -111,18 +110,19 @@ on all relay messages (API calls).
 .PP
 The full list of names is: all, accel, advapi, animate, aspi, atom, 
 bitblt, bitmap, caret, cd, cdaudio, class, clipboard, clipping, combo, 
-comboex, comm, commctrl, commdlg, console, crtdll, cursor, dc, dde, ddeml, 
+comboex, comm, commctrl, commdlg, console, crtdll, cursor, datetime, dc, 
-ddraw, debug, dialog, dinput, dll, dosfs, dosmem, dplay, driver, dsound, 
+dde, ddeml, ddraw, debug, dialog, dinput, dll, dosfs, dosmem, dplay, driver, 
-edit, event, exec, file, fixup, font, gdi, global, graphics, header, heap, 
+dsound, edit, event, exec, file, fixup, font, gdi, global, graphics, header, 
-hook, hotkey, icon, imagehlp, imagelist, imm, int, int10, int16, int21, 
+heap, hook, hotkey, icon, imagehlp, imagelist, imm, int, int10, int16, int17, 
-int31, ipaddress, key, keyboard, ldt, listbox, local, mci, mcianim, mciwave, mdi, menu, message, metafile, midi, mmaux, mmio, mmsys, mmtime, module, mpr, 
+int19, int21, int31, io, ipaddress, key, keyboard, ldt, listbox, listview, 
-msg, nativefont, nonclient, ntdll, ole, pager, palette, pidl, print, process, 
+local, mci, mcianim, mciwave, mdi, menu, message, metafile, midi, mmaux, mmio, 
-profile, progress, prop, psapi, psdrv, rebar, reg, region, relay, resource, 
+mmsys, mmtime, module, monthcal, mpr, msacm, msg, nativefont, nonclient, ntdll, 
-s, scroll, security, segment, selector, sem, sendmsg, shell, shm, snoop, 
+ole, pager, palette, pidl, print, process, profile, progress, prop, psapi, 
-sound, static, statusbar, stress, string, syscolor, system, tab, task, text, 
+psdrv, rebar, reg, region, relay, resource, s, scroll, security, segment, 
-thread, thunk, timer, toolbar, toolhelp, tooltips, trackbar, treeview, tweak, 
+selector, sem, sendmsg, shell, shm, snoop, sound, static, statusbar, stress, 
-uitools, updown, ver, virtual, vxd, win, win16drv, win32, wing, winsock, 
+string, syscolor, system, tab, task, text, thread, thunk, timer, toolbar, 
-wnet, x11, x11drv.
+toolhelp, tooltips, trackbar, treeview, tweak, uitools, updown, ver, virtual, 
+vxd, win, win16drv, win32, wing, winsock, wnet, x11, x11drv.
 .PP
 For more information on debugging messages, see the file 
 .I documentation/debug-msgs
@@ -195,9 +195,13 @@ Specify which Windows version WINE should imitate.
 Possible arguments are: win31, win95, nt351, and nt40.
 .PD 1
 .SH PROGRAM/ARGUMENTS
-The program name may be specified in DOS format (C:\\WINDOWS\\SOL.EXE) or in 
+The program name may be specified in DOS format (
-Unix format (/msdos/windows/sol.exe).  The program being executed may be 
+.I
-passed arguments by adding them on to the end of the command line invoking
+C:\\WINDOWS\\SOL.EXE)
+or in Unix format (
+.I /msdos/windows/sol.exe
+).  The program being executed may be passed arguments by adding them on 
+to the end of the command line invoking
 .B wine
 (such as: wine "notepad C:\\TEMP\\README.TXT").  Note that
 the program name and its arguments 
@@ -207,7 +211,9 @@ them together in quotation marks.  Multiple applications may be started
 by placing all of them on the command line (such as: wine notepad clock).
 .SH CONFIGURATION FILE
 .B wine
-expects a configuration file (/usr/local/etc/wine.conf), which should
+expects a configuration file (
+.I /usr/local/etc/wine.conf
+), which should
 conform to the following rules (the format is just like a Windows .ini
 file).  The actual file name may be specified during the execution of
 the
@@ -421,18 +427,19 @@ of the authors, please see the file
 .B AUTHORS
 in the top-level directory of the source distribution.
 .SH BUGS
-There are too many to count, much less list.  Some bugs of note, however,
-are that programs requiring VBRUNxxx.DLL are unreliable (with reports of
-some working), OLE is not in place, the internal COMMDLG support is not yet
-at 100% (although rapidly improving).  Color support for other than 8bpp
-(256 colors) is currently flaky.
 .PP
 A status report on many appplications is available from
-.I http://www.winehq.com/apps.cgi.
+.I http://www.winehq.com/Apps.
-Users can add, modify, and delete entries on this list.
+Please add entries to this list for applications you currently run.
 .PP
 Bug reports and successes may be posted to 
 .I comp.emulators.ms-windows.wine.
+If you do so, please read the file
+.I documentation/bugreports
+in the Wine source.
+.PP
+For problems and suggestions with this manpage, please send a note to
+James Juran <jrj120@psu.edu>.
 .SH AVAILABILITY
 The most recent public version of 
 .B wine
@@ -464,13 +471,16 @@ All discussions about the project take place in this forum.
 .I /usr/local/bin/wine
 The Wine program loader.
 .TP
+.I /usr/local/bin/dosmod
+The DOS program loader.
+.TP
 .I /usr/local/etc/wine.conf
 Global configuration file for wine.
 .TP
-.I /usr/local/lib/wine.sym
-Global symbol table (used in debugger)
-.TP
 .I ~/.winerc
 User-specific configuration file
+.TP
+.I /usr/local/lib/wine.sym
+Global symbol table (used in debugger)
 .SH "SEE ALSO"
-clone(2)
+.BR clone (2)