Blame SOURCES/Add-description-for-available-plugins.patch

56112c
From 0c050bb8cde65b0ac368f06bfd5ec36cccf87a83 Mon Sep 17 00:00:00 2001
56112c
From: Ondrej Holy <oholy@redhat.com>
56112c
Date: Fri, 9 Jun 2017 09:49:11 +0200
56112c
Subject: [PATCH] Add description for available plugins
56112c
56112c
The man pages lack info about available plugins and its functionality.
56112c
Add description for available plugins and their parameters.
56112c
56112c
It is based on info from upstream wiki pages:
56112c
https://github.com/FreeRDP/FreeRDP/wiki/Plugins
56112c
https://github.com/FreeRDP/FreeRDP/wiki/CommandLineInterface
56112c
56112c
Removed mention about ALSA mixer support since it is not built in RHEL.
56112c
---
56112c
 client/X11/xfreerdp.1.xml | 140 ++++++++++++++++++++++++++++++++++++++++++++--
56112c
 1 file changed, 136 insertions(+), 4 deletions(-)
56112c
56112c
diff --git a/client/X11/xfreerdp.1.xml b/client/X11/xfreerdp.1.xml
56112c
index 6ccf42fc8..3b1dc675e 100644
56112c
--- a/client/X11/xfreerdp.1.xml
56112c
+++ b/client/X11/xfreerdp.1.xml
56112c
@@ -438,10 +438,134 @@
56112c
         </listitem>
56112c
       </varlistentry>
56112c
       <varlistentry>
