creator-cli.qdoc 7.79 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-project-generic.html
28 29 30 31 32
    \page creator-cli.html
    \nextpage creator-keyboard-shortcuts.html

    \title Using Command Line Options

Tobias Hunger's avatar
Tobias Hunger committed
33 34
    You can start \QC and specify some options from the command line. For
    example, you can open a file to any line.
35 36 37 38 39 40 41 42 43 44

    To specify command line options, enter the following command in the \QC
    installation or build directory:

    \c {qtcreator [option] [filename[:line_number]]}

    \note You can use either a colon (:) or a plus sign (+) as a separator
    between the filename and line number. You can also use a space between the
    separator and the line number.

Leena Miettinen's avatar
Leena Miettinen committed
45
    For example, on Windows:
46 47 48

    \list

49
        \li \c {C:\qtcreator\bin>qtcreator -help}
50

51
        \li \c {C:\qtcreator\bin>qtcreator C:\TextFinder\textfinder.cpp:100}
52

53
        \li \c {C:\qtcreator\bin>qtcreator C:\TextFinder\textfinder.cpp +100}
54 55 56

    \endlist

Leena Miettinen's avatar
Leena Miettinen committed
57 58 59 60 61 62 63 64
    On OS X:

    \list

        \li \c {Qt Creator.app/Contents/MacOS/Qt Creator -help}

    \endlist

Tobias Hunger's avatar
Tobias Hunger committed
65 66 67 68
    To open a project that is located in a particular folder, you can pass on
    the folder name as a command line argument. \QC looks for a session that
    matches the folder name and loads it. Or it looks for a project file in the
    folder and opens it. For example:
69 70 71

    \c {qtcreator .}

72 73 74 75 76 77 78 79 80
    \note To run a self-built \QC from the command line on Windows, make sure
    that the Qt installation directory is included in the PATH environment
    variable. You can enter the following command on the command line to add Qt
    to the path:

    \code
    set PATH=<Qt_installation_directory>\mingw\bin;c:<Qt_installation_directory>\bin;%PATH%
    \endcode

81 82 83 84
    The following table summarizes the available options:

    \table
        \header
Tobias Hunger's avatar
Tobias Hunger committed
85 86
            \li Option
            \li Description
87 88

        \row
Tobias Hunger's avatar
Tobias Hunger committed
89 90
            \li -help
            \li Display help on command line options.
91 92

        \row
Tobias Hunger's avatar
Tobias Hunger committed
93 94
            \li -version
            \li Display \QC version.
95 96

        \row
Tobias Hunger's avatar
Tobias Hunger committed
97 98
            \li -client
            \li Attempt to connect to an already running instance of \QC.
99

Leena Miettinen's avatar
Leena Miettinen committed
100 101 102 103 104 105 106 107 108 109
       \row
            \li -pid
            \li Attempt to connect to an already running instance of \QC with
                the specified process ID.

        \row
            \li -block
            \li Open files in editors in a running \QC instance and block the
                command line until the first editor is closed.

Daniel Teske's avatar
Daniel Teske committed
110 111
       \row
            \li -load <plugin>
112 113 114 115 116 117 118 119
            \li Enable the specified plugin and all plugins that it depends on.
                You can combine \c -load and \c -noload options and specify both
                options multiple times to enable and disable several plugins.
                The actions are executed in the specified order.

       \row
            \li -load all
            \li Enables all plugins.
Daniel Teske's avatar
Daniel Teske committed
120

121
        \row
Tobias Hunger's avatar
Tobias Hunger committed
122 123
            \li -noload <plugin>
            \li Disable the specified plugin and all plugins that depend on it.
124 125

        \row
Tobias Hunger's avatar
Tobias Hunger committed
126 127
            \li -noload all
            \li Disables all plugins.
128 129

        \row
Tobias Hunger's avatar
Tobias Hunger committed
130 131
            \li -profile
            \li Output plugin start up and shut down profiling data.
132

Leena Miettinen's avatar
Leena Miettinen committed
133 134 135 136 137
       \row
            \li -pluginpath <path>
            \li Add a path where \QC looks for plugins. To specify several
                paths, add the \c{-pluginpath} option for each path.

138
        \row
