Basic Operations

Launching a New Application

On the command line

Launching an application with GammaRay on the command line is similar to tools like valgrind:

gammaray <gammaray-args> <app> <app-args>

This will launch the application with GammaRay attached to it right from the start. The GammaRay arguments allow you to select a different injection method. While the default is suitable for most target applications, the simultaneous use of other tools using the same entry points as GammaRay might require using alternative injection methods for example.

Read more...

With a graphical user interface

Launching applications is also available in the graphical user interface. Launch GammaRay without command line arguments (or use the menu shortcut if you have one), select the Launch tab. There you can select the executable to launch as well as optional command line arguments to pass to it.

Read more...

With Qt Creator

You can launch both local and remote applications from within Qt Creator with GammaRay via Analyze > Start with GammaRay. All environment and application settings are taken from your regular run configuration in Qt Creator.

Read more...

Qt Creator integration is only available in the Qt Automotive Suite.

On an embedded target

If you want to run the GammaRay UI on a different machine, which is commonly the case for embedded targets, you can proceed as described in the command line section above, with the extra --inject-only argument passed to GammaRay. Then follow the instructions below on how to connect to a already running instance.

Attaching to a Running Application

On the command line

Attaching to a running application on the command line is similar to gdb:

gammaray <gammaray-args> --pid <pid>

This will attach GammaRay to the application running with process id <pid>. Keep in mind that this process has to be a Qt application with matching build settings and Qt version for GammaRay to work.

Read more...

With a graphical user interface

Launch GammaRay without command line arguments (or use the menu shortcut if you have one) to bring up the GammaRay UI. It will show you a list of processes GammaRay can attach to, that is, those with the same build settings and Qt version as your GammaRay instance. You'll find the process list on the Attach tab.

Read more...

With Qt Creator

You can attach GammaRay to already locally running applications from within Qt Creator using Analyze > Attach GammaRay to a local running process. Just as when attaching a regular debugger, Qt Creator will open a process selection dialog allowing you to pick which process to attach to.

Read more...

Qt Creator integration is only available in the Qt Automotive Suite.

On an embedded target

If you want to run the GammaRay UI on a different machine, which is commonly the case for embedded targets, you can proceed as described in the command line section above, with the extra --inject-only argument passed to GammaRay. Then follow the instructions below on how to connect to a already running instance.

Connecting to a Running Application

On the command line

Run the following command to connect to a running remote instance:

gammaray --connect tcp://<host>:<port>

Insert the IP address or host name of the target device, and if needed the port number accordingly. The port number can usually be omitted if there's only a single GammaRay instance active on the target. The port number to use is printed on the command line after injection as described above.

Read more...

With a graphical user interface

Launch GammaRay without any command line arguments to get to the launcher UI. Select the Connect tab. Depending on your network setup active targets will be already listed here and can simply be selected from the list. Manual entry of host name or IP address, and if necessary the port number is also possible.

Read more...

With Qt Creator

You can connect to remotely running applications with GammaRay already injected from within Qt Creator using Analyze > Connect GammaRay to a remote running process. Qt Creator will then show all running instances discovered on the local network, as well as an option to manually specify a network address to connect to.

Read more...

Qt Creator integration is only available in the Qt Automotive Suite.

© 2016-2017 Klarälvdalens Datakonsult AB (KDAB). Documentation contributions included herein are the copyrights of their respective owners.
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.