[X2Go-Commits] [x2goserver] 01/01: some man page updates

git-admin at x2go.org git-admin at x2go.org
Sun Jun 29 16:42:25 CEST 2014


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

x2go pushed a commit to branch master
in repository x2goserver.

commit 7f75302fd0e3a0b79705105dcbdbfb3c384de317
Author: Mike Gabriel <mike.gabriel at das-netzwerkteam.de>
Date:   Sun Jun 29 16:40:59 2014 +0200

    some man page updates
---
 x2goserver/man/man8/x2gobasepath.8           |    2 +-
 x2goserver/man/man8/x2gocleansessions.8      |    2 +-
 x2goserver/man/man8/x2gocmdexitmessage.8     |    6 +--
 x2goserver/man/man8/x2godbadmin.8            |    2 +-
 x2goserver/man/man8/x2gofeature.8            |    6 +--
 x2goserver/man/man8/x2gofeaturelist.8        |    2 +-
 x2goserver/man/man8/x2gogetservers.8         |    7 ++--
 x2goserver/man/man8/x2golistdesktops.8       |    6 +--
 x2goserver/man/man8/x2golistmounts.8         |   14 ++++---
 x2goserver/man/man8/x2golistsessions.8       |   36 ++++++++--------
 x2goserver/man/man8/x2golistsessions_root.8  |    6 +--
 x2goserver/man/man8/x2golistshadowsessions.8 |   34 +++++++--------
 x2goserver/man/man8/x2gomountdirs.8          |    2 +-
 x2goserver/man/man8/x2gopath.8               |    4 +-
 x2goserver/man/man8/x2goresume-session.8     |   57 +++++++++++++++++++++++---
 x2goserver/man/man8/x2goruncommand.8         |    2 +-
 x2goserver/man/man8/x2gosessionlimit.8       |    2 +-
 x2goserver/man/man8/x2gosetkeyboard.8        |    2 +-
 x2goserver/man/man8/x2goshowblocks.8         |    2 +-
 x2goserver/man/man8/x2gostartagent.8         |   54 +++++++++++++++---------
 x2goserver/man/man8/x2gosuspend-session.8    |    2 +-
 x2goserver/man/man8/x2goterminate-session.8  |    2 +-
 x2goserver/man/man8/x2goumount-session.8     |    2 +-
 x2goserver/man/man8/x2goversion.8            |    2 +-
 24 files changed, 163 insertions(+), 93 deletions(-)

diff --git a/x2goserver/man/man8/x2gobasepath.8 b/x2goserver/man/man8/x2gobasepath.8
index f4fcf0d..2bd01be 100644
--- a/x2goserver/man/man8/x2gobasepath.8
+++ b/x2goserver/man/man8/x2gobasepath.8
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2gobasepath 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2gobasepath 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2gobasepath \- Detect Base Path of X2Go Server Installation
 .SH SYNOPSIS
diff --git a/x2goserver/man/man8/x2gocleansessions.8 b/x2goserver/man/man8/x2gocleansessions.8
index 7b42dfe..a4180b5 100644
--- a/x2goserver/man/man8/x2gocleansessions.8
+++ b/x2goserver/man/man8/x2gocleansessions.8
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2gocleansessions 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2gocleansessions 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2gocleansessions \- X2Go Server Cleanup Daemon
 .SH SYNOPSIS
diff --git a/x2goserver/man/man8/x2gocmdexitmessage.8 b/x2goserver/man/man8/x2gocmdexitmessage.8
index 928b608..3a0ac40 100644
--- a/x2goserver/man/man8/x2gocmdexitmessage.8
+++ b/x2goserver/man/man8/x2gocmdexitmessage.8
@@ -5,17 +5,17 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2gocmdexitmessage 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2gocmdexitmessage 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2gocmdexitmessage \- Exit Message of X2Go Command
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2gocmdexitmessage <session_id>
+x2gocmdexitmessage \fI<session_id>\fR
 
 .SH DESCRIPTION
-\fBx2gocmdexitmessage\fR prints out the exit message of the last command run with \fBx2goruncommand\fR for session <session_id>.
+\fBx2gocmdexitmessage\fR prints out the exit message of the last command run with \fBx2goruncommand\fR for session \fI<session_id>\fR.
 
 \fBx2gocmdexitmessage\fR is run with X2Go user privileges.
 .PP
