269 lines
8.8 KiB
HTML
269 lines
8.8 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of GAMMARAY</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>GAMMARAY</H1>
|
|
Section: KDAB (1)<BR>Updated: 2020-04-11<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
GammaRay - Qt-application inspection and manipulation tool.
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
|
|
|
|
gammaray [--pid <pid> | <application> <args> | --connect <host>[:<port>]
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
|
|
|
|
GammaRay inspects runtime internals of a Qt-application, such as:
|
|
<BR> Object tree, properties, signal/slots, widgets, models,
|
|
<BR> graphics views, javascript debugger, resources,
|
|
<BR> state machines, meta types, fonts, codecs, text documents
|
|
<P>
|
|
|
|
When run without any options, gammaray will present a list of running
|
|
Qt-applications from which you can attach the selected injector.
|
|
Else, you can attach to a running process by specifying its pid,
|
|
or you can start a new Qt-application by specifying its name
|
|
(and optional arguments).
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>--help</B><DD>
|
|
|
|
|
|
Print help message and exit.
|
|
<DT id="2"><B>--version</B><DD>
|
|
|
|
|
|
Print version information and exit.
|
|
<DT id="3"><B>-p, --pid <pid</B>><DD>
|
|
|
|
|
|
Attach to running Qt application with the specified pid.
|
|
<DT id="4"><B>-i, --injector <injector</B>><DD>
|
|
|
|
|
|
Set the specified injection type.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Supported injectors are:
|
|
<BR> preload (Linux, Mac <FONT SIZE="-1">OS</FONT>)
|
|
<BR> gdb (Linux. requires gdb to be installed)
|
|
<BR> lldb (Linux. Mac <FONT SIZE="-1">OS,</FONT> requires lldb to be installed)
|
|
<BR> style
|
|
<BR> windll (Windows)
|
|
<DT id="5"><B>--inprocess</B><DD>
|
|
|
|
|
|
Use the Gammaray 1.x in-process <FONT SIZE="-1">UI.</FONT> This is not necessary in most cases,
|
|
apart from using tools that do not work remotely.
|
|
<DT id="6"><B>--inject-only</B><DD>
|
|
|
|
|
|
This will only inject the GammaRay probe into a process, but not start
|
|
the GammaRay <FONT SIZE="-1">UI.</FONT> This is useful for example when doing remote debugging
|
|
on embedded devices.
|
|
<DT id="7"><B>--listen <address</B>><DD>
|
|
|
|
|
|
Specify on which network address the GammaRay server should listen,
|
|
default is <FONT SIZE="-1">GAMMARAY_DEFAULT_ANY_TCP_URL</FONT> (ie. <A HREF="tcp://0.0.0.0,">tcp://0.0.0.0,</A> all of ipv4,
|
|
use <A HREF="tcp://[::]">tcp://[::]</A> for all ipv6). This can be used for example on Windows to
|
|
avoid firewall warnings by setting the address to 127.0.0.1 if you don't
|
|
need remote access.
|
|
<DT id="8"><B>--no-listen</B><DD>
|
|
|
|
|
|
Disables the GammaRay server. This implies --inprocess as there is no
|
|
other way to connect to the GammaRay probe in this case.
|
|
<DT id="9"><B>--list-probes</B><DD>
|
|
|
|
|
|
List all installed probes.
|
|
<DT id="10"><B>--probe <abi</B>><DD>
|
|
|
|
|
|
Explicitly specify which probe to use. You should use this if you have
|
|
more than one probe installed (e.g. one for Qt4 and one for Qt5), until
|
|
probe <FONT SIZE="-1">ABI</FONT> auto-detection is implemented.
|
|
<DT id="11"><B>--connect <host</B>[:port]><DD>
|
|
|
|
|
|
Connect to a target with an already injected GammaRay probe. Useful for
|
|
example for remote debugging.
|
|
<DT id="12"><B>--self-test [injector]</B><DD>
|
|
|
|
|
|
Run GammaRay self-tests, if an injector is specified only that specific
|
|
one will be tested.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
The exit code is 0 on success, and 1 otherwise.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>EXAMPLES</H2>
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="13">Run gammaray on the Qt-application "qtfoo" with command line arguments 'arg1' and 'arg2':<DD>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
% gammaray /path/to/qtfoo arg1 arg2
|
|
|
|
</PRE>
|
|
|
|
|
|
<DT id="14">Invoke gammaray on the Qt-application running with pid 1234:<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
% gammaray --pid 1234
|
|
|
|
</PRE>
|
|
|
|
|
|
<DT id="15">Invoke gammaray on with injector gdb on Qt-application running with pid 1234:<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
% gammaray --injector gdb --pid 1234
|
|
|
|
</PRE>
|
|
|
|
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>EXIT STATUS</H2>
|
|
|
|
|
|
|
|
Exits with 0 under normal operation; otherwise, exists with a positive integer
|
|
indicating a problem occurred while launching or attaching an injector.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>COPYRIGHT</H2>
|
|
|
|
|
|
|
|
Copyright (C) 2010-2019 Klaralvdalens Datakonsult <FONT SIZE="-1">AB,</FONT> a <FONT SIZE="-1">KDAB</FONT> Group company, <<A HREF="mailto:info@kdab.com">info@kdab.com</A>>
|
|
<P>
|
|
|
|
Licensees holding valid commercial <FONT SIZE="-1">KDAB</FONT> GammaRay licenses may use this file in
|
|
accordance with GammaRay Commercial License Agreement provided with the Software.
|
|
<P>
|
|
|
|
Contact <A HREF="mailto:info@kdab.com">info@kdab.com</A> if any conditions of this licensing are not clear to you.
|
|
<P>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the <FONT SIZE="-1">GNU</FONT> General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
<P>
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but <FONT SIZE="-1">WITHOUT ANY WARRANTY</FONT>; without even the implied warranty of
|
|
<FONT SIZE="-1">MERCHANTABILITY</FONT> or <FONT SIZE="-1">FITNESS FOR A PARTICULAR PURPOSE.</FONT> See the
|
|
<FONT SIZE="-1">GNU</FONT> General Public License for more details.
|
|
<P>
|
|
|
|
You should have received a copy of the <FONT SIZE="-1">GNU</FONT> General Public License along
|
|
with this program; if not, write to the Free Software Foundation, Inc.,
|
|
51 Franklin Street, Fifth Floor, Boston, <FONT SIZE="-1">MA</FONT> 02110-1301, <FONT SIZE="-1">USA.</FONT>
|
|
<P>
|
|
|
|
StackWalker code Copyright (c) 2005-2009, Jochen Kalmbach, All rights reserved.
|
|
<P>
|
|
|
|
lz4 fast <FONT SIZE="-1">LZ</FONT> compression code Copyright (C) 2011-2015, Yann Collet, All rights reserved.
|
|
<P>
|
|
|
|
Backward-cpp code Copyright 2013 Google Inc. All rights reserved.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>AUTHORS</H2>
|
|
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
Allen Winter <<A HREF="mailto:allen.winter@kdab.com">allen.winter@kdab.com</A>>
|
|
Andreas Holzammer <<A HREF="mailto:andreas.holzammer@kdab.com">andreas.holzammer@kdab.com</A>>
|
|
Anton Kreuzkamp <<A HREF="mailto:anton.kreuzkamp@kdab.com">anton.kreuzkamp@kdab.com</A>>
|
|
BogDan Vatra <<A HREF="mailto:bogdan.vatra@kdab.com">bogdan.vatra@kdab.com</A>>
|
|
Dan Vratil <<A HREF="mailto:dvratil@redhat.com">dvratil@redhat.com</A>>
|
|
David Faure <<A HREF="mailto:david.faure@kdab.com">david.faure@kdab.com</A>>
|
|
Filipe Azevedo <<A HREF="mailto:filipe.azevedo@kdab.com">filipe.azevedo@kdab.com</A>>
|
|
Frank Osterfeld <<A HREF="mailto:frank.osterfeld@kdab.com">frank.osterfeld@kdab.com</A>>
|
|
James Turner <<A HREF="mailto:james.turner@kdab.com">james.turner@kdab.com</A>>
|
|
Jan Dalheimer <<A HREF="mailto:jan.dalheimer@kdab.com">jan.dalheimer@kdab.com</A>>
|
|
Kevin Funk <<A HREF="mailto:kevin.funk@kdab.com">kevin.funk@kdab.com</A>>
|
|
Laurent Montel <<A HREF="mailto:laurent.montel@kdab.com">laurent.montel@kdab.com</A>>
|
|
Mathias Hasselmann <<A HREF="mailto:mathias.hasselmann@kdab.com">mathias.hasselmann@kdab.com</A>>
|
|
Milian Wolff <<A HREF="mailto:milian.wolff@kdab.com">milian.wolff@kdab.com</A>>
|
|
Nicolas Arnaud-Cormos <<A HREF="mailto:nicolas.arnaud-cormos@kdab.com">nicolas.arnaud-cormos@kdab.com</A>>
|
|
Patrick Spendrin <<A HREF="mailto:patrick.spendrin@kdab.com">patrick.spendrin@kdab.com</A>>
|
|
Peter Kuemmel <<A HREF="mailto:syntheticpp@gmx.net">syntheticpp@gmx.net</A>>
|
|
Rafael Roquetto <<A HREF="mailto:rafael.roquetto@kdab.com">rafael.roquetto@kdab.com</A>>
|
|
Sergio Martins <<A HREF="mailto:sergio.martins@kdab.com">sergio.martins@kdab.com</A>>
|
|
Stephen Kelly <<A HREF="mailto:stephen.kelly@kdab.com">stephen.kelly@kdab.com</A>>
|
|
Thomas McGuire <<A HREF="mailto:thomas.mcguire@kdab.com">thomas.mcguire@kdab.com</A>>
|
|
Till Adam <<A HREF="mailto:till.adam@kdab.com">till.adam@kdab.com</A>>
|
|
Tobias Koenig <<A HREF="mailto:tobias.koenig@kdab.com">tobias.koenig@kdab.com</A>>
|
|
Volker Krause <<A HREF="mailto:volker.krause@kdab.com">volker.krause@kdab.com</A>>
|
|
|
|
</PRE>
|
|
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="16"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="17"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="18"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="19"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="20"><A HREF="#lbAF">EXAMPLES</A><DD>
|
|
<DT id="21"><A HREF="#lbAG">EXIT STATUS</A><DD>
|
|
<DT id="22"><A HREF="#lbAH">COPYRIGHT</A><DD>
|
|
<DT id="23"><A HREF="#lbAI">AUTHORS</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:12 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|