1pyhoca-gui(1)                  X2Go Application                  pyhoca-gui(1)
2
3
4

NAME

6       pyhoca-gui - graphical X2Go client applet written in Python
7

SYNOPSIS

9       pyhoca-gui [ options ]
10

DESCRIPTION

12       pyhoca-gui is a cross-platform (Windows, MacOS X, Linux) graphical X2Go
13       client applet that docks to your desktop's system tray.
14
15       From your desktop's system tray you can start/resume/share  pre-config‐
16       ured  X2Go sessions. You can manage the pre-configured session profiles
17       in the X2Go profile manager and also configure the basic setup of pyho‐
18       ca-gui.
19
20       pyhoca-gui  uses  the  same set of config files (settings, printing and
21       sessions in ~/.x2goclient) as the original X2Go Client application  (by
22       Heinz-M. Graesing and Oleksandr Schneyder) does.
23
24       On  Windows  systems  pyhoca-gui  uses the same set of Windows registry
25       keys and values as the original X2Go Client application.
26
27       See the included README and TODO for further information on pyhoca-gui.
28

COMMON OPTIONS

30       pyhoca-gui accepts the following common options:
31
32       -h, --help
33              Display a help with all available command line options and exit.
34
35       -V, --version
36              Output version information and exit.
37
38       -d, --quiet
39              No output to stdout at all! Use this option on Windows!!!
40
41       -d, --debug
42              Enable debugging output.
43
44       --libdebug
45              Enable debugging code of the unterlying Python X2Go module.
46
47       --libdebug-sftpxfer
48              Enable debugging code of Python X2Go's sFTP  server  code  (very
49              verbose, and it may even reveal promiscuous data).
50
52       -P, --session-profile
53              The  name  of the session profile to be used to make the connec‐
54              tion. You can actually pass a komma-separated  list  of  session
55              profile names to this option.
56
57       --remember-username
58              For profiles with interactive authentication, remember the last-
59              used username.
60
61       --non-interactive
62              Run in non-interactive mode. This option requires the --session-
63              profile  option.  It also sets the following options to true au‐
64              tomagically:
65
66                      --restricted-trayicon
67                      --single_session_profile
68                      --start-on-connect
69                      --resume-all-on-connect
70                      --exit-on-disconnect
71                      --disconnect-on-suspend
72                      --disconnect-on-terminate
73
74       --auto-connect
75              Connect sessions via SSH public key authentication  on  applica‐
76              tion startup, if possible.
77
78       --show-profile-metatypes
79              Show  descriptive  meta information on session profiles in menus
80              (NOTE: this makes menus appear a bit more sluggish, use it most‐
81              ly for debugging).
82
83       --single-session-profile
84              Disable  support  of handling multiple session profiles. Use to‐
85              gether with the --session-profile cmdline parameter.
86
87       --tray-icon <your-logo>
88              Define an alternative system tray icon  file  (PNG  files  only,
89              leave  out  file  extension  here, size 22x22 on Linux, 16x16 on
90              Windows).
91
92       --tray-icon-connecting <your-logo-while-connecting>
93              Define an alternative system tray icon file while connecting  to
94              a  server  (PNG  files only, leave out file extension here, size
95              22x22 on Linux, 16x16 on Windows).
96
97       --restricted-trayicon
98              Restrict functionality of pyhoca-gui's main session manager icon
99              that  is  shown  in  the  notification  area / system tray. This
100              switch limits the icon 's functionality to  a  right-click  menu
101              that  allows  one to raise the ,,About'' window and exit the ap‐
102              plication. On left-click only a minimal session menu is shown.
103
104       --add-to-known-hosts
105              Automatically add host key fingerprint  to  .ssh/known_hosts  in
106              case  of  "authenticity of server can't be established" (without
107              user interaction).
108
109              Handle this option with care: Using it lessens the  security/in‐
110              tegrity of your SSH client setup.
111
112       --start-on-connect
113              DEPRECATED:  Start a session directly after authentication (only
114              if no suspended sessions are available). This switch is now ful‐
115              ly  controlled from within the session profiles. This option it‐
116              self remains here for compatibility with older versions of PyHo‐
117              ca-GUI.
118
119       --exit-on-disconnect
120              Exit pyhoca-gui cleanly once a session has been disconnected.
121
122       --resume-on-connect, --resume-newest-on-connect
123              DEPRECATED: After authentication directly auto-resume the newest
124              available running/suspended session. This switch  is  now  fully
125              controlled from within the session profiles, resuming the newest
126              session is the hard-coded default. However,  you  can  influence
127              the  resuming  behaviour with the next two command line options.
128              This option itself remains here  for  compatibility  with  older
129              versions of PyHoca-GUI.
130
131       --resume-oldest-on-connect
132              After  authentication  directly auto-resume the oldest available
133              running/suspended session.
134
135       --resume-all-on-connect
136              After authentication directly  auto-resume  all  available  run‐
137              ning/suspended session.
138
139       --disconnect-on-suspend
140              Disconnect  from  a  server if a session on that server has been
141              suspended.
142
143       --disconnect-on-terminate
144              Disconnect from a server if a session on that  server  has  been
145              terminated.
146
147       --display <hostname>:<screennumber>
148              Set  the  DISPLAY environment variable to <hostname>:<screennum‐
149              ber>.
150
151

