From 76770526f582638ed4100e021a29425b8d65d13b Mon Sep 17 00:00:00 2001 From: "W. Michael Petullo" <mike@flyn.org> Date: Thu, 30 Dec 2021 15:48:24 -0600 Subject: [PATCH] x2gowswrapper: small refinements to manpage To: x2go-dev@lists.x2go.org
Signed-off-by: W. Michael Petullo <mike@flyn.org> --- man/man1/x2gowswrapper.1 | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/man/man1/x2gowswrapper.1 b/man/man1/x2gowswrapper.1 index 70678da..035157a 100644 --- a/man/man1/x2gowswrapper.1 +++ b/man/man1/x2gowswrapper.1 @@ -5,24 +5,27 @@ \\$2 \(la\\$1\(ra\\$3 .. .if \n(.g .mso www.tmac -.TH x2gowswrapper 1 "Jun 2021" "Version 0.0.0.1" "X2Go Application" +.TH x2gowswrapper 1 "Dec 2021" "Version 0.0.0.1" "X2Go Manual" .SH NAME -x2gowswrapper \- Help utility for X2Go HTML5 Client (required server-side) +x2gowswrapper \- helper utility for X2Go HTML5 client (runs on server side) .SH SYNOPSIS 'nh .fi .ad l -\fBx2gowswrapper\fR \fI<tunpid> <localport> <wsport>\fR +\fBx2gowswrapper\fR \fI[TUNPID] [LOCALPORT] [WSPORT]\fR .SH DESCRIPTION -\fBx2gowswrapper\fR is helper utility that is required on the server side -for attaching websocket streams to an X2Go KDrive based Xsession. +\fBx2gowswrapper\fR is helper utility that attaches WebSocket streams +to an X2Go KDrive-based Xsession. You should not directly run this application, +as proper use requires it be invoked by the X2Go RPC CGI script. .PP -You should not run this application standalone. It is evoked from via the X2Go Web RPC CGI Skript. +\fI[TUNPID]\fR specifies the PID of the SSH process providing a tunnel +back to the client. \fBx2gowswrapper\fR uses this to determine if the +SSH process is running as well as to terminate the SSH process. .PP -.SH OPTIONS -\fBx2gowswrapper\fR does not know of any additional options. +\fI[LOCALPORT]\fR specifies the port of the SSH tunnel. +.PP +\fI[WSPORT]\fR specifies the port to which a browser should direct its WebSocket connection. .PP .SH AUTHOR -This manual has been written by Mike Gabriel <mike.gabriel@das\-netzwerkteam.de> for the X2Go project -(http://www.x2go.org). +Written by Mike Gabriel and W. Michael Petullo for the X2Go project. -- 2.33.1