From 38a3d264f1c66628f639c261f966605e86c3320b Mon Sep 17 00:00:00 2001
From: James Juran <jrj120@psu.edu>
Date: Fri, 1 Jan 1999 18:45:52 +0000
Subject: [PATCH] Add some information to the man page and README file. Make
documentation/win95look say [Tweak.Layout] instead of [Tweaks.Layout]. Fix
incorrect command given in documentation/bugreports. Standard error was not
being redirected, so most of the output was lost.
---
README | 45 +++++++++-------
documentation/bugreports | 9 +++-
documentation/win95look | 2 +-
documentation/wine.man | 113 +++++++++++++--------------------------
4 files changed, 73 insertions(+), 96 deletions(-)
diff --git a/README b/README
index cd189058662..f21ba8eb36c 100644
--- a/README
+++ b/README
@@ -24,17 +24,21 @@ To compile Wine, you must have one of:
You also need to have libXpm installed on your system. The sources for
it are probably available on the ftp site where you got Wine. They can
-also be found on ftp.x.org and all its mirror sites.
+also be found on ftp.x.org and all its mirror sites. If you are using
+RedHat, install the xpm and xpm-devel packages.
-On x86 Systems gcc >= 2.7.0 is required. You will probably need flex too.
+On x86 Systems gcc >= 2.7.0 is required. You also need flex and yacc.
+Bison will work as a replacement for yacc. If you are using RedHat,
+install the flex and bison packages.
-To build Wine, first do a "./configure" and then a "make depend; make".
+To build Wine, first run "./configure" and then run "make depend; make".
This will build the library "libwine.a" and the program "wine".
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. If you have an ELF compiler, you can use
-"./configure --enable-dll" to build a shared library instead.
+"./configure --enable-dll" to build a shared library instead. To see
+other 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
@@ -50,7 +54,8 @@ run "make depend; make".
3. SETUP
Once Wine has been built correctly, you can do "make install"; this
-will install the wine executable and the man page.
+will install the wine executable, the Wine man page, and a few other
+needed files.
Wine requires you to have a file /usr/local/etc/wine.conf (you can
supply a different name when configuring wine) or a file called .winerc
@@ -62,7 +67,7 @@ wine.ini contains a config file example.
4. RUNNING PROGRAMS
-When invoking Wine, you must specify the entire path to the executable,
+When invoking Wine, you may specify the entire path to the executable,
or a filename only.
For example: to run Solitaire:
@@ -78,29 +83,33 @@ 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 some programs may crash. You will be dropped
-into a debugger so that you can investigate and fix the problem.
+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.
+
5. GETTING MORE INFORMATION
-Usenet: The best place to get help or to report bugs is the Usenet newsgroup
- comp.emulators.ms-windows.wine. The Wine FAQ is posted there every
- month.
+FAQ: The Wine FAQ is located at http://pw1.netcom.com/~dagar/wine.html.
-WWW: 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.
-
- A great deal of information about Wine is available from WineHQ at
+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.
+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.
+
+ 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.
+
CVS: The current Wine development tree is available through CVS.
Go to http://www.winehq.com/dev.html for more information.
-FAQ: The Wine FAQ is located at http://pw1.netcom.com/~dagar/wine.html.
-
-
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
release.
diff --git a/documentation/bugreports b/documentation/bugreports
index efce410fdc8..f111c78ef19 100644
--- a/documentation/bugreports
+++ b/documentation/bugreports
@@ -30,9 +30,16 @@ likely to get answered and fixed):
To accomplish this, use the following commands:
- wine -debugmsg +relay [other_options] program_name | tee filename.out
+ tcsh and other csh-like shells:
+
+ wine -debugmsg +relay [other_options] program_name |& tee filename.out
head -100 filename.out > report_file
+ bash and other sh-like shells:
+
+ wine -debugmsg +relay [other_options] program_name 2>&1 | 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
diff --git a/documentation/win95look b/documentation/win95look
index ed87f6840a6..4d260495c3d 100644
--- a/documentation/win95look
+++ b/documentation/win95look
@@ -1,7 +1,7 @@
Win95/Win98 interface code is being introduced.
Instead of compiling Wine for Win3.1 vs. Win95 using #define switches,
-the code now looks in a special [Tweaks.Layout] section of wine.conf
+the code now looks in a special [Tweak.Layout] section of wine.conf
for a "WineLook=Win95" or "WineLook=Win98" entry.
A few new sections and a number of entries have been added to the
diff --git a/documentation/wine.man b/documentation/wine.man
index 8da64b0f548..4ce56b7cc52 100644
--- a/documentation/wine.man
+++ b/documentation/wine.man
@@ -1,15 +1,14 @@
.\" -*- nroff -*-
-.TH WINE 1 "November 22, 1998" "Version 981108" "Windows On Unix"
+.TH WINE 1 "December 30, 1998" "Version 981211" "Windows On Unix"
.SH NAME
wine \- run Windows programs on Unix
.SH SYNOPSIS
-.BI "wine " "[wine_options]"
-"
-.BI "program_name [program_args]"
-" "
-.IB "[program_name [program_args] "
-"
-.BI "..." " ]"
+.BI "wine " "[wine_options] " "program1 " "[program2 ... ]"
+.PP
+For instructions on passing arguments to Windows programs, please see the
+.B
+PROGRAM/ARGUMENTS
+section of the man page.
.SH DESCRIPTION
.B wine
.I program
@@ -25,7 +24,11 @@ are still several major pieces of work left to do.
At present,
.B wine
will run under any Linux kernel more recent than 0.99.13, or
-under recent releases of NetBSD/i386, FreeBSD and OpenBSD/i386.
+under recent releases of NetBSD/i386, FreeBSD and OpenBSD/i386. Some bugs
+were fixed and additional features were added late in the Linux 2.0.x
+series, so if you have an old Linux kernel, you may want to upgrade to the
+latest 2.0.x release. If you have FreeBSD, make sure you have the USER_LDT,
+SYSVSEM, and SYSVMSG options turned on in your kernel.
.PP
The current support for multithreaded applications relies on the
.BR clone (2)
@@ -39,10 +42,11 @@ 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. If you're using Debian, the packages you need are xpm4g
-and xpm4g-dev. If you have some other distribution, please send email to
-the address listed in the
+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.
@@ -55,6 +59,12 @@ compiled with optimization.
.B
pgcc
currently doesn't work with wine. The cause of this problem is unknown.
+.PP
+.B flex
+and
+.B yacc
+are required. Bison can be used in replace of yacc. If you have Redhat,
+make sure the bison and flex packages are installed.
.SH INSTALLATION
To install
.B Wine,
@@ -119,10 +129,10 @@ local, mci, mcianim, mciwave, mdi, menu, message, metafile, midi, mmaux, mmio,
mmsys, mmtime, module, monthcal, mpr, msacm, msg, nativefont, nonclient, ntdll,
ole, pager, palette, pidl, print, process, profile, progress, prop, psapi,
psdrv, rebar, reg, region, relay, resource, s, scroll, security, segment,
-selector, sem, sendmsg, shell, shm, snoop, sound, static, statusbar, stress,
-string, syscolor, system, tab, task, text, thread, thunk, timer, toolbar,
-toolhelp, tooltips, trackbar, treeview, tweak, uitools, updown, ver, virtual,
-vxd, win, win16drv, win32, wing, winsock, wnet, x11, x11drv.
+selector, sem, sendmsg, server, shell, shm, snoop, sound, static, statusbar,
+stress, string, syscolor, system, tab, task, text, thread, thunk, timer,
+toolbar, 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
@@ -218,7 +228,7 @@ 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
.B configure
-script. Alternatively, you may have a
+script with the --sysconfdir option. Alternatively, you may have a
.I .winerc
file of this format in your home directory or have the environment variable
.B WINE_INI
@@ -367,59 +377,9 @@ default: Win31
.br
Use Win95-like window displays or Win3.1-like window displays.
.SH SAMPLE CONFIGURATION FILE
-[Drive A]
-.br
-Path=/mnt/fd0
-.br
-Type=floppy
-.PP
-[Drive C]
-.br
-Path=/dos
-.br
-Type=hd
-.br
-Label=DOS disk
-.PP
-[Drive D]
-.br
-Path=${HOME}/Wine
-.PP
-[wine]
-.br
-windows=c:\\windows
-.br
-system=c:\\windows\\system
-.br
-temp=c:\\temp
-.br
-path=c:\\windows;c:\\windows\\system;c:\\winapps\\word
-.br
-symboltablefile=/usr/local/lib/wine.sym
-.PP
-[serialports]
-.br
-com1=/dev/cua1
-.br
-com2=/dev/cua1
-.PP
-[parallelports]
-.br
-lpt1=/dev/lp0
-.PP
-[spy]
-.br
-;File=CON
-.br
-;File=spy.log
-.br
-Exclude=WM_TIMER;WM_SETCURSOR;WM_MOUSEMOVE;WM_NCHITTEST;
-.br
-Include=WM_COMMAND;
-.PP
-[Tweak.Layout]
-.br
-WineLook=Win95
+A sample configuration file is distributed as
+.B wine.ini
+in the top-level directory of the source distribution.
.SH AUTHORS
.B Wine
is available thanks to the work of many developers. For a listing
@@ -434,18 +394,19 @@ 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
+If you want to post a bug report, please read the file
.I documentation/bugreports
-in the Wine source.
+in the Wine source to see what information is necessary.
.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
-can be obtained via FTP from sunsite.unc.edu or tsx-11.mit.edu in the /pub/linux/ALPHA/Wine/development
-directory. The releases are in the format 'Wine-yymmdd.tar.gz',
-or 'Wine-yymmdd.diff.gz' for the diff's from the previous release.
+can be obtained via FTP from metalab.unc.edu or tsx-11.mit.edu in the
+/pub/linux/ALPHA/Wine/development directory. The releases are in the
+format 'Wine-yymmdd.tar.gz', or 'Wine-yymmdd.diff.gz' for the diff's
+from the previous release.
.PP
The latest snapshot of the code may be obtained via CVS. For information
on how to do this, please see