/**************************************************************************** ** ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). ** Contact: Nokia Corporation (qt-info@nokia.com) ** ** This file is part of the documentation of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:LGPL$ ** No Commercial Usage ** This file contains pre-release code and may not be distributed. ** You may use this file in accordance with the terms and conditions ** contained in the Technology Preview License Agreement accompanying ** this package. ** ** GNU Lesser General Public License Usage ** Alternatively, this file may be used under the terms of the GNU Lesser ** General Public License version 2.1 as published by the Free Software ** Foundation and appearing in the file LICENSE.LGPL included in the ** packaging of this file. Please review the following information to ** ensure the GNU Lesser General Public License version 2.1 requirements ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. ** ** In addition, as a special exception, Nokia gives you certain ** additional rights. These rights are described in the Nokia Qt LGPL ** Exception version 1.1, included in the file LGPL_EXCEPTION.txt in this ** package. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. ** ** ** ** ** ** ** ** ** $QT_END_LICENSE$ ** ****************************************************************************/ /**************************************************************************** ** Please remember to update the corresponding INSTALL files. ****************************************************************************/ /*! \group installation \title Installation \ingroup buildsystem \ingroup topics \brief Installing Qt on supported platforms. The installation procedure is different on each Qt platform. Please follow the instructions for your platform from the following list. \generatelist{related} */ /*! \page install-x11.html \title Installing Qt on X11 Platforms \ingroup installation \brief How to install Qt on platforms with X11. \previouspage Installation \note Qt for X11 has some requirements that are given in more detail in the \l{Qt for X11 Requirements} document. \list 1 \o If you have the commercial edition of Qt, install your license file as \c{$HOME/.qt-license}. For the open source version you do not need a license file. \o Unpack the archive if you have not done so already. For example, if you have the \c{qt-x11-opensource-desktop-%VERSION%.tar.gz} package, type the following commands at a command line prompt: \snippet doc/src/snippets/code/doc_src_installation.qdoc 0 This creates the directory \c{/tmp/qt-x11-opensource-desktop-%VERSION%} containing the files from the archive. We only support the GNU version of the tar archiving utility. Note that on some systems it is called gtar. \o Building To configure the Qt library for your machine type, run the \c{./configure} script in the package directory. By default, Qt is configured for installation in the \c{/usr/local/Trolltech/Qt-%VERSION%} directory, but this can be changed by using the \c{-prefix} option. \snippet doc/src/snippets/code/doc_src_installation.qdoc 1 Type \c{./configure -help} to get a list of all available options. To create the library and compile all the demos, examples, tools, and tutorials, type: \snippet doc/src/snippets/code/doc_src_installation.qdoc 2 If \c{-prefix} is outside the build directory, you need to install the library, demos, examples, tools, and tutorials in the appropriate place. To do this, type: \snippet doc/src/snippets/code/doc_src_installation.qdoc 3 , as root if necessary. Note that on some systems the make utility is named differently, e.g. gmake. The configure script tells you which make utility to use. \bold{Note:} If you later need to reconfigure and rebuild Qt from the same location, ensure that all traces of the previous configuration are removed by entering the build directory and typing \c{make confclean} before running \c configure again. \o Environment variables In order to use Qt, some environment variables needs to be extended. \snippet doc/src/snippets/code/doc_src_installation.qdoc 4 This is done like this: In \c{.profile} (if your shell is bash, ksh, zsh or sh), add the following lines: \snippet doc/src/snippets/code/doc_src_installation.qdoc 5 In \c{.login} (in case your shell is csh or tcsh), add the following line: \snippet doc/src/snippets/code/doc_src_installation.qdoc 6 If you use a different shell, please modify your environment variables accordingly. For compilers that do not support rpath you must also extended the \c LD_LIBRARY_PATH environment variable to include \c{/usr/local/Trolltech/Qt-%VERSION%/lib}. On Linux with GCC this step is not needed. \o That's all. Qt is now installed. If you are new to Qt, we suggest that you take a look at the demos and examples to see Qt in action. Run the Qt Examples and Demos either by typing \c qtdemo on the command line or through the desktop's Main menu. You might also want to try the following links: \list \o \l{Configuring Qt} \o \l{How to Learn Qt} \o \l{Tutorials} \o \l{Developer Zone} \o \l{Deploying Qt Applications} \endlist \endlist We hope you will enjoy using Qt. Good luck! */ /*! \page install-win.html \title Installing Qt on Windows \ingroup installation \brief How to install Qt on Windows. \previouspage Installation \note Qt for Windows has some requirements that are given in more detail in the \l{Qt for Windows Requirements} document. \table \row \o \bold{Notes:} \list \o If you have obtained a binary package for this platform, consult the installation instructions provided instead of the ones in this document. \o \l{Open Source Versions of Qt} is not officially supported for use with any version of Visual Studio. Integration with Visual Studio is available as part of the \l{Qt Commercial Editions}. \endlist \endtable \list 1 \o If you have the commercial edition of Qt, copy the license file from your account on dist.trolltech.com into your home directory (this may be known as the \c userprofile environment variable) and rename it to \c{.qt-license}. This renaming process must be done using a \e{command prompt} on Windows, \bold{not} with Windows Explorer. For example on Windows 2000, \c{%USERPROFILE%} should be something like \c{C:\Documents and Settings\username} For the open source version you do not need a license file. \o Uncompress the files into the directory you want Qt installed; e.g. \c{C:\Qt\%VERSION%}. \note The install path must not contain any spaces or Windows specific file system characters. \o Environment variables In order to build and use Qt, the \c PATH environment variable needs to be extended: \snippet doc/src/snippets/code/doc_src_installation.qdoc 7 This is done by adding \c{c:\Qt\%VERSION%\bin} to the \c PATH variable. For newer versions of Windows, \c PATH can be extended through the \menu{Control Panel|System|Advanced|Environment variables} menu. You may also need to ensure that the locations of your compiler and other build tools are listed in the \c PATH variable. This will depend on your choice of software development environment. \bold{Note}: If you don't use the configured shells, which is available in the application menu, in the \l{Open Source Versions of Qt}, \c configure requires that \c sh.exe is not in the path or that it is run from \c msys. This also goes for mingw32-make. \o Building To configure the Qt library for your machine, type the following command in a \bold{Visual Studio} command prompt: \snippet doc/src/snippets/code/doc_src_installation.qdoc 8 Type \c{configure -help} to get a list of all available options. If you have multiple compilers installed, and want to build the Qt library using a specific compiler, you must specify a \c qmake specification. This is done by pasing \c{-platform } to configure; for example: \snippet doc/src/snippets/code/doc_src_installation.qdoc 9 In some cases you need to set up the compilation environment before running configure in order to use the right compiler. For instance, you need to do this if you have Visual Studio 2005 installed and want to compile Qt using the x64 compiler because the 32-bit and 64-bit compiler both use the same \c qmake specification file. This is usually done by selecting \menu{Microsoft Visual Studio 2005|Visual Studio Tools|} from the \gui Start menu. The actual commands needed to build Qt depends on your development system. For Microsoft Visual Studio to create the library and compile all the demos, examples, tools and tutorials type: \snippet doc/src/snippets/code/doc_src_installation.qdoc 10 \note If you later need to reconfigure and rebuild Qt from the same location, ensure that all traces of the previous configuration are removed by entering the build directory and typing \c{nmake distclean} before running \c configure again. \o That's all. Qt is now installed. If you are new to Qt, we suggest that you take a look at the demos and examples to see Qt in action. Run the Qt Examples and Demos either by typing \c qtdemo on the command line or through the desktop's Start menu. You might also want to try the following links: \list \o \l{How to Learn Qt} \o \l{Tutorials} \o \l{Developer Zone} \o \l{Deploying Qt Applications} \endlist \endlist We hope you will enjoy using Qt. Good luck! */ /*! \page install-mac.html \title Installing Qt on Mac OS X \ingroup installation \brief How to install Qt on Mac OS X. \previouspage Installation \note Qt for Mac OS X has some requirements that are given in more detail in the \l{Qt for Mac OS X Requirements} document. \bold{Note for the binary package}: If you have the binary package, simply double-click on the Qt.mpkg and follow the instructions to install Qt. You can later run the \c{uninstall-qt.py} script to uninstall the binary package. The script is located in /Developer/Tools and must be run as root. The following instructions describe how to install Qt from the source package. \list 1 \o If you have the commercial edition of Qt, install your license file as \c{$HOME/.qt-license}. For the open source version you do not need a license file. \o Unpack the archive if you have not done so already. For example, if you have the \c{qt-mac-opensource-desktop-%VERSION%.tar.gz} package, type the following commands at a command line prompt: \snippet doc/src/snippets/code/doc_src_installation.qdoc 11 This creates the directory \c{/tmp/qt-mac-opensource-desktop-%VERSION%} containing the files from the archive. \o Building To configure the Qt library for your machine type, run the \c{./configure} script in the package directory. By default, Qt is configured for installation in the \c{/usr/local/Trolltech/Qt-%VERSION%} directory, but this can be changed by using the \c{-prefix} option. \snippet doc/src/snippets/code/doc_src_installation.qdoc 12 Type \c{./configure -help} to get a list of all available options. Note that you will need to specify \c{-universal} if you want to build universal binaries, and also supply a path to the \c{-sdk} option if your development machine has a PowerPC CPU. By default, Qt is built as a framework, but you can built it as a set of dynamic libraries (dylibs) by specifying the \c{-no-framework} option. Qt can also be configured to be built with debugging symbols. This process is described in detail in the \l{Debugging Techniques} document. To create the library and compile all the demos, examples, tools, and tutorials, type: \snippet doc/src/snippets/code/doc_src_installation.qdoc 13 If \c{-prefix} is outside the build directory, you need to install the library, demos, examples, tools, and tutorials in the appropriate place. To do this, type: \snippet doc/src/snippets/code/doc_src_installation.qdoc 14 as root, if neccessary (note that this requires that you have administrator access to your machine). There is a potential race condition when running make install with multiple jobs. It is best to only run one make job (-j1) for the install. \bold{Note:} If you later need to reconfigure and rebuild Qt from the same location, ensure that all traces of the previous configuration are removed by entering the build directory and typing \c{make confclean} before running \c configure again. \o Environment variables In order to use Qt, some environment variables need to be extended. \snippet doc/src/snippets/code/doc_src_installation.qdoc 15 This is done like this: In \c{.profile} (if your shell is bash), add the following lines: \snippet doc/src/snippets/code/doc_src_installation.qdoc 16 In \c{.login} (in case your shell is csh or tcsh), add the following line: \snippet doc/src/snippets/code/doc_src_installation.qdoc 17 If you use a different shell, please modify your environment variables accordingly. \o That's all. Qt is now installed. If you are new to Qt, we suggest that you take a look at the demos and examples to see Qt in action. Run the Qt Examples and Demos either by typing \c qtdemo on the command line or through the desktop's Start menu. You might also want to try the following links: \list \o \l{How to Learn Qt} \o \l{Tutorials} \o \l{Developer Zone} \o \l{Deploying Qt Applications} \endlist \endlist We hope you will enjoy using Qt. Good luck! */ /*! \page install-wince.html \title Installing Qt on Windows CE \ingroup installation \ingroup qtce \brief How to install Qt on Windows CE. \previouspage Installation \note Qt for Windows CE has some requirements that are given in more detail in the \l{Qt for Windows CE Requirements} document. \list 1 \o Uncompress the files into the directory you want to install Qt into; e.g., \c{C:\Qt\%VERSION%}. \note The install path must not contain any spaces. \o Environment variables In order to build and use Qt, the \c PATH environment variable needs to be extended: \snippet doc/src/snippets/code/doc_src_installation.qdoc 18 This is done by adding \c{c:\Qt\%VERSION%\bin} to the \c PATH variable. For newer versions of Windows, \c PATH can be extended through "Control Panel->System->Advanced->Environment variables" and for older versions by editing \c{c:\autoexec.bat}. Make sure the enviroment variables for your compiler are set. Visual Studio includes \c{vcvars32.bat} for that purpose - or simply use the "Visual Studio Command Prompt" from the Start menu. \o Configuring Qt To configure Qt for Windows Mobile 5.0 for Pocket PC, type the following: \snippet doc/src/snippets/code/doc_src_installation.qdoc 19 If you want to configure Qt for another platform or with other options, type \c{configure -help} to get a list of all available options. See the \c README file for the list of supported platforms. \o Building Qt Now, to build Qt you first have to update your \c PATH, \c INCLUDE and \c LIB paths to point to the correct resources for your target platforms. For a default installation of the Windows Mobile 5.0 Pocket PC SDK, this is done with the following commands: \snippet doc/src/snippets/code/doc_src_installation.qdoc 20 We provide a convenience script for this purpose, called \c{setcepaths}. Simply type: \snippet doc/src/snippets/code/doc_src_installation.qdoc 21 Then to build Qt type: \snippet doc/src/snippets/code/doc_src_installation.qdoc 22 \o That's all. Qt is now installed. To get started with Qt, you can check out the examples found in the \c{examples} directory of your Qt installation. The documentation can be found in \c{doc\html}. \bold{Remember:} If you reconfigure Qt for a different platform, make sure you start with a new clean console to get rid of the platform dependent include directories. The links below provide further information for using Qt: \list \o \l{How to Learn Qt} \o \l{Tutorials} \o \l{Developer Zone} \o \l{Deploying Qt Applications} \endlist You might also want to try the following Windows CE specific links: \list \o \l{Windows CE - Introduction to using Qt} \o \l{Windows CE - Working with Custom SDKs} \o \l{Windows CE - Using shadow builds} \endlist Information on feature and performance tuning for embedded builds can be found on the following pages: \list \o \l{Fine-Tuning Features in Qt} \o \l{Qt Performance Tuning} \endlist \endlist We hope you will enjoy using Qt. Good luck! */ /*! \page requirements.html \title General Qt Requirements \ingroup installation \brief Outlines the general requirements and dependencies needed to install Qt. This page describes the specific requirements of libraries and components on which Qt depends. For information about installing Qt, see the \l{Installation} page. \section1 OpenSSL (version 0.9.7 or later) Support for \l{SSL}{Secure Sockets Layer (SSL)} communication is provided by the \l{OpenSSL Toolkit}, which must be obtained separately. \section1 Platform-Specific Requirements Each platform has its own specific set of dependencies. Please see the relevant page for more details about the components that are required to build and install Qt on your platform. \list \o \l{Qt for Embedded Linux Requirements} \o \l{Qt for Mac OS X Requirements} \o \l{Qt for Windows CE Requirements} \o \l{Qt for Windows Requirements} \o \l{Qt for X11 Requirements} \endlist */ /*! \page requirements-win.html \title Qt for Windows Requirements \ingroup installation \brief Setting up the Windows environment for Qt. \previouspage General Qt Requirements If you are using a binary version of Qt with Visual Studio 2005, you must first install the Visual Studio Service Pack 1 available \l{http://www.microsoft.com/downloads/details.aspx?FamilyId=BB4A75AB-E2D4-4C96-B39D-37BAF6B5B1DC&displaylang=en}{here} to avoid runtime conflicts. To build Qt with Phonon on Windows, you require: \list \o Microsoft's DirectX Software Development Kit which can be downloaded \l{http://msdn2.microsoft.com/en-us/directx/aa937788.aspx}{here}, and \o Microsoft's Windows Server 2003 R2 Platform SDK which is available \l{http://www.microsoft.com/downloads/details.aspx?FamilyID=0baf2b35-c656-4969-ace8-e4c0c0716adb&DisplayLang=en}{here}. \endlist \sa {Known Issues in %VERSION%} */ /*! \page requirements-mac.html \title Qt for Mac OS X Requirements \ingroup installation \brief Setting up the Mac OS X environment for Qt. \previouspage General Qt Requirements \sa {Known Issues in %VERSION%} */ /*! \page requirements-x11.html \title Qt for X11 Requirements \ingroup installation \brief Setting up the X11 environment for Qt. \previouspage General Qt Requirements \tableofcontents \section1 QtGui Dependencies \image x11_dependencies.png Qt for X11 Dependencies \raw HTML \endraw The QtGui module and the QtCore module, which provides the non-GUI features required by QtGui, depend on the libraries described in the following table. \table 90% \header \o Name \o Library \o Notes \o Configuration options \o Minimum working version \raw HTML XRender libXrender X Rendering Extension; used for anti-aliasing -xrender or auto-detected0.9.0 Xrandr libXrandr X Resize and Rotate Extension -xrandr or auto-detected1.0.2 Xcursor libXcursor X Cursor Extension -xcursor or auto-detected1.1.4 Xfixes libXfixes X Fixes Extension -xfixes or auto-detected3.0.0 Xinerama libXinerama Multi-head support -xinerama or auto-detected1.1.0 Xi libXi X11 Input Extensions -xinput or auto-detected1.3.0 Xt libXt Xt Intrinsics0.99 Xext libXext X Extensions6.4.3 X11 libX11 X11 Client-Side Library6.2.1 SM libSM X Session Management -sm or auto-detected6.0.4 ICE libICE Inter-Client Exchange -sm or auto-detected6.3.5 glib libglib-2.0 Common event loop handling -glib or auto-detected2.8.3 pthread libpthread Multithreading 2.3.5 \endraw \endtable \note You must compile with XRender support to get alpha transparency support for pixmaps and images. \section1 Phonon Dependencies As described in the \l{Phonon Overview}, Phonon uses the GStreamer multimedia framework as the backend for audio and video playback on X11. The minimum required version of GStreamer is 0.10. To build Phonon, you need the GStreamer library, base plugins, and development files for your system. The package names for GStreamer vary between Linux distributions; try searching for \c gstreamer or \c libgstreamer in your distribution's package repository to find suitable packages. \sa {Known Issues in %VERSION%} */ /*! \page requirements-wince.html \title Qt for Windows CE Requirements \ingroup installation \brief Setting up the Windows CE environment for Qt. \previouspage General Qt Requirements Qt is known to work with Visual Studio 2005/2008 and the following SDKs for Windows CE development on Windows XP and Windows Vista: \list \o Windows CE 5.0 Standard SDK for ARM, X86, and MIPS \o Windows CE 6.0 SDKs for ARM generated using the defaults found in Platform Builder \o Windows Mobile 5.0 (\e{Pocket PC}, \e{Smartphone} and \e{Pocket PC with Phone} editions) \o Windows Mobile 6.0 (\e{Standard}, \e{Classic} and \e{Professional} editions) \endlist Below is a list of links to download the SDKs: \list \o \l{http://www.microsoft.com/downloads/details.aspx?familyid=fa1a3d66-3f61-4ddc-9510-ae450e2318c3&displaylang=en} {Windows CE 5 Standard SDK} \o \l{http://www.microsoft.com/downloads/details.aspx?familyid=83A52AF2-F524-4EC5-9155-717CBE5D25ED&displaylang=en} {Windows Mobile 5 Pocket PC} \o \l{http://www.microsoft.com/downloads/details.aspx?familyid=DC6C00CB-738A-4B97-8910-5CD29AB5F8D9&displaylang=en} {Windows Mobile 5 Smartphone} \o \l{http://www.microsoft.com/downloads/details.aspx?familyid=06111A3A-A651-4745-88EF-3D48091A390B&displaylang=en } {Windows Mobile 6 Professional/Standard} \endlist \table \row \bold{Note:} \o \list 1 \o Currently, there is only compile support for Windows CE 5.0 Standard SDK for SH-4. \o There is currently no "out of the box" support for the Windows CE Automotive or Portable Media SDKs from Microsoft. \endlist \endtable Device manufacturers may prefer to make their own customized version of Windows CE using Platform Builder. In order for Qt for Windows CE to support a custom SDK, a build specification needs to be created. More information on Windows CE Customization can be found \l{Windows CE - Working with Custom SDKs}{here}. \sa {Known Issues in %VERSION%} */ /*! \page requirements-embedded-linux.html \title Qt for Embedded Linux Requirements \ingroup installation \brief Setting up the Embedded Linux environment for Qt. \previouspage General Qt Requirements \sa {Known Issues in %VERSION%} \section1 Building Qt for Embedded Linux with uclibc If you intend to include the QtWebKit module in your Qt build then you should use version \bold{uClibc 0.9.29 or greater} as that is the earliest version with sufficient pthread support. \section1 Memory Requirements The memory and storage requirements for Qt for Embedded Linux depend on a an variety of different factors, including the target architecture and the features enabled in the Qt build. The following table shows typical library sizes for the most common Qt libraries on different architectures, built in release mode with different feature profiles. \table \header \o{1,2} Architecture \o{1,2} Compiler \o{2,1} QtCore \o{2,1} QtGui \o{2,1} QtNetwork \o{2,1} QtWebKit \header \o Minimal \o Normal \o Minimal \o Normal \o Minimal \o Normal \o Minimal \o Normal \row \o linux-x86-g++ \o GCC 4.2.4 \o 1.7M \o 2.7M \o 3.3M \o 9.9M \o 653K \o 1.1M \o N/A \o 17M \row \o linux-arm-g++ \o GCC 4.1.1 \o 1.9M \o 3.2M \o 4.1M \o 11M \o 507K \o 1.0M \o N/A \o 17M \row \o linux-mips-g++ (MIPS32) \o GCC 4.2.4 \o 2.0M \o 3.2M \o 4.5M \o 12M \o 505K \o 1003K \o N/A \o 21M \endtable Library sizes are given in the following units: K = 1024 bytes; M = 1024K. QtWebKit is excluded from the minimal configuration. The \l{Fine-Tuning Features in Qt} document covers the process of configuring Qt builds to avoid the inclusion of unnecessary features. \section1 Additional X11 Libraries for QVFb The Virtual Framebuffer (QVFb) application requires the \c libxtst library in addition to the libraries used to build Qt for X11. This library enables the use of the Record extension to the X protocol to be used in applications. */