documentation/getting.sgml

   1   <chapter id="getting-wine">
   2     <title>Getting Wine</title>
   3     <para>
   4       If you decided that you can use and want to use Wine (e.g. after
   5       having read the <link linkend="introduction">introductory
   6       chapter</link>), then as a first step you need to find a good
   7       compatible Wine version that you like and that works on your
   8       system, and after you found one, the next step is to transfer its
   9       files to your system somehow.
  10       This chapter is here to tell you what you need to take care of
  11       in order to successfully accomplish these two steps.
  12     </para>
  13
  14     <sect1 id="getting-download">
  15       <title>How to download Wine?</title>
  16       <para>
  17         There are three different methods of how the files
  18         belonging to Wine may be brought (downloaded) to your system:
  19         <itemizedlist>
  20           <listitem>
  21           <para>Getting a single Wine <glossterm>package</glossterm> file
  22           (specifically adapted to your particular system), which
  23           contains various <glossterm>binary</glossterm> files of Wine</para>
  24           </listitem>
  25           <listitem>
  26           <para>Getting a single compressed archive file (usually .tar.gz), which contains
  27           all <glossterm>source code</glossterm> files of a standard Wine
  28           release version</para>
  29           </listitem>
  30           <listitem>
  31           <para>Downloading from a <glossterm>CVS</glossterm> server,
  32           which contains the very latest development source code files
  33           of Wine</para>
  34           </listitem>
  35         </itemizedlist>
  36       </para>
  37
  38       <sect2 id="getting-which-wine">
  39         <title>Which Wine form should I pick?</title>
  40
  41         <para>
  42          Now that we told you about the different Wine distribution
  43          methods available, let's discuss the advantages and
  44          disadvantages of the various methods.
  45         </para>
  46
  47         <variablelist>
  48           <title>Wine distribution methods</title>
  49           <varlistentry>
  50             <term><emphasis>Wine package file</emphasis></term>
  51
  52             <listitem>
  53               <para>
  54                 Intended user level: Beginner to Advanced
  55               </para>
  56
  57               <para>
  58                 Using Wine package files is easy for three
  59                 reasons:
  60                 They install everything else that's needed for their
  61                 operation, they usually preconfigure a lot, and you
  62                 don't need to worry about compiling anything or so.
  63                 However, the Wine Team doesn't have "official" packages.
  64                 All Wine packages are being offered by external groups,
  65                 with often slightly inaccurate or quite inaccurate Wine
  66                 environment setup.
  67                 Also, a package you downloaded might turn out to be
  68                 partially incompatible with your particular system
  69                 configuration.
  70                 Thus it might actually be <emphasis>better</emphasis>
  71                 to compile Wine from source and completely install it
  72                 on your own, by following the instructions in this
  73                 Guide.
  74               </para>
  75             </listitem>
  76           </varlistentry>
  77           <varlistentry>
  78             <term><emphasis>Wine source code via archive file</emphasis></term>
  79
  80             <listitem>
  81
  82               <para>
  83                 Intended user level: Advanced to Expert
  84               </para>
  85
  86               <para>
  87                 A Wine source code archive file can be used
  88                 if you want to compile your own standard Wine release.
  89                 By using differential patch files to newer Wine versions,
  90                 you can easily upgrade your outdated Wine directory.
  91                 However, as you need to manually download patch files
  92                 and you're only able to download the most current
  93                 standard Wine release, this is not necessarily the
  94                 best method to use.
  95                 The only advantage a Wine source archive has is that it
  96                 is a standard Wine release with less development
  97                 "quirks" than current CVS code.  Except for that, CVS
  98                 source code is much preferred and almost as easy.
  99               </para>
 100             </listitem>
 101           </varlistentry>
 102           <varlistentry>
 103             <term><emphasis>Wine source code via CVS checkout</emphasis></term>
 104             <listitem>
 105               <para>
 106                 Intended user level: Advanced to Expert/Developer
 107               </para>
 108
 109               <para>
 110                 The Wine CVS checkout offers the best way to take
 111                 part in bleeding edge Wine capabilities and
 112                 development, since you'll be able to download every
 113                 single CVS commit even <emphasis>beyond</emphasis> the
 114                 last official Wine release.
 115                 As upgrading a Wine CVS checkout tree to the latest
 116                 version is very easy, this is a recommended method
 117                 of installing Wine.
 118                 Plus, by carefully following the instructions in this
 119                 Guide, you'll be able to gain the very best Wine
 120                 environment compatibility (instead of falling victim
 121                 to package maintainers who fail to follow some
 122                 instructions in the Wine Packagers Guide).
 123               </para>
 124             </listitem>
 125           </varlistentry>
 126         </variablelist>
 127
 128         <para>
 129           To summarize, the "best" way to install Wine is to download
 130           Wine source code via CVS to get the newest code (which might
 131           be unstable!). Then you could easily compile and install the
 132           Wine files manually. The final configuration part (writing the
 133           configuration file and setting up the drive environment) could then
 134           be handled by WineSetupTk. All in all the best way to go,
 135           except for the about 500MB of disk space that you'll need.
 136         </para>
 137
 138         <para>
 139           With source code archive files, you have the advantage that you're
 140           running standard release versions, plus you can update to
 141           newer versions via patch files that we release.
 142           You won't have the newest code and the flexibility offered by CVS,
 143           though.
 144         </para>
 145
 146         <para>
 147           About binary package files: not sure. There's about a zillion
 148           reasons to not like them as much as you'd think: they may be
 149           outdated, they may not include "everything", they are
 150           <emphasis>not</emphasis> optimized for your particular
 151           environment (as opposed to a source compile, which would guess
 152           and set everything based on your system), they frequently fail
 153           to provide a completely configured Wine environment.
 154           On the plus side: they're pretty easy to install and they
 155           don't take as much space as a full-blown source code compile.
 156           But that's about it when it comes to their advantages.
 157           So I'd say they are OK if you want to have a
 158           <emphasis>quick</emphasis> way to have a test run of Wine, but
 159           for prolonged Wine use, configuring the environment on your
 160           own is probably better.
 161           Eventually this will change (we'll probably do some packaging
 162           efforts on our own at some time), but at the current explosive
 163           rate of Wine development, staying as close as possible to the
 164           actual Wine development that's going on is the way to go.
 165         </para>
 166
 167         <para>
 168           If you are running a distribution of Linux or some other
 169           system that uses packages to keep track of installed software,
 170           you should be in luck: A prepackaged version of Wine
 171           should already exist for your system.
 172           The following sections will tell you how to find the latest
 173           Wine packages and get them installed.  You should be careful,
 174           though, about mixing system packages between different distributions,
 175           and even from different versions of the same distribution.
 176           Often a package will only work on the distribution which it
 177           has been compiled for.  We'll cover
 178           <link linkend="getting-dist-debian">Debian Linux</link>,
 179           <link linkend="getting-dist-redhat">Red Hat Linux</link>,
 180           <link linkend="getting-freebsd">FreeBSD</link>, and
 181           <link linkend="getting-other">other</link> distributions.
 182         </para>
 183         <para>
 184           If you're not lucky enough to have a package available for
 185           your operating system, or if you'd prefer a newer version of
 186           Wine than already exists as a package, you will need to
 187           download the Wine source code and compile it yourself on your
 188           own machine.  Don't worry, it's not too hard to do this,
 189           especially with the many helpful tools that come with Wine.
 190           You don't need any programming experience to compile and
 191           install Wine, although it might be nice to have some minor
 192           UNIX administrative skills.  Working from the source is
 193           covered in the Wine Developer's Guide.
 194           The main problem with externally maintained package files is
 195           that they lack a standard configuration method, and in fact
 196           they often fail to configure Wine's Windows environment
 197           properly (which is outlined in the Wine Packagers Guide).
 198         </para>
 199       </sect2>
 200
 201     </sect1>
 202
 203     <sect1 id="getting-wine-package">
 204       <title>Getting a Wine package</title>
 205       <sect2 id="getting-dist-debian">
 206         <title>Debian Linux</title>
 207
 208         <para>
 209           In most cases on a Debian system (or any other distribution that
 210         uses packages that use the file name ending .deb, for that
 211         matter), you can download and install Wine with a
 212           single command, as <glossterm>root</glossterm>:
 213         </para>
 214   <screen>
 215   <prompt># </><userinput>apt-get install wine</>
 216   </screen>
 217         <para>
 218           <command>apt-get</command> will connect to a Debian archive
 219           across the Internet (thus, you must be online), then download
 220           the Wine package and install it on your system. End of story.
 221           You might first need to properly update your package setup,
 222           though, by using an <glossterm>editor</glossterm> as
 223           <glossterm>root</glossterm> to add an entry to
 224           <filename>/etc/apt/sources.list</filename> to point to an active
 225           package server and then running <command>apt-get
 226           update</command>.
 227         </para>
 228         <para>
 229           Once you're done with that step, you may skip the Wine
 230           installation chapter, since apt-get has not only downloaded,
 231           but also installed the Wine files already.
 232           Thus you can now go directly to the <link
 233           linkend="config-wine-main">Configuration section</link>.
 234         </para>
 235
 236         <para>
 237           However, if you don't want to or cannot use the automatic
 238           download method for .deb packages that
 239           <command>apt-get</command> provides, then please read on.
 240         </para>
 241         <para>
 242           Of course, Debian's pre-packaged version of Wine may not be
 243           the most recent release.  If you are running the stable
 244           version of Debian, you may be able to get a slightly newer
 245           version of Wine by grabbing the package from the so-called
 246           "unstable" Debian distribution, although this may be a little
 247           risky, depending on how far the unstable distribution has
 248           diverged from the stable one.  You can find a list of Wine
 249           binary packages for the various Debian releases using the
 250           package search engine at <ulink
 251           url="http://www.debian.org">www.debian.org</ulink>.
 252         </para>
 253
 254         <para>
 255           If you downloaded a separate .deb package file (e.g. a newer
 256           Wine release as stated above) that's not part of your
 257           distribution and thus cannot be installed via
 258           <command>apt-get</command>, you must use <command>dpkg</command> instead.
 259           For instructions on how to do this, please proceed to the
 260           <link linkend="installing">Installation section</link>.
 261         </para>
 262       </sect2>
 263
 264       <sect2 id="getting-dist-redhat">
 265         <title>Red Hat Linux</title>
 266
 267         <para>
 268           Red Hat users can use <ulink url="http://rpmfind.net/linux/RPM/">
 269             rpmfind.net</ulink> to track down available Wine RPM binaries.
 270           <ulink url="http://rpmfind.net/linux/RPM/WByName.html">This
 271             page</ulink> contains a list of all rpmfind packages that start with
 272           the letter "W", including a few Wine packages.
 273         </para>
 274       </sect2>
 275
 276       <sect2 id="getting-freebsd">
 277         <title>FreeBSD</title>
 278
 279         <para>
 280         In order to use Wine you need to build and install a new kernel
 281         with options USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG.
 282         </para>
 283
 284         <para>
 285         If you want to install Wine using the FreeBSD port system, run
 286         in a <glossterm>terminal</glossterm>:
 287         </para>
 288   <screen>
 289   <prompt>$ </><userinput>su -</>
 290   <prompt># </><userinput>cd /usr/port/emulators/</>
 291   <prompt># </><userinput>make</>
 292   <prompt># </><userinput>make install</>
 293   <prompt># </><userinput>make clean</>
 294   </screen>
 295         <para>
 296           This process will get wine source from the Internet,
 297           then download the Wine package and install it on your system.
 298         </para>
 299
 300         <para>
 301         If you want to install Wine from the FreeBSD CD-ROM, run in a
 302         <glossterm>terminal</glossterm>:
 303         </para>
 304 <screen>
 305 <prompt>$ </><userinput>su -</>
 306 <prompt># </><userinput>mount /cdrom</>
 307 <prompt># </><userinput>cd /cdrom/packages/All</>
 308 <prompt># </><userinput>pkg_add wine_.X.X.X.tgz</>
 309 </screen>
 310          <para>
 311          </para>
 312          <para>
 313            These FreeBSD install instructions completely install the
 314            Wine files on your system; you may then proceed to the <link
 315            linkend="config-wine-main">Configuration section</link>.
 316          </para>
 317       </sect2>
 318
 319       <sect2 id="getting-other">
 320         <title>Other systems</title>
 321
 322         <para>
 323           The first place you should look if your system isn't
 324           specifically mentioned above is the <ulink
 325           url="http://www.winehq.com/download/">WineHQ Download
 326           Page</ulink>.  This page lists many assorted archives of
 327           binary (precompiled) Wine files.
 328         </para>
 329
 330         <para>
 331           You could also try to use
 332           <ulink url="http://www.google.com/search?q=wine+package+download">
 333             Google</ulink> to track down miscellaneous distribution packages.
 334         </para>
 335
 336         <note>
 337         <para>
 338           If you are running a Mandrake system, please see the page
 339           on how to get Wine for a
 340           <link linkend="getting-dist-redhat">Red Hat</link> system,
 341           as Mandrake is based on Red Hat.
 342         </para>
 343         </note>
 344
 345       </sect2>
 346       <!-- *** Add other distributions, e.g., SUSE, Slackware *** -->
 347
 348     </sect1>
 349
 350     <sect1 id="getting-wine-source">
 351       <title>Getting Wine source code</title>
 352
 353       <para>
 354         If you are going to compile Wine (instead of installing binary
 355         Wine files), either to use the most recent code possible or to
 356         improve it, then the first thing to do is to obtain a copy of
 357         the source code. We'll cover how to retrieve and compile the
 358         official source releases from the <link
 359         linkend="getting-source-ftp">FTP archives</link>, and also how
 360         to get the cutting edge up-to-the-minute fresh Wine source code
 361         from <link linkend="getting-source-cvs">CVS (Concurrent Versions
 362         System)</link>.
 363       </para>
 364
 365       <para>
 366         Once you have downloaded Wine source code according to the
 367         instructions below, there are two ways to proceed: If you want
 368         to manually install and configure Wine, then go to the <link
 369         linkend="compiling">Compiling</link> section. If instead you
 370         want automatic installation, then go straight to the <link
 371         linkend="config-wine-main">Configuration section</link> to make
 372         use of <command>wineinstall</command> to automatically install
 373         and configure Wine.
 374       </para>
 375
 376       <para>
 377         You may also need to know how to apply a source code patch to
 378         your version of Wine.  Perhaps you've uncovered
 379         a bug in Wine, reported it to the
 380         <ulink url="http://bugs.winehq.org">Wine Bugzilla</ulink>
 381         or the
 382         <ulink url="mailto:wine-devel@winehq.com">Wine mailing list</ulink>,
 383         and received a patch from a developer to hopefully fix the
 384         bug.  We will show you how to
 385         <link linkend="getting-upgrading-patch">safely apply the
 386         patch</link> and revert it if it doesn't work.
 387       </para>
 388
 389       <sect2 id="getting-source-ftp">
 390         <title>Getting Wine Source Code from an FTP Archive</title>
 391
 392         <para>
 393           The safest way to grab the source is from one of the official
 394           FTP archives.  An up to date listing is in the <ulink
 395           url="http://www.winehq.com/source/ANNOUNCE">ANNOUNCE</ulink>
 396           file in the Wine distribution (which you would have if you
 397           already downloaded it).  Here is a list
 398           of FTP servers carrying Wine:
 399         </para>
 400         <itemizedlist>
 401           <listitem>
 402             <para>
 403               <ulink url="ftp://ftp.ibiblio.org/pub/Linux/ALPHA/wine/development/">
 404                 ftp://ftp.ibiblio.org/pub/Linux/ALPHA/wine/development/
 405               </ulink>
 406             </para>
 407           </listitem>
 408           <listitem>
 409             <para>
 410               <ulink url="ftp://ftp.infomagic.com/pub/mirrors/linux/sunsite/ALPHA/wine/development/">
 411                 ftp://ftp.infomagic.com/pub/mirrors/linux/sunsite/ALPHA/wine/development/
 412               </ulink>
 413             </para>
 414           </listitem>
 415           <listitem>
 416             <para>
 417               <ulink url="ftp://ftp.fu-berlin.de/unix/linux/mirrors/sunsite.unc.edu/ALPHA/wine/development/">
 418                 ftp://ftp.fu-berlin.de/unix/linux/mirrors/sunsite.unc.edu/ALPHA/wine/development/
 419               </ulink>
 420             </para>
 421           </listitem>
 422           <listitem>
 423             <para>
 424               <ulink url="ftp://orcus.progsoc.uts.edu.au/pub/Wine/development/">
 425                 ftp://orcus.progsoc.uts.edu.au/pub/Wine/development/
 426               </ulink>
 427             </para>
 428           </listitem>
 429         </itemizedlist>
 430         <para>
 431           The official releases are tagged by date with the format
 432           "Wine-<replaceable>YYYYMMDD</>.tar.gz".  Your best bet is to grab
 433           the latest one.
 434         </para>
 435         <para>
 436           I'd recommend placing the Wine archive file that you chose
 437           into the directory where you intend to extract Wine. In this
 438           case, let's just assume that it is your home directory.
 439         </para>
 440         <para>
 441           Once you have downloaded a Wine archive file, we need to
 442           extract the archive file. This is not very hard to do. First
 443           switch to the directory containing the file you just
 444           downloaded. Then extract the source in a
 445           <glossterm>terminal</glossterm> with (e.g.):
 446 <screen>
 447 <prompt>$ </><userinput>tar xvzf wine-<replaceable>20030115</>.tar.gz</>
 448 </screen>
 449         </para>
 450         <para>
 451           Just in case you happen to get a Wine archive that uses
 452           <filename>.tar.bz2</filename> extension instead of
 453           <filename>.tar.gz</filename>:
 454           Simply use <command>tar xvjf</command> in that case instead.
 455         </para>
 456         <para>
 457           Since you now have a fully working Wine source tree by
 458           having followed the steps above, you're now well-prepared to
 459           go to the Wine installation and configuration steps that follow.
 460         </para>
 461       </sect2>
 462
 463       <sect2 id="getting-source-cvs">
 464         <title>Getting Wine Source Code from CVS</title>
 465         <!-- this part is sort of duplicated in cvs.sgml
 466              (this representation is meant to be a very short intro
 467              instead, but it's similar). Please don't forget to update both!
 468         -->
 469
 470         <para>
 471           This part is intended to be quick and easy, showing the bare minimum
 472           of what is needed to download Wine source code via CVS.
 473           If you're interested in a very verbose explanation of CVS or
 474           advanced CVS topics (configuration settings, CVS mirror servers,
 475           other CVS modules on WineHQ, CVSWeb, ...), then please read
 476           the full CVS chapter in the Wine Developer's Guide.
 477         </para>
 478
 479         <sect3>
 480           <title>CVS installation check</title>
 481           <para>
 482             First you need to make sure that you have <command>cvs</command>
 483             installed.
 484             To check whether this is the case, please run in a
 485             <glossterm>terminal</glossterm>:
 486           </para>
 487           <screen>
 488           <prompt>$ </><userinput>cvs</>
 489           </screen>
 490           <para>
 491             If this was successful, then you should have gotten a nice CVS
 492             "Usage" help output.  Otherwise (e.g. an error "cvs: command
 493             not found") you still need to install a CVS package for your
 494             particular operating system, similar to the instructions given
 495             in the chapters for getting and installing a Wine package on
 496             various systems.
 497           </para>
 498         </sect3>
 499
 500         <sect3>
 501           <title>Configuring Wine-specific CVS settings</title>
 502
 503           <para>
 504             First, you should do a
 505           </para>
 506           <screen>
 507           <prompt>$ </><userinput>touch ~/.cvspass</>
 508           </screen>
 509           <para>
 510             to create or update the file <filename>.cvspass</filename> in
 511             your home directory, since CVS needs this file (for password
 512             and login management) and will complain loudly if it doesn't exist.
 513           </para>
 514
 515           <para>
 516             Second, we need to create the file
 517             <filename>.cvsrc</filename> in your home directory
 518             containing the CVS configuration settings needed for a valid
 519             Wine CVS setup (use CVS compression, properly update file and
 520             directory information, ...).
 521             The content of this file should look like the following:
 522             <programlisting>
 523 cvs -z 3
 524 update -PAd
 525 diff -u
 526 checkout -P
 527             </programlisting>
 528             Create the file with an <glossterm>editor</glossterm>
 529             of your choice, either by running
 530             <screen>
 531             <prompt>$ </><userinput>&lt;editor&gt; ~/.cvsrc</>
 532             </screen>
 533             , where &lt;editor&gt; is the editor you want to use (e.g.
 534             <command>joe</command>, <command>ae</command>,
 535             <command>vi</command>),
 536             or by creating the file <filename>.cvsrc</filename> in your
 537             home directory with your favourite graphical editor like nedit, kedit,
 538             gedit or others.
 539           </para>
 540         </sect3>
 541
 542         <sect3>
 543           <title>Downloading the Wine CVS tree</title>
 544
 545           <para>
 546             Once CVS is installed and the Wine specific CVS
 547             configuration is done, you can now do a login on our CVS
 548             server and checkout (download) the Wine source code.
 549             First, let's do the server login:
 550           </para>
 551           <screen>
 552           <prompt>$ </><userinput>cvs -d :pserver:cvs@cvs.winehq.com:/home/wine login</>
 553           </screen>
 554           <para>
 555             If <command>cvs</command> successfully connects to the CVS server,
 556             then you will get a "CVS password:" prompt.
 557             Simply enter "cvs" as the password (the password is
 558             <emphasis>case sensitive</emphasis>: no capital letters!).
 559           </para>
 560
 561           <para>
 562             After login, we are able to download the Wine source code tree.
 563             Please make sure that you are in the directory that you want
 564             to have the Wine source code in (the Wine source code will
 565             use the subdirectory <filename>wine/</filename> in this
 566             directory, since the subdirectory is named after the CVS module
 567             that we want to check out). We assume that your current directory
 568             might be your user's home directory.
 569             To download the Wine tree into the subdirectory <filename>wine/</filename>, run:
 570           </para>
 571           <screen>
 572           <prompt>$ </><userinput>cvs -d :pserver:cvs@cvs.winehq.com:/home/wine checkout wine</>
 573           </screen>
 574           <para>
 575             Downloading the CVS tree might take a while (some minutes
 576             to few hours), depending on your connection speed.
 577             Once the download is finished, you should keep a note of
 578             which directory the newly downloaded
 579             <filename>wine/</filename> directory is in, by running
 580             <command>pwd</command> (Print Working Directory):
 581           </para>
 582           <screen>
 583           <prompt>$ </><userinput>pwd</>
 584           </screen>
 585           <para>
 586             Later, you will be able to change to this directory by
 587             running:
 588           </para>
 589           <screen>
 590           <prompt>$ </><userinput>cd <replaceable>&lt;some_dir&gt;</></>
 591           </screen>
 592           <para>
 593             , where &lt;some_dir&gt; is the directory that
 594             <command>pwd</command> gave you.
 595             By running
 596           </para>
 597           <screen>
 598           <prompt>$ </><userinput>cd wine</>
 599           </screen>
 600           <para>
 601             , you can now change to the directory of the Wine CVS tree
 602             you just downloaded. Since you now have a fully working Wine
 603             source tree by having followed the steps above, you're now
 604             well-prepared to go to the Wine installation and configuration
 605             steps that follow.
 606           </para>
 607         </sect3>
 608       </sect2>
 609
 610       <sect2 id="getting-updating-cvs">
 611         <title>Updating the Wine CVS tree</title>
 612
 613         <para>
 614           After a while, you might want to update your Wine CVS tree to
 615           the current version.
 616           Before updating the Wine tree, it might also be a good idea
 617           to run <command>make uninstall</command> as root in order to
 618           uninstall the installation of the previous Wine version.
 619         </para>
 620         <para>
 621           To proceed with updating Wine, simply <command>cd</command>
 622           to the Wine CVS tree directory, then run:
 623         </para>
 624         <screen>
 625         <prompt>$ </><userinput>make distclean</>
 626         <prompt>$ </><userinput>cvs -d :pserver:cvs@cvs.winehq.com:/home/wine update</>
 627         </screen>
 628         <para>
 629           The <command>make distclean</command> part is optional, but
 630           it's a good idea to remove old build and compile configuration
 631           files before updating to a newer Wine version.  Once the CVS
 632           update is finished, you can proceed with installing Wine again
 633           as usual.
 634         </para>
 635       </sect2>
 636
 637       <sect2 id="getting-upgrading-patch">
 638         <title>Updating Wine with a Patch</title>
 639         <para>
 640           If you got Wine source code (e.g. via a tar archive file), you
 641           have the option of applying patches to the source tree to
 642           update to a newer Wine release or to fix bugs and add
 643           experimental features.  Perhaps you've found a bug, reported
 644           it to the <ulink url="mailto:wine-devel@winehq.com">Wine
 645           mailing list</>, and received a patch file to fix the bug.
 646           You can apply the patch with the <command>patch</> command,
 647           which takes a streamed patch from <filename>stdin</>:
 648 <screen>
 649 <prompt>$ </><userinput>cd wine</>
 650 <prompt>$ </><userinput>patch -p0 &lt;<replaceable>../patch_to_apply.diff</></>
 651 </screen>
 652         </para>
 653         <para>
 654           To remove the patch, use the <parameter>-R</> option:
 655 <screen>
 656 <prompt>$ </><userinput>patch -p0 -R &lt;<replaceable>../patch_to_apply.diff</></>
 657 </screen>
 658         </para>
 659         <para>
 660           If you want to do a test run to see if the patch will apply
 661           successfully (e.g., if the patch was created from an older or
 662           newer version of the tree), you can use the
 663           <parameter>--dry-run</> parameter to run the patch
 664           without writing to any files:
 665 <screen>
 666 <prompt>$ </><userinput>patch -p0 --dry-run &lt;<replaceable>../patch_to_apply.d
 667 iff</></>
 668 </screen>
 669         </para>
 670         <para>
 671           <command>patch</> is pretty smart about extracting
 672           patches from the middle of a file, so if you save an email with
 673           an inlined patch to a file on your hard drive, you can invoke
 674           patch on it without stripping out the email headers and other
 675           text.  <command>patch</> ignores everything that doesn't
 676           look like a patch.
 677         </para>
 678         <para>
 679           The <parameter>-p0</> option to <command>patch</>
 680           tells it to keep the full file name from the patch file. For example,
 681           if the file name in the patch file was
 682            <filename>wine/programs/clock/main.c</>.
 683           Setting the <parameter>-p0</> option would apply the patch
 684           to the file of the same name i.e.
 685           <filename>wine/programs/clock/main.c </>.
 686           Setting the <parameter>-p1</> option would strip off the
 687           first part of the file name and apply
 688           the patch to <filename>programs/clock/main.c</>.
 689           The <parameter>-p1</> option would be useful if you named your
 690           top level wine directory differently than the person who sent
 691           you the patch. For the <parameter>-p1</> option
 692           <command>patch</> should be run from the top level wine
 693           directory.
 694         </para>
 695       </sect2>
 696     </sect1>
 697
 698   </chapter>
 699
 700 <!-- Keep this comment at the end of the file
 701 Local variables:
 702 mode: sgml
 703 sgml-parent-document:("wine-user.sgml" "set" "book" "chapter" "")
 704 End:
 705 -->