Remmina-debugging.md

Go to the documentation of this file.

# General information

Plugins can have seperate log level options. They have no connection to the Remmina debug window or any environment variables. (Explained below)

More specifically the RDP, GVNC and SSH plugins have options in the connection profile to raise up and/or set the log level.

# Debugging mode

## GUI way
You can just open a debug window inside of Remmina.

- Click on the 3 dots at the top of Remmina.
- Click on 'Debugging'

Just keep that window open and you'll see there will be quite a few debug messages shortly.

## Terminal way
Firstly, you have to be sure that Remmina isn't already running:

- Open a terminal (gnome-terminal, mate-terminal, xterm, alacritty, just to name a few...)

Your desktop environment will surely have a terminal, so you won't have to install one.

```bash
pkill remmina
ps -ef | grep remmina
```

In order to start Remmina in debug mode, we have to tell the underlying library GLib that we want debug messages to be printed into the terminal. For more information, please visit the GLib documentation: https://docs.gtk.org/glib/running.html

- For that we start Remmina with the `environment variables` `G_MESSAGES_PREFIXED` and `G_MESSAGES_DEBUG` both set to `all`.

### Installed through apt-get, yum, pacman, rpm, or compiled with sources.
```bash
G_MESSAGES_PREFIXED=all G_MESSAGES_DEBUG=all remmina
```

# Installed through Flatpak
```bash
G_MESSAGES_PREFIXED=all G_MESSAGES_DEBUG=all flatpak run org.remmina.Remmina
```

# Installed through Snap
```bash
G_MESSAGES_PREFIXED=all G_MESSAGES_DEBUG=all snap run remmina
```

## Remmina crashes

When Remmina crashes we need a backtrace if possible

### gdb backtrace with a distribution provided package

Install the remmina debug symbols if available

```
gdb remmina
```

At the prompt type run, reproduce the crash, and at the prompt type `bt full`

### gdb backtrace on a snap package

You may need to reinstall remmina with `--devmode`

```
snap install --devmode remmina
```

To run gdb:

```
snap run --gdb remmina
``` 

Follow the steps in `gdb backtrace with a distribution provided package`, instead of `run` it will be `cont`

See https://snapcraft.io/docs/using-gdb-gdbserver 

### gdb backtrace on a Flatpak package

```
flatpak --user install org.remmina.Remmina.Debug
flatpak run --command=sh --devel org.remmina.Remmina
gdb /app/bin/remmina
```

At the prompt type run, reproduce the crash, and at the prompt type `bt full`

## Flatpak and Snap package debugging

These packages run in a confined environment, you can get a shell and do some tests, including testing with xfreerdp for instance.

### Flatpak

```
flatpak --user install org.remmina.Remmina.Debug
flatpak run --command=sh --devel org.remmina.Remmina
```

Binaries are installed under `/app/bin`

See https://docs.flatpak.org/en/latest/debugging.html

### Snap

Install remmina in `devmode`

```
snap install --devmode remmina
```

You can execute a shell in the confined environment

```
snap run --shell remmina
```

See https://snapcraft.io/docs/debug-snaps especially the considerations about AppArmor and Secomp 


## RDP Broken pipe

If you get `broken pipe` errors or if you want to check the RDP connection, install `nmap`, and from a terminal test the connectivity


```
nmap -P0 -p 3389 192.168.20.30
```

Replace the IP with the one of your server


It should output:

```
3389/tcp open ms-wbt-server
```

If the system you are using is like a gateway or a tunnel, be sure it's correctly connected to the remote RDP server.

## RDP `Timeout waiting for activation`

In the advanced tab of the RDP connection profile, set an higher timeout, the default is 900 ms, 15000 or 20000 should be anough large for most cases, tune as per your needs.