GRDCTL(1)

📦
version 51.0 · 4 versions
, in alpine 3.24, centos-stream 10, nixos 26.05, nixpkgs unstable, ubuntu resolute, ubuntu stonking

💖 GRDCTL(1) — the group chat guide to grdctl 💖

okay so bestie, welcome to grdctl, a User Commands era icon. This is the command line tool for configuring GNOME Remote Desktop, and yes it's giving very much "I'm the main character of your ssh session". Manual page name is GRDCTL(1), and we're gonna walk through it together, no cap. 🫶

✨ SYNOPSIS ✨

grdctl [OPTION...] [COMMAND] [SUBCOMMAND...]

That's the whole vibe. An optional option, an optional command, and then optional subcommands trailing after like your little siblings at the mall. 🛍️

🌸 DESCRIPTION 🌸

grdctl hands you the methods for configuring the GNOME Remote Desktop service. Think of it as the friend who holds your keys — for example, setting credentials. That's literally the job. Setting things up so the remote desktop service knows what's what. 💅

🎀 OPTIONS 🎀

  • --help — shows you the help text. The "hey bestie, here's what you can do" of it all. 🙈

⭐ GENERAL COMMANDS ⭐

  • status — shows the current status. Like checking if your crush is online, except it's your remote desktop backend. 👀

🦋 RDP COMMANDS 🦋

This is the section where everything actually happens, and honestly? Obsessed.

  • rdp enable — turns the RDP backend on. Slay. ✨
  • rdp disable — turns the RDP backend off. Not slay, but sometimes necessary. 😭
  • rdp set-auth-methods AUTH-METHOD... — sets a comma separated list of authentication methods. The available methods are credentials and kerberos. Heads up though: the kerberos method is only supported by the headless and screen share runtime modes, so don't come for it in other modes. And fr fr, at least one auth method must be set — you can't just leave it empty, that's a vibe check you will fail. 💀
  • rdp set-tls-cert TLS-CERT — sets the path to the TLS certificate. Path, bestie. A path. 🍓
  • rdp set-tls-key TLS-KEY — sets the path to the TLS key. 🔑
  • rdp set-kerberos-keytab KERBEROS-KEY-TAB — sets the path to a Kerberos keytab. When it's configured with the kerberos auth method, this keytab gets used for authenticating remote users. Very secure, very demure. 🧚
  • rdp set-credentials USERNAME PASSWORD — sets the username and password credentials. Two arguments, no shortcuts, no "just guess my password". 👑
  • rdp clear-credentials — clears the username and password credentials. Gone. Poof. Clean slate energy. 🌈
  • rdp enable-view-only — disables remote control of input devices. Yeah, the naming goes the other way, I know, I know — this one gets me every time. Read it twice. Enable view-only = no more touching things. 😭
  • rdp disable-view-only — enables remote control of input devices. Again. Opposite direction. We love a chaotic naming convention don't we. 💀
⚠️ ok genuine note bestie: enable-view-only and disable-view-only are named for the view-only state, not for the input devices. So enabling view-only kills input control, and disabling view-only brings it back. Do not let the names gaslight you.

🐛 BUGS 🐛

If something's broken (and it might be, no judgment), the bug tracker can be reached by visiting the website:

https://gitlab.gnome.org/GNOME/gnome-remote-desktop/issues

Before you send that bug report though, please verify that you have the latest version of gnome-remote-desktop. Because bestie — many bugs, major and minor, are fixed at each release, and if yours is out of date, the problem may already have been solved. Don't waste your main character moment reporting a ghost. 👻

💜 cute sign-off 💜

This lil masterpiece comes from GNOME-REMOTE-DESKTOP, dated March 2022, and it lives at GRDCTL(1). Take care of it, take care of your credentials, and remember: at least one auth method. Always. 🫶✨💖

📦 where this page comes from