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