[X2Go-Commits] [x2gobroker] 01/05: x2gobroker.1: Mention x2gobroker-ssh in its man page, differentiate between the different modes (http/ssh) of the x2gobroker application.

git-admin at x2go.org git-admin at x2go.org
Thu Mar 26 14:50:33 CET 2015


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

x2go pushed a commit to branch master
in repository x2gobroker.

commit 477949ad3dbcb2a65a511d89023020b8b807650c
Author: Mike Gabriel <mike.gabriel at das-netzwerkteam.de>
Date:   Thu Mar 26 13:46:53 2015 +0100

    x2gobroker.1: Mention x2gobroker-ssh in its man page, differentiate between the different modes (http/ssh) of the x2gobroker application.
---
 man/man1/x2gobroker.1 |   24 ++++++++++++++++++------
 1 file changed, 18 insertions(+), 6 deletions(-)

diff --git a/man/man1/x2gobroker.1 b/man/man1/x2gobroker.1
index fdff520..4295926 100644
--- a/man/man1/x2gobroker.1
+++ b/man/man1/x2gobroker.1
@@ -7,7 +7,7 @@
 .if \n(.g .mso www.tmac
 .TH x2gobroker 1 "Feb 2014" "Version 0.0.3.x" "X2Go Session Broker"
 .SH NAME
-x2gobroker,x2gobroker-daemon \- Session Broker for X2Go
+x2gobroker{,-daemon,-ssh} \- Session Broker for X2Go
 .SH SYNOPSIS
 'nh
 .fi
@@ -30,15 +30,27 @@ x2gobroker,x2gobroker-daemon \- Session Broker for X2Go
 ]
 'in \n(.iu-\nxu
 .ad b
+.PP
+.ad l
+\fBx2gobroker-ssh\fR \kx
+.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
+'in \n(.iu+\nxu
+[
+\fIoptions\fR
+]
+'in \n(.iu-\nxu
+.ad b
 'hy
 .SH DESCRIPTION
-\fBx2gobroker\fR is a Python Tornado based implementation of the X2Go Session Broker API.
+\fBx2gobroker\fR (resp. \fBx2gobroker-daemon\fR) is a Python Tornado based implementation of the X2Go Session Broker API. \fBx2gobroker-ssh\fR is the same application but designed
+for usage via SSH (as a command line tool).
 .PP
-This command is normally executed either through the host's init system or via the WSGI module in your httpd server.
+The HTTP(S) implementation of \fBx2gobroker\fR is normally executed either through the host's init system or via the WSGI module in your httpd server. The SSH
+implementation is executed by X2Go clients through SSH.
 .PP
 See the included README and TODO for further information on \fBx2gobroker\fR.
 .SH GENERAL OPTIONS
-\fBx2gobroker\fR accepts the following common options:
+\fBx2gobroker{,-daemon,-ssh}\fR accepts the following common options:
 .TP
 \*(T<\fB\-M, \-\-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.
@@ -54,7 +66,7 @@ broker API through a normal web browser.
 \*(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:
+\fBx2gobroker-ssh\fR, i.e., 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
@@ -78,7 +90,7 @@ For the \fIselectsession\fR task the session profile ID has to be given as an ad
 \*(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:
+\fBx2gobroker-daemon\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 Tornado http-engine will bind to (default: 127.0.0.1:8080).

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


More information about the x2go-commits mailing list