Fix spelling errors discovered by Marcelo Duarte.
[wine] / documentation / wine.conf.man
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: """GraphicsDriver""=""<x11drv|ttydrv>"""
44 .br
45 default: "x11drv"
46 .br
47 Tells Wine which graphics driver to use. Normally you'd want to use
48 x11drv (for X11). In case you want to run programs as text console/TTY only
49 without having Wine rely on X11 support, then use ttydrv.
50 .PP
51 .I format: """ShowDirSymlinks""=""<0|1>"""
52 .br
53 default: "0"
54 .br
55 Wine doesn't pass directory symlinks to Windows programs by default.
56 Enabling this may crash some programs that do recursive lookups of a whole
57 subdir tree in case of a symlink pointing back to itself.
58 .PP
59 .I format: """ShowDotFiles""=""<0|1>"""
60 .br
61 default: "0"
62 .br
63 Under Unix, files starting with a dot, are considered hidden,
64 and should not be shown in directory listing (unless explicitly asked for),
65 just like DOS-style hidden files. If you want them treated as regular
66 files, set this value to 1.
67 .PP
68 .B [Version]
69 .br
70 .I format: """Windows""=""<version string>"""
71 .br
72 default: none; chosen by semi-intelligent detection mechanism based on DLL environment
73 .br
74 Used to specify which Windows version to return to programs (forced value,
75 overrides standard detection mechanism !).
76 Valid settings are e.g. "win31", "win95", "win98", "win2k", "winxp".
77 Also valid as an AppDefaults setting (recommended/preferred use).
78 .PP
79 .I format: """DOS""=""<version string>"""
80 .br
81 default: "<Windows version specific>"
82 .br
83 Used to specify the DOS version that should be returned to programs.
84 Only takes effect in case Wine acts as "win31" Windows version !
85 Common DOS version settings include 6.22, 6.20, 6.00, 5.00, 4.00, 3.30, 3.10.
86 Also valid as an AppDefaults setting (recommended/preferred use).
87 .PP
88 .B [DllOverrides]
89 .br
90 .I format: """modulename""=""native,builtin"""
91 .br
92 .I modulename
93 can be any valid DLL module name. If no extension is specified .dll is
94 assumed. The specified value is a comma separated list of module-types
95 to try to load in that specific order. Case is not important and only
96 the first letter of each type is enough to identify the type n[ative]
97 or b[uiltin]. Also whitespace is ignored. See also the description of
98 the
99 .I WINEDLLOVERRIDES
100 environment variable in
101 .BR wine (1)
102 for details about the allowed types.
103 .br
104 The wildcard entry
105 .I """*"""
106 specifies the load order to use for modules not explicitly
107 mentioned. If the wildcard entry is not found, then the order
108 "native,builtin" is used.
109 .br
110 Examples:
111 .br
112 .I """kernel32""=""builtin"""
113 .br
114 .I """comdlg32""=""native,builtin"""
115 .br
116 .I """*""=""builtin,native"""
117 .br
118 When the specified module name does not contain a path, it matches
119 only dlls loaded from the Windows system directory. If the application
120 explicitly loads a dll from a different directory, it has to be
121 configured separately. This can be done either by specifying the full
122 path in the module name, or by using a path wildcard of the form
123 .I """*modulename""".
124 .br
125 For instance, the following will load the native shell32 when loaded
126 from C:\\Program Files, and the builtin when loaded from any other
127 directory:
128 .br
129 .I """C:\\\\\\\\Program Files\\\\\\\\shell32"" = ""native"""
130 .br
131 .I """*shell32"" = ""builtin"""
132 .br
133 Changing the load order of low-level dlls like kernel32, gdi32 or
134 user32 to anything other than builtin will cause wine to fail because
135 wine cannot use native versions for these libraries.
136 .br
137 Always make sure that you have some kind of strategy in mind when you start
138 fiddling with the current defaults and needless to say that you must know
139 what you are doing.
140 WINEDEBUG=loaddll might come in handy for experimenting with that stuff.
141 .PP
142 .B [Debug]
143 .br
144 .I format: """SpyExclude""=""<message names separated by semicolons>"""
145 .br
146 default: none
147 .br
148 Used to specify which messages will be excluded from the logfile.
149 .PP
150 .I format: """SpyInclude""=""<message names separated by semicolons>"""
151 .br
152 default: none
153 .br Used to specify which messages will be included in the logfile.
154 .PP
155 .I format: """RelayFromExclude""=""<module names separated by semicolons>"""
156 .br
157 default: none
158 .br
159 Used to specify a set of modules whose calls are excluded from a relay debug log.
160 .PP
161 .I format: """RelayFromInclude""=""<module names separated by semicolons>"""
162 .br
163 default: include all modules
164 .br 
165 Used to specify the set of modules whose calls are included in a relay debug log.
166 .PP
167 .I format: """RelayExclude""=""<functions or dll.functions separated by semicolons>"""
168 .br
169 default: none
170 .br
171 Used to specify which functions will be excluded from a relay debug log.
172 .PP
173 .I format: """RelayInclude""=""<functions or dll.functions separated by semicolons>"""
174 .br
175 default: include all functions
176 .br 
177 Used to specify which functions will be included in a relay debug log.
178 .PP
179 .I format: """SnoopExclude""=""<functions or dll.functions separated by semicolons>"""
180 .br
181 default: none
182 .br 
183 Used to specify which functions will be excluded from the snoop debug log.
184 .PP
185 .I format: """SnoopInclude""=""<functions or dll.functions separated by semicolons>"""
186 .br
187 default: include all functions
188 .br 
189 Used to specify which functions will be included in the snoop debug log.
190 .PP
191 For Relay and Snoop <dllname>.* includes or excludes the whole dll. Exclude
192 entries have priority over Include entries.
193 .PP
194 .B [Network]
195 .br
196 .I format: """UseDnsComputerName""=""<boolean>"""
197 .br
198 If Y, always override the registry setting for ComputerName
199 with the Unix hostname.
200 .PP
201 .B [AppDefaults\\\\\\\\<appname>\\\\\\\\...]
202 .PP
203 This section allows specifying application-specific values for
204 the other sections described above.
205 .I <appname>
206 is the name of the application exe file, without path. The "..."
207 should be replaced by the name of one of the above configuration
208 sections.
209 .br
210 Example:
211 .br
212 .I [AppDefaults\\\\\\\\sol.exe\\\\\\\\DllOverrides]
213 .br
214 .I """shell32""" = """native"""
215 .br
216 means that Solitaire will use "native" load order for the shell32
217 dll. All other applications will continue to use what was specified in
218 the general
219 .I DllOverrides
220 section.
221 .br
222 The only sections that support application-specific information at the
223 moment are
224 .I DllOverrides, dsound, Version
225 and
226 .I x11drv.
227 .br
228 Make sure to use double backslashes in the section name.
229 .PP
230 .SH SAMPLE CONFIGURATION FILE
231 A sample configuration file is distributed as
232 .B documentation/samples/config
233 in the Wine source distribution.
234 .SH ENVIRONMENT VARIABLES
235 .TP
236 .I WINEPREFIX
237 Specifies the directory that contains the per-user
238 .I config
239 file, the registry files, and the DOS device mappings. The default is
240 .I $HOME/.wine.
241 .SH FILES
242 .TP
243 .I $WINEPREFIX/config
244 User-specific configuration file
245 .SH "SEE ALSO"
246 .BR wine (1)