BROKERAGE OPTIONS

153       In case you want to retrieve X2Go session profiles from an X2Go Session
154       Broker use the following options:
155
156       --broker-url=<URL>
157              Specify the <URL> of the X2Go Session Broker. pyhoca-gui can ac‐
158              cess http(s):// and ssh:// style URLs.
159
160              Syntax of <URL> for HTTP brokerage:
161
162              http(s)://<user>:<password>@<hostname>:<port>/path/to/broker
163
164              Syntax of <URL> for  SSH brokerage:
165
166              ssh://<user>:<password>@<hostname>:<port>/usr/bin/x2gobroker (or
167              any executable that provides the broker via SSH).
168
169              As a special <URL> you can type "HTTP" or "SSH" and then the ap‐
170              plication will provide a login window  with  a  pre-formatted  /
171              schematic URL.
172
173       --broker-password <password>
174              Session broker password for retrieving session profiles from the
175              X2Go Session Broker.  The cleartext password that has been spec‐
176              ified  at  the  command  line will be masqueraded in the systems
177              process list (Linux, MacOS). On Windows systems the usage of the
178              --broker-password option is forbidden.
179
180       --broker-name <broker-name>
181              Provide  a human readable name for the session broker. This name
182              overrides the default broker name ("X2Go Session Broker") in the
183              application's menus and notification bubbles.
184
185       --broker-cacertfile CACERT_FILE
186              For https:// brokers with SSL certificates that have been signed
187              against a self-signed root-CA, use this command line  option  to
188              point to the self-signed root-CA certificate file.
189
190       --broker-autoconnect
191              If  this command line option is given the session broker authen‐
192              tication dialog will appear on application startup.
193
194

BRANDING OPTIONS

196       The pyhoca-gui provides some features that allow one  to  easily  brand
197       its  appearance.  Here are some options for tweaking the pyhoca-gui ap‐
198       pearance and behaviour.
199
200       --splash-image <your-splash-image>
201              Define an alternative splash image that gets shown  on  applica‐
202              tion  startup (PNG files only, full path or filename as found in
203              <share>/img).
204
205       --about-image <your-about-window-image>
206              Define an alternative image for the application's ,,About'' win‐
207              dow  (PNG  files  only,  full  path  or  filename  as  found  in
208              <share>/img).  For those who distribute a customized version  of
209              this  application: As PyHoca-GUI and its backend Python X2Go are
210              licensed under AGPL, the ,,About'' window is a  good  place  for
211              placing  the  download  location of your modified version of the
212              source code.
213
214       --disable-splash
215              Do not show the application's splash screen.
216
217       --disable-options
218              Grey-out the ,,Options'' menu item and thus disable  the  client
219              configuration window.
220
221       --disable-printingprefs
222              Grey-out the ,,Printing Preferences'' menu item and thus disable
223              the client's printing preferences window.
224
225       --disable-profilemanager
226              Grey-out the profile manager menu items  and  thus  disable  all
227              profile management functionalities.
228
229       --disable-notifications
230              Disable all applet notifications.
231
232       --logon-window-position <x-pos>x<y-pos>
233              Give a custom position for the logon window, use negative values
234              to position relative to right/bottom border.
235
236       --published-applications-no-submenus <number>
237              The number of published applications that will be rendered with‐
238              out submenus.
239

