The branch, build-59a18b6e3b5d3f1dd8f07f26433d37fe5984a57d has been updated via ccd54373f71d3510904d9f45bb97cdc297755951 (commit) from 469584fa40038761b9826971ea9af6d9e8e0ea82 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- ----------------------------------------------------------------------- Summary of changes: debian/changelog | 1 + man/man1/pyhoca-gui.1 | 138 +++++++++++++++++++++++++++++-------------------- 2 files changed, 82 insertions(+), 57 deletions(-) The diff of changes is: diff --git a/debian/changelog b/debian/changelog index 4676122..5380050 100644 --- a/debian/changelog +++ b/debian/changelog @@ -139,6 +139,7 @@ pyhoca-gui (0.1.2.0-0~x2go1) UNRELEASED; urgency=low - Make new session option keyboard ,,variant'' configurable in profile manager. - Re-register available/registered sessions after session profile changes. + - Update man page. * Depend on Python X2Go 0.1.2.0. * Install GNOME icons via dh_links. * Install X2Go icons with explicit install paths. diff --git a/man/man1/pyhoca-gui.1 b/man/man1/pyhoca-gui.1 index ed90d24..8e1f50b 100644 --- a/man/man1/pyhoca-gui.1 +++ b/man/man1/pyhoca-gui.1 @@ -5,7 +5,7 @@ \\$2 \(la\\$1\(ra\\$3 .. .if \n(.g .mso www.tmac -.TH pyhoca-gui 1 "26 May 2011" "Version 0.1.0.x" "X2Go Application" +.TH pyhoca-gui 1 "May 2012" "Version 0.1.2.x" "X2Go Application" .SH NAME pyhoca-gui \- graphical X2Go client applet written in Python .SH SYNOPSIS @@ -38,94 +38,118 @@ See the included README and TODO for further information on \fBpyhoca-gui\fR. .SH COMMON OPTIONS \fBpyhoca-gui\fR accepts the following common options: .TP -\*(T<\fB\-h, \-\-help\fR\*(T> +\*(T<\fB\-h, \-\-help\fR\*(T> Display a help with all available command line options and exit. -.TP -\*(T<\fB\-V, \-\-version\fR\*(T> +.TP +\*(T<\fB\-V, \-\-version\fR\*(T> Output version information and exit. -.TP -\*(T<\fB\-d, \-\-quiet\fR\*(T> +.TP +\*(T<\fB\-d, \-\-quiet\fR\*(T> No output to stdout at all! Use this option on Windows!!! -.TP -\*(T<\fB\-d, \-\-debug\fR\*(T> +.TP +\*(T<\fB\-d, \-\-debug\fR\*(T> Enable debugging output. -.TP -\*(T<\fB\-\-libdebug\fR\*(T> +.TP +\*(T<\fB\-\-libdebug\fR\*(T> Enable debugging code of the unterlying Python X2Go module. -.TP -\*(T<\fB\-\-libdebug-sftpxfer\fR\*(T> +.TP +\*(T<\fB\-\-libdebug-sftpxfer\fR\*(T> Enable debugging code of Python X2go's sFTP server code (very verbose, and it may even reveal promiscuous data). .SH GUI OPTIONS -.TP -\*(T<\fB\-u, \-\-username\fR \fI<USERNAME>\fR\*(T> -Username for the session (default: currently logged in user). -.TP +.TP \*(T<\fB\-P, \-\-session-profile\fR\*(T> The name of the session profile to be used to make the connection. You can actually pass a komma-separated list of session profile names to this option. -.TP +.TP +\*(T<\fB\-\-remember-username\fR\*(T> +For profiles with interactive authentication, remember the last-used username. +.TP \*(T<\fB\-\-non-interactive\fR\*(T> Run in non-interactive mode. This option requires the \fB\-\-session-profile\fR option. It also sets the following options to true automagically: \fB\-\-restricted-trayicon\fR + \fB\-\-single_session_profile\fR \fB\-\-start-on-connect\fR \fB\-\-resume-all-on-connect\fR \fB\-\-exit-on-disconnect\fR \fB\-\-disconnect-on-suspend\fR \fB\-\-disconnect-on-terminate\fR -.TP +.TP +\*(T<\fB\-\-auto-connect\fR\*(T> +Connect sessions via SSH public key authentication on application startup, if possible. +.TP \*(T<\fB\-\-show-profile-metatypes\fR\*(T> Show descriptive meta information on session profiles in menus (NOTE: this makes menus appear a bit more sluggish, use it mostly for debugging). -.TP -\*(T<\fB\-\-restricted-trayicon\fR\*(T> -Restrict functionality of \fBpyhoca-gui\fR's main session manager icon that is shown in the notification area / system tray. This -switch limits the icon 's functionality to a right-click menu that allows to raise the ,,About'' window and exit the application. -.TP +.TP +\*(T<\fB\-\-single-session-profile\fR\*(T> +Disable support of handling multiple session profiles. Use together with the \fB\-\-session-profile\fR cmdline parameter. +.TP +\*(T<\fB\-\-tray-icon\fR \fI<your-logo>\fR\*(T> +Define an alternative system tray icon file (PNG files only, leave out file extension here, size 22x22 on Linux, 16x16 on Windows). +.TP +\*(T<\fB\-\-tray-icon-connecting\fR \fI<your-logo-while-connecting>\fR\*(T> +Define an alternative system tray icon file while connecting to a server (PNG files only, leave out file extension here, size 22x22 on Linux, 16x16 on Windows). +.TP \*(T<\fB\-\-restricted-trayicon\fR\*(T> Restrict functionality of \fBpyhoca-gui\fR's main session manager icon that is shown in the notification area / system tray. This -switch limits the icon 's functionality to a right-click menu that allows to raise the ,,About'' window and exit the application. -.TP -\*(T<\fB\-\-auto-connect\fR\*(T> -Connect sessions via SSH public key authentication on application startup, if possible. -.TP +switch limits the icon 's functionality to a right-click menu that allows to raise the ,,About'' window and exit the application. On +left-click only a minimal session menu is shown. +.TP \*(T<\fB\-\-start-on-connect\fR\*(T> Start a session directly after authentication (only if no suspended sessions are available). -.TP +.TP \*(T<\fB\-\-exit-on-disconnect\fR\*(T> Exit \fBpyhoca-gui\fR cleanly once a session has been disconnected. -.TP +.TP \*(T<\fB\-\-resume-on-connect, \-\-resume-newest-on-connect\fR\*(T> After authentication directly auto-resume the newest available running/suspended session. -.TP +.TP \*(T<\fB\-\-resume-oldest-on-connect\fR\*(T> After authentication directly auto-resume the oldest available running/suspended session. -.TP +.TP \*(T<\fB\-\-resume-all-on-connect\fR\*(T> After authentication directly auto-resume all available running/suspended session. -.TP +.TP \*(T<\fB\-\-disconnect-on-suspend\fR\*(T> Disconnect from a server if a session on that server has been suspended. -.TP +.TP \*(T<\fB\-\-disconnect-on-terminate\fR\*(T> Disconnect from a server if a session on that server has been terminated. -.TP +.TP +\*(T<\fB\-\-splash-image\fR \fI<your-splash-image>\fR\*(T> +Define an alternative splash image that gets shown on application startup (PNG files only, full path or filename as found in <share>/img). +.TP +\*(T<\fB\-\-about-image\fR \fI<your-about-window-image>\fR\*(T> +Define an alternative image for the application's ,,About'' window (PNG files only, full path or filename as found in <share>/img). +. +For those who distribute a customized version of this application: +As PyHoca-GUI and its backend Python X2Go are licensed under AGPL, the ,,About'' window is a good place for placing the download location +of your modified version of the source code. +.TP \*(T<\fB\-\-disable-splash\fR\*(T> Do not show the application's splash screen. -.TP +.TP \*(T<\fB\-\-disable-options\fR\*(T> Grey-out the ,,Options'' menu item and thus disable the client configuration window. -.TP +.TP \*(T<\fB\-\-disable-printingprefs\fR\*(T> Grey-out the ,,Printing Preferences'' menu item and thus disable the client's printing preferences window. -.TP +.TP \*(T<\fB\-\-disable-profilemanager\fR\*(T> Grey-out the profile manager menu items and thus disable all profile management functionalities. -.TP +.TP +\*(T<\fB\-\-disable-notifications\fR\*(T> +Disable all applet notifications. +.TP \*(T<\fB\-\-display <hostname>:<screennumber>\fR\*(T> Set the DISPLAY environment variable to <hostname>:<screennumber>. -.TP -\*(T<\fB\-\-logon\-window\-position <x-pos>x<y-pos>\fR\*(T> +.TP +\*(T<\fB\-\-logon\-window\-position\fR \fI<x-pos>x<y-pos>\fR\*(T> Give a custom position for the logon window, use negative values to position relative to right/bottom border. +.TP +\*(T<\fB\-\-published-applications-no-submenus\fR \fI<number>\fR\*(T> +The number of published applications that will be rendered without submenus. +.PP .SH BACKEND OPTIONS \fBpyhoca-gui\fR supports transparent use of different data backends. For configuration three backends are common: FILE, GCONF (Linux only) and WINREG (Windows only). The default backend currently is the FILE backend @@ -136,57 +160,57 @@ print their execution results to /dev/stdout. (But other communication backends .PP In the same way we are focusing on a successor of the current NX3 agent/proxy tool. A change in the proxy backend will also be implemented as a backend. -.TP +.TP \*(T<\fB\-\-backend-controlsession <CONTROLSESSION_BACKEND>\fR\*(T> Force usage of a certain CONTROLSESSION_BACKEND (do not use this unless you know exactly what you are doing). -.TP +.TP \*(T<\fB\-\-backend-terminalsession <TERMINALSESSION_BACKEND>\fR\*(T> Force usage of a certain TERMINALSESSION_BACKEND (do not use this unless you know exactly what you are doing). -.TP +.TP \*(T<\fB\-\-backend-serversessioninfo <SERVERSESSIONINFO_BACKEND>\fR\*(T> Force usage of a certain SERVERSESSIONINFO_BACKEND (do not use this unless you know exactly what you are doing). -.TP +.TP \*(T<\fB\-\-backend-serversessionlist <SERVERSESSIONLIST_BACKEND>\fR\*(T> Force usage of a certain SERVERSESSIONLIST_BACKEND (do not use this unless you know exactly what you are doing). -.TP +.TP \*(T<\fB\-\-backend-proxy <PROXY_BACKEND>\fR\*(T> Force usage of a certain PROXY_BACKEND (do not use this unless you know exactly what you are doing). -.TP +.TP \*(T<\fB\-\-backend-sessionprofiles <SESSIONPROFILES_BACKEND>\fR\*(T> Use given backend for accessing session profiles, available backends on Linux: FILES, GCONF; on Windows: FILES, WINREG. -.TP +.TP \*(T<\fB\-\-backend-clientsettings <CLIENTSETTINGS_BACKEND>\fR\*(T> Use given backend for accessing the client settings configuration, available backends on Linux: FILES, GCONF; on Windows: FILES, WINREG. -.TP +.TP \*(T<\fB\-\-backend-clientprinting <CLIENTPRINTING_BACKEND>\fR\*(T> Use given backend for accessing the client printing configuration, available backends on Linux: FILES, GCONF; on Windows: FILES, WINREG. .SH PORTABLE OPTIONS -.TP +.TP \*(T<\fB\-\-client-rootdir <CLIENT_ROOTDIR>\fR\*(T> Define an alternative location where to find plain text config files (default: <HOME>/.x2goclient). This option will set ,,--backend-profiles FILE'', ,,--backend-clientsettings FILE'' and ,,--backend-clientprinting FILE'' -.TP +.TP \*(T<\fB\-\-sessions-rootdir <SESSIONS_ROOTDIR>\fR\*(T> Define an alternative location for session runtime files (default: <HOME>/.x2go). -.TP +.TP \*(T<\fB\-\-ssh-rootdir <SSH_ROOTDIR>\fR\*(T> Define an alternative location for user SSH files (default: <HOME>/.ssh). .SH WINDOWS OPTIONS There are some options that are only available on Windows: -.TP +.TP \*(T<\fB\-\-start-xserver\fR\*(T> Start an XServer (if available) before starting \fBpyhoca-gui\fR. The application will detect the best suitable XServer automatically, if more than one XServer is installed on your system (currently known: Xming, Cygwin-X). .TP \*(T<\fB\-\-preferred-xserver <XSERVER_NAME>\fR\*(T> -Start either of the currently supported XServers: Xming, Cygwin-X -- make sure your preferred XServer is installed -on your system. -.TP +Start either of the currently supported XServers: Xming, Cygwin-X and VcXsrv -- make sure your preferred XServer is installed +on your system (default and recommended is VcXsrv). +.TP \*(T<\fB\-\-start-pulseaudio\fR\*(T> Start the PulseAudio server before starting \fBpyhoca-gui\fR. This option is needed to get X2Go audio working. However, it is not enabled by default. -.TP +.TP \*(T<\fB\-\-lang [en|de|nl|es]\fR\*(T> Select the GUI language. .SH "SEE ALSO" hooks/post-receive -- pyhoca-gui.git (Python X2Go Client (wxPython GUI)) This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "pyhoca-gui.git" (Python X2Go Client (wxPython GUI)).