creator-external-tools.qdoc 6.93 KB
Newer Older
1 2
/****************************************************************************
**
3 4
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
5
**
6
** This file is part of the Qt Creator documentation.
7
**
8 9 10 11 12 13 14
** 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.
15
**
16
** GNU Free Documentation License Usage
17 18
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
19 20 21 22
** 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.
23 24 25 26 27 28 29 30 31 32
**
****************************************************************************/

// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************

/*!
33
    \contentspage {Qt Creator Manual}
34
    \previouspage creator-keyboard-shortcuts.html
35
    \page creator-editor-external.html
36
    \nextpage creator-task-lists.html
37 38 39 40

    \title Using External Tools

    You can use external tools directly from \QC. Qt Linguist,
41
    QML preview tools, the
42 43 44 45
    default text editor for your system, and the \c sort tool are preconfigured
    for use. You can change their default configurations and configure new
    tools.

46 47 48
    To run the tools, select \uicontrol Tools > \uicontrol External, or use the
    \c x filter in the locator.

49 50 51 52 53 54 55
    \section1 Using Qt Linguist

    You can use the Qt Linguist release manager tools, lupdate and lrelease,
    directly from \QC. The lupdate tool is used to synchronize source
    code and translations. The lrelease tool is used to create run-time
    translation files for use by the released application.

Leena Miettinen's avatar
Leena Miettinen committed
56 57
    To synchronize translation source (TS) files from a translator with the
    application code,
58
    select \uicontrol {Tools > External > Text > Linguist > Update Translations
59 60
    (lupdate)}.

Leena Miettinen's avatar
Leena Miettinen committed
61
    To generate from the TS files Qt message (QM) files that can be used by an
62
    application, select \uicontrol {Tools > External > Text > Linguist > Release
63 64 65
    Translations (lrelease)}.

    By default, the project .pro file is passed to the tools as an argument. To
66
    specify other command line arguments for the tools, select \uicontrol {Tools >
67 68
    External > Configure}.

69
    For more information about Qt Linguist, see \l{Qt Linguist Manual}.
70

71
    \section1 Previewing QML Files
72

73 74 75
    You can preview the current QML document in the QML Viewer (Qt Quick 1) or
    QML Scene (Qt Quick 2). The preview tools enable you to load QML documents
    for viewing and testing while you are developing an application.
76

77 78 79
    To preview the currently active QML file, select \uicontrol Tools >
    \uicontrol External > \uicontrol {Qt Quick} > \uicontrol {Qt Quick 1 Preview
    (qmlviewer)} or \uicontrol {Qt Quick 2 Preview (qmlscene)}.
80 81 82 83

    \section1 Using External Text Editors

    You can open files for editing in the default text editor for your system:
84
    Notepad on Windows and vi on Linux and \macos.
85
    To open the file you are currently viewing in an external editor, select
86 87 88
    \uicontrol Tools > \uicontrol External > \uicontrol Text >
    \uicontrol {Edit with Notepad} or \uicontrol {Edit with vi}, depending on
    your system.
89 90 91 92 93 94

    \QC looks for the editor path in the PATH environment variable
    of your operating system.

    \section1 Sorting Text Alphabetically

95
    To sort selected text alphabetically, select \uicontrol {Tools > External > Text
96 97 98 99
    > Sort Selection}. The \c sort tool takes the selected text as input and
    returns it in alphabetic order. By default, the output replaces the
    original selection in the code editor.

100
    To change the default configuration, select \uicontrol {Tools > External >
101 102 103 104 105
    Configure}.

    \section1 Configuring External Tools

    You can change the configuration of preconfigured tools and configure
106
    additional tools in \QC \uicontrol Options.
107

108 109
    \image qtcreator-external-tools.png

110 111 112 113
    To configure external tools:

    \list 1

114
        \li Select \uicontrol {Tools > External > Configure}.
115

116 117
        \li Select \uicontrol {Add > Add Tool}
            to add a new tool. You can also select \uicontrol {Add Category} to add a
118 119
            new category.

120
        \li In the \uicontrol Executable field, specify the executable to run. If the
121 122 123
            executable is found in your system PATH variable, do not specify
            the path to it.

124
        \li In the \uicontrol Arguments field, specify optional arguments for running
125 126
            the executable.

127
        \li In the \uicontrol {Working directory} field, specify the path to the
128 129
            working directory.

130
        \li In the \uicontrol Output field, select how to handle output from the
131
            tool. You can ignore the output, view it in the \uicontrol {General
132 133 134
            Messages} output pane, or replace the selected text with the
            output in the code editor.

135 136 137 138 139 140 141
        \li In the \uicontrol {Error output} field, select how to handle error
            messages from the tool.

        \li In the \uicontrol Environment field, select \uicontrol Change to modify
            environment variable values for build and run environments in
            the \uicontrol {Edit Environment Changes} dialog. For more information
            about how to add and remove variable values, see \l{Batch Editing}.
142

143
        \li Select the \uicontrol {Modifies current document} check box to make sure
144 145 146
            that if the current document is modified by the tool, it is saved
            before the tool is run and reloaded after the tool finishes.

147
        \li In the \uicontrol Input field, specify text that is passed as standard
148 149 150 151
            input to the tool.

    \endlist

152
    The category and tool are added to the \uicontrol {Tools > External} menu.
153 154

    If you change the configuration of preconfigured tools, you can later
155
    revert the changes by selecting the \uicontrol Reset button.
156 157 158

    The tool configurations that you add and modify are stored in XML format in
    the user configuration folder. For example,
159
    \c {~/config/QtProject/qtcreator/externaltools}
160
    on Linux and \macos and
161
    \c {C:\Users\username\AppData\Roaming\QtProject\qtcreator\externaltools}
162 163 164 165
    in Windows. To share a configuration with other users, copy an XML
    configuration file to the folder.

*/