[X2go-Commits] x2goserver.git - master (branch) updated: 3.0.99-2-272-g2c8b4d0

X2go dev team git-admin at x2go.org
Tue Sep 20 16:50:40 CEST 2011


The branch, master has been updated
       via  2c8b4d0343361ed9e3086fb403f9c4fbbce7b042 (commit)
      from  7756d7a917376297c35aa28246ec19fad3451c22 (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 -----------------------------------------------------------------
commit 2c8b4d0343361ed9e3086fb403f9c4fbbce7b042
Author: Mike Gabriel <mike.gabriel at das-netzwerkteam.de>
Date:   Tue Sep 20 16:51:41 2011 +0200

    Improvement of man pages.

-----------------------------------------------------------------------

Summary of changes:
 debian/changelog                            |    1 +
 x2goserver/man/man8/x2gocleansessions.8     |    3 +-
 x2goserver/man/man8/x2gocmdexitmessage.8    |    8 ++-
 x2goserver/man/man8/x2godbadmin.8           |    1 +
 x2goserver/man/man8/x2golistdesktops.8      |   19 ++++++--
 x2goserver/man/man8/x2golistsessions.8      |   16 +++++--
 x2goserver/man/man8/x2golistsessions_root.8 |   13 +++--
 x2goserver/man/man8/x2gomountdirs.8         |   34 +++++++++++--
 x2goserver/man/man8/x2goprint.8             |   44 +++++++++++++++--
 x2goserver/man/man8/x2goresume-session.8    |   12 +++--
 x2goserver/man/man8/x2goruncommand.8        |   33 +++++++++++--
 x2goserver/man/man8/x2goshowblocks.8        |   12 +++--
 x2goserver/man/man8/x2gostartagent.8        |   70 +++++++++++++++++++++++----
 x2goserver/man/man8/x2gosuspend-session.8   |   12 +++--
 x2goserver/man/man8/x2goterminate-session.8 |   12 +++--
 x2goserver/man/man8/x2goumount-session.8    |   23 +++++++--
 16 files changed, 253 insertions(+), 60 deletions(-)

The diff of changes is:
diff --git a/debian/changelog b/debian/changelog
index cbaf353..b19fae7 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -66,6 +66,7 @@ x2goserver (3.0.99.5-0~x2go3) UNRELEASED; urgency=low
   * Fix x2goumount-session for individual paths (folder type: disk),
     ToDo: folder type CDROM and removable media.
   * Let db_insertmount create a proper return value (success vs. failed).
+  * Improvement of man pages.
 
   [ Ivan Kabaivanov ]
   * Makefile fix around man page installation in x2goserver-compat package.
diff --git a/x2goserver/man/man8/x2gocleansessions.8 b/x2goserver/man/man8/x2gocleansessions.8
index 860c180..cfc79fc 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 "18 May 2011" "Version 3.0.99.x" "X2go Server Admin Tool"
+.TH x2gocleansessions 8 "Sep 2011" "Version 3.0.99.x" "X2go Server Admin Tool"
 .SH NAME
 x2gocleansessions \- X2go Server Cleanup Daemon
 .SH SYNOPSIS
@@ -17,6 +17,7 @@ x2gocleansessions
 .SH DESCRIPTION
 \fBx2gocleansessions\fR is run as a service on X2go servers to handle the cleanup of stale sessions.
 .PP
+\fBx2gocleansessions\fR must be run (as a service) with root privileges.
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
 (http://www.x2go.org).
diff --git a/x2goserver/man/man8/x2gocmdexitmessage.8 b/x2goserver/man/man8/x2gocmdexitmessage.8
index 14681ba..6d31d77 100644
--- a/x2goserver/man/man8/x2gocmdexitmessage.8
+++ b/x2goserver/man/man8/x2gocmdexitmessage.8
@@ -7,15 +7,17 @@
 .if \n(.g .mso www.tmac
 .TH x2gocmdexitmessage 8 "July 2011" "Version 3.0.99.x" "X2go Server Tool"
 .SH NAME
-x2goexitmessage \- X2go Server Script
+x2gocmdexitmessage \- Exit Message of X2go Command
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2goexitmessage
+x2gocmdexitmessage <session_id>
 
 .SH DESCRIPTION
-\fBx2goexitmessage\fR is one of many scripts belonging to X2go Server.
+\fBx2gocmdexitmessage\fR prints out the exit message of the last command run with \fBx2goruncommand\fR for session <session_id>.
+
+\fBx2gocmdexitmessage\fR is run with X2go user privileges.
 .PP
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
diff --git a/x2goserver/man/man8/x2godbadmin.8 b/x2goserver/man/man8/x2godbadmin.8
index 1046f36..01ac1b0 100644
--- a/x2goserver/man/man8/x2godbadmin.8
+++ b/x2goserver/man/man8/x2godbadmin.8
@@ -18,6 +18,7 @@ x2godbadmin <options>
 \fBx2godbadmin\fR is used to set up the initial X2go session database and perform other
 maintenance tasks on the X2go server's database.
 .PP
+\fBx2godbadmin\fR must be run with root privileges.
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
 (http://www.x2go.org).
diff --git a/x2goserver/man/man8/x2golistdesktops.8 b/x2goserver/man/man8/x2golistdesktops.8
index 1436bda..79baffc 100644
--- a/x2goserver/man/man8/x2golistdesktops.8
+++ b/x2goserver/man/man8/x2golistdesktops.8
@@ -5,18 +5,29 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2golistdesktops 8 "July 2011" "Version 3.0.99.x" "X2go Server Tool"
+.TH x2golistdesktops 8 "Sep 2011" "Version 3.0.99.x" "X2go Server Tool"
 .SH NAME
-x2golistdesktops \- X2go Server Script
+x2golistdesktops \- List Available X Desktops
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2golistdesktops
+x2golistdesktops [<server-hostname>]
 
 .SH DESCRIPTION
-\fBx2golistdesktops\fR is one of many scripts belonging to X2go Server.
+\fBx2golistdesktops\fR returns a list of active desktop sessions running on server <server-hostnamme>.
+If no server hostname is given at the command line, the fully qualified domain name of the local system
+is used here.
 .PP
+\fBx2golistdesktops\fR is run with X2go user privileges and it is used by X2go clients to render
+a list of available desktops that may be candidates for X2go desktop sharing (shadow sessions).
+.PP
+The list of desktops will include local desktop sessions (launched via KDM, GDM, etc.) run by the same user, X2go desktop
+sessions run by the same user and desktop sessions of other users (local or remote) that are announced via 
+the \fBx2godesktopsharing\fR utility.
+.PP
+.SH SEE ALSO
+x2godesktopsharing(1)
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
 (http://www.x2go.org).
diff --git a/x2goserver/man/man8/x2golistsessions.8 b/x2goserver/man/man8/x2golistsessions.8
index 54f85b3..170a3d1 100644
--- a/x2goserver/man/man8/x2golistsessions.8
+++ b/x2goserver/man/man8/x2golistsessions.8
@@ -5,17 +5,25 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2golistsessions 8 "18 May 2011" "Version 3.0.99.x" "X2go Server Tool"
+.TH x2golistsessions 8 "Sep 2011" "Version 3.0.99.x" "X2go Server Tool"
 .SH NAME
-x2golistsessions \- X2go Server Script
+x2golistsessions \- List Available X2go Sessions for User
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2golistsessions
+x2golistsessions [<server-hostname|--all-servers]
 
 .SH DESCRIPTION
-\fBx2golistsessions\fR is one of many scripts belonging to X2go Server.
+\fBx2golistsessions\fR returns a list of running or suspended X2go sessions for X2go server <server-hostnamme>.
+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
+a list of available X2go sessions.
+.SH X2GO CLUSTER MODE
+If \fBx2golistsessions\fR is executed with the \fI--all-servers\fR option then the central database
+of your X2go cluster is queried for running/suspended sessions belonging to the user executing this command.
+These sessions may be active on any of the X2go servers within you cluster.
 .PP
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
diff --git a/x2goserver/man/man8/x2golistsessions_root.8 b/x2goserver/man/man8/x2golistsessions_root.8
index 1a5816a..cf7e29f 100644
--- a/x2goserver/man/man8/x2golistsessions_root.8
+++ b/x2goserver/man/man8/x2golistsessions_root.8
@@ -5,19 +5,20 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2golistsessions_root 8 "July 2011" "Version 3.0.99.x" "X2go Server Admin Tool"
+.TH x2golistsessions_root 8 "Sep 2011" "Version 3.0.99.x" "X2go Server Admin Tool"
 .SH NAME
-x2golistsessions_root \- List all X2go sessions currently available
+x2golistsessions_root \- List X2go Sessions for System
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2golistsessions_root [<server-name>]
+x2golistsessions_root [<server-hostname>]
 
 .SH DESCRIPTION
-\fBx2golistsessions_root\fR shows a list of all available X2go session on the server <server-name> or--if
-no server name is specified--of all X2go servers in the X2go cluster.
-
+\fBx2golistsessions_root\fR shows a list of all available X2go sessions on the server <server-hostname>.
+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.
 .PP
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
diff --git a/x2goserver/man/man8/x2gomountdirs.8 b/x2goserver/man/man8/x2gomountdirs.8
index fec5c97..b51f928 100644
--- a/x2goserver/man/man8/x2gomountdirs.8
+++ b/x2goserver/man/man8/x2gomountdirs.8
@@ -5,18 +5,44 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2gomountdirs 8 "18 May 2011" "Version 3.0.99.x" "X2go Server Tool"
+.TH x2gomountdirs 8 "Sep 2011" "Version 3.0.99.x" "X2go Server Tool"
 .SH NAME
-x2gomountdirs \- X2go Server Script
+x2gomountdirs \- Share Client-Side Folder with X2go Session
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2gomountdirs
+x2gomountdirs <mount_type> <session_id> <username> <key_file> <dir1> [<dir2> [<dir3> [...]]]
 
 .SH DESCRIPTION
-\fBx2gomountdirs\fR is one of many scripts belonging to X2go Server.
+\fBx2gomountdirs\fR mounts client-side folders or devices onto mountpoints that are accessible
+from within your remote X2go session.
 .PP
+\fBx2gomountdirs\fR is run with X2go user privileges and normally issued by an X2go client application.
+.SH ARGUMENTS
+.TP
+\*(T<\fB\<mount_type>\fR\*(T>
+If the mount type is set to ,,dir'' then the client-side mount target is interpreted as a folder. If other,
+it is interpreted as a device.
+.TP
+\*(T<\fB\<session_id>\fR\*(T>
+The <session_id> is the unique identifier of the X2go session that this command is run for.
+.TP
+\*(T<\fB\<username>\fR\*(T>
+The owner of session <session_id> is given as the <username> argument.
+.TP
+\*(T<\fB\<key_file>\fR\*(T>
+Location of a temporary private SSH key file (only valid for this command execution).
+.TP
+\*(T<\fB\<dir1> [<dir2> [<dir3> [...]]]\fR\*(T>
+A list of client-side folders or device mount points that shall be mounted for X2go session <session_id>.
+.PP
+.SH PERMISSIONS
+X2go uses the fuse-based SSH filesystem (SSHFS) for sharing client-side file ressources with X2go sessions.
+Users that shall use X2go folder sharing must be members of the X2go server's ,,fuse'' POSIX group.
+.PP
+.SH SEE ALSO
+x2goumount-session(8)
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
 (http://www.x2go.org).
diff --git a/x2goserver/man/man8/x2goprint.8 b/x2goserver/man/man8/x2goprint.8
index 542aa2c..a8d8ec1 100644
--- a/x2goserver/man/man8/x2goprint.8
+++ b/x2goserver/man/man8/x2goprint.8
@@ -5,17 +5,53 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2goprint 8 "18 May 2011" "Version 3.0.99.x" "X2go Server Tool"
+.TH x2goprint 8 "Sep 2011" "Version 3.0.99.x" "X2go Server Tool"
 .SH NAME
-x2goprint \- X2go Server Script
+x2goprint \- Process X2go Print Job
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2goprint
+x2goprint <username> <session_id> <pdf_file> <title_file>
 
 .SH DESCRIPTION
-\fBx2goprint\fR is one of many scripts belonging to X2go Server.
+X2go print jobs are rendered by the \fBcups-x2go\fR backend on your network's (central) CUPS server and
+then get copied to the X2go server that the X2go print job was issued from.
+.PP
+On that X2go server \fBcups-x2go\fR places two print job files (a PDF file and a title file)
+into the home directory of the POSIX system user ,,x2goprint'' where they await further processing
+by \fBx2goprint\fR.
+.PP
+The \fBx2goprint\fR command on the session's X2go server (executed by \fBcups-x2go\fR backend) then
+prepares the job files for delivery to the X2go client-side.
+.PP
+\fBx2goprint\fR must run with root privileges and is executed by \fBcups-x2go\fR.
+.SH ARGUMENTS
+.TP
+\*(T<\fB\<username>\fR\*(T>
+The owner of the incoming print jobs is given as the <username> argument.
+.TP
+\*(T<\fB\<session_id>\fR\*(T>
+The <session_id> is the unique identifier of the X2go session that the processed print job is
+coming from.
+.TP
+\*(T<\fB\<pdf_file>\fR\*(T>
+The filename of the PDF file as dropped into ~x2goprint by \fBcups-x2go\fR.
+.TP
+\*(T<\fB\<title_file>\fR\*(T>
+The filename of the title file as dropped into ~x2goprint by \fBcups-x2go\fR.
+.PP
+.SH PERMISSIONS
+X2go uses the fuse-based SSH filesystem (SSHFS) for transferring print jobs from X2go server to X2go client.
+Users that shall use X2go printing must be members of the X2go server's ,,fuse'' POSIX group.
+.PP
+.SH X2GO CLUSTER MODE
+If X2go server and CUPS server are the same machine, no further setup for X2go printing is necessary.
+.PP
+However, if X2go server and CUPS server are hosted on separate machines then a special setup of sudo and SSH
+is required on X2go server(s) and the central CUPS server.
+.PP
+Refer to http://wiki.x2go.org/installing_x2go_printing_debian_ubuntu for further information.
 .PP
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
diff --git a/x2goserver/man/man8/x2goresume-session.8 b/x2goserver/man/man8/x2goresume-session.8
index f18f421..1004fb1 100644
--- a/x2goserver/man/man8/x2goresume-session.8
+++ b/x2goserver/man/man8/x2goresume-session.8
@@ -5,18 +5,22 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2goresume-session 8 "18 May 2011" "Version 3.0.99.x" "X2go Server Tool"
+.TH x2goresume-session 8 "Sep 2011" "Version 3.0.99.x" "X2go Server Tool"
 .SH NAME
-x2goresume-session \- X2go Server Script
+x2goresume-session \- Resume X2go Session
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2goresume-session
+x2goresume-session <session_id>
 
 .SH DESCRIPTION
-\fBx2goresume-session\fR is one of many scripts belonging to X2go Server.
+\fBx2goresume-session\fR resumes the suspended session with session ID <session_id>.
 .PP
+This command is normally issued
+by an X2go client application with X2go user privileges.
+.SH SEE ALSO
+x2gostartagent(8), x2goruncommand(8), x2gosuspend-session(8), x2goterminate-session(8)
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
 (http://www.x2go.org).
diff --git a/x2goserver/man/man8/x2goruncommand.8 b/x2goserver/man/man8/x2goruncommand.8
index 370d907..c8ca8b6 100644
--- a/x2goserver/man/man8/x2goruncommand.8
+++ b/x2goserver/man/man8/x2goruncommand.8
@@ -5,18 +5,43 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2goruncommand 8 "18 May 2011" "Version 3.0.99.x" "X2go Server Tool"
+.TH x2goruncommand 8 "Sep 2011" "Version 3.0.99.x" "X2go Server Tool"
 .SH NAME
-x2goruncommand \- X2go Server Script
+x2goruncommand \- Launch Command inside an X2go Session
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2goruncommand
+x2goruncommand <display> <agent_pid> <session_id> <command> <sound_system> <session_type>
 
 .SH DESCRIPTION
-\fBx2goruncommand\fR is one of many scripts belonging to X2go Server.
+\fBx2goruncommand\fR launches a(n X-based) command inside of a given X2go session.
 .PP
+\fBx2goruncommand\fR is run with X2go user privileges and normally executed by an X2go client application.
+.SH ARGUMENTS
+.TP
+\*(T<\fB\<display>\fR\*(T>
+The X display number/port of the session this command is for.
+.TP
+\*(T<\fB\<agent_pid>\fR\*(T>
+The process ID (pid) of the x2goagent instance that the given session runs in.
+.TP
+\*(T<\fB\<session_id>\fR\*(T>
+The <session_id> is the unique identifier of the X2go session that this command is intended for.
+.TP
+\*(T<\fB\<command>\fR\*(T>
+Execute command <command>. Full paths will be ignored, the command has to be in the server's $PATH.
+
+Possible generic values for <command> are: WWWBROWSER, OFFICE, MAILCLIENT and TERMINAL.
+.TP
+\*(T<\fB\<sound_system>\fR\*(T>
+Either of the possible sound systems supported by X2go: pulse, esd, arts (obsolete) or none.
+.TP
+\*(T<\fB\<session_type>\fR\*(T>
+Allowed values for <session_type> are: D (desktop) and R (rootless).
+.PP
+.SH SEE ALSO
+x2gostartagent(8), x2goresume-session(8), x2gosuspend-session(8), x2goterminate-sessions(8)
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
 (http://www.x2go.org).
diff --git a/x2goserver/man/man8/x2goshowblocks.8 b/x2goserver/man/man8/x2goshowblocks.8
index 370d907..372a995 100644
--- a/x2goserver/man/man8/x2goshowblocks.8
+++ b/x2goserver/man/man8/x2goshowblocks.8
@@ -5,18 +5,22 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2goruncommand 8 "18 May 2011" "Version 3.0.99.x" "X2go Server Tool"
+.TH x2goshowblocks 8 "Sep 2011" "Version 3.0.99.x" "X2go Server Tool"
 .SH NAME
-x2goruncommand \- X2go Server Script
+x2goshowblocks \- Show X2go-Mounted Block Devices
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2goruncommand
+x2goshowblocks <username> <session_id>
 
 .SH DESCRIPTION
-\fBx2goruncommand\fR is one of many scripts belonging to X2go Server.
+\fBx2goshowblocks\fR lists mounted shares for user <username> and X2go session with ID <session_id>.
 .PP
+The \fBx2goshowblocks\fR must be run with root privileges.
+
+.SH SEE ALSO
+x2gomountdirs(8), x2goumount-session(8)
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
 (http://www.x2go.org).
diff --git a/x2goserver/man/man8/x2gostartagent.8 b/x2goserver/man/man8/x2gostartagent.8
index 6a84a72..0296f4b 100644
--- a/x2goserver/man/man8/x2gostartagent.8
+++ b/x2goserver/man/man8/x2gostartagent.8
@@ -7,29 +7,79 @@
 .if \n(.g .mso www.tmac
 .TH x2gostartagent 8 "18 May 2011" "Version 3.0.99.x" "X2go Server Tool"
 .SH NAME
-x2gostartagent \- X2go Server Script
+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>
+x2gostartagent <geometry> <link_quality> <nx_pack_meth> <cache_type+dpi> <kblayout> <kbtype> <setkbd> <session_type> <command>
 
 .SH DESCRIPTION
-\fBx2gostartagent\fR is a script that coordinates the startup process of new X2go sessions. 
+\fBx2gostartagent\fR coordinates the startup process of a new X2go session.
 It expects quite a list of parameters, all of which are obligatory.
+.PP
+\fBx2gostartagent\fR is run with X2go user privileges and normally executed by an X2go client application.
+.SH ARGUMENTS
+.TP
+\*(T<\fB\<geometry>\fR\*(T>
+Session window size on screen (allowed values: <width>x<height> or fullscreen).
+.TP
+\*(T<\fB\<link_quality>\fR\*(T>
+Any value out of: modem, isdn, adsl, wan or lan.
+.TP
+\*(T<\fB\<nx_pack_method>\fR\*(T>
+NX compression method (see below for possible values).
+.TP
+\*(T<\fB\<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>
+Keyboard layout (e.g. us, de, etc.).
+.TP
+\*(T<\fB\<kbtype>\fR\*(T>
+Keyboard type/model (e.g. pc105/us).
+.TP
+\*(T<\fB\<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>
+Allowed values for <session_type> are: D (desktop), R (rootless) or S (shadow session, X2go desktop sharing).
+.TP
+\*(T<\fB\<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.
+.PP
 .SH RETURN VALUES
 A list of parameters will be returned after a successful session startup. Each value will be presented on
 a new line:
 
-    \fB<X-display-number>\fR
-    \fB<session-cookie-hash>\fR
-    \fB<x2goagent-pid>\fR
-    \fB<session-name>\fR
-    \fB<graphics-port>\fR
-    \fB<sound-port>\fR
-    \fB<sshfs-port>\fR
+    \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
 
 .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.
+.PP
+nopack, 8, 64, 256, 512, 4k, 32k, 64k, 256k, 2m, 16m
+256-rdp, 256-rdp-compressed, 32k-rdp, 32k-rdp-compressed, 64k-rdp
+64k-rdp-compressed, 16m-rdp, 16m-rdp-compressed
+rfb-hextile, rfb-tight, rfb-tight-compressed
+8-tight, 64-tight, 256-tight, 512-tight, 4k-tight, 32k-tight
+64k-tight, 256k-tight, 2m-tight, 16m-tight
+8-jpeg-%, 64-jpeg, 256-jpeg, 512-jpeg, 4k-jpeg, 32k-jpeg
+64k-jpeg, 256k-jpeg, 2m-jpeg, 16m-jpeg-%
+8-png-jpeg-%, 64-png-jpeg, 256-png-jpeg, 512-png-jpeg, 4k-png-jpeg
+32k-png-jpeg, 64k-png-jpeg, 256k-png-jpeg, 2m-png-jpeg, 16m-png-jpeg-%
+8-png-%, 64-png, 256-png, 512-png, 4k-png
+32k-png, 64k-png, 256k-png, 2m-png, 16m-png-%
+16m-rgb-%, 16m-rle-%
+.SH SEE ALSO
+x2goruncommand(8), x2goresume-session(8), x2gosuspend-session(8), x2goterminate-session(8)
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
 (http://www.x2go.org).
diff --git a/x2goserver/man/man8/x2gosuspend-session.8 b/x2goserver/man/man8/x2gosuspend-session.8
index ec4aa2c..c24a077 100644
--- a/x2goserver/man/man8/x2gosuspend-session.8
+++ b/x2goserver/man/man8/x2gosuspend-session.8
@@ -5,18 +5,22 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2gosuspend-session 8 "18 May 2011" "Version 3.0.99.x" "X2go Server Tool"
+.TH x2gosuspend-session 8 "Sep 2011" "Version 3.0.99.x" "X2go Server Tool"
 .SH NAME
-x2gosuspend-session \- X2go Server Script
+x2gosuspend-session \- Suspend an X2go Session
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2gosuspend-session
+x2gosuspend-session <session_id>
 
 .SH DESCRIPTION
-\fBx2gosuspend-session\fR is one of many scripts belonging to X2go Server.
+\fBx2gosuspend-session\fR suspends the running session with session ID <session_id>.
 .PP
+This command is normally issued by an X2go client application with X2go user privileges.
+.PP
+.SH SEE ALSO
+x2gostartagent(8), x2goruncommand(8), x2goresume-session(8), x2goterminate-session(8)
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
 (http://www.x2go.org).
diff --git a/x2goserver/man/man8/x2goterminate-session.8 b/x2goserver/man/man8/x2goterminate-session.8
index 2bfcce8..f007a99 100644
--- a/x2goserver/man/man8/x2goterminate-session.8
+++ b/x2goserver/man/man8/x2goterminate-session.8
@@ -5,18 +5,22 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2goterminate-session 8 "18 May 2011" "Version 3.0.99.x" "X2go Server Tool"
+.TH x2goterminate-session 8 "Sep 2011" "Version 3.0.99.x" "X2go Server Tool"
 .SH NAME
-x2goterminate-session \- X2go Server Script
+x2goterminate-session \- Terminate an X2go Session
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2goterminate-session
+x2goterminate-session <session_id>
 
 .SH DESCRIPTION
-\fBx2goterminate-session\fR is one of many scripts belonging to X2go Server.
+\fBx2goterminate-session\fR cleanly terminates the running or suspended session with session ID <session_id>.
 .PP
+This command is normally issued by an X2go client application with X2go user privileges.
+.PP
+.SH SEE ALSO
+x2gostartagent(8), x2goruncommand(8), x2goresume-session(8), x2gosuspend-session(8)
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
 (http://www.x2go.org).
diff --git a/x2goserver/man/man8/x2goumount-session.8 b/x2goserver/man/man8/x2goumount-session.8
index 8e8fe0d..151dea1 100644
--- a/x2goserver/man/man8/x2goumount-session.8
+++ b/x2goserver/man/man8/x2goumount-session.8
@@ -5,18 +5,33 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH x2goumount-session 8 "18 May 2011" "Version 3.0.99.x" "X2go Server Tool"
+.TH x2goumount-session 8 "Sep 2011" "Version 3.0.99.x" "X2go Server Tool"
 .SH NAME
-x2goumount-session \- X2go Server Script
+x2goumount-session \- Unshare mounted Folders from X2go Session
 .SH SYNOPSIS
 'nh
 .fi
 .ad l
-x2goumount-session
+x2goumount-session <session_id> [<local_path_on_client>]
 
 .SH DESCRIPTION
-\fBx2goumount-session\fR is one of many scripts belonging to X2go Server.
+\fBx2goumount-session\fR is used to unshare client folders from X2go session with session ID <session_id>.
+Shared folders have been previously mounted into the X2go session by the \fBx2gomountdirs\fR command.
 .PP
+\fBx2goumount-session\fR is run with X2go user privileges and normally issued by an X2go client application.
+.SH ARGUMENTS
+.TP
+\*(T<\fB\<session_id>\fR\*(T>
+Unmount shared folder(s) as registered for X2go session ID <session_id> in the X2go session database.
+.TP
+\*(T<\fB\<local_path_on_client>\fR\*(T>
+Optionally, you can name a local path name (path name as found on the client-side) here. If given,
+only the named folder is unshared from the X2go session <session_id>.
+
+If this optional argument is omitted, then ALL session folders will be unshared (including spool folders for printing and MIME box).
+
+.SH SEE ALSO
+x2gomountdirs(8)
 .SH AUTHOR
 This manual has been written by Mike Gabriel <mike.gabriel at das-netzwerkteam.de> for the X2go project
 (http://www.x2go.org).


hooks/post-receive
-- 
x2goserver.git (X2go Server)

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 "x2goserver.git" (X2go Server).




More information about the x2go-commits mailing list