---
name: "x2goclient"
section: "1"
platform: "linux"
package: "x2goclient"
version: "4.1.2.3-4"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/x2goclient"
---

# x2goclient(1)

Client application to launch server-side X2Go sessions.

## NAME

x2goclient - Client application to launch server-side X2Go sessions.

## SYNOPSIS

**x2goclient**  \<options\>

## DESCRIPTION

**x2goclient** is a GUI application for launching server-side X2Go sessions.

## HELP AND DEBUG OPTIONS

**x2goclient** has the following help and debugging options:

- FC**--help**F\[0\]

  Show available command line options.

- FC**--help-pack**F\[0\]

  Show available pack methods and exit.

- FC**-v, --version**F\[0\]

  Output X2Go Client version to stderr.

- FC**--debug**F\[0\]

  Enable extensive console output for debugging X2Go Client.

- FC**--changelog**F\[0\]

  Show changelog file.

- FC**--git-info**F\[0\]

  Show Git commit history (not available on all X2Go Client builds).

## GUI OPTIONS

The following options can be used for controlling the GUI behaviour:

- FC**--no-menu**F\[0\]

  Hide menu-/toolbar (default: false).

- FC**--maximize**F\[0\]

  Start client maximized (default: false).

- FC**--hide**F\[0\]

  Hide client (start hidden, default: false).

- FC**--keep-trayicon**F\[0\]

  Always keep the "accelerated X" icon in the system tray. Without this option the default behaviour is: Switch the tray icon to the session's icon on successful session startup/resumption.

- FC**--tray-icon**F\[0\]

  Show tray icon (default: false). This option overrides the global tray icon settings and also forces the tray icon to be shown in hidden X2Go Client mode.

- FC**--hide-foldersharing**F\[0\]

  Hide all elements in X2Go Client GUI that are related to folder sharing.

- FC**--close-disconnect**F\[0\]

  Close X2Go Client after a session got disconnected.

- FC**--client-ssh-port**F\[0\]

  Local ssh port (for filesystem export, default: 22).

- FC**--autostart=\<app\>**F\[0\]

  Launch \<app\> by session start in "published applications" mode. This parameter should go along with --session=\<session-profile-name\>, where the given session profile should be configured as a session profile of type "Published Applications".

- FC**--support-menu=\<html-file\>**F\[0\]

  Add a "Support..." submenu item to X2Go Client's "Help" menu.

  The support information is provided via a simple HTML file. Example:

  ```
          <html><body>
          <h1>IT-Support for X2Go</h1>
          DAS-NETZWERKTEAM | Mike Gabriel:<br />
          <a href="mailto:support@das-netzwerkteam.de">
              support@das-netzwerkteam.de
          </a><br />
          <br />
          Thanks for using X2Go...
          </body></html>
  ```

- FC**--background=\<svg-file\|dir\>**F\[0\]

  Use a custom/branded background image (SVG format) for X2Go Client's main window (i.e. replace the blue gradient area in X2Go Client by some background of your own (business/workgroup/project). If a directory is given, will randomly pick an SVG file inside of it.

- FC**--branding=\<svg-file\>**F\[0\]

  Use a custom icon (SVG format) for additional branding to replace the default in the lower left corner of X2Go Client's main window.

## MISCELLANEOUS OPTIONS

These options change X2Go Client's behavior globally. Some might not be available on all platforms.

- FC**--xserver-start-limit=\<num\>**F\[0\] (Windows-only)

  Limit the X.Org Server start count to at most \<num\> tries. Default: **3**. If **\<num\>** is zero or a negative number, no limit is imposed. The limits for **\<num\>** are platform dependent. If the passed value is out of bounds, X2Go Client falls back to the default value.

## SESSION PROFILE DEFAULTS

You can set certain defaults for session profiles via command line switches using the following options:

- FC**--user**F\[0\]

  Pre-selection of user at client startup (LDAP mode only).

