/****************************************************************************
**
** 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$
**
****************************************************************************/

/*!
    \page cli-shell.html
    \ingroup cli

    \title shell
    \brief Opens a shell with a product's environment.

    \section1 Synopsis

    \code
    qbs shell [options] [config: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 project-file
    \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

    Opens a shell with the same environment that \QBS uses when building the
    project:

    \code
    qbs shell
    \endcode
*/
