[X2Go-Commits] [x2goserver] 89/99: x2goserver/bin/x2goupdateoptionsstring: document the new base6 pseudo-mode.

git-admin at x2go.org git-admin at x2go.org
Mon Dec 28 06:10:54 CET 2020

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

x2go pushed a commit to branch master
in repository x2goserver.

commit 315ddc33e263edcffc9c8896e121a64c227b19bb
Author: Mihai Moldovan <ionic at ionic.de>
Date:   Thu Dec 10 17:51:05 2020 +0100

    x2goserver/bin/x2goupdateoptionsstring: document the new base6 pseudo-mode.
 debian/changelog                       |  2 ++
 x2goserver/bin/x2goupdateoptionsstring | 26 ++++++++++++++++++++++++--
 2 files changed, 26 insertions(+), 2 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 1e150270..a2fe85e3 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -368,6 +368,8 @@ x2goserver ( UNRELEASED; urgency=medium
       the kv-pair filter function if so specified. Big oops.
     - x2goserver/bin/x2goupdateoptionsstring: extend extraction example for
       how to check for full key-value pair combinations.
+    - x2goserver/bin/x2goupdateoptionsstring: document the new base64
+      pseudo-mode.
   * debian/control:
     + Build-depend upon lsb-release for distro version detection.
   * debian/x2goserver.manpages:
diff --git a/x2goserver/bin/x2goupdateoptionsstring b/x2goserver/bin/x2goupdateoptionsstring
index 7bacf990..2572600f 100755
--- a/x2goserver/bin/x2goupdateoptionsstring
+++ b/x2goserver/bin/x2goupdateoptionsstring
@@ -841,9 +841,9 @@ x2goupdateoptionsstring - X2Go Agent Options String Manipulator and Extractor
 =item B<x2goupdateoptionsstring> B<--man>
-=item B<x2goupdateoptionsstring> [<B<--mode>|B<-m>>[B<=>| ]B<t>[B<ransform>]|B<-t>] [B<--compact>|B<-c>] [B<--debug>|B<-d>] [B<-->] I<options_string> [B<+>]|B<->I<key>[B<=>I<value>] ...
+=item B<x2goupdateoptionsstring> [<B<--mode>|B<-m>>[B<=>| ]B<t>[B<ransform>]|B<-t>] [B<--compact>|B<-c>] [B<--base64>|B<-b>] [B<--debug>|B<-d>] [B<-->] I<options_string> [B<+>]|B<->I<key>[B<=>I<value>] ...
-=item B<x2goupdateoptionsstring> <B<--mode>|B<-m>>[B<=>| ]B<e>[B<xtract>]|B<-e> [B<--debug>|B<-d>] [B<-->] I<options_string> I<key>[B<=>I<value>] ...
+=item B<x2goupdateoptionsstring> <B<--mode>|B<-m>>[B<=>| ]B<e>[B<xtract>]|B<-e> [B<--base64>|B<-b>] [B<--debug>|B<-d>] [B<-->] I<options_string> I<key>[B<=>I<value>] ...
@@ -863,6 +863,13 @@ For more information about supported options strings, refer to the L<OPTIONS
 STRINGS section in the X2Go::Server::Agent::NX::Options
 documentation|X2Go::Server::Agent::NX::Options/OPTIONS STRINGS>.
+For full support of options string, which are allowed (but not recommended) to
+include binary data, the special B<--base64>|B<-b> switch is supported.
+If given, all arguments other than flags must be base64-encoded (making it
+possible to pass binary data via shells, for instance).
+The program's output, minus potentially debugging messages, will also be
 Currently, two modes are supported:
@@ -984,6 +991,21 @@ This option is only available in B<transformation mode>.
 It will be silently ignored in B<extraction mode>, as compaction is a
 pre-requisite and done automatically during extraction.
+=item B<--base64>|B<-b>
+Enable a special full base64 mode.
+Any binary data can be given and output by this program in this mode, even
+when operating on a shell.
+Input parameters must always be provided encoded in base64 form.
+Likewise, the program will always output data encoded in a base64 form.
+Since key-value pairs returned in extraction mode are already base64-encoded
+and delimited with a character that is not legal in the base64 encoding, this
+flag does not modify the extraction's mode output (i.e., you will B<not> have
+to decode the output data twice).

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

More information about the x2go-commits mailing list