summaryrefslogtreecommitdiffstats
path: root/doc/index.qdoc
blob: c8ce70b05eafab44f30183efdd3d7c9e0848626c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/****************************************************************************
**
** Copyright (C) 2019 Luxoft Sweden AB
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Luxoft Application Manager.
**
** $QT_BEGIN_LICENSE:FDL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite licenses may use
** this file in accordance with the commercial license agreement provided
** with the Software or, alternatively, in accordance with the terms
** contained in a written agreement between you and The Qt Company.  For
** licensing terms and conditions see https://www.qt.io/terms-conditions.
** For further information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!

\page qtapplicationmanager-index.html
\keyword Qt Application Manager Reference Documentation
\indexpage
\title Qt Application Manager

\section1 Overview

The application-manager binary (\c appman) is a headless daemon by itself. A suitable QML file
needs to be supplied on the command-line or via a config file at startup, which will act as a
compositing window manager using the APIs that are exported from the C++ side.

Please read the \l{The Qt Application Manager}{Introduction to the Qt Application Manager} for a
high-level overview of the package.

\section1 Important topics
\list
    \li \l{Installation}
    \li \l{Configuration}
    \li \l{Troubleshooting}
    \omit
    \li \l{How to write a System-UI}
    \endomit
    \li \l{Writing Applications}
    \li \l{The Application Installer}
    \li \l{Logging and Debugging}
    \li \l{Containers}
    \li \l{Single- vs. Multi-Process Mode}
    \li \l{Migrating code from 5.11 to 5.12}
\endlist

\section1 Tools
\annotatedlist qtappman-tools

\section1 Reference
\list
    \li \l{Manifest Definition}{Applications Manifest Definition (info.yaml)}
    \li \l{QtApplicationManager QML module}
    \li \l{QtApplicationManager.SystemUI QML module}
    \li \l{QtApplicationManager.Application QML module}
\endlist

\section1 Examples
\annotatedlist applicationmanager-examples

\section1 Licenses and Attributions

Qt ApplicationManager is available under commercial Qt Automotive Suite licenses.
In addition, it is available under the \l{GNU Lesser General Public License, version 3}, or
See \l{Qt Licensing} for further details.

Executables on Windows potentially link against \l{The qtmain Library}. This library is available
under commercial licenses, and in addition under the \l{BSD 3-clause "New" or "Revised" License}.

Furthermore Qt ApplicationManager potentially contains third party modules under following
permissive licenses:

\generatelist{groupsbymodule attributions-applicationmanager}

*/