doc/src/getting-started/installation.qdoc
changeset 0 1918ee327afb
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the documentation of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 /****************************************************************************
       
    43 ** Please remember to update the corresponding INSTALL files.
       
    44 ****************************************************************************/
       
    45 
       
    46 /*!
       
    47 \group installation
       
    48 \title Installation
       
    49 \brief Installing Qt on supported platforms.
       
    50 
       
    51 The installation procedure is different on each Qt platform.
       
    52 Please follow the instructions for your platform from the following list.
       
    53 
       
    54 \generatelist{related}
       
    55 */
       
    56 
       
    57 /*! \page install-x11.html
       
    58 \title Installing Qt on X11 Platforms
       
    59 \ingroup installation
       
    60 \brief How to install Qt on platforms with X11.
       
    61 \previouspage Installation
       
    62 
       
    63 \note Qt for X11 has some requirements that are given in more detail
       
    64 in the \l{Qt for X11 Requirements} document.
       
    65 
       
    66 \list 1
       
    67 \o  If you have the commercial edition of Qt, install your license
       
    68     file as \c{$HOME/.qt-license}.
       
    69 
       
    70     For the open source version you do not need a license file.
       
    71 
       
    72 \o  Unpack the archive if you have not done so already. For example,
       
    73     if you have the \c{qt-x11-opensource-desktop-%VERSION%.tar.gz}
       
    74     package, type the following commands at a command line prompt:
       
    75 
       
    76 \snippet doc/src/snippets/code/doc_src_installation.qdoc 0
       
    77 
       
    78     This creates the directory \c{/tmp/qt-x11-opensource-desktop-%VERSION%}
       
    79     containing the files from the archive. We only support the GNU version of
       
    80     the tar archiving utility. Note that on some systems it is called gtar.
       
    81 
       
    82 \o  Building
       
    83 
       
    84     To configure the Qt library for your machine type, run the
       
    85     \c{./configure} script in the package directory.
       
    86 
       
    87     By default, Qt is configured for installation in the
       
    88     \c{/usr/local/Trolltech/Qt-%VERSION%} directory, but this can be
       
    89     changed by using the \c{-prefix} option.
       
    90 
       
    91 \snippet doc/src/snippets/code/doc_src_installation.qdoc 1
       
    92 
       
    93     Type \c{./configure -help} to get a list of all available options.
       
    94 
       
    95     To create the library and compile all the demos, examples, tools,
       
    96     and tutorials, type:
       
    97 
       
    98 \snippet doc/src/snippets/code/doc_src_installation.qdoc 2
       
    99 
       
   100     If \c{-prefix} is outside the build directory, you need to install
       
   101     the library, demos, examples, tools, and tutorials in the appropriate
       
   102     place. To do this, type:
       
   103 
       
   104 \snippet doc/src/snippets/code/doc_src_installation.qdoc 3
       
   105 
       
   106     , as root if necessary.
       
   107 
       
   108     Note that on some systems the make utility is named differently,
       
   109     e.g. gmake. The configure script tells you which make utility to
       
   110     use.
       
   111 
       
   112     \bold{Note:} If you later need to reconfigure and rebuild Qt from the
       
   113     same location, ensure that all traces of the previous configuration are
       
   114     removed by entering the build directory and typing \c{make confclean}
       
   115     before running \c configure again.
       
   116 
       
   117 \o  Environment variables
       
   118 
       
   119     In order to use Qt, some environment variables needs to be
       
   120     extended.
       
   121 
       
   122 \snippet doc/src/snippets/code/doc_src_installation.qdoc 4
       
   123 
       
   124     This is done like this:
       
   125 
       
   126     In \c{.profile} (if your shell is bash, ksh, zsh or sh), add the
       
   127     following lines:
       
   128 
       
   129 \snippet doc/src/snippets/code/doc_src_installation.qdoc 5
       
   130 
       
   131     In \c{.login} (in case your shell is csh or tcsh), add the following line:
       
   132 
       
   133 \snippet doc/src/snippets/code/doc_src_installation.qdoc 6
       
   134 
       
   135     If you use a different shell, please modify your environment
       
   136     variables accordingly.
       
   137 
       
   138     For compilers that do not support rpath you must also extended the
       
   139     \c LD_LIBRARY_PATH environment variable to include
       
   140     \c{/usr/local/Trolltech/Qt-%VERSION%/lib}. On Linux with GCC this step
       
   141     is not needed.
       
   142 
       
   143 \o  That's all. Qt is now installed.
       
   144 
       
   145     If you are new to Qt, we suggest that you take a look at the demos
       
   146     and examples to see Qt in action. Run the Qt Examples and Demos
       
   147     either by typing \c qtdemo on the command line or through the
       
   148     desktop's Main menu.
       
   149 
       
   150     You might also want to try the following links:
       
   151 
       
   152     \list
       
   153     \o \l{Configuring Qt}
       
   154     \o \l{How to Learn Qt}
       
   155     \o \l{Tutorials}
       
   156     \o \l{Developer Zone}
       
   157     \o \l{Deploying Qt Applications}
       
   158     \endlist
       
   159 \endlist
       
   160 
       
   161     We hope you will enjoy using Qt. Good luck!
       
   162 
       
   163 */
       
   164 
       
   165 /*!
       
   166 \page install-win.html
       
   167 \title Installing Qt on Windows
       
   168 \ingroup installation
       
   169 \brief How to install Qt on Windows.
       
   170 \previouspage Installation
       
   171 
       
   172 \note Qt for Windows has some requirements that are given in more detail
       
   173 in the \l{Qt for Windows Requirements} document.
       
   174 
       
   175 \table
       
   176 \row \o \bold{Notes:}
       
   177 \list
       
   178 \o If you have obtained a binary package for this platform,
       
   179 consult the installation instructions provided instead of the ones in
       
   180 this document.
       
   181 \o \l{Open Source Versions of Qt} is not officially supported for use with
       
   182 any version of Visual Studio. Integration with Visual Studio is available
       
   183 as part of the \l{Qt Commercial Editions}.
       
   184 
       
   185 \endlist
       
   186 \endtable
       
   187 
       
   188 \list 1
       
   189 \o  If you have the commercial edition of Qt, copy the license file
       
   190     from your account on dist.trolltech.com into your home directory
       
   191     (this may be known as the \c userprofile environment variable) and
       
   192     rename it to \c{.qt-license}. This renaming process must be done
       
   193     using a \e{command prompt} on Windows, \bold{not} with Windows Explorer.
       
   194     For example on Windows 2000, \c{%USERPROFILE%} should be something
       
   195     like \c{C:\Documents and Settings\username}
       
   196 
       
   197     For the open source version you do not need a license file.
       
   198 
       
   199 \o  Uncompress the files into the directory you want Qt installed;
       
   200     e.g. \c{C:\Qt\%VERSION%}.
       
   201 
       
   202     \note The install path must not contain any spaces or Windows specific
       
   203     file system characters.
       
   204 
       
   205 \o Environment variables
       
   206 
       
   207     In order to build and use Qt, the \c PATH environment variable needs to be
       
   208     extended:
       
   209 
       
   210 \snippet doc/src/snippets/code/doc_src_installation.qdoc 7
       
   211 
       
   212     This is done by adding \c{c:\Qt\%VERSION%\bin} to the \c PATH variable.
       
   213 
       
   214     For newer versions of Windows, \c PATH can be extended through
       
   215     the \menu{Control Panel|System|Advanced|Environment variables} menu.
       
   216 
       
   217     You may also need to ensure that the locations of your compiler and
       
   218     other build tools are listed in the \c PATH variable. This will depend
       
   219     on your choice of software development environment.
       
   220 
       
   221     \bold{Note}: If you don't use the configured shells, which is
       
   222     available in the application menu, in the \l{Open Source Versions of Qt},
       
   223     \c configure requires that \c sh.exe is not in the path
       
   224     or that it is run from \c msys. This also goes for mingw32-make.
       
   225 
       
   226 \o Building
       
   227 
       
   228     To configure the Qt library for your machine, type the following command
       
   229     in a \bold{Visual Studio} command prompt:
       
   230 
       
   231 \snippet doc/src/snippets/code/doc_src_installation.qdoc 8
       
   232 
       
   233     Type \c{configure -help} to get a list of all available options.
       
   234 
       
   235     If you have multiple compilers installed, and want to build the Qt library
       
   236     using a specific compiler, you must specify a \c qmake specification.
       
   237     This is done by pasing \c{-platform <spec>} to configure; for example:
       
   238 
       
   239 \snippet doc/src/snippets/code/doc_src_installation.qdoc 9
       
   240 
       
   241     In some cases you need to set up the compilation environment before running
       
   242     configure in order to use the right compiler. For instance, you need to do this
       
   243     if you have Visual Studio 2005 installed and want to compile Qt using the x64
       
   244     compiler because the 32-bit and 64-bit compiler both use the same
       
   245     \c qmake specification file.
       
   246     This is usually done by selecting
       
   247     \menu{Microsoft Visual Studio 2005|Visual Studio Tools|<Command Prompt>}
       
   248     from the \gui Start menu.
       
   249 
       
   250     The actual commands needed to build Qt depends on your development
       
   251     system. For Microsoft Visual Studio to create the library and
       
   252     compile all the demos, examples, tools and tutorials type:
       
   253 
       
   254 \snippet doc/src/snippets/code/doc_src_installation.qdoc 10
       
   255 
       
   256     \note If you later need to reconfigure and rebuild Qt from the
       
   257     same location, ensure that all traces of the previous configuration are
       
   258     removed by entering the build directory and typing \c{nmake distclean}
       
   259     before running \c configure again.
       
   260 
       
   261 \o  That's all. Qt is now installed.
       
   262 
       
   263     If you are new to Qt, we suggest that you take a look at the demos
       
   264     and examples to see Qt in action. Run the Qt Examples and Demos
       
   265     either by typing \c qtdemo on the command line or through the
       
   266     desktop's Start menu.
       
   267 
       
   268     You might also want to try the following links:
       
   269 
       
   270     \list
       
   271     \o \l{How to Learn Qt}
       
   272     \o \l{Tutorials}
       
   273     \o \l{Developer Zone}
       
   274     \o \l{Deploying Qt Applications}
       
   275     \endlist
       
   276 
       
   277 \endlist
       
   278 
       
   279     We hope you will enjoy using Qt. Good luck!
       
   280 
       
   281 */
       
   282 
       
   283 /*! \page install-mac.html
       
   284 \title Installing Qt on Mac OS X
       
   285 \ingroup installation
       
   286 \brief How to install Qt on Mac OS X.
       
   287 \previouspage Installation
       
   288 
       
   289 \note Qt for Mac OS X has some requirements that are given in more detail
       
   290 in the \l{Qt for Mac OS X Requirements} document.
       
   291 
       
   292 \bold{Note for the binary package}: If you have the binary package, simply double-click on the Qt.mpkg
       
   293 and follow the instructions to install Qt. You can later run the \c{uninstall-qt.py}
       
   294 script to uninstall the binary package. The script is located in /Developer/Tools and
       
   295 must be run as root.
       
   296 
       
   297 The following instructions describe how to install Qt from the source package.
       
   298 
       
   299 \list 1
       
   300 \o  If you have the commercial edition of Qt, install your license
       
   301     file as \c{$HOME/.qt-license}.
       
   302 
       
   303     For the open source version you do not need a license file.
       
   304 
       
   305 \o  Unpack the archive if you have not done so already. For example,
       
   306     if you have the \c{qt-mac-opensource-desktop-%VERSION%.tar.gz}
       
   307     package, type the following commands at a command line prompt:
       
   308 
       
   309 \snippet doc/src/snippets/code/doc_src_installation.qdoc 11
       
   310 
       
   311     This creates the directory \c{/tmp/qt-mac-opensource-desktop-%VERSION%}
       
   312     containing the files from the archive.
       
   313 
       
   314 \o  Building
       
   315 
       
   316     To configure the Qt library for your machine type, run the
       
   317     \c{./configure} script in the package directory.
       
   318 
       
   319     By default, Qt is configured for installation in the
       
   320     \c{/usr/local/Trolltech/Qt-%VERSION%} directory, but this can be
       
   321     changed by using the \c{-prefix} option.
       
   322 
       
   323 \snippet doc/src/snippets/code/doc_src_installation.qdoc 12
       
   324 
       
   325     Type \c{./configure -help} to get a list of all available options.
       
   326 
       
   327     Note that you will need to specify \c{-universal} if you want to
       
   328     build universal binaries, and also supply a path to the \c{-sdk}
       
   329     option if your development machine has a PowerPC CPU. By default,
       
   330     Qt is built as a framework, but you can built it as a set of
       
   331     dynamic libraries (dylibs) by specifying the \c{-no-framework}
       
   332     option.
       
   333 
       
   334     Qt can also be configured to be built with debugging symbols. This
       
   335     process is described in detail in the \l{Debugging Techniques}
       
   336     document.
       
   337 
       
   338     To create the library and compile all the demos, examples, tools,
       
   339     and tutorials, type:
       
   340 
       
   341 \snippet doc/src/snippets/code/doc_src_installation.qdoc 13
       
   342 
       
   343     If \c{-prefix} is outside the build directory, you need to install
       
   344     the library, demos, examples, tools, and tutorials in the appropriate
       
   345     place. To do this, type:
       
   346 
       
   347 \snippet doc/src/snippets/code/doc_src_installation.qdoc 14
       
   348 
       
   349     as root, if neccessary (note that this requires that you have administrator access
       
   350     to your machine).
       
   351 
       
   352     There is a potential race condition when running make install with multiple
       
   353     jobs. It is best to only run one make job (-j1) for the install.
       
   354 
       
   355     \bold{Note:} If you later need to reconfigure and rebuild Qt from the
       
   356     same location, ensure that all traces of the previous configuration are
       
   357     removed by entering the build directory and typing \c{make confclean}
       
   358     before running \c configure again.
       
   359 
       
   360 \o  Environment variables
       
   361 
       
   362     In order to use Qt, some environment variables need to be
       
   363     extended.
       
   364 
       
   365 \snippet doc/src/snippets/code/doc_src_installation.qdoc 15
       
   366 
       
   367     This is done like this:
       
   368 
       
   369     In \c{.profile} (if your shell is bash), add the following lines:
       
   370 
       
   371 \snippet doc/src/snippets/code/doc_src_installation.qdoc 16
       
   372 
       
   373     In \c{.login} (in case your shell is csh or tcsh), add the following line:
       
   374 
       
   375 \snippet doc/src/snippets/code/doc_src_installation.qdoc 17
       
   376 
       
   377     If you use a different shell, please modify your environment
       
   378     variables accordingly.
       
   379 
       
   380 \o  That's all. Qt is now installed.
       
   381 
       
   382     If you are new to Qt, we suggest that you take a look at the demos
       
   383     and examples to see Qt in action. Run the Qt Examples and Demos
       
   384     either by typing \c qtdemo on the command line or through the
       
   385     desktop's Start menu.
       
   386 
       
   387     You might also want to try the following links:
       
   388 
       
   389     \list
       
   390     \o \l{How to Learn Qt}
       
   391     \o \l{Tutorials}
       
   392     \o \l{Developer Zone}
       
   393     \o \l{Deploying Qt Applications}
       
   394     \endlist
       
   395 \endlist
       
   396 
       
   397     We hope you will enjoy using Qt. Good luck!
       
   398 
       
   399 */
       
   400 
       
   401 /*! \page install-wince.html
       
   402 \title Installing Qt on Windows CE
       
   403 \ingroup installation
       
   404 \ingroup qtce
       
   405 \brief How to install Qt on Windows CE.
       
   406 \previouspage Installation
       
   407 
       
   408 \note Qt for Windows CE has some requirements that are given in more detail
       
   409 in the \l{Qt for Windows CE Requirements} document.
       
   410 
       
   411 \list 1
       
   412     \o  Uncompress the files into the directory you want to install Qt into;
       
   413         e.g., \c{C:\Qt\%VERSION%}.
       
   414 
       
   415         \note The install path must not contain any spaces.
       
   416 
       
   417     \o  Environment variables
       
   418 
       
   419         In order to build and use Qt, the \c PATH environment variable needs
       
   420         to be extended:
       
   421 
       
   422         \snippet doc/src/snippets/code/doc_src_installation.qdoc 18
       
   423 
       
   424         This is done by adding \c{c:\Qt\%VERSION%\bin} to the \c PATH variable.
       
   425 
       
   426         For newer versions of Windows, \c PATH can be extended through
       
   427         "Control Panel->System->Advanced->Environment variables" and for
       
   428         older versions by editing \c{c:\autoexec.bat}.
       
   429 
       
   430         Make sure the enviroment variables for your compiler are set. 
       
   431         Visual Studio includes \c{vcvars32.bat} for that purpose - or simply
       
   432         use the "Visual Studio Command Prompt" from the Start menu.
       
   433 
       
   434     \o  Configuring Qt
       
   435 
       
   436         To configure Qt for Windows Mobile 5.0 for Pocket PC, type the
       
   437         following:
       
   438 
       
   439         \snippet doc/src/snippets/code/doc_src_installation.qdoc 19
       
   440 
       
   441         If you want to configure Qt for another platform or with other
       
   442         options, type \c{configure -help} to get a list of all available
       
   443         options. See the \c README file for the list of supported platforms.
       
   444 
       
   445 
       
   446     \o Building Qt
       
   447 
       
   448         Now, to build Qt you first have to update your \c PATH, \c INCLUDE
       
   449         and \c LIB paths to point to the correct resources for your target
       
   450         platforms. For a default installation of the Windows Mobile 5.0
       
   451         Pocket PC SDK, this is done with the following commands:
       
   452 
       
   453         \snippet doc/src/snippets/code/doc_src_installation.qdoc 20
       
   454 
       
   455         We provide a convenience script for this purpose, called \c{setcepaths}.
       
   456         Simply type:
       
   457 
       
   458         \snippet doc/src/snippets/code/doc_src_installation.qdoc 21
       
   459 
       
   460         Then to build Qt type:
       
   461 
       
   462         \snippet doc/src/snippets/code/doc_src_installation.qdoc 22
       
   463 
       
   464         \o  That's all. Qt is now installed.
       
   465 
       
   466         To get started with Qt, you can check out the examples found in the
       
   467         \c{examples} directory of your Qt installation. The documentation can
       
   468         be found in \c{doc\html}.
       
   469 
       
   470         \bold{Remember:} If you reconfigure Qt for a different platform,
       
   471         make sure you start with a new clean console to get rid of the
       
   472         platform dependent include directories.
       
   473 
       
   474         The links below provide further information for using Qt:
       
   475         \list
       
   476         \o \l{How to Learn Qt}
       
   477         \o \l{Tutorials}
       
   478         \o \l{Developer Zone}
       
   479         \o \l{Deploying Qt Applications}
       
   480         \endlist
       
   481 
       
   482         You might also want to try the following Windows CE specific links:
       
   483         \list
       
   484         \o \l{Windows CE - Introduction to using Qt}
       
   485         \o \l{Windows CE - Working with Custom SDKs}
       
   486         \o \l{Windows CE - Using shadow builds}
       
   487         \endlist
       
   488 
       
   489         Information on feature and performance tuning for embedded builds can
       
   490         be found on the following pages:
       
   491         \list
       
   492         \o \l{Fine-Tuning Features in Qt}
       
   493         \o \l{Qt Performance Tuning}
       
   494         \endlist
       
   495 \endlist
       
   496 
       
   497     We hope you will enjoy using Qt. Good luck!
       
   498 */
       
   499 
       
   500 /*! \page install-Symbian-installer.html
       
   501 
       
   502 \title Installing Qt on the Symbian platform using binary package
       
   503 \ingroup qts60
       
   504 \brief How to install Qt on the Symbian platform using the binary package.
       
   505 
       
   506 \note Qt for Symbian platform has some requirements that are given in more detail
       
   507 in the \l{Qt for Symbian platform Requirements} document.
       
   508 
       
   509 \list 1
       
   510 
       
   511     \o  Install Qt
       
   512 
       
   513         Run \c{qt-symbian-opensource-%VERSION%.exe} and follow the instructions.
       
   514 
       
   515         \note Qt must be installed on the same drive as the Symbian SDK you are
       
   516         using, and the install path must not contain any spaces.
       
   517 
       
   518     \o  Running Qt demos
       
   519 
       
   520         We've included a subset of the Qt demos in this package for you
       
   521         to try out. An excellent starting point is the "fluidlauncher"
       
   522         demo. To run the demo on a real device, you first have to install
       
   523         \c{qt.sis} and \c{fluidlauncher.sis} found in the Qt installation
       
   524         directory. Begin by connecting your phone using the USB cable and
       
   525         selecting "PC Suite mode". In Windows Explorer right click on the
       
   526         \c{.sis} files and select "Install with Nokia Application Installer"
       
   527         and follow the instructions.
       
   528 
       
   529         To run the demos and examples on the emulator, you need to build them first.
       
   530         Open the "Qt for Symbian platform Command Prompt" from the Start menu and type:
       
   531         
       
   532         \snippet doc/src/snippets/code/doc_src_installation.qdoc 25
       
   533         
       
   534         To run the demos on the emulator simply navigate to the directory of the demo 
       
   535         you want to see and run:
       
   536 
       
   537         \snippet doc/src/snippets/code/doc_src_installation.qdoc 27
       
   538 
       
   539         For more information about building and running Qt programs on the
       
   540 Symbian platform,
       
   541         see \l{Symbian platform - Introduction to using Qt}.
       
   542 
       
   543     We hope you will enjoy using Qt.
       
   544 
       
   545 \endlist
       
   546 
       
   547 */
       
   548 /*! \page install-Symbian.html
       
   549 
       
   550 \title Installing Qt on the Symbian platform
       
   551 \ingroup installation
       
   552 \ingroup qts60
       
   553 \brief How to install Qt for the Symbian platform
       
   554 
       
   555 \note Qt for the Symbian platform has some requirements that are given in more detail
       
   556 in the \l{Qt for Symbian platform Requirements} document.
       
   557 
       
   558 \note \bold {This document describes how to install and configure Qt for
       
   559 the Symbian platform from scratch. 
       
   560 If you are using pre-built binaries, follow the instructions
       
   561 \l{Installing Qt on the Symbian platform using binary package}{here}.}
       
   562 
       
   563 \list 1
       
   564 
       
   565     \o  Install Qt
       
   566 
       
   567         Uncompress the package into the directory you want Qt installed,
       
   568         e.g. \c{C:\Qt\%VERSION%}.
       
   569 
       
   570         \note Qt must be installed on the same drive as the Symbian SDK you are
       
   571         using, and the install path must not contain any spaces.
       
   572 
       
   573     \o  Environment variables
       
   574 
       
   575         In order to build and use Qt, the \c PATH environment variable needs
       
   576         to be extended:
       
   577 
       
   578         \snippet doc/src/snippets/code/doc_src_installation.qdoc 18
       
   579 
       
   580         This is done by adding \c{c:\Qt\%VERSION%\bin} to the \c PATH variable.
       
   581 
       
   582         On Windows the PATH can be extended by navigating to
       
   583         "Control Panel->System->Advanced->Environment variables".
       
   584 
       
   585         In addition, you must configure the environment for use with the Symbian
       
   586         emulator. This is done by locating the Carbide.c++ submenu on the Start
       
   587         menu, and choosing "Configure environment for WINSCW command line".
       
   588 
       
   589     \o  Configure Qt
       
   590 
       
   591         To configure Qt for the Symbian platform, do:
       
   592 
       
   593         \snippet doc/src/snippets/code/doc_src_installation.qdoc 23
       
   594         to build the tools using MinGW, and the libraries using abld.
       
   595         or
       
   596         \snippet doc/src/snippets/code/doc_src_installation.qdoc 31
       
   597         to build the tools using MinGW, and the libraries using sbsv2.
       
   598 
       
   599         For other options, type \c{configure -help} to get a list of all available
       
   600         options.
       
   601 
       
   602     \o  Build Qt
       
   603 
       
   604         To build Qt for the emulator, type:
       
   605 
       
   606         \snippet doc/src/snippets/code/doc_src_installation.qdoc 24
       
   607 
       
   608         To build Qt for the device, type:
       
   609 
       
   610         \snippet doc/src/snippets/code/doc_src_installation.qdoc 28
       
   611         
       
   612         Congratulations, Qt is now ready to use.
       
   613 
       
   614     \o  Running Qt demos
       
   615 
       
   616         We've included a subset of the Qt demos in this package for you
       
   617         to try out. An excellent starting point is the "fluidlauncher"
       
   618         demo. To run the demo on a real device, you first have to install
       
   619         the Qt libraries on the device:
       
   620         
       
   621         \snippet doc/src/snippets/code/doc_src_installation.qdoc 29
       
   622 
       
   623         \note You will need to supply certificate that allows installation 
       
   624         of binaries with "All -Tcb" capability to your device. 
       
   625 
       
   626         Similarly, install fluidlauncher to the device:
       
   627 
       
   628         \snippet doc/src/snippets/code/doc_src_installation.qdoc 30
       
   629 
       
   630         This will create a self-signed \c fluidlauncher_armv5_urel.sis and
       
   631         install it to your device.
       
   632         
       
   633         To run the demos on the emulator simply navigate to the directory of the demo 
       
   634         you want to see and run:
       
   635 
       
   636         \snippet doc/src/snippets/code/doc_src_installation.qdoc 27
       
   637 
       
   638         For more information about building and running Qt programs on the
       
   639 Symbian platform, see \l{Symbian platform - Introduction to using Qt}.
       
   640 
       
   641     We hope you will enjoy using Qt.
       
   642 
       
   643 \endlist
       
   644 
       
   645 */
       
   646 /*!
       
   647     \page requirements.html
       
   648     \title General Qt Requirements
       
   649     \ingroup installation
       
   650     \brief Outlines the general requirements and dependencies needed to install Qt.
       
   651 
       
   652     This page describes the specific requirements of libraries and components on which
       
   653     Qt depends. For information about installing Qt, see the \l{Installation} page.
       
   654 
       
   655     For information about the platforms that Qt supports, see the \l{Supported Platforms}
       
   656     page.
       
   657 
       
   658     \section1 OpenSSL (version 0.9.7 or later)
       
   659 
       
   660     Support for \l{SSL}{Secure Sockets Layer (SSL)} communication is provided by the
       
   661     \l{OpenSSL Toolkit}, which must be obtained separately. More information about
       
   662     enabling SSL support can be found in the \l{Secure Sockets Layer (SSL) Classes}
       
   663     document.
       
   664 
       
   665     \section1 Platform-Specific Requirements
       
   666 
       
   667     Each platform has its own specific set of dependencies. Please see the relevant
       
   668     page for more details about the components that are required to build and install
       
   669     Qt on your platform.
       
   670 
       
   671     \list
       
   672     \o \l{Qt for Embedded Linux Requirements}
       
   673     \o \l{Qt for Mac OS X Requirements}
       
   674     \o \l{Qt for Symbian platform Requirements}
       
   675     \o \l{Qt for Windows CE Requirements}
       
   676     \o \l{Qt for Windows Requirements}
       
   677     \o \l{Qt for X11 Requirements}
       
   678     \endlist
       
   679 */
       
   680 
       
   681 /*!
       
   682     \page requirements-win.html
       
   683     \title Qt for Windows Requirements
       
   684     \ingroup installation
       
   685     \brief Setting up the Windows environment for Qt.
       
   686     \previouspage General Qt Requirements
       
   687 
       
   688     If you are using a binary version of Qt with Visual Studio 2005, you must
       
   689     first install the Visual Studio Service Pack 1 available
       
   690     \l{http://www.microsoft.com/downloads/details.aspx?FamilyId=BB4A75AB-E2D4-4C96-B39D-37BAF6B5B1DC&amp;displaylang=en}{here}
       
   691     to avoid runtime conflicts.
       
   692 
       
   693     To build Qt with Phonon on Windows, you require:
       
   694 
       
   695     \list
       
   696         \o Microsoft's DirectX Software Development Kit which can be
       
   697         downloaded
       
   698         \l{http://msdn2.microsoft.com/en-us/directx/aa937788.aspx}{here}, and
       
   699         \o Microsoft's Windows Server 2003 R2 Platform SDK which is available
       
   700         \l{http://www.microsoft.com/downloads/details.aspx?FamilyID=0baf2b35-c656-4969-ace8-e4c0c0716adb&amp;DisplayLang=en}{here}.
       
   701     \endlist
       
   702 
       
   703     \sa {Known Issues in %VERSION%}
       
   704 */
       
   705 
       
   706 /*!
       
   707     \page requirements-mac.html
       
   708     \title Qt for Mac OS X Requirements
       
   709     \ingroup installation
       
   710     \brief Setting up the Mac OS X environment for Qt.
       
   711     \previouspage General Qt Requirements
       
   712 
       
   713     \sa {Known Issues in %VERSION%}
       
   714 */
       
   715 
       
   716 /*!
       
   717     \page requirements-x11.html
       
   718     \title Qt for X11 Requirements
       
   719     \ingroup installation
       
   720     \brief Setting up the X11 environment for Qt.
       
   721     \previouspage General Qt Requirements
       
   722 
       
   723     \tableofcontents
       
   724 
       
   725     \section1 QtGui Dependencies
       
   726 
       
   727     \image x11_dependencies.png Qt for X11 Dependencies
       
   728 
       
   729     \raw HTML
       
   730     <style type="text/css" id="colorstyles">
       
   731      #QtGuiColor { background-color: #98fd00; color: black }
       
   732      #QtCoreColor { background-color: #9c9cff; color: black }
       
   733      #DefaultColor { background-color: #f6f6dc; color: black }
       
   734      #FreetypeColor { background-color: #e6e6fa; color: black }
       
   735      #GLColor { background-color: #ffc0cb; color: black }
       
   736      #PthreadColor { background-color: #bdb76b; color: black }
       
   737      #OptionalColor { background-color: #cae1ff; color: black }
       
   738      #SMColor { background-color: #c2fafa; color: black }
       
   739      #MiscColor { background-color: #f0f9ff; color: black }
       
   740      #GlibColor { background-color: #b3b3b3; color: black }
       
   741     </style>
       
   742     \endraw
       
   743 
       
   744     The QtGui module and the QtCore module, which provides the non-GUI features required
       
   745     by QtGui, depend on the libraries described in the following table. To build
       
   746     Qt from its source code, you will also need to install the development
       
   747     packages for these libraries for your system.
       
   748 
       
   749     \table 90%
       
   750     \header \o Name \o Library \o Notes \o Configuration options \o Minimum working version
       
   751     \raw HTML
       
   752     <tr id="OptionalColor">
       
   753     <td> XRender </td><td> libXrender </td><td> X Rendering Extension; used for anti-aliasing</td>
       
   754     <td><tt>-xrender</tt> or auto-detected</td><td>0.9.0</td>
       
   755     </tr><tr id="OptionalColor">
       
   756     <td> Xrandr </td><td> libXrandr </td><td> X Resize and Rotate Extension</td>
       
   757     <td><tt>-xrandr</tt> or auto-detected</td><td>1.0.2</td>
       
   758     </tr><tr id="OptionalColor">
       
   759     <td> Xcursor </td><td> libXcursor </td><td> X Cursor Extension</td>
       
   760     <td><tt>-xcursor</tt> or auto-detected</td><td>1.1.4</td>
       
   761     </tr><tr id="OptionalColor">
       
   762     <td> Xfixes </td><td> libXfixes </td><td> X Fixes Extension</td>
       
   763     <td><tt>-xfixes</tt> or auto-detected</td><td>3.0.0</td>
       
   764     </tr><tr id="OptionalColor">
       
   765     <td> Xinerama </td><td> libXinerama </td><td> Multi-head support</td>
       
   766     <td><tt>-xinerama</tt> or auto-detected</td><td>1.1.0</td>
       
   767 
       
   768     </tr><tr id="OptionalColor">
       
   769     <td> Fontconfig </td><td> libfontconfig </td><td> Font customization and configuration</td>
       
   770     <td><tt>-fontconfig</tt> or auto-detected</td><td>2.1</td>
       
   771     </tr><tr id="OptionalColor">
       
   772     <td> FreeType </td><td> libfreetype </td><td> Font engine</td>
       
   773     <td></td><td>2.1.3</td>
       
   774 
       
   775     </tr><tr id="DefaultColor">
       
   776     <td> Xi </td><td> libXi </td><td> X11 Input Extensions</td>
       
   777     <td><tt>-xinput</tt> or auto-detected</td><td>1.3.0</td>
       
   778     </tr><tr id="DefaultColor">
       
   779     <td> Xt </td><td> libXt </td><td> Xt Intrinsics</td><td></td><td>0.99</td>
       
   780     </tr><tr id="DefaultColor">
       
   781     <td> Xext </td><td> libXext </td><td> X Extensions</td><td></td><td>6.4.3</td>
       
   782     </tr><tr id="DefaultColor">
       
   783     <td> X11 </td><td> libX11 </td><td> X11 Client-Side Library</td><td></td><td>6.2.1</td>
       
   784 
       
   785     </tr><tr id="SMColor">
       
   786     <td> SM </td><td> libSM </td><td> X Session Management</td>
       
   787     <td><tt>-sm</tt> or auto-detected</td><td>6.0.4</td>
       
   788     </tr><tr id="SMColor">
       
   789     <td> ICE </td><td> libICE </td><td> Inter-Client Exchange</td>
       
   790     <td><tt>-sm</tt> or auto-detected</td><td>6.3.5</td>
       
   791 
       
   792     </tr><tr id="GlibColor">
       
   793     <td> glib </td><td> libglib-2.0 </td><td> Common event loop handling</td>
       
   794     <td><tt>-glib</tt> or auto-detected</td><td>2.8.3</td>
       
   795     </tr><tr id="PthreadColor">
       
   796     <td> pthread </td><td> libpthread </td><td> Multithreading</td>
       
   797     <td></td><td>2.3.5</td>
       
   798     </tr>
       
   799     \endraw
       
   800     \endtable
       
   801 
       
   802     \note You must compile with XRender support to get alpha transparency
       
   803     support for pixmaps and images.
       
   804 
       
   805     Development packages for these libraries contain header files that are used
       
   806     when building Qt from its source code. On Debian-based GNU/Linux systems,
       
   807     for example, we recommend that you install the following development
       
   808     packages:
       
   809     
       
   810     \list
       
   811     \o libfontconfig1-dev
       
   812     \o libfreetype6-dev
       
   813     \o libx11-dev
       
   814     \o libxcursor-dev
       
   815     \o libxext-dev
       
   816     \o libxfixes-dev
       
   817     \o libxft-dev
       
   818     \o libxi-dev
       
   819     \o libxrandr-dev
       
   820     \o libxrender-dev
       
   821     \endlist
       
   822 
       
   823     Some of these packages depend on others in this list, so installing one
       
   824     may cause others to be automatically installed. Other distributions may
       
   825     provide system packages with similar names.
       
   826 
       
   827     \section1 OpenGL Dependencies
       
   828 
       
   829     The configure script will autodetect if OpenGL headers and libraries are
       
   830     installed on your system, and if so, it will include the QtOpenGL module
       
   831     in the Qt library.
       
   832     
       
   833     If your OpenGL headers or libraries are placed in a non-standard directory,
       
   834     you may need to change the \c QMAKE_INCDIR_OPENGL and/or
       
   835     \c QMAKE_LIBDIR_OPENGL in the config file for your system.
       
   836 
       
   837     The QGL documentation assumes that you are familiar with OpenGL
       
   838     programming. If you're new to the subject a good starting point is
       
   839     \l{http://www.opengl.org/}.
       
   840 
       
   841     \section1 Phonon Dependencies
       
   842 
       
   843     As described in the \l{Phonon Overview}, Phonon uses the GStreamer multimedia
       
   844     framework as the backend for audio and video playback on X11. The minimum required
       
   845     version of GStreamer is 0.10.
       
   846 
       
   847     To build Phonon, you need the GStreamer library, base plugins, and development
       
   848     files for your system. The package names for GStreamer vary between Linux
       
   849     distributions; try searching for \c gstreamer or \c libgstreamer in your
       
   850     distribution's package repository to find suitable packages.
       
   851 
       
   852     \sa {Known Issues in %VERSION%}
       
   853 */
       
   854 
       
   855 /*!
       
   856     \page requirements-wince.html
       
   857     \title Qt for Windows CE Requirements
       
   858     \ingroup installation
       
   859     \brief Setting up the Windows CE environment for Qt.
       
   860     \previouspage General Qt Requirements
       
   861 
       
   862     Qt is known to work with Visual Studio 2005/2008 and the following SDKs for
       
   863     Windows CE development on Windows XP and Windows Vista:
       
   864 
       
   865     \list
       
   866         \o  Windows CE 5.0 Standard SDK for ARM, X86, and MIPS
       
   867         \o  Windows CE 6.0 SDKs for ARM generated using the defaults found in
       
   868             Platform Builder
       
   869         \o  Windows Mobile 5.0 (\e{Pocket PC}, \e{Smartphone} and
       
   870             \e{Pocket PC with Phone} editions)
       
   871         \o  Windows Mobile 6.0 (\e{Standard}, \e{Classic} and
       
   872             \e{Professional} editions)
       
   873     \endlist
       
   874 
       
   875     Below is a list of links to download the SDKs:
       
   876 
       
   877     \list
       
   878         \o \l{http://www.microsoft.com/downloads/details.aspx?familyid=fa1a3d66-3f61-4ddc-9510-ae450e2318c3&amp;displaylang=en}
       
   879             {Windows CE 5 Standard SDK}
       
   880         \o  \l{http://www.microsoft.com/downloads/details.aspx?familyid=83A52AF2-F524-4EC5-9155-717CBE5D25ED&amp;displaylang=en}
       
   881             {Windows Mobile 5 Pocket PC}
       
   882         \o  \l{http://www.microsoft.com/downloads/details.aspx?familyid=DC6C00CB-738A-4B97-8910-5CD29AB5F8D9&amp;displaylang=en}
       
   883             {Windows Mobile 5 Smartphone}
       
   884         \o  \l{http://www.microsoft.com/downloads/details.aspx?familyid=06111A3A-A651-4745-88EF-3D48091A390B&amp;displaylang=en }
       
   885             {Windows Mobile 6 Professional/Standard}
       
   886     \endlist
       
   887 
       
   888     \table
       
   889         \row \bold{Note:}
       
   890             \o
       
   891             \list 1
       
   892                 \o Currently, there is only compile support for Windows CE 5.0
       
   893                    Standard SDK for SH-4.
       
   894                 \o There is currently no "out of the box" support for the
       
   895                    Windows CE Automotive or Portable Media SDKs from Microsoft.
       
   896             \endlist
       
   897     \endtable
       
   898 
       
   899 
       
   900     Device manufacturers may prefer to make their own customized version of
       
   901     Windows CE using Platform Builder. In order for Qt for Windows CE to
       
   902     support a custom SDK, a build specification needs to be created. More
       
   903     information on Windows CE Customization can be found
       
   904     \l{Windows CE - Working with Custom SDKs}{here}.
       
   905 
       
   906     \sa {Known Issues in %VERSION%}
       
   907 */
       
   908 
       
   909 /*!
       
   910     \page requirements-embedded-linux.html
       
   911     \title Qt for Embedded Linux Requirements
       
   912     \ingroup installation
       
   913     \brief Setting up the Embedded Linux environment for Qt.
       
   914     \previouspage General Qt Requirements
       
   915 
       
   916     \sa {Known Issues in %VERSION%}
       
   917 
       
   918     \section1 Building Qt for Embedded Linux with uclibc
       
   919 
       
   920     If you intend to include the QtWebKit module in your Qt build then you should
       
   921     use version \bold{uClibc 0.9.29 or greater} as that is the earliest version
       
   922     with sufficient pthread support.
       
   923 
       
   924     \section1 Memory Requirements
       
   925 
       
   926     The memory and storage requirements for Qt for Embedded Linux depend on a
       
   927     an variety of different factors, including the target architecture and the
       
   928     features enabled in the Qt build.
       
   929 
       
   930     The following table shows typical library sizes for the most common Qt
       
   931     libraries on different architectures, built in release mode with different
       
   932     feature profiles.
       
   933 
       
   934     \table
       
   935     \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
       
   936     \header                                        \o Minimal \o Normal \o Minimal \o Normal \o Minimal \o Normal \o Minimal \o Normal 
       
   937     \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
       
   938     \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
       
   939     \row    \o linux-mips-g++ (MIPS32)
       
   940                              \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
       
   941     \endtable
       
   942 
       
   943     Library sizes are given in the following units: K = 1024 bytes; M = 1024K.
       
   944     QtWebKit is excluded from the minimal configuration.
       
   945 
       
   946     The \l{Fine-Tuning Features in Qt} document covers the process of configuring
       
   947     Qt builds to avoid the inclusion of unnecessary features.
       
   948 
       
   949     \section1 Additional X11 Libraries for QVFb
       
   950 
       
   951     The Virtual Framebuffer (QVFb) application requires the \c libxtst library
       
   952     in addition to the libraries used to build Qt for X11. This library
       
   953     enables the use of the Record extension to the X protocol to be used in
       
   954     applications.
       
   955 */
       
   956 
       
   957 /*!
       
   958     \page requirements-symbian.html
       
   959     \title Qt for Symbian platform Requirements
       
   960     \ingroup installation
       
   961     \brief Setting up the Symbian platform environment for Qt.
       
   962     \previouspage General Qt Requirements
       
   963 
       
   964     Qt for Symbian platform requires the following software installed on your development PC:
       
   965     \list
       
   966         \o \l{http://www.mingw.org/}{MinGW 3.4.5 or higher}, or another windows compiler to build the tools.
       
   967         \o \l{http://www.forum.nokia.com/main/resources/tools_and_sdks/carbide_cpp/}{Carbide.c++ v2.0.0 or higher}           
       
   968            \list
       
   969            \o \bold{Note:} It may be necessary to update the Carbide compiler.
       
   970               See \l{http://pepper.troll.no/s60prereleases/patches/}{here} for instructions how to check your
       
   971               compiler version and how to patch it, if needed.
       
   972            \endlist
       
   973         \o \l{http://www.forum.nokia.com/main/resources/tools_and_sdks/S60SDK/}{S60 Platform SDK 3rd Edition FP1 or higher}
       
   974         \o \l{http://www.forum.nokia.com/main/resources/technologies/openc_cpp/}{Open C/C++ v1.6.0 or higher}. 
       
   975            Install this to all Symbian SDKs you plan to use Qt with.
       
   976         \o Building Qt libraries requires \l{http://www.arm.com/products/DevTools/RVCT.html}{RVCT} 2.2 [build 686] or later,
       
   977            which is not available free of charge. 
       
   978     \endlist
       
   979 
       
   980     Running Qt on real device requires the following packages to be installed on your device.
       
   981     The packages can be found in the Symbian SDK where you installed Open C/C++:
       
   982     \list
       
   983         \o \c{nokia_plugin\openc\s60opencsis\pips_s60_<version>.sis}
       
   984         \o \c{nokia_plugin\openc\s60opencsis\openc_ssl_s60_<version>.sis}
       
   985         \o \c{nokia_plugin\opencpp\s60opencppsis\stdcpp_s60_<version>.sis}
       
   986     \endlist
       
   987 
       
   988     \note Users of \bold{S60 Platform SDK 3rd Edition FP1} also need special updates. The update can be found
       
   989     \l{http://pepper.troll.no/s60prereleases/patches/}{here}.
       
   990 
       
   991     \sa {Known Issues in %VERSION%}
       
   992 */