packaging.sgml 84.8 KB
Newer Older
1
<!-- Wine Packaging guidelines.  This is a rough outline only,
John R. Sheets's avatar
John R. Sheets committed
2
     and much of this was up for open debate on wine-devel.  -->
3

John R. Sheets's avatar
John R. Sheets committed
4 5
    <chapter id="pkg-preface"> <title>Preface</title>

6
        <sect1 id="pkg-authors"> <title>Authors</title>
John R. Sheets's avatar
John R. Sheets committed
7 8 9

        <para>
          Written by &name-marcus-meissner; <email>&email-marcus-meissner;</email>
10 11
        </para>
        <para>
John R. Sheets's avatar
John R. Sheets committed
12
          Updated by &name-jeremy-white; <email>&email-jeremy-white;</email>
13 14
        </para>
        <para>
15
          Updated by &name-andreas-mohr; <email>&email-andreas-mohr;</email>
John R. Sheets's avatar
John R. Sheets committed
16
        </para>
17 18 19
        <para>
          Updated by &name-tom-wickline; <email>&email-tom-wickline;</email>
        </para>
John R. Sheets's avatar
John R. Sheets committed
20 21
    </sect1>

22
    <sect1 id="pkg-date"> <title>Document Revision Date</title>
23 24 25


      <para>
John R. Sheets's avatar
John R. Sheets committed
26 27 28
      The information contained in this document is extremely
      time sensitive.  <emphasis>It is vital that a packager
      stay current with changes in Wine. </>
29 30 31 32 33 34
      Changes to this document could be tracked e.g. by viewing its CVS log.
      Due to Wine's fast development, a recent revision date
      does not necessarily indicate that this document is 100% on par
      with what Wine's full installation requirements are
      (especially whenever lazy developers don't properly update the
      documentation to include info about new features they implemented).
35 36
      </para>
      <para>
37
      This document was last revised on January 16, 2003.</para>
38

John R. Sheets's avatar
John R. Sheets committed
39
      </sect1>
40

41
    <sect1 id="pkg-terms"> <title>Terms used in this document</title>
John R. Sheets's avatar
John R. Sheets committed
42 43 44 45

        <para>There are several terms and paths used in this
        document as place holders for configurable values.
        Those terms are described here.
46 47
        </para>

John R. Sheets's avatar
John R. Sheets committed
48 49 50
        <orderedlist>
            <listitem id=WINECONFDIR><para id=wineconfdir.id><EnVar>WINECONFDIR</EnVar></para>
                <para>
51
                <envar>WINECONFDIR</envar> is the user's Wine configuration directory.
John R. Sheets's avatar
John R. Sheets committed
52 53 54 55 56
                This is almost always ~/.wine, but can be overridden
                by the user by setting the <EnVar>WINECONFDIR</EnVar> environment
                variable.
                </para>
            </listitem>
57

John R. Sheets's avatar
John R. Sheets committed
58 59 60
            <listitem id=PREFIX><para id=prefix.id><EnVar>PREFIX</EnVar></para>
                <para>
                <envar>PREFIX</envar> is the prefix used when selecting
61
                an installation target.  The current default is /usr/local.
John R. Sheets's avatar
John R. Sheets committed
62 63 64
                This results in binary installation into /usr/bin,
                library installation into /usr/wine/lib, and so forth.
                This value can be overridden by the packager.
65
                In fact, <ulink url="http://www.pathname.com/fhs/">FHS 2.2</ulink>
John R. Sheets's avatar
John R. Sheets committed
66 67 68 69 70 71 72 73 74 75 76
                specifications suggest that a better
                prefix is /opt/wine.  Ideally, a packager would also
                allow the installer to override this value.
                </para>
            </listitem>

            <listitem id=ETCDIR><para id=etcdir.id><EnVar>ETCDIR</EnVar></para>
                <para>
                <envar>ETCDIR</envar> is the prefix that Wine uses
                to find the global configuration directory.
                This can be changed by the configure option sysconfdir.
77
                The current default is $prefix/etc.
John R. Sheets's avatar
John R. Sheets committed
78 79 80 81 82 83 84 85 86 87 88 89
                </para>
            </listitem>

            <listitem id=WINDOWSDIR><para id=windowsdir.id><EnVar>WINDOWSDIR</EnVar></para>
                <para>
                <envar>WINDOWSDIR</envar> is an important concept
                to Wine.  This directory specifies what directory
                corresponds to the root Windows directory
                (e.g. C:\WINDOWS).
                </para>
                <para>
                This directory is specified by the user, in
90
                the user's <link linkend=winerc>configuration file</link>.
John R. Sheets's avatar
John R. Sheets committed
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
                </para>
                <para>
                Generally speaking, this directory is either set
                to point at an empty directory, or it is set
                to point at a Windows partition that has been
                mounted through the vfat driver.
                </para>
                <para>
                <emphasis>It is extremely important that the packager
                understand the importance of <envar>WINDOWSDIR</envar>
                and convey this information and choice to the end
                user</emphasis>.
                </para>
            </listitem>

        </orderedlist>


    </sect1>

  </chapter>



    <chapter id="pkg-introduction"> <title>Introduction</title>

    <para>
        This document attempts to establish guidelines
        for people making binary packages of Wine.
    </para>

    <para>
        It expresses the basic principles that the
        Wine developers have agreed should be
125
        used when building Wine.
John R. Sheets's avatar
John R. Sheets committed
126 127 128 129 130 131 132
        It also attempts to highlight the areas
        where there are different approaches
        to packaging Wine, so that the packager
        can understand the different alternatives
        that have been considered and their rationales.
    </para>

133
        <sect1 id="pkg-goals"> <title>Goals</title>
John R. Sheets's avatar
John R. Sheets committed
134
        <para>
135
            An installation from a Wine package should:
John R. Sheets's avatar
John R. Sheets committed
136
        </para>
137
          <itemizedlist>
John R. Sheets's avatar
John R. Sheets committed
138

139
            <listitem>
John R. Sheets's avatar
John R. Sheets committed
140 141 142 143 144
                <para>
                Install quickly and simply.
                </para>
                <para>
                The initial installation should require no user
145
                input.  An rpm -i wine.rpm or apt-get install wine
John R. Sheets's avatar
John R. Sheets committed
146 147
                should suffice for initial installation.
                </para>
148
            </listitem>
John R. Sheets's avatar
John R. Sheets committed
149

150
            <listitem>
John R. Sheets's avatar
John R. Sheets committed
151 152 153 154 155 156 157
                <para>
                Work quickly and simply
                </para>
                <para>
                The user should be able to launch Solitaire
                within minutes of downloading the Wine package.
                </para>
158
            </listitem>
John R. Sheets's avatar
John R. Sheets committed
159

160 161
            <listitem>
              <para>
162
              Comply with Filesystem Hierarchy Standard
John R. Sheets's avatar
John R. Sheets committed
163 164 165
              </para>
              <para>
              A Wine installation should, as much as possible, comply
166
              with the
John R. Sheets's avatar
John R. Sheets committed
167
                <ulink url="http://www.pathname.com/fhs/">FHS standard</ulink>.
168 169
              </para>
            </listitem>
John R. Sheets's avatar
John R. Sheets committed
170 171 172 173 174 175 176

            <listitem>
                <para>
                Preserve flexibility
                </para>
                <para>
                None of the flexibility built into Wine should
177
                be hidden from the end user.
John R. Sheets's avatar
John R. Sheets committed
178 179 180
                </para>
            </listitem>

181 182 183 184 185 186
            <listitem>
              <para>
                Come as preconfigured as possible, so the user does
                not need to change any configuration files.
              </para>
            </listitem>
John R. Sheets's avatar
John R. Sheets committed
187

188 189 190
            <listitem>
              <para>Use only as much diskspace as needed per user.</para>
            </listitem>
John R. Sheets's avatar
John R. Sheets committed
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205

            <listitem>
              <para>
              Reduce support requirements.
              </para>
              <para>
              A packaged version of Wine should be sufficiently easy
              to use and have quick and easy access to FAQs and
              documentation such that requests to the
              newsgroup and development group go down.
              Further, it should be easy for users to capture
              good bug reports.
              </para>
            </listitem>

206 207
          </itemizedlist>

John R. Sheets's avatar
John R. Sheets committed
208 209 210

        </sect1>

211
        <sect1 id="pkg-requirements"> <title>Requirements</title>
John R. Sheets's avatar
John R. Sheets committed
212 213 214 215
      <para>
        Successfully installing Wine requires:
      </para>

216
        <itemizedlist>
John R. Sheets's avatar
John R. Sheets committed
217 218 219 220
        <listitem>
          <para>Much thought and work from the packager (1x)</para>
        </listitem>
        <listitem>
221
          <para>
John R. Sheets's avatar
John R. Sheets committed
222
          A configuration file
223
          </para>
John R. Sheets's avatar
John R. Sheets committed
224
          <para>
225 226 227 228
          Wine will not run without a configuration file.  Wine provides a
          a sample config file and it can be found in /usr/share/doc/wine/samples.
          Some packagers may attempt to provide (or dynamically generate) a default configuration
          file.  Some packagers may wish to rely on winesetup to generate the configuration file.
John R. Sheets's avatar
John R. Sheets committed
229 230 231
          </para>
        </listitem>

232 233 234 235

            <listitem>
              <para>
                A writeable <filename>C:\</filename> directory
236
                structure on a per-user basis. Applications do dump
237 238 239
                <filename>.ini</filename> files into
                <filename>c:\windows</filename>, installers dump
                <filename>.exe</filename>, <filename>.dll</filename>
240 241
                and more into <filename>c:\windows</filename> and
                subdirectories or into <filename>C:\Program Files</filename>.
242 243
              </para>
            </listitem>
John R. Sheets's avatar
John R. Sheets committed
244 245


246 247
            <listitem>
              <para>
John R. Sheets's avatar
John R. Sheets committed
248
                An initial set of registry entries.
249
              </para>
John R. Sheets's avatar
John R. Sheets committed
250
                <para>
251
                The current Wine standard is to use the regedit tool
John R. Sheets's avatar
John R. Sheets committed
252 253 254
                against the 'winedefault.reg' file to generate
                a default registry.
                </para>
255 256 257
                <para> 
                The current preferred method of configuring/installing
                Wine is to run /toos/wineinstall.
John R. Sheets's avatar
John R. Sheets committed
258 259 260
                There are several other choices that could be made;
                registries can be imported from a Windows partition.
                At this time, Wine does not completely support
261
                a complex multi-user installation ala Windows NT,
John R. Sheets's avatar
John R. Sheets committed
262 263
                but it could fairly readily.
                </para>
264
            </listitem>
John R. Sheets's avatar
John R. Sheets committed
265 266


267 268 269 270 271 272 273 274
            <listitem>
              <para>
                Some special <filename>.dll</filename> and
                <filename>.exe</filename> files in the
                <filename>windows\system</filename> directory, since
                applications directly check for their presence.
              </para>
            </listitem>
John R. Sheets's avatar
John R. Sheets committed
275 276 277 278 279 280 281 282 283 284
          </itemizedlist>

        </sect1>


    </chapter>




285
    <chapter id="pkg-components"><title>Wine Components</title>
John R. Sheets's avatar
John R. Sheets committed
286 287 288 289 290

    <para>
        This section lists all files that pertain to Wine.
    </para>

291
        <sect1 id="pkg-static"><title>Wine Static and Shareable Files</title>
John R. Sheets's avatar
John R. Sheets committed
292 293

        <para>
294
        At the time of this writing, almost all of the following components
John R. Sheets's avatar
John R. Sheets committed
295
        are installed through a standard 'make install'
296
        of Wine. Exceptions from the rule are noted.