- FC**--command=\<default-command\>**F\[0\]

  Default command for session startup.

- FC**--ssh-port**F\[0\]

  Use this default TCP/IP port for connection (default: 22).

- FC**--ssh-key**F\[0\]

  Use this SSH private key file by default.

- FC**--autologin**F\[0\]

  By default, search for standard SSH key file names or try using an SSH agent.

- FC**--link**F\[0\]

  Set default link type (modem,isdn,adsl,wan or lan, default: adsl).

- FC**--pack**F\[0\]

  Set default pack method (default: '16m-jpeg').

- FC**--quality**F\[0\]

  Set default image quality(0-9, default: 9).

- FC**--set-kbd**F\[0\]

  Overwrite current keyboard settings, no override by default.

- FC**--kbd-layout**F\[0\]

  Set keyboard layout (default: 'de').

- FC**--kbd-type**F\[0\]

  Set keyboard type (default: pc105/us, depend on our clients language setup, though).

- FC**--clipboard=\<both\|client\|server\|none\>**F\[0\]

  Set default clipboard mode.

- FC**--geometry=\<W\>x\<H\>\|fullscreen**F\[0\]

  Set default geometry, default '800x600'.

- FC**--dpi=\<dpi\>**F\[0\]

  set DPI of X2Go Agent to \<dpi\>, default set to same as local display.

- FC**--sound**F\[0\]

  Activate sound for session, not enabled by default.

- FC**--sound-system**F\[0\]

  Which soundsystem to use: arts, esd, pulse (default: pulse).

- FC**--xinerama**F\[0\]

  Use Xinerama by default.

- FC**--session-icon=\<128x128px-icon-png-file\>**F\[0\]

  Use a custom session icon by default.

## THIN CLIENT OPTIONS

The following command line options are primarily interesting if **x2goclient** is used as a login manager on X2Go thin clients.

- FC**--thinclient**F\[0\]

  Let X2Go Client run without window manager.

- FC**--sessionid=\<session-profile-id\>**F\[0\]

  Pre-selection of a session profile (by its session profile ID) at client startup.

- FC**--session=\<session-profile-name\>**F\[0\]

  Pre-selection of a session profile (by its session profile name) at client startup.

- FC**--no-session-edit**F\[0\]

  Disable session editing.

- FC**--pgp-card**F\[0\]

  Use openPGP Card authentication (default: false).

- FC**--external-login=\<smartcard-logins\>**F\[0\]

  Authenticate via SMART card, path to login notification file.

- FC**--add-to-known-hosts**F\[0\]

  Add DSA/RSA host key fingerprint to .ssh/known\_hosts in case of "authenticity of server can't be established".

- FC**--read-exports-from**F\[0\]

  Specifies a directory where some external mechanism (e.g. script) can notify **x2goclient** on new block devices (CD/DVDs, USB sticks, etc.).

- FC**--haltbt**F\[0\]

  Show a "Shutdown" button in the top left corner of X2Go Client. When pressed, X2Go Client will create the file $HOME/.halt. An external script has to watch for this file and trigger a thinclient shutdown once it appears.

## PORTABLE OPTIONS

X2Go Client can be installed on a USB-Flashdrive as a portable applications. If installed that way, the following options support the portable setup of X2Go Client:

- FC**--portable**F\[0\]

  Start X2Go Client in "portable" mode. This implies... (TODO).

- FC**--home=\<dir\>**F\[0\]

  Set the users home directory. This is the directory where X2Go Client will store settings and cache files.

- FC**--session-conf=\<file\>**F\[0\]

  Path to alternative session profile config (default: $HOME/.x2goclient/sessions).

