| blob | 923b995b80d6c42a7216ea8dd27d479b4dbbf052 |
7 <para>
9 </para>
10 <para>
12 </para>
14 <sect2>
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>
53 <sect2>
55 <para>
56 This section will guide you through the process of making a
59 </para>
63 <thead>
64 <row>
68 </row>
69 </thead>
70 <tbody>
71 <row>
75 </row>
76 <row>
80 </row>
81 <row>
85 </row>
86 <row>
90 </row>
91 <row>
95 </row>
96 <row>
100 </row>
101 <row>
105 </row>
106 <row>
110 </row>
111 <row>
115 </row>
116 <row>
120 </row>
121 <row>
125 </row>
126 <row>
130 </row>
131 <row>
135 </row>
136 <row>
140 </row>
141 <row>
145 </row>
146 <row>
150 </row>
151 <row>
155 </row>
156 </tbody>
157 </tgroup>
158 </informaltable>
160 <sect3>
162 <para>
163 It should be pretty self explanatory, but here is an
164 in-depth tutorial about them. There are up to 6 lines for
165 each drive in Wine.
166 </para>
167 <para>
169 The above line begins the section for a drive whose letter is X.
170 </para>
171 <para>
173 path is where the drive will begin. When Wine is browsing
174 in drive X, it will see the files that are in the
176 to leave off the trailing slash!
177 </para>
178 <para>
179 <programlisting>
181 </programlisting>
182 </para>
183 <para>
184 Sets up the type of drive Wine will see it as. Type must
188 </para>
189 <para>
191 drive label. Generally only needed for programs that look
192 for a special CD-ROM. Info on finding the lable is in
194 The label may be up to 11 characters.
195 </para>
196 <para>
198 Tells Wine the serial number of the drive. A few programs with
199 intense protection for pirating might need this, but otherwise
200 don't use it. Up to 8 characters and hexadecimal.
201 </para>
202 <para>
204 Sets up the way Wine looks at files on the drive.
205 </para>
207 <variablelist>
208 <varlistentry>
210 <listitem>
211 <para>
212 Case insensitive filesystem. Alike to DOS and
214 length of files (eightdot.123) - longer ones will be
215 truncated. (NOTE: this is a very bad choice if you
216 plan on running apps that use long filenames. win95
217 should work fine with apps that were designed to run
218 under the msdos system. In other words, you might
219 not want to use this.)
220 </para>
221 </listitem>
222 </varlistentry>
223 <varlistentry>
225 <listitem>
226 <para>
228 the long filename filesystem you are probably used
229 to working with. The filesystem of choice for most
230 applications to be run under wine. PROBABLY THE ONE
231 YOU WANT!
232 </para>
233 </listitem>
234 </varlistentry>
235 <varlistentry>
237 <listitem>
238 <para>
239 Case sensitive. This filesystem has almost no use
240 (Windows apps expect case insensitive filenames).
241 Try it if you dare, but win95 is a much better
242 choice.
243 </para>
244 </listitem>
245 </varlistentry>
246 </variablelist>
249 <para>
250 Use this ONLY for floppy and cdrom devices. Using it on
251 Extended2 partitions can have dire results (when a windows
252 app tries to do a lowlevel write, they do it in a FAT way
253 -- FAT does not mix with Extended2).
254 </para>
255 <note>
256 <para>
257 This setting is not really important; almost all apps
258 will have no problem if it remains unspecified. For
259 CD-ROMs you might want to add it to get automatic label
260 detection, though. If you are unsure about specifying
261 device names, just leave out this setting for your
262 drives.
263 </para>
264 </note>
265 <para>
266 Here is a setup for Drive X, a generic hard drive:
267 <programlisting>
268 [Drive X]
273 This is a setup for Drive X, a generic CD-ROM drive:
274 [Drive X]
280 And here is a setup for Drive X, a generic floppy drive:
281 [Drive X]
288 </programlisting>
289 </para>
290 </sect3>
292 <sect3>
294 <para>
295 The [wine] section of the configuration file contains
296 information wine uses for directories. When specifying the
297 directories for the settings, make them as they would
303 </para>
304 <para>
306 Make one if you don't already have one. NO TRAILING SLASH
308 </para>
309 <para>
311 This sets up where the windows system files are. Should
312 reside in the directory used for the
315 files will go. Again, NO TRAILING SLASH!
316 </para>
317 <para>
319 be the directory you want your temp files stored in. YOU
320 MUST HAVE WRITE ACCESS TO IT.
321 </para>
322 <para>
323 <programlisting>
325 </programlisting>
326 </para>
327 <para>
329 boxes. When wine is run like <userinput>wine
331 resides in a directory specified in the
334 current directory, wine will run that one). Make sure it
336 system directory (For this setup, it must have
338 </para>
339 <para>
341 Sets up the symbol table file for the wine debugger. You
342 probably don't need to fiddle with this. May be useful if
343 your wine is stripped.
344 </para>
345 <para>
347 whether to allow printer drivers and printing to work.
348 Using these things are pretty alpha, so you might want to
349 watch out. Some people might find it useful, however. If
350 you're not planning on working on printing, don't even add
352 isn't already in it). Check out the [spooler] and
353 [parallelports] sections too.
354 </para>
355 </sect3>
357 <sect3>
359 <para>
360 There are a few things you will need to know before
361 configuring the DLL sections in your wine configuration
362 file.
363 </para>
364 <sect4>
366 <para>
367 Most windows DLL's have a win16 (Windows 3.x) and win32
368 (Windows 9x/NT) form. The combination of the win16 and
369 win32 DLL versions are called the "DLL pair". This is a
370 list of the most common pairs:
371 </para>
373 <informaltable>
375 <thead>
376 <row>
379 <entry>
380 Native
381 <footnote>
382 <para>
383 Is it possible to use native dll with wine?
384 (See next section)
385 </para>
386 </footnote>
387 </entry>
388 </row>
389 </thead>
390 <tbody>
391 <row>
395 </row>
396 <row>
400 </row>
401 <row>
405 </row>
406 <row>
410 </row>
411 <row>
415 </row>
416 <row>
420 </row>
421 </tbody>
422 </tgroup>
423 </informaltable>
424 </sect4>
426 <sect4>
428 <para>
429 There are a few different forms of DLL's wine can load:
430 <variablelist>
431 <varlistentry>
433 <listitem><para>
434 The DLL's that are included with windows. Many
435 windows DLL's can be loaded in their native
436 form. Many times these native versions work
437 better than their non-Microsoft equivalent --
438 other times they don't.
439 </para></listitem>
440 </varlistentry>
441 <varlistentry>
443 <listitem><para>
444 ELF encapsulated windows DLL's. This is currently
445 experimental (Not working yet).
446 </para></listitem>
447 </varlistentry>
448 <varlistentry>
450 <listitem><para>
451 Native ELF libraries. Will not work yet.
452 </para></listitem>
453 </varlistentry>
454 <varlistentry>
456 <listitem><para>
457 The most common form of DLL loading. This is
458 what you will use if the DLL is error-prone in
459 native form (KERNEL for example), you don't have
460 the native DLL, or you just want to be
461 Microsoft-free.
462 </para></listitem>
463 </varlistentry>
464 </variablelist>
465 </para>
466 </sect4>
467 </sect3>
469 <sect3>
471 <para>
472 These settings provide wine's default handling of DLL loading.
473 </para>
474 <para>
476 </para>
477 <para>
478 This setting is a comma-delimited list of which order to
479 attempt loading DLL's. If the first option fails, it will
480 try the second, and so on. The order specified above is
481 probably the best in most conditions.
482 </para>
483 </sect3>
485 <sect3>
487 <para>
488 At one time, there was a section called [DllPairs] in the
489 default configuration file, but this has been obsoleted
490 because the pairing information has now been embedded into
491 Wine itself. (The purpose of this section was merely to be
492 able to issue warnings if the user attempted to pair
496 </para>
497 </sect3>
499 <sect3>
501 <para>
502 The format for this section is the same for each line:
503 <programlisting>
505 </programlisting>
506 </para>
507 <para>
508 For example, to load builtin KERNEL pair (case doesn't
509 matter here):
510 <programlisting>
512 </programlisting>
513 </para>
514 <para>
515 To load the native COMMDLG pair, but if that doesn't work
516 try builtin:
517 <programlisting>
519 </programlisting>
520 </para>
521 <para>
522 To load the native COMCTL32:
523 <programlisting>
525 </programlisting>
526 </para>
527 <para>
528 Here is a good generic setup (As it is defined in config
529 that was included with your wine package):
530 <programlisting>
531 [DllOverrides]
567 </programlisting>
568 </para>
569 <note>
570 <para>
571 You see that elfdll or so is the first option for a few
572 of these dll's. This will fail for you, but you won't
573 notice it as wine will just use the second or third
574 option.
575 </para>
576 </note>
577 </sect3>
579 <sect3>
581 <para>
582 No one seems to know what this section is...
583 </para>
584 <para>
585 <programlisting>
587 </programlisting>
588 System colors to allocate? Just leave it at 100.
589 </para>
590 </sect3>
592 <sect3>
594 <para>
595 This section sets up wine's font handling.
596 </para>
597 <para>
599 </para>
600 <para>
601 Since the way X handles fonts is different from the way
602 Windows does, wine uses a special mechanism to deal with
603 them. It must scale them using the number defined in the
605 a nice in the middle one. If you have the real windows
609 important. Of course, it's always good to get your X fonts
610 working acceptably in wine.
611 </para>
612 <para>
614 The default font wine uses. Fool around with it if you'd like.
615 </para>
616 <para>
617 OPTIONAL:
618 </para>
619 <para>
621 used in wine. This is good for apps that need a special font you don't have,
622 but a good replacement exists. The syntax is like so:
623 <programlisting>
625 </programlisting>
626 </para>
627 <para>
629 then "Alias1" and so on. The fake windows name is the name
630 that the font will be under a windows app in wine. The
631 real X name is the font name as seen by X (Run
633 utilize the fake windows name you define. If it is not
634 used, then wine will just try to extract the fake windows
635 name itself and not use the value you enter.
636 </para>
637 <para>
638 Here is an example of an alias without masking. The font will show up in windows
639 apps as "Google". When defining an alias in a config file, forget about my
640 comment text (The "<-- blah" stuff)
641 <programlisting>
643 </programlisting>
644 </para>
645 <para>
646 Here is an example with masking enabled. The font will show up as "Foo" in
647 windows apps.
648 <programlisting>
650 </programlisting>
651 </para>
652 <para>
654 </para>
655 </sect3>
657 <sect3>
659 <para>
660 Even though it sounds like a lot of sections, these are
661 all closely related. They are all for communications and
662 parallel ports.
663 </para>
664 <para>
665 The [serialports] section tells wine what serial ports it
666 is allowed to use.
668 </para>
669 <para>
674 can actually equal any device
676 not always necessary to define any COM ports (An optional
677 setting). Here is an example:
679 </para>
680 <para>
681 Use as many of these as you like in the section to define
682 all of the COM ports you need.
683 </para>
684 <para>
685 The [parallelports] section sets up any parallel ports
686 that will be allowed access under wine.
688 </para>
689 <para>
690 Sounds familiar? Syntax is just like the COM port setting.
694 minus 1, just like for COM ports). You don't always need
695 to define a parallel port (AKA, it's optional). As with
696 the other section, LptX can equal any device (Maybe
699 </para>
700 <para>
701 The [spooler] section will inform wine where to spool
702 print jobs. Use this if you want to try printing. Wine
703 docs claim that spooling is "rather primitive" at this
704 time, so it won't work perfectly. IT IS OPTIONAL. The only
705 setting you use in this section works to map a port (LPT1,
706 for example) to a file or a command. Here is an example,
709 </para>
710 <para>
711 The following command maps printing jobs to LPT1 to the
714 </para>
715 <para>
716 The [ports] section is usually useful only for people who
717 need direct port access for programs requiring dongles or
718 scanners. IF YOU DON'T NEED IT, DON'T USE IT!
719 </para>
720 <para>
722 Gives direct read access to those IO's.
723 </para>
724 <para>
726 Gives direct write access to those IO's. It's probably a
727 good idea to keep the values of the
729 settings the same. This stuff will only work when you're
730 root.
731 </para>
732 </sect3>
734 <sect3>
736 <para>
737 [spy] is used to include or exclude debug messages, and to
738 output them to a file. The latter is rarely used. THESE
739 ARE ALL OPTIONAL AND YOU PROBABLY DON'T NEED TO ADD OR
740 REMOVE ANYTHING IN THIS SECTION TO YOUR CONFIG.
741 </para>
742 <para>
744 Sets the logfile for wine. Set to CON to log to standard out.
745 THIS IS RARELY USED.
746 </para>
747 <para>
751 </para>
752 <para>
756 </para>
757 <para>
758 [Registry] can be used to tell wine where your old windows
759 registry files exist. This section is completely optional
760 and useless to people using wine without an existing
761 windows installation.
762 </para>
763 <para>
766 </para>
767 <para>
768 [tweak.layout] is devoted to wine's look. There is only
769 one setting for it.
770 </para>
771 <para>
776 </para>
777 <para>
778 [programs] can be used to say what programs run under
779 special conditions.
780 </para>
781 <para>
783 Sets the program to be run if wine is started without specifying a program.
784 </para>
785 <para>
787 Sets the program to automatically be run at startup every time.
788 </para>
789 </sect3>
791 <sect3>
793 <para>
794 [WinMM] is used to define which multimedia drivers have to be loaded. Since
795 those drivers may depend on the multimedia interfaces available on your sustem
796 (OSS, Alsa... to name a few), it's needed to be able to configure which driver
797 has to be loaded.
798 </para>
800 <para>
801 The content of the section looks like:
802 <programlisting>
803 [WinMM]
807 </programlisting>
808 All the keys must be defined:
809 <itemizedlist>
810 <listitem>
811 <para>
812 The "Drivers" key is a ';' separated list of modules name, each of
813 them containing a low level driver. All those drivers will be loaded
814 when MMSYSTEM/WINMM is started and will provide their inner features.
815 </para>
816 </listitem>
817 <listitem>
818 <para>
819 The "WaveMapper" represents the name of the module containing the Wave
820 Mapper driver. Only one wave mapper can be defined in the system.
821 </para>
822 </listitem>
823 <listitem>
824 <para>
825 The "MidiMapper" represents the name of the module containing the Midi
826 Mapper driver. Only one Midi mapper can be defined in the system.
827 </para>
828 </listitem>
829 </itemizedlist>
830 </para>
831 </sect3>
832 </sect2>
834 <sect2>
836 <para>
837 The wine config file can go in two places.
838 </para>
839 <variablelist>
840 <varlistentry>
842 <listitem><para>
843 A systemwide config file, used for anyone who doesn't
844 have their own. NOTE: this file is currently unused as a
845 new global configuration mechanism is not in place at this
846 time
847 </para></listitem>
848 </varlistentry>
849 <varlistentry>
851 <listitem><para>
852 Your own config file, that only is used for your user.
853 </para></listitem>
854 </varlistentry>
855 </variablelist>
856 <para>
860 it.
861 </para>
862 </sect2>
864 <sect2>
866 <para>
867 There is always a chance that things will go wrong. If the
868 unthinkable happens, try the newsgroup,
871 irc.stealth.net:6668, or connected servers.
872 Make sure that you have looked over this document thoroughly,
873 and have also read:
874 </para>
875 <itemizedlist>
876 <listitem>
878 </listitem>
879 <listitem>
880 <para>
882 (optional but recommended)
883 </para>
884 </listitem>
885 </itemizedlist>
886 <para>
887 If indeed it looks like you've done your research, be
888 prepared for helpful suggestions. If you haven't, brace
889 yourself for heaving flaming.
890 </para>
891 </sect2>
892 </sect1>
896 <para>
898 </para>
899 <para>
901 </para>
902 <para>
903 Win95/Win98 interface code is being introduced.
904 </para>
905 <para>
906 Instead of compiling Wine for Win3.1 vs. Win95 using
908 special [Tweak.Layout] section of
912 </para>
913 <para>
914 A few new sections and a number of entries have been added to
916 debugging the Win95 tweaks only and may be removed in a future
917 release! These entries/sections are:
918 </para>
919 <programlisting>
920 [Tweak.Fonts]
926 "OEMFixed.xxx" # Same parameters for the OEM fixed typeface
927 "AnsiFixed.xxx" # Same parameters for the Ansi fixed typeface
928 "AnsiVar.xxx" # Same parameters for the Ansi variable typeface
929 "SystemFixed.xxx" # Same parameters for the System fixed typeface
931 [Tweak.Layout]
933 </programlisting>
934 </sect1>
939 <para>
941 </para>
942 <para>
944 </para>
946 <para>
947 Most Wine users run Wine under the windowing system known as
948 X11. During most of Wine's history, this was the only display
949 driver available, but in recent years, parts of Wine has been
950 reorganized to allow for other display drivers (although the
951 only alternative currently available is Patrik Stridvall's
952 ncurses-based ttydrv, which he claims works for displaying
953 calc.exe). The display driver is chosen with the
956 x11drv driver in this article.
957 </para>
959 <sect2>
962 <para>
963 <!-- FIXME: This is outdated -->
964 Note: This is now all done in the config file. Needs an update...
965 </para>
967 <para>
968 The x11drv driver consists of two conceptually distinct
969 pieces, the graphics driver (GDI part), and the windowing
970 driver (USER part). Both of these are linked into the
973 Wine, running on X11, the graphics driver must draw on
974 drawables (window interiors) provided by the windowing
975 driver. This differs a bit from the Windows model, where the
976 windowing system creates and configures device contexts
977 controlled by the graphics driver, and applications are
978 allowed to hook into this relationship anywhere they like.
979 Thus, to provide any reasonable tradeoff between
980 compatibility and usability, the x11drv has three different
981 modes of operation.
982 </para>
984 <variablelist>
985 <varlistentry>
987 <listitem>
988 <para>
989 The default. Window-manager-independent (any running
990 window manager is ignored completely). Window
991 decorations (title bars, borders, etc) are drawn by
992 Wine to look and feel like the real Windows. This is
993 compatible with applications that depend on being able
994 to compute the exact sizes of any such decorations, or
995 that want to draw their own.
996 </para>
997 </listitem>
998 </varlistentry>
999 <varlistentry>
1001 <listitem>
1002 <para>
1003 Specified by using the
1007 Ordinary top-level frame windows with thick borders,
1008 title bars, and system menus will be managed by your
1009 window manager. This lets these applications integrate
1010 better with the rest of your desktop, but may not
1011 always work perfectly. (A rewrite of this mode of
1012 operation, to make it more robust and less patchy, is
1013 highly desirable, though, and is planned to be done
1014 before the Wine 1.0 release.)
1015 </para>
1016 </listitem>
1017 </varlistentry>
1018 <varlistentry>
1020 <listitem>
1021 <para>
1022 Specified by using the
1024 (with a geometry, e.g. <parameter>--desktop
1027 automatically position the desktop at the upper-left
1028 corner of the display). This is the mode most
1029 compatible with the Windows model. All application
1030 windows will just be Wine-drawn windows inside the
1031 Wine-provided desktop window (which will itself be
1032 managed by your window manager), and Windows
1033 applications can roam freely within this virtual
1034 workspace and think they own it all, without
1035 disturbing your other X apps.
1036 </para>
1037 </listitem>
1038 </varlistentry>
1039 </variablelist>
1040 </sect2>
1042 <sect2>
1045 <variablelist>
1046 <varlistentry>
1048 <listitem>
1049 <para>
1050 Applies only if you have a palette-based display, i.e.
1051 if your X server is set to a depth of 8bpp, and if you
1052 haven't requested a private color map. It specifies
1053 the maximum number of shared colormap cells (palette
1054 entries) Wine should occupy. The higher this value,
1055 the less colors will be available to other
1056 applications.
1057 </para>
1058 </listitem>
1059 </varlistentry>
1060 <varlistentry>
1062 <listitem>
1063 <para>
1064 Applies only if you have a palette-based display, i.e.
1065 if your X server is set to a depth of 8bpp. It
1066 specifies that you don't want to use the shared color
1067 map, but a private color map, where all 256 colors are
1068 available. The disadvantage is that Wine's private
1069 color map is only seen while the mouse pointer is
1070 inside a Wine window, so psychedelic flashing and
1071 funky colors will become routine if you use the mouse
1072 a lot.
1073 </para>
1074 </listitem>
1075 </varlistentry>
1076 <varlistentry>
1078 <listitem>
1079 <para>
1080 This option only determines whether fast X11 routines
1081 or exact Wine routines will be used for certain ROP
1082 codes in blit operations. Most users won't notice any
1083 difference.
1084 </para>
1085 </listitem>
1086 </varlistentry>
1087 <varlistentry>
1089 <listitem>
1090 <para>
1091 Applies only to multi-depth displays. It specifies
1092 which of the available depths Wine should use (and
1093 tell Windows apps about).
1094 </para>
1095 </listitem>
1096 </varlistentry>
1097 <varlistentry>
1099 <listitem>
1100 <para>
1101 This specifies which X11 display to use, and if
1102 specified, will override both the
1105 </para>
1106 </listitem>
1107 </varlistentry>
1108 <varlistentry>
1110 <listitem>
1111 <para>
1112 Wine can let frame windows be managed by your window
1113 manager. This option specifies whether you want that
1114 by default.
1115 </para>
1116 </listitem>
1117 </varlistentry>
1118 <varlistentry>
1120 <listitem>
1121 <para>
1122 This specifies whether you want DirectDraw to use
1123 XFree86's <firstterm>Direct Graphics
1124 Architecture</firstterm> (DGA), which is able to
1125 take over the entire display and run the game
1126 full-screen at maximum speed. (With DGA1 (XFree86
1127 3.x), you still have to configure the X server to the
1128 game's requested bpp first, but with DGA2 (XFree86
1129 4.x), runtime depth-switching may be possible,
1130 depending on your driver's capabilities.) But be aware
1131 that if Wine crashes while in DGA mode, it may not be
1132 possible to regain control over your computer without
1133 rebooting. DGA normally requires either root
1134 privileges or read/write access to
1136 </para>
1137 </listitem>
1138 </varlistentry>
1139 <varlistentry>
1141 <listitem>
1142 <para>
1143 If you don't want DirectX to use DGA, you can at least
1144 use X Shared Memory extensions (XShm). It is much
1145 slower than DGA, since the app doesn't have direct
1146 access to the physical frame buffer, but using shared
1147 memory to draw the frame is at least faster than
1148 sending the data through the standard X11 socket, even
1149 though Wine's XShm support is still known to crash
1150 sometimes.
1151 </para>
1152 </listitem>
1153 </varlistentry>
1154 <varlistentry>
1156 <listitem>
1157 <para>
1158 If you don't use DGA, you may want an alternative
1159 means to convince the mouse cursor to stay within the
1160 game window. This option does that. Of course, as with
1161 DGA, if Wine crashes, you're in trouble (although not
1162 as badly as in the DGA case, since you can still use
1163 the keyboard to get out of X).
1164 </para>
1165 </listitem>
1166 </varlistentry>
1167 <varlistentry>
1169 <listitem>
1170 <para>
1171 Applies only if you use the
1173 to run in a desktop window. Specifies whether to
1174 create the desktop window with a double-buffered
1175 visual, something most OpenGL games need to run
1176 correctly.
1177 </para>
1178 </listitem>
1179 </varlistentry>
1180 <varlistentry>
1182 <listitem>
1183 <para>
1184 <!-- FIXME: To be documented -->
1185 To be documented...
1186 </para>
1187 </listitem>
1188 </varlistentry>
1189 <varlistentry>
1191 <listitem>
1192 <para>
1193 <!-- FIXME: To be documented -->
1194 To be documented...
1195 </para>
1196 </listitem>
1197 </varlistentry>
1198 <varlistentry>
1200 <listitem>
1201 <para>
1202 <!-- FIXME: To be documented -->
1203 To be documented...
1204 </para>
1205 </listitem>
1206 </varlistentry>
1207 </variablelist>
1208 </sect2>
1209 </sect1>
1211 ®istry;
1214 <sect1info>
1215 <authorgroup>
1216 <author>
1219 <affiliation>
1221 </affiliation>
1223 </author>
1224 <author>
1227 <affiliation>
1229 </affiliation>
1231 </author>
1232 </authorgroup>
1233 </sect1info>
1236 <para>
1238 Nov 14 1999
1239 </para>
1240 <para>
1242 Jan 25 2000
1243 </para>
1244 <para>
1246 </para>
1247 <para>
1248 Until now, your only possibility of specifying drive volume
1249 labels and serial numbers was to set them manually in the wine
1250 config file. By now, wine can read them directly from the
1251 device as well. This may be useful for many Win 9x games or
1252 for setup programs distributed on CD-ROMs that check for
1253 volume label.
1254 </para>
1256 <sect2>
1261 <thead>
1262 <row>
1266 </row>
1267 </thead>
1268 <tbody>
1269 <row>
1273 </row>
1274 <row>
1278 </row>
1279 </tbody>
1280 </tgroup>
1281 </informaltable>
1283 </sect2>
1285 <sect2>
1287 <para>
1288 Reading labels and serial numbers just works automagically
1291 Note that the device has to exist and must be accessible if
1292 you do this, though.
1293 </para>
1294 <para>
1295 If you don't do that, then you should give fixed
1298 these entries instead if no device is given. If they don't
1299 exist, then Wine will return default values (label
1302 </para>
1303 <para>
1306 but not for reading the volume info from the device (i.e. you want
1309 to skip the volume reading.
1310 </para>
1311 </sect2>
1313 <sect2>
1315 <para>
1316 Here's a simple example of cdrom and floppy; labels will be
1317 read from the device on both cdrom and floppy; serial
1318 numbers on floppy only:
1319 </para>
1320 <screen>
1321 [Drive A]
1327 [Drive R]
1332 </screen>
1333 <para>
1334 Here's an example of overriding the CD-ROM label:
1335 </para>
1336 <screen>
1337 [Drive J]
1341 ; note that the device isn't really needed here as we have a fixed label
1344 </screen>
1345 </sect2>
1347 <sect2>
1349 <itemizedlist>
1350 <listitem> <para>
1351 The cdrom label can be read only if the data track of
1352 the disk resides in the first track and the cdrom is
1353 iso9660.
1354 </para> </listitem>
1355 <listitem> <para>
1356 Better checking for FAT superblock (it now checks only
1357 one byte). </para>
1358 </listitem>
1359 <listitem> <para>
1360 Support for labels/serial nums WRITING.
1361 </para> </listitem>
1362 <listitem> <para>
1364 chars).
1365 </para> </listitem>
1366 <listitem> <para>
1367 What about reading ext2 volume label? ....
1368 </para> </listitem>
1369 </itemizedlist>
1370 </sect2>
1371 </sect1>
1376 <para>
1378 </para>
1379 <para>
1381 </para>
1383 <para>
1385 and [DllOverrides] are the subject of some confusion. The
1386 overall purpose of most of these directives are clear enough,
1387 though - given a choice, should Wine use its own built-in
1389 in an existing Windows installation? This document explains
1390 how this feature works.
1391 </para>
1393 <sect2>
1395 <variablelist>
1396 <varlistentry>
1398 <listitem> <para>
1400 written for the real Microsoft Windows.
1401 </para> </listitem>
1402 </varlistentry>
1403 <varlistentry>
1405 <listitem> <para>
1406 A "builtin" DLL is a Wine DLL. These can either be a
1409 that Wine is able to load on demand.
1410 </para> </listitem>
1411 </varlistentry>
1412 <varlistentry>
1414 <listitem> <para>
1416 with a special Windows-like file structure that is as
1417 close to Windows as possible, and that can also
1418 seamlessly link dynamically with "native" DLLs, by
1419 using special ELF loader and linker tricks. Bertho
1420 Stultiens did some work on this, but this feature has
1421 not yet been merged back into Wine (because of
1422 political reasons and lack of time), so this DLL type
1423 does not exist in the official Wine at this time. In
1424 the meantime, the "builtin" DLL type gained some of
1425 the features of elfdlls (such as dynamic loading), so
1426 it's possible that "elfdll" functionality will be
1427 folded into "builtin" at some point.
1428 </para> </listitem>
1429 </varlistentry>
1430 <varlistentry>
1432 <listitem> <para>
1434 calling convention conversion thunks generated on the
1435 fly as the library is loaded. This is mostly useful
1436 for libraries such as "glide" that have exactly the
1437 same API on both Windows and Unix.
1438 </para> </listitem>
1439 </varlistentry>
1440 </variablelist>
1441 </sect2>
1443 <sect2>
1445 <variablelist>
1446 <varlistentry>
1448 <listitem> <para>
1449 This specifies in what order Wine should search for
1450 available DLL types, if the DLL in question was not
1451 found in the [DllOverrides] section.
1452 </para> </listitem>
1453 </varlistentry>
1454 </variablelist>
1455 </sect2>
1457 <sect2>
1459 <para>
1460 At one time, there was a section called [DllPairs] in the
1461 default configuration file, but this has been obsoleted
1462 because the pairing information has now been embedded into
1463 Wine itself. (The purpose of this section was merely to be
1464 able to issue warnings if the user attempted to pair
1468 </para>
1469 </sect2>
1471 <sect2>
1473 <para>
1474 This section specifies how you want specific DLLs to be
1475 handled, in particular whether you want to use "native" DLLs
1476 or not, if you have some from a real Windows configuration.
1477 Because builtins do not mix seamlessly with native DLLs yet,
1478 certain DLL dependencies may be problematic, but workarounds
1479 exist in Wine for many popular DLL configurations. Also see
1480 WWN's [16]Status Page to figure out how well your favorite
1481 DLL is implemented in Wine.
1482 </para>
1483 <para>
1484 It is of course also possible to override these settings by
1486 command-line option (see the man page for details). Some
1487 hints for choosing your optimal configuration (listed by
1489 </para>
1490 <variablelist>
1491 <varlistentry>
1493 <listitem> <para>
1494 Native versions of these will never work, so don't try. Leave
1496 </para> </listitem>
1497 </varlistentry>
1498 <varlistentry>
1500 <listitem> <para>
1501 Graphics Device Interface. No effort has been made at trying to
1503 </para> </listitem>
1504 </varlistentry>
1505 <varlistentry>
1507 <listitem> <para>
1508 Window management and standard controls. It was
1510 versions at some point (if all other DLLs that depend
1511 on it, such as comctl32 and comdlg32, were also run
1513 possible after the Address Space Separation, so leave
1515 </para> </listitem>
1516 </varlistentry>
1517 <varlistentry>
1519 <listitem> <para>
1520 NT kernel API. Although badly documented, the
1523 </para> </listitem>
1524 </varlistentry>
1525 <varlistentry>
1527 <listitem> <para>
1529 version will probably never work. Leave at
1531 </para> </listitem>
1532 </varlistentry>
1533 <varlistentry>
1535 <listitem> <para>
1536 Win16 support library for NT. The
1539 </para> </listitem>
1540 </varlistentry>
1541 <varlistentry>
1543 <listitem> <para>
1544 Win16 kernel stuff. Will never work
1547 </para> </listitem>
1548 </varlistentry>
1549 <varlistentry>
1551 <listitem> <para>
1553 </para> </listitem>
1554 </varlistentry>
1555 <varlistentry>
1557 <listitem> <para>
1558 Tool helper routines. This is rarely a source of problems.
1560 </para> </listitem>
1561 </varlistentry>
1562 <varlistentry>
1564 <listitem> <para>
1565 Versioning. Seldom useful to mess with.
1566 </para> </listitem>
1567 </varlistentry>
1568 <varlistentry>
1570 <listitem> <para>
1571 Registry and security features. Trying the
1573 not work.
1574 </para> </listitem>
1575 </varlistentry>
1576 <varlistentry>
1578 <listitem> <para>
1579 Common Dialogs, such as color picker, font dialog,
1580 print dialog, open/save dialog, etc. It is safe to try
1582 </para> </listitem>
1583 </varlistentry>
1584 <varlistentry>
1586 <listitem> <para>
1587 Common Controls. This is toolbars, status bars, list controls,
1589 </para> </listitem>
1590 </varlistentry>
1591 <varlistentry>
1593 <listitem> <para>
1594 Shell interface (desktop, filesystem, etc). Being one of the
1595 most undocumented pieces of Windows, you may have luck with the
1597 </para> </listitem>
1598 </varlistentry>
1599 <varlistentry>
1601 <listitem> <para>
1603 will not work under Wine, so leave at
1605 </para> </listitem>
1606 </varlistentry>
1607 <varlistentry>
1609 <listitem> <para>
1610 ICMP routines for wsock32. As with wsock32, leave at
1612 </para> </listitem>
1613 </varlistentry>
1614 <varlistentry>
1616 <listitem> <para>
1618 to thunking issues. Leave at
1620 </para> </listitem>
1621 </varlistentry>
1622 <varlistentry>
1624 <listitem> <para>
1625 Lempel-Ziv decompression. Wine's
1627 </para> </listitem>
1628 </varlistentry>
1629 <varlistentry>
1631 <listitem> <para>
1632 Advanced SCSI Peripheral Interface. The
1635 </para> </listitem>
1636 </varlistentry>
1637 <varlistentry>
1639 <listitem> <para>
1641 version will easily work better than Wine's on this
1642 one.
1643 </para> </listitem>
1644 </varlistentry>
1645 <varlistentry>
1647 <listitem> <para>
1648 Printer spooler. You are not likely to have more luck
1650 </para> </listitem>
1651 </varlistentry>
1652 <varlistentry>
1654 <listitem> <para>
1655 DirectDraw/Direct3D. Since Wine does not implement the
1657 will not work at this time.
1658 </para> </listitem>
1659 </varlistentry>
1660 <varlistentry>
1662 <listitem> <para>
1664 may or may not work.
1665 </para> </listitem>
1666 </varlistentry>
1667 <varlistentry>
1669 <listitem> <para>
1670 DirectSound. It may be possible to run this
1672 </para> </listitem>
1673 </varlistentry>
1674 <varlistentry>
1676 <listitem> <para>
1678 ought to work best on this, if at all.
1679 </para> </listitem>
1680 </varlistentry>
1681 <varlistentry>
1683 <listitem> <para>
1685 version is not likely to work. Leave at
1687 </para> </listitem>
1688 </varlistentry>
1689 <varlistentry>
1691 <listitem> <para>
1692 Audio Compression Manager. The
1694 set msacm.drv to the same.
1695 </para> </listitem>
1696 </varlistentry>
1697 <varlistentry>
1699 <listitem> <para>
1700 Video for Windows. It is safe (and recommended) to try
1702 </para> </listitem>
1703 </varlistentry>
1704 <varlistentry>
1706 <listitem> <para>
1707 CD Audio MCI driver.
1708 </para> </listitem>
1709 </varlistentry>
1710 <varlistentry>
1712 <listitem> <para>
1714 playback).
1715 </para> </listitem>
1716 </varlistentry>
1717 <varlistentry>
1719 <listitem> <para>
1721 </para> </listitem>
1722 </varlistentry>
1723 <varlistentry>
1725 <listitem> <para>
1728 </para> </listitem>
1729 </varlistentry>
1730 <varlistentry>
1732 <listitem> <para>
1733 Animation MCI driver.
1734 </para> </listitem>
1735 </varlistentry>
1736 <varlistentry>
1738 <listitem> <para>
1739 Audio Compression Manager. Set to same as msacm32.
1740 </para> </listitem>
1741 </varlistentry>
1742 <varlistentry>
1744 <listitem> <para>
1745 MIDI Mapper.
1746 </para> </listitem>
1747 </varlistentry>
1748 <varlistentry>
1750 <listitem> <para>
1751 This is a pseudo-DLL used by Wine for thunking
1753 doesn't exist.
1754 </para> </listitem>
1755 </varlistentry>
1756 </variablelist>
1757 </sect2>
1758 </sect1>
1763 <para>
1765 </para>
1766 <para>
1768 </para>
1770 <para>
1771 Wine now needs to know about your keyboard layout. This
1772 requirement comes from a need from many apps to have the
1773 correct scancodes available, since they read these directly,
1774 instead of just taking the characters returned by the X
1775 server. This means that Wine now needs to have a mapping from
1776 X keys to the scancodes these applications expect.
1777 </para>
1778 <para>
1779 On startup, Wine will try to recognize the active X layout by
1780 seeing if it matches any of the defined tables. If it does,
1781 everything is alright. If not, you need to define it.
1782 </para>
1783 <para>
1784 To do this, open the file
1786 at the existing tables. Make a backup copy of it, especially
1787 if you don't use CVS.
1788 </para>
1789 <para>
1790 What you really would need to do, is find out which scancode
1791 each key needs to generate. Find it in the
1793 this:
1794 </para>
1795 <programlisting>
1796 static const int main_key_scan[MAIN_LEN] =
1797 {
1798 /* this is my (102-key) keyboard layout, sorry if it doesn't quite match yours */
1804 };
1805 </programlisting>
1806 <para>
1807 Next, assign each scancode the characters imprinted on the
1808 keycaps. This was done (sort of) for the US 101-key keyboard,
1809 which you can find near the top in
1811 is no 102nd key, you can skip that.
1812 </para>
1813 <para>
1814 However, for most international 102-key keyboards, we have
1815 done it easy for you. The scancode layout for these already
1816 pretty much matches the physical layout in the
1818 to go through all the keys that generate characters on your
1819 main keyboard (except spacebar), and stuff those into an
1820 appropriate table. The only exception is that the 102nd key,
1821 which is usually to the left of the first key of the last line
1823 line after the last line.
1824 </para>
1825 <para>
1826 For example, my Norwegian keyboard looks like this
1827 </para>
1828 <screen>
1829 § ! " # ¤ % & / ( ) = ? ` Back-
1830 | 1 2@ 3£ 4$ 5 6 7{ 8[ 9] 0} + \´ space
1832 Tab Q W E R T Y U I O P Å ^
1833 ¨~
1834 Enter
1835 Caps A S D F G H J K L Ø Æ *
1836 Lock '
1838 Sh- > Z X C V B N M ; : _ Shift
1839 ift < , . -
1841 Ctrl Alt Spacebar AltGr Ctrl
1842 </screen>
1843 <para>
1844 Note the 102nd key, which is the <keycap><></keycap> key, to
1845 the left of <keycap>Z</keycap>. The character to the right of
1846 the main character is the character generated by
1847 <keycap>AltGr</keycap>.
1848 </para>
1849 <para>
1850 This keyboard is defined as follows:
1851 </para>
1852 <programlisting>
1853 static const char main_key_NO[MAIN_LEN][4] =
1854 {
1859 "<>"
1860 };
1861 </programlisting>
1862 <para>
1863 Except that " and \ needs to be quoted with a backslash, and
1864 that the 102nd key is on a separate line, it's pretty
1865 straightforward.
1866 </para>
1867 <para>
1868 After you have written such a table, you need to add it to the
1869 <function>main_key_tab[]</function> layout index table. This
1870 will look like this:
1871 </para>
1872 <programlisting>
1873 static struct {
1874 WORD lang, ansi_codepage, oem_codepage;
1875 const char (*key)[MAIN_LEN][4];
1876 } main_key_tab[]={
1877 ...
1878 ...
1879 {MAKELANGID(LANG_NORWEGIAN,SUBLANG_DEFAULT), 1252, 865, &main_key_NO},
1880 ...
1881 </programlisting>
1882 <para>
1883 After you have added your table, recompile Wine and test that
1884 it works. If it fails to detect your table, try running
1885 </para>
1886 <screen>
1887 wine --debugmsg +key,+keyboard >& key.log
1888 </screen>
1889 <para>
1890 and look in the resulting <filename>key.log</filename> file to
1891 find the error messages it gives for your layout.
1892 </para>
1893 <para>
1894 Note that the <constant>LANG_*</constant> and
1895 <constant>SUBLANG_*</constant> definitions are in
1896 <filename>include/winnls.h</filename>, which you might need to
1897 know to find out which numbers your language is assigned, and
1898 find it in the debugmsg output. The numbers will be
1899 <literal>(SUBLANG * 0x400 + LANG)</literal>, so, for example
1900 the combination <literal>LANG_NORWEGIAN (0x14)</literal> and
1901 <literal>SUBLANG_DEFAULT (0x1)</literal> will be (in hex)
1902 <literal>14 + 1*400 = 414</literal>, so since I'm Norwegian, I
1903 could look for <literal>0414</literal> in the debugmsg output
1904 to find out why my keyboard won't detect.
1905 </para>
1906 <para>
1907 Once it works, submit it to the Wine project. If you use CVS,
1908 you will just have to do
1909 </para>
1910 <screen>
1911 cvs -z3 diff -u windows/x11drv/keyboard.c > layout.diff
1912 </screen>
1913 <para>
1914 from your main Wine directory, then submit
1915 <filename>layout.diff</filename> to
1916 <email>wine-patches@winehq.com</email> along with a brief note
1917 of what it is.
1918 </para>
1919 <para>
1920 If you don't use CVS, you need to do
1921 </para>
1922 <screen>
1923 diff -u the_backup_file_you_made windows/x11drv/keyboard.c > layout.diff
1924 </screen>
1925 <para>
1926 and submit it as explained above.
1927 </para>
1928 <para>
1929 If you did it right, it will be included in the next Wine
1930 release, and all the troublesome applications (especially
1931 remote-control applications) and games that use scancodes will
1932 be happily using your keyboard layout, and you won't get those
1933 annoying fixme messages either.
1934 </para>
1935 <para>
1936 Good luck.
1937 </para>
1938 </sect1>
1940 &fonts;
1941 &printing;
1943 </chapter>
1945 <!-- Keep this comment at the end of the file
1946 Local variables:
1947 mode: sgml
1949 End:
1950 -->