GUACAMOLE-446: Merge documentation for new "drive-name" parameter.
diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml
index 391fc13..776d0e7 100644
--- a/src/chapters/configuring.xml
+++ b/src/chapters/configuring.xml
@@ -2607,6 +2607,46 @@
default.</para>
</entry>
</row>
+ <row>
+ <entry><parameter>disable-bitmap-caching</parameter></entry>
+ <entry>
+ <para><indexterm>
+ <primary>RDP</primary>
+ <secondary>bitmap caching</secondary>
+ </indexterm>In certain situations, particularly with RDP server
+ implementations with known bugs, it is necessary to disable
+ RDP's built-in bitmap caching functionality. This parameter
+ allows that to be controlled in a Guacamole session. If set to
+ "true" the RDP bitmap cache will not be used.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><parameter>disable-offscreen-caching</parameter></entry>
+ <entry>
+ <para><indexterm>
+ <primary>RDP</primary>
+ <secondary>offscreen bitmap caching</secondary>
+ </indexterm>RDP normally maintains caches of regions of the screen
+ that are current not visible in the client in order to accelerate
+ retrieval of those regions when they come into view. This parameter,
+ when set to "true," will disable caching of those regions. This is
+ usually only useful when dealing with known bugs in RDP server
+ implementations and should remain enabled in most circumstances.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><parameter>disable-glyph-caching</parameter></entry>
+ <entry>
+ <para><indexterm>
+ <primary>RDP</primary>
+ <secondary>glyph caching</secondary>
+ </indexterm>In addition to screen regions, RDP maintains caches of
+ frequently used symbols or fonts, collectively known as "glyphs." As
+ with bitmap and offscreen caching, certain known bugs in RDP implementations
+ can cause performance issues with this enabled, and setting this parameter
+ to "true" will disable that glyph caching in the RDP session.</para>
+ </entry>
+ </row>
</tbody>
</tgroup>
</informaltable>
@@ -2987,6 +3027,46 @@
</tgroup>
</informaltable>
</section>
+ <section xml:id="ssh-terminal-behavior">
+ <title>Controlling terminal behavior</title>
+ <para>In most cases, the default behavior for a terminal works without modification.
+ However, when connecting to certain systems, particularly operating systems other
+ than Linux, the terminal behavior may need to be tweaked to allow it to operate
+ properly. The settings in this section control that behavior.</para>
+ <informaltable frame="all">
+ <indexterm>
+ <primary>parameters</primary>
+ <secondary>SSH</secondary>
+ </indexterm>
+ <tgroup cols="2">
+ <colspec colname="c1" colnum="1" colwidth="1*"/>
+ <colspec colname="c2" colnum="2" colwidth="3.55*"/>
+ <thead>
+ <row>
+ <entry>Parameter name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><parameter>backspace</parameter></entry>
+ <entry>
+ <para><indexterm>
+ <primary>SSH</primary>
+ <secondary>backspace</secondary>
+ </indexterm>This parameter controls the ASCII code that
+ the backspace key sends to the remote system. Under most
+ circumstances this should not need to be adjusted; however,
+ if, when pressing the backspace key, you see control characters
+ (often either ^? or ^H) instead of seeing the text erased,
+ you may need to adjust this parameter. By default the terminal
+ sends ASCII code 127 (Delete) if this option is not set.</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
<section xml:id="ssh-typescripts">
<title>Text session recording (typescripts)</title>
<para>The full, raw text content of SSH sessions, including timing information, can
@@ -3572,6 +3652,46 @@
</tgroup>
</informaltable>
</section>
+ <section xml:id="telnet-terminal-behavior">
+ <title>Controlling terminal behavior</title>
+ <para>In most cases, the default behavior for a terminal works without modification.
+ However, when connecting to certain systems, particularly operating systems other
+ than Linux, the terminal behavior may need to be tweaked to allow it to operate
+ properly. The settings in this section control that behavior.</para>
+ <informaltable frame="all">
+ <indexterm>
+ <primary>parameters</primary>
+ <secondary>telnet</secondary>
+ </indexterm>
+ <tgroup cols="2">
+ <colspec colname="c1" colnum="1" colwidth="1*"/>
+ <colspec colname="c2" colnum="2" colwidth="3.55*"/>
+ <thead>
+ <row>
+ <entry>Parameter name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><parameter>backspace</parameter></entry>
+ <entry>
+ <para><indexterm>
+ <primary>telnet</primary>
+ <secondary>backspace</secondary>
+ </indexterm>This parameter controls the ASCII code that
+ the backspace key sends to the remote system. Under most
+ circumstances this should not need to be adjusted; however,
+ if, when pressing the backspace key, you see control characters
+ (often either ^? or ^H) instead of seeing the text erased,
+ you may need to adjust this parameter. By default the terminal
+ sends ASCII code 127 (Delete) if this option is not set.</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
<section xml:id="telnet-typescripts">
<title>Text session recording (typescripts)</title>
<para>The full, raw text content of telnet sessions, including timing information,
@@ -3599,7 +3719,7 @@
<informaltable frame="all">
<indexterm>
<primary>parameters</primary>
- <secondary>SSH</secondary>
+ <secondary>telnet</secondary>
</indexterm>
<tgroup cols="2">
<colspec colname="c1" colnum="1" colwidth="1*"/>
diff --git a/src/chapters/docker.xml b/src/chapters/docker.xml
index c58cee8..58e4ea3 100644
--- a/src/chapters/docker.xml
+++ b/src/chapters/docker.xml
@@ -64,6 +64,12 @@
port 4822, but this port will only be available to Docker containers that have been
explicitly linked to
<varname><replaceable>some-guacd</replaceable></varname>.</para>
+ <para>The log level of guacd can be controlled with the <varname>GUACD_LOG_LEVEL</varname> environment variable. The
+ default value is <varname><replaceable>info</replaceable></varname>, and can be set to any of the
+ valid settings for the guacd log flag (-L).</para>
+ <informalexample>
+ <screen><prompt>$</prompt> <command>docker</command> run -e GUACD_LOG_LEVEL=<replaceable>debug</replaceable> -d guacamole/guacd</screen>
+ </informalexample>
</section>
<section xml:id="guacd-docker-external">
<title>Running <package>guacd</package> for use by services outside Docker</title>
