creator-cli.qdoc 6.63 KB
Newer Older
1 2
/****************************************************************************
**
3
** Copyright (c) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
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 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
    \page creator-cli.html
    \nextpage creator-keyboard-shortcuts.html

    \title Using Command Line Options

    You can start \QC and specify some options from the command line.
    For example, you can open a file to any line.

    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.

    For example:

    \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

57 58 59 60 61 62
    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:

    \c {qtcreator .}

63 64 65 66 67 68 69 70 71
    \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

72 73 74 75
    The following table summarizes the available options:

    \table
        \header
76 77
            \li  Option
            \li  Description
78 79

        \row
80 81
            \li  -help
            \li  Display help on command line options.
82 83

        \row
84 85
            \li  -version
            \li  Display \QC version.
86 87

        \row
88 89
            \li  -client
            \li  Attempt to connect to an already running instance of \QC.
90

Daniel Teske's avatar
Daniel Teske committed
91 92 93 94
       \row
            \li -load <plugin>
            \li Load the specified plugin.

95
        \row
96 97
            \li  -noload <plugin>
            \li  Do not load the specified plugin.
98 99

        \row
100 101
            \li  -profile
            \li  Output plugin start up and shut down profiling data.
102

Leena Miettinen's avatar
Leena Miettinen committed
103 104 105 106 107
       \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.

108
        \row
109 110
            \li  -settingspath <path>
            \li  Override the default path where user settings are stored.
111 112

        \row
113 114
            \li  -color <color>
            \li  Core plugin: override the selected UI color.
115 116

        \row
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
            \li  -debug <pid>
            \li  Debugger plugin: attach to the process with the given process ID.

        \row
            \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.

        \row
            \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.

        \row
            \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.
147 148

        \row
149 150
            \li  -wincrashevent <event-handle>
            \li  Debugger plugin: Attach to crashed processes by using the specified
151 152 153
            event handle.

        \row
154 155
            \li  -customwizard-verbose
            \li  ProjectExplorer plugin: display additional information when loading
156 157 158 159
            custom wizards. For more information about custom wizards, see
            \l{Adding New Custom Wizards}

        \row
160 161
            \li  -lastsession
            \li  ProjectExplorer plugin: load the last session when \QC starts.
162 163 164
            Open the projects and files that were open when you last exited \QC.
            For more information about managing sessions, see \l{Managing Sessions}.

Leena Miettinen's avatar
Leena Miettinen committed
165 166 167 168
        \row
            \li -block
            \li Open files in editors in a running \QC instance and block the
                command line until the first editor is closed.
169 170
    \endtable

171 172
    \section1 Using Custom Styles

173
    \QC is a \l{QApplication}
174 175 176
    {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
177
    \l{QApplication#stylesheet}{stylesheets}.
178 179 180 181 182 183 184
    The styling is only applied during the current session.

    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.

185
    */