.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "GAMMARAY 1" .TH GAMMARAY 1 2024-04-12 3.0.0 KDAB .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME GammaRay \- Qt\-application inspection and manipulation tool. .SH SYNOPSIS .IX Header "SYNOPSIS" gammaray [\-\-pid | | \-\-connect [:] .SH DESCRIPTION .IX Header "DESCRIPTION" GammaRay inspects runtime internals of a Qt-application, such as: Object tree, properties, signal/slots, widgets, models, graphics views, javascript debugger, resources, state machines, meta types, fonts, codecs, text documents .PP 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). .SH OPTIONS .IX Header "OPTIONS" .IP \fB\-\-help\fR 4 .IX Item "--help" Print help message and exit. .IP \fB\-\-version\fR 4 .IX Item "--version" Print version information and exit. .IP "\fB\-p, \-\-pid " 4 .IX Item "-p, --pid " Attach to running Qt application with the specified pid. .IP "\fB\-i, \-\-injector " 4 .IX Item "-i, --injector " Set the specified injection type. .Sp Supported injectors are: preload (Linux, Mac OS) gdb (Linux. requires gdb to be installed) lldb (Linux. Mac OS, requires lldb to be installed) style windll (Windows) .IP \fB\-\-inprocess\fR 4 .IX Item "--inprocess" Use the Gammaray 1.x in-process UI. This is not necessary in most cases, apart from using tools that do not work remotely. .IP \fB\-\-inject\-only\fR 4 .IX Item "--inject-only" This will only inject the GammaRay probe into a process, but not start the GammaRay UI. This is useful for example when doing remote debugging on embedded devices. .IP "\fB\-\-listen " 4 .IX Item "--listen
" Specify on which network address the GammaRay server should listen, default is GAMMARAY_DEFAULT_ANY_TCP_URL (ie. tcp://0.0.0.0, all of ipv4, use tcp://[::] 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. .IP \fB\-\-no\-listen\fR 4 .IX Item "--no-listen" Disables the GammaRay server. This implies \-\-inprocess as there is no other way to connect to the GammaRay probe in this case. .IP \fB\-\-list\-probes\fR 4 .IX Item "--list-probes" List all installed probes. .IP "\fB\-\-probe " 4 .IX Item "--probe " 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 ABI auto-detection is implemented. .IP "\fB\-\-connect " 4 .IX Item "--connect " Connect to a target with an already injected GammaRay probe. Useful for example for remote debugging. .IP "\fB\-\-self\-test [injector]\fR" 4 .IX Item "--self-test [injector]" Run GammaRay self-tests, if an injector is specified only that specific one will be tested. .Sp The exit code is 0 on success, and 1 otherwise. .SH EXAMPLES .IX Header "EXAMPLES" .ie n .IP "Run gammaray on the Qt-application ""qtfoo"" with command line arguments 'arg1' and 'arg2':" 4 .el .IP "Run gammaray on the Qt-application \f(CWqtfoo\fR with command line arguments 'arg1' and 'arg2':" 4 .IX Item "Run gammaray on the Qt-application qtfoo with command line arguments 'arg1' and 'arg2':" .Vb 1 \& % gammaray /path/to/qtfoo arg1 arg2 .Ve .IP "Invoke gammaray on the Qt-application running with pid 1234:" 4 .IX Item "Invoke gammaray on the Qt-application running with pid 1234:" .Vb 1 \& % gammaray \-\-pid 1234 .Ve .IP "Invoke gammaray on with injector gdb on Qt-application running with pid 1234:" 4 .IX Item "Invoke gammaray on with injector gdb on Qt-application running with pid 1234:" .Vb 1 \& % gammaray \-\-injector gdb \-\-pid 1234 .Ve .SH "EXIT STATUS" .IX Header "EXIT STATUS" Exits with 0 under normal operation; otherwise, exists with a positive integer indicating a problem occurred while launching or attaching an injector. .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (C) 2010\-2023 Klaralvdalens Datakonsult AB, a KDAB Group company, .PP Licensees holding valid commercial KDAB GammaRay licenses may use this file in accordance with GammaRay Commercial License Agreement provided with the Software. .PP Contact info@kdab.com if any conditions of this licensing are not clear to you. .PP This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. .PP You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301, USA. .PP StackWalker code Copyright (c) 2005\-2019, Jochen Kalmbach, All rights reserved. .PP lz4 fast LZ compression code Copyright (C) 2011\-2020, Yann Collet, All rights reserved. .PP backward-cpp code Copyright 2013\-2017 Google Inc. All rights reserved. .SH AUTHORS .IX Header "AUTHORS" .Vb 10 \& Allen Winter \& Andreas Holzammer \& Anton Kreuzkamp \& BogDan Vatra \& Dan Vratil \& David Faure \& Filipe Azevedo \& Frank Osterfeld \& James Turner \& Jan Dalheimer \& Kevin Funk \& Laurent Montel \& Mathias Hasselmann \& Milian Wolff \& Nicolas Arnaud\-Cormos \& Patrick Spendrin \& Peter Kuemmel \& Rafael Roquetto \& Sergio Martins \& Stephen Kelly \& Thomas McGuire \& Till Adam \& Tobias Koenig \& Volker Krause .Ve