1x2goclient(1)                  X2Go Client (Qt4)                 x2goclient(1)
2
3
4

NAME

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

SYNOPSIS

9       x2goclient  <options>
10
11

DESCRIPTION

13       x2goclient is a GUI application for launching server-side X2Go
14       sessions.
15

HELP AND DEBUG OPTIONS

17       x2goclient has the following help and debugging options:
18
19       --help Show available command line options.
20
21       --help-pack
22              Show available pack methods and exit.
23
24       -v, --version
25              Output X2Go Client version to stderr.
26
27       --debug
28              Enable extensive console output for debugging X2Go Client.
29
30       --changelog
31              Show changelog file.
32
33       --git-info
34              Show Git commit history (not available on all X2Go Client
35              builds).
36

GUI OPTIONS

38       The following options can be used for controlling the GUI behaviour:
39
40       --no-menu
41              Hide menu-/toolbar (default: false).
42
43       --maximize
44              Start client maximized (default: false).
45
46       --hide Hide client (start hidden, default: false).
47
48       --keep-trayicon
49              Always keep the "accelerated X" icon in the system tray. Without
50              this option the default behaviour is: Switch the tray icon to
51              the session's icon on successful session startup/resumption.
52
53       --tray-icon
54              Show tray icon (default: false). This option overrides the
55              global tray icon settings and also forces the tray icon to be
56              shown in hidden X2Go Client mode.
57
58       --hide-foldersharing
59              Hide all elements in X2Go Client GUI that are related to folder
60              sharing.
61
62       --close-disconnect
63              Close X2Go Client after a session got disconnected.
64
65       --client-ssh-port
66              Local ssh port (for filesystem export, default: 22).
67
68       --autostart=<app>
69              Launch <app> by session start in "published applications" mode.
70              This parameter should go along with --session=<session-profile-
71              name>, where the given session profile should be configured as a
72              session profile of type "Published Applications".
73
74       --support-menu=<html-file>
75              Add a "Support..." submenu item to X2Go Client's "Help" menu.
76
77              The support information is provided via a simple HTML file.
78              Example:
79
80                   <html><body>
81                   <h1>IT-Support for X2Go</h1>
82                   DAS-NETZWERKTEAM | Mike Gabriel:<br />
83                   <a href="mailto:support@das-netzwerkteam.de">
84                       support@das-netzwerkteam.de
85                   </a><br />
86                   <br />
87                   Thanks for using X2Go...
88                   </body></html>
89
90       --background=<svg-file|dir>
91              Use a custom/branded background image (SVG format) for X2Go
92              Client's main window (i.e. replace the blue gradient area in
93              X2Go Client by some background of your own
94              (business/workgroup/project).  If a directory is given, will
95              randomly pick an SVG file inside of it.
96
97       --branding=<svg-file>
98              Use a custom icon (SVG format) for additional branding to
99              replace the default in the lower left corner of X2Go Client's
100              main window.
101
102

MISCELLANEOUS OPTIONS

104       These options change X2Go Client's behavior globally. Some might not be
105       available on all platforms.
106
107       --xserver-start-limit=<num> (Windows-only)
108              Limit the X.Org Server start count to at most <num> tries.
109              Default: 3.  If <num> is zero or a negative number, no limit is
110              imposed.  The limits for <num> are platform dependent. If the
111              passed value is out of bounds, X2Go Client falls back to the
112              default value.
113
114

SESSION PROFILE DEFAULTS

116       You can set certain defaults for session profiles via command line
117       switches using the following options:
118
119       --user Pre-selection of user at client startup (LDAP mode only).
120
121       --command=<default-command>
122              Default command for session startup.
123
124       --ssh-port
125              Use this default TCP/IP port for connection (default: 22).
126
127       --ssh-key
128              Use this SSH private key file by default.
129
130       --autologin
131              By default, search for standard SSH key file names or try using
132              an SSH agent.
133
134       --link Set default link type (modem,isdn,adsl,wan or lan, default:
135              adsl).
136
137       --pack Set default pack method (default: '16m-jpeg').
138
139       --quality
140              Set default image quality(0-9, default: 9).
141
142       --set-kbd
143              Overwrite current keyboard settings, no override by default.
144
145       --kbd-layout
146              Set keyboard layout (default: 'de').
147
148       --kbd-type
149              Set keyboard type (default: pc105/us, depend on our clients
150              language setup, though).
151
152       --clipboard=<both|client|server|none>
153              Set default clipboard mode.
154
155       --geometry=<W>x<H>|fullscreen
156              Set default geometry, default '800x600'.
157
158       --dpi=<dpi>
159              set DPI of X2Go Agent to <dpi>, default set to same as local
160              display.
161
162       --sound
163              Activate sound for session, not enabled by default.
164
165       --sound-system
166              Which soundsystem to use: arts, esd, pulse (default: pulse).
167
168       --xinerama
169              Use Xinerama by default.
170
171       --session-icon=<128x128px-icon-png-file>
172              Use a custom session icon by default.
173
174

THIN CLIENT OPTIONS

