| blob | fecf255d813dbaaf5d2655dcb51329e03dd76084 |
1 .\" -*- nroff -*-
2 .TH WINE.CONF 5 "July 16, 1999" "Version 990704" "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 @sysconfdir@/wine.conf
9 ), which should
10 conform to the following rules (the format is just like a Windows .ini
11 file). Common locations are /usr/local/etc/wine.conf or
12 (in some distributions) /etc/wine.conf. The actual directory
13 where that file resides may be specified during the execution of the
14 .B configure
15 script with the --sysconfdir option. Alternatively, you may have a
16 .I .winerc
17 file of this format in your home directory or have the environment variable
18 .B WINE_INI
19 pointing to a configuration file, or use the -config option on the command
20 line.
21 A sample configuration file is available as wine.ini in the base directory
22 of the Wine source distribution.
23 .SH CONFIGURATION FILE FORMAT
24 All entries are grouped in sections; a section begins with the line
25 .br
26 .I [section name]
27 .br
28 and continues until the next section starts. Individual entries
29 consist of lines of the form
30 .br
31 .I entry=value
32 .br
33 The value can be any text string, optionally included in single or
34 double quotes; it can also contain references to environment variables
35 surrounded by
36 .I ${}.
37 Supported section names and entries are listed below.
38 .PP
39 .B [Drive X]
40 .br
41 This section is used to specify the root directory and type of each
42 .B DOS
43 drive, since most Windows applications require a DOS/MS-Windows based
44 disk drive & directory scheme. There is one such section for every
45 drive you want to configure.
46 .PP
47 .I format: Path = <rootdirectory>
48 .br
49 default: none
50 .br
51 If you mounted your dos partition as
52 .I /dos
53 and installed Microsoft Windows in
54 C:\\WINDOWS then you should specify
55 .I Path=/dos
56 in the
57 .I [Drive C]
58 section.
59 .PP
60 .I format: Type = <type>
61 .br
62 default: hd
63 .br
64 Used to specify the drive type this drive appears as in Windows
65 or DOS programs; supported types are floppy, hd, cdrom
66 and network.
67 .PP
68 .I format: Label = <label>
69 .br
70 default: 'Drive X'
71 .br
72 Used to specify the drive label; limited to 11 characters.
73 .PP
74 .I format: Serial = <serial>
75 .br
76 default: 12345678
77 .br
78 Used to specify the drive serial number, as an 8-character hexadecimal
79 number.
80 .PP
81 .I format: Filesystem = <fstype>
82 .br
83 default: win95
84 .br
85 Used to specify the type of the file system Wine should emulate on a given
86 directory structure/underlying file system.
87 .br
88 Supported types are msdos (or fat), win95 (or vfat), unix.
89 .br
90 Recommended:
91 .br
92 win95 for ext2fs, VFAT and FAT32
93 .br
94 msdos for FAT16 (ugly)
95 .br
96 You definitely don't want to use "unix" unless you intend to port programs using Winelib.
97 .br
98 Always try to avoid using FAT16. Use VFAT/FAT32 OS file system driver instead !
99 .PP
100 .B [wine]
101 .br
102 .I format: windows = <directory>
103 .br
104 default: C:\\WINDOWS
105 .br
106 Used to specify a different Windows directory
107 .PP
108 .I format: system = <directory>
109 .br
110 default: C:\\WINDOWS\\SYSTEM
111 .br
112 Used to specify a different system directory
113 .PP
114 .I format: temp = <directory>
115 .br
116 default: C:\\TEMP
117 .br
118 Used to specify a directory where Windows applications can store
119 temporary files.
120 .PP
121 .I format: profile = <directory>
122 .br
123 default: nothing
124 .br
125 Used to specify a directory where Windows stores special folders and the user-registry files (user.dat or ntuser.dat).
126 Mapped to environment variable %USERPROFILE%.
127 Set this value when running with a native NT or a native win95 directory with per-user settings.
128 .PP
129 .I format: path = <directories separated by semi-colons>
130 .br
131 default: C:\\WINDOWS;C:\\WINDOWS\\SYSTEM
132 .br
133 Used to specify the path which will be used to find executables and .DLL's.
134 .PP
135 .I format: symboltablefile = <filename>
136 .br
137 default: wine.sym
138 .br
139 Used to specify the path and file name of the symbol table used by the built-in
140 debugger.
141 .PP
142 .B [DllDefaults]
143 .br
144 .I format: EXTRA_LD_LIBRARY_PATH=@prefix@/lib/wine[:/more/path/to/search[:...]]
145 .br
146 The path will be appended to any existing LD_LIBRARY_PATH from the
147 environment for the search of elfdlls and .so libraries.
148 .PP
149 .I format: DefaultLoadOrder=native,elfdll,so,builtin
150 .br
151 A comma separated list of module-types to try to load in that specific
152 order. The DefaultLoadOrder key is used as a fallback when a module is
153 not specified explicitely. If the DefaultLoadOrder key is not found,
154 then the order "native,elfdll,so,builtin" is used.
155 .br
156 Case is not (yet) important and only the first letter of each type is enough
157 to identify the type n[ative], e[lfdll], s[o], b[uiltin]. Also whitespace is
158 ignored. Keep everything in lower case to be sure that your entries keep the
159 same meaning. See also commandline option
160 .I -dll
161 for details about the allowable types.
162 .PP
163 .B [DllOverrides]
164 .br
165 There are no explicit keys defined other than module/library names. A comma
166 separated list of modules is followed by an assignment of the load order
167 for these specific modules. See above for possible types. You should not
168 specify an extension.
169 .br
170 Examples:
171 .br
172 .I kernel32, gdi32, user32 = builtin
173 .br
174 .I kernel, gdi, user = builtin
175 .br
176 .I comdlg32 = elfdll, native, builtin
177 .br
178 .I commdlg = native, builtin
179 .br
180 .I version, ver = elfdll, native, builtin
181 .br
182 Changing the load order of kernel/kernel32 and gdi/gdi32 to
183 anything other than builtin will cause wine to fail because wine cannot
184 use native versions for these libraries (gdi[32] might work native someday,
185 but kernel[32] will never work native). These libraries are also the last
186 to be converted to elfdlls and will live as builtins for quite some time
187 to come.
188 Note that using the native versions of user[32] isn't recommended right now,
189 as these modules face nearly the same problems as kernel/gdi and we only
190 just managed to make them work partially. But trying to use it might get
191 your program running.
192 .br
193 Always make sure that you have some kind of strategy in mind when you start
194 fiddling with the current defaults and needless to say that you must know
195 what you are doing.
196 .PP
197 .B [DllPairs]
198 .br
199 This is a simple pairing in the form 'name1 = name2'. It is supposed to
200 identify the dlls that cannot live without eachother unless they are
201 loaded in the same format. Examples are common dialogs and controls,
202 shell, kernel, gdi, user, etc...
203 .br
204 The code will issue a warning if the loadorder of these pairs are different
205 and might cause hard-to-find bugs due to incompatible pairs loaded at
206 run-time. Note that this pairing gives
207 .B no
208 guarantee that the pairs
209 actually get loaded as the same type, nor that the correct versions are
210 loaded (might be implemented later). It merely notes obvious trouble.
211 .br
212 Examples:
213 .br
214 .I kernel = kernel32
215 .br
216 .I commdlg = comdlg32
217 .br
218 The implementation will probably change in a later stage to force pairs to
219 be loaded correctly, but there are also drawbacks with such an approach.
220 .PP
221 .B [serialports]
222 .br
223 .I format: com[12345678] = <devicename>
224 .br
225 default: none
226 .br
227 Used to specify the devices which are used as COM1 - COM8.
228 .PP
229 .B [parallelports]
230 .br
231 .I format: lpt[12345678] = <devicename>
232 .br
233 default: none
234 .br
235 Used to specify the devices which are used as LPT1 - LPT8.
236 .PP
237 .B [spy]
238 .br
239 .I format: file = <filename or CON when logging to stdout>
240 .br
241 default: none
242 .br
243 Used to specify the file which will be used as
244 .B logfile.
245 .PP
246 .I format: exclude = <message names separated by semicolons>
247 .br
248 default: none
249 .br
250 Used to specify which messages will be excluded from the logfile.
251 .PP
252 .I format: include = <message names separated by semicolons>
253 .br
254 default: none
255 .br Used to specify which messages will be included in the logfile.
256 .PP
257 .B [Tweak.Layout]
258 .br
259 .I format: WineLook=<Win31|Win95|Win98>
260 .br
261 default: Win31
262 .br
263 Use Win95-like window displays or Win3.1-like window displays.
264 .PP
265 .B [Registry]
266 .br
267 .I format: AltCurrentUserFile=<filename>
268 .br
269 alternate registry file name: HKEY_CURRENT_USER
270 .PP
271 .I format: AltUserFile=<filename>
272 .br
273 alternate registry file name: HKKEY_USERS
274 .PP
275 .I format: AltLocalMachineFile=<filename>
276 .br
277 alternate registry file name: HKEY_LOCAL_MASCHINE
278 .PP
279 .I format: LoadAltRegistryFiles=<boolean>
280 .br
281 Load above registries.
282 .PP
283 .I format: WritetoAltRegistryFiles=<boolean>
284 .br
285 TRY to write all changes to alt registries
286 .PP
287 .I format: LoadGlobalRegistryFiles=<boolean>
288 .br
289 Global registries (stored in /etc)
290 .PP
291 .I format: LoadHomeRegistryFiles=<boolean>
292 .br
293 Home registries (stored in ~user/.wine/)
294 .PP
295 .I format: WritetoHomeRegistryFiles=<boolean>
296 .br
297 TRY to write all changes to alt registries
298 .PP
299 .I format: LoadWindowsRegistryFiles=<boolean>
300 .br
301 Load Windows registry from the current Windows directory.
302 .PP
303 booleans: Y/y/T/t/1 are true, N/n/F/f/0 are false.
304 .br
305 Defaults are read all, write to Home and Alt
306 .PP
307 Note: it is pointless to specify alt files and neither load nor write to them.
308 .PP
309 .SH SAMPLE CONFIGURATION FILE
310 A sample configuration file is distributed as
311 .B wine.ini
312 in the top-level directory of the source distribution.
313 .SH FILES
314 .PD 0
315 .TP
316 .I @sysconfdir@/wine.conf
317 Global configuration file for wine.
318 .TP
319 .I ~/.winerc
320 User-specific configuration file
321 .SH "SEE ALSO"
322 .BR wine (1)