John R. Sheets's avatar
John R. Sheets committed
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332

        <caution>
        <para>
        It is vital that a packager check for
        changes in Wine.  This list will likely be out
        of date by the time this document is committed to CVS.
        </para>
        </caution>

        </para>

        <orderedlist>

            <listitem id=binfiles>
                <variablelist><title>Executable Files</title>

                  <varlistentry><term><filename>wine</filename></term>
                    <listitem>
                    <para>
                    The main Wine executable.  This program will load
                    a Windows binary and run it, relying upon
                    the Wine shared object libraries.
                    </para>
                    </listitem>
                  </varlistentry>

                  <varlistentry><term><filename>wineserver</filename></term>
                    <listitem>
                    <para>
                    The Wine server is critical to Wine; it is the
                    process that coordinates all shared Windows
                    resources.
                    </para>
                    </listitem>
                  </varlistentry>

333
                  <varlistentry><term><filename>wineboot</filename></term>
334 335 336 337 338 339 340
                    <listitem>
                    <para>
		    Winelib app to be found in programs/.
		    Its purpose is to process all Windows startup autorun
		    mechanisms, such as wininit.ini, win.ini Load=/Run=,
		    registry keys: RenameFiles/Run/RunOnce*/RunServices*,
		    Startup folders.
341 342 343 344 345 346
		    It'll be called by Wine automatically when an application
                    requests a restart of the system (presumeably - after
                    installation).
                    It should also be called once when a session starts to
                    run the various session start utilities (will not happen
                    automatically). To start a session, invoke "wineboot start".
347 348 349 350
                    </para>
                    </listitem>
                  </varlistentry>

John R. Sheets's avatar
John R. Sheets committed
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
                  <varlistentry><term><filename>wineclipsrv</filename></term>
                    <listitem>
                    <para>
                    The Wine Clipboard Server is a standalone XLib
                    application whose purpose is to manage the X selection
                    when Wine exits.
                    </para>
                    </listitem>
                  </varlistentry>

                  <varlistentry><term><filename>winedbg</filename></term>
                    <listitem>
                    <para>
                    Winedbg is the Wine built in debugger.
                    </para>
                    </listitem>
                  </varlistentry>

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
                  <varlistentry><term><filename>winelauncher</filename></term>
                    <listitem>
                    <para>
		    (not getting installed via make install)
		    A wine wrapper shell script that intelligently handles
		    wine invocation by informing the user about what's going
		    on, among other things.
		    To be found in tools/ directory.
		    Use of this wrapper script instead of directly using wine
		    is strongly encouraged, as it not only improves the user
		    interface, but also adds important functionality to wine,
		    such as session bootup/startup actions.
		    If you intend to use this script, then you might want to
		    rename the wine executable to e.g. wine.bin and
		    winelauncher to wine.
                    the <link linkend=WINECONFDIR endterm=wineconfdir.id></link>/config file.
                    </para>
                    </listitem>
                  </varlistentry>

                  <varlistentry><term><filename>winesetup</filename></term>
John R. Sheets's avatar
John R. Sheets committed
390 391 392 393 394 395 396 397 398 399 400 401 402
                    <listitem>
                    <para>
                    This is a Tcl/Tk based front end that provides
                    a user friendly tool to edit and configure
                    the <link linkend=WINECONFDIR endterm=wineconfdir.id></link>/config file.
                    </para>
                    </listitem>
                  </varlistentry>

                  <varlistentry><term><filename>wineshelllink</filename></term>
                    <listitem>
                    <para>
                    This shell script can be called by Wine in order
403
                    to propagate Desktop icon and menu creation
John R. Sheets's avatar
John R. Sheets committed
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
                    requests out to a GNOME or KDE (or other
                    Window Managers).
                    </para>
                    </listitem>
                  </varlistentry>

                  <varlistentry><term><filename>winebuild</filename></term>
                    <listitem>
                    <para>
                    Winebuild is a tool used for Winelib applications
                    (and by Wine itself) to allow a developer to
                    compile a .spec file into a .spec.c file.
                    </para>
                    </listitem>
                  </varlistentry>
                  <varlistentry><term><filename>wmc</filename></term>
                    <listitem>
                    <para>
                    The wmc tools is the Wine Message Compiler.  It
                    allows Windows message files to be compiled
                    into a format usable by Wine.
                    </para>
                    </listitem>
                  </varlistentry>
                  <varlistentry><term><filename>wrc</filename></term>
                    <listitem>
                    <para>
                    The wrc tool is the Wine Resource Compiler.
                    It allows Winelib programmers (and Wine itself)
                    to compile Windows style resource files
                    into a form usable by Wine.
                    </para>
                    </listitem>
                  </varlistentry>
                  <varlistentry><term><filename>fnt2bdf</filename></term>
                    <listitem>
                    <para>
                    The fnt2bdf utility extracts fonts from .fnt or
442
                    .dll files and stores them in .bdf format files.
John R. Sheets's avatar
John R. Sheets committed
443 444 445 446 447 448 449 450 451 452 453
                    </para>
                    </listitem>
                  </varlistentry>
                  <varlistentry><term><filename>dosmod</filename></term>
                    <listitem>
                    <para>
                    DOS Virtual Machine.
                    </para>
                    </listitem>
                  </varlistentry>

454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
                  <varlistentry><term><filename>uninstaller</filename></term>
                    <listitem>
                    <para>
		    (not getting installed via make install)
                    A Winelib program to uninstall installed Windows programs.
		    To be found in the programs/ source directory.
		    This program can be used to uninstall most Windows programs
		    (just like the Add/Remove Programs item in Windows)
		    by taking the registry uninstall strings that get created
		    by installers such as InstallShield or WISE.
		    In binary packages, it should probably be renamed
		    to something like wine-uninstaller for consistency's sake.
                    </para>
                    </listitem>
                  </varlistentry>

John R. Sheets's avatar
John R. Sheets committed
470 471 472 473
                </variablelist>
            </listitem>

        <listitem id=libfiles>
474 475
        <para>Shared Object Library Files</para>
	<para>This list may NOT necessarily current!</para>
John R. Sheets's avatar
John R. Sheets committed
476 477

        <simplelist columns=5>
478 479 480 481
<member>advapi32.dll.so</>
<member>avicap32.dll.so</>
<member>avifil32.dll.so</>
<member>avifile.dll.so</>
482 483 484 485
<member>aviinfo.exe.so</>
<member>aviplay.exe.so</>
<member>clock.exe.so </>
<member>comcat.dll.so</>
486 487 488 489 490
<member>comctl32.dll.so</>
<member>comdlg32.dll.so</>
<member>comm.dll.so</>
<member>commdlg.dll.so</>
<member>compobj.dll.so</>
491
<member>control.exe.so</>
492 493 494 495 496 497 498
<member>crtdll.dll.so</>
<member>crypt32.dll.so</>
<member>dciman32.dll.so</>
<member>ddeml.dll.so</>
<member>ddraw.dll.so</>
<member>devenum.dll.so</>
<member>dinput.dll.so</>
499
<member>dinput8.dll.so</>
500 501 502 503 504
<member>dispdib.dll.so</>
<member>display.dll.so</>
<member>dplay.dll.so</>
<member>dplayx.dll.so</>
<member>dsound.dll.so</>
505
<member>expand.exe.so</>
506 507 508 509 510 511
<member>gdi.exe.so</>
<member>gdi32.dll.so</>
<member>glu32.dll.so</>
<member>icmp.dll.so</>
<member>imaadp32.acm.so</>
<member>imagehlp.dll.so</>
512 513 514 515
<member>icinfo.exe.so</>
<member>icmp.dll.so</>
<member>imaadp32.acm.so</>
<member>imagehlp.dll.so</>
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
<member>imm.dll.so</>
<member>imm32.dll.so</>
<member>joystick.drv.so</>
<member>kernel32.dll.so</>
<member>keyboard.dll.so</>
<member>krnl386.exe.so</>
<member>libgdi32.dll.so</>
<member>libkernel32.dll.so</>
<member>libntdll.dll.so</>
<member>libuser32.dll.so</>
<member>libwine.so</>
<member>libwine_tsx11.so</>
<member>libwine_unicode.so</>
<member>libwinspool.drv.so</>
<member>lz32.dll.so</>
<member>lzexpand.dll.so</>
<member>mapi32.dll.so</>
<member>mcianim.drv.so</>
<member>mciavi.drv.so</>
<member>mcicda.drv.so</>
<member>mciseq.drv.so</>
<member>mciwave.drv.so</>
<member>midimap.drv.so</>
<member>mmsystem.dll.so</>
<member>mouse.dll.so</>
<member>mpr.dll.so</>
<member>msacm.dll.so</>
<member>msacm.drv.so</>
<member>msacm32.dll.so</>
<member>msdmo.dll.so</>
<member>msg711.drv.so</>
<member>msimg32.dll.so</>
548 549 550 551 552 553 554
<member>msacm.drv.so</>
<member>msnet32.dll.so</>
<member>msrle32.dll.so</>
<member>msdmo.dll.so</>
<member>msg711.acm.so</>
<member>msimg32.dll.so</>
<member>msisys.ocx.so</>
555 556 557 558 559 560 561
<member>msnet32.dll.so</>
<member>msrle32.dll.so</>
<member>msvcrt.dll.so</>
<member>msvcrt20.dll.so</>
<member>msvfw32.dll.so</>
<member>msvideo.dll.so</>
<member>netapi32.dll.so</>
562
<member>notepad.exe.so</>
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
<member>ntdll.dll.so</>
<member>odbc32.dll.so</>
<member>ole2.dll.so</>
<member>ole2conv.dll.so</>
<member>ole2disp.dll.so</>
<member>ole2nls.dll.so</>
<member>ole2prox.dll.so</>
<member>ole2thk.dll.so</>
<member>ole32.dll.so</>
<member>oleaut32.dll.so</>
<member>olecli.dll.so</>
<member>olecli32.dll.so</>
<member>oledlg.dll.so</>
<member>olepro32.dll.so</>
<member>olesvr.dll.so</>
<member>olesvr32.dll.so</>
<member>opengl32.dll.so</>
580 581
<member>osversioncheck.exe.so</>
<member>progman.exe.so</>
582 583 584 585 586
<member>psapi.dll.so</>
<member>qcap.dll.so</>
<member>quartz.dll.so</>
<member>rasapi16.dll.so</>
<member>rasapi32.dll.so</>
587 588 589 590
<member>regapi.exe.so</>
<member>regedit.exe.so </>
<member>regsvr32.exe.so</>
<member>regtest.exe.so</>
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
<member>riched32.dll.so</>
<member>rpcrt4.dll.so</>
<member>serialui.dll.so</>
<member>setupapi.dll.so</>
<member>setupx.dll.so</>
<member>shdocvw.dll.so</>
<member>shell.dll.so</>
<member>shell32.dll.so</>
<member>shfolder.dll.so</>
<member>shlwapi.dll.so</>
<member>sound.dll.so</>
<member>sti.dll.so</>
<member>storage.dll.so</>
<member>stress.dll.so</>
<member>system.dll.so</>
<member>tapi32.dll.so</>
<member>toolhelp.dll.so</>
<member>ttydrv.dll.so</>
<member>twain_32.dll.so</>
<member>typelib.dll.so</>
611
<member>uninstaller.exe.so</>
612 613 614 615 616 617 618 619 620 621 622 623
<member>url.dll.so</>
<member>urlmon.dll.so</>
<member>user.exe.so</>
<member>user32.dll.so</>
<member>ver.dll.so</>
<member>version.dll.so</>
<member>w32skrnl.dll.so</>
<member>w32sys.dll.so</>
<member>win32s16.dll.so</>
<member>win87em.dll.so</>
<member>winaspi.dll.so</>
<member>windebug.dll.so</>
624
<member>winealsa.drv.so</>
625
<member>winearts.drv.so</>
626 627
<member>wineconsole.exe.so</>
<member>winedbg.exe.so</>
628
<member>winedos.dll.so</>
629 630 631
<member>winefile.exe.so</>
<member>winemine.exe.so</>
<member>winemp3.acm.so</>
632
<member>wineoss.drv.so</>
633
<member>winepath.exe.so</>
634 635 636
<member>wineps.dll.so</>
<member>wineps16.dll.so</>
<member>wing.dll.so</>
637
<member>winhelp.exe.so</>
638 639 640 641 642 643 644 645 646 647 648 649 650
<member>wininet.dll.so</>
<member>winmm.dll.so</>
<member>winnls.dll.so</>
<member>winnls32.dll.so</>
<member>winsock.dll.so</>
<member>winspool.drv.so</>
<member>wintrust.dll.so</>
<member>wnaspi32.dll.so</>
<member>wow32.dll.so</>
<member>wprocs.dll.so</>
<member>ws2_32.dll.so</>
<member>wsock32.dll.so</>
<member>x11drv.dll.so</>
John R. Sheets's avatar
John R. Sheets committed
651 652 653 654 655 656 657 658 659
        </simplelist>

        </listitem>


            <listitem id=manfiles>
            <para> Man Pages</para>
                <simplelist columns=1>
