source: trunk/doc/src/getting-started/installation.qdoc@ 973

Last change on this file since 973 was 865, checked in by Dmitry A. Kuminov, 14 years ago

trunk: Merged in qt 4.7.3 sources from branches/vendor/nokia/qt.

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