- FC**--clean-all-files**F\[0\]

  In portable mode, X2Go Client removes several directories it has created (and probably directories you don't want to have removed on a normal system):

          *$HOME/.ssh*\
           *$HOME/ssh*\
           *$HOME/.x2go*

  If *--clean-all-files* is used on the command line, also the directory containing the configuration files of X2Go Client gets removed:

          *$HOME/.x2goclient*

## BROKER OPTIONS

In case you want to retrieve **x2goclient** session profiles from an X2Go Session Broker use the following options:

- FC**--broker-url=\<URL\>**F\[0\]

  Specify the \<URL\> of the X2Go Session Broker. X2Go Client can access http:// and ssh:// style URLs.

  Syntax of \<URL\> for HTTP brokerage:

  http(s)://\<user\>:\<password\>@\<hostname\>:\<port\>/path/to/broker

  Syntax of \<URL\> for  SSH brokerage:

  ssh://\<user\>:\<password\>@\<hostname\>:\<port\>/usr/bin/x2gobroker (or any executable that provides the broker via SSH).

- FC**--broker-cacertfile=\</path/to/cafile.crt\>**F\[0\]

  Specify a special (self-signed) root-CACert file that shall get used when connecting to an X2Go Session Broker via https (SSL).

- FC**--broker-noauth**F\[0\]

  The X2Go Session Broker is accessible without authentication.

- FC**--broker-krblogin**F\[0\]

  Login to X2Go Session Broker via GSSAPI. Only supported with ssh:// broker URLs.

- FC**--auth-id=\<USERNAME\>**F\[0\]

  Use this \<USERNAME\> for authenticating against the X2Go Session Broker. This option mostly makes sense together with *--broker-autologin* or *--broker-ssh-key*.

- FC**--broker-autologin**F\[0\]

  For SSH based X2Go Session Brokers. If an SSH agent is available or default key files exist then try those for authentication against the X2Go Session Broker.

- FC**--broker-autologoff**F\[0\]

  Enforce re-authentication against X2Go Session Broker after a session has been suspended or terminated.

- FC**--broker-ssh-key=\<SSHPRIVKEY\>**F\[0\]

  For SSH based X2Go Session Brokers. Full path to a valid SSH private key file.

- FC**--broker-name=\<NAME\>**F\[0\]

  Sets the broker name to display in X2Go Client. This parameter is optional.

- FC**--connectivity-test**F\[0\]

  Run a connectivity test against X2Go Session Broker. Not supported by all broker implementations.

- FC**--change-broker-pass**F\[0\]

  Send a change-password request to an X2Go Session Broker. Not supported by all broker implementations.

- FC**--broker-noauth-with-session-username**F\[0\]

  Informs the broker to use the username you entered for X2Go Server authentication when selecting a server/session. Only has functionality if --broker-noauth is used.

- FC**--broker-use-creds-for-session**F\[0\]

  Use broker credentials as session user/password credentials when using broker mode with broker authentication. Currently only affects direct RDP sessions.

- FC**--broker-logoutbt**F\[0\]

  Show a "Logout" button in the top left corner of X2Go Client. When logged in to a broker, pressing this button X2Go Client lets you login to the broker again.

## LDAP OPTIONS (deprecated)

NOTE: LDAP support won't be continued in X2Go Client 2 (next generation of X2Go Client).

A slightly different approach than X2Go Client's LDAP functionality is available via the X2Go Session Brokerage feature.

In case you want to control **x2goclient** via an LDAP server use the following options:

- FC**--ldap=\<host:port:dn\>**F\[0\]

  Start with LDAP support (disabled by default). Example: --ldap=ldapserver:389:o=organization,c=de

- FC**--ldap1=\<host:port:dn\>**F\[0\]

  Failover LDAP URI No. 1.

- FC**--ldap2=\<host:port:dn\>**F\[0\]

  Failover LDAP URI No. 2.

- FC**--ldap-printing**F\[0\]

  Allow client side printing in LDAP mode.

## AUTHOR

This manual has been written by Mike Gabriel \<mike.gabriel@das-netzwerkteam.de\> for the X2Go project (https://www.x2go.org).