[X2Go-Commits] x2goserver.git - build-main (branch) updated: 3.0.99-2-277-gcea2b3c

X2Go dev team git-admin at x2go.org
Wed Dec 4 06:17:50 CET 2013


The branch, build-main has been updated
       via  cea2b3cb96b8a0ab8ca52d8b1751c481b64e75f5 (commit)
      from  c12be797c5798f68a73ce3581fb6b46a4912b03a (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 +
 x2goserver-extensions/man/man8/x2gosetkeyboard.8 |    5 +++++
 x2goserver-extensions/man/man8/x2goversion.8     |    3 +++
 x2goserver/bin/x2goresume-session                |    6 ++---
 x2goserver/man/man8/x2gocmdexitmessage.8         |    4 ++++
 x2goserver/man/man8/x2golistdesktops.8           |    3 +++
 x2goserver/man/man8/x2golistsessions.8           |   26 +++++++++++++++++++++-
 x2goserver/man/man8/x2golistsessions_root.8      |    4 ++++
 x2goserver/man/man8/x2gomountdirs.8              |   19 ++++++++++++++++
 x2goserver/man/man8/x2goprint.8                  |    6 +++++
 x2goserver/man/man8/x2goresume-session.8         |    4 ++++
 x2goserver/man/man8/x2goruncommand.8             |    3 +++
 x2goserver/man/man8/x2gostartagent.8             |    4 ++--
 x2goserver/man/man8/x2gosuspend-session.8        |    3 +++
 x2goserver/man/man8/x2goterminate-session.8      |    3 +++
 x2goserver/man/man8/x2goumount-session.8         |    9 ++++++--
 16 files changed, 95 insertions(+), 8 deletions(-)

The diff of changes is:
diff --git a/debian/changelog b/debian/changelog
index b19fae7..1a13e68 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -67,6 +67,7 @@ x2goserver (3.0.99.5-0~x2go3) UNRELEASED; urgency=low
     ToDo: folder type CDROM and removable media.
   * Let db_insertmount create a proper return value (success vs. failed).
   * Improvement of man pages.
+  * Add return value information of X2go commands to man pages.
 
   [ Ivan Kabaivanov ]
   * Makefile fix around man page installation in x2goserver-compat package.
diff --git a/x2goserver-extensions/man/man8/x2gosetkeyboard.8 b/x2goserver-extensions/man/man8/x2gosetkeyboard.8
index 702155f..e77ee77 100644
--- a/x2goserver-extensions/man/man8/x2gosetkeyboard.8
+++ b/x2goserver-extensions/man/man8/x2gosetkeyboard.8
@@ -20,7 +20,12 @@ the X2go session keyboard settings requested from the client side.
 .PP
 If no 'keyboard' file is present in the X2go session directory, nothing happens (i.e. no error
 will be raised).
+.SH RETURN VALUES
+If \fBx2gosetkeyboard\fR successfully sets the session's keyboard parameters an exit code of 0 is
+returned. Also, if the file ${HOME}/.x2go/C-${X2GO_SESSION}/keyboard is not presented at the
+expected location, a zero-exitcode is returned.
 .PP
+If the command fails on its way, then the exitcode of the failing command is returned.
 .SH FILES
 ${HOME}/.x2go/C-${X2GO_SESSION}/keyboard
 .PP
diff --git a/x2goserver-extensions/man/man8/x2goversion.8 b/x2goserver-extensions/man/man8/x2goversion.8
index bb07d83..4d99559 100644
--- a/x2goserver-extensions/man/man8/x2goversion.8
+++ b/x2goserver-extensions/man/man8/x2goversion.8
@@ -26,7 +26,10 @@ component's version is printed to stdout.
 .PP
 The \fBx2goversion\fR tool can be used by X2go client implementations to query server-side versions
 of X2go components.
+.SH RETURN VALUES
+\fBx2goversion\fR reports X2go component version information to stdout.
 .PP
+As exitcode \fBx2goversion\fR always returns 0.
 .SH FILES
 /usr/share/x2go/versions/VERSION.*
 .PP
diff --git a/x2goserver/bin/x2goresume-session b/x2goserver/bin/x2goresume-session
index 24fd6db..85d43a9 100755
--- a/x2goserver/bin/x2goresume-session
+++ b/x2goserver/bin/x2goresume-session
@@ -86,7 +86,7 @@ $X2GO_LIB_PATH/x2goresume  $X2GO_CLIENT $SESSION_NAME  > /dev/null
 kill -HUP $X2GO_AGENT_PID &>/dev/null && {
 	$X2GO_LIB_PATH/x2gosyslog "$0" "notice" "client $X2GO_CLIENT has successfully resumed session with ID $SESSION_NAME"
 } || {
-       err_msg="ERROR: failed to resume session with ID $SESSION_NAME"
-       echo "$err_msg" 1>&2
-       $X2GO_LIB_PATH/x2gosyslog "$0" "err" "$err_msg"
+	err_msg="ERROR: failed to resume session with ID $SESSION_NAME"
+	echo "$err_msg" 1>&2
+	$X2GO_LIB_PATH/x2gosyslog "$0" "err" "$err_msg"
 }
diff --git a/x2goserver/man/man8/x2gocmdexitmessage.8 b/x2goserver/man/man8/x2gocmdexitmessage.8
index 6d31d77..c27f142 100644
--- a/x2goserver/man/man8/x2gocmdexitmessage.8
+++ b/x2goserver/man/man8/x2gocmdexitmessage.8
@@ -19,6 +19,10 @@ x2gocmdexitmessage <session_id>
 
 \fBx2gocmdexitmessage\fR is run with X2go user privileges.
 .PP
+.SH RETURN VALUES
+\fBx2gocmdexitmessage\fR prints out the last command's exit message.
+.PP
+As exitcode \fBx2gocmdexitmessage\fR always returns 0.
 .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 62d1782..3703f79 100644
--- a/x2goserver/man/man8/x2golistdesktops.8
+++ b/x2goserver/man/man8/x2golistdesktops.8
@@ -25,7 +25,10 @@ a list of available desktops that may be candidates for X2go desktop sharing (sh
 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.
+.SH RETURN VALUES
+A list of available X desktops, line-by-line.
 .PP
+As exitcode \fBx2golistdesktop\fR always returns 0.
 .SH SEE ALSO
 x2godesktopsharing(1)
 .SH AUTHOR
diff --git a/x2goserver/man/man8/x2golistsessions.8 b/x2goserver/man/man8/x2golistsessions.8
index ad6ec49..adbbac6 100644
--- a/x2goserver/man/man8/x2golistsessions.8
+++ b/x2goserver/man/man8/x2golistsessions.8
@@ -12,7 +12,7 @@ x2golistsessions \- List Available X2go Sessions for User
 'nh
 .fi
 .ad l
-x2golistsessions [<server_hostname|--all-servers]
+x2golistsessions [<server_hostname>|--all-servers]
 
 .SH DESCRIPTION
 \fBx2golistsessions\fR returns a list of running or suspended X2go sessions for X2go server <server_hostname>.
@@ -24,7 +24,31 @@ a list of available X2go sessions.
 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.
+.SH RETURN VALUES
+A line-by-line list of available X2go sessions. Each line consists of several session attribute fields separated by the pipe
+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>
+
+.PP
+As exitcode \fBx2golistsessions\fR always returns 0.
+.SH SEE ALSO
+x2golistsessions_root(8), x2golistdesktops(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/x2golistsessions_root.8 b/x2goserver/man/man8/x2golistsessions_root.8
index f92e6b8..9c7f18e 100644
--- a/x2goserver/man/man8/x2golistsessions_root.8
+++ b/x2goserver/man/man8/x2golistsessions_root.8
@@ -20,6 +20,10 @@ If no server hostname is given at the command line, the session list query runs
 .PP
 \fBx2golistsessions_root\fR must be run with root privileges.
 .PP
+.SH RETURN VALUES
+Same as explained in x2golistsessions(8).
+.SH SEE ALSO
+x2golistsessions(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/x2gomountdirs.8 b/x2goserver/man/man8/x2gomountdirs.8
index b51f928..33b8f09 100644
--- a/x2goserver/man/man8/x2gomountdirs.8
+++ b/x2goserver/man/man8/x2gomountdirs.8
@@ -40,7 +40,26 @@ A list of client-side folders or device mount points that shall be mounted for X
 .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.
+.SH RETURN VALUES
+\fBx2gomountdirs\fR returns some mount point information to stdout if the mounting process has been successful.
+The mount results are printed line-by-line. The individual lines must be interpreted as shown below:
+
+    line 01: dirs:<local_path>__REVERSESSH_PORT__<sshfs_port>
+    line 02: ssh port:<sshfs_port>
+    line 03: Host:<client_ip>
+    line 04: User:<user>
+    line 05: inserted, sshfs  -o <options> \\
+                "<user">@<client_ip>:"<local_path>" \\
+                "<server_path>" -p <sshfs_port>
+    line 06: mount <local_path> ok
+    line 07: fname: <desktop_icon_name>
+.PP
+If mounting of a client folder fails, either of the errors is returned (on stdout):
+
+    error 01: mounting of <local_path> failed
+    error 02: insertion of <local_path> failed (already mounted?), not mounting
 .PP
+As exitcode \fBx2gomoundirs\fR always returns 0.
 .SH SEE ALSO
 x2goumount-session(8)
 .SH AUTHOR
diff --git a/x2goserver/man/man8/x2goprint.8 b/x2goserver/man/man8/x2goprint.8
index a8d8ec1..1075652 100644
--- a/x2goserver/man/man8/x2goprint.8
+++ b/x2goserver/man/man8/x2goprint.8
@@ -53,6 +53,12 @@ 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 RETURN VALUES
+By \fBx2goprint\fR nothing is reported on stdout or stderr.
+.PP
+If \fBx2goprint\fR has run successfully, an exitcode of 0 is returned. If the script has either been
+called by a non-root user or with the wrong number of command line arguments, a non-zero exitcode is
+returned.
 .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/x2goresume-session.8 b/x2goserver/man/man8/x2goresume-session.8
index 1004fb1..38e1661 100644
--- a/x2goserver/man/man8/x2goresume-session.8
+++ b/x2goserver/man/man8/x2goresume-session.8
@@ -19,6 +19,10 @@ x2goresume-session <session_id>
 .PP
 This command is normally issued
 by an X2go client application with X2go user privileges.
+.SH RETURN VALUES
+By \fBx2goresume-session\fR nothing is reported on stdout or stderr.
+.PP
+As exitcode \fBx2goresume-session\fR always returns 0.
 .SH SEE ALSO
 x2gostartagent(8), x2goruncommand(8), x2gosuspend-session(8), x2goterminate-session(8)
 .SH AUTHOR
diff --git a/x2goserver/man/man8/x2goruncommand.8 b/x2goserver/man/man8/x2goruncommand.8
index c8ca8b6..4a64515 100644
--- a/x2goserver/man/man8/x2goruncommand.8
+++ b/x2goserver/man/man8/x2goruncommand.8
@@ -39,7 +39,10 @@ Either of the possible sound systems supported by X2go: pulse, esd, arts (obsole
 .TP
 \*(T<\fB\<session_type>\fR\*(T>
 Allowed values for <session_type> are: D (desktop) and R (rootless).
+.SH RETURN VALUES
+By \fBx2goruncommand\fR nothing is reported on stdout or stderr.
 .PP
+As exitcode \fBx2goruncommand\fR always returns 0.
 .SH SEE ALSO
 x2gostartagent(8), x2goresume-session(8), x2gosuspend-session(8), x2goterminate-sessions(8)
 .SH AUTHOR
diff --git a/x2goserver/man/man8/x2gostartagent.8 b/x2goserver/man/man8/x2gostartagent.8
index 0296f4b..65bc07e 100644
--- a/x2goserver/man/man8/x2gostartagent.8
+++ b/x2goserver/man/man8/x2gostartagent.8
@@ -50,8 +50,8 @@ The command given by the <command> argument is only used to create the session I
 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:
+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
diff --git a/x2goserver/man/man8/x2gosuspend-session.8 b/x2goserver/man/man8/x2gosuspend-session.8
index c24a077..96e3e9e 100644
--- a/x2goserver/man/man8/x2gosuspend-session.8
+++ b/x2goserver/man/man8/x2gosuspend-session.8
@@ -18,7 +18,10 @@ x2gosuspend-session <session_id>
 \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.
+.SH RETURN VALUES
+By \fBx2gosuspend-session\fR nothing is reported on stdout or stderr.
 .PP
+As exitcode \fBx2gosuspend-session\fR always returns 0.
 .SH SEE ALSO
 x2gostartagent(8), x2goruncommand(8), x2goresume-session(8), x2goterminate-session(8)
 .SH AUTHOR
diff --git a/x2goserver/man/man8/x2goterminate-session.8 b/x2goserver/man/man8/x2goterminate-session.8
index f007a99..9089c04 100644
--- a/x2goserver/man/man8/x2goterminate-session.8
+++ b/x2goserver/man/man8/x2goterminate-session.8
@@ -18,7 +18,10 @@ x2goterminate-session <session_id>
 \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.
+.SH RETURN VALUES
+By \fBx2goterminate-session\fR nothing is reported on stdout or stderr.
 .PP
+As exitcode \fBx2goterminate-session\fR always returns 0.
 .SH SEE ALSO
 x2gostartagent(8), x2goruncommand(8), x2goresume-session(8), x2gosuspend-session(8)
 .SH AUTHOR
diff --git a/x2goserver/man/man8/x2goumount-session.8 b/x2goserver/man/man8/x2goumount-session.8
index 151dea1..a2cc555 100644
--- a/x2goserver/man/man8/x2goumount-session.8
+++ b/x2goserver/man/man8/x2goumount-session.8
@@ -27,9 +27,14 @@ Unmount shared folder(s) as registered for X2go session ID <session_id> in the X
 \*(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>.
-
+.PP
 If this optional argument is omitted, then ALL session folders will be unshared (including spool folders for printing and MIME box).
-
+.SH RETURN VALUES
+.SH RETURN VALUES
+By \fBx2goumount-session\fR nothing is reported on stdout or stderr.
+.PP
+As exitcode \fBx2goumount-session\fR return 0 on successful an umount action. If there is a failure during
+unmounting a shared folder a non-zero exit code is returned.
 .SH SEE ALSO
 x2gomountdirs(8)
 .SH AUTHOR


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