doc/src/emb-deployment.qdoc

   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-deployment.html
  44
  45     \title Deploying Qt for Embedded Linux Applications
  46     \ingroup qt-embedded-linux
  47
  48     The procedure of deploying an Qt application on \l{Qt for Embedded Linux}
  49     is essentially the same as the deployment procedure on X11 platforms
  50     which is described in detail in the \l {Deploying an Application
  51     on X11 Platforms} documentation. See also the \l {Deploying Qt
  52     applications}{general remarks} about deploying Qt applications.
  53
  54     In addition, there is a couple of Qt for Embedded Linux specific issues to
  55     keep in mind:
  56
  57     \tableofcontents
  58
  59     \section1 Fonts
  60
  61     When Qt for Embedded Linux applications run, they look for a file called
  62     \c fontdir in Qt's \c /lib/fonts/ directory defining the
  63     fonts that are available to the application (i.e. the fonts
  64     located in the mentioned directory).
  65
  66     For that reason, the preferred fonts must be copied to the \c
  67     /lib/fonts/ directory, and the \c fontdir file must be customized
  68     accordingly.  See the \l {Qt for Embedded Linux Fonts}{fonts} documentation
  69     for more details about the supported font formats.
  70
  71     Note that the application will look for the \c /lib/fonts/
  72     directory relative to the path set using the \c -prefix parameter
  73     when running the \c configure script; ensure that this is a
  74     sensible path in the target device environment. See the \l
  75     {Installing Qt for Embedded Linux#Step 3: Building the
  76     Library}{installation} documentation for more details.
  77
  78     \section1 Environment Variables
  79
  80     In general, any variable value that differs from the provided
  81     default values must be set explicitly in the target device
  82     environment.  Typically, these include the QWS_MOUSE_PROTO,
  83     QWS_KEYBOARD and QWS_DISPLAY variables specifying the drivers for
  84     pointer handling, character input and display management,
  85     respectively.
  86
  87     For example, without the proper mouse and keyboard drivers, there
  88     is no way to give any input to the application when it is
  89     installed on the target device. By running the \c configure script
  90     using the \c -qt-kbd-<keyboarddriver> and \c
  91     -qt-mouse-<mousedriver> options, the drivers are enabled, but in
  92     addition the drivers and the preferred devices must be specified
  93     as the ones to use in the target environment, by setting the
  94     environment variables.
  95
  96     See the \l{Qt for Embedded Linux Pointer Handling}{pointer handling},
  97     \l{Qt for Embedded Linux Character Input}{character input} and
  98     \l{Qt for Embedded Linux Display Management}{display management}
  99     documentation for more information.
 100
 101     \section1 Framebuffer Support
 102
 103     No particular actions are required to enable the framebuffer on
 104     target devices: The Linux framebuffer is enabled by default on all
 105     modern Linux distributions. For information on older versions, see
 106     \l http://en.tldp.org/HOWTO/Framebuffer-HOWTO.html.
 107
 108     To test that the Linux framebuffer is set up correctly, and that
 109     the device permissions are correct, use the program provided by
 110     the \l {Testing the Linux Framebuffer} document.
 111 */