docu patch

Andreas Mohr andi at rhlx01.fht-esslingen.de
Sun Jun 2 09:56:51 CDT 2002


Hi all,

- add "libperl-dev" and "make" requirement to README
- remove HOWTO pointer in README
- much improved Wine drive/Windows configuration description
  (it was awfully lacking)
- reorder configuration descriptions according to their priority
- replace broken DLL archive link
- add Windows/DOS version settings to wine.conf.man (greetings to Alexandre !)
- improve sample config file

-- 
Andreas Mohr                        Stauferstr. 6, D-71272 Renningen, Germany
-------------- next part --------------
Determining best CVS host...
Using CVSROOT :pserver:cvs at rhlx01.fht-esslingen.de:/home/wine
Index: README
===================================================================
RCS file: /home/wine/wine/README,v
retrieving revision 1.35
diff -u -r1.35 README
--- README	9 May 2002 20:37:26 -0000	1.35
+++ README	2 Jun 2002 14:52:28 -0000
@@ -86,10 +86,15 @@
 management. pgcc currently doesn't work with Wine. The cause of this problem
 is unknown.
 
+Of course you also need "make" (most likely GNU make).
+
 You also need flex version 2.5 or later and yacc.
 Bison will work as a replacement for yacc. If you are
 using RedHat or Debian, install the flex and bison packages.
 
+For the automatic processing of the test suite scripts, you also need
+libperl development header support (libperl-dev package on Debian).
+
 For requirements in case you intend to build the documentation yourself,
 see "DOCUMENTATION" section.
 
@@ -121,14 +126,17 @@
 
 5. SETUP
 
+In case a previous Wine installation is already on your PC, don't forget
+to uninstall it before installing this Wine version (unless the previous
+Wine version is an "isolated" install which doesn't conflict with the
+new install).
+Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
+to do so.
+
 Once Wine has been built correctly, you can do "make install"; this
 will install the wine executable, the Wine man page, and a few other
 needed files.
 
-Don't forget to uninstall any conflicting previous Wine installation
-first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
-before installing.
-
 If you want to read the documentation supplied with the Wine source,
 see the "DOCUMENTATION" section.
 
@@ -153,7 +161,10 @@
 As this program is alpha, it doesn't run a truly thorough test yet, though,
 so it should be taken as a first verification step only.
 
-See wine.conf man page on how to switch to text mode only support if desired.
+See wine.conf man page on how to switch to text mode only support
+(i.e.: no X11 output) if desired.
+
+Also, don't forget to read the wine man page !
 
 6. RUNNING PROGRAMS
 
@@ -216,9 +227,6 @@
 	also post bug reports to comp.emulators.ms-windows.wine.
 	Please read the file documentation/bugs.sgml to see what
 	information is required.
-
-HOWTO:	The Wine HOWTO (outdated !) is available at
-	http://www.westfalen.de/witch/wine-HOWTO.txt .
 
 IRC:	Online help is available at channel #WineHQ on irc.openprojects.net.
 
Index: documentation/configuring.sgml
===================================================================
RCS file: /home/wine/wine/documentation/configuring.sgml,v
retrieving revision 1.13
diff -u -r1.13 configuring.sgml
--- documentation/configuring.sgml	8 May 2002 23:14:19 -0000	1.13
+++ documentation/configuring.sgml	2 Jun 2002 14:52:31 -0000
@@ -180,64 +180,77 @@
         <sect3>
           <title>The [Drive X] Section</title>
           <para>
-            It should be pretty self explanatory, but here is an
-            in-depth tutorial about them. There are up to 6 lines for
-            each drive in Wine.
+	    These sections are supposed to make certain Unix
+	    directory locations accessible to Wine as a DOS/Windows drive
+	    (drive 'X:') and thus accessible to Windows programs
+	    under the drive name you specified.
+	    Every DOS/Windows program sort of expects at least a C: drive (and
+	    sometimes also an A: floppy drive), so your config file should
+	    at least contain the corresponding sections, [Drive C] and
+	    [Drive A].
+	    You need to decide on whether you want to use an existing Windows
+	    partition as the C drive or whether you want to create your own
+	    Wine drive C directory tree somewhere (take care about
+	    permissions !).
+            Each drive section may specify up to 6 different settings
+	    as explained below.
           </para>
           <para>
             <programlisting>[Drive X]</programlisting>
