mshtml: Declare prototype of wine_dos_get_file_name correctly; fixes Gecko install...
[wine] / README
diff --git a/README b/README
index a007111..9678e17 100644 (file)
--- a/README
+++ b/README
 1. INTRODUCTION
 
-Wine is a program that allows running MS-Windows programs under X11.
-It consists of a program loader, that loads and executes an
-MS-Windows binary, and of an emulation library that translates Windows
-API calls to their Unix/X11 equivalent.
+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. See the file LICENSE for the details.
-Basically, you can do anything with it, except claim that you wrote it.
+Wine is free software, released under the GNU LGPL; see the file
+LICENSE for the details.
 
 
-2. COMPILATION
+2. QUICK START
 
-You must have one of:
+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:
 
-       Linux version 0.99.13 or above
-       NetBSD-current
-       FreeBSD-current or FreeBSD 1.1
+./tools/wineinstall
 
-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.
+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.
 
-To build Wine, first do a "./Configure" and then a "make" (or "gmake"
-if you're running *BSD).  The executable "wine" will be built.  "wine"
-will load and run 16-bit Windows executables. 
 
-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:
+3. REQUIREMENTS
 
-    gunzip -c patch-file | patch -p1
+To compile and run Wine, you must have one of the following:
 
-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". 
+  Linux version 2.0.36 or above
+  FreeBSD 6.3 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.
 
-3. SETUP
+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.
 
-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
-in your home directory.
+FreeBSD info:
+  Wine will generally not work properly on versions before FreeBSD
+  6.3 or 7.0, and FreeBSD 6.3 has additional patches available. See
+  <http://wiki.freebsd.org/Wine> for more information.
 
-The format of this config file is just like a Windows .ini file.
-The file wine.ini contains a config file example.
+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.
 
-Here's an explanation of each section:
+NetBSD info:
+  Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
+  turned on in your kernel.
 
-* [drives]
+Mac OS X info:
+  You need Xcode 2.4 or later to build properly on x86.
 
-format: <driveletter> = <rootdirectory>
-default: none
 
-This section is used to specify the root directory of each `dos'drive 
-as Windows' applications require a dos/mswindows based diskdrive & 
-directory scheme. 
+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.
 
-If you mounted your dos-partition as /dos and installed Microsoft Windows 
-in c:\windows than you should specify c=/dos in the drives section.
+Basic requirements:
+  You need to have the X11 development include files installed
+  (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
 
-* [wine]
+  Of course you also need "make" (most likely GNU make).
 
-format: windows = <directory>
-default: c:\windows
+  You also need flex version 2.5 or later and bison.
 
-Used to specify an different windows directory.
+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.
 
-format: system = <directory>
-default: c:\windows\system
+  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.
 
-Used to specify an different system directory.
+4. COMPILATION
 
-format: temp = <directory>
-default: c:\temp
+In case you chose to not use wineinstall, run the following commands
+to build Wine:
 
-Used to specify a directory where Windows applications can store temporary
-files.
+./configure
+make depend
+make
 
-format: path = <directories separated by semi-colons>
-default: c:\windows;c:\windows\system
+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.
 
-Used to specify the path which will be used to find executables and DLL's.
+To see compile configuration options, do ./configure --help.
 
-format: systemresources = <filename>
-default: c:\temp
+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:
 
-Used to specify the name of sysres.dll, a dll which is used by Wine itself.
+    bunzip2 -c patch-file | patch -p1
 
-* [serialports]
+where "patch-file" is the name of the patch file (something like
+wine-1.0.x.diff.bz2). You can then re-run "./configure", and then
+run "make depend && make".
 
-format: com[12345678] = <devicename>
-default: none
 
-Used to specify the devices which are used as com1 - com8.
+5. SETUP
 
-* [parallelports]
+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.
 
-format: lpt[12345678] = <devicename>
-default: none
+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.
 
-Used to specify the devices which are used as lpt1 - lpt8.
+Once installed, you can run the "winecfg" configuration tool. See the
+Support area at http://www.winehq.org/ for configuration hints.
 
-* [spy]
 
-format: file = <filename or CON when logging to stdout>
-default: none
+6. RUNNING PROGRAMS
 
-used to specify the file which will be used as logfile.
+When invoking Wine, you may specify the entire path to the executable,
+or a filename only.
 
-format: exclude = <message names separated by semicolons>
-default: none
+For example: to run Notepad:
 
-Used to specify which messages will be excluded from the logfile.
+       wine notepad               (using the search Path as specified in
+       wine notepad.exe            the config file to locate the file)
 
-format: include = <message names separated by semicolons>
-default: none
+       wine c:\\windows\\notepad.exe  (using DOS filename syntax)
 
-Used to specify which messages will be included in the logfile.
+       wine ~/.wine/drive_c/windows/notepad.exe  (using Unix filename syntax)
 
+        wine notepad.exe /parameter1 -parameter2 parameter3
+                                  (calling program with parameters)
 
-4. RUNNING PROGRAMS
+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.
 
-When invoking Wine, you must specify the entire path to the executable,
-or a filename only.
 
-For example: to run Windows' solitaire:
+7. GETTING MORE INFORMATION
 
-       wine sol                   (using the searchpath to locate the file)
-       wine sol.exe
+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.
 
-       wine c:\\windows\\sol.exe  (using a dosfilename)
+FAQ:   The Wine FAQ is located at http://www.winehq.org/FAQ
 
-       wine /usr/windows/sol.exe  (using a unixfilename)
+Usenet:        You can discuss Wine-related issues and get help
+       on comp.emulators.ms-windows.wine.
 
-Note: the path of the file will also be added to the path when
-      a full name is supplied on the commandline.
+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.
 
-Have a nice game of solitaire, but be careful.  Emulation isn't perfect.
-So, occasionally it may crash.
+IRC:   Online help is available at channel #WineHQ on irc.freenode.net.
 
+Git:   The current Wine development tree is available through Git.
+       Go to http://www.winehq.org/site/git for more information.
 
-5. GETTING MORE INFORMATION
+Mailing lists:
+       There are several mailing lists for Wine users and developers;
+       see http://www.winehq.org/forums for more information.
 
-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.
+Wiki:  The Wine Wiki is located at http://wiki.winehq.org
 
-If you add something, or fix a bug, please send a patch to
-wine-new@amscons.com for inclusion in the next release.
+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@lamisun.epfl.ch
+julliard@winehq.org