diff --git a/documentation/Makefile.in b/documentation/Makefile.in index bbabb82b1be..553f64d66d6 100644 --- a/documentation/Makefile.in +++ b/documentation/Makefile.in @@ -12,12 +12,10 @@ EXTRASUBDIRS = samples WINE_USER_SRCS = \ bugs.sgml \ - compiling.sgml \ configuring.sgml \ fonts.sgml \ getting.sgml \ glossary.sgml \ - installing.sgml \ introduction.sgml \ printing.sgml \ registry.sgml \ diff --git a/documentation/compiling.sgml b/documentation/compiling.sgml deleted file mode 100644 index 3832a3a65b1..00000000000 --- a/documentation/compiling.sgml +++ /dev/null @@ -1,70 +0,0 @@ - - Compiling the Wine Source - - - In case you downloaded Wine source code files, this chapter will - tell you how to compile it into binary files before installing them. - Otherwise, please proceed directly to the Installation chapter to install the - binary Wine files. - - - - Compiling Wine - - - Commands - - To compile and install Wine, run the following commands: - -./configure -make depend -make -make install - - Please note that the last command (make install) - must be run as root. - - - - - - Requirements - - For an up-to-date list of software requirements for compiling - Wine and instructions how to actually do it, please see the README file, - which is also available in the main directory of a Wine source - code tree. - - - - - Space required - - You also need about 400 MB of available disk space for compilation. - The compiled libwine.so binary takes around 5 MB of disk space, - which can be reduced to about 1 MB by stripping ('strip wine'). - Stripping is not recommended, however, as you can't submit - proper crash reports with a stripped binary. - - - - - Common problems - - If you get a repeatable sig11 compiling shellord.c, thunk.c - or other files, try compiling just that file without optimization - (removing the -Ox option from the GCC command in the - corresponding Makefile). - - - - - - diff --git a/documentation/getting.sgml b/documentation/getting.sgml index e7ad6f70fd5..0c6defa99d3 100644 --- a/documentation/getting.sgml +++ b/documentation/getting.sgml @@ -1,591 +1,190 @@ Getting Wine - - If you decided that you can use and want to use Wine (e.g. after - having read the introductory - chapter), then as a first step you need to find a good - compatible Wine version that you like and that works on your - system, and after you found one, the next step is to transfer its - files to your system somehow. - This chapter is here to tell you what you need to take care of - in order to successfully accomplish these two steps. - - - - How to download Wine? + + Wine Installation Methods - There are three different methods of how the files - belonging to Wine may be brought (downloaded) to your system: - - - - Getting a single Wine package file - (specifically adapted to your particular system), which - contains various binary files of Wine - - - - - Getting a single compressed archive file (usually .tar.gz), which contains - all source code files of a standard Wine - release version - - - - - Downloading from a CVS server, - which contains the very latest development source code files - of Wine - - - + Once you've decided that Wine is right for your needs, the next step is + to decide how you want to install it. There are three methods for + installing Wine from Winehq, each with their own advantages and + disadvantages. - - Which Wine form should I pick? - + + Installation from a package - Now that we told you about the different Wine distribution - methods available, let's discuss the advantages and - disadvantages of the various methods. - - - - Wine distribution methods - - Wine package file - - - - Intended user level: Beginner to Advanced - - - - Using Wine package files is easy for three - reasons: - They install everything else that's needed for their - operation, they usually preconfigure a lot, and you - don't need to worry about compiling anything or so. - You can get the official wine packages from - - the sourceforge.net Wine download page - - - - - - Wine source code via archive file - - - - - Intended user level: Advanced to Expert - - - - A Wine source code archive file can be used - if you want to compile your own standard Wine release. - By using differential patch files to newer Wine versions, - you can easily upgrade your outdated Wine directory. - However, as you need to manually download patch files - and you're only able to download the most current - standard Wine release, this is not necessarily the - best method to use. - The only advantage a Wine source archive has is that it - is a standard Wine release with less development - "quirks" than current CVS code. Except for that, CVS - source code is much preferred and almost as easy. - - - - - Wine source code via CVS checkout - - - Intended user level: Advanced to Expert/Developer - - - - The Wine CVS checkout offers the best way to take - part in bleeding edge Wine capabilities and - development, since you'll be able to download every - single CVS commit even beyond the - last official Wine release. - As upgrading a Wine CVS checkout tree to the latest - version is very easy, this is a recommended method - of installing Wine. - Plus, by carefully following the instructions in this - Guide, you'll be able to gain the very best Wine - environment compatibility. - - - - - - - If you are running a distribution of Linux or some other - system that uses packages to keep track of installed software, - you should be in luck: A prepackaged version of Wine - should already exist for your system. - The following sections will tell you how to find the latest - Wine packages and get them installed. You should be careful, - though, about mixing system packages between different distributions, - and even from different versions of the same distribution. - Often a package will only work on the distribution which it - has been compiled for. We'll cover - Debian Linux, - Red Hat, Mandrake, SUSE and Slackware Linux, - FreeBSD, and - other distributions. + By far the easiest method for installing Wine is to use a prepackaged + version of Wine. These packages contain ready-to-run Wine binary + files specifically compiled for your distribution, and they are + tested regularly by the packagers for both functionality and + completeness. - If you're not lucky enough to have a package available for - your operating system, or if you'd prefer a newer version of - Wine than already exists as a package, you will need to - download the Wine source code and compile it yourself on your - own machine. Don't worry, it's not too hard to do this, - especially with the many helpful tools that come with Wine. - You don't need any programming experience to compile and - install Wine, although it might be nice to have some minor - UNIX administrative skills. Working from the source is - covered in the Wine Developer's Guide. + Packages are the recommended method for installing Wine. We make + them easily available at the + WineHQ downloads page + , and these are always the latest packages available. Being + popular, Wine packages can also be found elsewhere in official + distribution repositories. These can, however, sometimes be out of + date, depending on the distribution. Packages are easily upgradable + as well, and many distributions can upgrade Wine seamlessly with a + few clicks. Building your own installable binary package from a + source package is also possible, although it is beyond the scope of + this guide. + + + + Installation from a source archive + + Sometimes the Wine packages don't fit your needs exactly. Perhaps + they're not available for your architecture or distribution, or + perhaps you want to build wine using your own compiler optimizations + or with some options disabled, or perhaps you need to modify a + specific part of the source code before compilation. Being an open + source project, you are free to do all of these things with Wine's + source code, which is provided with every Wine release. This method + of installation can be done by downloading a Wine source archive and + compiling from the command line. If you are comfortable with such + things and have special needs, this option may be for you. + + + Getting Wine source archives is simple. Every release, we put a + source package in compressed tar.gz format at the + WineHQ downloads + page. Compiling and installing Wine from source is slightly + more difficult than using a package, however we will cover it in + depth and attempt to hold your hand along the way. + + Installation from a cvs snapshot + + If you wish to try out the bleeding edge of Wine development, or + would even like to help develop Wine yourself, you can download the + very latest source code from our CVS server. Instructions for + downloading from the Wine cvs repository are available at http://www.winehq.org/site/cvs + . + + + Please take note that the usual warnings for using a developmental + version still apply. The source code on the CVS server is largely + untested and may not even compile properly. It is, however, the + best way to test out how Wine will work in the next version, and if + you're modifying source code it's best to get the latest copy. The + CVS repository is also useful for application maintainers interested + in testing if an application will still work right for the next + release, or if a recent patch actually improves things. If you're + interested in helping us to get an application working in Wine, see + the + guide to helping applications work. + + - - Getting a Wine package - - Debian Linux - + + Installing Wine from a package + + Installing a fresh package - In most cases on a Debian system (or any other distribution that - uses packages that use the file name ending .deb, for that - matter), you can download and install Wine with a - single command, as root: - - - # apt-get install wine - - - apt-get will connect to a Debian archive - across the Internet (thus, you must be online), then download - the Wine package and install it on your system. End of story. - You might first need to properly update your package setup, - though, by using an editor as - root to add an entry to - /etc/apt/sources.list to point to an active - package server and then running apt-get - update. - - - Once you're done with that step, you may skip the Wine - installation chapter, since apt-get has not only downloaded, - but also installed the Wine files already. - Thus you can now go directly to the Configuration section. - - - - However, if you don't want to or cannot use the automatic - download method for .deb packages that - apt-get provides, then please read on. - - - Of course, Debian's pre-packaged version of Wine may not be - the most recent release. If you are running the stable - version of Debian, you may be able to get a slightly newer - version of Wine by grabbing the package from the so-called - "unstable" Debian distribution, although this may be a little - risky, depending on how far the unstable distribution has - diverged from the stable one. You can find a list of Wine - binary packages for the various Debian releases using the - package search engine at www.debian.org. - - - - If you downloaded a separate .deb package file (e.g. a newer - Wine release as stated above) that's not part of your - distribution and thus cannot be installed via - apt-get, you must use dpkg instead. - For instructions on how to do this, please proceed to the - Installation section. - + Installing a package on a fresh system is remarkably straightforward. + Simply download and install the package using whatever utility your + distribution provides. There is usually no need to explicitly + remove old packages before installing, as modern Linux distributions + should upgrade and replace them automatically. If you installed + Wine from source code, however, you should remove it before + installing a Wine package. See the section on uninstalling Wine from source + for proper instructions. - - - Linux Red Hat, Mandrake, SUSE, and Slackware - + + Different Distributions - Red Hat, Mandrake, SUSE and Slackware users can download - a wine binary from the - - sourceforge.net Wine download page + Wine works on a huge amount of different Linux distributions, as well + other Unix-like systems such as Solaris and FreeBSD, each with their + own specific way of installing and managing packages. Fortunately, + however, the same general ideas apply to all of them, and installing + Wine should be no more difficult than installing any other software, + no matter what distribution you use. Uninstalling Wine packages is + simple as well, and in modern Linux distributions is usually done + through the same easy interface as package installation. + + + We won't cover the specifics of installing or uninstalling Wine + packages among the various systems' methods of packaging and package + management in this guide, however, up to date installation notes for + particular distributions can be found at the WineHQ website in the + howto, at . If you need further help figuring + out how to simply install a Wine package, we suggest consulting your + distribution's documentation, support forums, or IRC channels. - - - FreeBSD - - - In order to use Wine you need to build and install a new kernel - with options USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG. - - - - If you want to install Wine using the FreeBSD port system, run - in a terminal: - - - $ su - - # cd /usr/ports/emulators/wine/ - # make - # make install - # make clean - - - This process will get wine source from the Internet, - then download the Wine package and install it on your system. - - - - If you want to install Wine from the FreeBSD CD-ROM, run in a - terminal: - - - $ su - - # mount /cdrom - # cd /cdrom/packages/All - # pkg_add wine_.X.X.X.tgz - - - - - These FreeBSD install instructions completely install the - Wine files on your system; you may then proceed to the Configuration section. - - - You can also download a FreeBSD package of wine from the - - sourceforge.net Wine download page - - - - - Other systems - - - The first place you should look if your system isn't - specifically mentioned above is the WineHQ Download - Page. This page lists many assorted archives of - binary (precompiled) Wine files. - - - - You could also try to use - - Google to track down miscellaneous distribution packages. - - - - - - - Getting Wine source code - + + Installing Wine from source - If you are going to compile Wine (instead of installing binary - Wine files), either to use the most recent code possible or to - improve it, then the first thing to do is to obtain a copy of - the source code. We'll cover how to retrieve and compile the - source releases from the official archives, and also how - to get the cutting edge up-to-the-minute fresh Wine source code - from CVS (Concurrent Versions - System). + Before installing Wine from source, make sure you uninstall any Wine + binary packages you may have on your system. Installing from source + requires use of the terminal window as well as a full copy of the + Wine source code. Once having downloaded the source from CVS or + extracted it from an archive, navigate to it using the terminal and + then follow the remaining steps. - - - Once you have downloaded Wine source code according to the - instructions below, there are two ways to proceed: If you want - to manually install and configure Wine, then go to the Compiling section. If instead you - want automatic installation, then go straight to the Configuration section to make - use of wineinstall to automatically install - and configure Wine. - - - - You may also need to know how to apply a source code patch to - your version of Wine. Perhaps you've uncovered - a bug in Wine, reported it to the - Wine Bugzilla - or the - Wine mailing list, - and received a patch from a developer to hopefully fix the - bug. We will show you how to - safely apply the - patch and revert it if it doesn't work. - - - - Getting Wine Source Code from the official archives - + + Getting the Build Dependencies - The safest way to grab the source is from one of the official - archives. An up to date listing is in the ANNOUNCE - file in the Wine distribution (which you would have if you - already downloaded it). Here is a list - of servers carrying Wine: + Wine makes use of many open source libraries during its operation. + While Wine is not strictly dependent on these libraries and will + compile without most of them, much of Wine's functionality is + improved by having them available at compile time. In the past, + many user problems were caused by people not having the necessary + development libraries when they built Wine from source; because of + this reason and others, we highly recommend installing via binary + packages or by building source packages which can automatically + satisfy their build dependencies. - - - - - ftp://ftp.ibiblio.org/pub/Linux/ALPHA/wine/development/ - - - - - - - sourceforge.net download page - - - - - The official releases are tagged by date with the format - "Wine-YYYYMMDD.tar.gz". Your best bet is to grab - the latest one. + If you wish to install build dependencies by hand, there are several + ways to see if you're missing some useful development libraries. + The most straightforward approach is to watch the configure program's + output before you compile Wine and see if anything important is + missing; if it is, simply install what's missing and rerun configure + before compiling. You can also check the file configure generates, + (include/config.h.in) and see if what files configure is looking for + but not finding. - - I'd recommend placing the Wine archive file that you chose - into the directory where you intend to extract Wine. In this - case, let's just assume that it is your home directory. - - - Once you have downloaded a Wine archive file, we need to - extract the archive file. This is not very hard to do. First - switch to the directory containing the file you just - downloaded. Then extract the source in a - terminal with (e.g.): - - $ tar xvzf wine-20030115.tar.gz - - - - Just in case you happen to get a Wine archive that uses - .tar.bz2 extension instead of - .tar.gz: - Simply use tar xvjf in that case instead. - - - Since you now have a fully working Wine source tree by - having followed the steps above, you're now well-prepared to - go to the Wine installation and configuration steps that follow. - - - - Getting Wine Source Code from CVS - + + Compiling Wine - This part is intended to be quick and easy, showing the bare minimum - of what is needed to download Wine source code via CVS. - If you're interested in a very verbose explanation of CVS or - advanced CVS topics (configuration settings, CVS mirror servers, - other CVS modules on WineHQ, CVSWeb, ...), then please read - the full CVS chapter in the Wine Developer's Guide. + Once you've installed the build dependencies you need, you're ready + to compile the package. In the terminal window, after having + navigated to the Wine source tree, run the following commands: + + $ ./configure + # make depend + # make + # make install + + The last command requires root privileges. Although you should + never run Wine as root, you will need to install it this way. - - - CVS installation check - - First you need to make sure that you have cvs - installed. - To check whether this is the case, please run in a - terminal: - - - $ cvs - - - If this was successful, then you should have gotten a nice CVS - "Usage" help output. Otherwise (e.g. an error "cvs: command - not found") you still need to install a CVS package for your - particular operating system, similar to the instructions given - in the chapters for getting and installing a Wine package on - various systems. - - - - - Downloading the Wine CVS tree - - - Once CVS is installed, you can now do a login on our CVS - server and checkout (download) the Wine source code. - First, let's do the server login, to connect to the US server: - - - $ export CVSROOT=:pserver:cvs@cvs.winehq.org:/home/wine - $ cvs login - - - To connect to the EU server: - - - $ export CVSROOT=:pserver:cvs@rhlx01.fht-esslingen.de:/home/wine - $ cvs login - - - If cvs successfully connects to the CVS server, - then you will get a "CVS password:" prompt. - Simply enter "cvs" as the password (the password is - case sensitive: no capital letters!). - - - - After login, we are able to download the Wine source code tree. - Please make sure that you are in the directory that you want - to have the Wine source code in (the Wine source code will - use the subdirectory wine/ in this - directory, since the subdirectory is named after the CVS module - that we want to check out). We assume that your current directory - might be your user's home directory. - To download the Wine tree into the subdirectory wine/, run: - - - $ cvs -z3 checkout wine - - - Downloading the CVS tree might take a while (some minutes - to few hours), depending on your connection speed. - Once the download is finished, you should keep a note of - which directory the newly downloaded - wine/ directory is in, by running - pwd (Print Working Directory): - - - $ pwd - - - Later, you will be able to change to this directory by - running: - - - $ cd <some_dir> - - - where <some_dir> is the directory that - pwd gave you. - By running - - - $ cd wine - - - you can now change to the directory of the Wine CVS tree - you just downloaded. Since you now have a fully working Wine - source tree by having followed the steps above, you're now - well-prepared to go to the Wine installation and configuration - steps that follow. - - - - - Updating the Wine CVS tree - - - After a while, you might want to update your Wine CVS tree to - the current version. - Before updating the Wine tree, it might also be a good idea - to run make uninstall as root in order to - uninstall the installation of the previous Wine version. - - - To proceed with updating Wine, simply cd - to the Wine CVS tree directory, then run, if you're using the US server: - - - $ make distclean - $ cvs update -PAd - - - The make distclean part is optional, but - it's a good idea to remove old build and compile configuration - files before updating to a newer Wine version. Once the CVS - update is finished, you can proceed with installing Wine again - as usual. - - - - - Updating Wine with a Patch + + Uninstalling Wine from Source - If you got Wine source code (e.g. via a tar archive file), you - have the option of applying patches to the source tree to - update to a newer Wine release or to fix bugs and add - experimental features. Perhaps you've found a bug, reported - it to the Wine - mailing list, and received a patch file to fix the bug. - You can apply the patch with the patch command, - which takes a streamed patch from stdin: - - $ cd wine - $ patch -p0 <../patch_to_apply.diff - - - - To remove the patch, use the -R option: - - $ patch -p0 -R <../patch_to_apply.diff - - - - If you want to do a test run to see if the patch will apply - successfully (e.g., if the patch was created from an older or - newer version of the tree), you can use the - --dry-run parameter to run the patch - without writing to any files: - - $ patch -p0 --dry-run <../patch_to_apply.diff - - - - patch is pretty smart about extracting - patches from the middle of a file, so if you save an email with - an inlined patch to a file on your hard drive, you can invoke - patch on it without stripping out the email headers and other - text. patch ignores everything that doesn't - look like a patch. - - - The -p0 option to patch - tells it to keep the full file name from the patch file. For example, - if the file name in the patch file was - wine/programs/clock/main.c. - Setting the -p0 option would apply the patch - to the file of the same name i.e. - wine/programs/clock/main.c . - Setting the -p1 option would strip off the - first part of the file name and apply - the patch to programs/clock/main.c. - The -p1 option would be useful if you named your - top level wine directory differently than the person who sent - you the patch. For the -p1 option - patch should be run from the top level wine - directory. + To uninstall Wine from source, once again navigate to the same + source folder that you used to install Wine using the terminal. + Then, run the following command: + + # make uninstall + + This command will require root privileges, and should remove all of + the Wine binary files from your system. It will not, however, + remove your Wine configuration and applications located in your + user's home directory, so you are free to install another version of + Wine or delete that configuration by hand. diff --git a/documentation/installing.sgml b/documentation/installing.sgml deleted file mode 100644 index a6046706799..00000000000 --- a/documentation/installing.sgml +++ /dev/null @@ -1,163 +0,0 @@ - - Installing or uninstalling Wine - - - A standard Wine distribution form (which you probably downloaded - according to chapter Getting Wine) - includes quite a few different programs, libraries - and configuration files. All of these - must be set up properly for Wine to work well. In order to - achieve this, this chapter will guide you through the necessary steps - to get the Wine files - installed on your system. It will not - deal with how to get Wine's Windows environment - configured; that's what the next chapter - will talk about. - - - - When installing Wine, you should make sure that it doesn't happen - to overwrite a previous Wine installation (as this would cause - an overwhelming amount of annoying and fatal conflicts); - uninstalling any previous Wine version (as explained in this chapter) - to avoid this problem is recommended. - - - - Installing or uninstalling Wine packages - - - Now that you have downloaded the Debian or RPM or whatever Wine - package file, probably via the instructions given in the - previous chapter, you may be wondering "What in the world do I - do with this thing?". - This section will hopefully be able to put an end to your - bewildered questioning, by giving detailed install instructions - for all sorts of well-known package types. - - - - Debian Linux - - - In case you haven't downloaded and automatically installed the - Wine package file via apt-get as described - in the Getting Wine - section, you now need to use dpkg to - install it. Switch to the directory you downloaded the Debian - .deb package file to. Once there, type these commands, - adapting the package file name as required: - - - $ su - - Password: - # cd /home/user - # dpkg -i wine_0.0.20030115-1.deb - - - (Type the root password at the "Password:" prompt) - - - - You may also want to install the - wine-doc package, and if you are - using Wine from the 2.3 distribution (Woody), the - wine-utils package as well. - - - - Uninstalling an installed Wine Debian package can be done by - running: - - - # dpkg -l|grep wine - - - The second column of the output (if any) of this command will - indicate the installed packages dealing with "wine". - The corresponding packages can be uninstalled by running: - - - # dpkg -r <package_name> - - - where <package_name> is the name of the Wine-related package - which you want to uninstall. - - - - Linux Red Hat, Mandrake, SUSE and other distributions using RPM - - - Most distributions provide a graphical tool for installing - RPM packages, you can use it by simply clicking (Or double clicking, - depending on your system settings) on the RPM. If you don't have a - graphical RPM manager installed, using a shell, switch to the - directory where you downloaded the RPM package file to. - Once there, type this one command as root, adapting the - package file name as required: - - - # rpm -ivh wine-20031212.i386.rpm - - - You may also want to install the - wine-devel package. - - - If you've installed wine graphically, you can uninstall it - using your graphical RPM manager (Gnorpm, Kpackage, Yast, - Mandrake Control Center and so on), alternatively, uninstalling - a installed Wine RPM package can be done from a shell, by running: - - - # rpm -qa|grep -i wine - - - This command will indicate the installed packages dealing with "wine". - The corresponding packages can be uninstalled by running: - - - # rpm -e <package_name> - - - where <package_name> is the name of the Wine-related package - which you want to uninstall. - - - - - - Installing or uninstalling a Wine source code tree - - - If you are in the directory of the Wine version that you just - compiled (e.g. by having run make depend && make), then you may now install this Wine version by running as root: - - - # make install - - - This will copy the Wine binary files to their final destination - in your system. You can then proceed to the Configuration chapter to - configure the Wine environment. - - - - If instead you want to uninstall the currently installed Wine - source code version, then change to the main directory of this - version and run as root: - - - # make uninstall - - - - - diff --git a/documentation/introduction.sgml b/documentation/introduction.sgml index e5f6563f3b6..66575537de8 100644 --- a/documentation/introduction.sgml +++ b/documentation/introduction.sgml @@ -42,9 +42,7 @@ date Wine install. The first step, Getting Wine, illustrates the various methods of getting Wine's files onto your computer. - The second step, Installing - Wine, details the various install processes available to - you. The third step, Configuring + The second step, Configuring Wine, shows how to customize a Wine installation depending on your individual needs. The final step, Running Wine, covers the specific diff --git a/documentation/wine-user.sgml b/documentation/wine-user.sgml index 1cfd751d1b7..eb39088b3fa 100644 --- a/documentation/wine-user.sgml +++ b/documentation/wine-user.sgml @@ -2,8 +2,6 @@ - - @@ -19,6 +17,14 @@