176       The following command line options are primarily interesting if
177       x2goclient is used as a login manager on X2Go thin clients.
178
179       --thinclient
180              Let X2Go Client run without window manager.
181
182       --sessionid=<session-profile-id>
183              Pre-selection of a session profile (by its session profile ID)
184              at client startup.
185
186       --session=<session-profile-name>
187              Pre-selection of a session profile (by its session profile name)
188              at client startup.
189
190       --no-session-edit
191              Disable session editing.
192
193       --pgp-card
194              Use openPGP Card authentication (default: false).
195
196       --external-login=<smartcard-logins>
197              Authenticate via SMART card, path to login notification file.
198
199       --add-to-known-hosts
200              Add DSA/RSA host key fingerprint to .ssh/known_hosts in case of
201              "authenticity of server can't be established".
202
203       --read-exports-from
204              Specifies a directory where some external mechanism (e.g.
205              script) can notify x2goclient on new block devices (CD/DVDs, USB
206              sticks, etc.).
207
208       --haltbt
209              Show a "Shutdown" button in the top left corner of X2Go Client.
210              When pressed, X2Go Client will create the file $HOME/.halt. An
211              external script has to watch for this file and trigger a
212              thinclient shutdown once it appears.
213
214

PORTABLE OPTIONS

216       X2Go Client can be installed on a USB-Flashdrive as a portable
217       applications. If installed that way, the following options support the
218       portable setup of X2Go Client:
219
220       --portable
221              Start X2Go Client in "portable" mode. This implies... (TODO).
222
223       --home=<dir>
224              Set the users home directory. This is the directory where X2Go
225              Client will store settings and cache files.
226
227       --session-conf=<file>
228              Path to alternative session profile config (default:
229              $HOME/.x2goclient/sessions).
230
231       --clean-all-files
232              In portable mode, X2Go Client removes several directories it has
233              created (and probably directories you don't want to have removed
234              on a normal system):
235
236                      $HOME/.ssh
237                      $HOME/ssh
238                      $HOME/.x2go
239
240              If --clean-all-files is used on the command line, also the
241              directory containing the configuration files of X2Go Client gets
242              removed:
243
244                      $HOME/.x2goclient
245
246

BROKER OPTIONS

248       In case you want to retrieve x2goclient session profiles from an X2Go
249       Session Broker use the following options:
250
251       --broker-url=<URL>
252              Specify the <URL> of the X2Go Session Broker. X2Go Client can
253              access http:// and ssh:// style URLs.
254
255              Syntax of <URL> for HTTP brokerage:
256
257              http(s)://<user>:<password>@<hostname>:<port>/path/to/broker
258
259              Syntax of <URL> for  SSH brokerage:
260
261              ssh://<user>:<password>@<hostname>:<port>/usr/bin/x2gobroker (or
262              any executable that provides the broker via SSH).
263
264
265       --broker-cacertfile=</path/to/cafile.crt>
266              Specify a special (self-signed) root-CACert file that shall get
267              used when connecting to an X2Go Session Broker via https (SSL).
268
269       --broker-noauth
270              The X2Go Session Broker is accessible without authentication.
271
272       --broker-krblogin
273              Login to X2Go Session Broker via GSSAPI. Only supported with
274              ssh:// broker URLs.
275
276       --auth-id=<USERNAME>
277              Use this <USERNAME> for authenticating against the X2Go Session
278              Broker. This option mostly makes sense together with --broker-
279              autologin or --broker-ssh-key.
280
281       --broker-autologin
282              For SSH based X2Go Session Brokers. If an SSH agent is available
283              or default key files exist then try those for authentication
284              against the X2Go Session Broker.
285
286       --broker-autologoff
287              Enforce re-authentication against X2Go Session Broker after a
288              session has been suspended or terminated.
289
290       --broker-ssh-key=<SSHPRIVKEY>
291              For SSH based X2Go Session Brokers. Full path to a valid SSH
292              private key file.
293
294       --broker-name=<NAME>
295              Currently unused...
296
297       --connectivity-test
298              Run a connectivity test against X2Go Session Broker. Not
299              supported by all broker implementations.
300
301       --change-broker-pass
302              Send a change-password request to an X2Go Session Broker. Not
303              supported by all broker implementations.
304
305       --broker-noauth-with-session-username
306              Informs the broker to use the username you entered for X2Go
307              Server authentication when selecting a server/session. Only has
308              functionality if --broker-noauth is used.
309
310       --broker-use-creds-for-session
311              Use broker credentials as session user/password credentials when
312              using broker mode with broker authentication. Currently only
313              affects direct RDP sessions.
314
315       --broker-logoutbt
316              Show a "Logout" button in the top left corner of X2Go Client.
317              When logged in to a broker, pressing this button X2Go Client
318              lets you login to the broker again.
319
320

LDAP OPTIONS (deprecated)

322       NOTE: LDAP support won't be continued in X2Go Client 2 (next generation
323       of X2Go Client).
324
325       A slightly different approach than X2Go Client's LDAP functionality is
326       available via the X2Go Session Brokerage feature.
327
328       In case you want to control x2goclient via an LDAP server use the
329       following options:
330
331       --ldap=<host:port:dn>
332              Start with LDAP support (disabled by default). Example:
333              --ldap=ldapserver:389:o=organization,c=de
334
335       --ldap1=<host:port:dn>
336              Failover LDAP URI No. 1.
337
338       --ldap2=<host:port:dn>
339              Failover LDAP URI No. 2.
340
341       --ldap-printing
342              Allow client side printing in LDAP mode.
343
344

AUTHOR

346       This manual has been written by Mike Gabriel <mike.gabriel@das-
347       netzwerkteam.de> for the X2Go project (https://www.x2go.org).
348
349
350
351Version 4.1.2.1                    Jun 2018                      x2goclient(1)
Impressum