x2gostartagent(8)

📦
version 4.1.0.6 · 3 versions
, in alpine 3.24, debian trixie, fedora 43, fedora 44, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ x2gostartagent(8) ✨

okay bestie, this is the manual page for x2gostartagent, part of the X2Go Server Tool lineup 💜. It's the lil icon that kicks off a whole new X2Go session, and I'm gonna walk you through every single thing it wants from you. No skips, no shortcuts, we're doing the whole thing 🎀

🌸 NAME 🌸

x2gostartagent — start a new X2Go session, bestie. That's it. That's the job 💅

🦋 SYNOPSIS 🦋

x2gostartagent <geometry>  \
                <link_quality>  \
                <nx_pack_meth>  \
                <cache_type+dpi>  \
                <kblayout>  \
                <kbtype>  \
                <setkbd>  \
                <session_type>  \
                <command>  \
                <clipboardmode>  \

Look at all those arguments. Every single one is obligatory, so no ghosting any of them 🙈

💖 DESCRIPTION 💖

x2gostartagent is the main character of session startup — it coordinates the whole process of bringing a brand new X2Go session into existence 🫶

It expects quite a list of parameters, and ngl, all of them are obligatory. No optional lil treats here, you bring the full set or nothing.

It runs with X2Go user privileges, and normally it's an X2Go client application that executes it. So like, your client is the one calling it up, not you personally (though you can).

✨ ARGUMENTS ✨

  • <geometry> — how big the session window is on screen. Allowed values are <width>x<height> or fullscreen. Pick your size, slay 💅
  • <link_quality> — any value out of: modem, isdn, adsl, wan or lan. It's giving "how good is your internet, be honest" 🌈
  • <nx_pack_method> — the NX compression method. Peep the list further down for the possible values, there's a lot of them, it's lowkey iconic 📦
  • <cache_type+dpi> — the cache type and color depth for the X2Go session window. The most common value is unix-kde-depth_24 where the 24 is the color depth in bits. Yes the ,,24'' thing is them being fancy about the quotes, we move on 💀
  • <kblayout> — keyboard layout (e.g. us, de, etc.). Where your fingers think they are ⌨️
  • <kbtype> — keyboard type/model (e.g. pc105/us). Your actual physical keyboard vibe.
  • <setkbd> — force setting the keyboard layout and type within the X2Go session on startup. Values: 0 or 1. It's a yes/no bestie, pick one 🙈
  • <session_type> — allowed values are: D (desktop), R (rootless) or S (shadow session, X2Go desktop sharing). Pick your fighter 🎮
  • <command> — here's the tea ☕: the command you pass here is only used to create the session ID for this new X2Go session. The actual execution of a command? That's x2goruncommand's job, not this one's. So don't expect this arg to run anything, it's just out here generating an ID and looking cute ✨
  • <clipboardmode> — the session's clipboard mode. Possible values: both, server, client, none. It lets you configure clipboard security per session via the connecting X2Go client 📋. And heads up: if the clipboard parameter is set server-side in /etc/x2go/x2goagent.options, then that value will override client-side settings. Server said what it said, periodt.

🎀 RETURN VALUES 🎀

Once the session starts up successfully, you get a whole list of session attributes back, presented line-by-line like the lil receipts they are 🧾

field 01: <X_display_number>
field 02: <session_cookie_hash>
field 03: <agent_pid>
field 04: <session_id>
field 05: <graphics_port>
field 06: <sound_port>
field 07: <sshfs_port>
field 08: <tekictrl_port> (if Telekinesis is available/enabled)
field 09: <tekidata_port> (if Telekinesis is available/enabled)

Nine fields when Telekinesis is in the building, seven when it's not. Obsessed with a structured output ngl 💖

🌈 NX COMPRESSION METHODS 🌈

So as NX compression methods (that's your <link-quality> argument bestie, yes the manpage says <link-quality> with a dash, we keep it exactly as written 💅), these are the possible values. And the important bit: the % character must be replaced by a digit 0-9 ✨

  • nopack
  • 8
  • 64
  • 256
  • 512
  • 4k
  • 32k
  • 64k
  • 256k
  • 2m
  • 16m
  • 256-rdp
  • 256-rdp-compressed
  • 32k-rdp
  • 32k-rdp-compressed
  • 64k-rdp
  • 64k-rdp-compressed
  • 16m-rdp
  • 16m-rdp-compressed
  • rfb-hextile
  • rfb-tight
  • rfb-tight-compressed
  • 8-tight
  • 64-tight
  • 256-tight
  • 512-tight
  • 4k-tight
  • 32k-tight
  • 64k-tight
  • 256k-tight
  • 2m-tight
  • 16m-tight
  • 8-jpeg-%
  • 64-jpeg
  • 256-jpeg
  • 512-jpeg
  • 4k-jpeg
  • 32k-jpeg
  • 64k-jpeg
  • 256k-jpeg
  • 2m-jpeg
  • 16m-jpeg-%
  • 8-png-jpeg-%
  • 64-png-jpeg
  • 256-png-jpeg
  • 512-png-jpeg
  • 4k-png-jpeg
  • 32k-png-jpeg
  • 64k-png-jpeg
  • 256k-png-jpeg
  • 2m-png-jpeg
  • 16m-png-jpeg-%
  • 8-png-%
  • 64-png
  • 256-png
  • 512-png
  • 4k-png
  • 32k-png
  • 64k-png
  • 256k-png
  • 2m-png
  • 16m-png-%
  • 16m-rgb-%
  • 16m-rle-%

That's the whole roster, every single one. Ate and left no crumbs 🔥

💜 SEE ALSO 💜

Go read these next, they're the rest of the friend group:

👑 AUTHOR 👑

This manual was written by Mike Gabriel <mike.gabriel@das-netzwerkteam.de> for the X2Go project (https://www.x2go.org). Giving credit where credit is due, we love to see it 🫶

and that's the page bestie!! 🌟 this is Version 4.1.0.6, dated Aug 2023, and it's the x2gostartagent(8) manual page you just read — thanks for making it to the end, you're the real main character 💖✨🎀

📦 where this page comes from