Capturing a screenshot of the GDM login screen

These days GDM on Debian is running using Wayland, so the classic way of taking a screenshot using the X protocol does not work:

# Sleeping before launching the command allows to switch to the login screen
# before the screen gets actually captured.
# Otherwise if the login screen is not visible, only a black image will be
# captured.
sleep 6

sudo -u Debian-gdm\
  DISPLAY=:0 \
  XAUTHORITY=/var/run/user/109/gdm/Xauthority \
  import -display :0 -win root /tmp/GDM-screenshot.png"

Capturing the screen of the Xwayland instance, which uses the display name :1024, does not work either.

From what I read Wayland does not have a standardized way to let clients access the content of the whole screen, probably for security reasons, instead compositors (or toolkits acting as compositors) are left with the choice to provide a mechanism for that themselves.

The Wayland reference compositor, named Weston, provides a “screenshooter” interface, and some software like VLC can use it to capture the screen, but the Gtk+ wayland backend does not provide such a protocol, and so capturing a screenshot of gnome-shell —which GDM is based on— is not possible using the wayland client API.

However gnome-shell can still capture the whole screen using the toolkit functions, and it exposes this functionality via DBus under the org.gnome.Shell.Screenshot interface.

So a screenshot of gnome-shell can be captured with a script like this:


set -e


# Under Debian GDM is executed as the Debian-gdm user.
# On other distributions you'll need to adjust the value.

GNOME_SHELL_PID=$(pgrep -U $USERNAME gnome-shell)

# The tr command at the end is to strip the trailing NUL byte, which can cause
# some shells to emit a warning like:
#   bash: warning: command substitution: ignored null byte in input
DBUS_ADDRESS_ENV=$(sudo -u $USERNAME grep -z DBUS_SESSION_BUS_ADDRESS /proc/$GNOME_SHELL_PID/environ | tr -d '\0')

  dbus-send --type=method_call --print-reply \
    --dest=org.gnome.Shell.Screenshot \
    /org/gnome/Shell/Screenshot \
    org.gnome.Shell.Screenshot.Screenshot boolean:true boolean:false string:$OUTPUT_FILE

However this is still not enough for GDM, the DBus method returns always false with the default GDM config.

This happens because saving files to the disk is forbidden by default:

$ sudo -u Debian-gdm DCONF_PROFILE=gdm gsettings get org.gnome.desktop.lockdown disable-save-to-disk

Setting the GSetting key to false interactively does not work because the key is marked as read-only.

It is necessary to change the value in the configuration file /etc/gdm3/greeter.dconf-defaults, by adding these two lines:


After that, and after a restart, it is possible to capture screenshots of the GDM login screen using the DBus interface.

CommentsSyndicate content

Great! I've searched a whole

CWHuang's picture

Great! I've searched a whole day to find a way to capture screenshots of gdm3 login but no luck!
Finally your script just works! Thank you so much!
PS. I'm testing on Ubuntu 20.04.

Ah, I am glad to hear it was

ao2's picture

Ah, I am glad to hear it was useful.

Thanks for letting me know.

Post new comment

The content of this field is kept private and will not be shown publicly. If you have a Gravatar account associated with the e-mail address you provide, it will be used to display your avatar.
  • Web page addresses and e-mail addresses turn into links automatically.
  • Allowed HTML tags: <a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd>
  • Lines and paragraphs break automatically.

More information about formatting options

This question is for testing whether you are a human visitor and to prevent automated spam submissions.
Enter the code without spaces.