| blob | 456e761c8134c53fba13bd3cf25bbd98d09638b5 |
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 .I format: FailReadOnly=<boolean>
101 .br
102 Read-only files may not be opened in write mode (the default is to
103 allow opening read-only files for writing, because most Windows
104 programs always request read-write access, even on CD-ROM drives...).
105 .PP
106 .B [wine]
107 .br
108 .I format: windows = <directory>
109 .br
110 default: C:\\WINDOWS
111 .br
112 Used to specify a different Windows directory
113 .PP
114 .I format: system = <directory>
115 .br
116 default: C:\\WINDOWS\\SYSTEM
117 .br
118 Used to specify a different system directory
119 .PP
120 .I format: temp = <directory>
121 .br
122 default: C:\\TEMP
123 .br
124 Used to specify a directory where Windows applications can store
125 temporary files.
126 .PP
127 .I format: profile = <directory>
128 .br
129 default: nothing
130 .br
131 Used to specify a directory where Windows stores special folders and the user-registry files (user.dat or ntuser.dat).
132 Mapped to environment variable %USERPROFILE%.
133 Set this value when running with a native NT or a native win95 directory with per-user settings.
134 .PP
135 .I format: path = <directories separated by semi-colons>
136 .br
137 default: C:\\WINDOWS;C:\\WINDOWS\\SYSTEM
138 .br
139 Used to specify the path which will be used to find executables and .DLL's.
140 .PP
141 .I format: symboltablefile = <filename>
142 .br
143 default: wine.sym
144 .br
145 Used to specify the path and file name of the symbol table used by the built-in
146 debugger.
147 .PP
148 .B [DllDefaults]
149 .br
150 .I format: EXTRA_LD_LIBRARY_PATH=@prefix@/lib/wine[:/more/path/to/search[:...]]
151 .br
152 The path will be appended to any existing LD_LIBRARY_PATH from the
153 environment for the search of elfdlls and .so libraries.
154 .PP
155 .I format: DefaultLoadOrder=native,elfdll,so,builtin
156 .br
157 A comma separated list of module-types to try to load in that specific
158 order. The DefaultLoadOrder key is used as a fallback when a module is
159 not specified explicitely. If the DefaultLoadOrder key is not found,
160 then the order "native,elfdll,so,builtin" is used.
161 .br
162 Case is not (yet) important and only the first letter of each type is enough
163 to identify the type n[ative], e[lfdll], s[o], b[uiltin]. Also whitespace is
164 ignored. Keep everything in lower case to be sure that your entries keep the
165 same meaning. See also commandline option
166 .I --dll
167 for details about the allowable types.
168 .PP
169 .B [DllOverrides]
170 .br
171 There are no explicit keys defined other than module/library names. A comma
172 separated list of modules is followed by an assignment of the load order
173 for these specific modules. See above for possible types. You should not
174 specify an extension.
175 .br
176 Examples:
177 .br
178 .I kernel32, gdi32, user32 = builtin
179 .br
180 .I kernel, gdi, user = builtin
181 .br
182 .I comdlg32 = elfdll, native, builtin
183 .br
184 .I commdlg = native, builtin
185 .br
186 .I version, ver = elfdll, native, builtin
187 .br
188 Changing the load order of kernel/kernel32 and gdi/gdi32 to
189 anything other than builtin will cause wine to fail because wine cannot
190 use native versions for these libraries (gdi[32] might work native someday,
191 but kernel[32] will never work native). These libraries are also the last
192 to be converted to elfdlls and will live as builtins for quite some time
193 to come.
194 Note that using the native versions of user[32] isn't recommended right now,
195 as these modules face nearly the same problems as kernel/gdi and we only
196 just managed to make them work partially. But trying to use it might get
197 your program running.
198 .br
199 Always make sure that you have some kind of strategy in mind when you start
200 fiddling with the current defaults and needless to say that you must know
201 what you are doing.
202 .PP
203 .B [DllPairs]
204 .br
205 This is a simple pairing in the form 'name1 = name2'. It is supposed to
206 identify the dlls that cannot live without eachother unless they are
207 loaded in the same format. Examples are common dialogs and controls,
208 shell, kernel, gdi, user, etc...
209 .br
210 The code will issue a warning if the loadorder of these pairs are different
211 and might cause hard-to-find bugs due to incompatible pairs loaded at
212 run-time. Note that this pairing gives
213 .B no
214 guarantee that the pairs
215 actually get loaded as the same type, nor that the correct versions are
216 loaded (might be implemented later). It merely notes obvious trouble.
217 .br
218 Examples:
219 .br
220 .I kernel = kernel32
221 .br
222 .I commdlg = comdlg32
223 .br
224 The implementation will probably change in a later stage to force pairs to
225 be loaded correctly, but there are also drawbacks with such an approach.
226 .PP
227 .B [serialports]
228 .br
229 .I format: com[12345678] = <devicename>
230 .br
231 default: none
232 .br
233 Used to specify the devices which are used as COM1 - COM8.
234 .PP
235 .B [parallelports]
236 .br
237 .I format: lpt[12345678] = <devicename>
238 .br
239 default: none
240 .br
241 Used to specify the devices which are used as LPT1 - LPT8.
242 .PP
243 .B [spy]
244 .br
245 .I format: file = <filename or CON when logging to stdout>
246 .br
247 default: none
248 .br
249 Used to specify the file which will be used as
250 .B logfile.
251 .PP
252 .I format: exclude = <message names separated by semicolons>
253 .br
254 default: none
255 .br
256 Used to specify which messages will be excluded from the logfile.
257 .PP
258 .I format: include = <message names separated by semicolons>
259 .br
260 default: none
261 .br Used to specify which messages will be included in the logfile.
262 .PP
263 .B [Tweak.Layout]
264 .br
265 .I format: WineLook=<Win31|Win95|Win98>
266 .br
267 default: Win31
268 .br
269 Use Win95-like window displays or Win3.1-like window displays.
270 .PP
271 .B [Registry]
272 .br
273 .I format: LoadGlobalRegistryFiles=<boolean>
274 .br
275 Global registries (stored in /etc)
276 .PP
277 .I format: LoadHomeRegistryFiles=<boolean>
278 .br
279 Home registries (stored in ~user/.wine/)
280 .PP
281 .I format: WritetoHomeRegistryFiles=<boolean>
282 .br
283 TRY to write all changes to alt registries
284 .PP
285 .I format: LoadWindowsRegistryFiles=<boolean>
286 .br
287 Load Windows registry from the current Windows directory.
288 .PP
289 booleans: Y/y/T/t/1 are true, N/n/F/f/0 are false.
290 .br
291 Defaults are read all, write to Home
292 .PP
293 .SH SAMPLE CONFIGURATION FILE
294 A sample configuration file is distributed as
295 .B wine.ini
296 in the top-level directory of the source distribution.
297 .SH FILES
298 .PD 0
299 .TP
300 .I @sysconfdir@/wine.conf
301 Global configuration file for wine.
302 .TP
303 .I ~/.winerc
304 User-specific configuration file
305 .SH "SEE ALSO"
306 .BR wine (1)