- FreeBSD now supported.
[wine] / documentation / wine.conf.man.in
1 .\" -*- nroff -*-
2 .TH WINE.CONF 5 "August 5, 2001" "Version 20010731" "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
35 .B DOS
36 drive, since most Windows applications require a DOS/MS-Windows based 
37 disk drive & directory scheme. There is one such section for every
38 drive you want to configure.
39 .PP
40 .I format: """Path""=""<rootdirectory>"""
41 .br
42 default: none
43 .br
44 If you mounted your dos partition as 
45 .I /dos
46 and installed Microsoft Windows in 
47 C:\\WINDOWS then you should specify 
48 .I """Path""=""/dos"""
49 in the
50 .I [Drive C]
51 section.
52 .PP
53 .I format: """Type""=""<type>"""
54 .br
55 default: "hd"
56 .br
57 Used to specify the drive type this drive appears as in Windows
58 or DOS programs; supported types are "floppy", "hd", "cdrom"
59 and "network".
60 .PP
61 .I format: """Label""=""<label>"""
62 .br
63 default: "Drive X"
64 .br
65 Used to specify the drive label; limited to 11 characters.
66 .PP
67 .I format: """Serial""=""<serial>"""
68 .br
69 default: "12345678"
70 .br
71 Used to specify the drive serial number, as an 8-character hexadecimal
72 number.
73 .PP
74 .I format: """Filesystem""=""<fstype>"""
75 .br
76 default: "win95"
77 .br
78 Used to specify the type of the file system Wine should emulate on a given
79 directory structure/underlying file system.
80 .br
81 Supported types are "msdos" (or "fat"), "win95" (or "vfat"), "unix".
82 .br
83 Recommended:
84 .br
85   "win95" for ext2fs, VFAT and FAT32
86 .br
87   "msdos" for FAT16 (ugly)
88 .br
89 You definitely do not want to use "unix" unless you intend to port
90 programs using Winelib.  Always try to avoid using FAT16. Use the
91 VFAT/FAT32 OS file system driver instead.
92 .PP
93 .I format: """FailReadOnly""=""<boolean>"""
94 .br
95 Read-only files may not be opened in write mode (the default is to
96 allow opening read-only files for writing, because most Windows
97 programs always request read-write access, even on CD-ROM drives...).
98 .PP
99 .B [wine]
100 .br
101 .I format: """windows""=""<directory>"""
102 .br
103 default: "C:\\\\WINDOWS"
104 .br
105 Used to specify a different Windows directory; make sure to double the
106 backslashes.
107 .PP
108 .I format: """system""=""<directory>"""
109 .br
110 default: "C:\\\\WINDOWS\\\\SYSTEM"
111 .br
112 Used to specify a different system directory; make sure to double the
113 backslashes.
114 .PP
115 .I format: """temp""=""<directory>"""
116 .br
117 default: "C:\\\\TEMP"
118 .br
119 Used to specify a directory where Windows applications can store 
120 temporary files.
121 .PP
122 .I format: """profile""=""<directory>"""
123 .br
124 default: nothing
125 .br
126 Used to specify a directory where Windows stores special folders and
127 the user-registry files (user.dat or ntuser.dat).  Mapped to
128 environment variable %USERPROFILE%.  Set this value when running with
129 a native NT or a native win95 directory with per-user settings.
130 .PP
131 .I format: """path""=""<directories separated by semi-colons>"""
132 .br
133 default: "C:\\\\WINDOWS;C:\\\\WINDOWS\\\\SYSTEM"
134 .br
135 Used to specify the path which will be used to find executables and
136 dlls. Make sure to double all the backslashes.
137 .PP
138 .B [DllOverrides]
139 .br
140 .I format: """modulename""=""native,so,builtin"""
141 .br
142 .I modulename
143 can be any valid module name, without extension. The specified value
144 is a comma separated list of module-types to try to load in that
145 specific order. Case is not important and only the first letter of
146 each type is enough to identify the type n[ative], s[o],
147 b[uiltin]. Also whitespace is ignored. See also commandline option
148 .I --dll
149 for details about the allowable types.
150 .br
151 The wildcard entry
152 .I """*"""
153 specifies the load order to use for modules not explicitly
154 mentioned. If the wildcard entry is not found, then the order
155 "native,builtin,so" is used.
156 .br
157 Examples:
158 .br
159 .I """kernel32""=""builtin"""
160 .br
161 .I """kernel""=""builtin"""
162 .br
163 .I """comdlg32""=""native,builtin"""
164 .br
165 .I """*""=""builtin,native"""
166 .br
167 Changing the load order of kernel/kernel32 and gdi/gdi32 to
168 anything other than builtin will cause wine to fail because wine cannot
169 use native versions for these libraries.
170 .br
171 Always make sure that you have some kind of strategy in mind when you start
172 fiddling with the current defaults and needless to say that you must know
173 what you are doing.
174 .PP
175 .B [serialports]
176 .br
177 .I format: """com[12345678]""=""<devicename>"""
178 .br
179 default: none
180 .br
181 Used to specify the devices which are used as COM1 - COM8.
182 .PP
183 .B [parallelports]
184 .br
185 .I format: """lpt[12345678]""=""<devicename>"""
186 .br
187 default: none
188 .br
189 Used to specify the devices which are used as LPT1 - LPT8.
190 .PP
191 .B [spy]
192 .br
193 .I format: """exclude""=""<message names separated by semicolons>"""
194 .br
195 default: none
196 .br
197 Used to specify which messages will be excluded from the logfile.
198 .PP
199 .I format: """include""=""<message names separated by semicolons>"""
200 .br
201 default: none
202 .br Used to specify which messages will be included in the logfile.
203 .PP
204 .B [Tweak.Layout]
205 .br
206 .I format: """WineLook""=""<Win31|Win95|Win98>"""
207 .br
208 default: "Win31"
209 .br 
210 Use Win95-like window displays or Win3.1-like window displays.
211 .PP
212 .B [Registry]
213 .br
214 .I format: """LoadGlobalRegistryFiles""=""<boolean>"""
215 .br
216 Global registries (stored in /etc)
217 .PP
218 .I format: """LoadHomeRegistryFiles""=""<boolean>"""
219 .br
220 Home registries (stored in ~user/.wine/)
221 .PP
222 .I format: """WritetoHomeRegistryFiles""=""<boolean>"""
223 .br
224 TRY to write all changes to the home registry files
225 .PP
226 .I format: """LoadWindowsRegistryFiles""=""<boolean>"""
227 .br
228 Load Windows registry from the current Windows directory. 
229 .PP
230 booleans: Y/y/T/t/1 are true, N/n/F/f/0 are false.
231 .br
232 Defaults are read all, write to home files.
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 section that supports application-specific information at the
256 moment is
257 .I DllOverrides.
258 .br
259 Make sure to use double backslashes in the section name.
260 .PP
261 .SH SAMPLE CONFIGURATION FILE
262 A sample configuration file is distributed as
263 .B documentation/samples/config
264 in the Wine source distribution.
265 .SH FILES
266 .TP
267 .I ~/.wine/config
268 User-specific configuration file
269 .SH ENVIRONMENT VARIABLES
270 .TP 
271 .I WINEPREFIX
272 Specifies the directory that contains the per-user
273 .I config
274 file, the registry files, and the wineserver socket. The default is
275 .I $HOME/.wine.
276 .SH "SEE ALSO"
277 .BR wine (1)