Setting up config files, etc.
Copyright 1999 Adam Sacarny <magicbox@bestweb.net>
(Extracted from wine/documentation/config)
The Wine config file stores various settings for Wine. These include:
Drives and information about them
Directory settings
Port settings
The Wine look and feel
Wine's DLL usage
Wine's multimedia drivers and DLL configuration
This section will guide you through the process of making a config file. Take a look at the file <dirs to wine>/documentation/samples/config. It is organized by section.
Section Name | Needed? | What it Does |
---|---|---|
[Drive X] | yes | Sets up drives recognized by wine |
[wine] | yes | Settings for wine directories |
[DllDefaults] | recmd | Defaults for loading DLL's |
[DllPairs] | recmd | Sanity checkers for DLL's |
[DllOverrides] | recmd | Overides defaults for DLL loading |
[x11drv] | recmd | Graphic driver settings |
[fonts] | yes | Font appearance and recognition |
[serialports] | no | COM ports seen by wine |
[parallelports] | no | LPT ports seen by wine |
[ppdev] | no | Parallelport emulation |
[spooler] | no | Print spooling |
[ports] | no | Direct port access |
[Debug] | no | What to do with certain debug messages |
[Registry] | no | Specifies locations of windows registry files |
[tweak.layout] | recmd | Appearance of wine |
[programs] | no | Programs to be run automatically |
[Console] | no | Console settings |
[Clipboard] | no | Interaction for wine and X11 clipboard |
[afmdirs] | no | Postscript driver settings |
[WinMM] | yes | Multimedia settings |
[AppDefaults] | no | Overwrite the settings of previous sections for special programs |
These sections are supposed to make certain Unix directory locations accessible to Wine as a DOS/Windows drive (drive 'X:') and thus accessible to Windows programs under the drive name you specified. Every DOS/Windows program sort of expects at least a C: drive (and sometimes also an A: floppy drive), so your config file should at least contain the corresponding sections, [Drive C] and [Drive A]. You need to decide on whether you want to use an existing Windows partition as the C drive or whether you want to create your own Wine drive C directory tree somewhere (take care about permissions !). Each drive section may specify up to 6 different settings as explained below.
[Drive X] |
"Path" = "/dir/to/path" |
"Type" = "hd|cdrom|network|floppy" |
"Label" = "blah" |
"Serial" = "deadbeef" |
"Filesystem" = "win95|unix|msdos" |
Case insensitive. Alike to Windows 9x/NT 4. This is the long filename filesystem you are probably used to working with. The filesystem of choice for most applications to be run under wine. PROBABLY THE ONE YOU WANT!
Case sensitive. This filesystem has almost no use (Windows apps expect case insensitive filenames). Try it if you dare, but win95 is a much better choice.
Case insensitive filesystem. Alike to DOS and Windows 3.x. 8.3 is the maximum length of files (eightdot.123) - longer ones will be truncated. (NOTE: this is a very bad choice if you plan on running apps that use long filenames. win95 should work fine with apps that were designed to run under the msdos system. In other words, you might not want to use this.)
"Device" = "/dev/xx" |
Needed for raw device access and label and serial number reading. Use this ONLY for floppy and cdrom devices. Using it on Extended2 or other Unix file systems can have dire results (when a windows app tries to do a lowlevel write, they do it in a FAT way -- FAT format is completely different from any Unix file system). Also, make sure that you have proper permissions to this device file.
Note: This setting is not really important; almost all apps will have no problem if it remains unspecified. For CD-ROMs it's quite useful in order to get automatic label detection, though. If you are unsure about specifying device names, just leave out this setting for your drives.
Here are a few sample entries:
Here is a setup for Drive C, a generic hard drive: [Drive C] "Path" = "/dosc" "Type" = "hd" "Label" = "Hard Drive" "Filesystem" = "win95" This is a setup for Drive E, a generic CD-ROM drive: [Drive E] "Path" = "/mnt/cdrom" "Type" = "cdrom" "Label" = "Total Annihilation" "Filesystem" = "win95" "Device" = "/dev/cdrom" And here is a setup for Drive A, a generic floppy drive: [Drive A] "Type" = "floppy" "Path" = "/mnt/floppy" "Label" = "Floppy Drive" "Serial" = "87654321" "Filesystem" = "win95" "Device" = "/dev/fd0" |
The [wine] section of the configuration file contains all kinds of general settings for Wine.
"Windows" = "c:\\windows" |
"System" = "c:\\windows\\system" |
"Temp" = "c:\\temp" |
"Path" = "c:\\windows;c:\\windows\\system;c:\\blanco" |
Behaves like the PATH setting on UNIX boxes. When wine is run like wine sol.exe, if sol.exe resides in a directory specified in the Path setting, wine will run it (Of course, if sol.exe resides in the current directory, wine will run that one). Make sure it always has your windows directory and system directory (For this setup, it must have "c:\\windows;c:\\windows\\system").
"GraphicsDriver" = "x11drv|ttydrv" |
"Printer" = "off|on" |
"ShellLinker" = "wineshelllink" |
"ShowDirSymlinks" = "1" |
"SymbolTableFile" = "wine.sym" |
There are a few things you will need to know before configuring the DLL sections in your wine configuration file.
Most windows DLL's have a win16 (Windows 3.x) and win32 (Windows 9x/NT) form. The combination of the win16 and win32 DLL versions are called the "DLL pair". This is a list of the most common pairs:
There are a few different forms of DLL's wine can load:
The DLL's that are included with windows. Many windows DLL's can be loaded in their native form. Many times these native versions work better than their non-Microsoft equivalent -- other times they don't.
The most common form of DLL loading. This is what you will use if the DLL is too system-specific or error-prone in native form (KERNEL for example), you don't have the native DLL, or you just want to be Microsoft-free.
Native ELF libraries. Will not work yet.
ELF encapsulated windows DLL's. No longer used, ignored.
These settings provide wine's default handling of DLL loading.
"DefaultLoadOrder" =" native, so, builtin" |
This setting is a comma-delimited list of the order in which to attempt loading DLLs. If the first option fails, it will try the second, and so on. The order specified above is probably the best in most conditions.
At one time, there was a section called [DllPairs] in the default configuration file, but this has been obsoleted because the pairing information has now been embedded into Wine itself. (The purpose of this section was merely to be able to issue warnings if the user attempted to pair codependent 16-bit/32-bit DLLs of different types.) If you still have this in your ~/.wine/.config or wine.conf, you may safely delete it.
The format for this section is the same for each line:
<DLL>{,<DLL>,<DLL>...} = <FORM>{,<FORM>,<FORM>...} |
For example, to load builtin KERNEL pair (case doesn't matter here):
"kernel,kernel32" = "builtin" |
To load the native COMMDLG pair, but if that doesn't work try builtin:
"commdlg,comdlg32" = "native,builtin" |
To load the native COMCTL32:
"comctl32" = "native" |
Here is a good generic setup (As it is defined in config that was included with your wine package):
[DllOverrides] "rpcrt4" = "builtin, native" "oleaut32" = "builtin, native" "ole32" = "builtin, native" "commdlg" = "builtin, native" "comdlg32" = "builtin, native" "ver" = "builtin, native" "version" = "builtin, native" "shell" = "builtin, native" "shell32" = "builtin, native" "shfolder" = "builtin, native" "shlwapi" = "builtin, native" "shdocvw" = "builtin, native" "lzexpand" = "builtin, native" "lz32" = "builtin, native" "comctl32" = "builtin, native" "commctrl" = "builtin, native" "advapi32" = "builtin, native" "crtdll" = "builtin, native" "mpr" = "builtin, native" "winspool.drv" = "builtin, native" "ddraw" = "builtin, native" "dinput" = "builtin, native" "dsound" = "builtin, native" "opengl32" = "builtin, native" "msvcrt" = "native, builtin" "msvideo" = "builtin, native" "msvfw32" = "builtin, native" "mcicda.drv" = "builtin, native" "mciseq.drv" = "builtin, native" "mciwave.drv" = "builtin, native" "mciavi.drv" = "native, builtin" "mcianim.drv" = "native, builtin" "msacm.drv" = "builtin, native" "msacm" = "builtin, native" "msacm32" = "builtin, native" "midimap.drv" = "builtin, native" ; you can specify applications too "notepad.exe" = "native, builtin" ; default for all other dlls "*" = "native, builtin" |
Note: If loading of the libraries that are listed first fails, wine will just go on by using the second or third option.
This section sets up wine's font handling.
"Resolution" = "96" |
Since the way X handles fonts is different from the way Windows does, wine uses a special mechanism to deal with them. It must scale them using the number defined in the "Resolution" setting. 60-120 are reasonable values, 96 is a nice in the middle one. If you have the real windows fonts available (<dirs to wine>/documentation/ttfserver and fonts), this parameter will not be as important. Of course, it's always good to get your X fonts working acceptably in wine.
"Default" = "-adobe-times-" |
OPTIONAL:
The Alias setting allows you to map an X font to a font used in wine. This is good for apps that need a special font you don't have, but a good replacement exists. The syntax is like so:
"AliasX" = "[Fake windows name],[Real X name]"<,optional "masking" section> |
Pretty straightforward. Replace "AliasX" with "Alias0", then "Alias1" and so on. The fake windows name is the name that the font will be under a windows app in wine. The real X name is the font name as seen by X (Run "xfontsel"). The optional "masking" section allows you to utilize the fake windows name you define. If it is not used, then wine will just try to extract the fake windows name itself and not use the value you enter.
Here is an example of an alias without masking. The font will show up in windows apps as "Google".
"Alias0" = "Foo,--google-" |
Here is an example with masking enabled. The font will show up as "Foo" in windows apps.
"Alias1" = "Foo,--google-,subst" |
For more info check out the Fonts chapter.
Even though it sounds like a lot of sections, these are all closely related. They are all for communications and parallel ports.
The [serialports] section tells wine what serial ports it is allowed to use.
"ComX" = "/dev/ttySY" |
Replace X with the number of the COM port in Windows (1-8) and Y with the number of it in X (Usually the number of the port in Windows minus 1). ComX can actually equal any device (/dev/modem is acceptable). It is not always necessary to define any COM ports (An optional setting). Here is an example:
"Com1" = "/dev/ttyS0" |
Use as many of these as you like in the section to define all of the COM ports you need.
The [parallelports] section sets up any parallel ports that will be allowed access under wine.
"LptX" = "/dev/lpY" |
Sounds familiar? Syntax is just like the COM port setting. Replace X with a value from 1-4 as it is in Windows and Y with a value from 0-3 (Y is usually the value in windows minus 1, just like for COM ports). You don't always need to define a parallel port (AKA, it's optional). As with the other section, LptX can equal any device (Maybe /dev/printer). Here is an example:
"Lpt1" = "/dev/lp0" |
The [spooler] section will inform wine where to spool print jobs. Use this if you want to try printing. Wine docs claim that spooling is "rather primitive" at this time, so it won't work perfectly. IT IS OPTIONAL. The only setting you use in this section works to map a port (LPT1, for example) to a file or a command. Here is an example, mapping LPT1 to the file out.ps:
"LPT1:" = "out.ps" |
The following command maps printing jobs to LPT1 to the command lpr. Notice the |:
"LPT1:" = "|lpr" |
The [ports] section is usually useful only for people who need direct port access for programs requiring dongles or scanners. IF YOU DON'T NEED IT, DON'T USE IT!
"read" = "0x779,0x379,0x280-0x2a0" |
"write" = "0x779,0x379,0x280-0x2a0" |
[Debug] is used to include or exclude debug messages, and to output them to a file. The latter is rarely used. THESE ARE ALL OPTIONAL AND YOU PROBABLY DON'T NEED TO ADD OR REMOVE ANYTHING IN THIS SECTION TO YOUR CONFIG. (In extreme cases you may want to use these options to manage the amount of information generated by the --debugmsg +relay option.)
"File" = "/blanco" |
"SpyExclude" = "WM_SIZE;WM_TIMER;" |
"SpyInclude" = "WM_SIZE;WM_TIMER;" |
"RelayInclude" = "user32.CreateWindowA;comctl32.*" |
"RelayExclude" = "RtlEnterCriticalSection;RtlLeaveCriticalSection" |
In both entries the functions may be specified either as a function name or as a module and function. In this latter case specify an asterisk for the function name to include/exclude all functions in the module.
[Registry] can be used to tell wine where your old windows registry files exist. This section is completely optional and useless to people using wine without an existing windows installation.
"UserFileName" = "/dirs/to/user.reg" |
[tweak.layout] is devoted to wine's look. There is only one setting for it.
"WineLook" = "win31|win95|win98" |
[programs] can be used to say what programs run under special conditions.
"Default" = "/program/to/execute.exe" |
"Startup" = "/program/to/execute.exe" |
[WinMM] is used to define which multimedia drivers have to be loaded. Since those drivers may depend on the multimedia interfaces available on your system (OSS, ALSA... to name a few), it's needed to be able to configure which driver has to be loaded.
The content of the section looks like:
[WinMM] "Drivers" = "wineoss.drv" "WaveMapper" = "msacm.drv" "MidiMapper" = "midimap.drv" |
The "Drivers" key is a ';' separated list of modules name, each of them containing a low level driver. All those drivers will be loaded when MMSYSTEM/WINMM is started and will provide their inner features.
The "WaveMapper" represents the name of the module containing the Wave Mapper driver. Only one wave mapper can be defined in the system.
The "MidiMapper" represents the name of the module containing the MIDI Mapper driver. Only one MIDI mapper can be defined in the system.
[Network] contains settings related to networking. Currently there is only one value that can be set.
A boolean setting (default: Y) that affects the way Wine sets the computer name. The computer name in the Windows world is the so-called NetBIOS name. It is contained in the ComputerName in the registry entry HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\ComputerName\ComputerName.
If this option is set to "Y" or missing, Wine will set the NetBIOS name to the Unix host name of your computer, if necessary truncated to 31 characters. The Unix hostname is the output of the shell command hostname, up to but not including the first dot ('.'). Among other things, this means that Windows programs running under Wine cannot change the NetBIOS computer name.
If this option is set to "N", Wine will use the registry value above to set the NetBIOS name. Only if the registry entry doesn't exist (usually only during the first wine startup) it will use the Unix hostname as usual. Windows applications can change the NetBIOS name. The change will be effective after a "reboot", i.e. after restarting Wine.
The section is used to overwrite certain settings of this file for a special program with different settings. [AppDefaults] is not the real name of the section. The real name consists of the leading word AppDefaults followed by the name of the executable the section is valid for. The end of the section name is the name of the corresponding "standard" section of the configuration file that should have some of its settings overwritten with the application specific settings you define. The three parts of the section name are separated by two backslashes.
Currently wine supports overriding selected settings within the sections [DllOverrides], [x11drv], [version] and [dsound] only.
Here is an example that overrides the normal settings for a program:
;; default settings [x11drv] "Managed" = "Y" "Desktop" = "N" ;; run install in desktop mode [AppDefaults\\install.exe\\x11drv] "Managed" = "N" "Desktop" = "800x600" |
The wine config file can go in two places.
A systemwide config file, used for anyone who doesn't have their own. NOTE: this file is currently unused as a new global configuration mechanism is not in place at this time.
Your own config file (which only is used for your user).
So copy your version of the wine config file to $HOME/.wine/config or /usr/local/etc/wine.conf for wine to recognize it.
There is always a chance that things will go wrong. If the unthinkable happens, report the problem to Wine Bugzilla, try the newsgroup comp.emulators.ms-windows.wine, or the IRC channel #WineHQ found on irc.freenode.net, or connected servers. Make sure that you have looked over this document thoroughly, and have also read:
README
http://www.winehq.org/trouble/
If indeed it looks like you've done your research, be prepared for helpful suggestions. If you haven't, brace yourself for heaving flaming.