aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/cli/builtin
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2017-10-04 15:12:48 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2017-10-04 16:03:38 +0000
commit06f2fb7929dd3b3a436cf266b461cef23a6a2f09 (patch)
treece5fd05b45c2257d354913485850f59764d826f7 /doc/reference/cli/builtin
parent8d0b530cf1b8872d4c5bcc315d98f8997f00d46c (diff)
Doc: Create a CLI reference
Each command is described on a separate page. Option and parameter descriptions are fetched from include files. \group and \ingroup commands are used to create a table that shows the CLI commands and short descriptions (from \brief commands). Task-number: QBS-947 Change-Id: I956c0e029f87e98162e03206a79baef604f1d55e Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Diffstat (limited to 'doc/reference/cli/builtin')
-rw-r--r--doc/reference/cli/builtin/cli-build.qdoc115
-rw-r--r--doc/reference/cli/builtin/cli-clean.qdoc72
-rw-r--r--doc/reference/cli/builtin/cli-dump-nodes-tree.qdoc72
-rw-r--r--doc/reference/cli/builtin/cli-generate.qdoc82
-rw-r--r--doc/reference/cli/builtin/cli-help.qdoc64
-rw-r--r--doc/reference/cli/builtin/cli-install.qdoc81
-rw-r--r--doc/reference/cli/builtin/cli-resolve.qdoc73
-rw-r--r--doc/reference/cli/builtin/cli-run.qdoc94
-rw-r--r--doc/reference/cli/builtin/cli-shell.qdoc85
-rw-r--r--doc/reference/cli/builtin/cli-status.qdoc68
-rw-r--r--doc/reference/cli/builtin/cli-update-timestamps.qdoc70
11 files changed, 876 insertions, 0 deletions
diff --git a/doc/reference/cli/builtin/cli-build.qdoc b/doc/reference/cli/builtin/cli-build.qdoc
new file mode 100644
index 000000000..dd0489eb8
--- /dev/null
+++ b/doc/reference/cli/builtin/cli-build.qdoc
@@ -0,0 +1,115 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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-build.html
+ \ingroup cli
+
+ \title build
+ \brief Builds a project.
+
+ \section1 Synopsis
+
+ \code
+ qbs build [options] [[configuration-name] [property:value] ...]
+ \endcode
+
+ \section1 Description
+
+ Builds projects in one or more configurations.
+
+ You can specify \l{Project Item}{project}, \l{Product Item}{product}, or
+ \l{List of Modules}{module} properties, as well as a \l{Profile Item}
+ {profile} separately for each configuration.
+
+ This is the default command.
+
+ If the build directory does not exist, it will be created.
+
+ For more information, see \l{Building Applications}.
+
+ \section1 Options
+
+ \include cli-options.qdocinc all-products
+ \include cli-options.qdocinc build-directory
+ \include cli-options.qdocinc changed-files
+ \include cli-options.qdocinc check-outputs
+ \include cli-options.qdocinc check-timestamps
+ \include cli-options.qdocinc clean-install-root
+ \include cli-options.qdocinc command-echo-mode
+ \include cli-options.qdocinc dry-run
+ \include cli-options.qdocinc project-file
+ \include cli-options.qdocinc force-probe-execution
+ \include cli-options.qdocinc jobs
+ \include cli-options.qdocinc keep-going
+ \include cli-options.qdocinc less-verbose
+ \include cli-options.qdocinc log-level
+ \include cli-options.qdocinc log-time
+ \include cli-options.qdocinc more-verbose
+ \include cli-options.qdocinc no-install
+ \include cli-options.qdocinc products-specified
+ \include cli-options.qdocinc settings-dir
+ \include cli-options.qdocinc show-progress
+ \include cli-options.qdocinc wait-lock
+
+ \section1 Parameters
+
+ \include cli-parameters.qdocinc configuration-name
+ \include cli-parameters.qdocinc property
+
+ \section1 Examples
+
+ Builds the application specified by the \c .qbs file in the current
+ directory using the default profile:
+
+ \code
+ qbs
+ \endcode
+
+ Builds the application using four concurrent build jobs:
+
+ \code
+ qbs -j 4
+ \endcode
+
+ Builds the default configuration of an application using the profile called
+ \c Android:
+
+ \code
+ qbs build profile:Android
+ \endcode
+
+ Builds the application using different \l{Module cpp}{cpp module} properties
+ for debug and release configurations. For the debug configuration, warnings
+ will cause the build to fail, whereas for the release configuration, the
+ size of the build artifacts will be optimized:
+
+ \code
+ qbs build debug modules.cpp.treatWarningsAsErrors:true release modules.cpp.optimization:small
+ \endcode
+*/
diff --git a/doc/reference/cli/builtin/cli-clean.qdoc b/doc/reference/cli/builtin/cli-clean.qdoc
new file mode 100644
index 000000000..1aa07a802
--- /dev/null
+++ b/doc/reference/cli/builtin/cli-clean.qdoc
@@ -0,0 +1,72 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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-clean.html
+ \ingroup cli
+
+ \title clean
+ \brief Removes the files generated during a build.
+
+ \section1 Synopsis
+
+ \code
+ qbs clean [options] [configuration-name]
+ \endcode
+
+ \section1 Description
+
+ Removes build \l{Artifact Item}{artifacts} for the specified build
+ configuration.
+
+ \section1 Options
+
+ \include cli-options.qdocinc build-directory
+ \include cli-options.qdocinc dry-run
+ \include cli-options.qdocinc keep-going
+ \include cli-options.qdocinc less-verbose
+ \include cli-options.qdocinc log-level
+ \include cli-options.qdocinc log-time
+ \include cli-options.qdocinc more-verbose
+ \include cli-options.qdocinc products-specified
+ \include cli-options.qdocinc settings-dir
+ \include cli-options.qdocinc show-progress
+
+ \section1 Parameters
+
+ \include cli-parameters.qdocinc configuration-name
+
+ \section1 Examples
+
+ Removes the build artifacts in the current directory for the default build
+ configuration:
+
+ \code
+ qbs clean
+ \endcode
+*/
diff --git a/doc/reference/cli/builtin/cli-dump-nodes-tree.qdoc b/doc/reference/cli/builtin/cli-dump-nodes-tree.qdoc
new file mode 100644
index 000000000..fa5d4db29
--- /dev/null
+++ b/doc/reference/cli/builtin/cli-dump-nodes-tree.qdoc
@@ -0,0 +1,72 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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-dump-nodes-tree.html
+ \ingroup cli
+
+ \title dump-nodes-tree
+ \brief Dumps the nodes in the build graph to \c stdout.
+
+ \section1 Synopsis
+
+ \code
+ qbs dump-nodes-tree [options] [[configuration-name] [property:value] ...]
+ \endcode
+
+ \section1 Description
+
+ Dumps the nodes in the build graph to \c stdout.
+
+ This is an internal command that is used for debugging purposes only.
+
+ \section1 Options
+
+ \include cli-options.qdocinc build-directory
+ \include cli-options.qdocinc project-file
+ \include cli-options.qdocinc less-verbose
+ \include cli-options.qdocinc log-level
+ \include cli-options.qdocinc log-time
+ \include cli-options.qdocinc more-verbose
+ \include cli-options.qdocinc products-specified
+ \include cli-options.qdocinc settings-dir
+
+ \section1 Parameters
+
+ \include cli-parameters.qdocinc configuration-name
+ \include cli-parameters.qdocinc property
+
+ \section1 Examples
+
+ Dumps the nodes tree into a file called \c nodes-tree.log:
+
+ \code
+ qbs dump-nodes-tree >nodes-tree.log
+ \endcode
+
+*/
diff --git a/doc/reference/cli/builtin/cli-generate.qdoc b/doc/reference/cli/builtin/cli-generate.qdoc
new file mode 100644
index 000000000..3d7d4cdbf
--- /dev/null
+++ b/doc/reference/cli/builtin/cli-generate.qdoc
@@ -0,0 +1,82 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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-generate.html
+ \ingroup cli
+
+ \title generate
+ \brief Invokes a project generator, for example to create project files for
+ another build tool.
+
+ \section1 Synopsis
+
+ \code
+ qbs generate [options] [[configuration-name] [property:value] ...]
+ \endcode
+
+ \section1 Description
+
+ Invokes a project generator, for example to create project files for another
+ build tool.
+
+ For more information, see \l{Generators}.
+
+ \section1 Options
+
+ \include cli-options.qdocinc generator
+ \include cli-options.qdocinc build-directory
+ \include cli-options.qdocinc project-file
+ \include cli-options.qdocinc install-root
+ \include cli-options.qdocinc less-verbose
+ \include cli-options.qdocinc log-level
+ \include cli-options.qdocinc log-time
+ \include cli-options.qdocinc more-verbose
+ \include cli-options.qdocinc settings-dir
+ \include cli-options.qdocinc show-progress
+
+ \section1 Parameters
+
+ \include cli-parameters.qdocinc configuration-name
+ \include cli-parameters.qdocinc property
+
+ \section1 Examples
+
+ Generates a project for Microsoft Visual Studio:
+
+ \code
+ qbs generate -g visualstudio2015
+ \endcode
+
+ Generates a \l{https://clang.llvm.org/docs/JSONCompilationDatabase.html}
+ {Clang compilation database (clangdb)}:
+
+ \code
+ qbs generate --generator clangdb
+ \endcode
+*/
diff --git a/doc/reference/cli/builtin/cli-help.qdoc b/doc/reference/cli/builtin/cli-help.qdoc
new file mode 100644
index 000000000..c36d03317
--- /dev/null
+++ b/doc/reference/cli/builtin/cli-help.qdoc
@@ -0,0 +1,64 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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-help.html
+ \ingroup cli
+
+ \title help
+ \brief Shows general or command-specific help.
+
+ \section1 Synopsis
+
+ \code
+ qbs help [<command>]
+ \endcode
+
+ \section1 Description
+
+ Shows a list of available commands with descriptions. Specify a command
+ name to list the options that the command takes with descriptions.
+
+ \section1 Options
+
+ This command takes no options.
+
+ \section1 Examples
+
+ Shows an overview of all commands:
+
+ \code
+ qbs help
+ \endcode
+
+ Lists the options that the \c build command takes:
+
+ \code
+ qbs help build
+ \endcode
+*/
diff --git a/doc/reference/cli/builtin/cli-install.qdoc b/doc/reference/cli/builtin/cli-install.qdoc
new file mode 100644
index 000000000..d68d4d922
--- /dev/null
+++ b/doc/reference/cli/builtin/cli-install.qdoc
@@ -0,0 +1,81 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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-install.html
+ \ingroup cli
+
+ \title install
+ \brief Installs a project.
+
+ \section1 Synopsis
+
+ \code
+ qbs install [options] [[configuration-name] [property:value] ...]
+ \endcode
+
+ \section1 Description
+
+ Install all files marked as installable to their respective destinations.
+ The project is built first, if necessary, unless the \c --no-build option is
+ given.
+
+ For more information, see \l{Installing Files}.
+
+ \section1 Options
+
+ \include cli-options.qdocinc all-products
+ \include cli-options.qdocinc build-directory
+ \include cli-options.qdocinc changed-files
+ \include cli-options.qdocinc check-outputs
+ \include cli-options.qdocinc check-timestamps
+ \include cli-options.qdocinc clean-install-root
+ \include cli-options.qdocinc command-echo-mode
+ \include cli-options.qdocinc dry-run
+ \include cli-options.qdocinc project-file
+ \include cli-options.qdocinc force-probe-execution
+ \include cli-options.qdocinc install-root
+ \include cli-options.qdocinc jobs
+ \include cli-options.qdocinc keep-going
+ \include cli-options.qdocinc less-verbose
+ \include cli-options.qdocinc log-level
+ \include cli-options.qdocinc log-time
+ \include cli-options.qdocinc more-verbose
+ \include cli-options.qdocinc no-build
+ \include cli-options.qdocinc products-specified
+ \include cli-options.qdocinc settings-dir
+ \include cli-options.qdocinc wait-lock
+
+ \section1 Parameters
+
+ \include cli-parameters.qdocinc configuration-name
+ \include cli-parameters.qdocinc property
+
+ \section1 Examples
+
+*/
diff --git a/doc/reference/cli/builtin/cli-resolve.qdoc b/doc/reference/cli/builtin/cli-resolve.qdoc
new file mode 100644
index 000000000..fd2035f57
--- /dev/null
+++ b/doc/reference/cli/builtin/cli-resolve.qdoc
@@ -0,0 +1,73 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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-resolve.html
+ \ingroup cli
+
+ \title resolve
+ \brief Resolves a project without building it.
+
+ \section1 Synopsis
+
+ \code
+ qbs resolve [options] [[configuration-name] [property:value] ...]
+ \endcode
+
+ \section1 Description
+
+ Resolves a \l{Project Item}{project} in one or more configurations. Run this
+ command to change the properties of an existing build.
+
+ \section1 Options
+
+ \include cli-options.qdocinc build-directory
+ \include cli-options.qdocinc dry-run
+ \include cli-options.qdocinc project-file
+ \include cli-options.qdocinc force-probe-execution
+ \include cli-options.qdocinc jobs
+ \include cli-options.qdocinc less-verbose
+ \include cli-options.qdocinc log-level
+ \include cli-options.qdocinc log-time
+ \include cli-options.qdocinc more-verbose
+ \include cli-options.qdocinc settings-dir
+ \include cli-options.qdocinc show-progress
+
+ \section1 Parameters
+
+ \include cli-parameters.qdocinc configuration-name
+ \include cli-parameters.qdocinc property
+
+ \section1 Examples
+
+ Resolves the default configuration of the project in the current directory:
+
+ \code
+ qbs resolve
+ \endcode
+*/
diff --git a/doc/reference/cli/builtin/cli-run.qdoc b/doc/reference/cli/builtin/cli-run.qdoc
new file mode 100644
index 000000000..5b9b6456a
--- /dev/null
+++ b/doc/reference/cli/builtin/cli-run.qdoc
@@ -0,0 +1,94 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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-run.html
+ \ingroup cli
+
+ \title run
+ \brief Runs an executable generated by building a project.
+
+ \section1 Synopsis
+
+ \code
+ qbs run [options] [configuration-name] [property:value] ... [ -- <arguments>]
+ \endcode
+
+ \section1 Description
+
+ Runs the specified product's executable with the specified \c <arguments>.
+ If the project has only one product, the \c --products option may be
+ omitted.
+
+ The product will be built if it is not up to date, unless the \c --no-build
+ option is specified. For more information, see \l{build}.
+
+ For more information about running applications, see
+ \l{Running Applications}.
+
+ \section1 Options
+
+ \include cli-options.qdocinc all-products
+ \include cli-options.qdocinc build-directory
+ \include cli-options.qdocinc changed-files
+ \include cli-options.qdocinc check-outputs
+ \include cli-options.qdocinc check-timestamps
+ \include cli-options.qdocinc clean-install-root
+ \include cli-options.qdocinc command-echo-mode
+ \include cli-options.qdocinc dry-run
+ \include cli-options.qdocinc project-file
+ \include cli-options.qdocinc force-probe-execution
+ \include cli-options.qdocinc install-root
+ \include cli-options.qdocinc jobs
+ \include cli-options.qdocinc keep-going
+ \include cli-options.qdocinc less-verbose
+ \include cli-options.qdocinc log-level
+ \include cli-options.qdocinc log-time
+ \include cli-options.qdocinc more-verbose
+ \include cli-options.qdocinc no-build
+ \include cli-options.qdocinc products-specified
+ \include cli-options.qdocinc settings-dir
+ \include cli-options.qdocinc wait-lock
+
+ \section1 Parameters
+
+ \include cli-parameters.qdocinc configuration-name
+ \include cli-parameters.qdocinc property
+
+ \section1 Arguments
+
+ \include cli-parameters.qdocinc arguments
+
+ \section1 Examples
+
+ Runs the Qt Creator application:
+
+ \code
+ qbs run --products qtcreator
+ \endcode
+*/
diff --git a/doc/reference/cli/builtin/cli-shell.qdoc b/doc/reference/cli/builtin/cli-shell.qdoc
new file mode 100644
index 000000000..d0b717901
--- /dev/null
+++ b/doc/reference/cli/builtin/cli-shell.qdoc
@@ -0,0 +1,85 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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-shell.html
+ \ingroup cli
+
+ \title shell
+ \brief Opens a shell with a product's environment.
+
+ \section1 Synopsis
+
+ \code
+ qbs shell [options] [configuration-name] [property:value]
+ \endcode
+
+ \section1 Description
+
+ Opens a shell in the environment that a build with the specified parameters
+ would use.
+
+ For more information, see \l{Using the Shell}.
+
+ \section1 Options
+
+ \include cli-options.qdocinc build-directory
+ \include cli-options.qdocinc changed-files
+ \include cli-options.qdocinc check-outputs
+ \include cli-options.qdocinc check-timestamps
+ \include cli-options.qdocinc clean-install-root
+ \include cli-options.qdocinc command-echo-mode
+ \include cli-options.qdocinc dry-run
+ \include cli-options.qdocinc project-file
+ \include cli-options.qdocinc force-probe-execution
+ \include cli-options.qdocinc jobs
+ \include cli-options.qdocinc keep-going
+ \include cli-options.qdocinc less-verbose
+ \include cli-options.qdocinc log-level
+ \include cli-options.qdocinc log-time
+ \include cli-options.qdocinc more-verbose
+ \include cli-options.qdocinc no-install
+ \include cli-options.qdocinc products-specified
+ \include cli-options.qdocinc settings-dir
+ \include cli-options.qdocinc show-progress
+ \include cli-options.qdocinc wait-lock
+
+ \section1 Parameters
+
+ \include cli-parameters.qdocinc configuration-name
+ \include cli-parameters.qdocinc property
+
+ \section1 Examples
+
+ Opens a shell with the same environment that \QBS uses when building the
+ project:
+
+ \code
+ qbs shell
+ \endcode
+*/
diff --git a/doc/reference/cli/builtin/cli-status.qdoc b/doc/reference/cli/builtin/cli-status.qdoc
new file mode 100644
index 000000000..ecafe3956
--- /dev/null
+++ b/doc/reference/cli/builtin/cli-status.qdoc
@@ -0,0 +1,68 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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-status.html
+ \ingroup cli
+
+ \title status
+ \brief Shows the status of files in the project directory.
+
+ \section1 Synopsis
+
+ \code
+ qbs status [options] [configuration-name] [property:value]
+ \endcode
+
+ \section1 Description
+
+ Lists all the files in the project directory and shows whether they are
+ known to \QBS in the respective configuration.
+
+ \section1 Options
+
+ \include cli-options.qdocinc build-directory
+ \include cli-options.qdocinc project-file
+ \include cli-options.qdocinc less-verbose
+ \include cli-options.qdocinc log-level
+ \include cli-options.qdocinc more-verbose
+ \include cli-options.qdocinc settings-dir
+
+ \section1 Parameters
+
+ \include cli-parameters.qdocinc configuration-name
+ \include cli-parameters.qdocinc property
+
+ \section1 Examples
+
+ To list the files in the project directory and view their status:
+
+ \code
+ qbs status
+ \endcode
+*/
diff --git a/doc/reference/cli/builtin/cli-update-timestamps.qdoc b/doc/reference/cli/builtin/cli-update-timestamps.qdoc
new file mode 100644
index 000000000..6b15cc26b
--- /dev/null
+++ b/doc/reference/cli/builtin/cli-update-timestamps.qdoc
@@ -0,0 +1,70 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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-update-timestamps.html
+ \ingroup cli
+
+ \title update-timestamps
+ \brief Marks the build as up-to-date.
+
+ \section1 Synopsis
+
+ \code
+ qbs update-timestamps [options] [[configuration-name] [property:value] ...]
+ \endcode
+
+ \section1 Description
+
+ Updates the timestamps of all build \l{Artifact Item}{artifacts}, causing
+ the next builds of the \l{Project Item}{project} to do nothing until source
+ files are updated again.
+
+ This command is useful if you know that the current changes to source files
+ are irrelevant to the build.
+
+ \note Using this command causes a discrepancy between the actual state of
+ source files and the information in the build graph, so be careful.
+
+ \section1 Options
+
+ \include cli-options.qdocinc build-directory
+ \include cli-options.qdocinc project-file
+ \include cli-options.qdocinc less-verbose
+ \include cli-options.qdocinc log-level
+ \include cli-options.qdocinc more-verbose
+ \include cli-options.qdocinc products-specified
+ \include cli-options.qdocinc settings
+
+ \section1 Parameters
+
+ \include cli-parameters.qdocinc configuration-name
+ \include cli-parameters.qdocinc property
+
+ \section1 Examples
+*/