Release 950109
[wine/multimedia.git] / README
blobd172aa956422f13fa300bde6cb5e6d60525df771
1 1. INTRODUCTION
3 Wine is a program that allows running MS-Windows programs under X11.
4 It consists of a program loader, that loads and executes an
5 MS-Windows binary, and of an emulation library that translates Windows
6 API calls to their Unix/X11 equivalent.
8 Wine is free software. See the file LICENSE for the details.
9 Basically, you can do anything with it, except claim that you wrote it.
11 Important note: current versions of Wine include a built-in debugger
12 for 16-bit code, that is based on code from gdb. This means that if
13 you redistribute a version of Wine that includes this debugger, you
14 must follow the terms of the GNU General Public License.
17 2. COMPILATION
19 You must have one of:
21         Linux version 0.99.13 or above
22         NetBSD-current
23         FreeBSD-current or FreeBSD 1.1
25 To build Wine, first do a "./Configure" and then a "make" (or "gmake"
26 if you're running *BSD).  The executable "wine" will be built.  "wine"
27 will load and run 16-bit Windows' executables. 
29 To upgrade to a new release by using a patch file, first cd to the
30 top-level directory of the release (the one containing this README
31 file). Then do a "make clean", and patch the release with:
33     gunzip -c patch-file | patch -p1
35 where "patch-file" is the name of the patch file (something like
36 Wine-yymmdd.diff.gz). You can then re-run "./Configure", and then
37 run "make". 
40 3. SETUP
42 Wine requires you to have a file /usr/local/etc/wine.conf (you can
43 supply a different name when configuring wine) or a file called .winerc
44 in your home directory.
46 The format of this config file is just like a Windows .ini file.
47 The file wine.ini contains a config file example.
49 Here's an explanation of each section:
51 * [drives]
53 format: <driveletter> = <rootdirectory>
54 default: none
56 This section is used to specify the root directory of each `dos'drive 
57 as Windows' applications require a dos/mswindows based diskdrive & 
58 directory scheme. 
60 If you mounted your dos-partition as /dos and installed Microsoft Windows 
61 in c:\windows than you should specify c=/dos in the drives section.
63 * [wine]
65 format: windows = <directory>
66 default: c:\windows
68 Used to specify an different windows directory.
70 format: system = <directory>
71 default: c:\windows\system
73 Used to specify an different system directory.
75 format: temp = <directory>
76 default: c:\temp
78 Used to specify a directory where Windows applications can store temporary
79 files.
81 format: path = <directories separated by semi-colons>
82 default: c:\windows;c:\windows\system
84 Used to specify the path which will be used to find executables and DLL's.
86 format: systemresources = <filename>
87 default: c:\temp
89 Used to specify the name of sysres.dll, a dll which is used by Wine itself.
91 * [serialports]
93 format: com[12345678] = <devicename>
94 default: none
96 Used to specify the devices which are used as com1 - com8.
98 * [parallelports]
100 format: lpt[12345678] = <devicename>
101 default: none
103 Used to specify the devices which are used as lpt1 - lpt8.
105 * [spy]
107 format: file = <filename or CON when logging to stdout>
108 default: none
110 used to specify the file which will be used as logfile.
112 format: exclude = <message names separated by semicolons>
113 default: none
115 Used to specify which messages will be excluded from the logfile.
117 format: include = <message names separated by semicolons>
118 default: none
120 Used to specify which messages will be included in the logfile.
123 4. RUNNING PROGRAMS
125 When invoking Wine, you must specify the entire path to the executable,
126 or a filename only.
128 For example: to run Windows' solitaire:
130         wine sol                   (using the searchpath to locate the file)
131         wine sol.exe
133         wine c:\\windows\\sol.exe  (using a dosfilename)
135         wine /usr/windows/sol.exe  (using a unixfilename)
137 Note: the path of the file will also be added to the path when
138       a full name is supplied on the commandline.
140 Have a nice game of solitaire, but be careful.  Emulation isn't perfect.
141 So, occasionally it may crash.
144 5. GETTING MORE INFORMATION
146 The best place to get help or to report bugs is the Usenet newsgroup
147 comp.emulators.ms-windows.wine. The Wine FAQ is posted there every
148 month.
150 If you add something, or fix a bug, please send a patch to
151 wine-new@amscons.com for inclusion in the next release.
154 Alexandre Julliard
155 julliard@lamisun.epfl.ch