Mark files starting with a dot as FA_HIDDEN.
[wine] / documentation / wine.conf.man
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...).
100 .PP
101 .B [wine]
102 .br
103 .I format: """windows""=""<directory>"""
104 .br
105 default: "C:\\\\WINDOWS"
106 .br
107 Used to specify where Wine is supposed to have its Windows directory
108 (which is an essential part of a Windows environment); make sure to double
109 the backslashes.
110 In case of e.g. C:\\WINDOWS, with drive C: being configured as
111 /home/user/wine_c, the /home/user/wine_c/WINDOWS directory would be used for
112 this.
113 .PP
114 .I format: """system""=""<directory>"""
115 .br
116 default: "C:\\\\WINDOWS\\\\System"
117 .br
118 Used to specify where Wine is supposed to have its Windows system directory
119 (again, essential part of Windows environment); make sure to double the backslashes.
120 Given a setting of C:\\WINDOWS\\System (the standard setting on Windows)
121 and a C: drive again at /home/user/wine_c, the /home/user/wine_c/WINDOWS/System
122 directory would be used for this.
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. E.g. with a C: drive at /home/user/wine_c, this would be
130 the /home/user/wine_c/TEMP directory.
131 .PP
132 .I format: """profile""=""<directory>"""
133 .br
134 default: nothing
135 .br
136 Used to specify a directory where Windows stores special folders and
137 the user-registry files (user.dat or ntuser.dat).  Mapped to
138 environment variable %USERPROFILE%.  Set this value when running with
139 a native NT or a native win95 directory with per-user settings.
140 .PP
141 .I format: """path""=""<directories separated by semi-colons>"""
142 .br
143 default: "C:\\\\WINDOWS;C:\\\\WINDOWS\\\\SYSTEM"
144 .br
145 Used to specify the path which will be used to find executables and
146 dlls. Make sure to double the backslashes.
147 .PP
148 .I format: """GraphicsDriver""=""<x11drv|ttydrv>"""
149 .br
150 default: "x11drv"
151 .br
152 Tells Wine which graphics driver to use. Normally you'd want to use
153 x11drv (for X11). In case you want to run programs as text console/TTY only
154 without having Wine rely on X11 support, then use ttydrv.
155 .PP
156 .I format: """ShowDotFiles""=""<0|1>"""
157 .br
158 default: "0"
159 .br
160 Under Unix, files starting with a dot, are considered hidden,
161 and should not be shown in directory listing (unless explicitly asked for),
162 just like DOS-style hidden files. If you want them treated as regular
163 files, set this value to 1.
164 .PP
165 .B [Version]
166 .br
167 .I format: """Windows""=""<version string>"""
168 .br
169 default: none; chosen by semi-intelligent detection mechanism based on DLL environment
170 .br
171 Used to specify which Windows version to return to programs (forced value,
172 overrides standard detection mechanism !).
173 Valid settings are e.g. "win31", "win95", "win98", "win2k", "winxp".
174 Also valid as an AppDefaults setting (recommended/preferred use).
175 .PP
176 .I format: """DOS""=""<version string>"""
177 .br
178 default: "<Windows version specific>"
179 .br
180 Used to specify the DOS version that should be returned to programs.
181 Only takes effect in case Wine acts as "win31" Windows version !
182 Common DOS version settings include 6.22, 6.20, 6.00, 5.00, 4.00, 3.30, 3.10.
183 Also valid as an AppDefaults setting (recommended/preferred use).
184 .PP
185 .B [DllOverrides]
186 .br
187 .I format: """modulename""=""native,so,builtin"""
188 .br
189 .I modulename
190 can be any valid DLL module name. If no extension is specified .dll is
191 assumed. The specified value is a comma separated list of module-types
192 to try to load in that specific order. Case is not important and only
193 the first letter of each type is enough to identify the type n[ative],
194 s[o], b[uiltin]. Also whitespace is ignored. See also commandline
195 option
196 .I --dll
197 for details about the allowable types.
198 .br
199 The wildcard entry
200 .I """*"""
201 specifies the load order to use for modules not explicitly
202 mentioned. If the wildcard entry is not found, then the order
203 "native,builtin,so" is used.
204 .br
205 Examples:
206 .br
207 .I """kernel32""=""builtin"""
208 .br
209 .I """kernel""=""builtin"""
210 .br
211 .I """comdlg32""=""native,builtin"""
212 .br
213 .I """*""=""builtin,native"""
214 .br
215 When the specified module name does not contain a path, it matches
216 only dlls loaded from the Windows system directory. If the application
217 explicitly loads a dll from a different directory, it has to be
218 configured separately. This can be done either by specifying the full
219 path in the module name, or by using a path wildcard of the form
220 .I """*modulename""".
221 .br
222 For instance, the following will load the native shell32 when loaded
223 from C:\\Program Files, and the builtin when loaded from any other
224 directory:
225 .br
226 .I """C:\\\\\\\\Program Files\\\\\\\\shell32"" = ""native"""
227 .br
228 .I """*shell32"" = ""builtin"""
229 .br
230 Changing the load order of low-level dlls like kernel32, gdi32 or
231 user32 to anything other than builtin will cause wine to fail because
232 wine cannot use native versions for these libraries.
233 .br
234 Always make sure that you have some kind of strategy in mind when you start
235 fiddling with the current defaults and needless to say that you must know
236 what you are doing.
237 --debugmsg +loaddll might come in handy for experimenting with that stuff.
238 .PP
239 .B [serialports]
240 .br
241 .I format: """com[12345678]""=""<devicename>"""
242 .br
243 default: none
244 .br
245 Used to specify the devices which are used as COM1 - COM8.
246 .PP
247 .B [parallelports]
248 .br
249 .I format: """lpt[12345678]""=""<devicename>"""
250 .br
251 default: none
252 .br
253 Used to specify the devices which are used as LPT1 - LPT8.
254 .PP
255 .B [spy]
256 .br
257 .I format: """exclude""=""<message names separated by semicolons>"""
258 .br
259 default: none
260 .br
261 Used to specify which messages will be excluded from the logfile.
262 .PP
263 .I format: """include""=""<message names separated by semicolons>"""
264 .br
265 default: none
266 .br Used to specify which messages will be included in the logfile.
267 .PP
268 .B [Tweak.Layout]
269 .br
270 .I format: """WineLook""=""<Win31|Win95|Win98>"""
271 .br
272 default: "Win31"
273 .br
274 Use Win95-like window displays or Win3.1-like window displays.
275 .PP
276 .B [Registry]
277 .br
278 .I format: """LoadGlobalRegistryFiles""=""<boolean>"""
279 .br
280 Global registries (stored in /etc)
281 .PP
282 .I format: """LoadHomeRegistryFiles""=""<boolean>"""
283 .br
284 Home registries (stored in ~user/.wine/)
285 .PP
286 .I format: """WritetoHomeRegistryFiles""=""<boolean>"""
287 .br
288 TRY to write all changes to the home registry files
289 .PP
290 .I format: """LoadWindowsRegistryFiles""=""<boolean>"""
291 .br
292 Load Windows registry from the current Windows directory.
293 .PP
294 booleans: Y/y/T/t/1 are true, N/n/F/f/0 are false.
295 .br
296 Defaults are read all, write to home files.
297 .PP
298 .B [AppDefaults\\\\\\\\<appname>\\\\\\\\...]
299 .PP
300 This section allows specifying application-specific values for
301 the other sections described above.
302 .I <appname>
303 is the name of the application exe file, without path. The "..."
304 should be replaced by the name of one of the above configuration
305 sections.
306 .br
307 Example:
308 .br
309 .I [AppDefaults\\\\\\\\sol.exe\\\\\\\\DllOverrides]
310 .br
311 .I """shell32""" = """native"""
312 .br
313 means that Solitaire will use "native" load order for the shell32
314 dll. All other applications will continue to use what was specified in
315 the general
316 .I DllOverrides
317 section.
318 .br
319 The only sections that support application-specific information at the
320 moment are
321 .I DllOverrides
322 and
323 .I x11drv.
324 .br
325 Make sure to use double backslashes in the section name.
326 .PP
327 .SH SAMPLE CONFIGURATION FILE
328 A sample configuration file is distributed as
329 .B documentation/samples/config
330 in the Wine source distribution.
331 .SH FILES
332 .TP
333 .I ~/.wine/config
334 User-specific configuration file
335 .SH ENVIRONMENT VARIABLES
336 .TP
337 .I WINEPREFIX
338 Specifies the directory that contains the per-user
339 .I config
340 file, the registry files, and the wineserver socket. The default is
341 .I $HOME/.wine.
342 .SH "SEE ALSO"
343 .BR wine (1)