aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/list-of-tools.qdoc
blob: 7cb61b49ca2c1ac5a40fea7354d59619823444fd (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
64
65
66
67
68
69
70
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of Qbs.
**
** 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 http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

/*!
    \contentspage reference.html
    \page list-of-tools.html

    \title List of Command-line Tools
    \brief Auxiliary tools

    In addition to the \c qbs command itself, a number of auxiliary tools are provided. Their file
    names follow the pattern \c{qbs-<tool name>}, and they can be invoked either using that file
    name or as \c{qbs <tool name>}.

    This page is intended to give a short overview of these tools. For the supported parameters,
    see the respective help screen, which you get by calling \c{qbs help <tool name>}.

    \section1 config

    Manages \QBS settings like preferences and profiles.

    \section1 config-ui

    Like \c config, but with a graphical user interface.

    \section1 qmltypes

    Dumps information about the QML types supplied by \QBS. This is not intended as documentation
    for users, but as tooling support.

    \section1 setup-android

    Creates \QBS profiles for Android SDK and NDK installations.

    \section1 setup-qt

    Creates \QBS profiles for Qt installations.

    \section1 setup-toolchains

    Creates \QBS profiles for toolchains like GCC or MSVC.

*/