gammaray.pod

   1 =head1 NAME
   2
   3 GammaRay - Qt-application inspection and manipulation tool.
   4
   5 =head1 SYNOPSIS
   6
   7 gammaray [--injector <injector>] [--pid <pid> | <application> <args>]
   8
   9
  10 =head1 DESCRIPTION
  11
  12 GammaRay inspects runtime internals of a Qt-application, such as:
  13     Object tree, properties, signal/slots, widgets, models,
  14     graphics views, javascript debugger, resources,
  15     state machines, meta types, fonts, codecs, text documents
  16
  17 When run without any options, gammaray will present a list of running
  18 Qt-applications from which you can attach the selected injector.
  19 Else, you can attach to a running process by specifying its pid,
  20 or you can start a new Qt-application by specifying its name
  21 (and optional arguments).
  22
  23 =head1 OPTIONS
  24
  25 =over 4
  26
  27 =item B<--help>
  28
  29 Print help message and exit.
  30
  31 =item B<--version>
  32
  33 Print version information and exit.
  34
  35 =item B<-p, --pid <pid>>
  36
  37 Attach to running Qt application with the specified pid.
  38
  39 =item B<-i, --injector <injector>>
  40
  41 Set the specified injection type.
  42
  43 Supported injectors are:
  44      preload (Linux, Mac OS)
  45      gdb (Linux. requires gdb to be installed)
  46      style
  47      windll (Windows)
  48
  49 =back
  50
  51 =head1 EXAMPLES
  52
  53 =over 4
  54
  55 =item Run gammaray on the Qt-application C<qtfoo> with command line arguments
  56 'arg1' and 'arg2':
  57
  58  % gammaray /path/to/qtfoo arg1 arg2
  59
  60 =item Invoke gammaray on the Qt-application running with pid 1234:
  61
  62  % gammaray --pid 1234
  63
  64 =item Invoke gammaray on with injector gdb on Qt-application running with pid 1234:
  65
  66  % gammaray --injector gdb --pid 1234
  67
  68 =back
  69
  70 =head1 EXIT STATUS
  71
  72 Exits with 0 under normal operation; otherwise, exists with a positive integer
  73 indicating a problem occurred while launching or attaching an injector.
  74
  75 =head1 COPYRIGHT
  76
  77 Copyright (C) 2010-2011 Klaralvdalens Datakonsult AB, a KDAB Group company, <info@kdab.com>
  78
  79 This program is free software; you can redistribute it and/or modify
  80 it under the terms of the GNU General Public License as published by
  81 the Free Software Foundation; either version 2 of the License, or
  82 (at your option) any later version.
  83
  84 This program is distributed in the hope that it will be useful,
  85 but WITHOUT ANY WARRANTY; without even the implied warranty of
  86 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  87 GNU General Public License for more details.
  88
  89 You should have received a copy of the GNU General Public License along
  90 with this program; if not, write to the Free Software Foundation, Inc.,
  91 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  92
  93 =head1 AUTHORS
  94
  95  Volker Krause <volker.krause@kdab.com> (Head Engineer)
  96  Allen Winter <allen.winter@kdab.com>
  97  Andreas Holzammer <andreas.holzammer@kdab.com>
  98  David Faure <david.faure@kdab.com>
  99  Kevin Funk <kevin.funk@kdab.com>
 100  Milian Wolff <milian.wolff@kdab.com>
 101  Patrick Spendrin <patrick.spendrin@kdab.com>
 102  Stephen Kelly <stephen.kelly@kdab.com>
 103  Till Adam <till@kdab.com>
 104  Tobias Koenig <tobias.koenig@kdab.com>
 105
 106 =cut