56112c
-        <term>--plugin <replaceable class="parameter">pluginname</replaceable></term>
56112c
-        <listitem>
56112c
-          <para>
56112c
-            load <replaceable class="parameter">pluginname</replaceable>
56112c
+        <term>--plugin <replaceable class="parameter">plugin</replaceable> [--data <replaceable class="parameter">data</replaceable> --]</term>
56112c
+        <listitem>
56112c
+          <para>
56112c
+            Load one of the following <replaceable class="parameter">plugin</replaceable>:
56112c
+            <variablelist>
56112c
+              <varlistentry>
56112c
+                <term>cliprdr</term>
56112c
+                <listitem>
56112c
+                  <para>
56112c
+                    Synchronize client and server clipboard data.
56112c
+                  </para>
56112c
+                </listitem>
56112c
+              </varlistentry>
56112c
+              <varlistentry>
56112c
+                <term>drdynvc --data <replaceable class="parameter">subplugin</replaceable> [<replaceable class="parameter">subplugin</replaceable> ...] --</term>
56112c
+                <listitem>
56112c
+                  <para>
56112c
+                    Enable multimedia redirection.
56112c
+                    The <replaceable class="parameter">subplugin</replaceable> must be one of the following:
56112c
+                  </para>
56112c
+                  <variablelist>
56112c
+                    <varlistentry>
56112c
+                      <term>audin</term>
56112c
+                      <listitem>
56112c
+                        <para>
56112c
+                          Redirect audio recording device to the server.
56112c
+                        </para>
56112c
+                      </listitem>
56112c
+                    </varlistentry>
56112c
+                    <varlistentry>
56112c
+                      <term>tsmf</term>
56112c
+                      <listitem>
56112c
+                        <para>
56112c
+                          Enable video redirection. The --plugin rdpsnd needs to be enabled as well.
56112c
+                        </para>
56112c
+                      </listitem>
56112c
+                    </varlistentry>
56112c
+                  </variablelist>
56112c
+                </listitem>
56112c
+              </varlistentry>
56112c
+              <varlistentry>
56112c
+                <term>rdpsnd [--data [<replaceable class="parameter">subplugin</replaceable>] [latency:<replaceable class="parameter">latency</replaceable>] --]</term>
56112c
+                <listitem>
56112c
+                  <para>
56112c
+                    Enable audio output using one of the following <replaceable class="parameter">subplugin</replaceable> and with a given <replaceable class="parameter">latency</replaceable> in ms:
56112c
+                  </para>
56112c
+                  <variablelist>
56112c
+                    <varlistentry>
56112c
+                      <term>pulse</term>
56112c
+                      <listitem>
56112c
+                        <para>
56112c
+                          Use PulseAudio mixer.
56112c
+                        </para>
56112c
+                      </listitem>
56112c
+                    </varlistentry>
56112c
+                  </variablelist>
56112c
+                </listitem>
56112c
+              </varlistentry>
56112c
+              <varlistentry>
56112c
+                <term>rail --data <replaceable class="parameter">executable</replaceable>[:<replaceable class="parameter">workingdir</replaceable>[:<replaceable class="parameter">arguments</replaceable>]] --</term>
56112c
+                <listitem>
56112c
+                  <para>
56112c
+                    Launch one <replaceable class="parameter">executable</replaceable> in a <replaceable class="parameter">workingdir</replaceable> with given <replaceable class="parameter">arguments</replaceable>.
56112c
+                    You must use --app before you can use rail.
56112c
+                  </para>
56112c
+                </listitem>
56112c
+              </varlistentry>
56112c
+              <varlistentry>
56112c
+                <term>rdpdbg</term>
56112c
+                <listitem>
56112c
+                  <para>
56112c
+                    Enable debugging virtual channel.
56112c
+                  </para>
56112c
+                </listitem>
56112c
+              </varlistentry>
56112c
+              <varlistentry>
56112c
+                <term>rdpdr --data <replaceable class="parameter">subplugin</replaceable> [<replaceable class="parameter">subplugin</replaceable> ...] --</term>
56112c
+                <listitem>
56112c
+                  <para>
56112c
+                    Redirect filesystem devices on your client to the server.
56112c
+                    If you want any redirection to work with Windows Server 2012 and newer you must use --plugin rdpsnd before you use any rdpdr options.
56112c
+                    The <replaceable class="parameter">subplugin</replaceable> must be one of the following:
56112c
+                  </para>
56112c
+                  <variablelist>
56112c
+                    <varlistentry>
56112c
+                      <term>drive:<replaceable class="parameter">name</replaceable>:<replaceable class="parameter">path</replaceable></term>
56112c
+                      <listitem>
56112c
+                        <para>
56112c
+                          Redirect system <replaceable class="parameter">path</replaceable> as disk with <replaceable class="parameter">name</replaceable>.
56112c
+                        </para>
56112c
+                      </listitem>
56112c
+                    </varlistentry>
56112c
+                    <varlistentry>
56112c
+                      <term>smartcard[:<replaceable class="parameter">name</replaceable>]</term>
56112c
+                      <listitem>
56112c
+                        <para>
56112c
+                          Redirect smartcard with <replaceable class="parameter">name</replaceable>.
56112c
+                        </para>
56112c
+                      </listitem>
56112c
+                    </varlistentry>
56112c
+                    <varlistentry>
56112c
+                      <term>serial:<replaceable class="parameter">port</replaceable>:<replaceable class="parameter">device</replaceable></term>
56112c
+                      <listitem>
56112c
+                        <para>
56112c
+                          Redirect serial <replaceable class="parameter">device</replaceable> (e.g. /dev/ttyS0) to <replaceable class="parameter">port</replaceable> (e.g. COM0).
56112c
+                        </para>
56112c
+                      </listitem>
56112c
+                    </varlistentry>
56112c
+                    <varlistentry>
56112c
+                      <term>parallel:<replaceable class="parameter">port</replaceable>:<replaceable class="parameter">device</replaceable></term>
56112c
+                      <listitem>
56112c
+                        <para>
56112c
+                          Redirect parallel <replaceable class="parameter">device</replaceable> (e.g. /dev/lp0) to <replaceable class="parameter">port</replaceable> (e.g. LPT0).
56112c
+                        </para>
56112c
+                      </listitem>
56112c
+                    </varlistentry>
56112c
+                    <varlistentry>
56112c
+                      <term>printer:<replaceable class="parameter">cupsname</replaceable>:<replaceable class="parameter">drivername</replaceable></term>
56112c
+                      <listitem>
56112c
+                        <para>
56112c
+                          Redirect printer with <replaceable class="parameter">cupsname</replaceable> and <replaceable class="parameter">drivername</replaceable>.
56112c
+                        </para>
56112c
+                      </listitem>
56112c
+                    </varlistentry>
56112c
+                  </variablelist>
56112c
+                </listitem>
56112c
+              </varlistentry>
56112c
+            </variablelist>
56112c
           </para>
56112c
         </listitem>
56112c
       </varlistentry>
56112c
-- 
56112c
2.14.1
56112c