aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/cli/builtin/cli-run.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/reference/cli/builtin/cli-run.qdoc')
-rw-r--r--doc/reference/cli/builtin/cli-run.qdoc94
1 files changed, 94 insertions, 0 deletions
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
+*/