Tobias Hunger's avatar
Tobias Hunger committed
139 140
            \li -settingspath <path>
            \li Override the default path where user settings are stored.
141 142

        \row
Tobias Hunger's avatar
Tobias Hunger committed
143 144
            \li -color <color>
            \li Core plugin: override the selected UI color.
145

Leena Miettinen's avatar
Leena Miettinen committed
146 147
       \row
            \li -presentationMode
Tobias Hunger's avatar
Tobias Hunger committed
148 149
            \li Core plugin: display keyboard shortcuts as popups when you
                press them. Mostly useful when presenting \QC to someone else.
Leena Miettinen's avatar
Leena Miettinen committed
150

151
        \row
Tobias Hunger's avatar
Tobias Hunger committed
152 153 154
            \li -theme <default | dark>
            \li Core plugin: apply a dark color theme to \QC, without using
                stylesheets.
155

156
        \row
Tobias Hunger's avatar
Tobias Hunger committed
157 158 159
            \li -debug <pid>
            \li Debugger plugin: attach to the process with the given process
                ID.
160 161

        \row
Tobias Hunger's avatar
Tobias Hunger committed
162 163 164 165 166
            \li -debug <executable>[,kit=<kit>]
            \li Debugger plugin: launch and debug the executable with the name
                \c{executable}.
                A \c{kit} can be specified to point to non-default debuggers
                and sysroots.
167 168

        \row
Tobias Hunger's avatar
Tobias Hunger committed
169 170 171 172 173 174 175 176 177 178
            \li -debug [executable,]core=<corefile>[,kit=<kit>]
            \li Debugger plugin: load the core file named \c{corefile}.
                The parameter \c{executable} specifies the executable that
                produced the core file.
                If this parameter is omitted, \QC will attempt to reconstruct
                it from the core file itself. This will fail for paths with more
                than about 80 characters.
                In such cases the \c{executable} parameter is mandatory.
                A \c{kit} can be specified to point to non-default debuggers
                and sysroots.
179 180

        \row
Tobias Hunger's avatar
Tobias Hunger committed
181 182 183 184 185 186 187
            \li -debug <executable>,server=<server:port>[,kit=<kit>]
            \li Debugger plugin: attach to a debug server running on the port
                \c{port} on the server \c{server}. The parameter \c{executable}
                specifies a local copy of the executable the remote debug server
                is manipulating.
                A \c{kit} can be specified to point to non-default debuggers and
                sysroots.
188 189

        \row
Tobias Hunger's avatar
Tobias Hunger committed
190 191 192
            \li -wincrashevent <event-handle:pid>
            \li Debugger plugin: Attach to crashed processes by using the
                specified event handle and process ID.
193 194

        \row
Tobias Hunger's avatar
Tobias Hunger committed
195 196 197 198
            \li -customwizard-verbose
            \li ProjectExplorer plugin: display additional information when
                loading custom wizards. For more information about custom
                wizards, see \l{Adding New Custom Wizards}
199 200

        \row
Tobias Hunger's avatar
Tobias Hunger committed
201 202 203 204 205
            \li -lastsession
            \li ProjectExplorer plugin: load the last session when \QC starts.
                Open the projects and files that were open when you last exited
                \QC. For more information about managing sessions, see
                \l{Managing Sessions}.
206 207 208

    \endtable

209 210
    \section1 Using Custom Styles

Tobias Hunger's avatar
Tobias Hunger committed
211 212 213 214 215
    \QC is a \l{QApplication}{Qt application}, and therefore, it accepts the
    command line options that all Qt applications accept. For example, you can
    use the \c {-style} and \c {-stylesheet} options to apply custom styles and
    \l{Qt Style Sheets}{stylesheets}. The styling is only applied during the
    current session.
216 217 218 219 220 221

    Exercise caution when applying styles, as overriding the existing styling
    may make some items difficult to see. Also, setting a stylesheet may affect
    the \l{Specifying Text Editor Settings}{text editor color scheme} and the
    styling of the integrated \QD.

222 223 224
    You can also switch to a dark theme to customize the appearance of widgets,
    colors, and icons without using stylesheets.

Tobias Hunger's avatar
Tobias Hunger committed
225
*/