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