Update copyright headers
[qt:qt.git] / doc / src / getting-started / installation.qdoc
1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the documentation of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:FDL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Free Documentation License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Free
19 ** Documentation License version 1.3 as published by the Free Software
20 ** Foundation and appearing in the file included in the packaging of
21 ** this file.  Please review the following information to ensure
22 ** the GNU Free Documentation License version 1.3 requirements
23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
24 ** $QT_END_LICENSE$
25 **
26 ****************************************************************************/
27
28 /*!
29 \group installation
30 \title Installation
31 \brief Installing Qt on supported platforms.
32
33 The installation procedure is different on each Qt platform. This page provides
34 information on how to install Qt, as well as software and hardware requirements
35 for using Qt on each of the supported platforms. Please follow the instructions
36 for your platform from the following list.
37
38 \generatelist{related}
39
40 */
41
42 /*! \page install-x11.html
43 \title Installing Qt for X11 Platforms
44 \ingroup installation
45 \brief How to install Qt on platforms with X11.
46 \previouspage Installation
47
48 \tableofcontents
49
50     Qt for X11 has some requirements that are given in more detail
51     in the \l{Qt for X11 Requirements} document.
52
53 \section1 Step 1: Installing the License File (commercial editions only)
54     If you have the commercial edition of Qt, install your license
55     file as \c{$HOME/.qt-license}.
56
57     For the open source version you do not need a license file.
58
59 \section1 Step 2: Unpacking the Archive
60     Unpack the archive if you have not done so already. For example,
61     if you have the \c{qt-everywhere-opensource-src-%VERSION%.tar.gz}
62     package, type the following commands at a command line prompt:
63
64 \snippet doc/src/snippets/code/doc_src_installation.qdoc 0
65
66     This creates the directory \c{/tmp/qt-everywhere-opensource-src-%VERSION%}
67     containing the files from the archive. We only support the GNU version of
68     the tar archiving utility. Note that on some systems it is called gtar.
69
70 \section1 Step 3: Building the Library
71
72     To configure the Qt library for your machine type, run the
73     \c{./configure} script in the package directory.
74
75     By default, Qt is configured for installation in the
76     \c{/usr/local/Trolltech/Qt-%VERSION%} directory, but this can be
77     changed by using the \c{-prefix} option.
78
79 \snippet doc/src/snippets/code/doc_src_installation.qdoc 1
80
81     Type \c{./configure -help} to get a list of all available options.
82     The \l{Configuration Options for Qt} page gives a brief overview
83     of these.
84
85     To create the library and compile all the demos, examples, tools,
86     and tutorials, type:
87
88 \snippet doc/src/snippets/code/doc_src_installation.qdoc 2
89
90     If \c{-prefix} is outside the build directory, you need to install
91     the library, demos, examples, tools, and tutorials in the appropriate
92     place. To do this (as root if necessary), type:
93
94 \snippet doc/src/snippets/code/doc_src_installation.qdoc 3
95
96     Note that on some systems the make utility is named differently,
97     e.g. gmake. The configure script tells you which make utility to
98     use.
99
100     \bold{Note:} If you later need to reconfigure and rebuild Qt from the
101     same location, ensure that all traces of the previous configuration are
102     removed by entering the build directory and typing \c{make confclean}
103     before running \c configure again.
104
105 \section1 Step 4: Set the Environment Variables
106
107     In order to use Qt, some environment variables needs to be
108     extended.
109
110 \snippet doc/src/snippets/code/doc_src_installation.qdoc 4
111
112     This is done like this:
113
114     In \c{.profile} (if your shell is bash, ksh, zsh or sh), add the
115     following lines:
116
117 \snippet doc/src/snippets/code/doc_src_installation.qdoc 5
118
119     In \c{.login} (in case your shell is csh or tcsh), add the following line:
120
121 \snippet doc/src/snippets/code/doc_src_installation.qdoc 6
122
123     If you use a different shell, please modify your environment
124     variables accordingly.
125
126     For compilers that do not support rpath you must also extended the
127     \c LD_LIBRARY_PATH environment variable to include
128     \c{/usr/local/Trolltech/Qt-%VERSION%/lib}. On Linux with GCC this step
129     is not needed.
130
131 \bold {That's all. Qt is now installed.}
132
133 \section1 Qt Demos and Examples
134
135     If you are new to Qt, we suggest that you take a look at the demos
136     and examples to see Qt in action. Run the Qt Examples and Demos
137     either by typing \c qtdemo on the command line or through the
138     desktop's Main menu.
139
140     You might also want to try the following links:
141
142     \list
143     \o \l{Configuring Qt}
144     \o \l{How to Learn Qt}
145     \o \l{Tutorials}
146     \o \l{Developer Network}
147     \o \l{Deploying Qt Applications}
148     \endlist
149
150     We hope you will enjoy using Qt. Good luck!
151
152 */
153
154 /*!
155 \page install-win.html
156 \title Installing Qt for Windows
157 \ingroup installation
158 \brief How to install Qt on Windows.
159 \previouspage Installation
160
161 \tableofcontents
162
163     Qt for Windows has some requirements that are given in more detail
164     in the \l{Qt for Windows Requirements} document.
165
166     If you have obtained a binary package for this platform,
167     consult the installation instructions provided instead of the ones in
168     this document.
169
170     Open Source Versions of Qt is not officially supported for use with
171     any version of Visual Studio. Integration with Visual Studio is available
172     as part of the \l{Qt Commercial Edition}.
173
174 \section1 Step 1: Install the License File (commercial editions only)
175
176     If you have the commercial edition of Qt, copy the license file
177     from your account on dist.trolltech.com into your home directory
178     (this may be known as the \c userprofile environment variable) and
179     rename it to \c{.qt-license}. This renaming process must be done
180     using a \e{command prompt} on Windows, \bold{not} with Windows Explorer.
181     For example on Windows 2000, \c{%USERPROFILE%} should be something
182     like \c{C:\Documents and Settings\username}
183
184     For the open source version you do not need a license file.
185
186 \section1 Step 2: Unpack the Archive
187
188     Uncompress the files into the directory you want Qt installed;
189     e.g. \c{C:\Qt\%VERSION%}.
190
191     \note The install path must not contain any spaces or Windows specific
192     file system characters.
193
194 \section1 Step 3: Set the Environment variables
195
196     In order to build and use Qt, the \c PATH environment variable needs to be
197     extended:
198
199 \snippet doc/src/snippets/code/doc_src_installation.qdoc 7
200
201     This is done by adding \c{c:\Qt\%VERSION%\bin} to the \c PATH variable.
202
203     For newer versions of Windows, \c PATH can be extended through
204     the \menu{Control Panel|System|Advanced|Environment variables} menu.
205
206     You may also need to ensure that the locations of your compiler and
207     other build tools are listed in the \c PATH variable. This will depend
208     on your choice of software development environment.
209
210     \note If you don't use the configured shells, which is
211     available in the application menu, in the \l{Open Source Versions of Qt},
212     \c configure requires that \c sh.exe is not in the path
213     or that it is run from \c msys. This also goes for mingw32-make.
214
215 \section1 Step 4: Build the Qt Library
216
217
218     To configure the Qt library for your machine, type the following command
219     in a \bold{Visual Studio} command prompt:
220
221 \snippet doc/src/snippets/code/doc_src_installation.qdoc 8
222
223     Type \c{configure -help} to get a list of all available options. The
224     \l{Configuration Options for Qt} page gives a brief overview of these.
225
226     If you have multiple compilers installed, and want to build the Qt library
227     using a specific compiler, you must specify a \c qmake specification.
228     This is done by pasing \c{-platform <spec>} to configure; for example:
229
230 \snippet doc/src/snippets/code/doc_src_installation.qdoc 9
231
232     In some cases you need to set up the compilation environment before running
233     configure in order to use the right compiler. For instance, you need to do this
234     if you have Visual Studio 2005 installed and want to compile Qt using the x64
235     compiler because the 32-bit and 64-bit compiler both use the same
236     \c qmake specification file.
237     This is usually done by selecting
238     \menu{Microsoft Visual Studio 2005|Visual Studio Tools|<Command Prompt>}
239     from the \gui Start menu.
240
241     The actual commands needed to build Qt depends on your development
242     system. For Microsoft Visual Studio to create the library and
243     compile all the demos, examples, tools and tutorials type:
244
245 \snippet doc/src/snippets/code/doc_src_installation.qdoc 10
246
247     \note If you later need to reconfigure and rebuild Qt from the
248     same location, ensure that all traces of the previous configuration are
249     removed by entering the build directory and typing \c{nmake distclean}
250     before running \c configure again.
251
252 \bold{That's all. Qt is now installed.}
253
254 \section1 Qt Demos and Examples
255
256     If you are new to Qt, we suggest that you take a look at the demos
257     and examples to see Qt in action. Run the Qt Examples and Demos
258     either by typing \c qtdemo on the command line or through the
259     desktop's Start menu.
260
261     You might also want to try the following links:
262
263     \list
264     \o \l{How to Learn Qt}
265     \o \l{Tutorials}
266     \o \l{Developer Network}
267     \o \l{Deploying Qt Applications}
268     \endlist
269
270     We hope you will enjoy using Qt. Good luck!
271
272 */
273
274 /*! \page install-mac.html
275 \title Installing Qt for Mac OS X
276 \ingroup installation
277 \brief How to install Qt on Mac OS X.
278 \previouspage Installation
279 \tableofcontents
280
281 Qt for Mac OS X has some requirements that are given in more detail
282 in the \l{Qt for Mac OS X Requirements} document.
283
284 The following instructions describe how to install Qt from the source package.
285
286 For the binary package, simply double-click on the Qt.mpkg
287 and follow the instructions to install Qt. You can later run the \c{uninstall-qt.py}
288 script to uninstall the binary package. The script is located in /Developer/Tools and
289 must be run as root.
290
291 \note Do not run the iPhone simulator while installing Qt. The
292 \l{http://openradar.appspot.com/7214991}
293 {iPhone simulator conflicts with the package installer}.
294
295 \section1 Step 1: Install the License File (commercial editions only)
296     If you have the commercial edition of Qt, install your license
297     file as \c{$HOME/.qt-license}.
298
299     For the open source version you do not need a license file.
300
301     Unpack the archive if you have not done so already. For example,
302     if you have the \c{qt-everywhere-opensource-src-%VERSION%.tar.gz}
303     package, type the following commands at a command line prompt:
304
305 \snippet doc/src/snippets/code/doc_src_installation.qdoc 11
306
307     This creates the directory \c{/tmp/qt-everywhere-opensource-src-%VERSION%}
308     containing the files from the archive.
309
310 \section1 Step 2:  Build the Qt Library
311
312     To configure the Qt library for your machine type, run the
313     \c{./configure} script in the package directory.
314
315     By default, Qt is configured for installation in the
316     \c{/usr/local/Trolltech/Qt-%VERSION%} directory, but this can be
317     changed by using the \c{-prefix} option.
318
319 \snippet doc/src/snippets/code/doc_src_installation.qdoc 12
320
321     Type \c{./configure -help} to get a list of all available options.
322
323     Note that you will need to specify \c{-universal} if you want to
324     build universal binaries, and also supply a path to the \c{-sdk}
325     option if your development machine has a PowerPC CPU. By default,
326     Qt is built as a framework, but you can built it as a set of
327     dynamic libraries (dylibs) by specifying the \c{-no-framework}
328     option.
329
330     Qt can also be configured to be built with debugging symbols. This
331     process is described in detail in the \l{Debugging Techniques}
332     document.
333
334     To create the library and compile all the demos, examples, tools,
335     and tutorials, type:
336
337 \snippet doc/src/snippets/code/doc_src_installation.qdoc 13
338
339     If \c{-prefix} is outside the build directory, you need to install
340     the library, demos, examples, tools, and tutorials in the appropriate
341     place. To do this, type:
342
343 \snippet doc/src/snippets/code/doc_src_installation.qdoc 14
344
345     This command requires that you have administrator access
346     on your machine.
347
348     \note There is a potential race condition when running make install with multiple
349     jobs. It is best to only run one make job (-j1) for the install.
350
351     If you later need to reconfigure and rebuild Qt from the
352     same location, ensure that all traces of the previous configuration are
353     removed by entering the build directory and typing \c{make confclean}
354     before running \c configure again.
355
356 \section1 Step 3: Set the Environment variables
357
358     In order to use Qt, some environment variables need to be
359     extended.
360
361 \snippet doc/src/snippets/code/doc_src_installation.qdoc 15
362
363     This is done like this:
364
365     In \c{.profile} (if your shell is bash), add the following lines:
366
367 \snippet doc/src/snippets/code/doc_src_installation.qdoc 16
368
369     In \c{.login} (in case your shell is csh or tcsh), add the following line:
370
371 \snippet doc/src/snippets/code/doc_src_installation.qdoc 17
372
373     If you use a different shell, please modify your environment
374     variables accordingly.
375
376 \bold {That's all. Qt is now installed.}
377
378 \section1 Qt Demos and Examples
379     If you are new to Qt, we suggest that you take a look at the demos
380     and examples to see Qt in action. Run the Qt Examples and Demos
381     either by typing \c qtdemo on the command line or through the
382     desktop's Start menu.
383
384     You might also want to try the following links:
385
386     \list
387     \o \l{How to Learn Qt}
388     \o \l{Tutorials}
389     \o \l{Developer Network}
390     \o \l{Deploying Qt Applications}
391     \endlist
392
393     We hope you will enjoy using Qt. Good luck!
394
395 */
396
397 /*! \page install-wince.html
398 \title Installing Qt for Windows CE
399 \ingroup installation
400 \ingroup qtce
401 \brief How to install Qt for Windows CE.
402 \previouspage Installation
403 \tableofcontents
404
405 Qt for Windows CE has some requirements that are given in more detail
406 in the \l{Qt for Windows CE Requirements} document.
407
408 \section1 Step 1: Install the License File (commercial editions only)
409     Uncompress the files into the directory you want to install Qt into;
410     e.g., \c{C:\Qt\%VERSION%}.
411
412     \note The install path must not contain any spaces.
413
414 \section1 Step 2: Set the Environment variables
415
416     In order to build and use Qt, the \c PATH environment variable needs
417     to be extended:
418
419 \snippet doc/src/snippets/code/doc_src_installation.qdoc 18
420     This is done by adding \c{c:\Qt\%VERSION%\bin} to the \c PATH variable.
421
422     For newer versions of Windows, \c PATH can be extended through
423     "Control Panel->System->Advanced->Environment variables" and for
424     older versions by editing \c{c:\autoexec.bat}.
425
426     Make sure the enviroment variables for your compiler are set.
427     Visual Studio includes \c{vcvars32.bat} for that purpose - or simply
428     use the "Visual Studio Command Prompt" from the Start menu.
429
430 \section1 Step 3: Configure Qt
431
432     To configure Qt for Windows Mobile 5.0 for Pocket PC, type the
433     following:
434
435 \snippet doc/src/snippets/code/doc_src_installation.qdoc 19
436
437     If you want to configure Qt for another platform or with other
438     options, type \c{configure -help} to get a list of all available
439     options. The \l{Configuration Options for Qt} page gives a brief
440     overview of these. See the \c README file for the list of supported
441     platforms.
442
443 \section1 Step 4: Build Qt Library
444
445     Now, to build Qt you first have to update your \c PATH, \c INCLUDE
446     and \c LIB paths to point to the correct resources for your target
447     platforms. For a default installation of the Windows Mobile 5.0
448     Pocket PC SDK, this is done with the following commands:
449
450 \snippet doc/src/snippets/code/doc_src_installation.qdoc 20
451
452     We provide a convenience script for this purpose, called \c{setcepaths}.
453     Simply type:
454
455 \snippet doc/src/snippets/code/doc_src_installation.qdoc 21
456
457     Then to build Qt type:
458
459     \snippet doc/src/snippets/code/doc_src_installation.qdoc 22
460
461 \bold{That's all. Qt is now installed.}
462
463 \section1 Qt Demos and Examples
464
465     To get started with Qt, you can check out the examples found in the
466     \c{examples} directory of your Qt installation. The documentation can
467     be found in \c{doc\html}.
468
469     \note If you reconfigure Qt for a different platform,
470     make sure you start with a new clean console to get rid of the
471     platform dependent include directories.
472
473     The links below provide further information for using Qt:
474     \list
475     \o \l{How to Learn Qt}
476     \o \l{Tutorials}
477     \o \l{Developer Network}
478     \o \l{Deploying Qt Applications}
479     \endlist
480
481     You might also want to try the following Windows CE specific links:
482     \list
483     \o \l{Windows CE - Introduction to using Qt}
484     \o \l{Windows CE - Working with Custom SDKs}
485     \o \l{Windows CE - Using shadow builds}
486     \o \l{Windows CE - Signing}
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
496     We hope you will enjoy using Qt. Good luck!
497 */
498
499 /*! \page install-Symbian-installer.html
500 \title Installing Qt for the Symbian platform from a Binary Package
501 \ingroup qtsymbian
502 \brief How to install Qt for the Symbian platform from a binary package.
503 \previouspage Installation
504
505 \tableofcontents
506
507     Qt for Symbian binary packages (SIS files) are available from the \l
508     {http://qt.nokia.com/downloads}{Qt SDK}.
509
510 */
511 /*! \page install-Symbian.html
512 \title Installing Qt for the Symbian Platform
513 \ingroup installation
514 \ingroup qtsymbian
515 \brief How to install Qt for the Symbian platform.
516 \previouspage Installation
517 \tableofcontents
518
519     \l {http://qt.nokia.com/downloads}{Qt SDK} provides all the necessary tools
520     and libraries for developing Qt applications. However, if you want to build
521     Qt itself for Symbian, follow the instructions below.
522
523 Qt for the Symbian platform has some requirements that are given in more detail
524 in the \l{Qt for the Symbian platform Requirements} document.
525
526 This document describes how to install and configure Qt for
527 the Symbian platform from scratch.
528
529 \section1 Step 1: Set Up the Development Environment
530
531     Make sure your Symbian development environment is correctly installed
532     and patched as explained in the \l{Qt for the Symbian platform Requirements}
533     document.
534
535     After you have finished the Symbian development environment setup, it is
536     good to verify that environment is functional for example by compiling one
537     of the pure Symbian examples for both emulator and HW. This can be done from
538     command prompt as follows:
539
540 \snippet doc/src/snippets/code/doc_src_installation.qdoc 32
541
542     If all steps pass without errors your Symbian development environment is
543     very likely installed correctly.
544
545 \section1 Step 2: Install Qt
546
547     Uncompress the \l{http://qt.nokia.com/downloads}{downloaded} source
548     package into the directory you want Qt installed, e.g. \c{C:\Qt\%VERSION%}.
549
550     \note Qt must be installed on the same drive as the Symbian SDK you are
551     using, and the install path must not contain any spaces.
552
553 \section1 Step 3: Set the Environment variables
554
555     In order to build and use Qt, the \c PATH environment variable needs
556     to be extended:
557
558 \snippet doc/src/snippets/code/doc_src_installation.qdoc 18
559
560     This is done by adding \c{c:\Qt\%VERSION%\bin} to the \c PATH variable.
561
562     On Windows the\c PATH can be extended by navigating to
563     "Control Panel->System->Advanced->Environment variables".
564
565     In addition, you must configure the environment for use with the Symbian
566     emulator. This is done by locating the Carbide.c++ submenu on the Start
567     menu, and choosing "Configure environment for WINSCW command line".
568
569     If you are planning to use \c abld (the default build system that comes with
570     the S60 SDK) to build Qt, you will also need to set the following
571     environment variable:
572
573 \snippet doc/src/snippets/code/doc_src_installation.qdoc 33
574
575     This is not necessary for other applications, only when building Qt.
576
577 \section1 Step 4: Configure Qt
578
579     To configure Qt for the Symbian platform, do:
580
581 \snippet doc/src/snippets/code/doc_src_installation.qdoc 23
582     (to build the tools using MinGW, and the libraries using abld)
583
584     \bold or
585
586 \snippet doc/src/snippets/code/doc_src_installation.qdoc 31
587     (to build the tools using MinGW, and the libraries using SBSv2)
588
589     Type \c{./configure -help} to get a list of all available options.
590     The \l{Configuration Options for Qt} page gives a brief overview
591     of these.
592
593     SBSv2 (also known as \l{http://projects.developer.nokia.com/raptor/wiki} {Raptor})
594     is a next-generation Symbian build system. SBSv2 is not officially supported
595     by any of the S60 SDKs currently available from Forum Nokia.
596
597 \section1 Step 5: Build Qt
598
599     To build Qt for the emulator, type:
600
601 \snippet doc/src/snippets/code/doc_src_installation.qdoc 24
602
603     To build Qt for the device, type:
604
605 \snippet doc/src/snippets/code/doc_src_installation.qdoc 28
606
607     Congratulations, Qt is now ready to use.
608
609 \section1 Step 7: Installing Qt Libraries on the Device
610
611     To run a Qt application on a device, it must have Qt libraries installed.
612
613     Symbian devices have a pre-installed Qt as follows:
614     \list
615     \o Symbian Anna devices have the pre-installed Qt, Qt Mobility, and Qt Webkit.
616     \o Symbian Belle and later devices have the pre-installed Qt on the device firmware.
617     \endlist
618
619     \l {http://www.developer.nokia.com/Community/Wiki/Nokia_Smart_Installer_for_Symbian}
620     {Nokia Smart Installer for Symbian} deploys the required Qt libraries to supported S60
621     and Symbian devices if the libraries are not pre-installed.
622
623     Nokia Developer site's \l {http://www.developer.nokia.com/Devices/Device_specifications/?filter1=qt}
624     {Device specifications} provide information on which devices have a
625     pre-installed Qt and the used Qt version.
626
627     To create your own Qt installation package, do as follows:
628
629     \snippet doc/src/snippets/code/doc_src_installation.qdoc 29
630
631     The Qt libraries are built with "All -Tcb" capability, so they can support
632     all types of applications. If you don't have a suitable certificate, you can
633     patch the binaries in either of the following ways:
634
635     \list
636     \o If you have no certificate, build a self-signed Qt:
637     \snippet doc/src/snippets/code/doc_src_installation.qdoc 34
638
639     \o If you have a symbian-signed developer certificate, specify the
640     capabilities you can sign for, for example:
641     \snippet doc/src/snippets/code/doc_src_installation.qdoc 35
642     \endlist
643
644 \section1 Running Qt demos
645
646     We've included a subset of the Qt demos in this package for you
647     to try out. An excellent starting point is the "fluidlauncher"
648     demo.
649
650     Similarly, install fluidlauncher to the device:
651
652 \snippet doc/src/snippets/code/doc_src_installation.qdoc 30
653
654     This will create a self-signed \c fluidlauncher.sis and
655     install it to your device.
656
657     To run the demos on the emulator simply navigate to the directory of the demo
658     you want to see and run:
659
660 \snippet doc/src/snippets/code/doc_src_installation.qdoc 27
661
662     For more information about building and running Qt programs on the
663     Symbian platform, see \l{The Symbian platform - Introduction to Qt}.
664     We hope you will enjoy using Qt.
665
666 */
667 /*! \page install-symbian-linux.html
668 \title Installing Qt for the Symbian platform using Linux (experimental)
669 \ingroup installation
670 \ingroup qtsymbian
671 \brief How to install Qt for the Symbian platform using Linux.
672 \previouspage Installation
673 \tableofcontents
674
675 This document describes how to install and configure Qt for
676 the Symbian platform from scratch, using Linux as the build host.
677 Qt for Symbian binaries can be downloaded directly so development of
678 applications using Qt for Symbian can start right away.
679
680 \section1 Step 1: Setup the Development Environment
681
682 Qt for the Symbian platform has some requirements on the development
683 platform. The Symbian SDK for Linux as well as a cross compiler for the ARM
684 processor used on Symbian devices should be present on the development
685 machine.
686
687 See \l{http://qt.gitorious.org/qt/pages/QtCreatorSymbianLinux} for more details.
688
689
690 \section1 Step 2: Unpack the Archive
691
692 Uncompress the \l{http://qt.nokia.com/downloads}{downloaded} source package into the
693 directory you want Qt installed, e.g. \c{/home/user/qt/%VERSION%}.
694
695
696 \section1 Step 3: Set the Environment Variables
697
698 In order to build and use Qt, the \c PATH environment variable needs
699 to be extended to fine Qt tools and also to find the Symbian platform tools:
700
701 First you need to set the \c EPOCROOT environment variable to point to the
702 location of your S60 SDK:
703
704 \snippet doc/src/snippets/code/doc_src_installation.qdoc 36
705
706 Then you can update the PATH variable;
707
708 \snippet doc/src/snippets/code/doc_src_installation.qdoc 37
709
710
711 \section1 Step 4: Configure Qt
712
713 To configure Qt for the Symbian platform, do:
714
715 \snippet doc/src/snippets/code/doc_src_installation.qdoc 38
716
717 to build the libraries using RVCT or
718
719 \snippet doc/src/snippets/code/doc_src_installation.qdoc 39
720
721 to build the libraries using GCCE.
722
723 Type \c{./configure -help} to get a list of all available options.
724 The \l{Configuration Options for Qt} page gives a brief overview
725 of these.
726
727 \section1 Step 5: Build Qt
728
729 To build Qt for the device, type:
730
731 \snippet doc/src/snippets/code/doc_src_installation.qdoc 40
732
733 Congratulations, Qt is now ready to use.
734
735
736 \section1 Step 6: Building Qt Packages for the Device
737
738 To run any application or demo on a real device, you need to install it
739 on the device. To do this you first have to create a a package for the
740 device, containing the libraries:
741
742 \bold{Building a Qt package without a certificate}
743
744 If you have no certificate, build a self signed Qt:
745
746 \snippet doc/src/snippets/code/doc_src_installation.qdoc 41
747
748 The Qt libraries are built with "All -Tcb" capability, so that
749 they can support all types of applications. However, these
750 capabilities are automatically lowered if you make a self-signed
751 package.
752
753 \bold{Building a Qt package with a Symbian developer certificate}
754
755 If you have a Symbian-signed developer certificate, specify the
756 capabilities you can sign for, for example:
757
758 \snippet doc/src/snippets/code/doc_src_installation.qdoc 42
759
760 \section2 Installing Qt Packages to the Device.
761
762 It is possible to install packages to a phone in Linux by putting
763 the package on the phone memory card and then installing manually
764 from the phone menu. However, this is tedious and will not work
765 on phones without a memory card, so the method recommended by Qt is
766 to use the App TRK tool.
767
768 \section3 Obtaining the App TRK package.
769
770 Download the package from the following location.
771
772 \list
773 \o \l{http://tools.ext.nokia.com/trk/}{Application TRK}.
774    Choose the correct installation package based on the
775    S60 version of your device
776    (\c{S60_<S60-version>_app_trk_<TRK-version>.sisx}).
777 \endlist
778
779 This package currently has to be installed by putting the
780 package on the memory card and installing from the phone
781 menu, or using a Windows PC for doing the install. However,
782 the installation only has to be done once.
783
784 \section3 Configuring App TRK on the Phone
785
786 When App TRK is installed, connect the phone to the PC using
787 the USB cable. Select "PCSuite" as connection type. Then run
788 App TRK on the phone, and make sure that the connection type is
789 USB. This can be changed under the \c Settings menu entry.
790 If necessary, choose \c Connect from the menu.
791
792 \section3 Configuring the USB Serial Driver on the Linux System
793
794 On Linux, phone should appear as the \c /dev/ttyUSB1 device,
795 however if you are running an old kernel, you may need to
796 force the USB module to be loaded correctly before the device
797 will appear:
798
799 \snippet doc/src/snippets/code/doc_src_installation.qdoc 43
800
801 Note the identifier on the line where your Symbian device
802 appears. Then execute the following, using the first and
803 second part of the identifier in place of \c XXX,
804 respectively.
805
806 \snippet doc/src/snippets/code/doc_src_installation.qdoc 44
807
808 The \c rmmod step may fail if the module is not already
809 loaded, but that is harmless.
810
811 \section3 Building the runonphone Tool.
812
813 Note that building the \c runonphone tool requires a separate
814 installation of Qt for Linux. If there is a version of Qt
815 installed by your distribution's package mechanism, that that
816 should do fine. Some distributions separate the libraries from
817 the development setup which includes \c qmake. Make sure you
818 have both installed.
819
820 You will also need the \l{libusb} libraries and header files
821 installed. Usually, installing a development package such as
822 \c{libusb-dev} will ensure that you have all the necessary
823 dependencies installed.
824
825 First, make sure that the \c qmake you use is taken from the
826 Linux installation of Qt. The easiest way to make sure of this
827 is to open a new shell and run the following command:
828
829 \snippet doc/src/snippets/code/doc_src_installation.qdoc 45
830
831 \c qmake will tell you where it is installed.
832
833 Copy the \c{%QTDIR%/tools/runonphone} folder to a place outside
834 of the Qt tree. Then go to the folder in a shell and build it:
835
836 \snippet doc/src/snippets/code/doc_src_installation.qdoc 46
837
838 Copy the resulting executable to a folder which is in your
839 \c PATH environment variable.
840
841 \section3 Installing the Built Package onto the Phone
842
843 \note Before starting, please make sure that there is no previously
844 installed version of Qt on the phone.
845
846 Return to the root of the Qt tree configured for Symbian. Then
847 install the Qt libraries by running the following:
848
849 \snippet doc/src/snippets/code/doc_src_installation.qdoc 47
850
851 You may need to supply the path of the serial device file using
852 the \c{-p} option:
853
854 \snippet doc/src/snippets/code/doc_src_installation.qdoc runonphone with device file path
855
856 If the installation fails, please make sure that there is
857 no previously installed version of Qt on the phone.
858
859 Qt requires some dependent packages to be installed on the device,
860 which can be installed using the runonphone tool as well. One is
861 the \c{sqlite3.sis}, which is included in the Qt distribution, while
862 the others are shipped with the Symbian SDK. The required packages
863 can be found from the following locations:
864
865 \snippet doc/src/snippets/code/doc_src_installation.qdoc 50
866
867 It is also possible to install packages onto the device using the
868 \c runonphone build rule that \c qmake automatically generates for
869 each Qt project. Options can be supplied to the \c runonphone tool
870 that is invoked begind the scenes:
871
872 \snippet doc/src/snippets/code/doc_src_installation.qdoc make runonphone with options
873
874 If you are running \c runonphone or invoking the \c runonphone
875 build rule often, it is possible to set the \c QT_RUN_ON_PHONE_OPTIONS
876 environment variable with the options you normally use:
877
878 \snippet doc/src/snippets/code/doc_src_installation.qdoc make runonphone with preset environment variable
879
880 This makes installation of packages onto a device easier and less
881 error-prone.
882
883
884 \section1 Running Qt Demos
885
886 We've included a subset of the Qt demos in this package for you
887 to try out. An excellent starting point is the "fluidlauncher"
888 demo.
889
890 Install and run the demo by using the following commands:
891
892 \snippet doc/src/snippets/code/doc_src_installation.qdoc 48
893
894 The same command can be used for other applications:
895
896 \snippet doc/src/snippets/code/doc_src_installation.qdoc 49
897
898 For more information about building and running Qt programs on the
899 Symbian platform, see \l{The Symbian platform - Introduction to Qt}.
900
901 We hope you will enjoy using Qt.
902 */
903
904 /*!
905     \page requirements.html
906     \title General Qt Requirements
907     \ingroup installation
908     \brief Outlines the general requirements and dependencies needed to install Qt.
909
910     This page describes the specific requirements of libraries and components on which
911     Qt depends. For information about installing Qt, see the \l{Installation} page.
912
913     For information about the platforms that Qt supports, see the \l{Supported Platforms}
914     page.
915
916     \section1 OpenSSL (version 0.9.7 or later)
917
918     Support for \l{SSL}{Secure Sockets Layer (SSL)} communication is provided by the
919     \l{OpenSSL Toolkit}, which must be obtained separately. More information about
920     enabling SSL support can be found in the \l{Secure Sockets Layer (SSL) Classes}
921     document.
922
923     \section1 Platform-Specific Requirements
924
925     Each platform has its own specific set of dependencies. Please see the relevant
926     page for more details about the components that are required to build and install
927     Qt on your platform.
928
929     \list
930     \o \l{Qt for Embedded Linux Requirements}
931     \o \l{Qt for Mac OS X Requirements}
932     \o \l{Qt for the Symbian platform Requirements}
933     \o \l{Qt for Windows CE Requirements}
934     \o \l{Qt for Windows Requirements}
935     \o \l{Qt for X11 Requirements}
936     \endlist
937 */
938
939 /*!
940     \page requirements-win.html
941     \title Qt for Windows Requirements
942     \ingroup installation
943     \brief Setting up the Windows environment for Qt.
944     \previouspage General Qt Requirements
945
946     If you are using a binary version of Qt with Visual Studio 2005, you must
947     first install the Visual Studio Service Pack 1 available
948     \l{http://www.microsoft.com/downloads/details.aspx?FamilyId=BB4A75AB-E2D4-4C96-B39D-37BAF6B5B1DC&amp;displaylang=en}{here}
949     to avoid runtime conflicts.
950     Additionally, you must use the Check for Updates feature in the Help menu of the Visual Studio 2005 IDE to apply at least the following security updates: KB937061, KB971023, KB971090, KB973673.
951
952     If you are using a source edition of Qt, you must first install Perl so
953     that the syncqt script invoked by configure can be executed. You can download
954     this \l{http://www.activestate.com/downloads/}{here}.
955
956     To build Qt with Phonon on Windows, you require:
957
958     \list
959         \o Microsoft's DirectX Software Development Kit which can be
960         downloaded
961         \l{http://msdn2.microsoft.com/en-us/directx/aa937788.aspx}{here}, and
962         \o Microsoft's Windows Server 2003 R2 Platform SDK which is available
963         \l{http://www.microsoft.com/downloads/details.aspx?FamilyID=0baf2b35-c656-4969-ace8-e4c0c0716adb&amp;DisplayLang=en}{here}.
964     \endlist
965
966     \sa {Known Issues}
967 */
968
969 /*!
970     \page requirements-mac.html
971     \title Qt for Mac OS X Requirements
972     \ingroup installation
973     \brief Setting up the Mac OS X environment for Qt.
974     \previouspage General Qt Requirements
975
976     Qt requires Xcode to be installed on the system. Xcode should be
977     available on the Mac installation CD.
978
979     \sa {Known Issues}
980 */
981
982 /*!
983     \page requirements-x11.html
984     \title Qt for X11 Requirements
985     \ingroup installation
986     \brief Setting up the X11 environment for Qt.
987     \previouspage General Qt Requirements
988
989     \tableofcontents
990
991     \section1 QtGui Dependencies
992
993     \image x11_dependencies.png Qt for X11 Dependencies
994
995     The QtGui module and the QtCore module, which provides the non-GUI features required
996     by QtGui, depend on the libraries described in the following table. To build
997     Qt from its source code, you will also need to install the development
998     packages for these libraries for your system.
999
1000     \table 100%
1001     \header
1002     \o Name
1003     \o Library
1004     \o Notes
1005     \o Configuration options
1006     \o Minimum working version
1007     \row {id="OptionalColor"}
1008     \o XRender
1009     \o libXrender
1010     \o X Rendering Extension; used for anti-aliasing
1011     \o \tt{-xrender} or auto-detected
1012     \o 0.9.0
1013     \row {id="OptionalColor"}
1014     \o Xrandr
1015     \o libXrandr
1016     \o X Resize and Rotate Extension
1017     \o \tt{-xrandr} or auto-detected
1018     \o 1.0.2
1019     \row {id="OptionalColor"}
1020     \o Xcursor
1021     \o libXcursor
1022     \o X Cursor Extension
1023     \o \tt{-xcursor} or auto-detected
1024     \o 1.1.4
1025     \row {id="OptionalColor"}
1026     \o Xfixes
1027     \o libXfixes
1028     \o X Fixes Extension
1029     \o \tt{-xfixes} or auto-detected
1030     \o 3.0.0
1031     \row {id="OptionalColor"}
1032     \o Xinerama
1033     \o libXinerama
1034     \o Multi-head support
1035     \o \tt{-xinerama} or auto-detected
1036     \o 1.1.0
1037
1038     \row {id="OptionalColor"}
1039     \o Fontconfig
1040     \o libfontconfig
1041     \o Font customization and configuration
1042     \o \tt{-fontconfig} or auto-detected
1043     \o 2.1
1044     \row {id="OptionalColor"}
1045     \o FreeType
1046     \o libfreetype
1047     \o Font engine
1048     \o
1049     \o 2.1.3
1050
1051     \row {id="DefaultColor"}
1052     \o Xi
1053     \o libXi
1054     \o X11 Input Extensions
1055     \o \tt{-xinput} or auto-detected
1056     \o 1.3.0
1057     \row {id="DefaultColor"}
1058     \o Xt
1059     \o libXt
1060     \o Xt Intrinsics
1061     \o
1062     \o 0.99
1063     \row {id="DefaultColor"}
1064     \o Xext
1065     \o libXext
1066     \o X Extensions
1067     \o
1068     \o 6.4.3
1069     \row {id="DefaultColor"}
1070     \o X11
1071     \o libX11
1072     \o X11 Client-Side Library
1073     \o
1074     \o 6.2.1
1075
1076     \row {id="SMColor"}
1077     \o SM
1078     \o libSM
1079     \o X Session Management
1080     \o \tt{-sm} or auto-detected
1081     \o 6.0.4
1082     \row {id="SMColor"}
1083     \o ICE
1084     \o libICE
1085     \o Inter-Client Exchange
1086     \o \tt{-sm} or auto-detected
1087     \o 6.3.5
1088
1089     \row {id="GlibColor"}
1090     \o glib
1091     \o libglib-2.0
1092     \o Common event loop handling
1093     \o \tt{-glib} or auto-detected
1094     \o 2.8.3
1095     \row {id="PthreadColor"}
1096     \o pthread
1097     \o libpthread
1098     \o Multithreading
1099     \o
1100     \o 2.3.5
1101     \endtable
1102
1103     \note You must compile with XRender support to get alpha transparency
1104     support for pixmaps and images.
1105
1106     Development packages for these libraries contain header files that are used
1107     when building Qt from its source code. On Debian-based GNU/Linux systems,
1108     for example, we recommend that you install the following development
1109     packages:
1110
1111     \list
1112     \o libfontconfig1-dev
1113     \o libfreetype6-dev
1114     \o libx11-dev
1115     \o libxcursor-dev
1116     \o libxext-dev
1117     \o libxfixes-dev
1118     \o libxft-dev
1119     \o libxi-dev
1120     \o libxrandr-dev
1121     \o libxrender-dev
1122     \endlist
1123
1124     Some of these packages depend on others in this list, so installing one
1125     may cause others to be automatically installed. Other distributions may
1126     provide system packages with similar names.
1127
1128     \section1 OpenGL Dependencies
1129
1130     The configure script will autodetect if OpenGL headers and libraries are
1131     installed on your system, and if so, it will include the QtOpenGL module
1132     in the Qt library.
1133
1134     If your OpenGL headers or libraries are placed in a non-standard directory,
1135     you may need to change the \c QMAKE_INCDIR_OPENGL and/or
1136     \c QMAKE_LIBDIR_OPENGL in the config file for your system.
1137
1138     The QGL documentation assumes that you are familiar with OpenGL
1139     programming. If you're new to the subject a good starting point is
1140     \l{http://www.opengl.org/}.
1141
1142     \section1 Phonon Dependencies
1143
1144     As described in the \l{Phonon Overview}, Phonon uses the GStreamer multimedia
1145     framework as the backend for audio and video playback on X11. The minimum required
1146     version of GStreamer is 0.10.
1147
1148     To build Phonon, you need the GStreamer library, base plugins, and development
1149     files for your system. The package names for GStreamer vary between Linux
1150     distributions; try searching for \c gstreamer or \c libgstreamer in your
1151     distribution's package repository to find suitable packages.
1152
1153     \sa {Known Issues}
1154 */
1155
1156 /*!
1157     \page requirements-wince.html
1158     \title Qt for Windows CE Requirements
1159     \ingroup installation
1160     \brief Setting up the Windows CE environment for Qt.
1161     \previouspage General Qt Requirements
1162
1163     Qt is known to work with Visual Studio 2005/2008/2010 and the following SDKs for
1164     Windows CE development on Windows XP and Windows Vista:
1165
1166     \list
1167         \o  Windows CE 5.0 Standard SDK for ARM, X86, and MIPS
1168         \o  Windows CE 6.0 SDKs for ARM generated using the defaults found in
1169             Platform Builder
1170         \o  Windows Mobile 5.0 (\e{Pocket PC}, \e{Smartphone} and
1171             \e{Pocket PC with Phone} editions)
1172         \o  Windows Mobile 6.0 (\e{Standard}, \e{Classic} and
1173             \e{Professional} editions)
1174     \endlist
1175
1176     Below is a list of links to download the SDKs:
1177
1178     \list
1179         \o \l{http://www.microsoft.com/downloads/details.aspx?familyid=fa1a3d66-3f61-4ddc-9510-ae450e2318c3&amp;displaylang=en}
1180             {Windows CE 5 Standard SDK}
1181         \o  \l{http://www.microsoft.com/downloads/details.aspx?familyid=83A52AF2-F524-4EC5-9155-717CBE5D25ED&amp;displaylang=en}
1182             {Windows Mobile 5 Pocket PC}
1183         \o  \l{http://www.microsoft.com/downloads/details.aspx?familyid=DC6C00CB-738A-4B97-8910-5CD29AB5F8D9&amp;displaylang=en}
1184             {Windows Mobile 5 Smartphone}
1185         \o  \l{http://www.microsoft.com/downloads/details.aspx?familyid=06111A3A-A651-4745-88EF-3D48091A390B&amp;displaylang=en}
1186             {Windows Mobile 6 Professional/Standard}
1187     \endlist
1188
1189     \bold{Note:}
1190     \table
1191         \row
1192             \o
1193             \list 1
1194                 \o Currently, there is only compile support for Windows CE 5.0
1195                    Standard SDK for SH-4.
1196                 \o There is currently no "out of the box" support for the
1197                    Windows CE Automotive or Portable Media SDKs from Microsoft.
1198             \endlist
1199     \endtable
1200
1201     Device manufacturers may prefer to make their own customized version of
1202     Windows CE using Platform Builder. In order for Qt for Windows CE to
1203     support a custom SDK, a build specification needs to be created. More
1204     information on Windows CE Customization can be found
1205     \l{Windows CE - Working with Custom SDKs}{here}.
1206
1207         \section3 Requirements
1208         \list
1209                 \o Development environment:
1210                 \list
1211                         \o Microsoft Visual Studio 2005 (Standard Edition) or higher
1212                         \o ActivePerl
1213                 \endlist
1214                 \o Footprint
1215                 \list
1216                         \o Lean configuration - 4.8 MB
1217                         \o Full configuration - 8.4 MB
1218                 \endlist
1219                 \o Operating Systems
1220                 \list
1221                         \o Windows CE 5 or higher
1222                         \o Windows Mobile 5 or higher
1223                 \endlist
1224                 \o Hardware Platform
1225                 \list
1226                         \o Supported on ARM, x86
1227                         \o (Compiles on SH4 and MIPS)
1228                 \endlist
1229         \endlist
1230
1231                 \sa {Known Issues}
1232 */
1233
1234 /*!
1235     \page requirements-embedded-linux.html
1236     \title Qt for Embedded Linux Requirements
1237     \ingroup installation
1238     \brief Setting up the Embedded Linux environment for Qt.
1239     \previouspage General Qt Requirements
1240
1241     \sa {Known Issues}
1242
1243     \section1 Building Qt for Embedded Linux with uclibc
1244
1245     If you intend to include the QtWebKit module in your Qt build then you should
1246     use version \bold{uClibc 0.9.29 or greater} as that is the earliest version
1247     with sufficient pthread support.
1248
1249     \section1 Memory Requirements
1250
1251     The memory and storage requirements for Qt for Embedded Linux depend on a
1252     an variety of different factors, including the target architecture and the
1253     features enabled in the Qt build.
1254
1255     The following table shows typical library sizes for the most common Qt
1256     libraries on different architectures, built in release mode with different
1257     feature profiles.
1258
1259     \table
1260     \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
1261     \header                                        \o Minimal \o Normal \o Minimal \o Normal \o Minimal \o Normal \o Minimal \o Normal
1262     \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
1263     \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
1264     \row    \o linux-mips-g++ (MIPS32)
1265                              \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
1266     \endtable
1267
1268     Library sizes are given in the following units: K = 1024 bytes; M = 1024K.
1269     QtWebKit is excluded from the minimal configuration.
1270
1271     The \l{Fine-Tuning Features in Qt} document covers the process of configuring
1272     Qt builds to avoid the inclusion of unnecessary features.
1273
1274     \section1 Additional X11 Libraries for QVFb
1275
1276     The Virtual Framebuffer (QVFb) application requires the \c libxtst library
1277     in addition to the libraries used to build Qt for X11. This library
1278     enables the use of the Record extension to the X protocol to be used in
1279     applications.
1280 */
1281
1282 /*!
1283     \page requirements-symbian.html
1284     \title Qt for the Symbian platform Requirements
1285     \ingroup installation
1286     \brief Setting up the Symbian platform environment for Qt.
1287     \previouspage General Qt Requirements
1288
1289     \l {http://qt.nokia.com/downloads}{Qt SDK} provides all the necessary tools
1290     and libraries for developing Qt applications. However, if you want to build
1291     Qt itself for Symbian, follow the instructions below.
1292
1293     Qt for the Symbian platform requires the following software installed on
1294     your development PC:
1295     \list
1296         \o \l{http://www.forum.nokia.com/Library/Tools_and_downloads/Other/Carbide.c++/}{Carbide.c++ v2.3.0 or higher recommended}.
1297            \list
1298            \o \bold{Note:} It may be necessary to update the Carbide compiler depending on Carbide version.
1299               See \l{http://pepper.troll.no/s60prereleases/patches/}{here} for instructions how to check your
1300               compiler version and how to patch it, if needed.
1301            \endlist
1302         \o \l{http://downloads.activestate.com/ActivePerl/releases}{ActivePerl 5.6.1 build 638 or higher}
1303            \list
1304            \o \bold{Note:} According to Symbian, version 5.6.1 build 638 is mandatory for building Symbian applications,
1305               but that version is no longer available from ActiveState. However, Qt for Symbian has been successfully
1306               compiled using both 5.8.x and 5.10.x versions.
1307            \endlist
1308         \o \l{http://www.forum.nokia.com/info/sw.nokia.com/id/ec866fab-4b76-49f6-b5a5-af0631419e9c/S60_All_in_One_SDKs.html}{S60 Platform SDK 3rd Edition FP1 or higher}
1309            \list
1310            \o \bold{Note:} Users of \bold{S60 Platform SDK 3rd Edition FP1} also need special update. The update can be found
1311            \l{http://pepper.troll.no/s60prereleases/patches/}{here}.
1312            \endlist
1313         \o \l{http://www.forum.nokia.com/info/sw.nokia.com/id/91d89929-fb8c-4d66-bea0-227e42df9053/Open_C_SDK_Plug-In.html}{Open C/C++ v1.7.5 or higher}.
1314            Install this to all Symbian SDKs you plan to use Qt with.
1315         \o Building Qt tools from scratch requires \l{http://www.mingw.org/}{MinGW 3.4.5 or higher}, or another windows compiler.
1316            \list
1317            \o \bold{Note:} This is not required if you are using pre-built binary package.
1318            \endlist
1319         \o Building Qt libraries requires \l{http://www.arm.com/products/tools/software-development-tools.php}{RVCT} version 2.2 (build 686 or later),
1320            which is not available free of charge.  Usage of later versions of RVCT, including the 3.x and 4.x series, is not supported
1321            in this release.
1322     \endlist
1323
1324     Running Qt on real device requires the Open C and sqlite3 to be installed on the device.
1325     These installation packages are embedded into \c{qt_installer.sis}, which is included in
1326     Qt for Symbian binary package.
1327
1328     If you are building Qt from scratch, you can find the sqlite3 package from
1329     under your Qt installation:
1330
1331     \list
1332         \o \c{src\s60installs\sqlite3.sis}
1333     \endlist
1334
1335     The Open C packages you can find in the Symbian SDK where you installed Open C/C++:
1336     \list
1337         \o \c{nokia_plugin\openc\s60opencsis\pips_s60_<version>.sis}
1338         \o \c{nokia_plugin\openc\s60opencsis\openc_ssl_s60_<version>.sis}
1339         \o \c{nokia_plugin\opencpp\s60opencppsis\stdcpp_s60_<version>.sis}
1340     \endlist
1341
1342     If you wish to do hardware debugging with Carbide or run applications in real devices using "make run" command,
1343     TRK must be installed to the device. \bold{Note:} TRK is not required if you just want to install and run
1344     applications manually on the device.
1345     \list
1346         \o \l{http://tools.ext.nokia.com/trk/}{Application TRK}. Choose the correct
1347            installation package based on the S60 version of your device (S60_<S60-version>_app_trk_<TRK-version>.sisx).
1348     \endlist
1349
1350
1351     We recommend you to take a look at \l{http://doc.qt.nokia.com/latest/install-symbian.html}{Installing Qt for the Symbian platform}
1352     to get more information about how to setup the development environment.
1353
1354     \sa {Known Issues}
1355 */
1356
1357 /*!
1358     \page configure-options.html
1359     \title Configuration Options for Qt
1360     \ingroup installation
1361     \brief Brief description of available options for building Qt.
1362
1363     This page gives a brief description of the different options available when
1364     building Qt using the \c configure script or \c configure.exe binary.
1365     To build Qt using the default options, just call configure from the command
1366     line as shown below.
1367
1368     When building on Linux, Mac OS X and Unix platforms:
1369
1370     \c{./configure}
1371
1372     On Windows, run the corresponding executable:
1373
1374     \c{.\configure.exe}
1375
1376     If you would like to customize your build, please use the options listed in
1377     the following tables. To see the full list of options, invoke the configure
1378     tool with the \c -help command line option.
1379
1380     \section2 Cross platform options:
1381
1382     \table
1383     \header \o Option  \o Description \o Note
1384     \row   \o \c {-buildkey} <key> \o Build the Qt library and plugins
1385     using the specified \o
1386     \row   \o \c {<key>} \o When the library loads plugins, it will only
1387     load those that have a matching <key>. \o
1388     \row   \o \c {-release} \o Compile and link Qt with debugging turned off. \o
1389     \row   \o \c {-debug} \o Compile and link Qt with debugging turned on.
1390     \o Default value.
1391     \row   \o \c {-debug-and-release} \o Compile and link two Qt libraries,
1392     with and without debugging turned on. \o This option denotes a default
1393     value and needs to be evaluated. If the evaluation succeeds, the
1394     feature is included.
1395     \row   \o \c {-opensource} \o Compile and link the Open-Source Edition
1396     of Qt. \o
1397     \row   \o \c {-commercial} \o Compile and link the Commercial Edition
1398     of Qt. \o
1399     \row   \o \c {-developer-build} \o Compile and link Qt with Qt developer
1400     options including auto-tests exporting) \o
1401     \row   \o \c {-shared} \o Create and use shared Qt libraries. \o Default
1402     value.
1403     \row   \o \c {-static} \o Create and use static Qt libraries. \o
1404     \row   \o \c {-ltcg} \o Use Link Time Code Generation. \o Apply to release
1405     builds only.
1406     \row   \o \c {-no-ltcg} \o Do not use Link Time Code Generation. \o Default
1407     value.
1408     \row   \o \c {-no-fast} \o Configure Qt normally by generating Makefiles for
1409     all project files. \o Default value.
1410     \row   \o \c {-fast} \o Configure Qt quickly by generating Makefiles only for
1411     library and subdirectory targets. \o All other Makefiles are created as
1412     wrappers which will in turn run qmake.
1413     \row   \o \c {-no-exceptions} \o Disable exceptions on platforms that support
1414     it. \o
1415     \row   \o \c {-exceptions} \o Enable exceptions on platforms that support it.
1416     \o Default value.
1417     \row   \o \c {-no-accessibility} \o Do not compile Windows Active
1418     Accessibility support. \o
1419     \row   \o \c {-accessibility} \o Compile Windows Active Accessibility
1420     support. \o Default value.
1421     \row   \o \c {-no-stl} \o Do not compile STL support. \o
1422     \row   \o \c {-stl} \o Compile STL support. \o Default value.
1423     \row   \o \c {-no-sql-<driver>} \o Disable SQL <driver> entirely, by default
1424     none are turned on. \o
1425     \row   \o \c {-qt-sql-<driver>} \o Enable a SQL <driver> in the Qt Library.
1426     \o
1427     \row   \o \c {-plugin-sql-<driver>} \o Enable SQL <driver> as a plugin to be
1428     linked to at run time. \o Available values for <driver>: mysql, psql,
1429     oci, odbc, tds, db2, sqlite, sqlite2, ibase. Drivers marked with a
1430     '+' during configure have been detected as available on this system.
1431     \row   \o \c {-system-sqlite} \o Use sqlite from the operating system. \o
1432     \row   \o \c {-no-qt3support} \o Disables the Qt 3 support functionality. \o
1433     \row   \o \c {-no-opengl} \o Disables OpenGL functionality \o
1434     \row   \o \c {-opengl <api>} \o Enable OpenGL support with specified API
1435     version. \o Available values for <api>: desktop - Enable support for
1436     Desktop OpenGL (Default), es1 - Enable support for OpenGL ES Common
1437     Profile, es2 - Enable support for OpenGL ES 2.0.
1438     \row   \o \c {-no-openvg} \o Disables OpenVG functionality \o Default value.
1439     \row   \o \c {-openvg} \o Enables OpenVG functionality \o Requires EGL
1440     support, typically supplied by an OpenGL or other graphics
1441     implementation.
1442     \row   \o \c {-platform <spec>} \o The operating system and compiler you
1443     are building on. \o The default value is %QMAKESPEC%.
1444     \row   \o \c {-xplatform <spec>} \o The operating system and compiler you
1445     are cross compiling for. \o See the README file for a list of supported
1446     operating systems and compilers.
1447     \row   \o \c {-system-proxies} \o Use system network proxies by default. \o
1448     \row   \o \c {-no-system-proxies} \o Do not use system network proxies
1449     by default. \o
1450     \row   \o \c {-qtnamespace <namespace>} \o Wraps all Qt library code in
1451     'namespace name {..} \o
1452     \row   \o \c {-qtlibinfix <infix>} \o Renames all Qt* libs to Qt*<infix>
1453     \o
1454     \row   \o \c {-D <define>} \o Add an explicit define to the preprocessor.
1455     \o
1456     \row   \o \c {-I <includepath>} \o Add an explicit include path. \o
1457     \row   \o \c {-L <librarypath>} \o Add an explicit library path. \o
1458     \row   \o \c {-l <libraryname>} \o Add an explicit library name, residing
1459     in a librarypath. \o
1460     \row   \o \c {-graphicssystem <sys>} \o Specify which graphics system should
1461     be used. \o Available values for <sys>: * raster - Software rasterizer,
1462     opengl - Using OpenGL acceleration, experimental!, openvg - Using
1463     OpenVG acceleration, experimental!
1464     \row   \o \c {-help, -h, -?} \o Display this information. \o
1465     \endtable
1466
1467     \section2 Third Party Libraries
1468
1469     \table
1470     \header \o Option  \o Description \o Note
1471     \row   \o \c {-qt-zlib} \o Use the zlib bundled with Qt. \o
1472     \row   \o \c {-system-zlib} \o Use zlib from the operating system.
1473     \o See http://www.gzip.org/zlib
1474     \row   \o \c {-no-gif} \o Do not compile GIF reading support.
1475     \o This option denotes a default value and needs to be evaluated.
1476     If the evaluation succeeds, the feature is included.
1477     \row   \o \c {-no-libpng} \o Do not compile PNG support. \o
1478     \row   \o \c {-qt-libpng} \o Use the libpng bundled with Qt.
1479     \o This option denotes a default value and needs to be evaluated.
1480     If the evaluation succeeds, the feature is included.
1481     \row   \o \c {-system-libpng} \o Use libpng from the operating system.
1482     \o See http://www.libpng.org/pub/png
1483     \row   \o \c {-no-libmng} \o Do not compile MNG support. \o This option
1484     denotes a default value and needs to be evaluated. If the evaluation
1485     succeeds, the feature is included.
1486     \row   \o \c {-qt-libmng} \o Use the libmng bundled with Qt. \o
1487     \row   \o \c {-system-libmng} \o Use libmng from the operating system.
1488     \o See http://www.libmng.com
1489     \row   \o \c {-no-libtiff} \o Do not compile TIFF support. \o This option
1490     denotes a default value and needs to be evaluated. If the evaluation
1491     succeeds, the feature is included.
1492     \row   \o \c {-qt-libtiff} \o Use the libtiff bundled with Qt. \o
1493     \row   \o \c {-system-libtiff} \o Use libtiff from the operating system.
1494     \o See http://www.libtiff.org
1495     \row   \o \c {-no-libjpeg} \o Do not compile JPEG support. \o This option
1496     denotes a default value and needs to be evaluated. If the evaluation
1497     succeeds, the feature is included.
1498     \row   \o \c {-qt-libjpeg} \o Use the libjpeg bundled with Qt. \o
1499     \row   \o \c {-system-libjpeg} \o Use libjpeg from the operating system.
1500     \o See http://www.ijg.org. This option denotes a default value and
1501     needs to be evaluated. If the evaluation succeeds, the feature is
1502     included.
1503     \endtable
1504
1505     \section2 Qt for Windows only:
1506     \table
1507     \header \o Option  \o Description \o Note
1508     \row   \o \c {-no-dsp} \o Do not generate VC++ .dsp files. \o
1509     \row   \o \c {-dsp} \o Generate VC++ .dsp files, only if spec "win32-msvc".
1510     \o Default value.
1511     \row   \o \c {-no-vcproj} \o Do not generate VC++ .vcproj files. \o
1512     \row   \o \c {-vcproj} \o Generate VC++ .vcproj files, only if platform
1513     "win32-msvc.net". \o Default value.
1514     \row   \o \c {-no-incredibuild-xge} \o Do not add IncrediBuild XGE distribution
1515     commands to custom build steps. \o
1516     \row   \o \c {-incredibuild-xge} \o Add IncrediBuild XGE distribution commands
1517     to custom build steps. This will distribute MOC and UIC steps, and other
1518     custom buildsteps which are added to the INCREDIBUILD_XGE variable.
1519     \o The IncrediBuild distribution commands are only added to Visual Studio
1520     projects. This option denotes a default value and needs to be evaluated.
1521     If the evaluation succeeds, the feature is included.
1522     \row   \o \c {-no-plugin-manifests} \o Do not embed manifests in plugins. \o
1523     \row   \o \c {-plugin-manifests} \o Embed manifests in plugins.
1524     \o Default value.
1525     \row   \o \c {-no-qmake} \o Do not compile qmake. \o
1526     \row   \o \c {-qmake} \o Compile qmake. \o Default value
1527     \row   \o \c {-dont-process} \o Do not generate Makefiles/Project files. This
1528     will override -no-fast if specified. \o
1529     \row   \o \c {-process} \o Generate Makefiles/Project files. \o Default value.
1530     \row   \o \c {-no-rtti} \o Do not compile runtime type information. \o
1531     \row   \o \c {-rtti} \o Compile runtime type information. \o Default value.
1532     \row   \o \c {-no-mmx} \o Do not compile with use of MMX instructions \o
1533     \row   \o \c {-mmx} \o Compile with use of MMX instructions \o This option
1534     denotes a default value and needs to be evaluated. If the evaluation
1535     succeeds, the feature is included.
1536     \row   \o \c {-no-3dnow} \o Do not compile with use of 3DNOW instructions \o
1537     \row   \o \c {-3dnow} \o Compile with use of 3DNOW instructions \o This
1538     option denotes a default value and needs to be evaluated. If the
1539     evaluation succeeds, the feature is included.
1540     \row   \o \c {-no-sse} \o Do not compile with use of SSE instructions \o
1541     \row   \o \c {-sse} \o Compile with use of SSE instructions \o This option
1542     denotes a default value and needs to be evaluated. If the evaluation
1543     succeeds, the feature is included.
1544     \row   \o \c {-no-sse2} \o Do not compile with use of SSE2 instructions \o
1545     \row   \o \c {-sse2} \o Compile with use of SSE2 instructions \o This option
1546     denotes a default value and needs to be evaluated. If the evaluation
1547     succeeds, the feature is included.
1548     \row   \o \c {-no-openssl} \o Do not compile in OpenSSL support \o
1549     \row   \o \c {-openssl} \o Compile in run-time OpenSSL support \o This option
1550     denotes a default value and needs to be evaluated. If the evaluation
1551     succeeds, the feature is included.
1552     \row   \o \c {-openssl-linked} \o Compile in linked OpenSSL support \o
1553     \row   \o \c {-no-dbus} \o Do not compile in D-Bus support \o
1554     \row   \o \c {-dbus} \o Compile in D-Bus support and load libdbus-1 dynamically.
1555     \o This option denotes a default value and needs to be evaluated.
1556     If the evaluation succeeds, the feature is included.
1557     \row   \o \c {-dbus-linked} \o Compile in D-Bus support and link to
1558     libdbus-1 \o
1559     \row   \o \c {-no-phonon} \o Do not compile in the Phonon module \o
1560     \row   \o \c {-phonon} \o Compile the Phonon module. \o Phonon is built if a
1561     decent C++ compiler is used. This option denotes a default value and needs
1562     to be evaluated. If the evaluation succeeds, the feature is included.
1563     \row   \o \c {-no-phonon-backend} \o Do not compile the platform-specific
1564     Phonon backend-plugin \o
1565     \row   \o \c {-phonon-backend} \o Compile in the platform-specific Phonon
1566     backend-plugin \o Default value.
1567     \row   \o \c {-no-multimedia} \o Do not compile the multimedia module \o
1568     \row   \o \c {-multimedia} \o Compile in multimedia module \o Default value.
1569     \row   \o \c {-no-audio-backend} \o Do not compile in the platform audio
1570     backend into QtMultimedia \o
1571     \row   \o \c {-audio-backend} \o Compile in the platform audio backend into
1572     QtMultimedia \o This option denotes a default value and needs to be
1573     evaluated. If the evaluation succeeds, the feature is included.
1574     \row   \o \c {-no-webkit} \o Do not compile in the WebKit module \o
1575     \row   \o \c {-webkit} \o Compile in the WebKit module \o WebKit is built
1576     if a decent C++ compiler is used. This option denotes a default value
1577     and needs to be evaluated. If the evaluation succeeds, the feature is
1578     included.
1579     \row   \o \c {-webkit-debug} \o Compile in the WebKit module with debug
1580     symbols. \o
1581     \row   \o \c {-no-script} \o Do not build the QtScript module. \o
1582     \row   \o \c {-script} \o Build the QtScript module. \o This option
1583     denotes a default value and needs to be evaluated. If the evaluation
1584     succeeds, the feature is included.
1585     \row   \o \c {-no-scripttools} \o Do not build the QtScriptTools module. \o
1586     \row   \o \c {-scripttools} \o Build the QtScriptTools module. \o This
1587     option denotes a default value and needs to be evaluated. If the
1588     evaluation succeeds, the feature is included.
1589     \row   \o \c {-no-declarative} \o Do not build the declarative module \o
1590     \row   \o \c {-declarative} \o Build the declarative module \o This option
1591     denotes a default value and needs to be evaluated. If the evaluation
1592     succeeds, the feature is included.
1593     \row   \o \c {-no-declarative-debug} \o Do not build the declarative debugging
1594     support \o
1595     \row   \o \c {-declarative-debug} \o Build the declarative debugging support
1596     \o Default value.
1597     \row   \o \c {-arch <arch>} \o Specify an architecture. \o Available values for
1598     <arch>:  * windows, windowsce, symbian, boundschecker, generic.
1599     \row   \o \c {-no-style-<style>} \o Disable <style> entirely. \o
1600     \row   \o \c {-qt-style-<style>} \o Enable <style> in the Qt Library.
1601     \o Available styles: * windows, + windowsxp, + windowsvista,
1602     * plastique, * cleanlooks, * motif, * cde, windowsce, windowsmobile,
1603     s60
1604     \row   \o \c {-no-native-gestures} \o Do not use native gestures on Windows 7.
1605     \o
1606     \row   \o \c {-native-gestures} \o Use native gestures on Windows 7.
1607     \o Default value.
1608     \row   \o \c {-no-mp} \o Do not use multiple processors for compiling with MSVC
1609     \o Default value.
1610     \row   \o \c {-mp} \o Use multiple processors for compiling with MSVC (-MP) \o
1611     \row   \o \c {-loadconfig <config>} \o Run configure with the parameters from file
1612     configure_<config>.cache. \o
1613     \row   \o \c {-saveconfig <config>} \o Run configure and save the parameters in
1614     file configure_<config>.cache. \o
1615     \row   \o \c {-redo} \o Run configure with the same parameters as last time. \o
1616     \endtable
1617
1618     \section2 Qt for Windows CE only:
1619     \table
1620     \header \o Option  \o Description \o Note
1621     \row   \o \c {-no-iwmmxt} \o Do not compile with use of IWMMXT instructions \o
1622     \row   \o \c {-iwmmxt} \o Do compile with use of IWMMXT instructions. \o This is
1623     for Qt for Windows CE on Arm only. This option denotes a default value and
1624     needs to be evaluated. If the evaluation succeeds, the feature is included.
1625     \row   \o \c {-no-crt} \o Do not add the C runtime to default deployment rules.
1626     \o Default value.
1627     \row   \o \c {-qt-crt} \o Qt identifies C runtime during project generation \o
1628     \row   \o \c {-crt <path>} \o Specify path to C runtime used for project
1629     generation. \o
1630     \row   \o \c {-no-cetest} \o Do not compile Windows CE remote test application \o
1631     \row   \o \c {-cetest} \o Compile Windows CE remote test application \o This
1632     option denotes a default value and needs to be evaluated. If the evaluation
1633     succeeds, the feature is included.
1634     \row   \o \c {-signature <file>} \o Use file for signing the target project \o
1635     \row   \o \c {-phonon-wince-ds9} \o Enable Phonon Direct Show 9 backend for
1636     Windows CE \o Default value
1637     \endtable
1638
1639     \section2 Qt for Symbian OS only:
1640     \table
1641     \header \o Option  \o Description \o Note
1642     \row   \o \c {-no-freetype} \o Do not compile in Freetype2 support.
1643     \o Default value.
1644     \row   \o \c {-qt-freetype} \o Use the libfreetype bundled with Qt. \o
1645     \row   \o \c {-fpu <flags>} \o VFP type on ARM, supported options:
1646     softvfp(default) |vfpv2 | softvfp+vfpv2 \o
1647     \row   \o \c {-no-s60} \o Do not compile in S60 support. \o
1648     \row   \o \c {-s60} \o Compile with support for the S60 UI Framework
1649     \o Default value.
1650     \row   \o \c {-no-usedeffiles} \o Disable the usage of DEF files. \o
1651     \row   \o \c {-usedeffiles} \o Enable the usage of DEF files. \o
1652     \endtable
1653 */