blob: 05482dcacb1f39f2a918205987375176f43821ac (
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
/****************************************************************************
**
** 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 appman-controller.html
\title Controller
\brief A command-line utility for triggering the installation of a specified
package on the target device.
\ingroup qtappman-tools
The \c{appman-controller} is a command-line utility that can be used by the developer (or indirectly
by other tools) on the target device to control the application-manager without directly talking to
its D-Bus interface.
The following commands are available:
\table
\header
\li Command
\li Arguments
\li Description
\row
\li \span {style="white-space: nowrap"} {\c start-application}
\li \c{<application-id>}
\c{[document-url]}
\li Starts the application identified by \c application-id within the application-manager. The
\c document-url parameter is optional.
\row
\li \span {style="white-space: nowrap"} {\c debug-application}
\li \c{<debug-wrapper-specification>}
\c{<application-id>}
\c{[document-url]}
\li Starts the application identified by \c application-id within the application-manager using
a debug-wrapper: see \l{DebugWrappers}{the debugging documentation} for more information on
this specification string. The \c document-url parameter is optional.
\row
\li \span {style="white-space: nowrap"} {\c stop-application}
\li \c{<application-id>}
\li Stops the application identified by \c application-id.
\row
\li \span {style="white-space: nowrap"} {\c stop-all-applications}
\li (none)
\li Stops all applications that are running within the application-manager.
\row
\li \span {style="white-space: nowrap"} {\c list-applications}
\li (none)
\li Outputs all available application ids on the console (one per line).
\row
\li \span {style="white-space: nowrap"} {\c show-application}
\li \c{<application-id>}
\li Shows the current meta-data of the given application in YAML format. The following options
are supported:
\c{--json}: Output in JSON format instead of YAML.
\row
\li \span {style="white-space: nowrap"} {\c install-package}
\li \c{<package>}
\li Installs the package given on the command-line. If the package file is specified as \c{-},
the tool will try to read the package from \c stdin. The following options are supported:
\c{-l, --location}: Install to a specific installation location (see \c show-installation-location).
\c{-a, --acknowledge}: Automatically acknowledge the installation, instead of relying on the System-UI's logic.
\row
\li \span {style="white-space: nowrap"} {\c remove-package}
\li \c{<application-id>}
\li Removes the package that previously installed the application specified with
\c application-id. The following options are supported:
\c{-f, --force}: Force removal of package.
\c{-k, --keep-documents}: Keep the document folder of the application.
\row
\li \span {style="white-space: nowrap"} {\c list-installation-locations}
\li (none)
\li Lists all installaton locations.
\row
\li \span {style="white-space: nowrap"} {\c show-installation-location}
\li \c{<installation-location>}
\li Shows details for installation location specified with \c installation-location in YAML
format. The following options are supported:
\c{--json}: Output in JSON format instead of YAML.
\endtable
The \c{appman-controller} naturally supports the standard Unix \c{--help} command-line option.
*/
|
