Avoid returning an unlocked window pointer from WINPOS_WindowFromPoint.
[wine] / documentation / wine.conf.man.in
1 .\" -*- nroff -*-
2 .TH WINE.CONF 5 "December 5, 2000" "Version 20001202" "Wine Configuration File"
3 .SH NAME
4 wine.conf \- Wine configuration file
5 .SH DESCRIPTION
6 .B wine
7 expects a configuration file (
8 .I @sysconfdir@/wine.conf
9 ), which should conform to the following rules. Common locations are
10 /usr/local/etc/wine.conf or (in some distributions)
11 /etc/wine.conf. The actual directory where that file resides may be
12 specified during the execution of the
13 .B configure
14 script with the --sysconfdir option. Alternatively, you may have a
15 file named
16 .I config
17 in this format in your ~/.wine directory or in the directory named in
18 the
19 .B WINEPREFIX
20 environment variable.  A sample configuration file is available as
21 .I documentation/samples/config
22 in the Wine source distribution.
23 .SH CONFIGURATION FILE FORMAT
24 All entries are grouped in sections; a section begins with the line
25 .br
26 .I [section name]
27 .br
28 and continues until the next section starts. Individual entries
29 consist of lines of the form
30 .br
31 .I """entry""=""value"""
32 .br
33 The entry and value can be any text strings, included in double
34 quotes; it can also contain references to environment variables
35 surrounded by
36 .I ${}.
37 Inside the double quotes, special characters, backslashes and quotes
38 must be escaped with backslashes. Supported section names and entries
39 are listed below.
40 .PP
41 .B [Drive X]
42 .br
43 This section is used to specify the root directory and type of each
44 .B DOS
45 drive, since most Windows applications require a DOS/MS-Windows based 
46 disk drive & directory scheme. There is one such section for every
47 drive you want to configure.
48 .PP
49 .I format: """Path""=""<rootdirectory>"""
50 .br
51 default: none
52 .br
53 If you mounted your dos partition as 
54 .I /dos
55 and installed Microsoft Windows in 
56 C:\\WINDOWS then you should specify 
57 .I """Path""=""/dos"""
58 in the
59 .I [Drive C]
60 section.
61 .PP
62 .I format: """Type""=""<type>"""
63 .br
64 default: "hd"
65 .br
66 Used to specify the drive type this drive appears as in Windows
67 or DOS programs; supported types are "floppy", "hd", "cdrom"
68 and "network".
69 .PP
70 .I format: """Label""=""<label>"""
71 .br
72 default: "Drive X"
73 .br
74 Used to specify the drive label; limited to 11 characters.
75 .PP
76 .I format: """Serial""=""<serial>"""
77 .br
78 default: "12345678"
79 .br
80 Used to specify the drive serial number, as an 8-character hexadecimal
81 number.
82 .PP
83 .I format: """Filesystem""=""<fstype>"""
84 .br
85 default: "win95"
86 .br
87 Used to specify the type of the file system Wine should emulate on a given
88 directory structure/underlying file system.
89 .br
90 Supported types are "msdos" (or "fat"), "win95" (or "vfat"), "unix".
91 .br
92 Recommended:
93 .br
94   "win95" for ext2fs, VFAT and FAT32
95 .br
96   "msdos" for FAT16 (ugly)
97 .br
98 You definitely do not want to use "unix" unless you intend to port
99 programs using Winelib.  Always try to avoid using FAT16. Use the
100 VFAT/FAT32 OS file system driver instead.
101 .PP
102 .I format: """FailReadOnly""=""<boolean>"""
103 .br
104 Read-only files may not be opened in write mode (the default is to
105 allow opening read-only files for writing, because most Windows
106 programs always request read-write access, even on CD-ROM drives...).
107 .PP
108 .B [wine]
109 .br
110 .I format: """windows""=""<directory>"""
111 .br
112 default: "C:\\\\WINDOWS"
113 .br
114 Used to specify a different Windows directory; make sure to double the
115 backslashes.
116 .PP
117 .I format: """system""=""<directory>"""
118 .br
119 default: "C:\\\\WINDOWS\\\\SYSTEM"
120 .br
121 Used to specify a different system directory; make sure to double the
122 backslashes.
123 .PP
124 .I format: """temp""=""<directory>"""
125 .br
126 default: "C:\\\\TEMP"
127 .br
128 Used to specify a directory where Windows applications can store 
129 temporary files.
130 .PP
131 .I format: """profile""=""<directory>"""
132 .br
133 default: nothing
134 .br
135 Used to specify a directory where Windows stores special folders and
136 the user-registry files (user.dat or ntuser.dat).  Mapped to
137 environment variable %USERPROFILE%.  Set this value when running with
138 a native NT or a native win95 directory with per-user settings.
139 .PP
140 .I format: """path""=""<directories separated by semi-colons>"""
141 .br
142 default: "C:\\\\WINDOWS;C:\\\\WINDOWS\\\\SYSTEM"
143 .br
144 Used to specify the path which will be used to find executables and
145 dlls. Make sure to double all the backslashes.
146 .PP
147 .B [DllOverrides]
148 .br
149 .I format: """modulename""=""native,so,builtin"""
150 .br
151 .I modulename
152 can be any valid module name, without extension. The specified value
153 is a comma separated list of module-types to try to load in that
154 specific order. Case is not important and only the first letter of
155 each type is enough to identify the type n[ative], s[o],
156 b[uiltin]. Also whitespace is ignored. See also commandline option
157 .I --dll
158 for details about the allowable types.
159 .br
160 The wildcard entry
161 .I """*"""
162 specifies the load order to use for modules not explicitly
163 mentioned. If the wildcard entry is not found, then the order
164 "native,builtin,so" is used.
165 .br
166 Examples:
167 .br
168 .I """kernel32""=""builtin"""
169 .br
170 .I """kernel""=""builtin"""
171 .br
172 .I """comdlg32""=""native,builtin"""
173 .br
174 .I """*""=""builtin,native"""
175 .br
176 Changing the load order of kernel/kernel32 and gdi/gdi32 to
177 anything other than builtin will cause wine to fail because wine cannot
178 use native versions for these libraries.
179 .br
180 Always make sure that you have some kind of strategy in mind when you start
181 fiddling with the current defaults and needless to say that you must know
182 what you are doing.
183 .PP
184 .B [serialports]
185 .br
186 .I format: """com[12345678]""=""<devicename>"""
187 .br
188 default: none
189 .br
190 Used to specify the devices which are used as COM1 - COM8.
191 .PP
192 .B [parallelports]
193 .br
194 .I format: """lpt[12345678]""=""<devicename>"""
195 .br
196 default: none
197 .br
198 Used to specify the devices which are used as LPT1 - LPT8.
199 .PP
200 .B [spy]
201 .br
202 .I format: """exclude""=""<message names separated by semicolons>"""
203 .br
204 default: none
205 .br
206 Used to specify which messages will be excluded from the logfile.
207 .PP
208 .I format: """include""=""<message names separated by semicolons>"""
209 .br
210 default: none
211 .br Used to specify which messages will be included in the logfile.
212 .PP
213 .B [Tweak.Layout]
214 .br
215 .I format: """WineLook""=""<Win31|Win95|Win98>"""
216 .br
217 default: "Win31"
218 .br 
219 Use Win95-like window displays or Win3.1-like window displays.
220 .PP
221 .B [Registry]
222 .br
223 .I format: """LoadGlobalRegistryFiles""=""<boolean>"""
224 .br
225 Global registries (stored in /etc)
226 .PP
227 .I format: """LoadHomeRegistryFiles""=""<boolean>"""
228 .br
229 Home registries (stored in ~user/.wine/)
230 .PP
231 .I format: """WritetoHomeRegistryFiles""=""<boolean>"""
232 .br
233 TRY to write all changes to the home registry files
234 .PP
235 .I format: """LoadWindowsRegistryFiles""=""<boolean>"""
236 .br
237 Load Windows registry from the current Windows directory. 
238 .PP
239 booleans: Y/y/T/t/1 are true, N/n/F/f/0 are false.
240 .br
241 Defaults are read all, write to home files.
242 .PP
243 .B [AppDefaults\\\\\\\\<appname>\\\\\\\\...]
244 .PP
245 This section allows specifying application-specific values for
246 the other sections described above.
247 .I <appname>
248 is the name of the application exe file, without path. The "..."
249 should be replaced by the name of one of the above configuration
250 sections.
251 .br
252 Example:
253 .br
254 .I [AppDefaults\\\\\\\\sol.exe\\\\\\\\DllOverrides]
255 .br
256 .I """shell32""" = """native"""
257 .br
258 means that Solitaire will use "native" load order for the shell32
259 dll. All other applications will continue to use what was specified in
260 the general
261 .I DllOverrides
262 section.
263 .br
264 The only section that supports application-specific information at the
265 moment is
266 .I DllOverrides.
267 .br
268 Make sure to use double backslashes in the section name.
269 .PP
270 .SH SAMPLE CONFIGURATION FILE
271 A sample configuration file is distributed as
272 .B documentation/samples/config
273 in the Wine source distribution.
274 .SH FILES
275 .TP
276 .I @sysconfdir@/wine.conf
277 Global configuration file for wine.
278 .TP
279 .I ~/.wine/config
280 User-specific configuration file
281 .SH ENVIRONMENT VARIABLES
282 .TP 
283 .I WINEPREFIX
284 Specifies the directory that contains the per-user
285 .I config
286 file, the registry files, and the wineserver socket. The default is
287 .I $HOME/.wine.
288 .SH "SEE ALSO"
289 .BR wine (1)