[X2Go-Commits] [nx-libs] 296/429: document additional options only nxagent knows about

[git-admin at x2go.org]

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

x2go pushed a commit to branch 3.6.x
in repository nx-libs.

commit 9b1dd340146ab62bfca9fc4c247edfbec2da2356
Author: Ulrich Sibiller <uli42 at gmx.de>
Date:   Sun Mar 7 20:21:37 2021 +0100

    document additional options only nxagent knows about
---
 nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1 |  9 +++++
 nxcomp/src/Misc.cpp                              | 41 ++++++++++++----------
 nxproxy/man/nxproxy.1                            | 44 ++++++++++++++----------
 3 files changed, 58 insertions(+), 36 deletions(-)

diff --git a/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1 b/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1
index 2a83a5afb..ebc528d37 100644
--- a/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1
+++ b/nx-X11/programs/Xserver/hw/nxagent/man/nxagent.1
@@ -459,6 +459,9 @@ The nx-X11 system adds the following command line arguments:
 .B \-forcenx
 force use of NX protocol messages assuming communication through \fBnxproxy\fR
 .TP 8
+.B \-id \fIstring\fP
+The session id.
+.TP 8
 .B \-autograb
 enable autograb mode on \fBnxagent\fR startup. The autograb feature can be toggled via nxagent keystrokes
 .TP 8
@@ -740,6 +743,9 @@ enable/disable shared pixmaps support. Accepted values: \fI1\fR (enable, default
 type of connecting operating system (supported: \fIlinux\fR,
 \fIwindows\fR, \fIsolaris\fR and \fImacosx\fR)
 .TP 8
+.B clients=<string>
+filename where to log output of the nxagent's clients. This is ignored if no session id has been provided. It then points to stderr. Default: <sessiondir>/clients.
+.TP 8
 .B shadow=<string>
 define the display that should be shadowed
 .TP 8
@@ -749,6 +755,9 @@ unique identifier for the shadow session
 .B shadowmode=<bool>
 full access (set to \fI1\fR) or viewing-only (set to \fI0\fR, default)
 .TP 8
+.B state=<string>
+filename where to store the state of the nxagent (for easier interoperation with software like x2go. Default: sessiondir/state.
+.TP 8
 .B defer=<int>
 defer image updates (enabled for all connection types except LAN),
 accepts values \fI0\fR, \fI1\fR and \fI2\fR
diff --git a/nxcomp/src/Misc.cpp b/nxcomp/src/Misc.cpp
index c626eb91b..d0d82d0aa 100644
--- a/nxcomp/src/Misc.cpp
+++ b/nxcomp/src/Misc.cpp
@@ -326,31 +326,36 @@ static const char UsageInfo[] =
                a program providing encryption of the point to point\n\
                communication.\n\
 \n\
-rootless=b\n\
-geometry=s\n\
-resize=b\n\
-fullscreen=b\n\
-keyboard=s\n\
-clipboard=s\n\
-streaming=n\n\
+autodpi=b\n\
+autograb=b\n\
 backingstore=n\n\
+client=s\n\
+clients=s\n\
+clipboard=s\n\
 composite=n\n\
-xinerama=n\n\
-shmem=b\n\
-shpix=b\n\
+copysize=n\n\
+defer=n\n\
+fullscreen=n\n\
+geometry=s\n\
 kbtype=s\n\
-client=s\n\
+keyboard=s\n\
+keyconv=s\n\
+magicpixel=b\n\
+menu=n\n\
+resize=b\n\
+rootless=b\n\
 shadow=n\n\
-shadowuid=n\n\
 shadowmode=s\n\
-defer=n\n\
-tile=s\n\
-menu=n\n\
-magicpixel=n\n\
-autodpi=n\n\
+shadowuid=n\n\
+shmem=b\n\
+shpix=b\n\
 sleep=n\n\
+state=s\n\
+streaming=n\n\
+textclipboard=b\n\
+tile=s\n\
 tolerancechecks=s\n\
-keyconv=s\n\
+xinerama=b\n\
                These options are interpreted by the NX agent. They\n\
                are ignored by the proxy.\n\
 \n\
diff --git a/nxproxy/man/nxproxy.1 b/nxproxy/man/nxproxy.1
index 67bf345f5..fdd5aa915 100644
--- a/nxproxy/man/nxproxy.1
+++ b/nxproxy/man/nxproxy.1
@@ -305,31 +305,39 @@ Should be set to 1 if the proxy is running as part of a program providing
 encryption of the point to point communication.
 
 .TP 8
-.I These options are interpreted by the nx-NX Agent. They are ignored by the proxy.
+.I The following options are interpreted by the nx-NX Agent. They are ignored by the proxy:
 
-    rootless=<bool>
-    geometry=<string>
-    resize=<bool>
-    fullscreen=<bool>
-    keyboard=<string>
-    clipboard=<int>
-    streaming=<int>
+    autodpi=<bool>
+    autograb=<bool>
     backingstore=<int>
+    client=<string>
+    clients=<string>
+    clipboard=<int>
     composite=<int>
-    xinerama=<int>
-    shmem=<bool>
-    shpix=<bool>
+    copysize=<int>
+    defer=<int>
+    fullscreen=<bool>
+    geometry=<string>
     kbtype=<string>
-    client=<string>
+    keyboard=<string>
+    keyconv=<string>
+    magicpixel=<bool>
+    menu=<int>
+    resize=<bool>
+    rootless=<bool>
     shadow=<int>
-    shadowuid=<int>
     shadowmode=<string>
-    defer=<int>
-    tile=<string>
-    menu=<int>
-    magicpixel=<bool>
-    autodpi=<bool>
+    shadowuid=<int>
+    shmem=<bool>
+    shpix=<bool>
     sleep=<int>
+    state=<string>
+    streaming=<int>
+    textclipboard=<bool>
+    tile=<string>
+    tolerancechecks=<int>
+    xinerama=<int>
+
 
 .SH NX ENVIRONMENT VARIABLES
 

--
Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/nx-libs.git