aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/cli/builtin/cli-status.qdoc
blob: a619aa9ce2d80dc21bcc29c7ff484b3708fba06b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/****************************************************************************
**
** 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]
    \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 settings-dir

    \section1 Parameters

    \include cli-parameters.qdocinc configuration-name

    \section1 Examples

    To list the files in the project directory and view their status:

    \code
    qbs status
    \endcode
*/