documentation/wine.conf.man

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