creator-external-tools.qdoc 6.29 KB
Newer Older
1 2
/****************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
**
**
** GNU Free Documentation License
**
** 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.
**
**
****************************************************************************/

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

/*!
26
    \contentspage {Qt Creator Manual}
27
    \previouspage creator-keyboard-shortcuts.html
28
    \page creator-editor-external.html
29
    \nextpage creator-task-lists.html
30 31 32 33

    \title Using External Tools

    You can use external tools directly from \QC. Qt Linguist,
34
    QML preview tools, the
35 36 37 38
    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.

39 40 41
    To run the tools, select \uicontrol Tools > \uicontrol External, or use the
    \c x filter in the locator.

42 43 44 45 46 47 48
    \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
49 50
    To synchronize translation source (TS) files from a translator with the
    application code,
51
    select \uicontrol {Tools > External > Text > Linguist > Update Translations
52 53
    (lupdate)}.

Leena Miettinen's avatar
Leena Miettinen committed
54
    To generate from the TS files Qt message (QM) files that can be used by an
55
    application, select \uicontrol {Tools > External > Text > Linguist > Release
56 57 58
    Translations (lrelease)}.

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

62
    For more information about Qt Linguist, see \l{Qt Linguist Manual}.
63

64
    \section1 Previewing QML Files
65

66 67 68
    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.
69

70 71 72
    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)}.
73 74 75 76

    \section1 Using External Text Editors

    You can open files for editing in the default text editor for your system:
77
    Notepad on Windows and vi on Linux and OS X.
78
    To open the file you are currently viewing in an external editor, select
79 80 81
    \uicontrol Tools > \uicontrol External > \uicontrol Text >
    \uicontrol {Edit with Notepad} or \uicontrol {Edit with vi}, depending on
    your system.
82 83 84 85 86 87

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

    \section1 Sorting Text Alphabetically

88
    To sort selected text alphabetically, select \uicontrol {Tools > External > Text
89 90 91 92
    > 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.

93
    To change the default configuration, select \uicontrol {Tools > External >
94 95 96 97 98
    Configure}.

    \section1 Configuring External Tools

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

101 102
    \image qtcreator-external-tools.png

103 104 105 106
    To configure external tools:

    \list 1

107
        \li Select \uicontrol {Tools > External > Configure}.
108

109 110
        \li Select \uicontrol {Add > Add Tool}
            to add a new tool. You can also select \uicontrol {Add Category} to add a
111 112
            new category.

113
        \li In the \uicontrol Executable field, specify the executable to run. If the
114 115 116
            executable is found in your system PATH variable, do not specify
            the path to it.

117
        \li In the \uicontrol Arguments field, specify optional arguments for running
118 119
            the executable.

120
        \li In the \uicontrol {Working directory} field, specify the path to the
121 122
            working directory.

123
        \li In the \uicontrol Output field, select how to handle output from the
124
            tool. You can ignore the output, view it in the \uicontrol {General
125 126 127
            Messages} output pane, or replace the selected text with the
            output in the code editor.

128 129 130 131 132 133 134
        \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}.
135

136
        \li Select the \uicontrol {Modifies current document} check box to make sure
137 138 139
            that if the current document is modified by the tool, it is saved
            before the tool is run and reloaded after the tool finishes.

140
        \li In the \uicontrol Input field, specify text that is passed as standard
141 142 143 144
            input to the tool.

    \endlist

145
    The category and tool are added to the \uicontrol {Tools > External} menu.
146 147

    If you change the configuration of preconfigured tools, you can later
148
    revert the changes by selecting the \uicontrol Reset button.
149 150 151

    The tool configurations that you add and modify are stored in XML format in
    the user configuration folder. For example,
152
    \c {~/config/QtProject/qtcreator/externaltools}
153
    on Linux and OS X and
154
    \c {C:\Users\username\AppData\Roaming\QtProject\qtcreator\externaltools}
155 156 157 158
    in Windows. To share a configuration with other users, copy an XML
    configuration file to the folder.

*/