1GAMMARAY(1)                          KDAB                          GAMMARAY(1)
2
3
4

NAME

6       GammaRay - Qt-application inspection and manipulation tool.
7

SYNOPSIS

9       gammaray [--pid <pid> | <application> <args> | --connect
10       <host>[:<port>]
11

DESCRIPTION

13       GammaRay inspects runtime internals of a Qt-application, such as:
14           Object tree, properties, signal/slots, widgets, models,
15           graphics views, javascript debugger, resources,
16           state machines, meta types, fonts, codecs, text documents
17
18       When run without any options, gammaray will present a list of running
19       Qt-applications from which you can attach the selected injector.  Else,
20       you can attach to a running process by specifying its pid, or you can
21       start a new Qt-application by specifying its name (and optional
22       arguments).
23

OPTIONS

25       --help
26           Print help message and exit.
27
28       --version
29           Print version information and exit.
30
31       -p, --pid <pid>
32           Attach to running Qt application with the specified pid.
33
34       -i, --injector <injector>
35           Set the specified injection type.
36
37           Supported injectors are:
38                preload (Linux, Mac OS)
39                gdb (Linux. requires gdb to be installed)
40                lldb (Linux. Mac OS, requires lldb to be installed)
41                style
42                windll (Windows)
43
44       --inprocess
45           Use the Gammaray 1.x in-process UI. This is not necessary in most
46           cases, apart from using tools that do not work remotely.
47
48       --inject-only
49           This will only inject the GammaRay probe into a process, but not
50           start the GammaRay UI. This is useful for example when doing remote
51           debugging on embedded devices.
52
53       --listen <address>
54           Specify on which network address the GammaRay server should listen,
55           default is GAMMARAY_DEFAULT_ANY_TCP_URL (ie. tcp://0.0.0.0, all of
56           ipv4, use tcp://[::] for all ipv6). This can be used for example on
57           Windows to avoid firewall warnings by setting the address to
58           127.0.0.1 if you don't need remote access.
59
60       --no-listen
61           Disables the GammaRay server. This implies --inprocess as there is
62           no other way to connect to the GammaRay probe in this case.
63
64       --list-probes
65           List all installed probes.
66
67       --probe <abi>
68           Explicitly specify which probe to use. You should use this if you
69           have more than one probe installed (e.g. one for Qt4 and one for
70           Qt5), until probe ABI auto-detection is implemented.
71
72       --connect <host[:port]>
73           Connect to a target with an already injected GammaRay probe. Useful
74           for example for remote debugging.
75
76       --self-test [injector]
77           Run GammaRay self-tests, if an injector is specified only that
78           specific one will be tested.
79
80           The exit code is 0 on success, and 1 otherwise.
81

EXAMPLES

83       Run gammaray on the Qt-application "qtfoo" with command line arguments
84       'arg1' and 'arg2':
85            % gammaray /path/to/qtfoo arg1 arg2
86
87       Invoke gammaray on the Qt-application running with pid 1234:
88            % gammaray --pid 1234
89
90       Invoke gammaray on with injector gdb on Qt-application running with pid
91       1234:
92            % gammaray --injector gdb --pid 1234
93

EXIT STATUS

95       Exits with 0 under normal operation; otherwise, exists with a positive
96       integer indicating a problem occurred while launching or attaching an
97       injector.
98
100       Copyright (C) 2010-2021 Klaralvdalens Datakonsult AB, a KDAB Group
101       company, <info@kdab.com>
102
103       Licensees holding valid commercial KDAB GammaRay licenses may use this
104       file in accordance with GammaRay Commercial License Agreement provided
105       with the Software.
106
107       Contact info@kdab.com if any conditions of this licensing are not clear
108       to you.
109
110       This program is free software; you can redistribute it and/or modify it
111       under the terms of the GNU General Public License as published by the
112       Free Software Foundation; either version 2 of the License, or (at your
113       option) any later version.
114
115       This program is distributed in the hope that it will be useful, but
116       WITHOUT ANY WARRANTY; without even the implied warranty of
117       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
118       General Public License for more details.
119
120       You should have received a copy of the GNU General Public License along
121       with this program; if not, write to the Free Software Foundation, Inc.,
122       51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
123
124       StackWalker code Copyright (c) 2005-2019, Jochen Kalmbach, All rights
125       reserved.
126
127       lz4 fast LZ compression code Copyright (C) 2011-2015, Yann Collet, All
128       rights reserved.
129
130       backward-cpp code Copyright 2013-2017 Google Inc. All rights reserved.
131

AUTHORS

133        Allen Winter <allen.winter@kdab.com>
134        Andreas Holzammer <andreas.holzammer@kdab.com>
135        Anton Kreuzkamp <anton.kreuzkamp@kdab.com>
136        BogDan Vatra <bogdan.vatra@kdab.com>
137        Dan Vratil <dvratil@redhat.com>
138        David Faure <david.faure@kdab.com>
139        Filipe Azevedo <filipe.azevedo@kdab.com>
140        Frank Osterfeld <frank.osterfeld@kdab.com>
141        James Turner <james.turner@kdab.com>
142        Jan Dalheimer <jan.dalheimer@kdab.com>
143        Kevin Funk <kevin.funk@kdab.com>
144        Laurent Montel <laurent.montel@kdab.com>
145        Mathias Hasselmann <mathias.hasselmann@kdab.com>
146        Milian Wolff <milian.wolff@kdab.com>
147        Nicolas Arnaud-Cormos <nicolas.arnaud-cormos@kdab.com>
148        Patrick Spendrin <patrick.spendrin@kdab.com>
149        Peter Kuemmel <syntheticpp@gmx.net>
150        Rafael Roquetto <rafael.roquetto@kdab.com>
151        Sergio Martins <sergio.martins@kdab.com>
152        Stephen Kelly <stephen.kelly@kdab.com>
153        Thomas McGuire <thomas.mcguire@kdab.com>
154        Till Adam <till.adam@kdab.com>
155        Tobias Koenig <tobias.koenig@kdab.com>
156        Volker Krause <volker.krause@kdab.com>
157
158
159
1602.11.3                            2023-10-09                       GAMMARAY(1)
Impressum