documentation/wine.conf.man

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