[X2Go-Commits] [x2goserver] 42/99: x2goserver/lib/x2goupdateoptionsstring: add links to X2Go::Server::Agent::NX::Options documentation on option strings and transformations.

git-admin at x2go.org git-admin at x2go.org
Mon Dec 28 06:10:44 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 9b96cb0e4deab2c6a7d61ca4350ebadc9dff5c10
Author: Mihai Moldovan <ionic at ionic.de>
Date:   Tue Nov 10 07:43:10 2020 +0100

    x2goserver/lib/x2goupdateoptionsstring: add links to X2Go::Server::Agent::NX::Options documentation on option strings and transformations.
---
 debian/changelog                       |  3 +++
 x2goserver/bin/x2goupdateoptionsstring | 16 +++++++++++++++-
 2 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/debian/changelog b/debian/changelog
index f0b256fb..96cb0367 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -266,6 +266,9 @@ x2goserver (4.1.0.4-0x2go1.2) UNRELEASED; urgency=medium
       logically very different" situation.
     - x2goserver/lib/x2goupdateoptionsstring: rename EXAMPLE section to
       EXAMPLES.
+    - x2goserver/lib/x2goupdateoptionsstring: add links to
+      X2Go::Server::Agent::NX::Options documentation on option strings and
+      transformations.
   * 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 b343b0f9..5796c359 100755
--- a/x2goserver/bin/x2goupdateoptionsstring
+++ b/x2goserver/bin/x2goupdateoptionsstring
@@ -333,12 +333,26 @@ x2goupdateoptionsstring - X2Go Agent Options String Manipulator
 
 =head1 DESCRIPTION
 
+=for comment
+Due to parser oddities, breaking a line during an L<> formatter code right
+after the separating pipe character will generate broken links.
+Make sure to only break it during the description or, generally, on space
+characters.
+A workaround for this as been proposed in
+https://github.com/Perl/perl5/issues/18305.
+
 B<x2goupdateoptionsstring> is a utility for manipulating options strings as
 passed to B<X2Go/NX Agent>.
+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>.
 
 Call it with optional flags, the options string as the first parameter and the
-options you want to manipulate as additional parameters.
+transformations to be carried out as additional parameters.
 At least one additional parameter (i.e., a transformation) must be provided.
+Transformations are described here briefly, but also in the L<TRANSFORMATIONS
+section in the X2Go::Server::Agent::NX::Options
+documentation|X2Go::Server::Agent::NX::Options/TRANSFORMATIONS>.
 
 It can either add, remove or replace components.
 

--
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