BACKEND OPTIONS

241       pyhoca-gui  supports  transparent  use  of different data backends. For
242       configuration three backends are common: FILE, GCONF (Linux  only)  and
243       WINREG  (Windows only). The default backend currently is the FILE back‐
244       end on all platforms.
245
246       For client-server communication the only yet implemented backend is the
247       STDOUT  backend  (as X2Go server commands print their execution results
248       to /dev/stdout. (But other communication backends might be possible  in
249       the future...).
250
251       In  the  same  way  we  are  focusing on a successor of the current NX3
252       agent/proxy tool. A change in the proxy backend will also be implement‐
253       ed as a backend.
254
255       --backend-controlsession <CONTROLSESSION_BACKEND>
256              Force usage of a certain CONTROLSESSION_BACKEND (do not use this
257              unless you know exactly what you are doing).
258
259       --backend-terminalsession <TERMINALSESSION_BACKEND>
260              Force usage of a certain  TERMINALSESSION_BACKEND  (do  not  use
261              this unless you know exactly what you are doing).
262
263       --backend-serversessioninfo <SERVERSESSIONINFO_BACKEND>
264              Force  usage  of a certain SERVERSESSIONINFO_BACKEND (do not use
265              this unless you know exactly what you are doing).
266
267       --backend-serversessionlist <SERVERSESSIONLIST_BACKEND>
268              Force usage of a certain SERVERSESSIONLIST_BACKEND (do  not  use
269              this unless you know exactly what you are doing).
270
271       --backend-proxy <PROXY_BACKEND>
272              Force  usage  of a certain PROXY_BACKEND (do not use this unless
273              you know exactly what you are doing).
274
275       --backend-sessionprofiles <SESSIONPROFILES_BACKEND>
276              Use given backend  for  accessing  session  profiles,  available
277              backends on Linux: FILES, GCONF; on Windows: FILES, WINREG.
278
279       --backend-clientsettings <CLIENTSETTINGS_BACKEND>
280              Use  given  backend for accessing the client settings configura‐
281              tion, available backends on Linux:  FILES,  GCONF;  on  Windows:
282              FILES, WINREG.
283
284       --backend-clientprinting <CLIENTPRINTING_BACKEND>
285              Use  given  backend for accessing the client printing configura‐
286              tion, available backends on Linux:  FILES,  GCONF;  on  Windows:
287              FILES, WINREG.
288

PORTABLE OPTIONS

290       --client-rootdir <CLIENT_ROOTDIR>
291              Define  an  alternative location where to find plain text config
292              files  (default:  <HOME>/.x2goclient).   This  option  will  set
293              ,,--backend-profiles  FILE'',  ,,--backend-clientsettings FILE''
294              and ,,--backend-clientprinting FILE''
295
296       --sessions-rootdir <SESSIONS_ROOTDIR>
297              Define an alternative location for session  runtime  files  (de‐
298              fault: <HOME>/.x2go).
299
300       --ssh-rootdir <SSH_ROOTDIR>
301              Define  an  alternative  location  for  user SSH files (default:
302              <HOME>/.ssh).
303

WINDOWS OPTIONS

305       There are some options that are only available on Windows:
306
307       --start-xserver
308              Start an  XServer (if available) before starting pyhoca-gui. The
309              application will detect the best suitable XServer automatically,
310              if more than one XServer is installed on your system  (currently
311              known: Xming, Cygwin-X).
312
313       --preferred-xserver <XSERVER_NAME>
314              Start either of the currently supported XServers: Xming, Cygwin-
315              X and VcXsrv -- make sure your preferred XServer is installed on
316              your system (default and recommended is VcXsrv).
317
318       --start-pulseaudio
319              Start the PulseAudio server before starting pyhoca-gui. This op‐
320              tion is needed to get X2Go audio working. However, it is not en‐
321              abled by default.
322
323       --lang [en|de|nl|es]
324              Select the GUI language.
325

SEE ALSO

327       /usr/share/doc/pyhoca-gui
328

AUTHOR

330       This  manual  has  been  written  for  the X2Go project by Mike Gabriel
331       <mike.gabriel@das-netzwerkteam.de>.
332
333
334
335Version 0.6.1.1                    Jan 2020                      pyhoca-gui(1)
Impressum