doc/src/platforms/emb-install.qdoc
changeset 0 1918ee327afb
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the documentation of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 /*!
       
    43     \page qt-embedded-install.html
       
    44 
       
    45     \title Installing Qt on Embedded Linux
       
    46     \ingroup qt-embedded-linux
       
    47     \ingroup installation
       
    48     \brief How to install Qt on Embedded Linux.
       
    49 
       
    50     This document describes how to install \l{Qt for Embedded Linux} in your
       
    51     development environment:
       
    52 
       
    53     \tableofcontents
       
    54 
       
    55     Please see the \l{Cross-Compiling Qt for Embedded Linux Applications}{cross
       
    56     compiling} and \l{Deploying Qt for Embedded Linux Applications}{deployment}
       
    57     documentation for details on how to install \l{Qt for Embedded Linux} on
       
    58     your target device.
       
    59 
       
    60     Note also that this installation procedure is written for Linux,
       
    61     and that it may need to be modified for other platforms.
       
    62 
       
    63     \section1 Step 1: Installing the License File (commercial editions only)
       
    64 
       
    65     If you have the commercial edition of \l{Qt for Embedded Linux}, the first step
       
    66     is to install your license file as \c $HOME/.qt-license.
       
    67 
       
    68     For the open source version you do not need a license file.
       
    69 
       
    70     \section1 Step 2: Unpacking the Archive
       
    71 
       
    72     First uncompress the archive in the preferred location, then
       
    73     unpack it:
       
    74 
       
    75     \snippet doc/src/snippets/code/doc_src_emb-install.qdoc 0
       
    76 
       
    77     This document assumes that the archive is unpacked in the
       
    78     following directory:
       
    79 
       
    80     \snippet doc/src/snippets/code/doc_src_emb-install.qdoc 1
       
    81 
       
    82     \section1 Step 3: Building the Library
       
    83 
       
    84     Before building the \l{Qt for Embedded Linux} library, run the \c
       
    85     ./configure script to configure the library for your development
       
    86     architecture. You can list all of the configuration system's
       
    87     options by typing \c {./configure -help}.
       
    88 
       
    89     Note that by default, \l{Qt for Embedded Linux} is configured for
       
    90     installation in the \c{/usr/local/Trolltech/QtEmbedded-%VERSION%}
       
    91     directory, but this can be changed by using the \c{-prefix}
       
    92     option. Alternatively, the \c{-prefix-install} option can be used
       
    93     to specify a "local" installation within the source directory.
       
    94 
       
    95     The configuration system is also designed to allow you to specify
       
    96     your platform architecture:
       
    97 
       
    98     \snippet doc/src/snippets/code/doc_src_emb-install.qdoc 2
       
    99 
       
   100     In general, all Linux systems which have framebuffer support can
       
   101     use the \c generic architecture. Other typical architectures are
       
   102     \c x86, \c arm and \c mips.
       
   103 
       
   104     \note If you want to build Qt for Embedded Linux for use with a virtual
       
   105     framebuffer, pass the \c{-qvfb} option to the \c configure
       
   106     script.
       
   107 
       
   108     To create the library and compile all the demos, examples, tools,
       
   109     and tutorials, type:
       
   110 
       
   111     \snippet doc/src/snippets/code/doc_src_emb-install.qdoc 3
       
   112 
       
   113     On some systems the \c make utility is named differently, e.g. \c
       
   114     gmake. The \c configure script tells you which \c make utility to
       
   115     use.
       
   116 
       
   117     If you did not configure \l{Qt for Embedded Linux} using the \c{-prefix-install}
       
   118     option, you need to install the library, demos, examples, tools,
       
   119     and tutorials in the appropriate place. To do this, type:
       
   120 
       
   121     \snippet doc/src/snippets/code/doc_src_emb-install.qdoc 4
       
   122 
       
   123     and enter the root password.
       
   124 
       
   125     \note You can use the \c INSTALL_ROOT environment variable to specify
       
   126     the location of the installed files when invoking \c{make install}.
       
   127 
       
   128     \section1 Step 4: Adjusting the Environment Variables
       
   129 
       
   130     In order to use \l{Qt for Embedded Linux}, the \c PATH variable must be extended
       
   131     to locate \c qmake, \c moc and other \l{Qt for Embedded Linux} tools, and the \c
       
   132     LD_LIBRARY_PATH must be extended for compilers that do not support
       
   133     \c rpath.
       
   134 
       
   135     To set the \c PATH variable, add the following lines to your \c
       
   136     .profile file if your shell is bash, ksh, zsh or sh:
       
   137 
       
   138     \snippet doc/src/snippets/code/doc_src_emb-install.qdoc 5
       
   139 
       
   140     In case your shell is csh or tcsh, add the following line to the
       
   141     \c .login file instead:
       
   142 
       
   143     \snippet doc/src/snippets/code/doc_src_emb-install.qdoc 6
       
   144 
       
   145     If you use a different shell, please modify your environment
       
   146     variables accordingly.
       
   147 
       
   148     For compilers that do not support \c rpath you must also extend
       
   149     the \c LD_LIBRARY_PATH environment variable to include
       
   150     \c /usr/local/Trolltech/QtEmbedded-%VERSION%/lib. Note that on Linux
       
   151     with GCC, this step is not needed.
       
   152 
       
   153     \section1 Step 5: Building the Virtual Framebuffer
       
   154 
       
   155     For development and debugging, \l{Qt for Embedded Linux} provides a virtual
       
   156     framebuffer as well as the option of running \l{Qt for Embedded Linux} as a VNC
       
   157     server. For a description of how to install the virtual
       
   158     framebuffer and how to use the VNC protocol, please consult the
       
   159     documentation at:
       
   160 
       
   161     \list
       
   162        \o \l {The Virtual Framebuffer}
       
   163        \o \l {The VNC Protocol and Qt for Embedded Linux}
       
   164     \endlist
       
   165 
       
   166     Note that the virtual framebuffer requires a Qt for X11
       
   167     installation. See \l {Installing Qt on X11 Platforms} for details.
       
   168 
       
   169     The Linux framebuffer, on the other hand, is enabled by default on
       
   170     all modern Linux distributions. For information on older versions,
       
   171     see \l http://en.tldp.org/HOWTO/Framebuffer-HOWTO.html. To test
       
   172     that the Linux framebuffer is set up correctly, use the program
       
   173     provided by the \l {Testing the Linux Framebuffer} document.
       
   174 
       
   175     That's all. \l{Qt for Embedded Linux} is now installed.
       
   176 
       
   177     \table 100%
       
   178     \row
       
   179     \o
       
   180     \bold {Customizing the Qt for Embedded Linux Library}
       
   181 
       
   182     When building embedded applications on low-powered devices,
       
   183     reducing the memory and CPU requirements is important.
       
   184 
       
   185     A number of options tuning the library's performance are
       
   186     available. But the most direct way of saving resources is to
       
   187     fine-tune the set of Qt features that is compiled. It is also
       
   188     possible to make use of accelerated graphics hardware.
       
   189 
       
   190     \list
       
   191         \o \l {Fine-Tuning Features in Qt}
       
   192         \o \l {Qt Performance Tuning}
       
   193         \o \l {Adding an Accelerated Graphics Driver to Qt for Embedded Linux}
       
   194     \endlist
       
   195 
       
   196     \endtable
       
   197 */