<member>wine.conf.man</>
660 661
<member>wine.man</>
<member>winemaker</>
John R. Sheets's avatar
John R. Sheets committed
662 663
<member>wmc.man</>
<member>wrc.man</>
664 665
                </simplelist>
            </listitem>
John R. Sheets's avatar
John R. Sheets committed
666 667 668


            <listitem id=includefiles>
669 670
            <para>Include Files</para>
	    <para>This list may NOT be current!</para>
John R. Sheets's avatar
John R. Sheets committed
671 672
                <simplelist columns=5>

673
<member>audevcod.h</>
John R. Sheets's avatar
John R. Sheets committed
674 675 676
<member>basetsd.h</>
<member>cderr.h</>
<member>cguid.h</>
677
<member>comcat.h</>
John R. Sheets's avatar
John R. Sheets committed
678 679 680
<member>commctrl.h</>
<member>commdlg.h</>
<member>compobj.h</>
681
<member>cpl.h</>
John R. Sheets's avatar
John R. Sheets committed
682 683 684 685 686 687 688 689 690 691 692
<member>d3d.h</>
<member>d3dcaps.h</>
<member>d3dtypes.h</>
<member>d3dvec.inl</>
<member>dde.h</>
<member>ddeml.h</>
<member>ddraw.h</>
<member>digitalv.h</>
<member>dinput.h</>
<member>dispdib.h</>
<member>dlgs.h</>
693 694 695
<member>dmo.h</>
<member>dmoreg.h</>
<member>dmort.h</>
John R. Sheets's avatar
John R. Sheets committed
696 697 698
<member>docobj.h</>
<member>dplay.h</>
<member>dplobby.h</>
699
<member>dshow.h</>
John R. Sheets's avatar
John R. Sheets committed
700 701 702 703 704 705 706 707
<member>dsound.h</>
<member>guiddef.h</>
<member>imagehlp.h</>
<member>imm.h</>
<member>initguid.h</>
<member>instance.h</>
<member>lmcons.h</>
<member>lzexpand.h</>
708 709
<member>mapi.h</>
<member>mapicode.h</>
John R. Sheets's avatar
John R. Sheets committed
710
<member>mapidefs.h</>
711
<member>mciavi.h</>
John R. Sheets's avatar
John R. Sheets committed
712
<member>mcx.h</>
713 714 715
<member>mediaerr.h</>
<member>mediaobj.h</>
<member>minmax.h</>
John R. Sheets's avatar
John R. Sheets committed
716 717 718
<member>mmreg.h</>
<member>mmsystem.h</>
<member>msacm.h</>
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
<member>msacmdlg.h</>
<member>msvcrt/conio.h</>
<member>msvcrt/crtdbg.h</>
<member>msvcrt/ctype.h</>
<member>msvcrt/direct.h</>
<member>msvcrt/dos.h</>
<member>msvcrt/eh.h</>
<member>msvcrt/excpt.h</>
<member>msvcrt/fcntl.h</>
<member>msvcrt/io.h</>
<member>msvcrt/locale.h</>
<member>msvcrt/malloc.h</>
<member>msvcrt/mbctype.h</>
<member>msvcrt/mbstring.h</>
<member>msvcrt/process.h</>
<member>msvcrt/search.h</>
<member>msvcrt/setjmp.h</>
<member>msvcrt/share.h</>
<member>msvcrt/stddef.h</>
<member>msvcrt/stdio.h</>
<member>msvcrt/stdlib.h</>
<member>msvcrt/string.h</>
<member>msvcrt/sys/locking.h</>
<member>msvcrt/sys/stat.h</>
<member>msvcrt/sys/timeb.h</>
<member>msvcrt/sys/types.h</>
<member>msvcrt/sys/utime.h</>
<member>msvcrt/time.h</>
<member>msvcrt/wchar.h</>
<member>msvcrt/wctype.h</>
<member>mswsock.h</>
<member>nb30.h</>
<member>nspapi.h</>
John R. Sheets's avatar
John R. Sheets committed
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
<member>ntsecapi.h</>
<member>oaidl.h</>
<member>objbase.h</>
<member>objidl.h</>
<member>ocidl.h</>
<member>ole2.h</>
<member>ole2ver.h</>
<member>oleauto.h</>
<member>olectl.h</>
<member>oledlg.h</>
<member>oleidl.h</>
<member>poppack.h</>
<member>prsht.h</>
<member>psapi.h</>
<member>pshpack1.h</>
<member>pshpack2.h</>
<member>pshpack4.h</>
<member>pshpack8.h</>
<member>ras.h</>
<member>regstr.h</>
<member>richedit.h</>
<member>rpc.h</>
774 775 776 777 778
<member>rpcdce.h</>
<member>rpcdcep.h</>
<member>rpcndr.h</>
<member>rpcnterr.h</>
<member>rpcproxy.h</>
John R. Sheets's avatar
John R. Sheets committed
779
<member>servprov.h</>
780
<member>setupapi.h</>
John R. Sheets's avatar
John R. Sheets committed
781 782 783 784 785 786 787 788 789 790 791 792
<member>shellapi.h</>
<member>shlguid.h</>
<member>shlobj.h</>
<member>shlwapi.h</>
<member>sql.h</>
<member>sqlext.h</>
<member>sqltypes.h</>
<member>storage.h</>
<member>tapi.h</>
<member>tlhelp32.h</>
<member>unknwn.h</>
<member>urlmon.h</>
793
<member>uuids.h</>
John R. Sheets's avatar
John R. Sheets committed
794 795
<member>ver.h</>
<member>vfw.h</>
796
<member>vfwmsgs.h</>
John R. Sheets's avatar
John R. Sheets committed
797 798 799 800 801 802
<member>winbase.h</>
<member>wincon.h</>
<member>wincrypt.h</>
<member>windef.h</>
<member>windows.h</>
<member>windowsx.h</>
803
<member>wine/debug.h</>
John R. Sheets's avatar
John R. Sheets committed
804 805 806
<member>wine/exception.h</>
<member>wine/icmpapi.h</>
<member>wine/ipexport.h</>
807
<member>wine/library.h</>
John R. Sheets's avatar
John R. Sheets committed
808 809 810 811
<member>wine/obj_base.h</>
<member>wine/obj_cache.h</>
<member>wine/obj_channel.h</>
<member>wine/obj_clientserver.h</>
812
<member>wine/obj_comcat.h</>
John R. Sheets's avatar
John R. Sheets committed
813 814 815 816 817 818 819
<member>wine/obj_commdlgbrowser.h</>
<member>wine/obj_connection.h</>
<member>wine/obj_contextmenu.h</>
<member>wine/obj_control.h</>
<member>wine/obj_dataobject.h</>
<member>wine/obj_dockingwindowframe.h</>
<member>wine/obj_dragdrop.h</>
820
<member>wine/obj_enumguid.h</>
John R. Sheets's avatar
John R. Sheets committed
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
<member>wine/obj_enumidlist.h</>
<member>wine/obj_errorinfo.h</>
<member>wine/obj_extracticon.h</>
<member>wine/obj_inplace.h</>
<member>wine/obj_marshal.h</>
<member>wine/obj_misc.h</>
<member>wine/obj_moniker.h</>
<member>wine/obj_oleaut.h</>
<member>wine/obj_olefont.h</>
<member>wine/obj_oleobj.h</>
<member>wine/obj_oleundo.h</>
<member>wine/obj_oleview.h</>
<member>wine/obj_picture.h</>
<member>wine/obj_property.h</>
<member>wine/obj_propertystorage.h</>
<member>wine/obj_queryassociations.h</>
837
<member>wine/obj_serviceprovider.h</>
John R. Sheets's avatar
John R. Sheets committed
838 839 840 841 842 843
<member>wine/obj_shellbrowser.h</>
<member>wine/obj_shellextinit.h</>
<member>wine/obj_shellfolder.h</>
<member>wine/obj_shelllink.h</>
<member>wine/obj_shellview.h</>
<member>wine/obj_storage.h</>
844
<member>wine/obj_webbrowser.h</>
John R. Sheets's avatar
John R. Sheets committed
845 846 847 848 849 850 851 852 853
<member>wine/unicode.h</>
<member>winerror.h</>
<member>wingdi.h</>
<member>wininet.h</>
<member>winioctl.h</>
<member>winnetwk.h</>
<member>winnls.h</>
<member>winnt.h</>
<member>winreg.h</>
854
<member>winres.h</>
John R. Sheets's avatar
John R. Sheets committed
855 856 857 858 859 860 861 862 863
<member>winresrc.h</>
<member>winsock.h</>
<member>winsock2.h</>
<member>winspool.h</>
<member>winsvc.h</>
<member>winuser.h</>
<member>winver.h</>
<member>wnaspi32.h</>
<member>wownt32.h</>
864 865 866 867
<member>ws2spi.h</>
<member>ws2tcpip.h</>
<member>wshisotp.h</>
<member>wsipx.h</>
John R. Sheets's avatar
John R. Sheets committed
868 869
<member>wtypes.h</>
<member>zmouse.h</>
870
<member>libwine_uuid.a</>
John R. Sheets's avatar
John R. Sheets committed
871 872 873 874 875
        </simplelist>

        </listitem>

        <listitem id=docfiles>
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
        <para>Documentation files.</para>
    	<para>This list may NOT be current!</para>

        <simplelist columns=3>