diff --git a/x2goserver/man/man8/x2godbadmin.8 b/x2goserver/man/man8/x2godbadmin.8
index c7ccada..920d662 100644
--- a/x2goserver/man/man8/x2godbadmin.8
+++ b/x2goserver/man/man8/x2godbadmin.8
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2godbadmin 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Admin Tool"
+.TH x2godbadmin 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Admin Tool"
 .SH NAME
 x2godbadmin \- X2Go Server Database Administrator
 .SH SYNOPSIS
diff --git a/x2goserver/man/man8/x2gofeature.8 b/x2goserver/man/man8/x2gofeature.8
index 13835c3..09cfc93 100644
--- a/x2goserver/man/man8/x2gofeature.8
+++ b/x2goserver/man/man8/x2gofeature.8
@@ -5,14 +5,14 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2gofeature 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2gofeature 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2gofeature \- Query X2Go Feature Availability on X2Go Server
 .SH SYNOPSIS
 'nh
 .fi
 .ad 1
-x2gofeature <feature_name>
+x2gofeature \fI<feature_name>\fR
 
 .SH DESCRIPTION
 \fBx2gofeature\fR allows client applications to query the server for certain features
@@ -20,7 +20,7 @@ before trying to use them.
 .PP
 \fBx2gofeature\fR can be run with user privileges.
 .SH RETURN VALUES
