diff options
author | Christian Kandeler <christian.kandeler@qt.io> | 2019-03-18 15:02:53 +0100 |
---|---|---|
committer | Christian Kandeler <christian.kandeler@qt.io> | 2019-09-18 15:07:54 +0000 |
commit | 9f3a9830162f379d6f856c84668c3664df6d6477 (patch) | |
tree | b32a126840ca81a0881e71051f5c09443ede5a05 /doc/reference/cli/builtin | |
parent | 41d8b09239ce0ace2fd8674aaecae1528b1985e4 (diff) |
Introduce the session command
Offers a JSON-based API for interaction with other tools via stdin/
stdout.
This allows for proper qbs support in IDEs that do not use Qt or even
C++.
Change-Id: Ib051a40b7ebe1c6e0c3147cca9bd96e7daec1fde
Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
Diffstat (limited to 'doc/reference/cli/builtin')
-rw-r--r-- | doc/reference/cli/builtin/cli-session.qdoc | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/reference/cli/builtin/cli-session.qdoc b/doc/reference/cli/builtin/cli-session.qdoc new file mode 100644 index 000000000..62999a82e --- /dev/null +++ b/doc/reference/cli/builtin/cli-session.qdoc @@ -0,0 +1,54 @@ +/**************************************************************************** +** +** Copyright (C) 2019 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-session.html + \ingroup cli + + \title session + \brief Starts a session for interacting with an IDE + + \section1 Synopsis + + \code + qbs session + \endcode + + \section1 Description + + Starts a session, communicating via standard input and standard output. + + In this mode, \QBS takes commands from standard input and sends replies + to standard output, using a \l{Appendix C: The JSON API}{JSON-based API}. + + This is the recommended \QBS interface for IDEs. It can be used to retrieve + information about a project and interact with it in various ways, such + as building it, collecting the list of executables, adding new source files + and so on. + +*/ |