<member>HOWTO-winelib.gz</>
<member>wine-devel-20020710/wine-devel</>
<member>wine-devel/accel-impl.html</>
<member>wine-devel/arch-dlls.html</>
<member>wine-devel/architecture.html</>
<member>wine-devel/build.html</>
<member>wine-devel/com-writing.html</>
<member>wine-devel/compiling.html</>
<member>wine-devel/consoles.html</>
<member>wine-devel/cvs-regression.html</>
<member>wine-devel/dbg-channels.html</>
<member>wine-devel/dbg-checking.html</>
<member>wine-devel/dbg-commands.html</>
<member>wine-devel/dbg-compiling.html</>
<member>wine-devel/dbg-config.html</>
<member>wine-devel/dbg-in-memory.html</>
<member>wine-devel/dbg-limits.html</>
<member>wine-devel/dbg-modes.html</>
<member>wine-devel/dbg-notes.html</>
<member>wine-devel/dbg-others.html</>
<member>wine-devel/dbg-param.html</>
<member>wine-devel/dbg-resource-ids.html</>
<member>wine-devel/dbg-using.html</>
<member>wine-devel/debugger.html</>
<member>wine-devel/debugging.html</>
<member>wine-devel/dlls.html</>
<member>wine-devel/documentation.html</>
<member>wine-devel/file-handles.html</>
<member>wine-devel/hardware-trace.html</>
<member>wine-devel/i18n.html</>
<member>wine-devel/implementation.html</>
<member>wine-devel/index.html</>
<member>wine-devel/memory-addresses.html</>
<member>wine-devel/module-overview.html</>
<member>wine-devel/ole-binary.html</>
<member>wine-devel/ole.html</>
<member>wine-devel/opengl-configure.html</>
<member>wine-devel/opengl-problems.html</>
<member>wine-devel/opengl-works.html</>
<member>wine-devel/opengl.html</>
<member>wine-devel/os2-wine.html</>
<member>wine-devel/part-one.html</>
<member>wine-devel/part-three.html</>
<member>wine-devel/part-two.html</>
<member>wine-devel/patch-quality.html</>
<member>wine-devel/patches.html</>
<member>wine-devel/porting.html</>
<member>wine-devel/tools.html</>
<member>wine-devel/wine-debugger.html</>
<member>wine-devel/wine-docbook.html</>
<member>winelib-user/bindlls-building.html</>
<member>winelib-user/bindlls-cxx-apis.html</>
<member>winelib-user/bindlls-spec.html</>
<member>winelib-user/bindlls-wrapper.html</>
<member>winelib-user/bindlls.html</>
<member>winelib-user/c-library.html</>
<member>winelib-user/com-support.html</>
<member>winelib-user/index.html</>
<member>winelib-user/init-problems.html</>
<member>winelib-user/linking.html</>
<member>winelib-user/mfc-compiling.html</>
<member>winelib-user/mfc-legal-issues.html</>
<member>winelib-user/mfc-using.html</>
<member>winelib-user/mfc.html</>
<member>winelib-user/others.html</>
<member>winelib-user/packaging.html</>
<member>winelib-user/portability-issues.html</>
<member>winelib-user/porting-compiling.html</>
<member>winelib-user/seh.html</>
<member>winelib-user/spec-file.html</>
<member>winelib-user/unicode.html</>
<member>winelib-user/winelib-getting-started.html</>
<member>winelib-user/winelib-introduction.html</>
<member>winelib-user/winelib-requirements.html</>
<member>winelib-user/winelib-toolkit.html</>
<member>winelib-user/wmc.html</>
<member>winelib-user/wrc.html</>
        </simplelist>

John R. Sheets's avatar
John R. Sheets committed
960 961 962 963 964 965 966 967
        </listitem>


        </orderedlist>

        </sect1>


968
        <sect1 id="pkg-nonstatic"><title>Dynamic Wine Files</title>
John R. Sheets's avatar
John R. Sheets committed
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983

        <para>
        Wine also generates and depends on a number of dynamic
        files, including user configuration files and registry files.
        </para>

        <para>
        At the time of this writing, there was not a clear
        consensus of where these files should be located, and how
        they should be handled.  This section attempts
        to explain the alternatives clearly.
        </para>

        <orderedlist>

984
            <listitem>
John R. Sheets's avatar
John R. Sheets committed
985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
                <variablelist><title>Configuration File</title>
                  <varlistentry id=winerc><term><filename><link linkend=WINECONFDIR endterm=wineconfdir.id></link>/config</filename></term>
                    <listitem>
                    <para>
                    This file is the user local Wine configuration file.
                    At the time of this writing, if this file exists,
                    then no other configuration file is loaded.
                    </para>
                    </listitem>
                  </varlistentry>

                  <varlistentry><term>
                    <filename><link linkend=ETCDIR endterm=etcdir.id></link>/wine.conf</filename></term>
                    <listitem>
                    <para>
                    This is the global Wine configuration file.  It
                    is only used if the user running Wine has
                    no local configuration file.
1003 1004
		    Global wine configuration is currently not possible;
		    this might get reenabled at some time.
John R. Sheets's avatar
John R. Sheets committed
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
                    </para>
                    <para>
                    Some packagers feel that this file should not
                    be supplied, and that only a wine.conf.default
                    should be given here.
                    </para>
                    <para>
                    Other packagers feel that this file should
                    be the predominant file used, and that
                    users should only shift to a local configuration
                    file if they need to.  An argument has been
                    made that the local configuration file
                    should inherit the global configuration file.
                    At this time, Wine does not do this;
                    please refer to the WineHQ discussion
                    archives for the debate concerning this.
                    </para>
                    <para>
                    This debate is addressed more completely
1024
                    below, in <link linkend=pkg-strategy endterm=strategy.id></link>.
John R. Sheets's avatar
John R. Sheets committed
1025 1026 1027 1028 1029
                    </para>
                    </listitem>
                  </varlistentry>
                </variablelist>

1030
            </listitem>
John R. Sheets's avatar
John R. Sheets committed
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057

        <listitem>

                <para>Registry Files</para>

                <para>
                In order to replicate the Windows registry system,
                Wine stores registry entries in a series of files.

                For an excellent overview of this issue, read
                this
                <ulink url="http://www.winehq.com/News/2000-25.html#FTR">
                Wine Weekly News feature.</ulink>

                </para>

                <para>
                The bottom line is that, at Wine server startup,
                Wine loads all registry entries into memory
                to create an in memory image of the registry.
                The order of files which Wine uses to load
                registry entries is extremely important,
                as it affects what registry entries are
                actually present.  The order is roughly that
                .dat files from a Windows partion are loaded,
                then global registry settings from <link linkend=ETCDIR endterm=etcdir.id></link>,
                and then finally local registry settings are
1058
                loaded from <link linkend=WINECONFDIR endterm=wineconfdir.id></link>
John R. Sheets's avatar
John R. Sheets committed
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
                .  As each set are loaded,
                they can override the prior entries.  Thus,
                the local registry files take precedence.
                </para>

                <para>
                Then, at exit (or at periodic intervals),
                Wine will write either all registry entries
                (or, with the default setting) changed
                registry entries to files in the
                <link linkend=WINECONFDIR endterm=wineconfdir.id></link>.
                </para>

                <variablelist>
                  <varlistentry><term><filename><link linkend=WINECONFDIR endterm=wineconfdir.id></link>/system.reg</filename></term>
                    <listitem>
                    <para>
1076
                    This file contains the user's local copy of
John R. Sheets's avatar
John R. Sheets committed
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
                    the HKEY_LOCAL_MACHINE registry hive.  In general
                    use, it will contain only changes made to the
                    default registry values.
                    </para>
                    </listitem>
                  </varlistentry>

                  <varlistentry><term><filename><link linkend=WINECONFDIR endterm=wineconfdir.id></link>/user.reg</filename></term>
                    <listitem>
                    <para>
1087
                    This file contains the user's local copy of
John R. Sheets's avatar
John R. Sheets committed
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
                    the HKEY_CURRENT_USER registry hive.  In
                    general use, it will contain only changes made to the
                    default registry values.
                    </para>
                    </listitem>
                  </varlistentry>

                  <varlistentry><term><filename><link linkend=WINECONFDIR endterm=wineconfdir.id></link>/userdef.reg</filename></term>
                    <listitem>
                    <para>
1098
                    This file contains the user's local copy of
John R. Sheets's avatar
John R. Sheets committed
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
                    the HKEY_USERS\.Default registry hive.  In
                    general use, it will contain only changes made to the
                    default registry values.
                    </para>
                    </listitem>
                  </varlistentry>

                  <varlistentry><term><filename><link linkend=WINECONFDIR endterm=wineconfdir.id></link>/wine.userreg</filename></term>
                    <listitem>
                    <para>
                    This file is being deprecated.  It is only read
                    if there is no user.reg or wine.userreg, and
                    it supplied the contents of HKEY_USERS.
                    </para>
                    </listitem>
                  </varlistentry>

                  <varlistentry><term><filename><link linkend=ETCDIR endterm=etcdir.id></link>/wine.systemreg</filename></term>
                    <listitem>
                    <para>
                    This file contains the global values for
                    HKEY_LOCAL_MACHINE.  The values in this file
1121
                    can be overridden by the user's local settings.
John R. Sheets's avatar
John R. Sheets committed
1122 1123 1124
                    </para>
                    <note>
                    <para>
1125
                    The location of this directory is hardcoded within
John R. Sheets's avatar
John R. Sheets committed
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
                    wine, generally to /etc.  This will hopefully be
                    fixed at some point in the future.
                    </para>
                    </note>
                    </listitem>
                  </varlistentry>


                  <varlistentry><term><filename><link linkend=ETCDIR endterm=etcdir.id></link>/wine.userreg</filename></term>
                    <listitem>
                    <para>
                    This file contains the global values for
                    HKEY_USERS.  The values in this file
1139
                    can be overridden by the user's local settings.
John R. Sheets's avatar
John R. Sheets committed
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
                    This file is likely to be deprecated in
                    favor of a global wine.userdef.reg that will
                    only contain HKEY_USERS/.Default.
                    </para>
                    </listitem>
                  </varlistentry>

                </variablelist>


1150 1151 1152
        </listitem>

        <listitem>
John R. Sheets's avatar
John R. Sheets committed
1153
                <variablelist><title>Other files in <link linkend=WINECONFDIR endterm=wineconfdir.id></link></title>
1154
                  <varlistentry><term><filename><link linkend=WINECONFDIR endterm=wineconfdir.id></link>/wineserver-[hostname]</filename></term>
John R. Sheets's avatar
John R. Sheets committed
1155 1156 1157
                    <listitem>
                    <para>
                    This directory contains files used by Wine and the Wineserver
Tom Wickline's avatar
Tom Wickline committed
1158 1159
                    to communicate. A packager may want to have a facility for the user to erase files in this directory, as a crash in the 
                    wineserver resulting in a bogus lock file can render wine unusable.
John R. Sheets's avatar
John R. Sheets committed
1160 1161 1162 1163 1164 1165 1166 1167 1168
                    </para>
                    </listitem>
                  </varlistentry>

                  <varlistentry><term><filename><link linkend=WINECONFDIR endterm=wineconfdir.id></link>/cachedmetrics.[display]</filename></term>
                    <listitem>
                    <para>
                    This file contains font metrics for the given X display.
                    Generally, this cache is generated once at Wine start time.
Tom Wickline's avatar
Tom Wickline committed
1169
                    cachedmetrics can be generated if absent.You should note this can be long.
John R. Sheets's avatar
John R. Sheets committed
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
                    </para>
                    </listitem>
                  </varlistentry>

                </variablelist>
        </listitem>


        </orderedlist>


        </sect1>

1183
        <sect1 id="pkg-winpartition"><title>Important Files from a Windows Partition</title>
John R. Sheets's avatar
John R. Sheets committed
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
        <para>
        Wine has the ability to use files from an installation of the
        actual Microsoft Windows operating system.  Generally these
        files are loaded on a VFAT partition that is mounted
        under Linux.
        </para>
        <para>
        This is probably the most important configuration detail.
        The use of Windows registry and DLL files dramatically
        alters the behaviour of Wine.  If nothing else,
        pacakager have to make this distinction clear
        to the end user, so that they can intelligently
        choose their configuration.
        </para>
1198

John R. Sheets's avatar
John R. Sheets committed
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229

        <orderedlist>

            <listitem>
                <variablelist><title>Registry Files</title>
                  <varlistentry><term><filename>[WINDOWSDIR]/system32/system.dat</filename></term>
                    <listitem>
                    <para>
                    </para>
                    </listitem>
                  </varlistentry>

                  <varlistentry><term><filename>[WINDOWSDIR]/system32/user.dat</filename></term>
                    <listitem>
                    <para>
                    </para>
                    </listitem>
                  </varlistentry>

                  <varlistentry><term><filename>[WINDOWSDIR]/win.ini</filename></term>
                    <listitem>
                    <para>
                    </para>
                    </listitem>
                  </varlistentry>

                </variablelist>

            </listitem>

            <listitem>
1230
                <para>
