Release 951226
[wine/gsoc-2012-control.git] / README
blobe00a17764156572c0162c4c54a742c31d950410b
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.
12 2. COMPILATION
14 You must have one of:
16         Linux version 0.99.13 or above
17         NetBSD-current
18         FreeBSD-current or FreeBSD 1.1
20 You also need to have libXpm installed on your system. The sources for
21 it are probably available on the ftp site where you got Wine. They can
22 also be found on ftp.x.org and all its mirror sites.
24 To build Wine, first do a "./configure" and then a "make depend; make".
25 The executable "wine" will be built.  "wine" will load and run 16-bit
26 Windows executables.
28 To upgrade to a new release by using a patch file, first cd to the
29 top-level directory of the release (the one containing this README
30 file). Then do a "make clean", and patch the release with:
32     gunzip -c patch-file | patch -p1
34 where "patch-file" is the name of the patch file (something like
35 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
36 run "make depend; make".
39 3. SETUP
41 Wine requires you to have a file /usr/local/etc/wine.conf (you can
42 supply a different name when configuring wine) or a file called .winerc
43 in your home directory.
45 The format of this config file is just like a Windows .ini file.
46 The file wine.ini contains a config file example.
48 Here's an explanation of each section:
50 * [drives]
52 format: <driveletter> = <rootdirectory>
53 default: none
55 This section is used to specify the root directory of each `dos'drive 
56 as Windows' applications require a dos/mswindows based diskdrive & 
57 directory scheme. 
59 If you mounted your dos-partition as /dos and installed Microsoft Windows 
60 in c:\windows than you should specify c=/dos in the drives section.
62 * [wine]
64 format: windows = <directory>
65 default: c:\windows
67 Used to specify an different windows directory.
69 format: system = <directory>
70 default: c:\windows\system
72 Used to specify an different system directory.
74 format: temp = <directory>
75 default: c:\temp
77 Used to specify a directory where Windows applications can store temporary
78 files.
80 format: path = <directories separated by semi-colons>
81 default: c:\windows;c:\windows\system
83 Used to specify the path which will be used to find executables and DLL's.
85 format: symboltablefile = <filename>
86 default: wine.sym
88 Used to specify the path and file name of the symbol table used by the
89 built-in debugger.
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: exclude = <message names and/or EXCLUDEALL separated by commas >
108 default: none
110 Used to specify which messages will be excluded from the message logging.
112 format: include = <message names and/or INCLUDEALL separated by commas >
113 default: none
115 Used to specify which messages will be included in the message logging.
118 4. RUNNING PROGRAMS
120 When invoking Wine, you must specify the entire path to the executable,
121 or a filename only.
123 For example: to run Windows' solitaire:
125         wine sol                   (using the searchpath to locate the file)
126         wine sol.exe
128         wine c:\\windows\\sol.exe  (using a dosfilename)
130         wine /usr/windows/sol.exe  (using a unixfilename)
132 Note: the path of the file will also be added to the path when
133       a full name is supplied on the commandline.
135 Have a nice game of solitaire, but be careful.  Emulation isn't perfect.
136 So, occasionally it may crash.
139 5. GETTING MORE INFORMATION
141 The best place to get help or to report bugs is the Usenet newsgroup
142 comp.emulators.ms-windows.wine. The Wine FAQ is posted there every
143 month.
145 If you add something, or fix a bug, please send a patch ('diff -u'
146 format preferred) to wine-new@amscons.com for inclusion in the next
147 release.
150 Alexandre Julliard
151 julliard@lrc.epfl.ch