2000-08-08 03:24:00 +02:00
<chapter id="configuring">
<title>Configuring Wine</title>
<para>Setting up config files, etc.</para>
<sect1 id="config">
<title>General Configuration</title>
<para>
2000-12-13 22:52:37 +01:00
Copyright 1999 &name-adam-sacarny; <email>&email-adam-sacarny;</email>
2000-08-08 03:24:00 +02:00
</para>
<para>
(Extracted from <filename>wine/documentation/config</filename>)
</para>
<sect2>
<title>The Wine Config File</title>
<para>
The Wine config file stores various settings for Wine. These include:
<itemizedlist>
<listitem>
<para>
2002-07-24 05:00:02 +02:00
Drives and information about them
2000-08-08 03:24:00 +02:00
</para>
</listitem>
<listitem>
<para>
2002-07-24 05:00:02 +02:00
Directory settings
2000-08-08 03:24:00 +02:00
</para>
</listitem>
<listitem>
<para>
2002-07-24 05:00:02 +02:00
Port settings
2000-08-08 03:24:00 +02:00
</para>
</listitem>
<listitem>
<para>
The Wine look and feel
</para>
</listitem>
<listitem>
<para>
2002-07-24 05:00:02 +02:00
Wine's DLL usage
2000-08-08 03:24:00 +02:00
</para>
</listitem>
2001-05-22 21:26:31 +02:00
<listitem>
<para>
2002-07-24 05:00:02 +02:00
Wine's multimedia drivers and DLL configuration
2001-05-22 21:26:31 +02:00
</para>
</listitem>
2000-08-08 03:24:00 +02:00
</itemizedlist>
</para>
</sect2>
<sect2>
<title>How Do I Make One?</title>
<para>
This section will guide you through the process of making a
config file. Take a look at the file <filename><dirs to
2001-01-19 00:03:47 +01:00
wine>/documentation/samples/config</filename>. It is organized by section.
2000-08-08 03:24:00 +02:00
</para>
<informaltable frame="all">
<tgroup cols="3">
<thead>
<row>
<entry>Section Name</entry>
<entry>Needed?</entry>
<entry>What it Does</entry>
</row>
</thead>
<tbody>
<row>
<entry>[Drive X]</entry>
<entry>yes</entry>
<entry>Sets up drives recognized by wine</entry>
</row>
<row>
<entry>[wine]</entry>
<entry>yes</entry>
<entry>Settings for wine directories</entry>
</row>
<row>
<entry>[DllDefaults]</entry>
<entry>recmd</entry>
<entry>Defaults for loading DLL's</entry>
</row>
<row>
<entry>[DllPairs]</entry>
<entry>recmd</entry>
<entry>Sanity checkers for DLL's</entry>
</row>
<row>
<entry>[DllOverrides]</entry>
<entry>recmd</entry>
<entry>Overides defaults for DLL loading</entry>
</row>
2002-01-14 20:44:30 +01:00
<row>
<entry>[x11drv]</entry>
<entry>recmd</entry>
<entry>Graphic driver settings</entry>
</row>
2000-08-08 03:24:00 +02:00
<row>
<entry>[fonts]</entry>
<entry>yes</entry>
<entry>Font appearance and recognition</entry>
</row>
<row>
<entry>[serialports]</entry>
<entry>no</entry>
<entry>COM ports seen by wine</entry>
</row>
<row>
<entry>[parallelports]</entry>
<entry>no</entry>
<entry>LPT ports seen by wine</entry>
</row>
2002-01-14 20:44:30 +01:00
<row>
<entry>[ppdev]</entry>
<entry>no</entry>
<entry>Parallelport emulation</entry>
</row>
2000-08-08 03:24:00 +02:00
<row>
<entry>[spooler]</entry>
<entry>no</entry>
<entry>Print spooling</entry>
</row>
<row>
<entry>[ports]</entry>
<entry>no</entry>
<entry>Direct port access</entry>
</row>
<row>
2002-10-19 03:00:04 +02:00
<entry>[Debug]</entry>
2000-08-08 03:24:00 +02:00
<entry>no</entry>
<entry>What to do with certain debug messages</entry>
</row>
<row>
<entry>[Registry]</entry>
<entry>no</entry>
<entry>Specifies locations of windows registry files</entry>
</row>
<row>
<entry>[tweak.layout]</entry>
<entry>recmd</entry>
<entry>Appearance of wine</entry>
</row>
<row>
<entry>[programs]</entry>
<entry>no</entry>
<entry>Programs to be run automatically</entry>
</row>
<row>
<entry>[Console]</entry>
<entry>no</entry>
<entry>Console settings</entry>
</row>
2002-01-14 20:44:30 +01:00
<row>
<entry>[Clipboard]</entry>
<entry>no</entry>
<entry>Interaction for wine and X11 clipboard</entry>
</row>
<row>
<entry>[afmdirs]</entry>
<entry>no</entry>
<entry>Postscript driver settings</entry>
</row>
2001-05-22 21:26:31 +02:00
<row>
<entry>[WinMM]</entry>
<entry>yes</entry>
<entry>Multimedia settings</entry>
</row>
2002-01-14 20:44:30 +01:00
<row>
<entry>[AppDefaults]</entry>
<entry>no</entry>
<entry>Overwrite the settings of previous sections for special programs</entry>
</row>
2000-08-08 03:24:00 +02:00
</tbody>
</tgroup>
</informaltable>
<sect3>
<title>The [Drive X] Section</title>
<para>
2002-06-05 01:09:34 +02:00
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.
2000-08-08 03:24:00 +02:00
</para>
<para>
<programlisting>[Drive X]</programlisting>
2002-06-05 01:09:34 +02:00
The above line begins the section for a drive whose letter is X
(DOS notation: drive 'X:').
You could e.g. create an equivalent to a drive 'C:'
under DOS/Windows by using a [Drive C] section name.
</para>
<para>
<programlisting>"Path" = "/dir/to/path"</programlisting>
This specifies the directory where the drive will begin.
When Wine is browsing in drive X, it will be able
to see the files that are in the directory
<filename>/dir/to/path</filename> and below.
(note that symlinks to directories won't get included !
see "<link linkend="dirsymlinks">ShowDirSymlinks</link>"
config setting)
You can also make use of environment variables like $HOME here,
an example for using a mywinedrive directory in your home dir
would be
"Path" = "${HOME}/mywinedrive"
Don't forget to leave off the trailing slash!
</para>
<para>
<programlisting>"Type" = "hd|cdrom|network|floppy"</programlisting>
2000-08-08 03:24:00 +02:00
Sets up the type of drive Wine will see it as. Type must
equal one of the four <literal>floppy</literal>,
<literal>hd</literal>, <literal>cdrom</literal>, or
<literal>network</literal>. They are self-explanatory.
2001-09-27 01:02:31 +02:00
(The |'s mean "Type = '<one of the options>'".)
2002-06-05 01:09:34 +02:00
Usually, you choose "hd" for a drive ("hd" is default anyway).
2000-08-08 03:24:00 +02:00
</para>
<para>
2002-06-05 01:09:34 +02:00
<programlisting>"Label" = "blah"</programlisting>
Defines the drive label. Generally only needed
for programs that look for a special CD-ROM.
2000-08-08 03:24:00 +02:00
The label may be up to 11 characters.
2002-06-05 01:09:34 +02:00
Note that the preferred way of managing labels and serial numbers
of CD-ROMs and floppies is to give Wine raw device access for
reading these on a per-CD case (see "Device" below) instead of
hardcoding one specific "Label".
2000-08-08 03:24:00 +02:00
</para>
<para>
2001-01-19 00:03:47 +01:00
<programlisting>"Serial" = "deadbeef"</programlisting>
2000-08-08 03:24:00 +02:00
Tells Wine the serial number of the drive. A few programs with
intense protection for pirating might need this, but otherwise
2002-06-05 01:09:34 +02:00
it's not needed. Up to 8 characters and hexadecimal.
Using a "Device" entry instead of hardcoding the "Serial" probably
is a smarter choice.
2000-08-08 03:24:00 +02:00
</para>
<para>
2002-06-05 01:09:34 +02:00
<programlisting>"Filesystem" = "win95|unix|msdos"</programlisting>
2000-08-08 03:24:00 +02:00
Sets up the way Wine looks at files on the drive.
</para>
<variablelist>
<varlistentry>
<term><literal>win95</literal></term>
<listitem>
<para>
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!
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>unix</literal></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
2002-06-05 01:09:34 +02:00
<varlistentry>
<term><literal>msdos</literal></term>
<listitem>
<para>
Case insensitive filesystem. Alike to DOS and
Windows 3.x. <literal>8.3</literal> 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.)
</para>
</listitem>
</varlistentry>
2000-08-08 03:24:00 +02:00
</variablelist>
2001-01-19 00:03:47 +01:00
<programlisting>"Device" = "/dev/xx"</programlisting>
2000-08-08 03:24:00 +02:00
<para>
2002-06-05 01:09:34 +02:00
Needed for raw device access and label and serial number reading.
2000-08-08 03:24:00 +02:00
Use this ONLY for floppy and cdrom devices. Using it on
2002-06-05 01:09:34 +02:00
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.
2000-08-08 03:24:00 +02:00
</para>
<note>
<para>
This setting is not really important; almost all apps
will have no problem if it remains unspecified. For
2002-06-05 01:09:34 +02:00
CD-ROMs it's quite useful in order to get automatic label
2000-08-08 03:24:00 +02:00
detection, though. If you are unsure about specifying
device names, just leave out this setting for your
drives.
</para>
</note>
<para>
2002-06-05 01:09:34 +02:00
Here are a few sample entries:
2000-08-08 03:24:00 +02:00
<programlisting>
2002-06-05 01:09:34 +02:00
Here is a setup for Drive C, a generic hard drive:
[Drive C]
"Path" = "/dosc"
2001-01-19 00:03:47 +01:00
"Type" = "hd"
"Label" = "Hard Drive"
"Filesystem" = "win95"
2002-06-05 01:09:34 +02:00
This is a setup for Drive E, a generic CD-ROM drive:
[Drive E]
"Path" = "/mnt/cdrom"
2001-01-19 00:03:47 +01:00
"Type" = "cdrom"
"Label" = "Total Annihilation"
"Filesystem" = "win95"
2002-06-05 01:09:34 +02:00
"Device" = "/dev/cdrom"
And here is a setup for Drive A, a generic floppy drive:
[Drive A]
2001-01-19 00:03:47 +01:00
"Type" = "floppy"
"Path" = "/mnt/floppy"
"Label" = "Floppy Drive"
"Serial" = "87654321"
"Filesystem" = "win95"
"Device" = "/dev/fd0"
2000-08-08 03:24:00 +02:00
</programlisting>
</para>
</sect3>
<sect3>
<title>The [wine] Section </title>
<para>
2001-09-20 00:34:38 +02:00
The [wine] section of the configuration file contains all kinds
2002-06-05 01:09:34 +02:00
of general settings for Wine.
</para>
2000-08-08 03:24:00 +02:00
<para>
2002-06-05 01:09:34 +02:00
<programlisting>"Windows" = "c:\\windows"</programlisting>
This tells Wine and Windows programs where the
<filename>Windows</filename> directory is. It is
recommended to have this directory somewhere on your
configured <medialabel>C</medialabel> drive, and it's also
recommended to just call the directory "windows" (this is
the default setup on Windows, and some stupid applications
might rely on this). So in case you chose a "Windows"
setting of "c:\\windows" and you chose to set up a drive C
e.g. at <filename>/usr/local/wine_c</filename>, the
corresponding directory would be
<filename>/usr/local/wine_c/windows</filename>. Make one
if you don't already have one. NO TRAILING SLASH (NOT
<filename>C:\\windows\</filename>)! Write access strongly
recommended!
2000-08-08 03:24:00 +02:00
</para>
<para>
2001-01-19 00:03:47 +01:00
<programlisting>"System" = "c:\\windows\\system"</programlisting>
2002-06-05 01:09:34 +02:00
This sets up where the windows system files are. The Windows
system directory should reside below the directory used for the
<literal>Windows</literal> setting.
Thus when using the example above, the system directory would be
<filename>/usr/local/wine_c/windows/system</filename>.
Again, no trailing slash, and write access!
2000-08-08 03:24:00 +02:00
</para>
<para>
2001-01-19 00:03:47 +01:00
<programlisting>"Temp" = "c:\\temp"</programlisting> This should
2002-06-05 01:09:34 +02:00
be the directory you want your temp files stored in,
/usr/local/wine_c/temp in our example.
Again, no trailing slash, and WRITE ACCESS!!
2000-08-08 03:24:00 +02:00
</para>
<para>
<programlisting>
2001-01-19 00:03:47 +01:00
"Path" = "c:\\windows;c:\\windows\\system;c:\\blanco"
2000-08-08 03:24:00 +02:00
</programlisting>
</para>
<para>
Behaves like the <envar>PATH</envar> setting on UNIX
boxes. When wine is run like <userinput>wine
sol.exe</userinput>, if <filename>sol.exe</filename>
resides in a directory specified in the
<literal>Path</literal> setting, wine will run it (Of
course, if <filename>sol.exe</filename> resides in the
current directory, wine will run that one). Make sure it
always has your <filename>windows</filename> directory and
system directory (For this setup, it must have
2001-01-19 00:03:47 +01:00
<filename>"c:\\windows;c:\\windows\\system"</filename>).
2000-08-08 03:24:00 +02:00
</para>
2001-09-20 00:34:38 +02:00
<para>
<programlisting>"GraphicsDriver" = "x11drv|ttydrv"</programlisting>
Sets the graphics driver to use for Wine output.
x11drv is for X11 output, ttydrv is for text console output.
WARNING: if you use ttydrv here, then you won't be able to run
any Windows GUI programs. Thus this option is mainly interesting
for e.g. embedded use of Wine in web server scripts.
2002-10-30 00:13:01 +01:00
Note that ttydrv is still very lacking, so if it doesn't work,
resort to using "xvfb", a virtual X11 server.
2001-09-20 00:34:38 +02:00
</para>
<para>
<programlisting>"Printer" = "off|on"</programlisting> Tells wine
whether to allow printing via printer drivers to work.
This option isn't needed for our builtin psdrv printer driver
at all.
Using these things are pretty alpha, so you might want to
watch out. Some people might find it useful, however. If
you're not planning on working on printing via windows printer
drivers, don't even add this to your wine config file
(It probably isn't already in it).
Check out the [spooler] and [parallelports] sections too.
</para>
<para>
<programlisting>"ShellLinker" = "wineshelllink"</programlisting>
This setting specifies the shell linker script to use for setting
up Windows icons in e.g. KDE or Gnome that are given by programs
making use of appropriate shell32.dll functionality to create
icons on the desktop/start menu during installation.
</para>
2002-06-05 01:09:34 +02:00
<para id="dirsymlinks">
2001-09-20 00:34:38 +02:00
<programlisting>"ShowDirSymlinks" = "1"</programlisting>
Wine doesn't pass directory symlinks to Windows programs by
default, as doing so may crash some programs that do
recursive lookups of whole subdirectory trees
whenever a directory symlink points back to itself or one of its
parent directories.
That's why we disallowed the use of directory symlinks
and added this setting to reenable ("1") this functionality.
</para>
2000-08-08 03:24:00 +02:00
<para>
2001-01-19 00:03:47 +01:00
<programlisting>"SymbolTableFile" = "wine.sym"</programlisting>
2000-08-08 03:24:00 +02:00
Sets up the symbol table file for the wine debugger. You
probably don't need to fiddle with this. May be useful if
your wine is stripped.
</para>
</sect3>
<sect3>
<title>Introduction To DLL Sections</title>
<para>
There are a few things you will need to know before
configuring the DLL sections in your wine configuration
file.
</para>
<sect4>
<title>Windows DLL Pairs</title>
<para>
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:
</para>
<informaltable>
<tgroup cols="3">
<thead>
<row>
<entry>Win16</entry>
<entry>Win32</entry>
<entry>
Native
<footnote>
<para>
Is it possible to use native dll with wine?
(See next section)
</para>
</footnote>
</entry>
</row>
</thead>
<tbody>
<row>
<entry>KERNEL</entry>
<entry>KERNEL32</entry>
<entry>No!</entry>
</row>
<row>
<entry>USER</entry>
<entry>USER32</entry>
<entry>No!</entry>
</row>
<row>
<entry>SHELL</entry>
<entry>SHELL32</entry>
<entry>Yes</entry>
</row>
<row>
<entry>GDI</entry>
<entry>GDI32</entry>
<entry>No!</entry>
</row>
<row>
<entry>COMMDLG</entry>
<entry>COMDLG32</entry>
<entry>Yes</entry>
</row>
<row>
<entry>VER</entry>
<entry>VERSION</entry>
<entry>Yes</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
<sect4>
<title>Different Forms Of DLL's</title>
<para>
There are a few different forms of DLL's wine can load:
<variablelist>
<varlistentry>
<term>native</term>
<listitem><para>
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.
</para></listitem>
</varlistentry>
<varlistentry>
2002-07-24 05:00:02 +02:00
<term>builtin</term>
2000-08-08 03:24:00 +02:00
<listitem><para>
2002-07-24 05:00:02 +02:00
The most common form of DLL loading. This is
what you will use if the DLL is error-prone in
native form (KERNEL for example), you don't have
the native DLL, or you just want to be
Microsoft-free.
2000-08-08 03:24:00 +02:00
</para></listitem>
</varlistentry>
<varlistentry>
<term>so</term>
<listitem><para>
Native ELF libraries. Will not work yet.
</para></listitem>
</varlistentry>
<varlistentry>
2002-07-24 05:00:02 +02:00
<term>elfdll</term>
2000-08-08 03:24:00 +02:00
<listitem><para>
2002-07-24 05:00:02 +02:00
ELF encapsulated windows DLL's.
No longer used, ignored.
2000-08-08 03:24:00 +02:00
</para></listitem>
</varlistentry>
</variablelist>
</para>
</sect4>
</sect3>
<sect3>
<title>The [DllDefaults] Section</title>
<para>
These settings provide wine's default handling of DLL loading.
</para>
<para>
2001-01-19 00:03:47 +01:00
<programlisting>"DefaultLoadOrder" =" native, so, builtin"</programlisting>
2000-08-08 03:24:00 +02:00
</para>
<para>
2001-09-20 00:34:38 +02:00
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.
2000-08-08 03:24:00 +02:00
</para>
</sect3>
<sect3>
<title>The [DllPairs] Section</title>
<para>
2002-07-24 05:00:02 +02:00
At one time, there was a section called [DllPairs] in the
2001-01-19 00:03:47 +01:00
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
2002-07-24 05:00:02 +02:00
still have this in your <filename>~/.wine/.config</filename> or
<filename>wine.conf</filename>, you may safely delete it.
2000-08-08 03:24:00 +02:00
</para>
2001-04-17 19:32:31 +02:00
</sect3>
2000-08-08 03:24:00 +02:00
<sect3>
<title>The [DllOverrides] Section</title>
<para>
The format for this section is the same for each line:
<programlisting>
<DLL>{,<DLL>,<DLL>...} = <FORM>{,<FORM>,<FORM>...}
</programlisting>
</para>
<para>
2000-12-13 22:52:37 +01:00
For example, to load builtin KERNEL pair (case doesn't
2000-08-08 03:24:00 +02:00
matter here):
<programlisting>
2001-01-19 00:03:47 +01:00
"kernel,kernel32" = "builtin"
2000-08-08 03:24:00 +02:00
</programlisting>
</para>
<para>
To load the native COMMDLG pair, but if that doesn't work
try builtin:
<programlisting>
2001-01-19 00:03:47 +01:00
"commdlg,comdlg32" = "native,builtin"
2000-08-08 03:24:00 +02:00
</programlisting>
</para>
<para>
To load the native COMCTL32:
<programlisting>
2001-01-19 00:03:47 +01:00
"comctl32" = "native"
2000-08-08 03:24:00 +02:00
</programlisting>
</para>
<para>
2001-01-19 00:03:47 +01:00
Here is a good generic setup (As it is defined in config
2000-08-08 03:24:00 +02:00
that was included with your wine package):
<programlisting>
[DllOverrides]
2002-07-24 05:00:02 +02:00
"rpcrt4" = "builtin, native"
"oleaut32" = "builtin, native"
"ole32" = "builtin, native"
2001-01-19 00:03:47 +01:00
"commdlg" = "builtin, native"
"comdlg32" = "builtin, native"
"ver" = "builtin, native"
"version" = "builtin, native"
"shell" = "builtin, native"
"shell32" = "builtin, native"
2002-07-24 05:00:02 +02:00
"shfolder" = "builtin, native"
"shlwapi" = "builtin, native"
"shdocvw" = "builtin, native"
2001-01-19 00:03:47 +01:00
"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"
2002-07-24 05:00:02 +02:00
"opengl32" = "builtin, native"
2001-01-19 00:03:47 +01:00
"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"
2002-07-24 05:00:02 +02:00
; you can specify applications too
"notepad.exe" = "native, builtin"
; default for all other dlls
"*" = "native, builtin"
2000-08-08 03:24:00 +02:00
</programlisting>
</para>
<note>
<para>
2002-07-24 05:00:02 +02:00
If loading of the libraries that are listed first fails,
wine will just go on by using the second or third option.
2000-08-08 03:24:00 +02:00
</para>
</note>
</sect3>
<sect3>
<title>The [fonts] Section</title>
<para>
This section sets up wine's font handling.
</para>
<para>
2001-01-19 00:03:47 +01:00
<programlisting>"Resolution" = "96"</programlisting>
2000-08-08 03:24:00 +02:00
</para>
<para>
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 (<filename><dirs to
wine>/documentation/ttfserver</filename> and
<filename>fonts</filename>), this parameter will not be as
important. Of course, it's always good to get your X fonts
working acceptably in wine.
</para>
<para>
2001-01-19 00:03:47 +01:00
<programlisting>"Default" = "-adobe-times-"</programlisting>
2000-08-08 03:24:00 +02:00
The default font wine uses. Fool around with it if you'd like.
</para>
<para>
2002-07-24 05:00:02 +02:00
OPTIONAL:
2000-08-08 03:24:00 +02:00
</para>
<para>
The <literal>Alias</literal> 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:
<programlisting>
2001-01-19 00:03:47 +01:00
"AliasX" = "[Fake windows name],[Real X name]"<,optional "masking" section>
2000-08-08 03:24:00 +02:00
</programlisting>
</para>
<para>
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.
</para>
<para>
Here is an example of an alias without masking. The font will show up in windows
2002-07-24 05:00:02 +02:00
apps as "Google".
2000-08-08 03:24:00 +02:00
<programlisting>
2002-07-24 05:00:02 +02:00
"Alias0" = "Foo,--google-"
2000-08-08 03:24:00 +02:00
</programlisting>
</para>
<para>
Here is an example with masking enabled. The font will show up as "Foo" in
windows apps.
<programlisting>
2001-01-19 00:03:47 +01:00
"Alias1" = "Foo,--google-,subst"
2000-08-08 03:24:00 +02:00
</programlisting>
</para>
<para>
2002-07-24 05:00:02 +02:00
For more info check out the <link linkend="fonts">Fonts</link>
chapter.
2000-08-08 03:24:00 +02:00
</para>
</sect3>
<sect3>
<title>The [serialports], [parallelports], [spooler], and [ports] Sections</title>
<para>
Even though it sounds like a lot of sections, these are
2000-12-13 22:52:37 +01:00
all closely related. They are all for communications and
2002-07-24 05:00:02 +02:00
parallel ports.
2000-08-08 03:24:00 +02:00
</para>
<para>
The [serialports] section tells wine what serial ports it
is allowed to use.
2001-01-19 00:03:47 +01:00
<programlisting>"ComX" = "/dev/cuaY"</programlisting>
2000-08-08 03:24:00 +02:00
</para>
<para>
Replace <literal>X</literal> with the number of the COM
port in Windows (1-8) and <literal>Y</literal> with the
number of it in <literal>X</literal> (Usually the number
of the port in Windows minus 1). <literal>ComX</literal>
can actually equal any device
(<medialabel>/dev/modem</medialabel> is acceptable). It is
not always necessary to define any COM ports (An optional
setting). Here is an example:
2001-01-19 00:03:47 +01:00
<programlisting>"Com1" = "/dev/cua0"</programlisting>
2000-08-08 03:24:00 +02:00
</para>
<para>
Use as many of these as you like in the section to define
all of the COM ports you need.
</para>
<para>
The [parallelports] section sets up any parallel ports
that will be allowed access under wine.
2001-01-19 00:03:47 +01:00
<programlisting>"LptX" = "/dev/lpY"</programlisting>
2000-08-08 03:24:00 +02:00
</para>
<para>
2000-12-13 22:52:37 +01:00
Sounds familiar? Syntax is just like the COM port setting.
2000-08-08 03:24:00 +02:00
Replace <literal>X</literal> with a value from 1-4 as it
is in Windows and <literal>Y</literal> with a value from
0-3 (<literal>Y</literal> 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
<medialabel>/dev/printer</medialabel>). Here is an
2001-01-19 00:03:47 +01:00
example: <programlisting>"Lpt1" = "/dev/lp0"</programlisting>
2000-08-08 03:24:00 +02:00
</para>
<para>
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,
2002-07-24 05:00:02 +02:00
mapping LPT1 to the file <filename>out.ps</filename>:
2001-01-19 00:03:47 +01:00
<programlisting>"LPT1:" = "out.ps"</programlisting>
2000-08-08 03:24:00 +02:00
</para>
<para>
The following command maps printing jobs to LPT1 to the
2002-07-24 05:00:02 +02:00
command <command>lpr</command>. Notice the |:
2001-01-19 00:03:47 +01:00
<programlisting>"LPT1:" = "|lpr"</programlisting>
2000-08-08 03:24:00 +02:00
</para>
<para>
The [ports] section is usually useful only for people who
need direct port access for programs requiring dongles or
2002-07-24 05:00:02 +02:00
scanners. IF YOU DON'T NEED IT, DON'T USE IT!
2000-08-08 03:24:00 +02:00
</para>
<para>
2001-01-19 00:03:47 +01:00
<programlisting>"read" = "0x779,0x379,0x280-0x2a0"</programlisting>
2000-08-08 03:24:00 +02:00
Gives direct read access to those IO's.
</para>
<para>
2001-01-19 00:03:47 +01:00
<programlisting>"write" = "0x779,0x379,0x280-0x2a0"</programlisting>
2000-12-13 22:52:37 +01:00
Gives direct write access to those IO's. It's probably a
2000-08-08 03:24:00 +02:00
good idea to keep the values of the
<literal>read</literal> and <literal>write</literal>
2000-12-13 22:52:37 +01:00
settings the same. This stuff will only work when you're
2000-08-08 03:24:00 +02:00
root.
</para>
</sect3>
2002-10-19 03:00:04 +02:00
<sect3 id="config-debug-etc">
<title>The [Debug], [Registry], [tweak.layout], and [programs] Sections</title>
2000-08-08 03:24:00 +02:00
<para>
2002-10-19 03:00:04 +02:00
[Debug] is used to include or exclude debug messages, and to
2000-08-08 03:24:00 +02:00
output them to a file. The latter is rarely used. THESE
ARE ALL OPTIONAL AND YOU PROBABLY DON'T NEED TO ADD OR
2002-10-19 03:00:04 +02:00
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 <parameter>--debugmsg +relay
</parameter> option.)
2000-08-08 03:24:00 +02:00
</para>
<para>
2001-01-19 00:03:47 +01:00
<programlisting>"File" = "/blanco"</programlisting>
2000-08-08 03:24:00 +02:00
Sets the logfile for wine. Set to CON to log to standard out.
THIS IS RARELY USED.
</para>
<para>
2002-10-19 03:00:04 +02:00
<programlisting>"SpyExclude" = "WM_SIZE;WM_TIMER;"</programlisting>
2000-08-08 03:24:00 +02:00
Excludes debug messages about <constant>WM_SIZE</constant>
and <constant>WM_TIMER</constant> in the logfile.
</para>
<para>
2002-10-19 03:00:04 +02:00
<programlisting>"SpyInclude" = "WM_SIZE;WM_TIMER;"</programlisting>
2000-08-08 03:24:00 +02:00
Includes debug messages about <constant>WM_SIZE</constant>
and <constant>WM_TIMER</constant> in the logfile.
</para>
2002-10-19 03:00:04 +02:00
<para>
<programlisting>"RelayInclude" = "user32.CreateWindowA;comctl32.*"</programlisting>
Include only the listed functions in a
<parameter>--debugmsg +relay</parameter> trace. This entry is
ignored if there is a <parameter>RelayExclude</parameter> entry.
</para>
<para>
<programlisting>"RelayExclude" = "RtlEnterCriticalSection;RtlLeaveCriticalSection"</programlisting>
Exclude the listed functions in a
<parameter>--debugmsg +relay</parameter> trace. This entry
overrides any settings in a <parameter>RelayInclude</parameter>
entry. If neither entry is present then the trace includes
everything.
</para>
<para>
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
all functions in the module.
</para>
2000-08-08 03:24:00 +02:00
<para>
[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.
</para>
<para>
2001-01-19 00:03:47 +01:00
<programlisting>"UserFileName" = "/dirs/to/user.reg"</programlisting>
2000-08-08 03:24:00 +02:00
The location of your old <filename>user.reg</filename> file.
</para>
<para>
[tweak.layout] is devoted to wine's look. There is only
one setting for it.
</para>
<para>
2001-01-19 00:03:47 +01:00
<programlisting>"WineLook" = "win31|win95|win98"</programlisting>
2000-08-08 03:24:00 +02:00
Will change the look of wine from Windows 3.1 to Windows 95.
The <literal>win98</literal> setting behaves
just like <literal>win95</literal> most of the time.
</para>
<para>
[programs] can be used to say what programs run under
special conditions.
</para>
<para>
2001-01-19 00:03:47 +01:00
<programlisting>"Default" = "/program/to/execute.exe"</programlisting>
2000-08-08 03:24:00 +02:00
Sets the program to be run if wine is started without specifying a program.
</para>
<para>
2001-01-19 00:03:47 +01:00
<programlisting>"Startup" = "/program/to/execute.exe"</programlisting>
2000-08-08 03:24:00 +02:00
Sets the program to automatically be run at startup every time.
</para>
</sect3>
2001-05-22 21:26:31 +02:00
<sect3>
<title>The [WinMM] Section</title>
<para>
[WinMM] is used to define which multimedia drivers have to be loaded. Since
2002-11-15 02:01:47 +01:00
those drivers may depend on the multimedia interfaces available on your system
2001-05-22 21:26:31 +02:00
(OSS, Alsa... to name a few), it's needed to be able to configure which driver
has to be loaded.
</para>
<para>
The content of the section looks like:
2002-07-24 05:00:02 +02:00
<programlisting>
2001-05-22 21:26:31 +02:00
[WinMM]
"Drivers" = "wineoss.drv"
"WaveMapper" = "msacm.drv"
"MidiMapper" = "midimap.drv"
2002-07-24 05:00:02 +02:00
</programlisting>
2001-05-22 21:26:31 +02:00
All the keys must be defined:
<itemizedlist>
<listitem>
<para>
2002-07-24 05:00:02 +02:00
The "Drivers" key is a ';' separated list of modules name, each of
them containing a low level driver. All those drivers will be loaded
2001-05-22 21:26:31 +02:00
when MMSYSTEM/WINMM is started and will provide their inner features.
</para>
</listitem>
<listitem>
<para>
The "WaveMapper" represents the name of the module containing the Wave
Mapper driver. Only one wave mapper can be defined in the system.
</para>
</listitem>
<listitem>
<para>
2002-07-24 05:00:02 +02:00
The "MidiMapper" represents the name of the module containing the MIDI
Mapper driver. Only one MIDI mapper can be defined in the system.
2001-05-22 21:26:31 +02:00
</para>
</listitem>
</itemizedlist>
</para>
</sect3>
2002-01-14 20:44:30 +01:00
2002-11-15 02:01:47 +01:00
<sect3 id="network-section">
<title>The [Network] Section</title>
<para>
[Network] contains settings related to
networking. Currently there is only one value that can be set.
</para>
<variablelist>
<varlistentry>
<term>UseDnsComputerName</term>
<listitem>
<para>
A boolean setting (default: <literal>Y</literal>)
that affects the way Wine sets the computer name. The computer
name in the Windows world is the so-called <emphasis>NetBIOS name</emphasis>.
It is contained in the <varname>ComputerName</varname> in the registry entry
<varname>HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\ComputerName\ComputerName</varname>.
</para>
<para>
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 <command>hostname</command>, up to and not
including the first dot ('.'). Among other things, this means that
Windows programs running under Wine cannot change the NetBIOS computer name.
</para>
<para>
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.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
2002-10-30 00:13:01 +01:00
<sect3 id="appdefaults-section">
2002-01-14 20:44:30 +01:00
<title>The [AppDefaults] Section</title>
<para>
2002-07-24 05:00:02 +02:00
The section is used to overwrite certain settings of this file for a
2002-01-14 20:44:30 +01:00
special program with different settings.
[AppDefaults] is not the real name of the section. The real name
2002-07-24 05:00:02 +02:00
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.
2002-01-14 20:44:30 +01:00
</para>
<para>
2002-07-24 05:00:02 +02:00
Currently wine supports only overwriting the sections
[DllOverrides], [x11drv], [version] and [dsound].
2002-01-14 20:44:30 +01:00
</para>
<para>
Here is an example that overwrites the normal settings for a
program:
2002-07-24 05:00:02 +02:00
<programlisting>
2002-01-14 20:44:30 +01:00
;; default settings
[x11drv]
"Managed" = "Y"
"Desktop" = "N"
;; run install in desktop mode
[AppDefaults\\install.exe\\x11drv]
"Managed" = "N"
"Desktop" = "800x600"
2002-07-24 05:00:02 +02:00
</programlisting>
2002-01-14 20:44:30 +01:00
</para>
</sect3>
2000-08-08 03:24:00 +02:00
</sect2>
<sect2>
<title>Where Do I Put It?</title>
<para>
The wine config file can go in two places.
</para>
<variablelist>
<varlistentry>
<term><filename>/usr/local/etc/wine.conf</filename></term>
<listitem><para>
A systemwide config file, used for anyone who doesn't
2001-01-19 00:03:47 +01:00
have their own. NOTE: this file is currently unused as a
new global configuration mechanism is not in place at this
2002-07-24 05:00:02 +02:00
time.
2000-08-08 03:24:00 +02:00
</para></listitem>
</varlistentry>
<varlistentry>
2001-01-19 00:03:47 +01:00
<term><filename>$HOME/.wine/config</filename></term>
2000-08-08 03:24:00 +02:00
<listitem><para>
2002-07-24 05:00:02 +02:00
Your own config file (which only is used for your user).
2000-08-08 03:24:00 +02:00
</para></listitem>
</varlistentry>
</variablelist>
<para>
2002-07-24 05:00:02 +02:00
So copy your version of the wine config file to
<filename>$HOME/.wine/config</filename>
or <filename>/usr/local/etc/wine.conf</filename>
for wine to recognize it.
2000-08-08 03:24:00 +02:00
</para>
</sect2>
<sect2>
<title>What If It Doesn't Work?</title>
<para>
There is always a chance that things will go wrong. If the
2002-07-24 05:00:02 +02:00
unthinkable happens, report the problem to
2002-05-09 01:14:19 +02:00
<ulink url="http://bugs.winehq.com/">Wine Bugzilla</ulink>,
try the newsgroup
2000-12-13 22:52:37 +01:00
<systemitem>comp.emulators.ms-windows.wine</systemitem>,
2001-01-19 00:03:47 +01:00
or the IRCnet channel <systemitem>#WineHQ</systemitem> found on
irc.stealth.net:6668, or connected servers.
2000-12-13 22:52:37 +01:00
Make sure that you have looked over this document thoroughly,
and have also read:
2000-08-08 03:24:00 +02:00
</para>
<itemizedlist>
<listitem>
<para><filename>README</filename></para>
</listitem>
<listitem>
<para>
2002-07-24 05:00:02 +02:00
<filename>http://www.winehq.org/trouble/</filename>
2000-08-08 03:24:00 +02:00
</para>
</listitem>
</itemizedlist>
<para>
If indeed it looks like you've done your research, be
prepared for helpful suggestions. If you haven't, brace
yourself for heaving flaming.
</para>
</sect2>
</sect1>
<sect1 id="x11drv">
<title>Configuring the x11drv Driver</title>
<para>
2000-12-13 22:52:37 +01:00
Written by &name-ove-kaaven; <email>&email-ove-kaaven;</email>
2000-08-08 03:24:00 +02:00
</para>
<para>
2002-01-14 20:44:30 +01:00
(Extracted from <filename>wine/documentation/x11drv</filename>)
2000-08-08 03:24:00 +02:00
</para>
<para>
Most Wine users run Wine under the windowing system known as
X11. During most of Wine's history, this was the only display
driver available, but in recent years, parts of Wine has been
reorganized to allow for other display drivers (although the
only alternative currently available is Patrik Stridvall's
ncurses-based ttydrv, which he claims works for displaying
calc.exe). The display driver is chosen with the
<literal>GraphicsDriver</literal> option in the [wine] section
2001-01-19 00:03:47 +01:00
of <filename>~/.wine/config</filename>, but I will only cover the
x11drv driver in this article.
2000-08-08 03:24:00 +02:00
</para>
<sect2>
<title>x11drv modes of operation</title>
2001-05-11 22:02:07 +02:00
2000-08-08 03:24:00 +02:00
<para>
The x11drv driver consists of two conceptually distinct
pieces, the graphics driver (GDI part), and the windowing
driver (USER part). Both of these are linked into the
<filename>libx11drv.so</filename> module, though (which you
load with the <literal>GraphicsDriver</literal> option). In
Wine, running on X11, the graphics driver must draw on
drawables (window interiors) provided by the windowing
driver. This differs a bit from the Windows model, where the
windowing system creates and configures device contexts
controlled by the graphics driver, and applications are
allowed to hook into this relationship anywhere they like.
Thus, to provide any reasonable tradeoff between
compatibility and usability, the x11drv has three different
modes of operation.
</para>
<variablelist>
<varlistentry>
<term>Managed</term>
<listitem>
<para>
2002-10-30 00:13:01 +01:00
The default. Specified by using the <literal>Managed</literal>
2002-07-24 05:00:02 +02:00
wine config file option (see below).
2000-08-08 03:24:00 +02:00
Ordinary top-level frame windows with thick borders,
title bars, and system menus will be managed by your
window manager. This lets these applications integrate
better with the rest of your desktop, but may not
always work perfectly. (A rewrite of this mode of
operation, to make it more robust and less patchy, is
2002-10-30 00:13:01 +01:00
currently being done, though, and it's planned to be
finished before the Wine 1.0 release.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Unmanaged/Normal</term>
<listitem>
<para>
Window-manager-independent (any running
window manager is ignored completely). Window
decorations (title bars, borders, etc) are drawn by
Wine to look and feel like the real Windows. This is
compatible with applications that depend on being able
to compute the exact sizes of any such decorations, or
that want to draw their own.
Unmanaged mode is only used if both Managed and Desktop
are set to disabled.
2000-08-08 03:24:00 +02:00
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Desktop-in-a-Box</term>
<listitem>
<para>
2002-07-24 05:00:02 +02:00
Specified by using the <literal>Desktop</literal>
wine config file option (see below).
(adding a geometry, e.g. <literal>800x600</literal>
for a such-sized desktop, or
even <literal>800x600+0+0</literal> to
2000-08-08 03:24:00 +02:00
automatically position the desktop at the upper-left
corner of the display). This is the mode most
compatible with the Windows model. All application
windows will just be Wine-drawn windows inside the
Wine-provided desktop window (which will itself be
managed by your window manager), and Windows
applications can roam freely within this virtual
workspace and think they own it all, without
disturbing your other X apps.
2002-10-30 00:13:01 +01:00
Note: currently there's one desktop window for every
application; this will be fixed at some time.
2000-08-08 03:24:00 +02:00
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2>
<title>The [x11drv] section</title>
<variablelist>
<varlistentry>
2002-07-24 05:00:02 +02:00
<term>Managed</term>
2000-08-08 03:24:00 +02:00
<listitem>
<para>
2002-07-24 05:00:02 +02:00
Wine can let frame windows be managed by your window
manager. This option specifies whether you want that
by default.
2000-08-08 03:24:00 +02:00
</para>
</listitem>
2002-07-24 05:00:02 +02:00
</varlistentry>
2000-08-08 03:24:00 +02:00
<varlistentry>
2002-07-24 05:00:02 +02:00
<term>Desktop</term>
2000-08-08 03:24:00 +02:00
<listitem>
<para>
2002-07-24 05:00:02 +02:00
Creates a main desktop window of a specified size
to display all Windows applications in.
The size argument could e.g. be "800x600".
2000-08-08 03:24:00 +02:00
</para>
</listitem>
2002-07-24 05:00:02 +02:00
</varlistentry>
2000-08-08 03:24:00 +02:00
<varlistentry>
2002-07-24 05:00:02 +02:00
<term>DXGrab</term>
2000-08-08 03:24:00 +02:00
<listitem>
<para>
2002-07-24 05:00:02 +02:00
If you don't use DGA, you may want an alternative
means to convince the mouse cursor to stay within the
game window. This option does that. Of course, as with
DGA, if Wine crashes, you're in trouble (although not
as badly as in the DGA case, since you can still use
the keyboard to get out of X).
2000-08-08 03:24:00 +02:00
</para>
</listitem>
2002-07-24 05:00:02 +02:00
</varlistentry>
2000-08-08 03:24:00 +02:00
<varlistentry>
<term>UseDGA</term>
<listitem>
<para>
This specifies whether you want DirectDraw to use
XFree86's <firstterm>Direct Graphics
Architecture</firstterm> (DGA), which is able to
take over the entire display and run the game
full-screen at maximum speed. (With DGA1 (XFree86
3.x), you still have to configure the X server to the
game's requested bpp first, but with DGA2 (XFree86
4.x), runtime depth-switching may be possible,
depending on your driver's capabilities.) But be aware
that if Wine crashes while in DGA mode, it may not be
possible to regain control over your computer without
rebooting. DGA normally requires either root
privileges or read/write access to
<filename>/dev/mem</filename>.
</para>
</listitem>
2002-07-24 05:00:02 +02:00
</varlistentry>
2000-08-08 03:24:00 +02:00
<varlistentry>
<term>UseXShm</term>
<listitem>
<para>
If you don't want DirectX to use DGA, you can at least
use X Shared Memory extensions (XShm). It is much
slower than DGA, since the app doesn't have direct
access to the physical frame buffer, but using shared
memory to draw the frame is at least faster than
sending the data through the standard X11 socket, even
though Wine's XShm support is still known to crash
sometimes.
</para>
</listitem>
2002-07-24 05:00:02 +02:00
</varlistentry>
2000-08-08 03:24:00 +02:00
<varlistentry>
<term>DesktopDoubleBuffered</term>
<listitem>
<para>
Applies only if you use the
<parameter>--desktop</parameter> command-line option
to run in a desktop window. Specifies whether to
create the desktop window with a double-buffered
visual, something most OpenGL games need to run
correctly.
</para>
</listitem>
</varlistentry>
2001-05-11 22:02:07 +02:00
<varlistentry>
2002-07-24 05:00:02 +02:00
<term>AllocSystemColors</term>
2001-05-11 22:02:07 +02:00
<listitem>
<para>
2002-07-24 05:00:02 +02:00
Applies only if you have a palette-based display, i.e.
if your X server is set to a depth of 8bpp, and if you
haven't requested a private color map. It specifies
the maximum number of shared colormap cells (palette
entries) Wine should occupy. The higher this value,
the less colors will be available to other
applications.
2001-05-11 22:02:07 +02:00
</para>
</listitem>
</varlistentry>
<varlistentry>
2002-07-24 05:00:02 +02:00
<term>PrivateColorMap</term>
<listitem>
<para>
Applies only if you have a palette-based display, i.e.
if your X server is set to a depth of 8bpp. It
specifies that you don't want to use the shared color
map, but a private color map, where all 256 colors are
available. The disadvantage is that Wine's private
color map is only seen while the mouse pointer is
inside a Wine window, so psychedelic flashing and
funky colors will become routine if you use the mouse
a lot.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Synchronous</term>
<listitem>
<para>
To be used for debugging X11 operations.
If Wine crashes with an X11 error, then you should enable
Synchronous mode to disable X11 request caching in order
to make sure that the X11 error happens directly after
the corresponding X11 call in the log file appears.
Will slow down X11 output !
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ScreenDepth</term>
<listitem>
<para>
Applies only to multi-depth displays. It specifies
which of the available depths Wine should use (and
tell Windows apps about).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Display</term>
<listitem>
<para>
This specifies which X11 display to use, and if
specified, will override the
<envar>DISPLAY</envar> environment variable.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PerfectGraphics</term>
<listitem>
<para>
This option only determines whether fast X11 routines
or exact Wine routines will be used for certain ROP
codes in blit operations. Most users won't notice any
difference.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TextCP</term>
2001-05-11 22:02:07 +02:00
<listitem>
<para>
2002-10-30 00:13:01 +01:00
Codepage to be used for rendering the text in X11
output. Some sample values would be 437 (USA, Canada),
850 (Europe), 852 (Central/Eastern Europe), 855
(Cyrillic). For additional suitable values, see e.g. the Linux
kernel's codepage configuration page.
2001-05-11 22:02:07 +02:00
</para>
</listitem>
</varlistentry>
2000-08-08 03:24:00 +02:00
</variablelist>
2002-07-24 05:00:02 +02:00
</sect2>
2000-08-08 03:24:00 +02:00
</sect1>
®istry;
2002-10-30 00:13:01 +01:00
<sect1 id="windows-versions">
<title>Setting the windows and DOS version value that's passed to
programs</title>
<para>
Written by &name-andreas-mohr; <email>&email-andreas-mohr;</email>
Oct 18 2002
</para>
<para>
The windows and DOS version value a program gets e.g. by calling the
Windows function GetVersion() plays a very important role:
If your Wine installation for whatever reason fails to provide
to your program the correct version value that it expects,
then the program might assume some very bad things and fail (in
the worst case even silently !).
Fortunately Wine contains some more or less intelligent Windows
version guessing algorithm that will try to guess the Windows
version a program might expect and pass that one on to the
program.
Thus you should <emphasis>not</emphasis> lightly configure a version value, as this will be a "forced" value and thus turn out to be rather harmful to proper operation. In other words: only explicitly set a Windows version value in case Wine's own version detection was unable to provide the correct Windows version and the program fails.
</para>
<sect2>
<title>How to configure the Windows and DOS version value Wine
should return</title>
<para>
The version values can be configured in the wine config file in
the [Version] section.
</para>
<variablelist>
<varlistentry>
<term>"Windows" = "<version string>"</term>
<listitem>
<para>
default: none; chosen by semi-intelligent detection
mechanism based on DLL environment.
Used to specify which Windows version to return to
programs (forced value, overrides standard detection
mechanism !). Valid settings are e.g. "win31", "win95",
"win98", "win2k", "winxp".
Also valid as an
<link linkend="appdefaults-section">AppDefaults</link>
setting (recommended/preferred use).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>"DOS"="<version string>"</term>
<listitem>
<para>
Used to specify the DOS version that should be returned
to programs. Only takes effect in case Wine acts as
"win31" Windows version ! Common DOS version settings
include 6.22, 6.20, 6.00, 5.00, 4.00, 3.30, 3.10.
Also valid as an
<link linkend="appdefaults-section">AppDefaults</link>
setting (recommended/preferred use).
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
2000-08-08 03:24:00 +02:00
<sect1 id="cdrom-labels">
<sect1info>
<authorgroup>
<author>
<firstname>Petr</firstname>
<surname>Tomasek</surname>
<affiliation>
2000-12-13 22:52:37 +01:00
<address><email>&email-petr-tomasek;</email></address>
2000-08-08 03:24:00 +02:00
</affiliation>
<contrib>Nov 14 1999</contrib>
</author>
<author>
<firstname>Andreas</firstname>
<surname>Mohr</surname>
<affiliation>
2000-12-13 22:52:37 +01:00
<address><email>&email-andreas-mohr;</email></address>
2000-08-08 03:24:00 +02:00
</affiliation>
<contrib>Jan 25 2000</contrib>
</author>
</authorgroup>
</sect1info>
<title>Drive labels and serial numbers with wine</title>
<para>
2000-12-13 22:52:37 +01:00
Written by &name-petr-tomasek; <email>&email-petr-tomasek;</email>
2000-08-08 03:24:00 +02:00
Nov 14 1999
</para>
<para>
2000-12-13 22:52:37 +01:00
Changes by &name-andreas-mohr; <email>&email-andreas-mohr;</email>
2000-08-08 03:24:00 +02:00
Jan 25 2000
</para>
<para>
(Extracted from <filename>wine/documentation/cdrom-labels</filename>)
</para>
<para>
Until now, your only possibility of specifying drive volume
labels and serial numbers was to set them manually in the wine
config file. By now, wine can read them directly from the
device as well. This may be useful for many Win 9x games or
for setup programs distributed on CD-ROMs that check for
volume label.
</para>
<sect2>
<title>What's Supported?</title>
<informaltable frame="all">
<tgroup cols="3">
<thead>
<row>
<entry>File System</entry>
<entry>Types</entry>
<entry>Comment</entry>
</row>
</thead>
<tbody>
<row>
<entry>FAT systems</entry>
<entry>hd, floppy</entry>
<entry>reads labels and serial numbers</entry>
</row>
<row>
<entry>ISO9660</entry>
<entry>cdrom</entry>
2001-09-20 00:34:38 +02:00
<entry>reads labels and serial numbers (not mixed-mode CDs yet !)</entry>
2000-08-08 03:24:00 +02:00
</row>
</tbody>
</tgroup>
</informaltable>
</sect2>
<sect2>
<title>How To Set Up?</title>
<para>
Reading labels and serial numbers just works automagically
if you specify a <literal>Device=</literal> line in the
2001-01-19 00:03:47 +01:00
[Drive X] section in your <filename>~/.wine/config</filename>.
2000-08-08 03:24:00 +02:00
Note that the device has to exist and must be accessible if
you do this, though.
</para>
<para>
If you don't do that, then you should give fixed
2001-01-19 00:03:47 +01:00
<literal>"Label" =</literal> or <literal>"Serial" =</literal>
2002-10-30 00:13:01 +01:00
entries in <filename>~/.wine/config</filename>, as Wine returns
2000-08-08 03:24:00 +02:00
these entries instead if no device is given. If they don't
exist, then Wine will return default values (label
<literal>Drive X</literal> and serial
<literal>12345678</literal>).
</para>
<para>
2001-01-19 00:03:47 +01:00
If you want to give a <literal>"Device" =</literal> entry
2000-12-13 22:52:37 +01:00
<emphasis>only</emphasis> for drive raw sector accesses,
but not for reading the volume info from the device (i.e. you want
a <emphasis>fixed</emphasis>, preconfigured label), you need
2001-01-19 00:03:47 +01:00
to specify <literal>"ReadVolInfo" = "0"</literal> to tell Wine
to skip the volume reading.
2000-08-08 03:24:00 +02:00
</para>
</sect2>
<sect2>
<title>EXAMPLES</title>
<para>
Here's a simple example of cdrom and floppy; labels will be
read from the device on both cdrom and floppy; serial
numbers on floppy only:
</para>
<screen>
[Drive A]
2001-01-19 00:03:47 +01:00
"Path" = "/mnt/floppy"
"Type" = "floppy"
"Device" = "/dev/fd0"
"Filesystem" = "msdos"
2000-08-08 03:24:00 +02:00
[Drive R]
2001-01-19 00:03:47 +01:00
"Path" = "/mnt/cdrom"
"Type" = "cdrom"
"Device" = "/dev/hda1"
"Filesystem" = "win95"
2000-08-08 03:24:00 +02:00
</screen>
<para>
Here's an example of overriding the CD-ROM label:
</para>
<screen>
[Drive J]
2001-01-19 00:03:47 +01:00
"Path" = "/mnt/cdrom"
"Type" = "cdrom"
"Label" = "X234GCDSE"
2000-08-08 03:24:00 +02:00
; note that the device isn't really needed here as we have a fixed label
2001-01-19 00:03:47 +01:00
"Device" = "/dev/cdrom"
"Filesystem" = "msdos"
2000-08-08 03:24:00 +02:00
</screen>
</sect2>
<sect2>
<title>Todo / Open Issues</title>
<itemizedlist>
<listitem> <para>
The cdrom label can be read only if the data track of
the disk resides in the first track and the cdrom is
iso9660.
</para> </listitem>
<listitem> <para>
Better checking for FAT superblock (it now checks only
one byte). </para>
</listitem>
<listitem> <para>
Support for labels/serial nums WRITING.
</para> </listitem>
<listitem> <para>
Can the label be longer than 11 chars? (iso9660 has 32
chars).
</para> </listitem>
<listitem> <para>
What about reading ext2 volume label? ....
</para> </listitem>
</itemizedlist>
</sect2>
</sect1>
2002-02-02 19:03:55 +01:00
<sect1 id="dll-config">
<title>DLL configuration</title>
<sect2 id="dll-overrides">
<title>DLL Overrides</title>
2002-07-24 05:00:02 +02:00
2000-08-08 03:24:00 +02:00
<para>
2002-02-02 19:03:55 +01:00
Written by &name-ove-kaaven; <email>&email-ove-kaaven;</email>
</para>
<para>
(Extracted from <filename>wine/documentation/dll-overrides</filename>)
</para>
2002-07-24 05:00:02 +02:00
2002-02-02 19:03:55 +01:00
<para>
2002-07-24 05:00:02 +02:00
The wine config file directives [DllDefaults]
2002-02-02 19:03:55 +01:00
and [DllOverrides] are the subject of some confusion. The
overall purpose of most of these directives are clear enough,
though - given a choice, should Wine use its own built-in
DLLs, or should it use <filename>.DLL</filename> files found
in an existing Windows installation? This document explains
how this feature works.
2000-08-08 03:24:00 +02:00
</para>
2002-07-24 05:00:02 +02:00
2002-02-02 19:03:55 +01:00
<sect3>
<title>DLL types</title>
<variablelist>
<varlistentry>
<term>native</term>
<listitem> <para>
A "native" DLL is a <filename>.DLL</filename> file
written for the real Microsoft Windows.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>builtin</term>
<listitem> <para>
A "builtin" DLL is a Wine DLL. These can either be a
part of <filename>libwine.so</filename>, or more
recently, in a special <filename>.so</filename> file
that Wine is able to load on demand.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>so</term>
<listitem> <para>
A native Unix <filename>.so</filename> file, with
calling convention conversion thunks generated on the
fly as the library is loaded. This is mostly useful
for libraries such as "glide" that have exactly the
same API on both Windows and Unix.
</para> </listitem>
</varlistentry>
2002-07-24 05:00:02 +02:00
</variablelist>
2002-02-02 19:03:55 +01:00
</sect3>
2002-07-24 05:00:02 +02:00
2002-02-02 19:03:55 +01:00
<sect3>
<title>The [DllDefaults] section</title>
<variablelist>
<varlistentry>
<term>DefaultLoadOrder</term>
<listitem> <para>
This specifies in what order Wine should search for
available DLL types, if the DLL in question was not
found in the [DllOverrides] section.
</para> </listitem>
</varlistentry>
</variablelist>
</sect3>
2002-07-24 05:00:02 +02:00
2002-02-02 19:03:55 +01:00
<sect3>
<title>The [DllPairs] section</title>
<para>
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
2002-07-24 05:00:02 +02:00
still have this in your <filename>~/.wine/config</filename> or
<filename>wine.conf</filename>, you may safely delete it.
2002-02-02 19:03:55 +01:00
</para>
</sect3>
2002-07-24 05:00:02 +02:00
2002-02-02 19:03:55 +01:00
<sect3>
<title>The [DllOverrides] section</title>
<para>
This section specifies how you want specific DLLs to be
handled, in particular whether you want to use "native" DLLs
or not, if you have some from a real Windows configuration.
Because builtins do not mix seamlessly with native DLLs yet,
certain DLL dependencies may be problematic, but workarounds
exist in Wine for many popular DLL configurations. Also see
WWN's [16]Status Page to figure out how well your favorite
DLL is implemented in Wine.
</para>
<para>
It is of course also possible to override these settings by
explictly using Wine's <parameter>--dll</parameter>
command-line option (see the man page for details). Some
hints for choosing your optimal configuration (listed by
16/32-bit DLL pair):
</para>
<variablelist>
<varlistentry>
<term>krnl386, kernel32</term>
<listitem> <para>
Native versions of these will never work, so don't try. Leave
at <literal>builtin</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>gdi, gdi32</term>
<listitem> <para>
Graphics Device Interface. No effort has been made at trying to
run native GDI. Leave at <literal>builtin</literal>.
</para> </listitem>
2002-07-24 05:00:02 +02:00
</varlistentry>
2002-02-02 19:03:55 +01:00
<varlistentry>
<term>user, user32</term>
<listitem> <para>
Window management and standard controls. It was
possible to use Win95's <literal>native</literal>
versions at some point (if all other DLLs that depend
on it, such as comctl32 and comdlg32, were also run
<literal>native</literal>). However, this is no longer
possible after the Address Space Separation, so leave
at <literal>builtin</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>ntdll</term>
<listitem> <para>
NT kernel API. Although badly documented, the
<literal>native</literal> version of this will never
work. Leave at <literal>builtin</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>w32skrnl</term>
<listitem> <para>
Win32s (for Win3.x). The <literal>native</literal>
version will probably never work. Leave at
<literal>builtin</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>wow32</term>
<listitem> <para>
Win16 support library for NT. The
<literal>native</literal> version will probably never
work. Leave at <literal>builtin</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>system</term>
<listitem> <para>
Win16 kernel stuff. Will never work
<literal>native</literal>. Leave at
<literal>builtin</literal>.
</para> </listitem>
2002-07-24 05:00:02 +02:00
</varlistentry>
2002-02-02 19:03:55 +01:00
<varlistentry>
<term>display</term>
<listitem> <para>
Display driver. Definitely leave at <literal>builtin</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>toolhelp</term>
<listitem> <para>
Tool helper routines. This is rarely a source of problems.
Leave at <literal>builtin</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>ver, version</term>
<listitem> <para>
Versioning. Seldom useful to mess with.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>advapi32</term>
<listitem> <para>
Registry and security features. Trying the
<literal>native</literal> version of this may or may
not work.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>commdlg, comdlg32</term>
<listitem> <para>
Common Dialogs, such as color picker, font dialog,
print dialog, open/save dialog, etc. It is safe to try
<literal>native</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>commctrl, comctl32</term>
<listitem> <para>
Common Controls. This is toolbars, status bars, list controls,
the works. It is safe to try <literal>native</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>shell, shell32</term>
<listitem> <para>
Shell interface (desktop, filesystem, etc). Being one of the
most undocumented pieces of Windows, you may have luck with the
<literal>native</literal> version, should you need it.
</para> </listitem>
2002-07-24 05:00:02 +02:00
</varlistentry>
2002-02-02 19:03:55 +01:00
<varlistentry>
<term>winsock, wsock32</term>
<listitem> <para>
Windows Sockets. The <literal>native</literal> version
will not work under Wine, so leave at
<literal>builtin</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>icmp</term>
<listitem> <para>
ICMP routines for wsock32. As with wsock32, leave at
<literal>builtin</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>mpr</term>
<listitem> <para>
The <literal>native</literal> version may not work due
to thunking issues. Leave at
<literal>builtin</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>lzexpand, lz32</term>
<listitem> <para>
Lempel-Ziv decompression. Wine's
<literal>builtin</literal> version ought to work fine.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>winaspi, wnaspi32</term>
<listitem> <para>
Advanced SCSI Peripheral Interface. The
<literal>native</literal> version will probably never
work. Leave at <literal>builtin</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>crtdll</term>
<listitem> <para>
C Runtime library. The <literal>native</literal>
version will easily work better than Wine's on this
one.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>winspool.drv</term>
<listitem> <para>
Printer spooler. You are not likely to have more luck
with the <literal>native</literal> version.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>ddraw</term>
<listitem> <para>
DirectDraw/Direct3D. Since Wine does not implement the
DirectX HAL, the <literal>native</literal> version
will not work at this time.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>dinput</term>
<listitem> <para>
DirectInput. Running this <literal>native</literal>
may or may not work.
</para> </listitem>
2002-07-24 05:00:02 +02:00
</varlistentry>
2002-02-02 19:03:55 +01:00
<varlistentry>
<term>dsound</term>
<listitem> <para>
DirectSound. It may be possible to run this
<literal>native</literal>, but don't count on it.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>dplay/dplayx</term>
<listitem> <para>
DirectPlay. The <literal>native</literal> version
ought to work best on this, if at all.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>mmsystem, winmm</term>
<listitem> <para>
Multimedia system. The <literal>native</literal>
version is not likely to work. Leave at
<literal>builtin</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>msacm, msacm32</term>
<listitem> <para>
Audio Compression Manager. The
<literal>builtin</literal> version works best, if you
set msacm.drv to the same.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>msvideo, msvfw32</term>
<listitem> <para>
Video for Windows. It is safe (and recommended) to try
<literal>native</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>mcicda.drv</term>
<listitem> <para>
CD Audio MCI driver.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>mciseq.drv</term>
<listitem> <para>
MIDI Sequencer MCI driver (<filename>.MID</filename>
playback).
</para> </listitem>
</varlistentry>
<varlistentry>
<term>mciwave.drv</term>
<listitem> <para>
Wave audio MCI driver (<filename>.WAV</filename> playback).
</para> </listitem>
</varlistentry>
<varlistentry>
<term>mciavi.drv</term>
<listitem> <para>
AVI MCI driver (<filename>.AVI</filename> video
playback). Best to use <literal>native</literal>.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>mcianim.drv</term>
<listitem> <para>
Animation MCI driver.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>msacm.drv</term>
<listitem> <para>
Audio Compression Manager. Set to same as msacm32.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>midimap.drv</term>
<listitem> <para>
MIDI Mapper.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>wprocs</term>
<listitem> <para>
This is a pseudo-DLL used by Wine for thunking
purposes. A <literal>native</literal> version of this
doesn't exist.
</para> </listitem>
</varlistentry>
2002-07-24 05:00:02 +02:00
</variablelist>
2002-02-02 19:03:55 +01:00
</sect3>
2000-08-08 03:24:00 +02:00
</sect2>
2002-02-02 19:03:55 +01:00
<sect2 id="dll-missing">
<title>Missing DLLs</title>
2002-07-24 05:00:02 +02:00
2000-08-08 03:24:00 +02:00
<para>
2002-02-02 19:03:55 +01:00
Written by &name-andreas-mohr; <email>&email-andreas-mohr;</email>
2000-08-08 03:24:00 +02:00
</para>
2002-07-24 05:00:02 +02:00
2000-08-08 03:24:00 +02:00
<para>
2002-02-02 19:03:55 +01:00
In case Wine complains about a missing DLL, you should check whether
this file is a publicly available DLL or a custom DLL belonging
to your program (by searching for its name on the internet).
If you managed to get hold of the DLL, then you should make sure
that Wine is able to find and load it.
DLLs usually get loaded according to the mechanism of the
SearchPath() function.
This function searches directories in the following order:
2002-07-24 05:00:02 +02:00
<orderedlist>
<listitem>
<para>
The directory the program was started from.
</para>
</listitem>
<listitem>
<para>
The current directory.
</para>
</listitem>
<listitem>
<para>
The Windows system directory.
</para>
</listitem>
<listitem>
<para>
The Windows directory.
</para>
</listitem>
<listitem>
<para>
The PATH variable directories.
</para>
</listitem>
</orderedlist>
2002-02-02 19:03:55 +01:00
In short: either put the required DLL into your application
directory (might be ugly), or usually put it into the Windows system
directory. Just find out its directory by having a look at the Wine
config File variable "System" (which indicates the location of the
Windows system directory) and the associated drive entry.
2002-10-30 00:13:01 +01:00
Note that you probably shouldn't use NT-based native DLLs,
since Wine's NT API support is somewhat weaker than its Win9x
API support (thus leading to even worse compatibility with NT DLLs
than with a no-windows setup !), so better use Win9x native DLLs
instead or no native DLLs at all.
</para>
</sect2>
<sect2 id="dll-windows">
<title>Fetching native DLLs from a Windows CD</title>
<para>
Written by &name-andreas-mohr; <email>&email-andreas-mohr;</email>
</para>
<para>
The Linux <command>cabextract</command> utility can be used to
extract native Windows .dll files from .cab files that are to be
found on many Windows installation CDs.
2000-08-08 03:24:00 +02:00
</para>
</sect2>
</sect1>
2002-06-05 01:09:34 +02:00
&fonts;
&printing;
<sect1 id="win95look">
<title>Win95/98 Look</title>
<para>
Written by &name-david-cuthbert; <email>&email-david-cuthbert;</email>
</para>
<para>
(Extracted from <filename>wine/documentation/win95look</filename>)
</para>
<para>
Win95/Win98 interface code is being introduced.
</para>
<para>
Instead of compiling Wine for Win3.1 vs. Win95 using
<constant>#define</constant> switches, the code now looks in a
special [Tweak.Layout] section of
<filename>~/.wine/config</filename> for a
<literal>"WineLook" = "Win95"</literal> or
<literal>"WineLook" = "Win98"</literal> entry.
</para>
<para>
A few new sections and a number of entries have been added to
the <filename>~/.wine/config</filename> file -- these are for
debugging the Win95 tweaks only and may be removed in a future
release! These entries/sections are:
</para>
<programlisting>
[Tweak.Fonts]
"System.Height" = "<point size>" # Sets the height of the system typeface
"System.Bold" = "[true|false]" # Whether the system font should be boldfaced
"System.Italic" = "[true|false]" # Whether the system font should be italicized
"System.Underline" = "[true|false]" # Whether the system font should be underlined
"System.StrikeOut" = "[true|false]" # Whether the system font should be struck out
"OEMFixed.xxx" # Same parameters for the OEM fixed typeface
"AnsiFixed.xxx" # Same parameters for the Ansi fixed typeface
"AnsiVar.xxx" # Same parameters for the Ansi variable typeface
"SystemFixed.xxx" # Same parameters for the System fixed typeface
[Tweak.Layout]
"WineLook" = "[Win31|Win95|Win98]" # Changes Wine's look and feel
</programlisting>
</sect1>
2000-08-08 03:24:00 +02:00
<sect1 id="keyboard">
<title>Keyboard</title>
2000-12-13 22:52:37 +01:00
<para>
Written by &name-ove-kaaven; <email>&email-ove-kaaven;</email>
</para>
2000-08-08 03:24:00 +02:00
<para>
(Extracted from <filename>wine/documentation/keyboard</filename>)
</para>
<para>
Wine now needs to know about your keyboard layout. This
requirement comes from a need from many apps to have the
correct scancodes available, since they read these directly,
instead of just taking the characters returned by the X
server. This means that Wine now needs to have a mapping from
X keys to the scancodes these applications expect.
</para>
<para>
On startup, Wine will try to recognize the active X layout by
seeing if it matches any of the defined tables. If it does,
everything is alright. If not, you need to define it.
</para>
<para>
To do this, open the file
2002-04-30 23:16:39 +02:00
<filename>dlls/x11drv/keyboard.c</filename> and take a look
2000-08-08 03:24:00 +02:00
at the existing tables. Make a backup copy of it, especially
if you don't use CVS.
</para>
<para>
What you really would need to do, is find out which scancode
each key needs to generate. Find it in the
<function>main_key_scan</function> table, which looks like
this:
</para>
<programlisting>
static const int main_key_scan[MAIN_LEN] =
{
/* this is my (102-key) keyboard layout, sorry if it doesn't quite match yours */
0x29,0x02,0x03,0x04,0x05,0x06,0x07,0x08,0x09,0x0A,0x0B,0x0C,0x0D,
0x10,0x11,0x12,0x13,0x14,0x15,0x16,0x17,0x18,0x19,0x1A,0x1B,
0x1E,0x1F,0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x27,0x28,0x2B,
0x2C,0x2D,0x2E,0x2F,0x30,0x31,0x32,0x33,0x34,0x35,
0x56 /* the 102nd key (actually to the right of l-shift) */
};
</programlisting>
<para>
Next, assign each scancode the characters imprinted on the
keycaps. This was done (sort of) for the US 101-key keyboard,
which you can find near the top in
<filename>keyboard.c</filename>. It also shows that if there
is no 102nd key, you can skip that.
</para>
<para>
However, for most international 102-key keyboards, we have
done it easy for you. The scancode layout for these already
pretty much matches the physical layout in the
<function>main_key_scan</function>, so all you need to do is
to go through all the keys that generate characters on your
main keyboard (except spacebar), and stuff those into an
appropriate table. The only exception is that the 102nd key,
which is usually to the left of the first key of the last line
(usually <keycap>Z</keycap>), must be placed on a separate
line after the last line.
</para>
<para>
For example, my Norwegian keyboard looks like this
</para>
<screen>
<EFBFBD> ! " # <20> % & / ( ) = ? ` Back-
| 1 2@ 3<> 4$ 5 6 7{ 8[ 9] 0} + \<5C> space
Tab Q W E R T Y U I O P <20> ^
<20> ~
Enter
Caps A S D F G H J K L <20> <20> *
Lock '
Sh- > Z X C V B N M ; : _ Shift
ift < , . -
Ctrl Alt Spacebar AltGr Ctrl
</screen>
<para>
Note the 102nd key, which is the <keycap><></keycap> key, to
the left of <keycap>Z</keycap>. The character to the right of
the main character is the character generated by
<keycap>AltGr</keycap>.
</para>
<para>
This keyboard is defined as follows:
</para>
<programlisting>
static const char main_key_NO[MAIN_LEN][4] =
{
"|<7C> ","1!","2\"@","3#<23> ","4<> $","5%","6&","7/{","8([","9)]","0=}","+?","\\<5C> ",
"qQ","wW","eE","rR","tT","yY","uU","iI","oO","pP","<22> <> ","<22> ^~",
"aA","sS","dD","fF","gG","hH","jJ","kK","lL","<22> <> ","<22> <> ","'*",
"zZ","xX","cC","vV","bB","nN","mM",",;",".:","-_",
"<>"
2002-07-24 05:00:02 +02:00
};
2000-08-08 03:24:00 +02:00
</programlisting>
<para>
Except that " and \ needs to be quoted with a backslash, and
that the 102nd key is on a separate line, it's pretty
straightforward.
</para>
<para>
After you have written such a table, you need to add it to the
<function>main_key_tab[]</function> layout index table. This
will look like this:
</para>
<programlisting>
static struct {
WORD lang, ansi_codepage, oem_codepage;
const char (*key)[MAIN_LEN][4];
} main_key_tab[]={
...
...
2002-07-24 05:00:02 +02:00
{MAKELANGID(LANG_NORWEGIAN,SUBLANG_DEFAULT), 1252, 865, &main_key_NO},
2000-08-08 03:24:00 +02:00
...
</programlisting>
<para>
After you have added your table, recompile Wine and test that
it works. If it fails to detect your table, try running
</para>
<screen>
wine --debugmsg +key,+keyboard >& key.log
</screen>
<para>
and look in the resulting <filename>key.log</filename> file to
find the error messages it gives for your layout.
</para>
<para>
Note that the <constant>LANG_*</constant> and
<constant>SUBLANG_*</constant> definitions are in
<filename>include/winnls.h</filename>, which you might need to
know to find out which numbers your language is assigned, and
find it in the debugmsg output. The numbers will be
<literal>(SUBLANG * 0x400 + LANG)</literal>, so, for example
the combination <literal>LANG_NORWEGIAN (0x14)</literal> and
<literal>SUBLANG_DEFAULT (0x1)</literal> will be (in hex)
<literal>14 + 1*400 = 414</literal>, so since I'm Norwegian, I
could look for <literal>0414</literal> in the debugmsg output
to find out why my keyboard won't detect.
</para>
<para>
Once it works, submit it to the Wine project. If you use CVS,
you will just have to do
</para>
<screen>
2002-04-30 23:16:39 +02:00
cvs -z3 diff -u dlls/x11drv/keyboard.c > layout.diff
2000-08-08 03:24:00 +02:00
</screen>
<para>
from your main Wine directory, then submit
<filename>layout.diff</filename> to
<email>wine-patches@winehq.com</email> along with a brief note
of what it is.
</para>
<para>
If you don't use CVS, you need to do
</para>
<screen>
2002-04-30 23:16:39 +02:00
diff -u the_backup_file_you_made dlls/x11drv/keyboard.c > layout.diff
2000-08-08 03:24:00 +02:00
</screen>
<para>
and submit it as explained above.
</para>
<para>
If you did it right, it will be included in the next Wine
release, and all the troublesome applications (especially
remote-control applications) and games that use scancodes will
be happily using your keyboard layout, and you won't get those
annoying fixme messages either.
</para>
<para>
Good luck.
</para>
</sect1>
2001-04-02 21:14:41 +02:00
2002-10-16 21:00:10 +02:00
<sect1 id="odbc">
<title>Using ODBC</title>
<para>
This section describes how ODBC works within Wine and how to configure
it to do what you want (if it can do what you want).
</para>
<para>
The ODBC system within wine, as with the printing system, is designed
to hook across to the Unix system at a high level. Rather than
ensuring that all the windows code works under wine it uses a suitable
Unix ODBC provider, such as UnixODBC. Thus if you configure Wine to
use the builtin odbc32.dll that wine dll will interface to your
Unix ODBC package and let that do the work, whereas if you configure
Wine to use the native odbc32.dll it will try to use the native
ODBC32 drivers etc.
</para>
<sect2>
<title>Using a Unix ODBC system with Wine</title>
<para>
The first step in using a Unix ODBC system with Wine is, of course,
to get the Unix ODBC system working itself. This may involve
downloading code or rpms etc. There are several Unix ODBC systems
available; the one the author is used to is unixODBC (with the
IBM DB2 driver). Typically such systems will include a tool, such
as isql, which will allow you to access the data from the command
line so that you can check that the system is working.
</para>
<para>
The next step is to hook the Unix ODBC library to the wine builtin
odbc32 dll. The builtin odbc32 (currently) looks to the
environmental variable <emphasis>LIB_ODBC_DRIVER_MANAGER</emphasis>
for the name of the odbc library. For example in the author's
.bashrc file is the line:
</para>
<programlisting>
export LIB_ODBC_DRIVER_MANAGER=/usr/lib/libodbc.so.1.0.0
</programlisting>
<para>
If that environmental variable is not set then it looks for a
library called libodbc.so and so you can add a symbolic link to
equate that to your own library. For example as root you could
run the commands:
</para>
<programlisting>
ln -s libodbc.so.1.0.0 /usr/lib/libodbc.so
/sbin/ldconfig
</programlisting>
<para>
The last step in configuring this is to ensure that Wine is set up
to run the builtin version of odbc32.dll, by modifying the DLL
configuration. This builtin dll merely acts as a stub between the
calling code and the Unix ODBC library.
</para>
<para>
If you have any problems then you can use the debugmsg channel
odbc32 to trace what is happening. One word of warning. Some
programs actually cheat a little and bypass the odbc library. For
example the Crystal Reports engine goes to the registry to check on
the DSN. The fix for this is documented at unixODBC's site where
there is a section on using unixODBC with Wine.
</para>
</sect2>
<sect2>
<title>Using Windows ODBC drivers</title>
<para>
Does anyone actually have any experience of this and anything to
add?
</para>
</sect2>
</sect1>
2000-08-08 03:24:00 +02:00
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
2000-12-13 22:52:37 +01:00
sgml-parent-document:("wine-doc.sgml" "set" "book" "chapter" "")
2000-08-08 03:24:00 +02:00
End:
-->
