You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@guacamole.apache.org by mj...@apache.org on 2016/03/20 03:15:47 UTC
[37/50] incubator-guacamole-manual git commit: GUAC-1452: Document
new SSH and telnet parameters for recording typescripts.
GUAC-1452: Document new SSH and telnet parameters for recording typescripts.
Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/commit/78c52c1f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/tree/78c52c1f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/diff/78c52c1f
Branch: refs/heads/master
Commit: 78c52c1fc07604c24e208e730a53da9c5a829330
Parents: 6da4c00
Author: Michael Jumper <mi...@guac-dev.org>
Authored: Wed Jan 27 13:41:06 2016 -0800
Committer: Michael Jumper <mi...@guac-dev.org>
Committed: Wed Jan 27 13:41:06 2016 -0800
----------------------------------------------------------------------
src/chapters/configuring.xml | 206 ++++++++++++++++++++++++++++++++++++++
1 file changed, 206 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/78c52c1f/src/chapters/configuring.xml
----------------------------------------------------------------------
diff --git a/src/chapters/configuring.xml b/src/chapters/configuring.xml
index 9176ef2..4bb9c64 100644
--- a/src/chapters/configuring.xml
+++ b/src/chapters/configuring.xml
@@ -2374,6 +2374,109 @@ ed272546-87bd-4db9-acba-e36e1a9ca20a
</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
+ be recorded automatically to a specified directory. This recording, also known
+ as a "typescript", will be written to two files within the directory specified
+ by <parameter>typescript-path</parameter>:
+ <filename><replaceable>NAME</replaceable></filename>, which contains the
+ raw text data, and <filename><replaceable>NAME</replaceable>.timing</filename>,
+ which contains timing information, where <replaceable>NAME</replaceable> is the
+ value provided for the <parameter>typescript-name</parameter> parameter.</para>
+ <para>This format is compatible with the format used by the standard UNIX
+ <command>script</command> command, and can be replayed using
+ <command>scriptreplay</command> (if installed). For example, to replay a
+ typescript called "<replaceable>NAME</replaceable>", you would run:</para>
+ <informalexample>
+ <screen><prompt>$</prompt> <userinput>scriptreplay <replaceable>NAME</replaceable>.timing <replaceable>NAME</replaceable></userinput></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
+ <replaceable>NAME</replaceable> to avoid overwriting an existing
+ recording. If even appending a numeric suffix does not help, the session
+ will simply not be recorded.</para>
+ </important>
+ <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>typescript-path</parameter></entry>
+ <entry>
+ <para><indexterm>
+ <primary>SSH</primary>
+ <secondary>typescripts</secondary>
+ </indexterm><indexterm>
+ <primary>SSH</primary>
+ <secondary>text recording</secondary>
+ </indexterm>The directory in which typescript files should
+ be created. <emphasis>If a typescript needs to be recorded,
+ this parameter is required.</emphasis> Specifying this
+ parameter enables typescript recording. If this parameter is
+ omitted, no typescript will be recorded.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><parameter>create-typescript-path</parameter></entry>
+ <entry>
+ <para>If set to "true", the directory specified by the
+ <parameter>typescript-path</parameter> parameter will
+ automatically be created if it does not yet exist. Only the
+ final directory in the path will be created - if other
+ directories earlier in the path do not exist, automatic
+ creation will fail, and an error will be logged.</para>
+ <para><emphasis>This parameter is optional.</emphasis> By
+ default, the directory specified by the
+ <parameter>typescript-path</parameter> parameter will
+ not automatically be created, and attempts to record
+ typescripts in a non-existent directory will be logged as
+ errors.</para>
+ <para>This parameter only has an effect if typescript recording
+ is enabled. If the <parameter>typescript-path</parameter> is
+ not specified, recording of typescripts will be disabled,
+ and this parameter will be ignored.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><parameter>typescript-name</parameter></entry>
+ <entry>
+ <para>The base filename to use when determining the names for
+ the data and timing files of the typescript. <emphasis>This
+ parameter is optional.</emphasis> If omitted, the value
+ "typescript" will be used instead.</para>
+ <para>Each typescript consists of two files which are created
+ within the directory specified by
+ <parameter>typescript-path</parameter>:
+ <filename><replaceable>NAME</replaceable></filename>,
+ which contains the raw text data, and
+ <filename><replaceable>NAME</replaceable>.timing</filename>,
+ which contains timing information, where
+ <replaceable>NAME</replaceable> is the value provided
+ for the <parameter>typescript-name</parameter>
+ parameter.</para>
+ <para>This parameter only has an effect if typescript recording
+ is enabled. If the <parameter>typescript-path</parameter> is
+ not specified, recording of typescripts will be disabled,
+ and this parameter will be ignored.</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
<section xml:id="ssh-sftp">
<title>SFTP</title>
<para>Guacamole provides support for file transfer over SSH using SFTP, the file
@@ -2696,6 +2799,109 @@ ed272546-87bd-4db9-acba-e36e1a9ca20a
</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,
+ can be recorded automatically to a specified directory. This recording, also
+ known as a "typescript", will be written to two files within the directory
+ specified by <parameter>typescript-path</parameter>:
+ <filename><replaceable>NAME</replaceable></filename>, which contains the
+ raw text data, and <filename><replaceable>NAME</replaceable>.timing</filename>,
+ which contains timing information, where <replaceable>NAME</replaceable> is the
+ value provided for the <parameter>typescript-name</parameter> parameter.</para>
+ <para>This format is compatible with the format used by the standard UNIX
+ <command>script</command> command, and can be replayed using
+ <command>scriptreplay</command> (if installed). For example, to replay a
+ typescript called "<replaceable>NAME</replaceable>", you would run:</para>
+ <informalexample>
+ <screen><prompt>$</prompt> <userinput>scriptreplay <replaceable>NAME</replaceable>.timing <replaceable>NAME</replaceable></userinput></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
+ <replaceable>NAME</replaceable> to avoid overwriting an existing
+ recording. If even appending a numeric suffix does not help, the session
+ will simply not be recorded.</para>
+ </important>
+ <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>typescript-path</parameter></entry>
+ <entry>
+ <para><indexterm>
+ <primary>telnet</primary>
+ <secondary>typescripts</secondary>
+ </indexterm><indexterm>
+ <primary>telnet</primary>
+ <secondary>text recording</secondary>
+ </indexterm>The directory in which typescript files should
+ be created. <emphasis>If a typescript needs to be recorded,
+ this parameter is required.</emphasis> Specifying this
+ parameter enables typescript recording. If this parameter is
+ omitted, no typescript will be recorded.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><parameter>create-typescript-path</parameter></entry>
+ <entry>
+ <para>If set to "true", the directory specified by the
+ <parameter>typescript-path</parameter> parameter will
+ automatically be created if it does not yet exist. Only the
+ final directory in the path will be created - if other
+ directories earlier in the path do not exist, automatic
+ creation will fail, and an error will be logged.</para>
+ <para><emphasis>This parameter is optional.</emphasis> By
+ default, the directory specified by the
+ <parameter>typescript-path</parameter> parameter will
+ not automatically be created, and attempts to record
+ typescripts in a non-existent directory will be logged as
+ errors.</para>
+ <para>This parameter only has an effect if typescript recording
+ is enabled. If the <parameter>typescript-path</parameter> is
+ not specified, recording of typescripts will be disabled,
+ and this parameter will be ignored.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><parameter>typescript-name</parameter></entry>
+ <entry>
+ <para>The base filename to use when determining the names for
+ the data and timing files of the typescript. <emphasis>This
+ parameter is optional.</emphasis> If omitted, the value
+ "typescript" will be used instead.</para>
+ <para>Each typescript consists of two files which are created
+ within the directory specified by
+ <parameter>typescript-path</parameter>:
+ <filename><replaceable>NAME</replaceable></filename>,
+ which contains the raw text data, and
+ <filename><replaceable>NAME</replaceable>.timing</filename>,
+ which contains timing information, where
+ <replaceable>NAME</replaceable> is the value provided
+ for the <parameter>typescript-name</parameter>
+ parameter.</para>
+ <para>This parameter only has an effect if typescript recording
+ is enabled. If the <parameter>typescript-path</parameter> is
+ not specified, recording of typescripts will be disabled,
+ and this parameter will be ignored.</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
<section xml:id="adding-telnet">
<title>Adding a telnet connection</title>
<indexterm>