Added regedit unit test, a couple minor changes to regedit.
[wine] / documentation / configuring.sgml
1   <chapter id="configuring">
2     <title>Configuring Wine</title>
3     <para>Setting up config files, etc.</para>
4
5     <sect1 id="config">
6       <title>General Configuration</title>
7       <para>
8         Copyright 1999 &name-adam-sacarny; <email>&email-adam-sacarny;</email>
9       </para>
10       <para>
11         (Extracted from <filename>wine/documentation/config</filename>)
12       </para>
13
14       <sect2>
15         <title>The Wine Config File</title>
16         <para>
17           The Wine config file stores various settings for Wine. These include:
18           <itemizedlist>
19             <listitem>
20               <para>
21                 Drives and Information about them
22               </para>
23             </listitem>
24             <listitem>
25               <para>
26                 Directory Settings
27               </para>
28             </listitem>
29             <listitem>
30               <para>
31                 Port Settings
32               </para>
33             </listitem>
34             <listitem>
35               <para>
36                 The Wine look and feel
37               </para>
38             </listitem>
39             <listitem>
40               <para>
41                 Wine's DLL Usage
42               </para>
43             </listitem>
44             <listitem>
45               <para>
46                 Wine's Multimedia drivers and DLL configuration
47               </para>
48             </listitem>
49           </itemizedlist>
50         </para>
51       </sect2>
52
53       <sect2>
54         <title>How Do I Make One?</title>
55         <para>
56           This section will guide you through the process of making a
57           config file. Take a look at the file <filename>&lt;dirs to
58           wine>/documentation/samples/config</filename>. It is organized by section.
59         </para>
60
61         <informaltable frame="all">
62           <tgroup cols="3">
63             <thead>
64               <row>
65                 <entry>Section Name</entry>
66                 <entry>Needed?</entry>
67                 <entry>What it Does</entry>
68               </row>
69             </thead>
70             <tbody>
71               <row>
72                 <entry>[Drive X]</entry>
73                 <entry>yes</entry>
74                 <entry>Sets up drives recognized by wine</entry>
75               </row>
76               <row>
77                 <entry>[wine]</entry>
78                 <entry>yes</entry>
79                 <entry>Settings for wine directories</entry>
80               </row>
81               <row>
82                 <entry>[DllDefaults]</entry>
83                 <entry>recmd</entry>
84                 <entry>Defaults for loading DLL's</entry>
85               </row>
86               <row>
87                 <entry>[DllPairs]</entry>
88                 <entry>recmd</entry>
89                 <entry>Sanity checkers for DLL's</entry>
90               </row>
91               <row>
92                 <entry>[DllOverrides]</entry>
93                 <entry>recmd</entry>
94                 <entry>Overides defaults for DLL loading</entry>
95               </row>
96               <row>
97                 <entry>[x11drv]</entry>
98                 <entry>recmd</entry>
99                 <entry>Graphic driver settings</entry>
100               </row>
101               <row>
102                 <entry>[fonts]</entry>
103                 <entry>yes</entry>
104                 <entry>Font appearance and recognition</entry>
105               </row>
106               <row>
107                 <entry>[serialports]</entry>
108                 <entry>no</entry>
109                 <entry>COM ports seen by wine</entry>
110               </row>
111               <row>
112                 <entry>[parallelports]</entry>
113                 <entry>no</entry>
114                 <entry>LPT ports seen by wine</entry>
115               </row>
116               <row>
117                 <entry>[ppdev]</entry>
118                 <entry>no</entry>
119                 <entry>Parallelport emulation</entry>
120               </row>
121               <row>
122                 <entry>[spooler]</entry>
123                 <entry>no</entry>
124                 <entry>Print spooling</entry>
125               </row>
126               <row>
127                 <entry>[ports]</entry>
128                 <entry>no</entry>
129                 <entry>Direct port access</entry>
130               </row>
131               <row>
132                 <entry>[spy]</entry>
133                 <entry>no</entry>
134                 <entry>What to do with certain debug messages</entry>
135               </row>
136               <row>
137                 <entry>[Registry]</entry>
138                 <entry>no</entry>
139                 <entry>Specifies locations of windows registry files</entry>
140               </row>
141               <row>
142                 <entry>[tweak.layout]</entry>
143                 <entry>recmd</entry>
144                 <entry>Appearance of wine</entry>
145               </row>
146               <row>
147                 <entry>[programs]</entry>
148                 <entry>no</entry>
149                 <entry>Programs to be run automatically</entry>
150               </row>
151               <row>
152                 <entry>[Console]</entry>
153                 <entry>no</entry>
154                 <entry>Console settings</entry>
155               </row>
156               <row>
157                 <entry>[Clipboard]</entry>
158                 <entry>no</entry>
159                 <entry>Interaction for wine and X11 clipboard</entry>
160               </row>
161               <row>
162                 <entry>[afmdirs]</entry>
163                 <entry>no</entry>
164                 <entry>Postscript driver settings</entry>
165               </row>
166               <row>
167                 <entry>[WinMM]</entry>
168                 <entry>yes</entry>
169                 <entry>Multimedia settings</entry>
170               </row>
171               <row>
172                 <entry>[AppDefaults]</entry>
173                 <entry>no</entry>
174                 <entry>Overwrite the settings of previous sections for special programs</entry>
175               </row>
176             </tbody>
177           </tgroup>
178         </informaltable>
179
180         <sect3>
181           <title>The [Drive X] Section</title>
182           <para>
183             These sections are supposed to make certain Unix
184             directory locations accessible to Wine as a DOS/Windows drive
185             (drive 'X:') and thus accessible to Windows programs
186             under the drive name you specified.
187             Every DOS/Windows program sort of expects at least a C: drive (and
188             sometimes also an A: floppy drive), so your config file should
189             at least contain the corresponding sections, [Drive C] and
190             [Drive A].
191             You need to decide on whether you want to use an existing Windows
192             partition as the C drive or whether you want to create your own
193             Wine drive C directory tree somewhere (take care about
194             permissions !).
195             Each drive section may specify up to 6 different settings
196             as explained below.
197           </para>
198           <para>
199             <programlisting>[Drive X]</programlisting>
200             The above line begins the section for a drive whose letter is X
201             (DOS notation: drive 'X:').
202             You could e.g. create an equivalent to a drive 'C:'
203             under DOS/Windows by using a [Drive C] section name.
204           </para>
205           <para>
206             <programlisting>"Path" = "/dir/to/path"</programlisting>
207             This specifies the directory where the drive will begin.
208             When Wine is browsing in drive X, it will be able
209             to see the files that are in the directory
210             <filename>/dir/to/path</filename> and below.
211             (note that symlinks to directories won't get included !
212             see "<link linkend="dirsymlinks">ShowDirSymlinks</link>"
213             config setting)
214             You can also make use of environment variables like $HOME here,
215             an example for using a mywinedrive directory in your home dir
216             would be
217             "Path" = "${HOME}/mywinedrive"
218             Don't forget to leave off the trailing slash!
219           </para>
220           <para>
221             <programlisting>"Type" = "hd|cdrom|network|floppy"</programlisting>
222             Sets up the type of drive Wine will see it as. Type must
223             equal one of the four <literal>floppy</literal>,
224             <literal>hd</literal>, <literal>cdrom</literal>, or
225             <literal>network</literal>. They are self-explanatory.
226             (The |'s mean "Type = '&lt;one of the options&gt;'".)
227             Usually, you choose "hd" for a drive ("hd" is default anyway).
228           </para>
229           <para>
230             <programlisting>"Label" = "blah"</programlisting>
231             Defines the drive label. Generally only needed
232             for programs that look for a special CD-ROM.
233             The label may be up to 11 characters.
234             Note that the preferred way of managing labels and serial numbers
235             of CD-ROMs and floppies is to give Wine raw device access for
236             reading these on a per-CD case (see "Device" below) instead of
237             hardcoding one specific "Label".
238           </para>
239           <para>
240             <programlisting>"Serial" = "deadbeef"</programlisting>
241             Tells Wine the serial number of the drive. A few programs with
242             intense protection for pirating might need this, but otherwise
243             it's not needed. Up to 8 characters and hexadecimal.
244             Using a "Device" entry instead of hardcoding the "Serial" probably
245             is a smarter choice.
246           </para>
247           <para>
248             <programlisting>"Filesystem" = "win95|unix|msdos"</programlisting>
249             Sets up the way Wine looks at files on the drive.
250           </para>
251
252           <variablelist>
253             <varlistentry>
254               <term><literal>win95</literal></term>
255               <listitem>
256                 <para>
257                   Case insensitive. Alike to Windows 9x/NT 4. This is
258                   the long filename filesystem you are probably used
259                   to working with. The filesystem of choice for most
260                   applications to be run under wine.  PROBABLY THE ONE
261                   YOU WANT!
262                 </para>
263               </listitem>
264             </varlistentry>
265             <varlistentry>
266               <term><literal>unix</literal></term>
267               <listitem>
268                 <para>
269                   Case sensitive. This filesystem has almost no use
270                   (Windows apps expect case insensitive filenames).
271                   Try it if you dare, but win95 is a  much better
272                   choice.
273                 </para>
274               </listitem>
275             </varlistentry>
276             <varlistentry>
277               <term><literal>msdos</literal></term>
278               <listitem>
279                 <para>
280                   Case insensitive filesystem. Alike to DOS and
281                   Windows 3.x. <literal>8.3</literal> is the maximum
282                   length of files (eightdot.123) - longer ones will be
283                   truncated. (NOTE: this is a very bad choice if you
284                   plan on running apps that use long filenames. win95
285                   should work fine with apps that were designed to run
286                   under the msdos system. In other words, you might
287                   not want to use this.)
288                 </para>
289               </listitem>
290             </varlistentry>
291           </variablelist>
292
293           <programlisting>"Device" = "/dev/xx"</programlisting>
294           <para>
295             Needed for raw device access and label and serial number reading.
296             Use this ONLY for floppy and cdrom devices. Using it on
297             Extended2 or other Unix file systems can have dire results
298             (when a windows app tries to do a lowlevel write,
299             they do it in a FAT way -- FAT format is completely different from
300             any Unix file system).
301             Also, make sure that you have proper permissions to this device
302             file.
303           </para>
304           <note>
305             <para>
306               This setting is not really important; almost all apps
307               will have no problem if it remains unspecified. For
308               CD-ROMs it's quite useful in order to get automatic label
309               detection, though. If you are unsure about specifying
310               device names, just leave out this setting for your
311               drives.
312             </para>
313           </note>
314           <para>
315             Here are a few sample entries:
316             <programlisting>
317 Here is a setup for Drive C, a generic hard drive:
318 [Drive C]
319 "Path" = "/dosc"
320 "Type" = "hd"
321 "Label" = "Hard Drive"
322 "Filesystem" = "win95"
323 This is a setup for Drive E, a generic CD-ROM drive:
324 [Drive E]
325 "Path" = "/mnt/cdrom"
326 "Type" = "cdrom"
327 "Label" = "Total Annihilation"
328 "Filesystem" = "win95"
329 "Device" = "/dev/cdrom"
330 And here is a setup for Drive A, a generic floppy drive:
331 [Drive A]
332 "Type" = "floppy"
333 "Path" = "/mnt/floppy"
334 "Label" = "Floppy Drive"
335 "Serial" = "87654321"
336 "Filesystem" = "win95"
337 "Device" = "/dev/fd0"
338             </programlisting>
339           </para>
340         </sect3>
341
342         <sect3>
343           <title>The [wine] Section </title>
344           <para>
345             The [wine] section of the configuration file contains all kinds
346             of general settings for Wine.
347           </para>
348           <para>
349             <programlisting>"Windows" = "c:\\windows"</programlisting>
350             This tells Wine and Windows programs where the
351             <filename>Windows</filename> directory is.  It is
352             recommended to have this directory somewhere on your
353             configured <medialabel>C</medialabel> drive, and it's also
354             recommended to just call the directory "windows" (this is
355             the default setup on Windows, and some stupid applications
356             might rely on this).  So in case you chose a "Windows"
357             setting of "c:\\windows" and you chose to set up a drive C
358             e.g. at <filename>/usr/local/wine_c</filename>, the
359             corresponding directory would be
360             <filename>/usr/local/wine_c/windows</filename>.  Make one
361             if you don't already have one. NO TRAILING SLASH (NOT
362             <filename>C:\\windows\</filename>)! Write access strongly
363             recommended!
364           </para>
365           <para>
366             <programlisting>"System" = "c:\\windows\\system"</programlisting>
367             This sets up where the windows system files are. The Windows
368             system directory should reside below the directory used for the
369             <literal>Windows</literal> setting.
370             Thus when using the example above, the system directory would be
371             <filename>/usr/local/wine_c/windows/system</filename>.
372             Again, no trailing slash, and write access!
373           </para>
374           <para>
375             <programlisting>"Temp" = "c:\\temp"</programlisting> This should
376             be the directory you want your temp files stored in,
377             /usr/local/wine_c/temp in our example.
378             Again, no trailing slash, and WRITE ACCESS!!
379           </para>
380           <para>
381             <programlisting>
382 "Path" = "c:\\windows;c:\\windows\\system;c:\\blanco"
383             </programlisting>
384           </para>
385           <para>
386             Behaves like the <envar>PATH</envar> setting on UNIX
387             boxes. When wine is run like <userinput>wine
388               sol.exe</userinput>, if <filename>sol.exe</filename>
389             resides in a directory specified in the
390             <literal>Path</literal> setting, wine will run it (Of
391             course, if <filename>sol.exe</filename> resides in the
392             current directory, wine will run that one). Make sure it
393             always has your <filename>windows</filename> directory and
394             system directory (For this setup, it must have
395             <filename>"c:\\windows;c:\\windows\\system"</filename>).
396           </para>
397           <para>
398             <programlisting>"GraphicsDriver" = "x11drv|ttydrv"</programlisting>
399             Sets the graphics driver to use for Wine output.
400             x11drv is for X11 output, ttydrv is for text console output.
401             WARNING: if you use ttydrv here, then you won't be able to run
402             any Windows GUI programs. Thus this option is mainly interesting
403             for e.g. embedded use of Wine in web server scripts.
404           </para>
405           <para>
406             <programlisting>"Printer" = "off|on"</programlisting> Tells wine
407             whether to allow printing via printer drivers to work.
408             This option isn't needed for our builtin psdrv printer driver
409             at all.
410             Using these things are pretty alpha, so you might want to
411             watch out. Some people might find it useful, however. If
412             you're not planning on working on printing via windows printer
413             drivers, don't even add this to your wine config file
414             (It probably isn't already in it).
415             Check out the [spooler] and [parallelports] sections too.
416           </para>
417           <para>
418             <programlisting>"ShellLinker" = "wineshelllink"</programlisting>
419             This setting specifies the shell linker script to use for setting
420             up Windows icons in e.g. KDE or Gnome that are given by programs
421             making use of appropriate shell32.dll functionality to create
422             icons on the desktop/start menu during installation.
423           </para>
424           <para id="dirsymlinks">
425             <programlisting>"ShowDirSymlinks" = "1"</programlisting>
426             Wine doesn't pass directory symlinks to Windows programs by
427             default, as doing so may crash some programs that do
428             recursive lookups of whole subdirectory trees
429             whenever a directory symlink points back to itself or one of its
430             parent directories.
431             That's why we disallowed the use of directory symlinks
432             and added this setting to reenable ("1") this functionality.
433           </para>
434           <para>
435             <programlisting>"SymbolTableFile" = "wine.sym"</programlisting>
436             Sets up the symbol table file for the wine debugger. You
437             probably don't need to fiddle with this. May be useful if
438             your wine is stripped.
439           </para>
440         </sect3>
441
442         <sect3>
443           <title>Introduction To DLL Sections</title>
444           <para>
445             There are a few things you will need to know before
446             configuring the DLL sections in your wine configuration
447             file.
448           </para>
449           <sect4>
450             <title>Windows DLL Pairs</title>
451             <para>
452               Most windows DLL's have a win16 (Windows 3.x) and win32
453               (Windows 9x/NT) form.  The combination of the win16 and
454               win32 DLL versions are called the "DLL pair". This is a
455               list of the most common pairs:
456             </para>
457
458             <informaltable>
459               <tgroup cols="3">
460                 <thead>
461                   <row>
462                     <entry>Win16</entry>
463                     <entry>Win32</entry>
464                     <entry>
465                       Native
466                       <footnote>
467                         <para>
468                           Is it possible to use native dll with wine?
469                           (See next section)
470                         </para>
471                       </footnote>
472                     </entry>
473                   </row>
474                 </thead>
475                 <tbody>
476                   <row>
477                     <entry>KERNEL</entry>
478                     <entry>KERNEL32</entry>
479                     <entry>No!</entry>
480                   </row>
481                   <row>
482                     <entry>USER</entry>
483                     <entry>USER32</entry>
484                     <entry>No!</entry>
485                   </row>
486                   <row>
487                     <entry>SHELL</entry>
488                     <entry>SHELL32</entry>
489                     <entry>Yes</entry>
490                   </row>
491                   <row>
492                     <entry>GDI</entry>
493                     <entry>GDI32</entry>
494                     <entry>No!</entry>
495                   </row>
496                   <row>
497                     <entry>COMMDLG</entry>
498                     <entry>COMDLG32</entry>
499                     <entry>Yes</entry>
500                   </row>
501                   <row>
502                     <entry>VER</entry>
503                     <entry>VERSION</entry>
504                     <entry>Yes</entry>
505                   </row>
506                 </tbody>
507               </tgroup>
508             </informaltable>
509           </sect4>
510
511           <sect4>
512             <title>Different Forms Of DLL's</title>
513             <para>
514               There are a few different forms of DLL's wine can load:
515               <variablelist>
516                 <varlistentry>
517                   <term>native</term>
518                   <listitem><para>
519                       The DLL's that are included with windows. Many
520                       windows DLL's can be loaded in their native
521                       form. Many times these native versions work
522                       better than their non-Microsoft equivalent --
523                       other times they don't.
524                     </para></listitem>
525                 </varlistentry>
526                 <varlistentry>
527                   <term>elfdll</term>
528                   <listitem><para>
529                       ELF encapsulated windows DLL's. This is currently
530                       experimental (Not working yet).
531                     </para></listitem>
532                 </varlistentry>
533                 <varlistentry>
534                   <term>so</term>
535                   <listitem><para>
536                       Native ELF libraries. Will not work yet.
537                     </para></listitem>
538                 </varlistentry>
539                 <varlistentry>
540                   <term>builtin</term>
541                   <listitem><para>
542                       The most common form of DLL loading. This is
543                       what you will use if the DLL is error-prone in
544                       native form (KERNEL for example), you don't have
545                       the native DLL, or you just want to be
546                       Microsoft-free.
547                     </para></listitem>
548                 </varlistentry>
549               </variablelist>
550             </para>
551           </sect4>
552         </sect3>
553
554         <sect3>
555           <title>The [DllDefaults] Section</title>
556           <para>
557             These settings provide wine's default handling of DLL loading.
558           </para>
559           <para>
560             <programlisting>"DefaultLoadOrder" =" native, so, builtin"</programlisting>
561           </para>
562           <para>
563             This setting is a comma-delimited list of the order in
564             which to attempt loading DLLs. If the first option fails,
565             it will try the second, and so on. The order specified
566             above is probably the best in most conditions.
567           </para>
568         </sect3>
569
570         <sect3>
571           <title>The [DllPairs] Section</title>
572           <para>
573           At one time, there was a section called [DllPairs] in the 
574           default configuration file, but this has been obsoleted
575           because the pairing information has now been embedded into
576           Wine itself. (The purpose of this section was merely to be
577           able to issue warnings if the user attempted to pair
578           codependent 16-bit/32-bit DLLs of different types.) If you
579           still have this in your <filename>wine.conf</filename> or
580           <filename>~/.wine/config</filename>, you may safely delete it.
581           </para>
582         </sect3>
583
584         <sect3>
585           <title>The [DllOverrides] Section</title>
586           <para>
587             The format for this section is the same for each line:
588             <programlisting>
589 &lt;DLL>{,&lt;DLL>,&lt;DLL>...} = &lt;FORM>{,&lt;FORM>,&lt;FORM>...}
590             </programlisting>
591           </para>
592           <para>
593             For example, to load builtin KERNEL pair (case doesn't
594             matter here):
595             <programlisting>
596 "kernel,kernel32" = "builtin"
597             </programlisting>
598           </para>
599           <para>
600             To load the native COMMDLG pair, but if that doesn't work
601             try builtin:
602             <programlisting>
603 "commdlg,comdlg32" = "native,builtin"
604             </programlisting>
605           </para>
606           <para>
607             To load the native COMCTL32:
608             <programlisting>
609 "comctl32" = "native"
610             </programlisting>
611           </para>
612           <para>
613             Here is a good generic setup (As it is defined in config
614             that was included with your wine package):
615             <programlisting>
616 [DllOverrides]
617 "commdlg"      = "builtin, native"
618 "comdlg32"     = "builtin, native"
619 "ver"          = "builtin, native"
620 "version"      = "builtin, native"
621 "shell"        = "builtin, native"
622 "shell32"      = "builtin, native"
623 "lzexpand"     = "builtin, native"
624 "lz32"         = "builtin, native"
625 "comctl32"     = "builtin, native"
626 "commctrl"     = "builtin, native"
627 "wsock32"      = "builtin"
628 "winsock"      = "builtin"
629 "advapi32"     = "builtin, native"
630 "crtdll"       = "builtin, native"
631 "mpr"          = "builtin, native"
632 "winspool.drv" = "builtin, native"
633 "ddraw"        = "builtin, native"
634 "dinput"       = "builtin, native"
635 "dsound"       = "builtin, native"
636 "mmsystem"     = "builtin"
637 "winmm"        = "builtin"
638 "msvcrt"       = "native, builtin"
639 "msvideo"      = "builtin, native"
640 "msvfw32"      = "builtin, native"
641 "mcicda.drv"   = "builtin, native"
642 "mciseq.drv"   = "builtin, native"
643 "mciwave.drv"  = "builtin, native"
644 "mciavi.drv"   = "native, builtin"
645 "mcianim.drv"  = "native, builtin"
646 "msacm.drv"    = "builtin, native"
647 "msacm"        = "builtin, native"
648 "msacm32"      = "builtin, native"
649 "midimap.drv"  = "builtin, native"
650 "wnaspi32"     = "builtin"
651 "icmp"         = "builtin"
652             </programlisting>
653           </para>
654           <note>
655             <para>
656               You see that elfdll or so is the first option for a few
657               of these dll's. This will fail for you, but you won't
658               notice it as wine will just use the second or third
659               option.
660             </para>
661           </note>
662         </sect3>
663
664         <sect3>
665           <title>The [fonts] Section</title>
666           <para>
667             This section sets up wine's font handling.
668           </para>
669           <para>
670             <programlisting>"Resolution" = "96"</programlisting>
671           </para>
672           <para>
673             Since the way X handles fonts is different from the way
674             Windows does, wine uses a special mechanism to deal with
675             them. It must scale them using the number defined in the
676             "Resolution" setting. 60-120 are reasonable values, 96 is
677             a nice in the middle one. If you have the real windows
678             fonts available (<filename>&lt;dirs to
679               wine>/documentation/ttfserver</filename> and
680             <filename>fonts</filename>), this parameter will not be as
681             important. Of course, it's always good to get your X fonts
682             working acceptably in wine.
683           </para>
684           <para>
685             <programlisting>"Default" = "-adobe-times-"</programlisting>
686             The default font wine uses. Fool around with it if you'd like.
687           </para>
688           <para>
689 OPTIONAL: 
690           </para>
691           <para>
692             The <literal>Alias</literal> setting allows you to map an X font to a font
693             used in wine. This is good for apps that need a special font you don't have,
694             but a good replacement exists. The syntax is like so:
695             <programlisting>
696 "AliasX" = "[Fake windows name],[Real X name]"&lt;,optional "masking" section>
697             </programlisting>
698           </para>
699           <para>
700             Pretty straightforward. Replace "AliasX" with "Alias0",
701             then "Alias1" and so on. The fake windows name is the name
702             that the font will be under a windows app in wine. The
703             real X name is the font name as seen by X (Run
704             "xfontsel"). The optional "masking" section allows you to
705             utilize the fake windows name you define. If it is not
706             used, then wine will just try to extract the fake windows
707             name itself and not use the value you enter.
708           </para>
709           <para>
710             Here is an example of an alias without masking. The font will show up in windows
711             apps as "Google". When defining an alias in a config file, forget about my
712             comment text (The "&lt;-- blah" stuff)
713             <programlisting>
714 "Alias0" = "Foo,--google-"      &lt;
715             </programlisting>
716           </para>
717           <para>
718             Here is an example with masking enabled. The font will show up as "Foo" in
719             windows apps.
720             <programlisting>
721 "Alias1" = "Foo,--google-,subst"
722             </programlisting>
723           </para>
724           <para>
725             For more info check out <filename>&lt;dirs to wine>/documentation/fonts</filename>
726           </para>
727         </sect3>
728
729         <sect3>
730           <title>The [serialports], [parallelports], [spooler], and [ports] Sections</title>
731           <para>
732             Even though it sounds like a lot of sections, these are
733             all closely related. They are all for communications and
734             parallel ports. 
735           </para>
736           <para>
737             The [serialports] section tells wine what serial ports it
738             is allowed to use.
739             <programlisting>"ComX" = "/dev/cuaY"</programlisting>
740           </para>
741           <para>
742             Replace <literal>X</literal> with the number of the COM
743             port in Windows (1-8) and <literal>Y</literal> with the
744             number of it in <literal>X</literal> (Usually the number
745             of the port in Windows minus 1). <literal>ComX</literal>
746             can actually equal any device
747             (<medialabel>/dev/modem</medialabel> is acceptable). It is
748             not always necessary to define any COM ports (An optional
749             setting). Here is an example:
750             <programlisting>"Com1" = "/dev/cua0"</programlisting>
751           </para>
752           <para>
753             Use as many of these as you like in the section to define
754             all of the COM ports you need.
755           </para>
756           <para>
757             The [parallelports] section sets up any parallel ports
758             that will be allowed access under wine.
759             <programlisting>"LptX" = "/dev/lpY"</programlisting>
760           </para>
761           <para>
762             Sounds familiar? Syntax is just like the COM port setting.
763             Replace <literal>X</literal> with a value from 1-4 as it
764             is in Windows and <literal>Y</literal> with a value from
765             0-3 (<literal>Y</literal> is usually the value in windows
766             minus 1, just like for COM ports). You don't always need
767             to define a parallel port (AKA, it's optional). As with
768             the other section, LptX can equal  any device (Maybe
769             <medialabel>/dev/printer</medialabel>). Here is an
770             example:  <programlisting>"Lpt1" = "/dev/lp0"</programlisting>
771           </para>
772           <para>
773             The [spooler] section will inform wine where to spool
774             print jobs. Use this if you want to try printing. Wine
775             docs claim that spooling is "rather primitive" at this
776             time, so it won't work perfectly. IT IS OPTIONAL. The only
777             setting you use in this section works to map a port (LPT1,
778             for example) to a file or a command. Here is an example,
779             mapping LPT1 to the file <filename>out.ps</filename>: 
780             <programlisting>"LPT1:" = "out.ps"</programlisting>
781           </para>
782           <para>
783             The following command maps printing jobs to LPT1 to the
784             command <command>lpr</command>. Notice  the |: 
785             <programlisting>"LPT1:" = "|lpr"</programlisting>
786           </para>
787           <para>
788             The [ports] section is usually useful only for people who
789             need direct port access for programs requiring dongles or
790             scanners. IF YOU DON'T NEED IT, DON'T USE IT! 
791           </para>
792           <para>
793             <programlisting>"read" = "0x779,0x379,0x280-0x2a0"</programlisting>
794             Gives direct read access to those IO's.
795           </para>
796           <para>
797             <programlisting>"write" = "0x779,0x379,0x280-0x2a0"</programlisting>
798             Gives direct write access to those IO's. It's probably a
799             good idea to keep the values of the
800             <literal>read</literal> and <literal>write</literal>
801             settings the same. This stuff will only work when you're
802             root.
803           </para>
804         </sect3>
805
806         <sect3>
807           <title>The [spy], [Registry], [tweak.layout], and [programs] Sections</title>
808           <para>
809             [spy] is used to include or exclude debug messages, and to
810             output them to a file. The latter is rarely used. THESE
811             ARE ALL OPTIONAL AND YOU PROBABLY DON'T NEED TO ADD OR
812             REMOVE ANYTHING IN THIS SECTION TO YOUR CONFIG.
813           </para>
814           <para>
815             <programlisting>"File" = "/blanco"</programlisting>
816             Sets the logfile for wine. Set to CON to log to standard out.
817             THIS IS RARELY USED.
818           </para>
819           <para>
820             <programlisting>"Exclude" = "WM_SIZE;WM_TIMER;"</programlisting>
821             Excludes debug messages about <constant>WM_SIZE</constant>
822             and <constant>WM_TIMER</constant> in the logfile.
823           </para>
824           <para>
825             <programlisting>"Include" = "WM_SIZE;WM_TIMER;"</programlisting>
826             Includes debug messages about <constant>WM_SIZE</constant>
827             and <constant>WM_TIMER</constant> in the logfile.
828           </para>
829           <para>
830             [Registry] can be used to tell wine where your old windows
831             registry files exist. This section is completely optional
832             and useless to people using wine without an existing
833             windows installation.
834           </para>
835           <para>
836             <programlisting>"UserFileName" = "/dirs/to/user.reg"</programlisting>
837             The location of your old <filename>user.reg</filename> file.
838           </para>
839           <para>
840             [tweak.layout] is devoted to wine's look. There is only
841             one setting for it.
842           </para>
843           <para>
844             <programlisting>"WineLook" = "win31|win95|win98"</programlisting>
845             Will change the look of wine from Windows 3.1 to Windows 95.
846             The <literal>win98</literal> setting behaves
847             just like <literal>win95</literal> most of the time.
848           </para>
849           <para>
850             [programs] can be used to say what programs run under
851             special conditions.
852           </para>
853           <para>
854             <programlisting>"Default" = "/program/to/execute.exe"</programlisting>
855             Sets the program to be run if wine is started without specifying a program.
856           </para>
857           <para>
858             <programlisting>"Startup" = "/program/to/execute.exe"</programlisting>
859             Sets the program to automatically be run at startup every time.
860           </para>
861         </sect3>
862
863         <sect3>
864           <title>The [WinMM] Section</title>
865           <para>
866             [WinMM] is used to define which multimedia drivers have to be loaded. Since
867             those drivers may depend on the multimedia interfaces available on your sustem
868             (OSS, Alsa... to name a few), it's needed to be able to configure which driver
869             has to be loaded.
870           </para>
871
872           <para>
873             The content of the section looks like:
874             <programlisting> 
875 [WinMM]
876 "Drivers" = "wineoss.drv"
877 "WaveMapper" = "msacm.drv"
878 "MidiMapper" = "midimap.drv"
879             </programlisting> 
880             All the keys must be defined:
881             <itemizedlist>
882               <listitem>
883                 <para>
884                   The "Drivers" key is a ';' separated list of modules name, each of 
885                   them containing a low level driver. All those drivers will be loaded 
886                   when MMSYSTEM/WINMM is started and will provide their inner features.
887                 </para>
888               </listitem>
889               <listitem>
890                 <para>
891                   The "WaveMapper" represents the name of the module containing the Wave
892                   Mapper driver. Only one wave mapper can be defined in the system.
893                 </para>
894               </listitem>
895               <listitem>
896                 <para>
897                   The "MidiMapper" represents the name of the module containing the Midi 
898                   Mapper driver. Only one Midi mapper can be defined in the system.
899                 </para>
900               </listitem>
901             </itemizedlist>
902           </para>
903         </sect3>
904
905         <sect3>
906           <title>The [AppDefaults] Section</title>
907           <para>
908             The section is used to overwrite the setting of this file for a
909             special program with different settings.
910             [AppDefaults] is not the real name of the section. The real name
911             consists of the leading word AppDefaults followed by the name 
912             of the executable the section is valid for. The end of the section
913             name is the name of the section of the configuration file its 
914             values should be overwritten with different settings. The three 
915             parts of the section name are separated by two backslashes.
916           </para>
917           <para>
918             Currently wine supports only overwriting the sections 
919             [DllOverrides] and [x11drv].
920           </para>
921           <para>
922             Here is an example that overwrites the normal settings for a
923             program:
924             <programlisting> 
925 ;; default settings
926 [x11drv]
927 "Managed" = "Y"
928 "Desktop" = "N"
929
930 ;; run install in desktop mode
931 [AppDefaults\\install.exe\\x11drv]
932 "Managed" = "N"
933 "Desktop" = "800x600"
934             </programlisting> 
935           </para>
936         </sect3>
937       </sect2>
938
939       <sect2>
940         <title>Where Do I Put It?</title>
941         <para>
942           The wine config file can go in two places.
943         </para>
944         <variablelist>
945           <varlistentry>
946             <term><filename>/usr/local/etc/wine.conf</filename></term>
947             <listitem><para>
948                 A systemwide config file, used for anyone who doesn't
949                 have their own. NOTE: this file is currently unused as a
950                 new global configuration mechanism is not in place at this
951                 time
952             </para></listitem>
953           </varlistentry>
954           <varlistentry>
955             <term><filename>$HOME/.wine/config</filename></term>
956             <listitem><para>
957                 Your own config file, that only is used for your user. 
958             </para></listitem>
959           </varlistentry>
960         </variablelist>
961         <para>
962           So copy your version of the <filename>wine.conf</filename> file to
963           <filename>/usr/local/etc/wine.conf</filename> or
964           <filename>$HOME/.wine/config</filename> for wine to recognize
965           it. 
966         </para>
967       </sect2>
968
969       <sect2>
970         <title>What If It Doesn't Work?</title>
971         <para>
972           There is always a chance that things will go wrong. If the
973           unthinkable happens report the problem to
974           <ulink url="http://bugs.winehq.com/">Wine Bugzilla</ulink>,
975           try the newsgroup
976           <systemitem>comp.emulators.ms-windows.wine</systemitem>,
977           or the IRCnet channel <systemitem>#WineHQ</systemitem> found on
978           irc.stealth.net:6668,  or connected servers.
979           Make sure that you have looked over this document thoroughly,
980           and have also read:
981         </para>
982         <itemizedlist>
983           <listitem>
984             <para><filename>README</filename></para>
985           </listitem>
986           <listitem>
987             <para>
988               <filename>http://www.la-sorciere.de/wine/index.html</filename>
989               (optional but recommended)
990             </para>
991           </listitem>
992         </itemizedlist>
993         <para>
994           If indeed it looks like you've done your research, be
995           prepared for helpful suggestions. If you haven't, brace
996           yourself for heaving flaming.
997         </para>
998       </sect2>
999     </sect1>
1000
1001     <sect1 id="x11drv">
1002       <title>Configuring the x11drv Driver</title>
1003
1004       <para>
1005         Written by &name-ove-kaaven; <email>&email-ove-kaaven;</email>
1006       </para>
1007       <para>
1008         (Extracted from <filename>wine/documentation/x11drv</filename>)
1009       </para>
1010
1011       <para>
1012         Most Wine users run Wine under the windowing system known as
1013         X11. During most of Wine's history, this was the only display
1014         driver available, but in recent years, parts of Wine has been
1015         reorganized to allow for other display drivers (although the
1016         only alternative currently available is Patrik Stridvall's
1017         ncurses-based ttydrv, which he claims works for displaying
1018         calc.exe). The display driver is chosen with the
1019         <literal>GraphicsDriver</literal> option in the [wine] section
1020         of <filename>~/.wine/config</filename>, but I will only cover the
1021         x11drv driver in this article.
1022       </para>
1023
1024       <sect2>
1025         <title>x11drv modes of operation</title>
1026
1027         <para>
1028           <!-- FIXME: This is outdated -->
1029           Note: This is now all done in the config file. Needs an update...
1030         </para>
1031
1032         <para>
1033           The x11drv driver consists of two conceptually distinct
1034           pieces, the graphics driver (GDI part), and the windowing
1035           driver (USER part). Both of these are linked into the
1036           <filename>libx11drv.so</filename> module, though (which you
1037           load with the <literal>GraphicsDriver</literal> option). In
1038           Wine, running on X11, the graphics driver must draw on
1039           drawables (window interiors) provided by the windowing
1040           driver. This differs a bit from the Windows model, where the
1041           windowing system creates and configures device contexts
1042           controlled by the graphics driver, and applications are
1043           allowed to hook into this relationship anywhere they like.
1044           Thus, to provide any reasonable tradeoff between
1045           compatibility and usability, the x11drv has three different
1046           modes of operation.
1047         </para>
1048
1049         <variablelist>
1050           <varlistentry>
1051             <term>Unmanaged/Normal</term>
1052             <listitem>
1053               <para>
1054                 The default. Window-manager-independent (any running
1055                 window manager is ignored completely). Window
1056                 decorations (title bars, borders, etc) are drawn by
1057                 Wine to look and feel like the real Windows. This is
1058                 compatible with applications that depend on being able
1059                 to compute the exact sizes of any such decorations, or
1060                 that want to draw their own.
1061               </para>
1062             </listitem>
1063           </varlistentry>          
1064           <varlistentry>
1065             <term>Managed</term>
1066             <listitem>
1067               <para>
1068                 Specified by using the
1069                 <parameter>--managed</parameter> command-line option
1070                 or the <literal>Managed</literal>
1071                 <filename>wine.conf</filename> option (see below).
1072                 Ordinary top-level frame windows with thick borders,
1073                 title bars, and system menus will be managed by your
1074                 window manager. This lets these applications integrate
1075                 better with the rest of your desktop, but may not
1076                 always work perfectly. (A rewrite of this mode of
1077                 operation, to make it more robust and less patchy, is
1078                 highly desirable, though, and is planned to be done
1079                 before the Wine 1.0 release.)
1080               </para>
1081             </listitem>
1082           </varlistentry>
1083           <varlistentry>
1084             <term>Desktop-in-a-Box</term>
1085             <listitem>
1086               <para>
1087                 Specified by using the
1088                 <parameter>--desktop</parameter> command-line option
1089                 (with a geometry, e.g. <parameter>--desktop
1090                   800x600</parameter> for a such-sized desktop, or
1091                 even <parameter>--desktop 800x600+0+0</parameter> to
1092                 automatically position the desktop at the upper-left
1093                 corner of the display). This is the mode most
1094                 compatible with the Windows model. All application
1095                 windows will just be Wine-drawn windows inside the
1096                 Wine-provided desktop window (which will itself be
1097                 managed by your window manager), and Windows
1098                 applications can roam freely within this virtual
1099                 workspace and think they own it all, without
1100                 disturbing your other X apps.
1101               </para>
1102             </listitem>
1103           </varlistentry>
1104         </variablelist>
1105       </sect2>
1106
1107       <sect2>
1108         <title>The [x11drv] section</title>
1109
1110         <variablelist>
1111           <varlistentry>
1112             <term>AllocSystemColors</term>
1113             <listitem>
1114               <para>
1115                 Applies only if you have a palette-based display, i.e.
1116                 if your X server is set to a depth of 8bpp, and if you
1117                 haven't requested a private color map. It specifies
1118                 the maximum number of shared colormap cells (palette
1119                 entries) Wine should occupy. The higher this value,
1120                 the less colors will be available to other
1121                 applications.
1122               </para>
1123             </listitem>
1124           </varlistentry>          
1125           <varlistentry>
1126             <term>PrivateColorMap</term>
1127             <listitem>
1128               <para>
1129                 Applies only if you have a palette-based display, i.e.
1130                 if your X server is set to a depth of 8bpp. It
1131                 specifies that you don't want to use the shared color
1132                 map, but a private color map, where all 256 colors are
1133                 available. The disadvantage is that Wine's private
1134                 color map is only seen while the mouse pointer is
1135                 inside a Wine window, so psychedelic flashing and
1136                 funky colors will become routine if you use the mouse
1137                 a lot.
1138               </para>
1139             </listitem>
1140           </varlistentry>          
1141           <varlistentry>
1142             <term>PerfectGraphics</term>
1143             <listitem>
1144               <para>
1145                 This option only determines whether fast X11 routines
1146                 or exact Wine routines will be used for certain ROP
1147                 codes in blit operations. Most users won't notice any
1148                 difference.
1149               </para>
1150             </listitem>
1151           </varlistentry>          
1152           <varlistentry>
1153             <term>ScreenDepth</term>
1154             <listitem>
1155               <para>
1156                 Applies only to multi-depth displays. It specifies
1157                 which of the available depths Wine should use (and
1158                 tell Windows apps about).
1159               </para>
1160             </listitem>
1161           </varlistentry>          
1162           <varlistentry>
1163             <term>Display</term>
1164             <listitem>
1165               <para>
1166                 This specifies which X11 display to use, and if
1167                 specified, will override both the
1168                 <envar>DISPLAY</envar> environment variable and the
1169                 <parameter>--display</parameter> command-line option.
1170               </para>
1171             </listitem>
1172           </varlistentry>          
1173           <varlistentry>
1174             <term>Managed</term>
1175             <listitem>
1176               <para>
1177                 Wine can let frame windows be managed by your window
1178                 manager. This option specifies whether you want that
1179                 by default.
1180               </para>
1181             </listitem>
1182           </varlistentry>          
1183           <varlistentry>
1184             <term>UseDGA</term>
1185             <listitem>
1186               <para>
1187                 This specifies whether you want DirectDraw to use
1188                 XFree86's <firstterm>Direct Graphics
1189                   Architecture</firstterm> (DGA), which is able to
1190                 take over the entire display and run the game
1191                 full-screen at maximum speed. (With DGA1 (XFree86
1192                 3.x), you still have to configure the X server to the
1193                 game's requested bpp first, but with DGA2 (XFree86
1194                 4.x), runtime depth-switching may be possible,
1195                 depending on your driver's capabilities.) But be aware
1196                 that if Wine crashes while in DGA mode, it may not be
1197                 possible to regain control over your computer without
1198                 rebooting. DGA normally requires either root
1199                 privileges or read/write access to
1200                 <filename>/dev/mem</filename>.
1201               </para>
1202             </listitem>
1203           </varlistentry>          
1204           <varlistentry>
1205             <term>UseXShm</term>
1206             <listitem>
1207               <para>
1208                 If you don't want DirectX to use DGA, you can at least
1209                 use X Shared Memory extensions (XShm). It is much
1210                 slower than DGA, since the app doesn't have direct
1211                 access to the physical frame buffer, but using shared
1212                 memory to draw the frame is at least faster than
1213                 sending the data through the standard X11 socket, even
1214                 though Wine's XShm support is still known to crash
1215                 sometimes.
1216               </para>
1217             </listitem>
1218           </varlistentry>          
1219           <varlistentry>
1220             <term>DXGrab</term>
1221             <listitem>
1222               <para>
1223                 If you don't use DGA, you may want an alternative
1224                 means to convince the mouse cursor to stay within the
1225                 game window. This option does that. Of course, as with
1226                 DGA, if Wine crashes, you're in trouble (although not
1227                 as badly as in the DGA case, since you can still use
1228                 the keyboard to get out of X).
1229               </para>
1230             </listitem>
1231           </varlistentry>          
1232           <varlistentry>
1233             <term>DesktopDoubleBuffered</term>
1234             <listitem>
1235               <para>
1236                 Applies only if you use the
1237                 <parameter>--desktop</parameter> command-line option
1238                 to run in a desktop window. Specifies whether to
1239                 create the desktop window with a double-buffered
1240                 visual, something most OpenGL games need to run
1241                 correctly.
1242               </para>
1243             </listitem>
1244           </varlistentry>
1245           <varlistentry>
1246             <term>TextCP</term>
1247             <listitem>
1248               <para>
1249                 <!-- FIXME: To be documented -->
1250                 To be documented...
1251               </para>
1252             </listitem>
1253           </varlistentry>
1254           <varlistentry>
1255             <term>XVideoPort</term>
1256             <listitem>
1257               <para>
1258                 <!-- FIXME: To be documented -->
1259                 To be documented...
1260               </para>
1261             </listitem>
1262           </varlistentry>
1263           <varlistentry>
1264             <term>Synchronous</term>
1265             <listitem>
1266               <para>
1267                 <!-- FIXME: To be documented -->
1268                 To be documented...
1269               </para>
1270             </listitem>
1271           </varlistentry>
1272         </variablelist>
1273       </sect2>          
1274     </sect1>
1275
1276     &registry;
1277
1278     <sect1 id="cdrom-labels">
1279       <sect1info>
1280         <authorgroup>
1281           <author>
1282             <firstname>Petr</firstname>
1283             <surname>Tomasek</surname>
1284             <affiliation>
1285               <address><email>&email-petr-tomasek;</email></address>
1286             </affiliation>
1287             <contrib>Nov 14 1999</contrib>
1288           </author>
1289           <author>
1290             <firstname>Andreas</firstname>
1291             <surname>Mohr</surname>
1292             <affiliation>
1293               <address><email>&email-andreas-mohr;</email></address>
1294             </affiliation>
1295             <contrib>Jan 25 2000</contrib>
1296           </author>
1297         </authorgroup>
1298       </sect1info>
1299
1300       <title>Drive labels and serial numbers with wine</title>
1301       <para>
1302         Written by &name-petr-tomasek; <email>&email-petr-tomasek;</email>
1303         Nov 14 1999
1304       </para>
1305       <para>
1306         Changes by &name-andreas-mohr; <email>&email-andreas-mohr;</email>
1307         Jan 25 2000
1308       </para>
1309       <para>
1310         (Extracted from <filename>wine/documentation/cdrom-labels</filename>)
1311       </para>
1312       <para>
1313         Until now, your only possibility of specifying drive volume
1314         labels and serial numbers was to set them manually in the wine
1315         config file. By now, wine can read them directly from the
1316         device as well. This may be useful for many Win 9x games or
1317         for setup programs distributed on CD-ROMs that check for
1318         volume label.
1319       </para>
1320
1321       <sect2>
1322         <title>What's Supported?</title>
1323
1324         <informaltable frame="all">
1325           <tgroup cols="3">
1326             <thead>
1327               <row>
1328                 <entry>File System</entry>
1329                 <entry>Types</entry>
1330                 <entry>Comment</entry>
1331               </row>
1332             </thead>
1333             <tbody>
1334               <row>
1335                 <entry>FAT systems</entry>
1336                 <entry>hd, floppy</entry>
1337                 <entry>reads labels and serial numbers</entry>
1338               </row>
1339               <row>
1340                 <entry>ISO9660</entry>
1341                 <entry>cdrom</entry>
1342                 <entry>reads labels and serial numbers (not mixed-mode CDs yet !)</entry>
1343               </row>
1344             </tbody>
1345           </tgroup>
1346         </informaltable>
1347
1348       </sect2>
1349
1350       <sect2>
1351         <title>How To Set Up?</title>
1352         <para>
1353           Reading labels and serial numbers just works automagically
1354           if you specify a <literal>Device=</literal> line in the
1355           [Drive X] section in your <filename>~/.wine/config</filename>.
1356           Note that the device has to exist and must be accessible if
1357           you do this, though.
1358         </para>
1359         <para>
1360           If you don't do that, then you should give fixed
1361           <literal>"Label" =</literal> or <literal>"Serial" =</literal>
1362           entries in <filename>~./wine/config</filename>, as Wine returns
1363           these entries instead if no device is given. If they don't
1364           exist, then Wine will return default values (label
1365           <literal>Drive X</literal> and serial
1366           <literal>12345678</literal>).
1367         </para>
1368         <para>
1369           If you want to give a <literal>"Device" =</literal> entry
1370           <emphasis>only</emphasis> for drive raw sector accesses,
1371           but not for reading the volume info from the device (i.e. you want
1372           a <emphasis>fixed</emphasis>, preconfigured label), you need
1373           to specify <literal>"ReadVolInfo" = "0"</literal> to tell Wine
1374           to skip the volume reading.
1375         </para>
1376       </sect2>
1377
1378       <sect2>
1379         <title>EXAMPLES</title>
1380         <para>
1381           Here's a simple example of cdrom and floppy; labels will be
1382           read from the device on both cdrom and floppy; serial
1383           numbers on floppy only:
1384         </para>
1385         <screen>
1386 [Drive A]
1387 "Path" = "/mnt/floppy"
1388 "Type" = "floppy"
1389 "Device" = "/dev/fd0"
1390 "Filesystem" = "msdos"
1391
1392 [Drive R]
1393 "Path" = "/mnt/cdrom"
1394 "Type" = "cdrom"
1395 "Device" = "/dev/hda1"
1396 "Filesystem" = "win95"
1397         </screen>
1398         <para>
1399           Here's an example of overriding the CD-ROM label:
1400         </para>
1401         <screen>
1402 [Drive J]
1403 "Path" = "/mnt/cdrom"
1404 "Type" = "cdrom"
1405 "Label" = "X234GCDSE"
1406 ; note that the device isn't really needed here as we have a fixed label
1407 "Device" = "/dev/cdrom"
1408 "Filesystem" = "msdos"
1409         </screen>
1410       </sect2>
1411
1412       <sect2>
1413         <title>Todo / Open Issues</title>
1414         <itemizedlist>
1415           <listitem> <para>
1416               The cdrom label can be read only if the data track of
1417               the disk resides in the first track and the cdrom is
1418               iso9660.
1419             </para> </listitem>
1420           <listitem> <para>
1421               Better checking for FAT superblock (it now checks only
1422               one byte). </para>
1423           </listitem>
1424           <listitem> <para>
1425               Support for labels/serial nums WRITING.
1426             </para> </listitem>
1427           <listitem> <para>
1428               Can the label be longer than 11 chars? (iso9660 has 32
1429               chars).
1430             </para> </listitem>
1431           <listitem> <para>
1432               What about reading ext2 volume label? ....
1433             </para> </listitem>
1434         </itemizedlist>
1435       </sect2>
1436     </sect1>
1437
1438     <sect1 id="dll-config">
1439       <title>DLL configuration</title>
1440       <sect2 id="dll-overrides">
1441         <title>DLL Overrides</title>
1442   
1443         <para>
1444           Written by &name-ove-kaaven; <email>&email-ove-kaaven;</email>
1445         </para>
1446         <para>
1447           (Extracted from <filename>wine/documentation/dll-overrides</filename>)
1448         </para>
1449   
1450         <para>
1451           The <filename>wine.conf</filename> directives [DllDefaults]
1452           and [DllOverrides] are the subject of some confusion. The
1453           overall purpose of most of these directives are clear enough,
1454           though - given a choice, should Wine use its own built-in
1455           DLLs, or should it use <filename>.DLL</filename> files found
1456           in an existing Windows installation? This document explains
1457           how this feature works.
1458         </para>
1459   
1460         <sect3>
1461           <title>DLL types</title>
1462           <variablelist>
1463             <varlistentry>
1464               <term>native</term>
1465               <listitem> <para>
1466                   A "native" DLL is a <filename>.DLL</filename> file
1467                   written for the real Microsoft Windows.
1468                 </para> </listitem>
1469             </varlistentry>
1470             <varlistentry>
1471               <term>builtin</term>
1472               <listitem> <para>
1473                   A "builtin" DLL is a Wine DLL. These can either be a
1474                   part of <filename>libwine.so</filename>, or more
1475                   recently, in a special <filename>.so</filename> file
1476                   that Wine is able to load on demand.
1477                 </para> </listitem>
1478             </varlistentry>
1479             <varlistentry>
1480               <term>elfdll</term>
1481               <listitem> <para>
1482                   An "elfdll" is a Wine <filename>.so</filename> file
1483                   with a special Windows-like file structure that is as
1484                   close to Windows as possible, and that can also
1485                   seamlessly link dynamically with "native" DLLs, by
1486                   using special ELF loader and linker tricks. Bertho
1487                   Stultiens did some work on this, but this feature has
1488                   not yet been merged back into Wine (because of
1489                   political reasons and lack of time), so this DLL type
1490                   does not exist in the official Wine at this time. In
1491                   the meantime, the "builtin" DLL type gained some of
1492                   the features of elfdlls (such as dynamic loading), so
1493                   it's possible that "elfdll" functionality will be
1494                   folded into "builtin" at some point.
1495                 </para> </listitem>
1496             </varlistentry>
1497             <varlistentry>
1498               <term>so</term>
1499               <listitem> <para>
1500                   A native Unix <filename>.so</filename> file, with
1501                   calling convention conversion thunks generated on the
1502                   fly as the library is loaded. This is mostly useful
1503                   for libraries such as "glide" that have exactly the
1504                   same API on both Windows and Unix.
1505                 </para> </listitem>
1506             </varlistentry>
1507           </variablelist>          
1508         </sect3>
1509   
1510         <sect3>
1511           <title>The [DllDefaults] section</title>
1512           <variablelist>
1513             <varlistentry>
1514               <term>DefaultLoadOrder</term>
1515               <listitem> <para>
1516                   This specifies in what order Wine should search for
1517                   available DLL types, if the DLL in question was not
1518                   found in the [DllOverrides] section.
1519                 </para> </listitem>
1520             </varlistentry>
1521           </variablelist>
1522         </sect3>
1523   
1524         <sect3>
1525           <title>The [DllPairs] section</title>
1526           <para>
1527             At one time, there was a section called [DllPairs] in the
1528             default configuration file, but this has been obsoleted
1529             because the pairing information has now been embedded into
1530             Wine itself. (The purpose of this section was merely to be
1531             able to issue warnings if the user attempted to pair
1532             codependent 16-bit/32-bit DLLs of different types.) If you
1533             still have this in your <filename>wine.conf</filename> or
1534             <filename>~/.wine/config</filename>, you may safely delete it.
1535           </para>
1536         </sect3>
1537   
1538         <sect3>
1539           <title>The [DllOverrides] section</title>
1540           <para>
1541             This section specifies how you want specific DLLs to be
1542             handled, in particular whether you want to use "native" DLLs
1543             or not, if you have some from a real Windows configuration.
1544             Because builtins do not mix seamlessly with native DLLs yet,
1545             certain DLL dependencies may be problematic, but workarounds
1546             exist in Wine for many popular DLL configurations. Also see
1547             WWN's [16]Status Page to figure out how well your favorite
1548             DLL is implemented in Wine.
1549           </para>
1550           <para>
1551             It is of course also possible to override these settings by
1552             explictly using Wine's <parameter>--dll</parameter>
1553             command-line option (see the man page for details).  Some
1554             hints for choosing your optimal configuration (listed by
1555             16/32-bit DLL pair):
1556           </para>
1557           <variablelist>
1558             <varlistentry>
1559               <term>krnl386, kernel32</term>
1560               <listitem> <para>
1561                   Native versions of these will never work, so don't try. Leave
1562                   at <literal>builtin</literal>.
1563                 </para> </listitem>
1564             </varlistentry>
1565             <varlistentry>
1566               <term>gdi, gdi32</term>
1567               <listitem> <para>
1568                   Graphics Device Interface. No effort has been made at trying to
1569                   run native GDI. Leave at <literal>builtin</literal>.
1570                 </para> </listitem>
1571             </varlistentry>          
1572             <varlistentry>
1573               <term>user, user32</term>
1574               <listitem> <para>
1575                   Window management and standard controls. It was
1576                   possible to use Win95's <literal>native</literal>
1577                   versions at some point (if all other DLLs that depend
1578                   on it, such as comctl32 and comdlg32, were also run
1579                   <literal>native</literal>). However, this is no longer
1580                   possible after the Address Space Separation, so leave
1581                   at <literal>builtin</literal>.
1582                 </para> </listitem>
1583             </varlistentry>
1584             <varlistentry>
1585               <term>ntdll</term>
1586               <listitem> <para>
1587                   NT kernel API. Although badly documented, the
1588                   <literal>native</literal> version of this will never
1589                   work. Leave at <literal>builtin</literal>.
1590                 </para> </listitem>
1591             </varlistentry>
1592             <varlistentry>
1593               <term>w32skrnl</term>
1594               <listitem> <para>
1595                   Win32s (for Win3.x). The <literal>native</literal>
1596                   version will probably never work. Leave at
1597                   <literal>builtin</literal>.
1598                 </para> </listitem>
1599             </varlistentry>
1600             <varlistentry>
1601               <term>wow32</term>
1602               <listitem> <para>
1603                   Win16 support library for NT. The
1604                   <literal>native</literal> version will probably never
1605                   work. Leave at <literal>builtin</literal>.
1606                 </para> </listitem>
1607             </varlistentry>
1608             <varlistentry>
1609               <term>system</term>
1610               <listitem> <para>
1611                   Win16 kernel stuff. Will never work
1612                   <literal>native</literal>. Leave at
1613                   <literal>builtin</literal>.
1614                 </para> </listitem>
1615             </varlistentry>          
1616             <varlistentry>
1617               <term>display</term>
1618               <listitem> <para>
1619                   Display driver. Definitely leave at <literal>builtin</literal>.
1620                 </para> </listitem>
1621             </varlistentry>
1622             <varlistentry>
1623               <term>toolhelp</term>
1624               <listitem> <para>
1625                   Tool helper routines. This is rarely a source of problems.
1626                   Leave at <literal>builtin</literal>.
1627                 </para> </listitem>
1628             </varlistentry>
1629             <varlistentry>
1630               <term>ver, version</term>
1631               <listitem> <para>
1632                   Versioning. Seldom useful to mess with.
1633                 </para> </listitem>
1634             </varlistentry>
1635             <varlistentry>
1636               <term>advapi32</term>
1637               <listitem> <para>
1638                   Registry and security features. Trying the
1639                   <literal>native</literal> version of this may or may
1640                   not work.
1641                 </para> </listitem>
1642             </varlistentry>
1643             <varlistentry>
1644               <term>commdlg, comdlg32</term>
1645               <listitem> <para>
1646                   Common Dialogs, such as color picker, font dialog,
1647                   print dialog, open/save dialog, etc. It is safe to try
1648                   <literal>native</literal>.
1649                 </para> </listitem>
1650             </varlistentry>
1651             <varlistentry>
1652               <term>commctrl, comctl32</term>
1653               <listitem> <para>
1654                   Common Controls. This is toolbars, status bars, list controls,
1655                   the works. It is safe to try <literal>native</literal>.
1656                 </para> </listitem>
1657             </varlistentry>
1658             <varlistentry>
1659               <term>shell, shell32</term>
1660               <listitem> <para>
1661                   Shell interface (desktop, filesystem, etc). Being one of the
1662                   most undocumented pieces of Windows, you may have luck with the
1663                   <literal>native</literal> version, should you need it.
1664                 </para> </listitem>
1665             </varlistentry>          
1666             <varlistentry>
1667               <term>winsock, wsock32</term>
1668               <listitem> <para>
1669                   Windows Sockets. The <literal>native</literal> version
1670                   will not work under Wine, so leave at
1671                   <literal>builtin</literal>.
1672                 </para> </listitem>
1673             </varlistentry>
1674             <varlistentry>
1675               <term>icmp</term>
1676               <listitem> <para>
1677                   ICMP routines for wsock32. As with wsock32, leave at
1678                   <literal>builtin</literal>.
1679                 </para> </listitem>
1680             </varlistentry>
1681             <varlistentry>
1682               <term>mpr</term>
1683               <listitem> <para>
1684                   The <literal>native</literal> version may not work due
1685                   to thunking issues. Leave at
1686                   <literal>builtin</literal>.
1687                 </para> </listitem>
1688             </varlistentry>
1689             <varlistentry>
1690               <term>lzexpand, lz32</term>
1691               <listitem> <para>
1692                   Lempel-Ziv decompression. Wine's
1693                   <literal>builtin</literal> version ought to work fine.
1694                 </para> </listitem>
1695             </varlistentry>
1696             <varlistentry>
1697               <term>winaspi, wnaspi32</term>
1698               <listitem> <para>
1699                   Advanced SCSI Peripheral Interface. The
1700                   <literal>native</literal> version will probably never
1701                   work. Leave at <literal>builtin</literal>.
1702                 </para> </listitem>
1703             </varlistentry>
1704             <varlistentry>
1705               <term>crtdll</term>
1706               <listitem> <para>
1707                   C Runtime library. The <literal>native</literal>
1708                   version will easily work better than Wine's on this
1709                   one.
1710                 </para> </listitem>
1711             </varlistentry>
1712             <varlistentry>
1713               <term>winspool.drv</term>
1714               <listitem> <para>
1715                   Printer spooler. You are not likely to have more luck
1716                   with the <literal>native</literal> version.
1717                 </para> </listitem>
1718             </varlistentry>
1719             <varlistentry>
1720               <term>ddraw</term>
1721               <listitem> <para>
1722                   DirectDraw/Direct3D. Since Wine does not implement the
1723                   DirectX HAL, the <literal>native</literal> version
1724                   will not work at this time.
1725                 </para> </listitem>
1726             </varlistentry>
1727             <varlistentry>
1728               <term>dinput</term>
1729               <listitem> <para>
1730                   DirectInput. Running this <literal>native</literal>
1731                   may or may not work.
1732                 </para> </listitem>
1733             </varlistentry>          
1734             <varlistentry>
1735               <term>dsound</term>
1736               <listitem> <para>
1737                   DirectSound. It may be possible to run this
1738                   <literal>native</literal>, but don't count on it.
1739                 </para> </listitem>
1740             </varlistentry>
1741             <varlistentry>
1742               <term>dplay/dplayx</term>
1743               <listitem> <para>
1744                   DirectPlay. The <literal>native</literal> version
1745                   ought to work best on this, if at all.
1746                 </para> </listitem>
1747             </varlistentry>
1748             <varlistentry>
1749               <term>mmsystem, winmm</term>
1750               <listitem> <para>
1751                   Multimedia system. The <literal>native</literal>
1752                   version is not likely to work. Leave at
1753                   <literal>builtin</literal>.
1754                 </para> </listitem>
1755             </varlistentry>
1756             <varlistentry>
1757               <term>msacm, msacm32</term>
1758               <listitem> <para>
1759                   Audio Compression Manager. The
1760                   <literal>builtin</literal> version works best, if you
1761                   set msacm.drv to the same.
1762                 </para> </listitem>
1763             </varlistentry>
1764             <varlistentry>
1765               <term>msvideo, msvfw32</term>
1766               <listitem> <para>
1767                   Video for Windows. It is safe (and recommended) to try
1768                   <literal>native</literal>.
1769                 </para> </listitem>
1770             </varlistentry>
1771             <varlistentry>
1772               <term>mcicda.drv</term>
1773               <listitem> <para>
1774                   CD Audio MCI driver.
1775                 </para> </listitem>
1776             </varlistentry>
1777             <varlistentry>
1778               <term>mciseq.drv</term>
1779               <listitem> <para>
1780                   MIDI Sequencer MCI driver (<filename>.MID</filename>
1781                   playback).
1782                 </para> </listitem>
1783             </varlistentry>
1784             <varlistentry>
1785               <term>mciwave.drv</term>
1786               <listitem> <para>
1787                   Wave audio MCI driver (<filename>.WAV</filename> playback).
1788                 </para> </listitem>
1789             </varlistentry>
1790             <varlistentry>
1791               <term>mciavi.drv</term>
1792               <listitem> <para>
1793                   AVI MCI driver (<filename>.AVI</filename> video
1794                   playback). Best to use <literal>native</literal>.
1795                 </para> </listitem>
1796             </varlistentry>
1797             <varlistentry>
1798               <term>mcianim.drv</term>
1799               <listitem> <para>
1800                   Animation MCI driver.
1801                 </para> </listitem>
1802             </varlistentry>
1803             <varlistentry>
1804               <term>msacm.drv</term>
1805               <listitem> <para>
1806                   Audio Compression Manager. Set to same as msacm32.
1807                 </para> </listitem>
1808             </varlistentry>
1809             <varlistentry>
1810               <term>midimap.drv</term>
1811               <listitem> <para>
1812                   MIDI Mapper.
1813                 </para> </listitem>
1814             </varlistentry>
1815             <varlistentry>
1816               <term>wprocs</term>
1817               <listitem> <para>
1818                   This is a pseudo-DLL used by Wine for thunking
1819                   purposes. A <literal>native</literal> version of this
1820                   doesn't exist.
1821                 </para> </listitem>
1822             </varlistentry>
1823           </variablelist>          
1824         </sect3>
1825       </sect2>
1826       <sect2 id="dll-missing">
1827         <title>Missing DLLs</title>
1828   
1829         <para>
1830           Written by &name-andreas-mohr; <email>&email-andreas-mohr;</email>
1831         </para>
1832   
1833         <para>
1834           In case Wine complains about a missing DLL, you should check whether
1835           this file is a publicly available DLL or a custom DLL belonging
1836           to your program (by searching for its name on the internet).
1837           If you managed to get hold of the DLL, then you should make sure
1838           that Wine is able to find and load it.
1839           DLLs usually get loaded according to the mechanism of the
1840           SearchPath() function.
1841           This function searches directories in the following order:
1842           
1843           a) The directory the program was started from.
1844           b) The current directory.
1845           c) The Windows system directory.
1846           d) The Windows directory.
1847           e) The PATH variable directories.
1848           
1849           In short: either put the required DLL into your application
1850           directory (might be ugly), or usually put it into the Windows system
1851           directory. Just find out its directory by having a look at the Wine
1852           config File variable "System" (which indicates the location of the
1853           Windows system directory) and the associated drive entry.
1854         </para>
1855       </sect2>
1856     </sect1>
1857
1858     &fonts;
1859     &printing;
1860
1861     <sect1 id="win95look">
1862       <title>Win95/98 Look</title>
1863       <para>
1864         Written by &name-david-cuthbert; <email>&email-david-cuthbert;</email>
1865       </para>
1866       <para>
1867         (Extracted from <filename>wine/documentation/win95look</filename>)
1868       </para>
1869       <para>
1870         Win95/Win98 interface code is being introduced.
1871       </para>
1872       <para>
1873         Instead of compiling Wine for Win3.1 vs. Win95 using
1874         <constant>#define</constant> switches, the code now looks in a
1875         special [Tweak.Layout] section of
1876         <filename>~/.wine/config</filename> for a
1877         <literal>"WineLook" = "Win95"</literal> or
1878         <literal>"WineLook" = "Win98"</literal> entry.
1879       </para>
1880       <para>
1881         A few new sections and a number of entries have been added to
1882         the <filename>~/.wine/config</filename> file -- these are for
1883         debugging the Win95 tweaks only and may be removed in a future
1884         release!  These entries/sections are:
1885       </para>
1886       <programlisting>
1887 [Tweak.Fonts]
1888 "System.Height" = "&lt;point size>"    # Sets the height of the system typeface
1889 "System.Bold" = "[true|false]"      # Whether the system font should be boldfaced
1890 "System.Italic" = "[true|false]"    # Whether the system font should be italicized
1891 "System.Underline" = "[true|false]" # Whether the system font should be underlined
1892 "System.StrikeOut" = "[true|false]" # Whether the system font should be struck out
1893 "OEMFixed.xxx"                  # Same parameters for the OEM fixed typeface
1894 "AnsiFixed.xxx"                 # Same parameters for the Ansi fixed typeface
1895 "AnsiVar.xxx"                   # Same parameters for the Ansi variable typeface
1896 "SystemFixed.xxx"               # Same parameters for the System fixed typeface
1897
1898 [Tweak.Layout]
1899 "WineLook" = "[Win31|Win95|Win98]"  # Changes Wine's look and feel
1900       </programlisting>
1901     </sect1>
1902
1903     <sect1 id="keyboard">
1904       <title>Keyboard</title>
1905
1906       <para>
1907         Written by &name-ove-kaaven; <email>&email-ove-kaaven;</email>
1908       </para>
1909       <para>
1910         (Extracted from <filename>wine/documentation/keyboard</filename>)
1911       </para>
1912
1913       <para>
1914         Wine now needs to know about your keyboard layout. This
1915         requirement comes from a need from many apps to have the
1916         correct scancodes available, since they read these directly,
1917         instead of just taking the characters returned by the X
1918         server. This means that Wine now needs to have a mapping from
1919         X keys to the scancodes these applications expect.
1920       </para>
1921       <para>
1922         On startup, Wine will try to recognize the active X layout by
1923         seeing if it matches any of the defined tables. If it does,
1924         everything is alright. If not, you need to define it.
1925       </para>
1926       <para>
1927         To do this, open the file
1928         <filename>dlls/x11drv/keyboard.c</filename> and take a look
1929         at the existing tables. Make a backup copy of it, especially
1930         if you don't use CVS.
1931       </para>
1932       <para>
1933         What you really would need to do, is find out which scancode
1934         each key needs to generate.  Find it in the
1935         <function>main_key_scan</function> table, which looks like
1936         this:
1937       </para>
1938       <programlisting>
1939 static const int main_key_scan[MAIN_LEN] =
1940 {
1941 /* this is my (102-key) keyboard layout, sorry if it doesn't quite match yours */
1942    0x29,0x02,0x03,0x04,0x05,0x06,0x07,0x08,0x09,0x0A,0x0B,0x0C,0x0D,
1943    0x10,0x11,0x12,0x13,0x14,0x15,0x16,0x17,0x18,0x19,0x1A,0x1B,
1944    0x1E,0x1F,0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x27,0x28,0x2B,
1945    0x2C,0x2D,0x2E,0x2F,0x30,0x31,0x32,0x33,0x34,0x35,
1946    0x56 /* the 102nd key (actually to the right of l-shift) */
1947 };
1948       </programlisting>
1949       <para>
1950         Next, assign each scancode the characters imprinted on the
1951         keycaps. This was done (sort of) for the US 101-key keyboard,
1952         which you can find near the top in
1953         <filename>keyboard.c</filename>. It also shows that if there
1954         is no 102nd key, you can skip that.
1955       </para>
1956       <para>
1957         However, for most international 102-key keyboards, we have
1958         done it easy for you. The scancode layout for these already
1959         pretty much matches the physical layout in the
1960         <function>main_key_scan</function>, so all you need to do is
1961         to go through all the keys that generate characters on your
1962         main keyboard (except spacebar), and stuff those into an
1963         appropriate table. The only exception is that the 102nd key,
1964         which is usually to the left of the first key of the last line
1965         (usually <keycap>Z</keycap>), must be placed on a separate
1966         line after the last line.
1967       </para>
1968       <para>
1969         For example, my Norwegian keyboard looks like this
1970       </para>
1971       <screen>
1972 §  !  "  #  ¤  %  &  /  (  )  =  ?  `  Back-
1973 |  1  2@ 3£ 4$ 5  6  7{ 8[ 9] 0} +  \´ space
1974
1975 Tab Q  W  E  R  T  Y  U  I  O  P  Å  ^
1976                                      ¨~
1977                                         Enter
1978 Caps A  S  D  F  G  H  J  K  L  Ø  Æ  *
1979 Lock                                  '
1980
1981 Sh- > Z  X  C  V  B  N  M  ;  :  _  Shift
1982 ift &lt;                      ,  .  -
1983
1984 Ctrl  Alt       Spacebar       AltGr  Ctrl
1985       </screen>
1986       <para>
1987         Note the 102nd key, which is the <keycap>&lt;></keycap> key, to
1988         the left of <keycap>Z</keycap>. The character to the right of
1989         the main character is the character generated by
1990         <keycap>AltGr</keycap>.
1991       </para>
1992       <para>
1993         This keyboard is defined as follows:
1994       </para>
1995       <programlisting>
1996 static const char main_key_NO[MAIN_LEN][4] =
1997 {
1998  "|§","1!","2\"@","3#£","4¤$","5%","6&","7/{","8([","9)]","0=}","+?","\\´",
1999  "qQ","wW","eE","rR","tT","yY","uU","iI","oO","pP","åÅ","¨^~",
2000  "aA","sS","dD","fF","gG","hH","jJ","kK","lL","øØ","æÆ","'*",
2001  "zZ","xX","cC","vV","bB","nN","mM",",;",".:","-_",
2002  "&lt;>"
2003 };   
2004       </programlisting>
2005       <para>
2006         Except that " and \ needs to be quoted with a backslash, and
2007         that the 102nd key is on a separate line, it's pretty
2008         straightforward.
2009       </para>
2010       <para>
2011         After you have written such a table, you need to add it to the
2012         <function>main_key_tab[]</function> layout index table. This
2013         will look like this:
2014       </para>
2015       <programlisting>
2016 static struct {
2017  WORD lang, ansi_codepage, oem_codepage;
2018  const char (*key)[MAIN_LEN][4];
2019 } main_key_tab[]={
2020 ...
2021 ...
2022  {MAKELANGID(LANG_NORWEGIAN,SUBLANG_DEFAULT),  1252, 865, &amp;main_key_NO},  
2023 ...
2024       </programlisting>
2025       <para>
2026         After you have added your table, recompile Wine and test that
2027         it works. If it fails to detect your table, try running
2028       </para>
2029       <screen>
2030 wine --debugmsg +key,+keyboard >& key.log
2031       </screen>
2032       <para>
2033         and look in the resulting <filename>key.log</filename> file to
2034         find the error messages it gives for your layout.
2035       </para>
2036       <para>
2037         Note that the <constant>LANG_*</constant> and
2038         <constant>SUBLANG_*</constant> definitions are in
2039         <filename>include/winnls.h</filename>, which you might need to
2040         know to find out which numbers your language is assigned, and
2041         find it in the debugmsg output. The numbers will be
2042         <literal>(SUBLANG * 0x400 + LANG)</literal>, so, for example
2043         the combination <literal>LANG_NORWEGIAN (0x14)</literal> and
2044         <literal>SUBLANG_DEFAULT (0x1)</literal> will be (in hex)
2045         <literal>14 + 1*400 = 414</literal>, so since I'm Norwegian, I
2046         could look for <literal>0414</literal> in the debugmsg output
2047         to find out why my keyboard won't detect.
2048       </para>
2049       <para>
2050         Once it works, submit it to the Wine project. If you use CVS,
2051         you will just have to do
2052       </para>
2053       <screen>
2054 cvs -z3 diff -u dlls/x11drv/keyboard.c > layout.diff
2055       </screen>
2056       <para>
2057         from your main Wine directory, then submit
2058         <filename>layout.diff</filename> to
2059         <email>wine-patches@winehq.com</email> along with a brief note
2060         of what it is.
2061       </para>
2062       <para>
2063         If you don't use CVS, you need to do
2064       </para>
2065       <screen>
2066 diff -u the_backup_file_you_made dlls/x11drv/keyboard.c > layout.diff
2067       </screen>
2068       <para>
2069         and submit it as explained above.
2070       </para>
2071       <para>
2072         If you did it right, it will be included in the next Wine
2073         release, and all the troublesome applications (especially
2074         remote-control applications) and games that use scancodes will
2075         be happily using your keyboard layout, and you won't get those
2076         annoying fixme messages either.
2077       </para>
2078       <para>
2079         Good luck.
2080       </para>
2081     </sect1>
2082
2083   </chapter>
2084
2085 <!-- Keep this comment at the end of the file
2086 Local variables:
2087 mode: sgml
2088 sgml-parent-document:("wine-doc.sgml" "set" "book" "chapter" "")
2089 End:
2090 -->