diff options
author | Christian Kandeler <christian.kandeler@qt.io> | 2018-06-15 14:13:05 +0200 |
---|---|---|
committer | Christian Kandeler <christian.kandeler@qt.io> | 2018-06-15 13:49:21 +0000 |
commit | 1b1296d69791aa7a7e2b8f703c8a9ea1e42b54c8 (patch) | |
tree | 96781a2072d41021a390064f209a0013eaa84ba1 /doc/reference/cli | |
parent | 30fb7a1a2b9ea655bf974ea5a937f045940ac082 (diff) |
Document the list-products command
Change-Id: I948e6251a97b0af94081255a79c11b18d6c8e9d4
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'doc/reference/cli')
-rw-r--r-- | doc/reference/cli/builtin/cli-list-products.qdoc | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/doc/reference/cli/builtin/cli-list-products.qdoc b/doc/reference/cli/builtin/cli-list-products.qdoc new file mode 100644 index 000000000..92ef043da --- /dev/null +++ b/doc/reference/cli/builtin/cli-list-products.qdoc @@ -0,0 +1,63 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qbs. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt 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$ +** +****************************************************************************/ + +/*! + \contentspage cli.html + \page cli-list-products.html + \ingroup cli + + \title list-products + \brief Lists all products in the given project. + + \section1 Synopsis + + \code + qbs list-products [options] [config:configuration-name] + \endcode + + \section1 Description + + Lists all products that exist in a project. + + \section1 Options + + \include cli-options.qdocinc project-file + \include cli-options.qdocinc build-directory + \include cli-options.qdocinc settings-dir + + \section1 Parameters + + \include cli-parameters.qdocinc configuration-name + + \section1 Examples + + To list all products for the project in the current directory: + + \code + qbs list-products + \endcode +*/ |