Update copyright headers
[qt:qt.git] / doc / src / platforms / emb-deployment.qdoc
1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the documentation of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:FDL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Free Documentation License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Free
19 ** Documentation License version 1.3 as published by the Free Software
20 ** Foundation and appearing in the file included in the packaging of
21 ** this file.  Please review the following information to ensure
22 ** the GNU Free Documentation License version 1.3 requirements
23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
24 ** $QT_END_LICENSE$
25 **
26 ****************************************************************************/
27
28 /*!
29     \page qt-embedded-deployment.html
30
31     \title Deploying Qt for Embedded Linux Applications
32     \ingroup qt-embedded-linux
33
34     The procedure of deploying an Qt application on \l{Qt for Embedded Linux}
35     is essentially the same as the deployment procedure on X11 platforms
36     which is described in detail in the \l {Deploying an Application
37     on X11 Platforms} documentation. See also the \l {Deploying Qt
38     applications}{general remarks} about deploying Qt applications.
39
40     In addition, there is a couple of Qt for Embedded Linux specific issues to
41     keep in mind:
42
43     \tableofcontents
44
45     \section1 Fonts
46
47     When Qt for Embedded Linux applications run, they look for a file called
48     \c fontdir in Qt's \c /lib/fonts/ directory defining the
49     fonts that are available to the application (i.e. the fonts
50     located in the mentioned directory).
51
52     For that reason, the preferred fonts must be copied to the \c
53     /lib/fonts/ directory, and the \c fontdir file must be customized
54     accordingly.  See the \l {Qt for Embedded Linux Fonts}{fonts} documentation
55     for more details about the supported font formats.
56
57     Note that the application will look for the \c /lib/fonts/
58     directory relative to the path set using the \c -prefix parameter
59     when running the \c configure script; ensure that this is a
60     sensible path in the target device environment. See the 
61     \l {Installing Qt for Embedded Linux#Step 3: Building the
62     Library}{installation} documentation for more details.
63
64     \section1 Environment Variables
65
66     In general, any variable value that differs from the provided
67     default values must be set explicitly in the target device
68     environment.  Typically, these include the QWS_MOUSE_PROTO,
69     QWS_KEYBOARD and QWS_DISPLAY variables specifying the drivers for
70     pointer handling, character input and display management,
71     respectively.
72
73     For example, without the proper mouse and keyboard drivers, there
74     is no way to give any input to the application when it is
75     installed on the target device. By running the \c configure script
76     using the \c -qt-kbd-<keyboarddriver> and \c
77     -qt-mouse-<mousedriver> options, the drivers are enabled, but in
78     addition the drivers and the preferred devices must be specified
79     as the ones to use in the target environment, by setting the
80     environment variables.
81
82     See the \l{Qt for Embedded Linux Pointer Handling}{pointer handling},
83     \l{Qt for Embedded Linux Character Input}{character input} and
84     \l{Qt for Embedded Linux Display Management}{display management}
85     documentation for more information.
86
87     \section1 Framebuffer Support
88
89     No particular actions are required to enable the framebuffer on
90     target devices: The Linux framebuffer is enabled by default on all
91     modern Linux distributions. For information on older versions, see
92     \l http://en.tldp.org/HOWTO/Framebuffer-HOWTO.html.
93
94     To test that the Linux framebuffer is set up correctly, and that
95     the device permissions are correct, use the program provided by
96     the \l {Testing the Linux Framebuffer} document.
97 */