1x2gostartagent(8) X2Go Server Tool x2gostartagent(8)
2
6 x2gostartagent - Start a New X2Go Session
7
9 x2gostartagent <geometry> \
10 <link_quality> \
11 <nx_pack_meth> \
12 <cache_type+dpi> \
13 <kblayout> \
14 <kbtype> \
15 <setkbd> \
16 <session_type> \
17 <command> \
18 <clipboardmode> \
19
22 x2gostartagent coordinates the startup process of a new X2Go session.
23 It expects quite a list of parameters, all of which are obligatory.
24 x2gostartagent is run with X2Go user privileges and normally executed
26 by an X2Go client application.
27
29 <geometry>
30 Session window size on screen (allowed values: <width>x<height>
31 or fullscreen).
32 <link_quality>
34 Any value out of: modem, isdn, adsl, wan or lan.
35 <nx_pack_method>
37 NX compression method (see below for possible values).
38 <cache_type+dpi>
40 Cache type and color depth for X2Go session window. The most
41 common value is: unix-kde-depth_24 where ,,24'' is the color
42 depth in bit.
43 <kblayout>
45 Keyboard layout (e.g. us, de, etc.).
46 <kbtype>
48 Keyboard type/model (e.g. pc105/us).
49 <setkbd>
51 Force setting keyboard layout and type within the X2Go session
52 on startup. Values: 0 or 1.
53 <session_type>
55 Allowed values for <session_type> are: D (desktop), R (rootless)
56 or S (shadow session, X2Go desktop sharing).
57 <command>
59 The command given by the <command> argument is only used to
60 create the session ID for this new X2Go session. The actual
61 execution of a command is handled by x2goruncommand.
62 <clipboardmode>
64 The session's clipboard mode. Possible values: both, server,
65 client, none. Allows one to configure clipboard security per
66 session via the connecting X2Go client. If the clipboard
67 parameter is set server-side in /etc/x2go/x2goagent.options,
68 then that value will override client-side settings.
69
71 A list of session attributes is returned after successful session
72 startup. Session attributes will be presented on a line-by-line basis:
73 field 01: <X_display_number>
75 field 02: <session_cookie_hash>
76 field 03: <agent_pid>
77 field 04: <session_id>
78 field 05: <graphics_port>
79 field 06: <sound_port>
80 field 07: <sshfs_port>
81 field 08: <tekictrl_port> (if Telekinesis is available/enabled)
82 field 09: <tekidata_port> (if Telekinesis is available/enabled)
83
86 As NX compression methods (<link-quality> argument) the following
87 values are possible. The % character must be replaced by a digit 0-9.
88 nopack, 8, 64, 256, 512, 4k, 32k, 64k, 256k, 2m, 16m 256-rdp, 256-rdp-
90 compressed, 32k-rdp, 32k-rdp-compressed, 64k-rdp 64k-rdp-compressed,
91 16m-rdp, 16m-rdp-compressed rfb-hextile, rfb-tight, rfb-tight-
92 compressed 8-tight, 64-tight, 256-tight, 512-tight, 4k-tight, 32k-tight
93 64k-tight, 256k-tight, 2m-tight, 16m-tight 8-jpeg-%, 64-jpeg, 256-jpeg,
94 512-jpeg, 4k-jpeg, 32k-jpeg 64k-jpeg, 256k-jpeg, 2m-jpeg, 16m-jpeg-%
95 8-png-jpeg-%, 64-png-jpeg, 256-png-jpeg, 512-png-jpeg, 4k-png-jpeg 32k-
96 png-jpeg, 64k-png-jpeg, 256k-png-jpeg, 2m-png-jpeg, 16m-png-jpeg-%
97 8-png-%, 64-png, 256-png, 512-png, 4k-png 32k-png, 64k-png, 256k-png,
98 2m-png, 16m-png-% 16m-rgb-%, 16m-rle-%
99
101 x2goruncommand(8), x2goresume-session(8), x2gosuspend-session(8),
102 x2goterminate-session(8)
103
105 This manual has been written by Mike Gabriel <mike.gabriel@das-
106 netzwerkteam.de> for the X2Go project (https://www.x2go.org).
107Version 4.1.0.3 Nov 2018 x2gostartagent(8)