Update copyright headers
[qt:qt.git] / doc / src / platforms / qt-embedded-linux.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     \group qws
30     \title Qt for Embedded Linux Classes
31     \ingroup groups
32     \ingroup qt-embedded-linux
33     \ingroup platform-specific
34
35     \brief Classes that are specific to Qt for Embedded Linux.
36
37     These classes are relevant to \l{Qt for Embedded Linux} users.
38 */
39
40
41 /*!
42     \group qt-embedded-linux
43     \ingroup qt-embedded
44     \title Qt for Embedded Linux
45     \brief Documents specifically about Qt for Embedded Linux.
46
47     Qt for Embedded Linux is a C++ framework for GUI and application development
48     for embedded devices. It runs on a variety of processors, usually
49     with Embedded Linux.  Qt for Embedded Linux provides the standard Qt API for
50     embedded devices with a lightweight window system.
51
52     \image qt-embedded-linux-architecture.png
53
54     Qt for Embedded Linux applications write directly to the framebuffer,
55     eliminating the need for the X Window System and saving memory.
56     The Linux framebuffer is enabled by default on all modern Linux
57     distributions. For information on older versions, please refer to
58     the \l{Framebuffer HOWTO} document. For development
59     and debugging purposes, Qt for Embedded Linux provides a \l {The
60     Virtual Framebuffer}{virtual framebuffer}. It is also possible to
61     run an application using the
62     \l{The VNC Protocol and Qt for Embedded Linux}{VNC protocol}.
63
64     \table 100%
65     \header \o Getting Started \o Reference \o Features
66     \row
67     \o
68      \list
69         \o \l {Qt for Embedded Linux Architecture}{Architecture Overview}
70         \o \l {Installing Qt for Embedded Linux}{Installation}
71         \o \l {Running Qt for Embedded Linux Applications}{Running Applications}
72         \o \l {Qt for Embedded Linux Examples}{Examples}
73     \endlist
74     \o
75     \list
76         \o \l {Qt for Embedded Linux Classes}{Classes}
77         \o \l {Qt for Embedded Linux Environment Variables}{Environment Variables}
78         \o \l {Licenses for Fonts Used in Qt for Embedded Linux}{Font Licenses}
79     \endlist
80     \o
81     \list
82         \o \l {Qt for Embedded Linux Pointer Handling}{Pointer Handling}
83         \o \l {Qt for Embedded Linux Character Input}{Character Input}
84         \o \l {Qt for Embedded Linux Display Management}{Display Management}
85         \o \l {Qt for Embedded Linux Hardware Accelerated Graphics}{Hardware Accelerated Graphics}
86         \o \l {Qt for Embedded Linux Fonts}{Fonts}
87     \endlist
88
89     \header \o Development \o Porting \o Optimization
90     \row
91     \o
92      \list
93         \o \l {The Virtual Framebuffer}{Virtual Framebuffer}
94         \o \l {The VNC Protocol and Qt for Embedded Linux}{VNC Protocol}
95         \o \l {Testing the Linux Framebuffer}
96         \o \l {Cross Compiling Qt for Embedded Linux Applications}{Cross Compiling Applications}
97         \o \l {Deploying Qt for Embedded Linux Applications}{Deploying Applications}
98     \endlist
99     \o
100     \list
101         \o \l {Porting Qt Applications to Qt for Embedded Linux}
102         \o \l {Porting Qt for Embedded Linux to a New Architecture}
103         \o \l {Porting Qt for Embedded Linux to Another Operating System}
104     \endlist
105     \o
106     \list
107         \o \l {Qt Performance Tuning}
108         \o \l {Fine-Tuning Features in Qt}
109         \o \l {Adding an Accelerated Graphics Driver to Qt for Embedded Linux}{Adding an Accelerated Graphics Driver}
110     \endlist
111     \endtable
112 */