Repository: guacamole-manual Updated Branches: refs/heads/master 9a198da18 -> 66c4bcc76
GUACAMOLE-313: Document new include/exclude parameters for session recordings. Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/c490cdd7 Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/c490cdd7 Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/c490cdd7 Branch: refs/heads/master Commit: c490cdd7eeef257acbab06bb5e1b62de16d0da94 Parents: 9a198da Author: Michael Jumper <mjum...@apache.org> Authored: Mon Feb 5 12:44:41 2018 -0800 Committer: Michael Jumper <mjum...@apache.org> Committed: Mon Feb 5 12:44:41 2018 -0800 ---------------------------------------------------------------------- src/chapters/configuring.xml | 45 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/c490cdd7/src/chapters/configuring.xml ---------------------------------------------------------------------- diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml index 69fef82..c138423 100644 --- a/src/chapters/configuring.xml +++ b/src/chapters/configuring.xml @@ -723,6 +723,51 @@ guacd-port: 4822</programlisting> and this parameter will be ignored.</para> </entry> </row> + <row> + <entry><parameter>recording-exclude-output</parameter></entry> + <entry> + <para>If set to "true", graphical output and other data normally + streamed from server to client will be excluded from the + recording, producing a recording which contains only user + input events. <emphasis>This parameter is + optional.</emphasis> If omitted, graphical output will + be included in the recording.</para> + <para>This parameter only has an effect if graphical recording + is enabled. If the <parameter>recording-path</parameter> is + not specified, graphical session recording will be disabled, + and this parameter will be ignored.</para> + </entry> + </row> + <row> + <entry><parameter>recording-exclude-mouse</parameter></entry> + <entry> + <para>If set to "true", user mouse events will be excluded from + the recording, producing a recording which lacks a visible + mouse cursor. <emphasis>This parameter is + optional.</emphasis> If omitted, mouse events will be + included in the recording.</para> + <para>This parameter only has an effect if graphical recording + is enabled. If the <parameter>recording-path</parameter> is + not specified, graphical session recording will be disabled, + and this parameter will be ignored.</para> + </entry> + </row> + <row> + <entry><parameter>recording-include-keys</parameter></entry> + <entry> + <para>If set to "true", user key events will be included in the + recording. The recording can subsequently be passed through + the <command>guaclog</command> utility to produce a + human-readable interpretation of the keys pressed during the + session. <emphasis>This parameter is optional.</emphasis> If + omitted, key events will be not included in the + recording.</para> + <para>This parameter only has an effect if graphical recording + is enabled. If the <parameter>recording-path</parameter> is + not specified, graphical session recording will be disabled, + and this parameter will be ignored.</para> + </entry> + </row> </tbody> </tgroup> </informaltable>
