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

Last change on this file since 569 was 561, checked in by Dmitry A. Kuminov, 15 years ago

trunk: Merged in qt 4.6.1 sources.

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