---
name: "x2goresume-session"
section: "8"
platform: "linux"
package: "x2goserver"
version: "4.1.0.6-1.1+b1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/x2goresume-session"
---

# x2goresume-session(8)

Resume X2Go Session

## NAME

x2goresume-session - Resume X2Go Session

## SYNOPSIS

**x2goresume-session**  *\<session\_id\>*  \\\
                     *\<geometry\>*  \\\
                     *\<link\_quality\>*  \\\
                     *\<nx\_pack\_meth\>*  \\\
                     *\<kblayout\>*  \\\
                     *\<kbtype\>*  \\\
                     *\<setkbd\>*  \\\
                     *\<clipboardmode\>*

## DESCRIPTION

**x2goresume-session** resumes the suspended session with session ID *\<session\_id\>*.

This command is normally issued by an X2Go client application with X2Go user privileges.

## ARGUMENTS

- FC*\<session\_id\>*F\[0\]

  The session ID (or session name) of the suspend session that is to be resumed.

- FC*\<geometry\>*F\[0\]

  Session window size on screen (allowed values: \<width\>x\<height\> or fullscreen).

- FC*\<link\_quality\>*F\[0\]

  Any value out of: modem, isdn, adsl, wan or lan.

- FC*\<nx\_pack\_method\>*F\[0\]

  NX compression method (see below for possible values).

- FC*\<cache\_type+dpi\>*F\[0\]

  Cache type and color depth for X2Go session window. The most common value is: unix-kde-depth\_24 where ,,24'' is the color depth in bit.

- FC*\<kblayout\>*F\[0\]

  Keyboard layout (e.g. us, de, etc.).

- FC*\<kbtype\>*F\[0\]

  Keyboard type/model (e.g. pc105/us).

- FC*\<setkbd\>*F\[0\]

  Force setting keyboard layout and type within the X2Go session on startup. Values: 0 or 1.

- FC*\<clipboardmode\>*F\[0\]

  The session's clipboard mode. Possible values: both, server, client, none. Allows one to configure clipboard security per session via the connecting X2Go client. If the clipboard parameter is set server-side in /etc/x2go/x2goagent.options, then that value will override client-side settings.

## RETURN VALUES

**x2goresume-session** reports to stderr if resuming of session *\<session\_id\>* failed. This very probably means that the session's X agent has died, so the session *\<session\_id\>* will be marked as finished in the X2Go session database.

If everything works out well, a list of session attributes is returned after successful session resumption. Session attributes will be presented on a line-by-line basis:

    field 01: *\<graphics\_port\>*\
     field 02: *\<sound\_port\>*\
     field 03: *\<sshfs\_port\>*\
     field 04: *\<tekictrl\_port\>* (if Telekinesis is available/enabled)\
     field 04: *\<tekidata\_port\>* (if Telekinesis is available/enabled)

As exitcode **x2goresume-session** always returns 0.

## SEE ALSO

[x2gostartagent(8)](/x2gostartagent/8.md), [x2goruncommand(8)](/x2goruncommand/8.md), [x2gosuspend-session(8)](/x2gosuspend-session/8.md), [x2goterminate-session(8)](/x2goterminate-session/8.md)

## AUTHOR

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