-            The above line begins the section for a drive whose letter is X. 
+            The above line begins the section for a drive whose letter is X
+	    (DOS notation: drive 'X:').
+	    You could e.g. create an equivalent to a drive 'C:'
+	    under DOS/Windows by using a [Drive C] section name.
+          </para>
+          <para>
+            <programlisting>"Path" = "/dir/to/path"</programlisting>
+	    This specifies the directory where the drive will begin.
+	    When Wine is browsing in drive X, it will be able
+	    to see the files that are in the directory
+	    <filename>/dir/to/path</filename> and below.
+	    (note that symlinks to directories won't get included !
+	    see "<link linkend="dirsymlinks">ShowDirSymlinks</link>"
+	    config setting)
+	    You can also make use of environment variables like $HOME here,
+	    an example for using a mywinedrive directory in your home dir
+	    would be
+	    "Path" = "${HOME}/mywinedrive"
+	    Don't forget to leave off the trailing slash!
           </para>
           <para>
-            <programlisting>Path=/dir/to/path</programlisting> This
-            path is where the drive will begin. When Wine is browsing
-            in drive X, it will see the files that are in the
-            directory <filename>/dir/to/path</filename>. Don't forget
-            to leave off the trailing slash!
-          </para>
-          <para>
-            <programlisting>"Type" = "floppy|hd|cdrom|network"</programlisting>
+            <programlisting>"Type" = "hd|cdrom|network|floppy"</programlisting>
             Sets up the type of drive Wine will see it as. Type must
             equal one of the four <literal>floppy</literal>,
             <literal>hd</literal>, <literal>cdrom</literal>, or
             <literal>network</literal>. They are self-explanatory.
             (The |'s mean "Type = '&lt;one of the options&gt;'".)
+	    Usually, you choose "hd" for a drive ("hd" is default anyway).
           </para>
           <para>
-            <programlisting>"Label" = "blah"</programlisting> Defines the
-            drive label. Generally only needed for programs that look
-            for a special CD-ROM. Info on finding the lable is in
-            <literal>&lt;dirs to wine>/documentation/cdrom-labels</literal>.
+            <programlisting>"Label" = "blah"</programlisting>
+	    Defines the drive label. Generally only needed
+	    for programs that look for a special CD-ROM.
             The label may be up to 11 characters.
+	    Note that the preferred way of managing labels and serial numbers
+	    of CD-ROMs and floppies is to give Wine raw device access for
+	    reading these on a per-CD case (see "Device" below) instead of
+	    hardcoding one specific "Label".
           </para>
           <para>
             <programlisting>"Serial" = "deadbeef"</programlisting>
             Tells Wine the serial number of the drive. A few programs with
             intense protection for pirating might need this, but otherwise
-            don't use it. Up to 8 characters and hexadecimal.
+            it's not needed. Up to 8 characters and hexadecimal.
+	    Using a "Device" entry instead of hardcoding the "Serial" probably
+	    is a smarter choice.
           </para>
           <para>
-            <programlisting>"Filesystem" = "msdos|win95|unix"</programlisting>
+            <programlisting>"Filesystem" = "win95|unix|msdos"</programlisting>
             Sets up the way Wine looks at files on the drive.
           </para>
 
           <variablelist>
             <varlistentry>
-              <term><literal>msdos</literal></term>
-              <listitem>
-                <para>
-                  Case insensitive filesystem. Alike to DOS and
-                  Windows 3.x. <literal>8.3</literal> is the maximum
-                  length of files (eightdot.123) - longer ones will be
-                  truncated. (NOTE: this is a very bad choice if you
-                  plan on running apps that use long filenames. win95
-                  should work fine with apps that were designed to run
-                  under the msdos system. In other words, you might
-                  not want to use this.)
-                </para>
-              </listitem>
-            </varlistentry>
-            <varlistentry>
               <term><literal>win95</literal></term>
               <listitem>
                 <para>
@@ -260,42 +273,62 @@
                 </para>
               </listitem>
             </varlistentry>
+            <varlistentry>
+              <term><literal>msdos</literal></term>
+              <listitem>
+                <para>
+                  Case insensitive filesystem. Alike to DOS and
+                  Windows 3.x. <literal>8.3</literal> is the maximum
+                  length of files (eightdot.123) - longer ones will be
+                  truncated. (NOTE: this is a very bad choice if you
+                  plan on running apps that use long filenames. win95
+                  should work fine with apps that were designed to run
+                  under the msdos system. In other words, you might
+                  not want to use this.)
+                </para>
+              </listitem>
+            </varlistentry>
           </variablelist>
 
           <programlisting>"Device" = "/dev/xx"</programlisting>
           <para>
+	    Needed for raw device access and label and serial number reading.
             Use this ONLY for floppy and cdrom devices. Using it on
-            Extended2 partitions can have dire results (when a windows
-            app tries to do a lowlevel write, they do it in a FAT way
-            -- FAT does not mix with Extended2).
+            Extended2 or other Unix file systems can have dire results
+	    (when a windows app tries to do a lowlevel write,
+	    they do it in a FAT way -- FAT format is completely different from
+	    any Unix file system).
+	    Also, make sure that you have proper permissions to this device
+	    file.
           </para>
           <note>
             <para>
               This setting is not really important; almost all apps
               will have no problem if it remains unspecified. For
-              CD-ROMs you might want to add it to get automatic label
+              CD-ROMs it's quite useful in order to get automatic label
               detection, though. If you are unsure about specifying
               device names, just leave out this setting for your
               drives.
             </para>
           </note>
           <para>
-            Here is a setup for Drive X, a generic hard drive:
+	    Here are a few sample entries:
             <programlisting>
-[Drive X]
-"Path" = "/dos-a"
+Here is a setup for Drive C, a generic hard drive:
+[Drive C]
+"Path" = "/dosc"
 "Type" = "hd"
 "Label" = "Hard Drive"
 "Filesystem" = "win95"
-This is a setup for Drive X, a generic CD-ROM drive:
-[Drive X]
-"Path" = "/dos-d"
+This is a setup for Drive E, a generic CD-ROM drive:
+[Drive E]
+"Path" = "/mnt/cdrom"
 "Type" = "cdrom"
 "Label" = "Total Annihilation"
 "Filesystem" = "win95"
-"Device" = "/dev/hdc"
-And here is a setup for Drive X, a generic floppy drive:
-[Drive X]
+"Device" = "/dev/cdrom"
+And here is a setup for Drive A, a generic floppy drive:
+[Drive A]
 "Type" = "floppy"
 "Path" = "/mnt/floppy"
 "Label" = "Floppy Drive"
@@ -310,31 +343,41 @@
           <title>The [wine] Section </title>
           <para>
             The [wine] section of the configuration file contains all kinds
-            of general settings for Wine. When specifying the directories
-            for the directory related settings, make them as they would
-            appear in wine. If your drive <medialabel>C</medialabel>
-            has a path of <filename>/dos</filename>, and your
-            <filename>windows</filename> directory is located in
-            <filename>/dos/windows</filename>, then use:
-            <programlisting>"Windows" = "c:\\windows"</programlisting>
-          </para>
+            of general settings for Wine.
+	  </para>
           <para>
-            This sets up the <filename>windows</filename> directory.
+            <programlisting>"Windows" = "c:\\windows"</programlisting>
+            This tells Wine and Windows programs where the <filename>Windows</filename> directory is.
+	    It is recommended to have this directory somewhere
+	    on your configured <medialabel>C</medialabel> drive,
+	    and it's also recommended
+	    to just call the directory "windows"
+	    (this is the default setup on Windows, and some stupid
+	    applications might rely on this).
+	    So in case you chose a "Windows" setting of "c:\\windows"
+	    and you chose to set up a drive C e.g. at
+	    <filename>/usr/local/wine_c</filename>,
+	    the corresponding directory would be
+	    <filename>/usr/local/wine_c/windows</filename>.
             Make one if you don't already have one. NO TRAILING SLASH
             (NOT <filename>C:\\windows\</filename>)!
+	    This is CaSe SeNsItIvE, too!
+	    Write access strongly recommended!
           </para>
           <para>
             <programlisting>"System" = "c:\\windows\\system"</programlisting>
-            This sets up where the windows system files are. Should
-            reside in the directory used for the
-            <literal>Windows</literal> setting. If you don't have
-            <filename>windows</filename> then this is where the system
-            files will go. Again, NO TRAILING SLASH!
+            This sets up where the windows system files are. The Windows
+	    system directory should reside below the directory used for the
+            <literal>Windows</literal> setting.
+	    Thus when using the example above, the system directory would be
+	    <filename>/usr/local/wine_c/windows/system</filename>.
+            Again, no trailing slash, case sensitive and write access!
           </para>
           <para>
             <programlisting>"Temp" = "c:\\temp"</programlisting> This should
-            be the directory you want your temp files stored in. YOU
-            MUST HAVE WRITE ACCESS TO IT.
+            be the directory you want your temp files stored in,
+	    /usr/local/wine_c/temp in our example.
+            Again, no trailing slash, case sensitive and WRITE ACCESS!!
           </para>
           <para>
             <programlisting>
@@ -380,7 +423,7 @@
 	    making use of appropriate shell32.dll functionality to create
 	    icons on the desktop/start menu during installation.
 	  </para>
-	  <para>
+	  <para id="dirsymlinks">
 	    <programlisting>"ShowDirSymlinks" = "1"</programlisting>
 	    Wine doesn't pass directory symlinks to Windows programs by
 	    default, as doing so may crash some programs that do
@@ -957,48 +1000,6 @@
       </sect2>
     </sect1>
 
-    <sect1 id="win95look">
-      <title>Win95/98 Look</title>
-      <para>
-        Written by &name-david-cuthbert; <email>&email-david-cuthbert;</email>
-      </para>
-      <para>
-        (Extracted from <filename>wine/documentation/win95look</filename>)
-      </para>
-      <para>
-        Win95/Win98 interface code is being introduced.
-      </para>
-      <para>
-        Instead of compiling Wine for Win3.1 vs. Win95 using
-        <constant>#define</constant> switches, the code now looks in a
-        special [Tweak.Layout] section of
-        <filename>~/.wine/config</filename> for a
-        <literal>"WineLook" = "Win95"</literal> or
-        <literal>"WineLook" = "Win98"</literal> entry.
-      </para>
-      <para>
-        A few new sections and a number of entries have been added to
-        the <filename>~/.wine/config</filename> file -- these are for
-        debugging the Win95 tweaks only and may be removed in a future
-        release!  These entries/sections are:
-      </para>
-      <programlisting>
-[Tweak.Fonts]
-"System.Height" = "&lt;point size>"    # Sets the height of the system typeface
-"System.Bold" = "[true|false]"      # Whether the system font should be boldfaced
-"System.Italic" = "[true|false]"    # Whether the system font should be italicized
-"System.Underline" = "[true|false]" # Whether the system font should be underlined
-"System.StrikeOut" = "[true|false]" # Whether the system font should be struck out
-"OEMFixed.xxx"                  # Same parameters for the OEM fixed typeface
-"AnsiFixed.xxx"                 # Same parameters for the Ansi fixed typeface
-"AnsiVar.xxx"                   # Same parameters for the Ansi variable typeface
-"SystemFixed.xxx"               # Same parameters for the System fixed typeface
-
-[Tweak.Layout]
-"WineLook" = "[Win31|Win95|Win98]"  # Changes Wine's look and feel
-      </programlisting>
-    </sect1>
-
     <sect1 id="x11drv">
       <title>Configuring the x11drv Driver</title>
 
@@ -1856,6 +1857,51 @@
       </sect2>
     </sect1>
 
+    &fonts;
+    &printing;
+
+    <sect1 id="win95look">
+      <title>Win95/98 Look</title>
+      <para>
+        Written by &name-david-cuthbert; <email>&email-david-cuthbert;</email>
+      </para>
+      <para>
+        (Extracted from <filename>wine/documentation/win95look</filename>)
+      </para>
+      <para>
+        Win95/Win98 interface code is being introduced.
+      </para>
+      <para>
+        Instead of compiling Wine for Win3.1 vs. Win95 using
+        <constant>#define</constant> switches, the code now looks in a
+        special [Tweak.Layout] section of
+        <filename>~/.wine/config</filename> for a
+        <literal>"WineLook" = "Win95"</literal> or
+        <literal>"WineLook" = "Win98"</literal> entry.
+      </para>
+      <para>
+        A few new sections and a number of entries have been added to
+        the <filename>~/.wine/config</filename> file -- these are for
+        debugging the Win95 tweaks only and may be removed in a future
+        release!  These entries/sections are:
+      </para>
+      <programlisting>
+[Tweak.Fonts]
+"System.Height" = "&lt;point size>"    # Sets the height of the system typeface
+"System.Bold" = "[true|false]"      # Whether the system font should be boldfaced
+"System.Italic" = "[true|false]"    # Whether the system font should be italicized
+"System.Underline" = "[true|false]" # Whether the system font should be underlined
+"System.StrikeOut" = "[true|false]" # Whether the system font should be struck out
+"OEMFixed.xxx"                  # Same parameters for the OEM fixed typeface
+"AnsiFixed.xxx"                 # Same parameters for the Ansi fixed typeface
+"AnsiVar.xxx"                   # Same parameters for the Ansi variable typeface
+"SystemFixed.xxx"               # Same parameters for the System fixed typeface
+
+[Tweak.Layout]
+"WineLook" = "[Win31|Win95|Win98]"  # Changes Wine's look and feel
+      </programlisting>
+    </sect1>
+
     <sect1 id="keyboard">
       <title>Keyboard</title>
 
@@ -2035,9 +2081,6 @@
         Good luck.
       </para>
     </sect1>
-
-    &fonts;
-    &printing;
 
   </chapter>
 
Index: documentation/fonts.sgml
===================================================================
RCS file: /home/wine/wine/documentation/fonts.sgml,v
retrieving revision 1.9
diff -u -r1.9 fonts.sgml
--- documentation/fonts.sgml	9 May 2002 20:37:26 -0000	1.9
+++ documentation/fonts.sgml	2 Jun 2002 14:52:32 -0000
@@ -106,7 +106,8 @@
           if you're on FreeBSD you can use the port in
           <filename>/usr/ports/x11-servers/Xfstt</filename>.  And
           there is <command>xfsft</command> which uses the freetype
-          library, see <filename>documentation/ttfserver</filename>).
+          library, see <link linkend="ttfont-server">freetype</link>
+	  description).
         </para>
         <para>
           However, there is a possibility of the native TrueType
