[X2Go-Commits] x2gobroker.git - master (branch) updated: 0.0.2.3-10-g739ad7f

[X2Go dev team]

The branch, master has been updated
       via  739ad7f995a0f480af554584d329b7faca3f20ea (commit)
      from  aa744c9436ad489b2ef344d2e1c4a7df251617e1 (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 739ad7f995a0f480af554584d329b7faca3f20ea
Author: Mike Gabriel <mike.gabriel at das-netzwerkteam.de>
Date:   Sun Aug 18 21:06:18 2013 +0200

    Update x2gobroker man page.

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

Summary of changes:
 debian/changelog      |    1 +
 man/man1/x2gobroker.1 |   47 +++++++++++++++++++++++++++++++++++++----------
 2 files changed, 38 insertions(+), 10 deletions(-)

The diff of changes is:
diff --git a/debian/changelog b/debian/changelog
index f94f27e..74167b8 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -3,6 +3,7 @@ x2gobroker (0.0.3.0-0~x2go1) UNRELEASED; urgency=low
   * New upstream version (0.0.3.0):
     - Add SSH support to X2Go Session Broker. (Fixes: #153).
     - Move x2gobroker executable to /usr/bin.
+    - Update x2gobroker man page.
     - Fix logrotate script: x2gobroker-wsgi. (Fixes: #275).
   * /debian/control:
     + Replace LDAP support with session brokerage support in LONG_DESCRIPTION.
diff --git a/man/man1/x2gobroker.1 b/man/man1/x2gobroker.1
index bc1425e..8d09fce 100644
--- a/man/man1/x2gobroker.1
+++ b/man/man1/x2gobroker.1
@@ -27,28 +27,55 @@ x2gobroker \- Session Broker for X2Go
 This command is normally executed either through an init script or via the WSGI module in your httpd server.
 .PP
 See the included README and TODO for further information on \fBx2gobroker\fR.
-.SH COMMON OPTIONS
+.SH GENERAL OPTIONS
 \fBx2gobroker\fR accepts the following common options:
 .TP
-\*(T<\fB\-h, \-\-help\fR\*(T>
-Display a help with all available command line options and exit.
+\*(T<\fB\-d, \-\-mode {HTTP|SSH}\fR\*(T>
+Set X2Go Session Broker into HTTP or SSH mode. If this option is omitted, then SSH is the default mode.\fR.
+.TP
+\*(T<\fB\-d, \-\-config FILENAME\fR\*(T>
+Specify an alternative configuration file name, default is: \fI/etc/x2go/x2gobroker.conf\fR.
 .TP
 \*(T<\fB\-d, \-\-debug\fR\*(T>
 Enable debugging code. This also makes http\'s POST method available as GET method, which then allows it to test the
 broker API through a normal web browser.
 .TP
-\*(T<\fB\-d, \-\-config FILENAME\fR\*(T>
-Specify an alternative configuration file name, default is: \fI/etc/x2go/x2gobroker.conf\fR.
-.SH DAEMON OPTIONS
-\fBx2gobroker\fR accepts the following daemon options:
+\*(T<\fB\-h, \-\-help\fR\*(T>
+Display a help with all available command line options and exit.
+.SH SSH MODE COMMAND LINE OPTIONS
+\fBx2gobroker\fR\-\-when run from the command line or via SSH\-\-accepts/requires these additional options:
+.TP
+\*(T<\fB\-\-task {listsessions, selectsession, setpass, testcon}\fR\*(T>
+Specify the either of the known broker tasks (listsessions, selectsession, setpass, testcon). This parameter
+is compulsory, the command execution will fail if it is omitted.
+.TP
+\*(T<\fB\-\-user USERNAME\fR\*(T>
+If \fBx2gobroker\fR is run by the `magic' user (the x2gobroker account by default), then the x2gobroker
+is allowed to change its user context and do queries on behalf of the user specified with this parameter.
+.TP
+\*(T<\fB\-\-auth-cookie, \-\-auth-id AUTHENTICATION_COOKIE\fR\*(T>
+It is possible to enforce a stronger authentication via an additional pre\-shared authentication cookie. This authentication
+cookie must be stored in a client-side file so that X2Go Client can access it and then pass it on to the X2Go 
+Session Broker (via the X2Go Client option \-\-auth-id=<fullpath-to-file>) while authenticating against the broker.
+
+The server-side cookie hash can be set in /etc/x2go/x2gobroker.conf (option: my-cookie). You have to set
+the option require-cookie-auth to true to enable the additional cookie comparison in the X2Go Session Broker.
+.TP
+\*(T<\fB\-\-profile-id, \-\-sid SESSION_PROFILE_ID\fR\*(T>
+For the \fIselectsession\fR task the session profile ID has to be given as an additional parameter.
+.TP
+\*(T<\fB\-\-backend BACKEND_NAME\fR\*(T>
+Query another than the default broker backend.
+.SH HTTP(S) DAEMON OPTIONS
+\fBx2gobroker\fR in standalone HTTP(S) daemon mode accepts these additional options:
 .TP
 \*(T<\fB\-b, \-\-bind ADDRESS:PORT\fR\*(T>
-The [address:]port that the Web.py http-engine will bind to (default: 127.0.0.1:8080).
+The [address:]port that the Tornado http-engine will bind to (default: 127.0.0.1:8080).
 .SH "FILES"
 /etc/x2go/x2gobroker.conf, /etc/x2go/broker/* (configuration files)
 .PP
-/etc/default/x2gobroker-daemon (environment for X2Go Session Broker when run
-as standalone daemon)
+/etc/default/python-x2gobroker, /etc/default/x2gobroker-daemon (environment for X2Go Session
+Broker when run as a standalone daemon)
 .PP
 /var/log/x2gobroker/* (log files of X2Go Session Broker)
 .SH "SEE ALSO"


hooks/post-receive
-- 
x2gobroker.git (HTTP(S) Session broker for X2Go)

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 "x2gobroker.git" (HTTP(S) Session broker for X2Go).