aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/projects/creator-projects-settings-run.qdoc
blob: 06c907851f96105e2512710b52cf6df53c480c87 (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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/****************************************************************************
**
** Copyright (c) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator
**
**
** 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.
// **********************************************************************

/*!
    \contentspage index.html
    \previouspage creator-build-settings.html
    \page creator-run-settings.html
    \nextpage creator-editor-settings.html

    \title Specifying Run Settings

    \QC automatically creates run configurations for your project.
    To view and modify the settings, select \gui {Projects > Build & Run > Run}.

    The settings to specify depend on the type of the project and on the
    \l{glossary-buildandrun-kit}{kit} that you build and run the project with.

    Click \gui Add to add run settings for a project and \gui Remove to remove
    the current settings.

    \section1 Specifying Run Settings for qmake Projects

    The run configurations for qmake projects derive their executable from the
    parsed .pro files. For more information on how the commands are constructed,
    see \l{Starting External Processes}.

    \include projects/creator-projects-settings-run-desktop.qdocinc
    \include projects/creator-projects-settings-run-analyze.qdocinc
    \include projects/creator-projects-settings-run-debug.qdocinc
    \include linux-mobile/creator-projects-settings-run-linux.qdocinc
    \include qnx/creator-projects-settings-run-qnx.qdocinc

    \section1 Selecting the Run Environment

    \QC automatically selects the environment used for running the application
    based on the device type. You can edit the environment or select another
    environment in the \gui {Run Environment} section.

    You can edit existing environment variables or add, reset and unset new
    variables.

    \image qtcreator-run-environment.png "Run Environment section"

    When running on the desktop, the \gui {Build Environment} is used by
    default, but you can also use the \gui {System Environment} without the
    additions made to the build environment. For more information, see
    \l {Build Environment}.

    To run in a clean system environment, select \gui {Clean Environment}.

    When running on a mobile device connected to the development host, \QC
    fetches information about the \gui {Device Environment} from the device.
    Usually, it does not make sense to edit the device environment.

    \section1 Specifying a Custom Executable to Run

    If you use CMake or the generic project type in \QC, or want
    to run a custom desktop executable, create a \gui {Custom Executable}
    run configuration for your project. For example, when working on a library,
    you can run a test application that links against the library.

    Specify the executable to run, command line arguments, working directory,
    and environment variables to use.

    \image qmldesigner-run-custom-exe.png "Run settings for custom executables"

    \include qtquick/creator-projects-settings-run-qtquick.qdocinc
*/