Update tools documentation

Removed obsolete deployer documentation and aligned packager and
controller docu with command line help.

Change-Id: I2b217ff9a86017130b7a546cf00f5bcf1bcc8d22
Reviewed-by: Robert Griebl <robert.griebl@pelagicore.com>

4 files changed, 98 insertions, 71 deletions

diff --git a/doc/controller.qdoc b/doc/controller.qdoc
index 68cc68f2..2a2ff705 100644
--- a/doc/controller.qdoc
+++ b/doc/controller.qdoc
@@ -40,33 +40,70 @@ The following commands are available:
 
 \table
 \header
-    \li Action
-    \li Options
+    \li Command
+    \li Arguments
     \li Description
 \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.
-\row
     \li \span {style="white-space: nowrap"} {\c start-application}
-    \li \c{<application-id> [document-url]}
+    \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> <application-id> [document-url]}
+    \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.
+    \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.
+\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.
diff --git a/doc/deployer.qdoc b/doc/deployer.qdoc
deleted file mode 100644
index 2929c6d1..00000000
--- a/doc/deployer.qdoc
+++ /dev/null
@@ -1,47 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2017 Pelagicore AG
-** Contact: https://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Pelagicore 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-deployer.html
-\title Deployer
-\brief A command-line utility for remotely installing a package on a target device
-       via SSH.
-\ingroup qtappman-tools
-
-The \c{appman-deployer} is a command-line utility that is used by the developer on his desktop
-machine to remotely install a package on a target device via SSH. It is a simple shell script that
-automates sending the package to the device and triggering the \c{appman-controller} on the target
-to install the package.
-
-\b Usage
-\badcode
-appman-deployer <user> <target name/ip> <package file>
-\endcode
-
-The \c{appman-deployer} naturally supports the standard Unix \c{--help} command-line option.
-
-*/
diff --git a/doc/manifest.qdoc b/doc/manifest.qdoc
index 7459f8e3..864f3121 100644
--- a/doc/manifest.qdoc
+++ b/doc/manifest.qdoc
@@ -236,7 +236,7 @@ The meaning of the fields within the \c info.yaml actual manifest data (second Y
         ApplicationManager::application()::applicationProperties to the System-UI and as the
         ApplicationInterface::applicationProperties to the QML application:
         \list
-        \li The application has access to public and protected properties. Private keys will
+        \li The application has access to private and protected properties. Private keys will
             overwrite identical protected ones.
         \li The System-UI has access to protected properties only.
         \endlist
diff --git a/doc/packager.qdoc b/doc/packager.qdoc
index 1ac4c70b..19ff2aa3 100644
--- a/doc/packager.qdoc
+++ b/doc/packager.qdoc
@@ -43,44 +43,81 @@ developer only (development mode), and packages that are signed by a trusted app
 
 \table
 \header
-    \li Action
-    \li Options
+    \li Command
+    \li Arguments
     \li Description
 \row
     \li \span {style="white-space: nowrap"} {\c create-package}
-    \li \c{<package> <source directory>}
-    \li Create a new package named \a package from the application in \a{source directory}. The
+    \li \c{<package>}
+
+        \c{<source directory>}
+    \li Creates a new package named \a package from the application in \a{source directory}. The
         directory needs to at least contain an \l{Manifest definition}{\c info.yaml} as well as an
         \c{icon.png} file.
         The tool will do a sanity-check on the \c info.yaml file before actually creating the
         package.
         All normal files and directories in the source directory will be copied into package. The
         only meta-data that is copied from the filesystem is the filename, and the user's
-        eXecutable-bit.
+        eXecutable-bit. The following options are supported:
+
+        \c{--verbose}: Dump the package's meta-data header and footer information to stdout.
+
+        \c{--json}: Output in JSON format instead of YAML.
 \row
     \li \span {style="white-space: nowrap"} {\c dev-sign-package}
-    \li \c{<package> <signed-package> <certificate> <password>}
+    \li \c{<package>}
+
+        \c{<signed-package>}
+
+        \c{<certificate>}
+
+        \c{<password>}
     \li Takes the input \c package, adds a developer signature and writes the output to \c signed-package.
         You need to supply a \c certificate in P12 format together with a \c password matching the
-        certificate.
+        certificate. The following options are supported:
+
+        \c{--verbose}: Dump the package's meta-data header and footer information to stdout.
+
+        \c{--json}: Output in JSON format instead of YAML.
 \row
     \li \span {style="white-space: nowrap"} {\c dev-verify-package}
-    \li \c{<package> <ca-certificates...>}
+    \li \c{<package>}
+
+        \c{<ca-certificates...>}
     \li Reads the input \c package and tries to verify the developer signature using the given \c
-        ca-certificates.
+        ca-certificates. The following options are supported:
+
+        \c{--verbose}: Print details regarding the verification to stdout.
 \row
     \li \span {style="white-space: nowrap"} {\c store-sign-package}
-    \li \c{<package> <signed-package> <certificate> <password> [device-id]}
+    \li \c{<package>}
+
+        \c{<signed-package>}
+
+        \c{<certificate>}
+
+        \c{<password>}
+
+        \c{[device-id]}
     \li Takes the input \c package, adds a store signature and writes the output to \c signed-package.
         You need to supply a \c certificate in P12 format together with a \c password matching the
         certificate. If you specify the optional \c device-id, the resulting package can only be
-        installed on this specific device.
+        installed on this specific device. The following options are supported:
+
+        \c{--verbose}: Dump the package's meta-data header and footer information to stdout.
+
+        \c{--json}: Output in JSON format instead of YAML.
 \row
     \li \span {style="white-space: nowrap"} {\c store-verify-package}
-    \li \c{<package> <ca-certificates...> <device-id>}
+    \li \c{<package>}
+
+        \c{<ca-certificates...>}
+
+        \c{<device-id>}
     \li Reads the input \c package and tries to verify the store signature using the given \c
-        ca-certificates.
+        ca-certificates. The following options are supported:
 
+        \c{--json}: Output in JSON format instead of YAML.
 \endtable
 
 The \c{appman-packager} naturally supports the standard Unix \c{--help} command-line option.