GUACAMOLE-313: Document general usage of guaclog.
diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml
index c138423..7d78a5a 100644
--- a/src/chapters/configuring.xml
+++ b/src/chapters/configuring.xml
@@ -654,6 +654,21 @@
<informalexample>
<screen><prompt>$</prompt> <userinput>man guacenc</userinput></screen>
</informalexample>
+ <para>If recording of key events is explicitly enabled using the
+ <parameter>recording-include-keys</parameter> parameter, recordings can also
+ be translated into human-readable interpretations of the keys pressed during the
+ session using the <command>guaclog</command> utility. The usage of
+ <command>guaclog</command> is analogous to <command>guacenc</command>, and
+ results in the creation of a new text file containing the interpreted
+ events:</para>
+ <informalexample>
+ <screen><prompt>$</prompt> <userinput>guaclog <replaceable>/path/to/recording/NAME</replaceable></userinput><computeroutput>
+guaclog: INFO: Guacamole input log interpreter (guaclog) version 0.9.14
+guaclog: INFO: 1 input file(s) provided.
+guaclog: INFO: Writing input events from "<replaceable>/path/to/recording/NAME</replaceable>" to "<replaceable annotations="">/path/to/recording/NAME</replaceable>.txt" ...
+guaclog: INFO: All files interpreted successfully.</computeroutput>
+<prompt>$</prompt> </screen>
+ </informalexample>
<important>
<para>Guacamole will never overwrite an existing recording. If necessary, a
numeric suffix like ".1", ".2", ".3", etc. will be appended to
@@ -1805,6 +1820,21 @@
<informalexample>
<screen><prompt>$</prompt> <userinput>man guacenc</userinput></screen>
</informalexample>
+ <para>If recording of key events is explicitly enabled using the
+ <parameter>recording-include-keys</parameter> parameter, recordings can also
+ be translated into human-readable interpretations of the keys pressed during the
+ session using the <command>guaclog</command> utility. The usage of
+ <command>guaclog</command> is analogous to <command>guacenc</command>, and
+ results in the creation of a new text file containing the interpreted
+ events:</para>
+ <informalexample>
+ <screen><prompt>$</prompt> <userinput>guaclog <replaceable>/path/to/recording/NAME</replaceable></userinput><computeroutput>
+guaclog: INFO: Guacamole input log interpreter (guaclog) version 0.9.14
+guaclog: INFO: 1 input file(s) provided.
+guaclog: INFO: Writing input events from "<replaceable>/path/to/recording/NAME</replaceable>" to "<replaceable annotations="">/path/to/recording/NAME</replaceable>.txt" ...
+guaclog: INFO: All files interpreted successfully.</computeroutput>
+<prompt>$</prompt> </screen>
+ </informalexample>
<important>
<para>Guacamole will never overwrite an existing recording. If necessary, a
numeric suffix like ".1", ".2", ".3", etc. will be appended to
@@ -1874,6 +1904,51 @@
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>
@@ -3020,6 +3095,21 @@
<informalexample>
<screen><prompt>$</prompt> <userinput>man guacenc</userinput></screen>
</informalexample>
+ <para>If recording of key events is explicitly enabled using the
+ <parameter>recording-include-keys</parameter> parameter, recordings can also
+ be translated into human-readable interpretations of the keys pressed during the
+ session using the <command>guaclog</command> utility. The usage of
+ <command>guaclog</command> is analogous to <command>guacenc</command>, and
+ results in the creation of a new text file containing the interpreted
+ events:</para>
+ <informalexample>
+ <screen><prompt>$</prompt> <userinput>guaclog <replaceable>/path/to/recording/NAME</replaceable></userinput><computeroutput>
+guaclog: INFO: Guacamole input log interpreter (guaclog) version 0.9.14
+guaclog: INFO: 1 input file(s) provided.
+guaclog: INFO: Writing input events from "<replaceable>/path/to/recording/NAME</replaceable>" to "<replaceable annotations="">/path/to/recording/NAME</replaceable>.txt" ...
+guaclog: INFO: All files interpreted successfully.</computeroutput>
+<prompt>$</prompt> </screen>
+ </informalexample>
<important>
<para>Guacamole will never overwrite an existing recording. If necessary, a
numeric suffix like ".1", ".2", ".3", etc. will be appended to
@@ -3089,6 +3179,51 @@
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>
@@ -3545,6 +3680,21 @@
<informalexample>
<screen><prompt>$</prompt> <userinput>man guacenc</userinput></screen>
</informalexample>
+ <para>If recording of key events is explicitly enabled using the
+ <parameter>recording-include-keys</parameter> parameter, recordings can also
+ be translated into human-readable interpretations of the keys pressed during the
+ session using the <command>guaclog</command> utility. The usage of
+ <command>guaclog</command> is analogous to <command>guacenc</command>, and
+ results in the creation of a new text file containing the interpreted
+ events:</para>
+ <informalexample>
+ <screen><prompt>$</prompt> <userinput>guaclog <replaceable>/path/to/recording/NAME</replaceable></userinput><computeroutput>
+guaclog: INFO: Guacamole input log interpreter (guaclog) version 0.9.14
+guaclog: INFO: 1 input file(s) provided.
+guaclog: INFO: Writing input events from "<replaceable>/path/to/recording/NAME</replaceable>" to "<replaceable annotations="">/path/to/recording/NAME</replaceable>.txt" ...
+guaclog: INFO: All files interpreted successfully.</computeroutput>
+<prompt>$</prompt> </screen>
+ </informalexample>
<important>
<para>Guacamole will never overwrite an existing recording. If necessary, a
numeric suffix like ".1", ".2", ".3", etc. will be appended to
@@ -3614,6 +3764,51 @@
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>
diff --git a/src/chapters/installing.xml b/src/chapters/installing.xml
index 0e65eb5..e054e64 100644
--- a/src/chapters/installing.xml
+++ b/src/chapters/installing.xml
@@ -637,6 +637,7 @@
guacd ...... yes
guacenc .... yes
+ guaclog .... yes
Init scripts: /etc/init.d