Index: documentation/implementation.sgml
===================================================================
RCS file: /home/wine/wine/documentation/implementation.sgml,v
retrieving revision 1.2
diff -u -r1.2 implementation.sgml
--- documentation/implementation.sgml	13 Dec 2000 21:52:37 -0000	1.2
+++ documentation/implementation.sgml	2 Jun 2002 14:52:34 -0000
@@ -397,7 +397,7 @@
 0x37a &gt; 04 @ 0297:0211
       </programlisting>
       <para>
-        As you can see their is a repeating structure starting at
+        As you can see there is a repeating structure starting at
         address <literal>0297:01ec</literal> that consists of four io
         accesses on the parallel port. Looking at it the first io
         access writes a changing byte to the data port the second
Index: documentation/installing.sgml
===================================================================
RCS file: /home/wine/wine/documentation/installing.sgml,v
retrieving revision 1.5
diff -u -r1.5 installing.sgml
--- documentation/installing.sgml	27 Feb 2002 01:30:34 -0000	1.5
+++ documentation/installing.sgml	2 Jun 2002 14:52:35 -0000
@@ -153,8 +153,10 @@
           And there are of course DLLs that wine does not currently
           implement very well (or at all). If you do not have a real
           Windows you can steal necessary DLLs from, you can always
-          get some from a DLL archive such as
-          <ulink url="http://solo.abac.com/dllarchive/">http://solo.abac.com/dllarchive/</ulink>.
+          get some from one of the Windows DLL archive sites
+	  that can be found via internet search engine.
+	  Please make sure to obey any licenses on the DLLs you fetch...
+	  (some are redistributable, some aren't).
         </para>
       </sect2>
     </sect1>
Index: documentation/wine.conf.man
===================================================================
RCS file: /home/wine/wine/documentation/wine.conf.man,v
retrieving revision 1.2
diff -u -r1.2 wine.conf.man
--- documentation/wine.conf.man	27 Feb 2002 01:30:34 -0000	1.2
+++ documentation/wine.conf.man	2 Jun 2002 14:52:35 -0000
@@ -153,6 +153,26 @@
 x11drv (for X11). In case you want to run programs as text console/TTY only
 without having Wine rely on X11 support, then use ttydrv.
 .PP
+.B [Version]
+.br
+.I format: """Windows""=""<version string>"""
+.br
+default: none; chosen by semi-intelligent detection mechanism based on DLL environment
+.br
+Used to specify which Windows version to return to programs (forced value,
+overrides standard detection mechanism !).
+Valid settings are e.g. "win31", "win95", "win98", "win2k", "winxp".
+Also valid as an AppDefaults setting (recommended/preferred use).
+.PP
+.I format: """DOS""=""<version string>"""
+.br
+default: "<Windows version specific>"
+.br
+Used to specify the DOS version that should be returned to programs.
+Only takes effect in case Wine acts as "win31" Windows version !
+Common DOS version settings include 6.22, 6.20, 6.00, 5.00, 4.00, 3.30, 3.10.
+Also valid as an AppDefaults setting (recommended/preferred use).
+.PP
 .B [DllOverrides]
 .br
 .I format: """modulename""=""native,so,builtin"""
Index: documentation/samples/config
===================================================================
RCS file: /home/wine/wine/documentation/samples/config,v
retrieving revision 1.23
diff -u -r1.23 config
--- documentation/samples/config	28 May 2002 22:45:58 -0000	1.23
+++ documentation/samples/config	2 Jun 2002 14:52:35 -0000
@@ -26,6 +26,7 @@
 "Path" = "/mnt/fd0"
 "Type" = "floppy"
 "Label" = "Floppy"
+"Filesystem" = "win95"
 "Serial" = "87654321"
 "Device" = "/dev/fd0"
 
@@ -55,7 +56,15 @@
 "Label" = "Home"
 "Filesystem" = "win95"
 
+;; this silences many "not accessible from a configured DOS drive" messages
+;[Drive U]
+;"Path" = "/usr"
+;"Type" = "hd"
+;"Label" = "usr"
+;"Filesystem" = "win95"
+
 [wine]
+; Warning ! case sensitive directory names here !
 "Windows" = "c:\\windows"
 "System" = "c:\\windows\\system"
 "Temp" = "e:\\"
@@ -129,7 +138,7 @@
 ;;"ScreenDepth" = "16"
 ; Name of X11 display to use
 ;;"Display" = ":0.0"
-; Allow the window manager to manage created windows
+; Allow the window manager to manage created windows (gets overridden by "Desktop" setting !)
 "Managed" = "Y"
 ; Use a desktop window of 640x480 for Wine
 ;"Desktop" = "640x480"
@@ -173,6 +182,13 @@
 ;"DefaultFixed" = "fixed"
 ;"DefaultSerif" = "-cronyx-times-"
 ;"DefaultSansSerif" = "-cronyx-helvetica-"
+
+; the TrueType font dirs you want to make accessible to wine
+[FontDirs]
+;"dir1" = "/usr/X11R6/lib/X11/fonts/TrueType"
+;"dir2" = "/usr/share/fonts/truetype"
+;"dir3" = "/usr/X11R6/lib/X11/fonts/TT"
+;"dir4" = "/usr/share/fonts/TT"
 
 [serialports]
 "Com1" = "/dev/ttyS0"


More information about the wine-patches mailing list