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

[X2Go dev team]

The branch, build-main has been updated
       via  5b22e17c13c76b133db6d6891b831a2d7b2a6709 (commit)
      from  752b012f49930a86ed9f7555a049cfd17312c291 (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                                   |    2 +
 .../man/man8/x2goserver-run-extensions.8           |   77 ++++++++++++++++++++
 2 files changed, 79 insertions(+)
 create mode 100644 x2goserver-extensions/man/man8/x2goserver-run-extensions.8

The diff of changes is:
diff --git a/debian/changelog b/debian/changelog
index e881700..51bf9c8 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -104,6 +104,8 @@ x2goserver (3.0.99.6-0~x2go1) UNRELEASED; urgency=low
   * Provide pluggable X2go extension system for main X2go server
     functions.
   * Adapt to renaming of x2godesktopsharing scripts.
+  * Provide man page for x2goserver-run-extensions that explains the new plug-in
+    mechanism of x2goserver.
 
   [ Ivan Kabaivanov ]
   * Makefile fix around man page installation in x2goserver-compat package.
diff --git a/x2goserver-extensions/man/man8/x2goserver-run-extensions.8 b/x2goserver-extensions/man/man8/x2goserver-run-extensions.8
new file mode 100644
index 0000000..e7b8a0b
--- /dev/null
+++ b/x2goserver-extensions/man/man8/x2goserver-run-extensions.8
@@ -0,0 +1,77 @@
+'\" -*- coding: utf-8 -*-
+.if \n(.g .ds T< \\FC
+.if \n(.g .ds T> \\F[\n[.fam]]
+.de URL
+\\$2 \(la\\$1\(ra\\$3
+..
+.if \n(.g .mso www.tmac
+.TH x2goserver-run-extensions 8 "Sep 2011" "Version 3.0.99.x" "X2go Server Tool"
+.SH NAME
+x2goserver-run-extensions \- Run X2go Server Extensions
+.SH SYNOPSIS
+'nh
+.fi
+.ad l
+x2goserver-run-extensions <session_id> <modality>
+
+.SH DESCRIPTION
+\fBx2goserver-run-extensions\fR is called from within a number of X2go Server core scripts.
+.PP
+\fIWARNING:\fR Do not call it directly unless you really know what you are doing.
+.PP
+\fBx2goserver-run-extensions\fR executes scripts that have been
+provided by third-party X2go extension packages.
+.PP
+What this man page is about is not the script usage itself but the way of how to provide X2go server
+extensions and features without the need to change the core X2go server scripts.
+.SH MODALITIES
+\fBx2goserver-run-extensions\fR is called with user privileges, as first cmd line argument the session ID is provided
+as the second cmd line argument a (what we call it) modality is provided.
+.PP
+This modality tells \fBx2goserver-run-extensions\fR at what stage of an X2go
+session startup, resumption, suspension or termination the calling script currently is at.
+.PP
+Calling X2go Server core scripts currently are: \fBx2gostartagent(8)\fR, \fBx2goruncommand(8)\fR, \fBx2goresume-session(8)\fR,
+\fBx2gosuspend-session(8)\fR or \fBx2goterminate-session(8)\fR.
+.PP
+The modality names all refer to a sub-directory of the path:
+
+  \fI<INSTALL_PREFIX>/lib/x2go/extensions\fR,
+
+where <INSTALL_PREFIX> mostly is /usr on commonly-used GNU/Linux systems.
+.PP
+In any of these sub-directories third-party X2go extension packages can place scripts or binaries that will then get executed by the core X2go server
+commands, either before or after the essential functionality (e.g. x2goagent startup, x2goagent suspension, x2goagent resumption, etc.) or on failure of that
+essential functionality.
+.PP
+The following table shows the available modalities, the calling scripts and the location where to place third-party extension scripts:
+
+
+ CALLING SCRIPT        MODALITY NAMES    EXTENSION SCRIPTS LOCATION
+ --------------        ---------------   --------------------------
+ x2gostartagent        pre-start         extensions/pre-start.d/
+                       post-start        extensions/post-start.d/
+                       fail-start        extensions/fail-start.d/
+ x2goruncommand        pre-runcommand    extensions/pre-runcommand.d/
+                       post-runcommand   extensions/post-runcommand.d/
+                       fail-runcommand   extensions/fail-runcommand.d/
+ x2goresume-session    pre-resume        extensions/pre-resume.d/
+                       post-resume       extensions/post-resume.d/
+                       fail-resume       extensions/fail-resume.d/
+ x2gosuspend-session   pre-suspend       extensions/pre-suspend.d/
+                       post-suspend      extensions/post-suspend.d/
+                       fail-suspend      extensions/fail-suspend.d/
+ x2goterminate-session pre-terminate     extensions/pre-terminate.d/
+                       post-terminate    extensions/post-terminate.d/
+                       fail-terminate    extensions/fail-terminate.d/
+
+\fIIMPORTANT:\fR When providing X2go Server extensions by this mechanism, please pretty well make sure that these extension scripts of yours that you place
+in either of the above folders do under no circumstance fail during execution.
+
+.SH RETURN VALUES
+As exitcode \fBx2goserver-run-extensions\fR always returns 0 and pretends to be permanently happy :-).
+.SH SEE ALSO
+\fBx2gostartagent(8)\fR, \fBx2goruncommand(8)\fR, \fBx2goresume-session(8)\fR, \fBx2gosuspend-session(8)\fR and \fBx2goterminate-session(8)\fR.
+.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).