wine.conf.man 8.4 KB
Newer Older
1
.\" -*- nroff -*-
2
.TH WINE.CONF 5 "April 2004" "Version 20040408" "Wine Configuration File"
3 4 5 6 7
.SH NAME
wine.conf \- Wine configuration file
.SH DESCRIPTION
.B wine
expects a configuration file (
8 9
.I $WINEPREFIX/config
(~/.wine/config)
10
), which should conform to the following rules.
11
A sample configuration file is available as
12 13
.I documentation/samples/config
in the Wine source distribution.
14
.SH CONFIGURATION FILE FORMAT
15 16 17 18 19 20 21 22 23
The config file needs to start with the header line
.br
.I WINE REGISTRY Version 2
.br
to be recognized by
.B Wine.
.PP
All entries (excepting the header) are grouped in sections; a section
begins with the line
24 25 26 27 28 29
.br
.I [section name]
.br
and continues until the next section starts. Individual entries
consist of lines of the form
.br
30
.I """entry""=""value"""
31
.br
32 33
The entry and value can be any text strings, included in double
quotes; it can also contain references to environment variables
34
surrounded by
35 36
.I %
signs.
37 38 39
Inside the double quotes, special characters, backslashes and quotes
must be escaped with backslashes. Supported section names and entries
are listed below.
40 41 42
.PP
.B [wine]
.br
43
.I format: """windows""=""<directory>"""
44
.br
45
default: "C:\\\\WINDOWS"
46
.br
47 48 49 50 51 52
Used to specify where Wine is supposed to have its Windows directory
(which is an essential part of a Windows environment); make sure to double
the backslashes.
In case of e.g. C:\\WINDOWS, with drive C: being configured as
/home/user/wine_c, the /home/user/wine_c/WINDOWS directory would be used for
this.
53
.PP
54 55 56 57 58 59 60 61
.I format: """GraphicsDriver""=""<x11drv|ttydrv>"""
.br
default: "x11drv"
.br
Tells Wine which graphics driver to use. Normally you'd want to use
x11drv (for X11). In case you want to run programs as text console/TTY only
without having Wine rely on X11 support, then use ttydrv.
.PP
62 63 64 65 66 67 68 69
.I format: """ShowDirSymlinks""=""<0|1>"""
.br
default: "0"
.br
Wine doesn't pass directory symlinks to Windows programs by default.
Enabling this may crash some programs that do recursive lookups of a whole
subdir tree in case of a symlink pointing back to itself.
.PP
70 71 72 73 74 75 76 77 78
.I format: """ShowDotFiles""=""<0|1>"""
.br
default: "0"
.br
Under Unix, files starting with a dot, are considered hidden,
and should not be shown in directory listing (unless explicitly asked for),
just like DOS-style hidden files. If you want them treated as regular
files, set this value to 1.
.PP
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
.B [Version]
.br
.I format: """Windows""=""<version string>"""
.br
default: none; chosen by semi-intelligent detection mechanism based on DLL environment
.br
Used to specify which Windows version to return to programs (forced value,
overrides standard detection mechanism !).
Valid settings are e.g. "win31", "win95", "win98", "win2k", "winxp".
Also valid as an AppDefaults setting (recommended/preferred use).
.PP
.I format: """DOS""=""<version string>"""
.br
default: "<Windows version specific>"
.br
Used to specify the DOS version that should be returned to programs.
Only takes effect in case Wine acts as "win31" Windows version !
Common DOS version settings include 6.22, 6.20, 6.00, 5.00, 4.00, 3.30, 3.10.
Also valid as an AppDefaults setting (recommended/preferred use).
.PP
99
.B [DllOverrides]
100
.br
Eric Pouech's avatar
Eric Pouech committed
101
.I format: """modulename""=""native,builtin"""
102
.br
103
.I modulename
104 105 106
can be any valid DLL module name. If no extension is specified .dll is
assumed. The specified value is a comma separated list of module-types
to try to load in that specific order. Case is not important and only
Eric Pouech's avatar
Eric Pouech committed
107
the first letter of each type is enough to identify the type n[ative]
108 109 110 111 112 113
or b[uiltin]. Also whitespace is ignored. See also the description of
the
.I WINEDLLOVERRIDES
environment variable in
.BR wine (1)
for details about the allowed types.
114
.br
115 116 117 118
The wildcard entry
.I """*"""
specifies the load order to use for modules not explicitly
mentioned. If the wildcard entry is not found, then the order
Eric Pouech's avatar
Eric Pouech committed
119
"native,builtin" is used.
120 121 122
.br
Examples:
.br
123
.I """kernel32""=""builtin"""
124
.br
125
.I """comdlg32""=""native,builtin"""
126
.br
127
.I """*""=""builtin,native"""
128
.br
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
When the specified module name does not contain a path, it matches
only dlls loaded from the Windows system directory. If the application
explicitly loads a dll from a different directory, it has to be
configured separately. This can be done either by specifying the full
path in the module name, or by using a path wildcard of the form
.I """*modulename""".
.br
For instance, the following will load the native shell32 when loaded
from C:\\Program Files, and the builtin when loaded from any other
directory:
.br
.I """C:\\\\\\\\Program Files\\\\\\\\shell32"" = ""native"""
.br
.I """*shell32"" = ""builtin"""
.br
Changing the load order of low-level dlls like kernel32, gdi32 or
user32 to anything other than builtin will cause wine to fail because
wine cannot use native versions for these libraries.
147 148 149 150
.br
Always make sure that you have some kind of strategy in mind when you start
fiddling with the current defaults and needless to say that you must know
what you are doing.
151
WINEDEBUG=loaddll might come in handy for experimenting with that stuff.
152
.PP
153
.B [Debug]
154
.br
155
.I format: """SpyExclude""=""<message names separated by semicolons>"""
156 157 158 159 160
.br
default: none
.br
Used to specify which messages will be excluded from the logfile.
.PP
161
.I format: """SpyInclude""=""<message names separated by semicolons>"""
162 163 164 165
.br
default: none
.br Used to specify which messages will be included in the logfile.
.PP
166
.I format: """RelayFromExclude""=""<module names separated by semicolons>"""
167 168 169
.br
default: none
.br
170
Used to specify a set of modules whose calls are excluded from a relay debug log.
171
.PP
172
.I format: """RelayFromInclude""=""<module names separated by semicolons>"""
173
.br
174
default: include all modules
175
.br 
176
Used to specify the set of modules whose calls are included in a relay debug log.
177
.PP
178
.I format: """RelayExclude""=""<functions or dll.functions separated by semicolons>"""
179 180
.br
default: none
181
.br
182
Used to specify which functions will be excluded from a relay debug log.
183
.PP
184
.I format: """RelayInclude""=""<functions or dll.functions separated by semicolons>"""
185
.br
186
default: include all functions
187
.br 
188
Used to specify which functions will be included in a relay debug log.
189
.PP
190
.I format: """SnoopExclude""=""<functions or dll.functions separated by semicolons>"""
191 192 193
.br
default: none
.br 
194
Used to specify which functions will be excluded from the snoop debug log.
195
.PP
196
.I format: """SnoopInclude""=""<functions or dll.functions separated by semicolons>"""
197
.br
198
default: include all functions
199
.br 
200
Used to specify which functions will be included in the snoop debug log.
201 202
.PP
For Relay and Snoop <dllname>.* includes or excludes the whole dll. Exclude
203
entries have priority over Include entries.
204
.PP
205 206
.B [Registry]
.br
207
.I format: """LoadGlobalRegistryFiles""=""<boolean>"""
208 209 210
.br
Global registries (stored in /etc)
.PP
211
.I format: """LoadHomeRegistryFiles""=""<boolean>"""
212 213 214
.br
Home registries (stored in ~user/.wine/)
.PP
215
.I format: """WritetoHomeRegistryFiles""=""<boolean>"""
216
.br
217
TRY to write all changes to the home registry files
218
.PP
219
.I format: """LoadWindowsRegistryFiles""=""<boolean>"""
220
.br
221
Load Windows registry from the current Windows directory.
222 223 224
.PP
booleans: Y/y/T/t/1 are true, N/n/F/f/0 are false.
.br
225
Defaults are read all, write to home files.
226
.PP
227 228 229 230 231 232 233
.B [Network]
.br
.I format: """UseDnsComputerName""=""<boolean>"""
.br
If Y, always override the registry setting for ComputerName
with the Unix hostname.
.PP
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
.B [AppDefaults\\\\\\\\<appname>\\\\\\\\...]
.PP
This section allows specifying application-specific values for
the other sections described above.
.I <appname>
is the name of the application exe file, without path. The "..."
should be replaced by the name of one of the above configuration
sections.
.br
Example:
.br
.I [AppDefaults\\\\\\\\sol.exe\\\\\\\\DllOverrides]
.br
.I """shell32""" = """native"""
.br
means that Solitaire will use "native" load order for the shell32
dll. All other applications will continue to use what was specified in
the general
.I DllOverrides
section.
.br
255 256
The only sections that support application-specific information at the
moment are
257
.I DllOverrides, dsound, Version
258
and
259
.I x11drv.
260 261 262
.br
Make sure to use double backslashes in the section name.
.PP
263 264
.SH SAMPLE CONFIGURATION FILE
A sample configuration file is distributed as
265 266 267
.B documentation/samples/config
in the Wine source distribution.
.SH ENVIRONMENT VARIABLES
268
.TP
269 270 271
.I WINEPREFIX
Specifies the directory that contains the per-user
.I config
272
file, the registry files, and the DOS device mappings. The default is
273
.I $HOME/.wine.
274 275 276 277
.SH FILES
.TP
.I $WINEPREFIX/config
User-specific configuration file
278 279
.SH "SEE ALSO"
.BR wine (1)