creator-cli.qdoc 4.79 KB
Newer Older
1 2
/****************************************************************************
**
3
** Copyright (c) 2013 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 26
**
**
** 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
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
    The following table summarizes the available options:

    \table
        \header
67 68
            \li  Option
            \li  Description
69 70

        \row
71 72
            \li  -help
            \li  Display help on command line options.
73 74

        \row
75 76
            \li  -version
            \li  Display \QC version.
77 78

        \row
79 80
            \li  -client
            \li  Attempt to connect to an already running instance of \QC.
81

Daniel Teske's avatar
Daniel Teske committed
82 83 84 85
       \row
            \li -load <plugin>
            \li Load the specified plugin.

86
        \row
87 88
            \li  -noload <plugin>
            \li  Do not load the specified plugin.
89 90

        \row
91 92
            \li  -profile
            \li  Output plugin start up and shut down profiling data.
93 94

        \row
95 96
            \li  -settingspath <path>
            \li  Override the default path where user settings are stored.
97 98

        \row
99 100
            \li  -color <color>
            \li  Core plugin: override the selected UI color.
101 102

        \row
103 104
            \li  -debug <PID-or-corefile>
            \li  Debugger plugin: attach to process ID or core file.
105 106

        \row
107 108
            \li  -wincrashevent <event-handle>
            \li  Debugger plugin: Attach to crashed processes by using the specified
109 110 111
            event handle.

        \row
112 113
            \li  -customwizard-verbose
            \li  ProjectExplorer plugin: display additional information when loading
114 115 116 117
            custom wizards. For more information about custom wizards, see
            \l{Adding New Custom Wizards}

        \row
118 119
            \li  -lastsession
            \li  ProjectExplorer plugin: load the last session when \QC starts.
120 121 122
            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
123 124 125 126
        \row
            \li -block
            \li Open files in editors in a running \QC instance and block the
                command line until the first editor is closed.
127 128
    \endtable

129 130 131 132 133 134 135 136 137 138 139 140 141 142
    \section1 Using Custom Styles

    \QC is a \l{http://qt-project.org/doc/qt-5.0/qtwidgets/qapplication.html#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{http://qt-project.org/doc/qt-5.0/qtwidgets/stylesheet.html}{stylesheets}.
    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.

143
    */