[X2Go-Commits] [x2goclient] 07/09: Update+rearrange man page.

[git-admin at x2go.org]

This is an automated email from the git hooks/post-receive script.

x2go pushed a commit to annotated tag 0.1.4.2
in repository x2goclient.

commit d5c1ff7f2e31a150aa241acd7317fabb940e5439
Author: Mike Gabriel <mike.gabriel at das-netzwerkteam.de>
Date:   Wed Aug 17 02:28:02 2011 +0200

    Update+rearrange man page.
---
 man/man1/pyhoca-cli.1 | 22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

diff --git a/man/man1/pyhoca-cli.1 b/man/man1/pyhoca-cli.1
index 8911f3b2..35678ff7 100644
--- a/man/man1/pyhoca-cli.1
+++ b/man/man1/pyhoca-cli.1
@@ -54,10 +54,16 @@ Enable debugging code of the unterlying Python X2go module.
 .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 SERVER
+.SH SERVER / SESSION PROFILE
+You either have to specify a server name or a pre-configured X2goClient session profile to tell \fBpyhoca-cli\fR to
+what X2go server to connect. \fBpyhoca-cli\fR will not start
+if neither of these two options has been given on the command line.
 .TP
 \*(T<\fB\-\-server\fR \fI<HOSTNAME_or_IP>\fR\*(T> 
 If not in LDAP mode you always have to name the remote X2go server's hostname or IP address.
+.TP 
+\*(T<\fB\-P, \-\-session-profile\fR \fI<SESSION_PROFILE_NAME>\fR\*(T>
+The name of the session profile to be used to make the connection.
 .SH ACTIONS
 \fBpyhoca-cli\fR accepts exclusively one of the listed actions:
 .TP
@@ -81,11 +87,16 @@ Terminate running X2go session <SESSION_NAME>. A special value for <SESSION_NAME
 .TP 
 \*(T<\fB\-L, \-\-list-sessions\fR\*(T> 
 List user's X2go sessions on server.
+.SH ACTION OPTIONS
+\fBpyhoca-cli\fR actions can be tweaked by these options:
+.TP
+\*(T<\fB\-\-clean-sessions\fR\*(T> 
+Clean all of the user's suspended/running sessions before starting a new one on the named X2go server.
+.TP
+\*(T<\fB\-\-terminate-on-ctrl-c\fR\*(T> 
+Terminate the connected session when pressing CTRL+C (instead of suspending the session).
 .SH X2GO OPTIONS
 .TP 
-\*(T<\fB\-P, \-\-session-profile\fR\*(T>
-The name of the session profile to be used to make the connection.B
-.TP 
 \*(T<\fB\-c, \-\-command\fR \fI<CMD>\fR\*(T> 
 Command to run with \fB\-\-new\fR mode on server (default: xterm).
 .TP 
@@ -117,9 +128,6 @@ Use X2go printing (default: disabled).
 .TP 
 \*(T<\fB\-\-share-mode\fR \fI{0|1}\fR\*(T> 
 Share mode for X2go desktop sharing (0: view-only, 1: full access).
-.TP
-\*(T<\fB\-\-clean-sessions\fR\*(T> 
-Clean all of the user's suspended/running sessions before starting a new one on the named X2go server.
 .TP 
 \*(T<\fB\-\-time-to-wait\fR\*(T> 
 Time to wait for session startup/resume (default: 8s). There should be no need to touch this, unless on very slow network connections.

--
Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/x2goclient.git