msvcrt: Fix _getw.
[wine] / README
diff --git a/README b/README
index 09eb3de..029f592 100644 (file)
--- a/README
+++ b/README
-Copyright  Robert J. Amstadt, 1993.  All code is provided without
-warranty.  It is my intent to cover this code with the Gnu Public
-License.
-
-So here goes release 0.0.2 of the Windows loader.  It will do some 
-relocations and then run the program.  The program test.exe is a 
-Windows executable.  Try the command "wine test.exe".
-
-WHAT'S NEW with version 0.0.2:
-
-    - Again thanks to Eric Youngdale for some very useful comments.
-    - The Windows startup code created by Micrsoft C 7.0 now runs 
-      to completion.
-    - Added a new patch to the kernel to increase the usable size of
-      the ldt to the full 32 entries currently allowed.
-    - Imported name relocations are now supported.
-    - Source code for my infamous test program is now included.
-    - A handful of basic Windows functions are now emulated.  See
-      "kernel.spec" for examples of how to use the build program.
-
-WHAT'S NEW with version 0.0.1:
-
-    - Eric Youngdale contributed countless improvements in memory
-      efficiency, bug fixes, and relocation.
-    - The build program has been completed.  It now lets you specify
-      how the main DLL entry point should interface to your emulation
-      library routines.  A brief description of how to build these
-      specifications is included in the file "build-spec.txt".
-    - The code to dispatch builtin DLL calls is complete, but untested.
-
-TODO:
-
-    - Segment fixup code completion.
-    - Make changes to the kernel to allow more than 32 LDT entries.
-    - Trap and handle DOS and DPMI calls.
-    - Windows emulation library (connect to Peter MacDonald's library).
-    - Set registers correctly when starting Windows program.
-    - Allowing loading of 16-bit DLLs for use with program.
-    - global memory allocation
-    - complete and improve local heap allocation
-
-INSTALLATION:
-
-    Uncompress and untar this archive into the directory of your
-choice.  The file "ldt.tar" contains a necessary kernel patch against
-Linux 0.99.10.  If you installed the "ldt.tar" from the first release
-of this package, then you MUST to replace it.  In the directory 
-/usr/src/linux (or whereever you keep your kernel sources), untar 
-this file it contains three files:
-
-       kernel/ldt.c
-               - This is source for a new system call.
-       
-       include/linux/ldt.h
-               - This contains structures defining the system call
-                 interface.
-
-       ldt.patch
-               - This is a patch that must be applied to the kernel.
-                 It updates two header files, and the kernel Makefile.
-
-BUILD:
-
-    The documentation for the build program is in the file build-spec.txt
-
-FINALE:
-
-Good luck,
-
-       If you successfully add anything, please send me a copy.
-
-Bob Amstadt
-bob@amscons.com
+1. INTRODUCTION
+
+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 (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.
+
+2. QUICK START
+
+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 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
+  NetBSD-current
+
+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.
+
+FreeBSD info:
+  Wine should build on FreeBSD 4.x and FreeBSD 5.x, but versions before
+  FreeBSD 5.3 will generally not work properly.
+  More information can be found in the FreeBSD ports tree at
+  <ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/>.
+
+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.
+
+
+
+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.
+
+Basic requirements:
+  You need to have the X11 development include files installed
+  (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
+
+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.
+
+  Of course you also need "make" (most likely GNU make).
+
+  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.
+  Install the libxml2 package to get a functional msxml implementation.
+
+4. COMPILATION
+
+In case you chose to not use wineinstall, run the following commands
+to build Wine:
+
+./configure
+make depend
+make
+
+This will build the program "wine" and numerous support libraries/binaries.
+The program "wine" will load and run Windows executables.
+The library "libwine" ("Winelib") can be used to compile and link
+Windows source code under Unix.
+
+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
+
+where "patch-file" is the name of the patch file (something like
+Wine-yymmdd.diff.gz). 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
+will install the wine executable, the Wine man page, and a few other
+needed files.
+
+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.
+
+See the Support area at http://www.winehq.org/ for 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:
+
+       wine sol                   (using the search Path as specified in
+       wine sol.exe                the config file to locate the file)
+
+       wine c:\\windows\\sol.exe  (using DOS filename syntax)
+
+       wine /usr/windows/sol.exe  (using Unix filename syntax)
+
+        wine sol.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
+
+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,
+       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.
+       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.
+
+Mailing lists:
+       There are several mailing lists for Wine developers; see
+       http://www.winehq.org/forums for more information.
+
+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@winehq.org