John R. Sheets's avatar
John R. Sheets committed
1231 1232
                Windows Dynamic Link Libraries ([WINDOWSDIR]/system32/*.dll)
                </para>
1233
                <para>
1234
                Wine has the ability to use the actual Windows DLL files
John R. Sheets's avatar
John R. Sheets committed
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
                when running an application.  An end user can configure
                Wine so that Wine uses some or all of these DLL files
                when running a given application.
                </para>
            </listitem>

        </orderedlist>

        </sect1>

    </chapter>

1247
    <chapter id="pkg-strategy"><title id=strategy.id>Packaging Strategies</title>
John R. Sheets's avatar
John R. Sheets committed
1248 1249 1250

        <para>
        There has recently been a lot of discussion on the Wine
1251
        development mailing list about the best way to
John R. Sheets's avatar
John R. Sheets committed
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
        build Wine packages.
        </para>
        <para>
        There was a lot of discussion, and several diverging
        points of view.  This section of the document
        attempts to present the areas of common agreement,
        and also to present the different approaches
        advocated on the mailing list.
        </para>

1262
        <sect1 id="pkg-whatfiles"><title>Distribution of Wine into packages</title>
John R. Sheets's avatar
John R. Sheets committed
1263 1264 1265 1266
        <para>
        The most basic question to ask is given the Wine CVS tree,
        what physical files are you, the packager, going to produce?
        Are you going to produce only a wine.rpm (as Marcus has done),
1267 1268
        or are you going to produce 6 Debian files
        (libwine, libwine-dev, wine, wine-doc, wine-utils and winesetuptk) as
John R. Sheets's avatar
John R. Sheets committed
1269 1270 1271 1272
        Ove has done?
        </para>
        <para>
        At this point, there is no consensus
1273
        amongst the wine-devel community on this subject.
John R. Sheets's avatar
John R. Sheets committed
1274 1275 1276
        </para>
        </sect1>

1277
        <sect1 id="pkg-wherefiles"><title>Where to install files</title>
John R. Sheets's avatar
John R. Sheets committed
1278 1279 1280 1281 1282 1283 1284 1285 1286
        <para>
        This question is not really contested.  It will vary
        by distribution, and is really up to the packager.
        As a guideline, the current 'make install' process
        seems to behave such that
        if we pick a single <link linkend=PREFIX endterm=prefix.id></link>,
        then :
        </para>
        <orderedlist>
1287

John R. Sheets's avatar
John R. Sheets committed
1288 1289 1290
            <listitem>
            <para>
            all <link linkend=binfiles>binary files</link> go into
Tom Wickline's avatar
Tom Wickline committed
1291
            <link linkend=PREFIX endterm=prefix.id></link>$PREFIX/bin,
John R. Sheets's avatar
John R. Sheets committed
1292 1293 1294 1295 1296 1297
            </para>
            </listitem>

            <listitem>
            <para>
            all <link linkend=libfiles>library files</link> go into
Tom Wickline's avatar
Tom Wickline committed
1298
            <link linkend=PREFIX endterm=prefix.id></link>$PREFIX/lib/wine,
John R. Sheets's avatar
John R. Sheets committed
1299 1300 1301 1302 1303 1304
            </para>
            </listitem>

            <listitem>
            <para>
            all <link linkend=includefiles>include files</link> go into
Tom Wickline's avatar
Tom Wickline committed
1305
            <link linkend=PREFIX endterm=prefix.id></link>$PREFIX/include/wine,
John R. Sheets's avatar
John R. Sheets committed
1306 1307 1308 1309 1310 1311
            </para>
            </listitem>

            <listitem>
            <para>
            all <link linkend=docfiles>documentation files</link> go into
Tom Wickline's avatar
Tom Wickline committed
1312
            <link linkend=PREFIX endterm=prefix.id></link>$PREFIX/share/doc/wine-VERSION,
John R. Sheets's avatar
John R. Sheets committed
1313 1314 1315 1316 1317 1318
            </para>
            </listitem>

            <listitem>
            <para>
            and <link linkend=manfiles>man pages</link> go into
Tom Wickline's avatar
Tom Wickline committed
1319
            <link linkend=PREFIX endterm=prefix.id></link>$PREFIX/share/man,
John R. Sheets's avatar
John R. Sheets committed
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329
            </para>
            </listitem>

        </orderedlist>

        <para>
        Refer to the specific information on the Debian package
        and the OpenLinux package for specific details on how
        those packages are built.
        </para>
1330 1331 1332 1333 1334 1335
	<para>
	You might also want to use the wine wrapper script winelauncher
	that can be found in tools/ directory, as it has several important
	advantages over directly invoking the wine binary.
	See the <link linkend=binfiles>Executable Files</link> section
	for details.
Michael Stefaniuc's avatar
Michael Stefaniuc committed
1336
        </para>
John R. Sheets's avatar
John R. Sheets committed
1337 1338 1339

        <sect2 id=opt><title>The question of /opt/wine</title>
        <para>
Tom Wickline's avatar
Tom Wickline committed
1340
        The FHS 2.2 specification suggests that Wine as a package
John R. Sheets's avatar
John R. Sheets committed
1341 1342 1343 1344 1345
        should be installed to /opt/wine.  None of the
        existing packages follow this guideline (today;
        check again tomorrow).
        </para>
        </sect2>
1346

John R. Sheets's avatar
John R. Sheets committed
1347 1348
        </sect1>

1349
        <sect1 id="pkg-whattomake"><title>What files to create</title>
John R. Sheets's avatar
John R. Sheets committed
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
        <para>
        After installing the static and shareable files, the next
        question the packager needs to ask is how much dynamic
        configuration will be done, and what configuration
        files should be created.
        </para>
        <para>
        There are several approaches to this:
        <orderedlist>
            <listitem>
                <para>
                Rely completely on user file space - install nothing
                </para>
                <para>
1364 1365
                This approach relies upon the new winesetup utility and
                the new ability of Wine to launch winesetup if no configuration file is found.
John R. Sheets's avatar
John R. Sheets committed
1366 1367 1368
                The basic concept is that no global configuration files
                are created at install time.
                Instead, Wine configuration files are created on the
1369 1370
                fly by the winesetup program when Wine is invoked.
                Further, winesetup creates default Windows directories
John R. Sheets's avatar
John R. Sheets committed
1371
                and paths that are stored completely in
1372
                the user's <link linkend=WINECONFDIR endterm=wineconfdir.id></link>.
John R. Sheets's avatar
John R. Sheets committed
1373 1374 1375 1376
                </para>
                <para>
                This approach has the benefit of simplicity in that all
                Wine files are either stored under /opt/wine or under
1377
                ~/.wine.  Further, there is only ever one Wine
John R. Sheets's avatar
John R. Sheets committed
1378 1379 1380 1381 1382 1383
                configuration file.
                </para>
                <para>
                This approach, however, adds another level of complexity.
                It does not allow Wine to run Solitaire 'out of the box';
                the user must run the configuration program first.  Further,
1384
                winesetup requires Tcl/Tk, a requirement not beloved by some.
John R. Sheets's avatar
John R. Sheets committed
1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415
                Additionally, this approach closes the door on multi
                user configurations and presumes a single user approach.
                </para>
            </listitem>


            <listitem>
                <para>
                Build a reasonable set of defaults for the global wine.conf,
                facilitate creation of a user's local Wine configuration.
                </para>
                <para>
                This approach, best shown by Marcus, causes the
                installation process to auto scan the system,
                and generate a global wine.conf file with best
                guess defaults.  The OpenLinux packages follow
                this behaviour.
                </para>
                <para>
                The keys to this approach are always putting
                an existing Windows partition into the
                path, and being able to run Solitaire
                right out of the box.
                Another good thing that Marcus does is he
                detects a first time installation and
                does some clever things to improve the
                user's Wine experience.
                </para>
                <para>
                A flaw with this approach, however, is it doesn't
                give the user an obvious way to choose not to
1416
                use a Windows partition.
John R. Sheets's avatar
John R. Sheets committed
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
                </para>
            </listitem>

            <listitem>
                <para>
                Build a reasonable set of defaults for the global wine.conf,
                and ask the user if possible
                </para>
                <para>
                This approach, demonstrated by Ove, causes the
                installation process to auto scan the system,
                and generate a global wine.conf file with best
                guess defaults.  Because Ove built a Debian
                package, he was able to further query debconf and
                get permission to ask the user some questions,
                allowing the user to decide whether or not to
                use a Windows partition.
                </para>
            </listitem>


            </orderedlist>
        </para>

        </sect1>


1444
        <sect1 id="pkg-wineconf"><title>What to put into the wine config file</title>
John R. Sheets's avatar
John R. Sheets committed
1445
        <para>
Tom Wickline's avatar
Tom Wickline committed
1446 1447
          This is the sample config file provided with wine 20030115. You can edit this file
          to best suit the needs of your intended user.
John R. Sheets's avatar
John R. Sheets committed
1448
        </para>
Tom Wickline's avatar
Tom Wickline committed
1449 1450 1451

        <programlisting>
    
Tom Wickline's avatar
Tom Wickline committed
1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520
WINE REGISTRY Version 2
;; All keys relative to \\Machine\\Software\\Wine\\Wine\\Config

;; If you think it is necessary to show others your complete config for a
;; bug report, filter out empty lines and comments with
;; grep -v "^;" ~/.wine/config | grep '.'
;;
;; MS-DOS drives configuration
;;
;; Each section has the following format:
;; [Drive X]
;; "Path"="xxx"       (Unix path for drive root)
;; "Type"="xxx"       (supported types are 'floppy', 'hd', 'cdrom' and 'network')
;; "Label"="xxx"      (drive label, at most 11 characters)
;; "Serial"="xxx"     (serial number, 8 characters hexadecimal number)
;; "Filesystem"="xxx" (supported types are 'msdos'/'dos'/'fat', 'win95'/'vfat', 'unix')
;;   This is the FS Wine is supposed to emulate on a certain
;;   directory structure.
;;   Recommended:
;;   - "win95" for ext2fs, VFAT and FAT32
;;   - "msdos" for FAT16 (ugly, upgrading to VFAT driver strongly recommended)
;;   DON'T use "unix" unless you intend to port programs using Winelib !
;; "Device"="/dev/xx" (only if you want to allow raw device access)
;;
[Drive A]
"Path" = "/mnt/fd0"
"Type" = "floppy"
"Label" = "Floppy"
"Filesystem" = "win95"
"Serial" = "87654321"
"Device" = "/dev/fd0"

[Drive C]
"Path" = "/c"
"Type" = "hd"
"Label" = "MS-DOS"
"Filesystem" = "win95"

[Drive D]
"Path" = "/cdrom"
"Type" = "cdrom"
"Label" = "CD-Rom"
"Filesystem" = "win95"
; make sure that device is correct and has proper permissions !
"Device" = "/dev/cdrom"

[Drive E]
"Path" = "/tmp"
"Type" = "hd"
"Label" = "Tmp Drive"
"Filesystem" = "win95"

[Drive F]
"Path" = "${HOME}"
"Type" = "network"
"Label" = "Home"
"Filesystem" = "win95"

[wine]
"Windows" = "c:\\windows"
"System" = "c:\\windows\\system"
"Temp" = "e:\\"
"Path" = "c:\\windows;c:\\windows\\system;e:\\;e:\\test;f:\\"
"Profile" = "c:\\windows\\Profiles\\Administrator"
"GraphicsDriver" = "x11drv"
;"ShowDirSymlinks" = "1"
;"ShowDotFiles" = "1"
"ShellLinker" = "wineshelllink"

Tom Wickline's avatar
Tom Wickline committed
1521 1522
# &lt;wineconf&gt;

Tom Wickline's avatar
Tom Wickline committed
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730
[Version]
; Windows version to imitate (win95,win98,winme,nt351,nt40,win2k,winxp,win20,win30,win31)
;"Windows" = "win98"
; DOS version to imitate
;"DOS" = "6.22"

; Be careful here, wrong DllOverrides settings have the potential
; to pretty much kill your setup.
[DllOverrides]
; some dlls you may want to change
"oleaut32"     = "builtin, native"
"ole32"        = "builtin, native"
"commdlg"      = "builtin, native"
"comdlg32"     = "builtin, native"
"shell"        = "builtin, native"
"shell32"      = "builtin, native"
"shfolder"     = "builtin, native"
"shlwapi"      = "builtin, native"
"shdocvw"      = "builtin, native"
"advapi32"     = "builtin, native"
"msvcrt"       = "native, builtin"
"mciavi.drv"   = "native, builtin"
"mcianim.drv"  = "native, builtin"
; you can specify applications too
; this one will apply for all notepad.exe
;"*notepad.exe" = "native, builtin"
; this one will apply only for a particular file
;"C:\\windows\\regedit.exe" = "native, builtin"
; default for all other dlls
"*" = "builtin, native"

[x11drv]
; Number of colors to allocate from the system palette
"AllocSystemColors" = "100"
; Use a private color map
"PrivateColorMap" = "N"
; Favor correctness over speed in some graphics operations
"PerfectGraphics" = "N"
; Color depth to use on multi-depth screens
;;"ScreenDepth" = "16"
; Name of X11 display to use
;;"Display" = ":0.0"
; Allow the window manager to manage created windows
"Managed" = "Y"
; Use a desktop window of 640x480 for Wine
;"Desktop" = "640x480"
; Use XFree86 DGA extension if present
; (make sure /dev/mem is accessible by you !)
"UseDGA" = "Y"
; Use XShm extension if present
"UseXShm" = "Y"
; Use XVidMode extension if present
"UseXVidMode" = "Y"
; Use the take focus protocol
"UseTakeFocus" = "Y"
; Enable DirectX mouse grab
"DXGrab" = "N"
; Create the desktop window with a double-buffered visual
; (useful to play OpenGL games)
"DesktopDoubleBuffered" = "N"
; Code page used for captions in managed mode
; 0 means default ANSI code page (CP_ACP == 0)
"TextCP" = "0"
; Use this if you have more than one port for video on your setup
; (Wine uses for now the first 'input image' it finds).
;; "XVideoPort" = "43"
; Run in synchronous mode (useful for debugging X11 problems)
;;"Synchronous" = "Y"
;
; Use the Render extension to render client side fonts (default "Y")
;;"ClientSideWithRender" = "Y"
; Fallback on X core requests to render client side fonts (default "Y")
;;"ClientSideWithCore" = "Y"
; Set both of the previous two to "N" in order to force X11 server side fonts
;
; Anti-alias fonts if using the Render extension (default "Y")
;;"ClientSideAntiAliasWithRender" = "Y"
; Anti-alias fonts if using core requests fallback (default "Y")
;;"ClientSideAntiAliasWithCore" = "Y"
;

[fonts]
;Read the Fonts topic in the Wine User Guide before adding aliases
;See a couple of examples for russian users below
"Resolution" = "96"
"Default" = "-adobe-helvetica-"
"DefaultFixed" = "fixed"
"DefaultSerif" = "-adobe-times-"
"DefaultSansSerif" = "-adobe-helvetica-"

;; default TrueType fonts with russian koi8-r encoding
;"Default" = "-monotype-arial-*-*-*--*-*-*-*-*-*-koi8-r"
;"DefaultFixed" = "-monotype-courier new-*-*-*--*-*-*-*-*-*-koi8-r"
;"DefaultSerif" = "-monotype-times new roman-*-*-*--*-*-*-*-*-*-koi8-r"
;"DefaultSansSerif" = "-monotype-arial-*-*-*--*-*-*-*-*-*-koi8-r"
;; default cyrillic bitmap X fonts
;"Default" = "-cronyx-helvetica-"
;"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"
"Com2" = "/dev/ttyS1"
"Com3" = "/dev/ttyS2"
"Com4" = "/dev/modem"

[parallelports]
"Lpt1" = "/dev/lp0"

[ppdev]
;; key:  io-base of the emulated port
;; value : parport-device{,timeout}
;; timeout for auto closing an open device ( not yet implemented)
;"378" = "/dev/parport0"
;"278" = "/dev/parport1"
;"3bc" = "/dev/parport2"

[spooler]
"FILE:" = "tmp.ps"
"LPT1:" = "|lpr"
"LPT2:" = "|gs -sDEVICE=bj200 -sOutputFile=/tmp/fred -q -"
"LPT3:" = "/dev/lp3"

[ports]
;"read"  = "0x779,0x379,0x280-0x2a0"
;"write" = "0x779,0x379,0x280-0x2a0"

[Debug]
;"RelayExclude" = "RtlEnterCriticalSection;RtlLeaveCriticalSection"
;"RelayInclude" = "user32.CreateWindowA"
;"SnoopExclude" = "RtlEnterCriticalSection;RtlLeaveCriticalSection"
;"SpyExclude" = "WM_SIZE;WM_TIMER;"

[registry]
;These are all booleans.  Y/y/T/t/1 are true, N/n/F/f/0 are false.
;Defaults are read all, write to Home
; Where to find the global registries
;"GlobalRegistryDir" = "/etc";
; Global registries (stored in /etc)
"LoadGlobalRegistryFiles" = "Y"
; Home registries (stored in ~user/.wine/)
"LoadHomeRegistryFiles" = "Y"
; Load Windows registries from the Windows directory
"LoadWindowsRegistryFiles" = "Y"
; TRY to write all changes to home registries
"WritetoHomeRegistryFiles" = "Y"
; Registry periodic save timeout in seconds
; "PeriodicSave" = "600"
; Save only modified keys
"SaveOnlyUpdatedKeys" = "Y"

[Tweak.Layout]
;; supported styles are 'Win31'(default), 'Win95', 'Win98'
;; this has *nothing* to do with the windows version Wine returns:
;; set the "Windows" value in the [Version] section if you want that.
"WineLook" = "Win95"

[Console]
;"Drivers" = "tty"
;"XtermProg" = "nxterm"
;"InitialRows" = "25"
;"InitialColumns" = "80"
;"TerminalType" = "nxterm"

[Clipboard]
"ClearAllSelections" = "0"
"PersistentSelection" = "1"

; List of all directories directly contain .AFM files
[afmdirs]
"1" = "/usr/share/ghostscript/fonts"
"2" = "/usr/share/a2ps/afm"
"3" = "/usr/share/enscript"
"4" = "/usr/X11R6/lib/X11/fonts/Type1"

[WinMM]
#"Drivers" = "winearts.drv"
#"Drivers" = "winejack.drv"
"Drivers" = "wineoss.drv"
"WaveMapper" = "msacm.drv"
"MidiMapper" = "midimap.drv"

[dsound]
;; HEL only: Number of waveOut fragments ahead to mix in new buffers.
;"HELmargin" = "5"
;; HEL only: Number of waveOut fragments ahead to queue to driver.
;"HELqueue" = "5"
;; Max number of fragments to prebuffer
;"SndQueueMax" = "28"
;; Min number of fragments to prebuffer
;"SndQueueMin" = "12"

[Network]
;; Use the DNS (Unix) host name always as NetBIOS "ComputerName" (boolean, default "Y").
;; Set to N if you need a persistent NetBIOS ComputerName that possibly differs 
;; from the Unix host name. You'll need to set ComputerName in 
;; HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\ComputerName\ComputerName, too.
;"UseDnsComputerName" = "N"

;; sample AppDefaults entries
Tom Wickline's avatar
Tom Wickline committed
1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744

; 3 InstallShield versions who like to put their full screen window in front,
; without any chance to switch to another X11 application.
; So just catch them in a desktop window.

[AppDefaults\\_INS5576._MP\\x11drv]
"Desktop" = "640x480"

[AppDefaults\\_INS5176._MP\\x11drv]
"Desktop" = "640x480"

[AppDefaults\\_INS0466._MP\\x11drv]
"Desktop" = "640x480"

Tom Wickline's avatar
Tom Wickline committed
1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765
;[AppDefaults\\iexplore.exe\\DllOverrides]
;"shlwapi" = "native"
;"rpcrt4" = "native"
;"ole32" = "native"
;"shdocvw" = "native"
;"wininet" = "native"
;"shfolder" = "native"
;"shell32" = "native"
;"shell" = "native"
;"comctl32" = "native"
;
;[AppDefaults\\setup.exe\\x11drv]
;"Desktop" = "800x600"
;
;[AppDefaults\\sol.exe\\Version]
;"Windows" = "nt40"
;
;; Some games (Quake 2, UT) refuse to accept emulated dsound devices.
;; You can add an AppDefault entry like this for such cases.
;[AppDefaults\\pickygame.exe\\dsound]
;"EmulDriver" = "N"
John R. Sheets's avatar
John R. Sheets committed
1766

Tom Wickline's avatar
Tom Wickline committed
1767 1768 1769
# &lt;/wineconf&gt;

 </programlisting>      
Tom Wickline's avatar
Tom Wickline committed
1770
        </sect1>
John R. Sheets's avatar
John R. Sheets committed
1771 1772 1773 1774 1775 1776

    </chapter>




1777
    <chapter id="pkg-implementation"> <title>Implementation</title>
John R. Sheets's avatar
John R. Sheets committed
1778

1779
    <sect1 id="pkg-openlinux"><title>RedHat 8.0 Sample</title>
1780 1781 1782 1783 1784

          <orderedlist inheritnum="inherit">
            <listitem>
              <para>Building the package</para>
              <para>
1785
                Wine is configured the usual way (depending on your
1786 1787 1788 1789 1790 1791 1792 1793
                build environment). The "prefix" is chosen using your
                application placement policy
                (<filename>/usr/</filename>,
                <filename>/usr/X11R6/</filename>,
                <filename>/opt/wine/</filename> or similar).  The
                configuration files (<filename>wine.conf</filename>,
                <filename>wine.userreg</filename>,
                <filename>wine.systemreg</filename>) are targeted for
1794
                <filename>/etc/wine/</filename> (rationale: FHS 2.2,
1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816
                multiple readonly configuration files of a package).
              </para>
              <para>
                Example (split this into <literal>%build</literal> and
                <literal>%install</literal> section for
                <command>rpm</command>):
              </para>
              <screen>
CFLAGS=$RPM_OPT_FLAGS \
./configure --prefix=/usr/X11R6 --sysconfdir=/etc/wine/ --enable-dll
make
BR=$RPM_BUILD_ROOT
make install prefix=$BR/usr/X11R6/ sysconfdir=$BR/etc/wine/
install -d $BR/etc/wine/
install -m 644 wine.ini $BR/etc/wine/wine.conf

# Put all our dlls in a seperate directory. (this works only if
# you have a buildroot)
install -d $BR/usr/X11R6/lib/wine
mv $BR/usr/X11R6/lib/lib* $BR/usr/X11R6/lib/wine/

# the clipboard server is started on demand.
1817
install -m 755 dlls/x11drv/wineclipsrv $BR/usr/X11R6/bin/
1818

1819
# The Wine server is needed.
1820 1821 1822 1823 1824
install -m 755 server/wineserver $BR/usr/X11R6/bin/
              </screen>
              <para>
                Here we unfortunately do need to create
                <filename>wineuser.reg</filename> and
1825
                <filename>winesystem.reg</filename> from the Wine
1826
                distributed <filename>winedefault.reg</filename>. This
1827
                can be done using <command>./regedit</command> once for
1828
                one example user and then reusing his
John R. Sheets's avatar
John R. Sheets committed
1829 1830
                <filename><link linkend=WINECONFDIR endterm=wineconfdir.id></link>/user.reg</filename> and
                <filename><link linkend=WINECONFDIR endterm=wineconfdir.id></link>/system.reg</filename> files.
1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882
                <note>
                  <title>FIXME</title>
                  <para>this needs to be done better</para>
                </note>
              </para>
              <screen>
install -m 644 wine.sytemreg $BR/etc/wine/
install -m 644 wine.userreg $BR/etc/wine/
              </screen>
              <para>
                There are now a lot of libraries generated by the
                build process, so a seperate library directory should
                be used.
              </para>
              <screen>
install -d 755 $BR/usr/X11R6/lib/
mv $BR/
              </screen>
              <para>
                You will need to package the files:
              </para>
              <screen>
$prefix/bin/wine, $prefix/bin/dosmod, $prefix/lib/wine/*
$prefix/man/man1/wine.1, $prefix/include/wine/*,
$prefix/bin/wineserver, $prefix/bin/wineclipsrv

%config /etc/wine/*
%doc ... choose from the toplevel directory and documentation/
              </screen>
              <para>
                The post-install script:
              </para>
              <screen>
if ! grep -q /usr/X11R6/lib/wine /etc/ld.so.conf; then
    echo "/usr/X11R6/lib/wine" &gt;&gt; /etc/ld.so.conf
fi
/sbin/ldconfig
              </screen>
              <para>
                The post-uninstall script:
              </para>
              <screen>
if [ "$1" = 0 ]; then
    perl -ni -e 'print unless m:/usr/X11R6/lib/wine:;' /etc/ld.so.conf
fi
/sbin/ldconfig
              </screen>
            </listitem>
            <listitem>
              <para>Creating a good default configuration file</para>
              <para>
                For the rationales of needing as less input from the
1883
                user as possible arises the need for a very good
1884
                configuration file. The one supplied with Wine is
1885 1886 1887 1888 1889 1890 1891 1892 1893 1894
                currently lacking. We need:
              </para>
              <itemizedlist>
                <listitem>
                  <para>
                    [Drive X]:
                  </para>
                  <itemizedlist>
                    <listitem>
                      <para>
1895
                        A for the floppy. Specify your distribution's
1896 1897 1898 1899 1900 1901 1902 1903 1904
                        default floppy mountpoint here.
                      </para>
                      <programlisting>
Path=/auto/floppy
                      </programlisting>
                    </listitem>
                    <listitem>
                      <para>
                        C for the <filename>C:\</filename> directory.
1905
                        Here we use the user's home directory, for most
1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917
                        applications do see <filename>C:\</filename>
                        as root-writeable directory of every windows
                        installation and this basically is it in the
                        UNIX-user context.
                        </para>
                      <programlisting>
Path=${HOME}
                      </programlisting>
                    </listitem>
                    <listitem>
                      <para>
                        R for the CD-Rom drive. Specify your
1918
                        distribution's default CD-ROM drives mountpoint
1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
                        here.
                        </para>
                      <programlisting>
Path=/auto/cdrom
                      </programlisting>
                    </listitem>
                    <listitem>
                      <para>
                        T for temporary storage. We do use
                        <filename>/tmp/</filename> (rationale: between
                        process temporary data belongs to
                        <filename>/tmp/</filename>, FHS 2.0)
                      </para>
                    </listitem>
                    <listitem>
                      <para>
                        W for the original Windows installation. This
                        drive points to the
                        <filename>windows\</filename> subdirectory of
                        the original windows installation. This avoids
                        problems with renamed
                        <filename>windows</filename> directories (as
                        for instance <filename>lose95</filename>,
                        <filename>win</filename> or
                        <filename>sys\win95</filename>). During
1944
                        compile/package/install we leave this to be
1945 1946 1947 1948 1949 1950 1951 1952
                        <filename>/</filename>, it has to be
                        configured after the package install.
                      </para>
                    </listitem>
                    <listitem>
                      <para>
                        Z for the UNIX Root directory. This avoids any
                        problems with "could not find drive for
1953 1954
                        current directory" users occasionally complain
                        about in the newsgroup and the irc channel. It
1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969
                        also makes the whole directory structure
                        browseable. The type of Z should be network,
                        so applications expect it to be readonly.
                      </para>
                      <programlisting>
Path=/
                      </programlisting>
                    </listitem>
                  </itemizedlist>
                </listitem>
                <listitem>
                  <para>
                    [wine]:
                  </para>
                  <screen>
1970 1971 1972 1973
  Windows=c:\windows\ 		(the windows/ subdirectory in the user's
  				 home directory)
  System=c:\windows\system\	(the windows/system subdirectory in the user's
  				 home directory)
1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000
  Path=c:\windows;c:\windows\system;c:\windows\system32;w:\;w:\system;w:\system32;
  ; Using this trick we have in fact two windows installations in one, we
  ; get the stuff from the readonly installation and can write to our own.
  Temp=t:\			(the TEMP directory)
                  </screen>
                </listitem>
                <listitem>
                  <para>[Tweak.Layout]</para>
                  <screen>
  WineLook=win95		(just the coolest look ;)
                  </screen>
                </listitem>
                <listitem>
                  <para>
                    Possibly modify the [spooler], [serialports] and
                    [parallelports] sections.
                  </para>
                  <note>
                    <title>FIXME</title>
                    <para>possibly more, including printer stuff.</para>
                  </note>
                </listitem>
              </itemizedlist>

              <para>Add this prepared configuration file to the package.</para>
            </listitem>
            <listitem>
2001
              <para>Installing Wine for the system administrator</para>
2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022
              <para>
                Install the package using the usual packager
                <command>rpm -i wine.rpm</command>. You may edit
                <filename>/etc/wine/wine.conf</filename>, [Drive W],
                to point to a possible windows installation right
                after the install. That's it.
              </para>
              <para>
                Note that on Linux you should somehow try to add the
                <option>unhide</option> mount option (see <command>man
                  mount</command>) to the CD-ROM entry in
                <filename>/etc/fstab</filename> during package
                install, as several stupid Windows programs mark some
                setup (!) files as hidden (ISO9660) on CD-ROMs, which
                will greatly confuse users as they won't find their
                setup files on the CD-ROMs as they were used on
                Windows systems when <option>unhide</option> is not
                set ;-\ And of course the setup program will complain
                that <filename>setup.ins</filename> or some other mess
                is missing... If you choose to do so, then please make
                this change verbose to the admin.
2023 2024 2025
		Also make sure that the kernel you use includes the Joliet
		CD-ROM support, for the very same reasons as given above
		(no long filenames due to missing Joliet, files not found).
2026 2027 2028
              </para>
            </listitem>
            <listitem>
2029
              <para>Installing Wine for the user</para>
2030 2031
              <para>
                The user will need to run a setup script before the
2032
                first invocation of Wine. This script should:
2033
              </para>
John R. Sheets's avatar
John R. Sheets committed
2034 2035


2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071
              <itemizedlist>
                <listitem>
                  <para>
                    Copy <filename>/etc/wine/wine.conf</filename> for
                    user modification.
                  </para>
                </listitem>
                <listitem>
                  <para>
                    Allow specification of the original windows
                    installation to use (which modifies the copied
                    <filename>wine.conf</filename> file).
                  </para>
                </listitem>
                <listitem>
                  <para>
                    Create the windows directory structure
                    (<filename>c:\windows</filename>,
                    <filename>c:\windows\system</filename>,
                    <filename>c:\windows\Start Menu\Programs</filename>,
                    <filename>c:\Program Files</filename>,
                    <filename>c:\Desktop</filename>, etc.)
                  </para>
                </listitem>
                <listitem>
                  <para>
                    Symlink all <filename>.dll</filename> and
                    <filename>.exe</filename> files from the original
                    windows installation to the
                    <filename>windows</filename> directory. Why? Some
                    programs reference "%windowsdir%/file.dll" or
                    "%systemdir%/file.dll" directly and fail if they
                    are not present.
                  </para>
                  <para>
                    This will give a huge number of symlinks, yes.
2072
                    However, if an installer later overwrites one of
2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084
                    those files, it will overwrite the symlink (so
                    that the file now lies in the
                    <filename>windows/</filename> subdirectory).
                  </para>
                  <note>
                    <title>FIXME</title>
                    <para>Not sure this is needed for all files.</para>
                  </note>
                </listitem>
                <listitem>
                  <para>
                    On later invocation the script might want to
2085
                    compare regular files in the user's windows
2086 2087 2088 2089 2090 2091
                    directories and in the global windows directories
                    and replace same files by symlinks (to avoid
                    diskspace problems).
                  </para>
                </listitem>
              </itemizedlist>
John R. Sheets's avatar
John R. Sheets committed
2092 2093


2094 2095 2096 2097
            </listitem>
          </orderedlist>


2098
      <sect2 id=sample><title>Sample RedHat 8.0 .spec file for review purposes</title>
2099 2100


2101
<programlisting>
2102

2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236
%define DATE 20030115
Summary: A Windows 16/32 bit emulator.
Name: wine
Version: %{DATE}
Release: 1rh8winehq
Group: Applications/Emulators
License: LGPL
URL: http://www.winehq.com/
Source: ftp://metalab.unc.edu/pub/Linux/ALPHA/wine/development/Wine-%{version}.tar.bz2
Source1: wine.init
Patch: wine-%{version}-initial.patch
Patch1: wine-%{version}-kde2.patch
Patch2: wine-%{version}-winelauncher.patch
Patch3: wine-%{version}-defaultcfg.patch
Patch4: wine-%{version}-stabs+.patch
Buildroot: %{_tmppath}/%{name}-root
ExclusiveArch: %{ix86}
Prereq: shadow-utils
Conflicts: kdebase < 2.0
Requires: cups-libs >= 1.1.12
BuildRequires: docbook-utils, cups-devel >= 1.1.12, autoconf253, perl

%description
While Wine is usually thought of as a Windows(TM) emulator, the Wine
developers would prefer that users thought of Wine as a Windows
compatibility layer for UNIX. This package includes a program loader,
which allows unmodified Windows 3.1/95/NT binaries to run under Intel
Unixes. Wine does not require MS Windows, but it can use native system
.dll files if they are available.

%package devel
Summary: Wine development environment.
Group: System Environment/Libraries
Requires: wine = %{version}

%description devel
Header and include files for developing applications with the Wine
Windows(TM) emulation libraries.

%prep
%setup -q -n wine-%{version}
find . -type d -name CVS |xargs rm -rf
%patch -p1 -b .initial
%patch1 -p1 -b .kde2
%patch2 -p1 -b .wl
%patch3 -p1 -b .defcfg
%patch4 -p1 -b .stabs+

%build
export CFLAGS="$RPM_OPT_FLAGS"
autoconf || autoconf-2.53
%configure \
	--with-x \
	--libdir=%{_libdir}/wine \
	--includedir=%{_includedir}/wine \
	--sysconfdir=%{_sysconfdir}/wine

make depend
make
make -C documentation doc

%install
rm -rf $RPM_BUILD_ROOT

%makeinstall \
	includedir=%{?buildroot:%{buildroot}}%{_includedir}/wine \
	libdir=%{?buildroot:%{buildroot}}%{_libdir}/wine \
	sysconfdir=%{?buildroot:%{buildroot}}%{_sysconfdir}/wine \
	dlldir=%{?buildroot:%{buildroot}}%{_libdir}/wine/wine \
	LDCONFIG=/bin/true

for i in system "Start Menu/Programs/Startup" Profiles/Administrator Fonts \
         Desktop Favorites NetHood Recent SendTo ShellNew; do
	mkdir -p "$RPM_BUILD_ROOT%{_datadir}/wine-c/windows/$i"
done
mkdir -p "$RPM_BUILD_ROOT%{_datadir}/wine-c/My Documents"
mkdir -p "$RPM_BUILD_ROOT%{_datadir}/wine-c/Program Files/Common Files"

# Take care of wine and windows configuration files...
mkdir -p $RPM_BUILD_ROOT%{_sysconfdir}/wine
mv documentation/samples/config documentation/samples/config.orig
sed "s/\"GraphicsDriver\" = .*/\"GraphicsDriver\" = \"ttydrv\"/" documentation/samples/config.orig |\
sed "s|\"Path\" = \"/c\"\$|\"Path\" = \"$RPM_BUILD_ROOT%{_datadir}/wine-c\"|" |\
sed "s|\"Path\" = \"\${HOME}\"$|\"Path\" = \"%{_builddir}/%{buildsubdir}\"|" -> documentation/samples/config
WINEPREFIX=%{_builddir}/%{buildsubdir}/documentation/samples programs/regedit/regedit winedefault.reg > /dev/null
# Wait until wineserver finishes and closes those files
sleep 5
install -c -m 0644 documentation/samples/system.reg $RPM_BUILD_ROOT%{_sysconfdir}/wine/system.reg
install -c -m 0644 documentation/samples/user.reg $RPM_BUILD_ROOT%{_sysconfdir}/wine/user.reg
install -c -m 0644 documentation/samples/userdef.reg $RPM_BUILD_ROOT%{_sysconfdir}/wine/userdef.reg
rm -f documentation/samples/system.reg
rm -f documentation/samples/user.reg
rm -f documentation/samples/userdef.reg

sed "s|\"Path\" = \"/c\"\$|\"Path\" = \"%{_datadir}/wine-c\"|" documentation/samples/config.orig > documentation/samples/config.rh
install -c -m 0644 documentation/samples/config.rh $RPM_BUILD_ROOT%{_sysconfdir}/wine/wine.conf
rm -f documentation/samples/config
rm -f documentation/samples/config.rh
mv documentation/samples/config.orig documentation/samples/config

# Install link to windows applications replacements
ln -sf %{_libdir}/wine/notepad.exe.so $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/notepad.exe
ln -sf %{_libdir}/wine/regedit.exe.so $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/regedit.exe
ln -sf %{_libdir}/wine/rundll32.exe.so $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/rundll32.exe
ln -sf %{_libdir}/wine/wcmd.exe.so $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/system/cmd.exe
ln -sf %{_libdir}/wine/control.exe.so $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/system/control.exe
ln -sf %{_libdir}/wine/winhelp.exe.so $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/system/help.exe
ln -sf %{_libdir}/wine/notepad.exe.so $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/system/notepad.exe
ln -sf %{_libdir}/wine/progman.exe.so $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/system/progman.exe
ln -sf %{_libdir}/wine/regsvr32.exe.so $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/system/regsvr32.exe
ln -sf %{_libdir}/wine/winemine.exe.so $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/system/winmine.exe
ln -sf %{_libdir}/wine/winver.exe.so $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/system/winver.exe
ln -sf %{_libdir}/wine/uninstaller.exe.so $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/uninstaller.exe
ln -sf %{_libdir}/wine/winhelp.exe.so $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/winhelp.exe
ln -sf %{_libdir}/wine/winhelp.exe.so $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/winhlp32.exe

for i in shell.dll shell32.dll winsock.dll wnsock32.dll; do
	touch $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/system/$i
done
touch $RPM_BUILD_ROOT%{_datadir}/wine-c/autoexec.bat
touch $RPM_BUILD_ROOT%{_datadir}/wine-c/config.sys
touch $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/win.ini
install -c -m 0644 documentation/samples/system.ini $RPM_BUILD_ROOT%{_datadir}/wine-c/windows/system.ini

cat >RedHat &lt;&lt;EOF
Wine directory structure used in Red Hat Linux:
===============================================

%{_datadir}/wine-c is the root directory (aka C: drive) wine looks for
by default. It contains (empty) C:\windows and C:\windows\system
directories, needed to operate Wine without an existing Windows installation.

If you want to use Wine with an existing Windows installation that is mounted,
for example, in /mnt/windows-c, edit /etc/wine.conf to say
2237 2238

[Drive C]
2239
Path=/mnt/windows-c
2240
Type=hd
2241
Label=Whatever
2242 2243
Filesystem=win95

2244
instead of the defaults set by installation.
2245

2246 2247 2248
If you do this, you can safely remove %{_datadir}/wine-c.
(Alternatively, just mount your Windows partition to %{_datadir}/wine-c.)
EOF
2249

2250 2251 2252
# Allow users to launch Windows programs by just clicking on the .exe file...
mkdir -p $RPM_BUILD_ROOT%{_initrddir}
install -c -m 755 %SOURCE1 $RPM_BUILD_ROOT%{_initrddir}/wine
2253

2254 2255
%clean
rm -rf $RPM_BUILD_ROOT
2256

2257 2258
%pre
/usr/sbin/groupadd -g 66 -r wine &>/dev/null || :
2259

2260 2261 2262 2263 2264 2265 2266 2267
%post
if ! grep -q "^/usr/lib/wine$" /etc/ld.so.conf; then
	echo "/usr/lib/wine" >>/etc/ld.so.conf
fi
/sbin/ldconfig
/sbin/chkconfig --add wine
/sbin/chkconfig --level 2345 wine on
/sbin/service wine start &>/dev/null || :
2268

2269 2270 2271 2272
%preun
if test "$1" = "0"; then
	/sbin/chkconfig --del wine
fi
2273

2274 2275 2276 2277 2278 2279
%postun
if test "$1" = "0"; then
	perl -pi -e "s,^/usr/lib/wine$,,g" /etc/ld.so.conf
	/usr/sbin/groupdel wine &>/dev/null || :
fi
/sbin/ldconfig
2280

2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319
%files
%defattr(-,root,root)
%attr(0775, root, wine) %dir %{_datadir}/wine-c
%attr(0775, root, wine) %dir %{_datadir}/wine-c/windows
%attr(0775, root, wine) %dir %{_datadir}/wine-c/windows/system
%attr(0775, root, wine) %dir "%{_datadir}/wine-c/windows/Start Menu"
%attr(0775, root, wine) %dir "%{_datadir}/wine-c/windows/Start Menu/Programs"
%attr(0775, root, wine) %dir "%{_datadir}/wine-c/windows/Start Menu/Programs/Startup"
%attr(0775, root, wine) %dir %{_datadir}/wine-c/windows/Profiles
%attr(0775, root, wine) %dir %{_datadir}/wine-c/windows/Profiles/Administrator
%attr(0775, root, wine) %dir %{_datadir}/wine-c/windows/Fonts
%attr(0775, root, wine) %dir %{_datadir}/wine-c/windows/Desktop
%attr(0775, root, wine) %dir %{_datadir}/wine-c/windows/Favorites
%attr(0775, root, wine) %dir %{_datadir}/wine-c/windows/NetHood
%attr(0775, root, wine) %dir %{_datadir}/wine-c/windows/Recent
%attr(0775, root, wine) %dir %{_datadir}/wine-c/windows/SendTo
%attr(0775, root, wine) %dir %{_datadir}/wine-c/windows/ShellNew
%attr(0775, root, wine) %dir "%{_datadir}/wine-c/My Documents"
%attr(0775, root, wine) %dir "%{_datadir}/wine-c/Program Files"
%attr(0775, root, wine) %dir "%{_datadir}/wine-c/Program Files/Common Files"
%{_libdir}/wine
%{_bindir}/*
%{_mandir}/man?/*
%{_datadir}/wine-c/windows/system/*.dll
%{_datadir}/wine-c/windows/*.exe
%config %{_datadir}/wine-c/autoexec.bat
%config %{_datadir}/wine-c/config.sys
%attr(0664, root, wine) %config %{_datadir}/wine-c/windows/win.ini
%attr(0664, root, wine) %config %{_datadir}/wine-c/windows/system.ini
%config %{_sysconfdir}/wine/*
%config %{_initrddir}/*
%doc ANNOUNCE BUGS COPYING.LIB ChangeLog DEVELOPERS-HINTS LICENSE LICENSE.OLD README VERSION
%doc AUTHORS RedHat
%doc documentation/ChangeLog.OLD documentation/HOWTO-winelib documentation/README.fr
%doc documentation/wine-devel documentation/wine-user documentation/winelib-user documentation/samples

%files devel
%defattr(-,root,root)
%{_includedir}/*
2320 2321 2322


      </programlisting>
John R. Sheets's avatar
John R. Sheets committed
2323 2324 2325 2326 2327 2328

      </sect2>
  </sect1>

</chapter>

2329
<chapter id="pkg-todo"><Title>Work to be done</title>
John R. Sheets's avatar
John R. Sheets committed
2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342

    <para>
    In preparing this document, it became clear that there were
    still a range of action items to be done in Wine
    that would improve this packaging process.
    For lack of a better place, I record them here.
    <emphasis>This list is almost certain to be obsolete;
    check bugzilla for a better list.</emphasis>
    </para>

    <orderedlist>
        <listitem>
            <para>
2343
            Remove duplication of code between winesetup and
John R. Sheets's avatar
John R. Sheets committed
2344 2345 2346
            wineconf/wineinstall.
            </para>
            <para>
2347
            Currently, winesetup duplicates all of the code contained
John R. Sheets's avatar
John R. Sheets committed
2348 2349 2350 2351
            in wineconf.
            </para>
            <para>
            Instead, wineconf should be improved to generate
2352
            the new style config file, and then winesetup should
John R. Sheets's avatar
John R. Sheets committed
2353 2354 2355 2356 2357 2358
            rely on wineconf to generate the default
            configuration file.
            </para>
            <para>
            Similarly, there is functionality such as creating
            the default registry files that is now done by
2359
            both winesetup and wineinstall.
John R. Sheets's avatar
John R. Sheets committed
2360 2361 2362 2363 2364
            </para>
            <para>
            At this time, it seems like the right thing to do
            is to break up or parameterize wineinstall, so that
            it can be used for single function actions,
2365
            and then have winesetup call those functions.
John R. Sheets's avatar
John R. Sheets committed
2366 2367 2368 2369 2370
            </para>
        </listitem>

        <listitem>
            <para>
2371
            Enhance winesetup to support W: drive generation.
John R. Sheets's avatar
John R. Sheets committed
2372 2373 2374 2375
            </para>
            <para>
            The best practices convention now seems to be
            to generate a set of drives from M: through W:.
2376
            At this point, winesetup does not generate
John R. Sheets's avatar
John R. Sheets committed
2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412
            a default wine config file that follows
            these conventions. It should.
            </para>
        </listitem>

        <listitem>
            <para>
            Enhance Wine to allow more dynamic switching
            between the use of a real Windows partition
            and an empty one.
            </para>
        </listitem>

        <listitem>
            <para>
            Write a winelauncher utility application.
            </para>
            <para>
            Currently, Wine really requires a user to launch it
            from a command line, so that the user can look for
            error messages and warnings.  However, eventually, we will
            want users to be able to launch Wine from a more
            friendly GUI launcher.  The launcher should have the
            ability to allow the end user to turn on debugging
            messages and capture those traces for bug reporting
            purposes.  Also, if we make it possible to
            switch between use of a Windows partition or not
            automatically, that option should be controlled here.
            </para>
        </listitem>

        <listitem>
            <para>
            Get Marcus's winesetup facilities into CVS
            </para>
            <para>
2413
            Along the lines of the changes to winesetup,
John R. Sheets's avatar
John R. Sheets committed
2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434
            and the consolidation of wineconf and wineinstall,
            we should extract the good stuff from Marcus's
            winesetup script, and get it into CVS.
            Again, perhaps we should have a set of scripts
            that perform discrete functions, or maybe
            one script with parameters.
            </para>
        </listitem>

        <listitem>
            <para>
            Finish this document
            </para>
            <para>
            This document is pretty rough itself.  Many hard
            things aren't addressed, and lots of stuff was missed.
            </para>
        </listitem>
    </orderedlist>
</chapter>

2435 2436 2437 2438

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
2439
sgml-parent-document:("wine-doc.sgml" "book" "part" "chapter" "")
2440 2441
End:
-->