-If feature <feature_name> is available on the X2Go server, then ,,ok'' is written to stdout.
+If feature \fI<feature_name>\fR is available on the X2Go server, then ,,ok'' is written to stdout.
 Otherwise the expression ,,not available'' is written to stdout.
 .SH SEE ALSO
 /usr/share/x2go/x2gofeature.d/*.features
diff --git a/x2goserver/man/man8/x2gofeaturelist.8 b/x2goserver/man/man8/x2gofeaturelist.8
index 6c00f91..7d7aa30 100644
--- a/x2goserver/man/man8/x2gofeaturelist.8
+++ b/x2goserver/man/man8/x2gofeaturelist.8
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2gofeaturelist 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2gofeaturelist 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2gofeaturelist \- Query X2Go Feature List for X2Go Server
 .SH SYNOPSIS
diff --git a/x2goserver/man/man8/x2gogetservers.8 b/x2goserver/man/man8/x2gogetservers.8
index ca32f7d..f27a394 100644
--- a/x2goserver/man/man8/x2gogetservers.8
+++ b/x2goserver/man/man8/x2gogetservers.8
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2gogetservers 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2gogetservers 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2gogetservers \- Retrieve list of available X2Go servers
 .SH SYNOPSIS
@@ -15,8 +15,9 @@ x2gogetservers \- Retrieve list of available X2Go servers
 x2gogetservers
 
 .SH DESCRIPTION
-\fBx2gogetservers\fR retrieves a list of available X2Go servers. This command is
-only used by \fIx2goclient\fR if it runs in LDAP mode.
+\fBx2gogetservers\fR retrieves a list of available X2Go servers.
+
+This command is used in X2Go load balancing scenarios.
 .PP
 The \fBx2gogetservers\fR is run with X2Go user privileges.
 
diff --git a/x2goserver/man/man8/x2golistdesktops.8 b/x2goserver/man/man8/x2golistdesktops.8
index 639b625..ac0984c 100644
--- a/x2goserver/man/man8/x2golistdesktops.8
+++ b/x2goserver/man/man8/x2golistdesktops.8
@@ -5,17 +5,17 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2golistdesktops 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2golistdesktops 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2golistdesktops \- List Available X Desktops
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2golistdesktops [<server_hostname>]
+x2golistdesktops [\fI<server_hostname>\fR]
 
 .SH DESCRIPTION
-\fBx2golistdesktops\fR returns a list of active desktop sessions running on server <server_hostname>.
+\fBx2golistdesktops\fR returns a list of active desktop sessions running on server \fI<server_hostname>\fR.
 If no server hostname is given at the command line, the fully qualified domain name of the local system
 is used here.
 .PP
diff --git a/x2goserver/man/man8/x2golistmounts.8 b/x2goserver/man/man8/x2golistmounts.8
index f062f27..a14b3e7 100644
--- a/x2goserver/man/man8/x2golistmounts.8
+++ b/x2goserver/man/man8/x2golistmounts.8
@@ -5,18 +5,22 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2golistmounts 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2golistmounts 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2golistmounts \- List Mounted Shares for an X2Go Session
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2golistmounts <session_id>
+x2golistmounts [\fI<session_id>\fR]
 
 .SH DESCRIPTION
 \fBx2golistmounts\fR returns a list of mounted client-side folders or devices for X2go
-session <session_id>.
+session \fI<session_id>\fR.
+.PP
+If this commands get evoked inside an X2Go session, the
+\fI<session_id>\fR parameter can be omitted (and the env var $X2GO_SESSION will be used
+instead).
 .PP
 \fBx2golistmounts\fR is run with normal user privileges and it is used by X2Go clients to render
 a list of SSHFS mounts for a given X2Go sessions.
@@ -26,8 +30,8 @@ two mount point attribute fields separated by the pipe symbol (,,|'').
 .PP
 The meanings of these mount point attributes are:
 
-  field 01: <sshfs_target_host_ip>
-  field 02: <mount_point_path_on_server>
+  field 01: \fI<sshfs_target_host_ip>\fR
+  field 02: \fI<mount_point_path_on_server>\fR
 
 As exitcode \fBx2golistmounts\fR always returns 0.
 .SH SEE ALSO
diff --git a/x2goserver/man/man8/x2golistsessions.8 b/x2goserver/man/man8/x2golistsessions.8
index 23bd2aa..6b99621 100644
--- a/x2goserver/man/man8/x2golistsessions.8
+++ b/x2goserver/man/man8/x2golistsessions.8
@@ -5,17 +5,17 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2golistsessions 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2golistsessions 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2golistsessions \- List Available X2Go Sessions for User
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2golistsessions [<server_hostname>|--all-servers]
+x2golistsessions [\fI<server_hostname>\fR|\fI--all-servers\fR]
 
 .SH DESCRIPTION
-\fBx2golistsessions\fR returns a list of running or suspended X2Go sessions for X2Go server <server_hostname>.
+\fBx2golistsessions\fR returns a list of running or suspended X2Go sessions for X2Go server \fI<server_hostname>\fR.
 If no server hostname is given at the command line, the session list query runs for the local system.
 .PP
 \fBx2golistsessions\fR is run with normal user privileges and it is used by X2Go clients to render
@@ -30,20 +30,22 @@ symbol (,,|'').
 .PP
 The meaning of the session attributes of each output line are shown below:
 
-  field 01: <agent_pid>
-  field 02: <session_id>
-  field 03: <port>
-  field 04: <host>
-  field 05: <state>
-  field 06: <init_time>
-  field 07: <session_cookie>
-  field 08: <client_ip>
-  field 09: <gr_port>
-  field 10: <snd_port>
-  field 11: <last_time>
-  field 12: <user>
-  field 13: <age_in_secs>
-  field 14: <sshfs_port>
+    field 01: \fI<agent_pid>\fR
+    field 02: \fI<session_id>\fR
+    field 03: \fI<port>\fR
+    field 04: \fI<host>\fR
+    field 05: \fI<state>\fR
+    field 06: \fI<init_time>\fR
+    field 07: \fI<session_cookie>\fR
+    field 08: \fI<client_ip>\fR
+    field 09: \fI<gr_port>\fR
+    field 10: \fI<snd_port>\fR
+    field 11: \fI<last_time>\fR
+    field 12: \fI<user>\fR
+    field 13: \fI<age_in_secs>\fR
+    field 14: \fI<sshfs_port>\fR
+    field 15: \fI<tekictrl_port>\fR (if Telekinesis is available/enabled)
+    field 15: \fI<tekidata_port>\fR (if Telekinesis is available/enabled)
 
 .PP
 As exitcode \fBx2golistsessions\fR always returns 0.
diff --git a/x2goserver/man/man8/x2golistsessions_root.8 b/x2goserver/man/man8/x2golistsessions_root.8
index 2258edb..f7938da 100644
--- a/x2goserver/man/man8/x2golistsessions_root.8
+++ b/x2goserver/man/man8/x2golistsessions_root.8
@@ -5,17 +5,17 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2golistsessions_root 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Admin Tool"
+.TH x2golistsessions_root 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Admin Tool"
 .SH NAME
 x2golistsessions_root \- List X2Go Sessions for System
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2golistsessions_root [<server_hostname>]
+x2golistsessions_root [\fI<server_hostname>\fR]
 
 .SH DESCRIPTION
-\fBx2golistsessions_root\fR shows a list of all available X2Go sessions on the server <server_hostname>.
+\fBx2golistsessions_root\fR shows a list of all available X2Go sessions on the server \fI<server_hostname>\fR.
 If no server hostname is given at the command line, the session list query runs for the local system.
 .PP
 \fBx2golistsessions_root\fR must be run with root privileges.
diff --git a/x2goserver/man/man8/x2golistshadowsessions.8 b/x2goserver/man/man8/x2golistshadowsessions.8
index 2f5c795..5581d8b 100644
--- a/x2goserver/man/man8/x2golistshadowsessions.8
+++ b/x2goserver/man/man8/x2golistshadowsessions.8
@@ -5,18 +5,18 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2golistshadowsessions 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2golistshadowsessions 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2golistshadowsessions \- List Available X2Go Shadow Sessions for User
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2golistshadowsessions [<server_hostname>|--all-servers]
+x2golistshadowsessions [\fI<server_hostname>\fR|\fI--all-servers\fR]
 
 .SH DESCRIPTION
 \fBx2golistshadowsessions\fR returns a list of running or suspended X2Go shadow sessions
-(sessions that provide the X2Go Desktop Sharing feature) for X2Go server <server_hostname>.
+(sessions that provide the X2Go Desktop Sharing feature) for X2Go server \fI<server_hostname>\fR.
 If no server hostname is given at the command line, the shadow session list query runs for the local system.
 .PP
 \fBx2golistshadowsessions\fR is run with normal user privileges and it is used by X2Go clients to render
@@ -31,20 +31,20 @@ symbol (,,|'').
 .PP
 The meaning of the session attributes of each output line are shown below:
 
-  field 01: <agent_pid>
-  field 02: <session_id>
-  field 03: <port>
-  field 04: <host>
-  field 05: <state>
-  field 06: <init_time>
-  field 07: <session_cookie>
-  field 08: <client_ip>
-  field 09: <gr_port>
-  field 10: <snd_port>
-  field 11: <last_time>
-  field 12: <user>
-  field 13: <age_in_secs>
-  field 14: <sshfs_port>
+  field 01: \fI<agent_pid>\fR
+  field 02: \fI<session_id>\fR
+  field 03: \fI<port>\fR
+  field 04: \fI<host>\fR
+  field 05: \fI<state>\fR
+  field 06: \fI<init_time>\fR
+  field 07: \fI<session_cookie>\fR
+  field 08: \fI<client_ip>\fR
+  field 09: \fI<gr_port>\fR
+  field 10: \fI<snd_port>\fR
+  field 11: \fI<last_time>\fR
+  field 12: \fI<user>\fR
+  field 13: \fI<age_in_secs>\fR
+  field 14: \fI<sshfs_port>\fR
 
 .PP
 As exitcode \fBx2golistshadowsessions\fR always returns 0.
diff --git a/x2goserver/man/man8/x2gomountdirs.8 b/x2goserver/man/man8/x2gomountdirs.8
index e86c16f..d4e9d17 100644
--- a/x2goserver/man/man8/x2gomountdirs.8
+++ b/x2goserver/man/man8/x2gomountdirs.8
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2gomountdirs 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2gomountdirs 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2gomountdirs \- Share Client-Side Folder with X2Go Session
 .SH SYNOPSIS
diff --git a/x2goserver/man/man8/x2gopath.8 b/x2goserver/man/man8/x2gopath.8
index 440fcca..1968410 100644
--- a/x2goserver/man/man8/x2gopath.8
+++ b/x2goserver/man/man8/x2gopath.8
@@ -1,10 +1,10 @@
-.TH x2gopath 8 "Feb 2012" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2gopath 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH Name
 .PP
 x2gopath - Show X2Go Server installation paths
 .SH Synopsis
 .PP
-\fBx2gopath\fP {\fBbase\fP|\fBlib\fP|\fBlibexec\fP|\fBshare\fP}
+\fBx2gopath\fP {\fIbase\fR|\fIlib\fR|\fIlibexec\fR|\fIshare\fR}
 .SH Description
 .PP
 \fBx2gopath\fP displays the paths of the selected X2Go installation directory.
diff --git a/x2goserver/man/man8/x2goresume-session.8 b/x2goserver/man/man8/x2goresume-session.8
index 794271f..04a1677 100644
--- a/x2goserver/man/man8/x2goresume-session.8
+++ b/x2goserver/man/man8/x2goresume-session.8
@@ -5,25 +5,72 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2goresume-session 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2goresume-session 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2goresume-session \- Resume X2Go Session
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2goresume-session <session_id>
+\fBx2goresume-session\fR  \fI<session_id>\fR \ \\
+                    \fI<geometry>\fR \ \\
+                    \fI<link_quality>\fR \ \\
+                    \fI<nx_pack_meth>\fR \ \\
+                    \fI<kblayout>\fR \ \\
+                    \fI<kbtype>\fR \ \\
+                    \fI<setkbd>\fR \ \\
+                    \fI<clipboardmode>\fR
 
 .SH DESCRIPTION
-\fBx2goresume-session\fR resumes the suspended session with session ID <session_id>.
+\fBx2goresume-session\fR resumes the suspended session with session ID \fI<session_id>\fR.
 .PP
 This command is normally issued
 by an X2Go client application with X2Go user privileges.
+.SH ARGUMENTS
+.TP
+\*(T<\fI\<session_id>\fR\*(T>
+The session ID (or session name) of the suspend session that is to be resumed.
+.TP
+\*(T<\fI\<geometry>\fR\*(T>
+Session window size on screen (allowed values: <width>x<height> or fullscreen).
+.TP
+\*(T<\fI\<link_quality>\fR\*(T>
+Any value out of: modem, isdn, adsl, wan or lan.
+.TP
+\*(T<\fI\<nx_pack_method>\fR\*(T>
+NX compression method (see below for possible values).
+.TP
+\*(T<\fI\<cache_type+dpi>\fR\*(T>
+Cache type and color depth for X2Go session window. The most common value is: unix-kde-depth_24 where ,,24'' is the color depth in bit.
+.TP
+\*(T<\fI\<kblayout>\fR\*(T>
+Keyboard layout (e.g. us, de, etc.).
+.TP
+\*(T<\fI\<kbtype>\fR\*(T>
+Keyboard type/model (e.g. pc105/us).
+.TP
+\*(T<\fI\<setkbd>\fR\*(T>
+Force setting keyboard layout and type within the X2Go session on startup. Values: 0 or 1.
+.TP
+\*(T<\fI\<clipboardmode>\fR\*(T>
+The session's clipboard mode. Possible values: both, server, client, none. Allows to configure clipboard security
+per session via the connecting X2Go client. If the clipboard parameter is set server-side in /etc/x2go/x2goagent.options,
+then that value will override client-side settings.
 .SH RETURN VALUES
-\fBx2goresume-session\fR reports to stderr if resuming of session <session_id> failed. This
-very probably means that the session's X agent has died, so the session <session_id> will
+\fBx2goresume-session\fR reports to stderr if resuming of session \fI<session_id>\fR failed. This
+very probably means that the session's X agent has died, so the session \fI<session_id>\fR will
 be marked as finished in the X2Go session database.
 .PP
+If everything works out well, a list of session attributes is returned after successful session resumption. 
+Session attributes will be presented on a line-by-line basis:
+
+    field 01: \fI<graphics_port>\fR
+    field 02: \fI<sound_port>\fR
+    field 03: \fI<sshfs_port>\fR
+    field 04: \fI<tekictrl_port>\fR (if Telekinesis is available/enabled)
+    field 04: \fI<tekidata_port>\fR (if Telekinesis is available/enabled)
+
+.PP
 As exitcode \fBx2goresume-session\fR always returns 0.
 .SH SEE ALSO
 x2gostartagent(8), x2goruncommand(8), x2gosuspend-session(8), x2goterminate-session(8)
diff --git a/x2goserver/man/man8/x2goruncommand.8 b/x2goserver/man/man8/x2goruncommand.8
index 0c7ed56..3b417fb 100644
--- a/x2goserver/man/man8/x2goruncommand.8
+++ b/x2goserver/man/man8/x2goruncommand.8
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2goruncommand 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2goruncommand 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2goruncommand \- Launch Command inside an X2Go Session
 .SH SYNOPSIS
diff --git a/x2goserver/man/man8/x2gosessionlimit.8 b/x2goserver/man/man8/x2gosessionlimit.8
index 4e3a82a..7b4371e 100644
--- a/x2goserver/man/man8/x2gosessionlimit.8
+++ b/x2goserver/man/man8/x2gosessionlimit.8
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2gosessionlimit 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2gosessionlimit 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2gosessionlimit \- Detect Session Limit for User or Group
 .SH SYNOPSIS
diff --git a/x2goserver/man/man8/x2gosetkeyboard.8 b/x2goserver/man/man8/x2gosetkeyboard.8
index aecc82f..2fcea47 100644
--- a/x2goserver/man/man8/x2gosetkeyboard.8
+++ b/x2goserver/man/man8/x2gosetkeyboard.8
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2gosetkeyboard 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool (PyHoca)"
+.TH x2gosetkeyboard 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool (PyHoca)"
 .SH NAME
 x2gosetkeyboard \- Allow server-side Keyboard Setting Updates issued by X2Go Client
 .SH SYNOPSIS
diff --git a/x2goserver/man/man8/x2goshowblocks.8 b/x2goserver/man/man8/x2goshowblocks.8
index ae8719f..8cc26e0 100644
--- a/x2goserver/man/man8/x2goshowblocks.8
+++ b/x2goserver/man/man8/x2goshowblocks.8
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2goshowblocks 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2goshowblocks 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2goshowblocks \- Show X2Go-Mounted Block Devices
 .SH SYNOPSIS
diff --git a/x2goserver/man/man8/x2gostartagent.8 b/x2goserver/man/man8/x2gostartagent.8
index 4d431cd..abfd1b4 100644
--- a/x2goserver/man/man8/x2gostartagent.8
+++ b/x2goserver/man/man8/x2gostartagent.8
@@ -5,14 +5,23 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2gostartagent 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2gostartagent 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2gostartagent \- Start a New X2Go Session
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2gostartagent <geometry> <link_quality> <nx_pack_meth> <cache_type+dpi> <kblayout> <kbtype> <setkbd> <session_type> <command>
+\fBx2gostartagent\fI \fI<geometry>\fR \ \\ 
+                \fI<link_quality>\fR \ \\
+                \fI<nx_pack_meth>\fR \ \\ 
+                \fI<cache_type+dpi>\fR \ \\ 
+                \fI<kblayout>\fR \ \\ 
+                \fI<kbtype>\fR \ \\ 
+                \fI<setkbd>\fR \ \\
+                \fI<session_type>\fR \ \\
+                \fI<command>\fR \ \\
+                \fI<clipboardmode>\fR \ \\
 
 .SH DESCRIPTION
 \fBx2gostartagent\fR coordinates the startup process of a new X2Go session.
@@ -21,49 +30,56 @@ It expects quite a list of parameters, all of which are obligatory.
 \fBx2gostartagent\fR is run with X2Go user privileges and normally executed by an X2Go client application.
 .SH ARGUMENTS
 .TP
-\*(T<\fB\<geometry>\fR\*(T>
+\*(T<\fI\<geometry>\fR\*(T>
 Session window size on screen (allowed values: <width>x<height> or fullscreen).
 .TP
-\*(T<\fB\<link_quality>\fR\*(T>
+\*(T<\fI\<link_quality>\fR\*(T>
 Any value out of: modem, isdn, adsl, wan or lan.
 .TP
-\*(T<\fB\<nx_pack_method>\fR\*(T>
+\*(T<\fI\<nx_pack_method>\fR\*(T>
 NX compression method (see below for possible values).
 .TP
-\*(T<\fB\<cache_type+dpi>\fR\*(T>
+\*(T<\fI\<cache_type+dpi>\fR\*(T>
 Cache type and color depth for X2Go session window. The most common value is: unix-kde-depth_24 where ,,24'' is the color depth in bit.
 .TP
-\*(T<\fB\<kblayout>\fR\*(T>
+\*(T<\fI\<kblayout>\fR\*(T>
 Keyboard layout (e.g. us, de, etc.).
 .TP
-\*(T<\fB\<kbtype>\fR\*(T>
+\*(T<\fI\<kbtype>\fR\*(T>
 Keyboard type/model (e.g. pc105/us).
 .TP
-\*(T<\fB\<setkbd>\fR\*(T>
+\*(T<\fI\<setkbd>\fR\*(T>
 Force setting keyboard layout and type within the X2Go session on startup. Values: 0 or 1.
 .TP
-\*(T<\fB\<session_type>\fR\*(T>
+\*(T<\fI\<session_type>\fR\*(T>
 Allowed values for <session_type> are: D (desktop), R (rootless) or S (shadow session, X2Go desktop sharing).
 .TP
-\*(T<\fB\<command>\fR\*(T>
+\*(T<\fI\<command>\fR\*(T>
 The command given by the <command> argument is only used to create the session ID for this new X2Go session. The
 actual execution of a command is handled by \fBx2goruncommand\fR.
+.TP
+\*(T<\fI\<clipboardmode>\fR\*(T>
+The session's clipboard mode. Possible values: both, server, client, none. Allows to configure clipboard security
+per session via the connecting X2Go client. If the clipboard parameter is set server-side in /etc/x2go/x2goagent.options,
+then that value will override client-side settings.
 .PP
 .SH RETURN VALUES
 A list of session attributes is returned after successful session startup. Session attributes will be presented
 on a line-by-line basis:
 
-    \fB<X_display_number>\fR
-    \fB<session_cookie_hash>\fR
-    \fB<agent_pid>\fR
-    \fB<session_id>\fR
-    \fB<graphics_port>\fR
-    \fB<sound_port>\fR
-    \fB<sshfs_port>\fR
+    field 01: \fI<X_display_number>\fR
+    field 02: \fI<session_cookie_hash>\fR
+    field 03: \fI<agent_pid>\fR
+    field 04: \fI<session_id>\fR
+    field 05: \fI<graphics_port>\fR
+    field 06: \fI<sound_port>\fR
+    field 07: \fI<sshfs_port>\fR
+    field 08: \fI<tekictrl_port>\fR (if Telekinesis is available/enabled)
+    field 09: \fI<tekidata_port>\fR (if Telekinesis is available/enabled)
 
 .PP
 .SH NX COMPRESSION METHODS
-As NX compression methods (\fB<link-quality>\fR argument) the following values are possible. The % character must be replaced by a digit 0-9.
+As NX compression methods (\fI<link-quality>\fR argument) the following values are possible. The % character must be replaced by a digit 0-9.
 .PP
 nopack, 8, 64, 256, 512, 4k, 32k, 64k, 256k, 2m, 16m
 256-rdp, 256-rdp-compressed, 32k-rdp, 32k-rdp-compressed, 64k-rdp
diff --git a/x2goserver/man/man8/x2gosuspend-session.8 b/x2goserver/man/man8/x2gosuspend-session.8
index 4bcc257..81b4033 100644
--- a/x2goserver/man/man8/x2gosuspend-session.8
+++ b/x2goserver/man/man8/x2gosuspend-session.8
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2gosuspend-session 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2gosuspend-session 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2gosuspend-session \- Suspend an X2Go Session
 .SH SYNOPSIS
diff --git a/x2goserver/man/man8/x2goterminate-session.8 b/x2goserver/man/man8/x2goterminate-session.8
index 231bc07..c77fe21 100644
--- a/x2goserver/man/man8/x2goterminate-session.8
+++ b/x2goserver/man/man8/x2goterminate-session.8
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2goterminate-session 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2goterminate-session 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2goterminate-session \- Terminate an X2Go Session
 .SH SYNOPSIS
diff --git a/x2goserver/man/man8/x2goumount-session.8 b/x2goserver/man/man8/x2goumount-session.8
index 5609b9c..3ac13fe 100644
--- a/x2goserver/man/man8/x2goumount-session.8
+++ b/x2goserver/man/man8/x2goumount-session.8
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2goumount-session 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2goumount-session 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2goumount-session \- Unshare mounted Folders from X2Go Session
 .SH SYNOPSIS
diff --git a/x2goserver/man/man8/x2goversion.8 b/x2goserver/man/man8/x2goversion.8
index 03cab17..11e2daf 100644
--- a/x2goserver/man/man8/x2goversion.8
+++ b/x2goserver/man/man8/x2goversion.8
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2goversion 8 "Jan 2013" "Version 4.1.0.0-preview" "X2Go Server Tool"
+.TH x2goversion 8 "Jun 2014" "Version 4.1.0.0-preview" "X2Go Server Tool"
 .SH NAME
 x2goversion \- Retrieve Code Versions of X2Go Server Components
 .SH SYNOPSIS

--
Alioth's /srv/git/_hooks_/post-receive-email on /srv/git/code.x2go.org/x2goserver.git


More information about the x2go-commits mailing list