GUAC-1432: Document clipboard stream instruction. Remove incorrect documentation covering legacy clipboard event.
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/8af1857c Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/tree/8af1857c Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/diff/8af1857c Branch: refs/heads/master Commit: 8af1857ce93db089e2a6622cb31e3ae0688317ed Parents: 3922c01 Author: Michael Jumper <[email protected]> Authored: Mon Dec 14 15:38:34 2015 -0800 Committer: Michael Jumper <[email protected]> Committed: Mon Dec 14 15:38:34 2015 -0800 ---------------------------------------------------------------------- src/chapters/protocol.xml | 14 +++++----- .../instructions/client/event/clipboard.xml | 23 ---------------- .../instructions/server/event/clipboard.xml | 18 ------------- .../instructions/server/stream/clipboard.xml | 28 ++++++++++++++++++++ src/references/protocol.xml | 10 +------ 5 files changed, 37 insertions(+), 56 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/8af1857c/src/chapters/protocol.xml ---------------------------------------------------------------------- diff --git a/src/chapters/protocol.xml b/src/chapters/protocol.xml index 6b7da4d..842250a 100644 --- a/src/chapters/protocol.xml +++ b/src/chapters/protocol.xml @@ -316,12 +316,14 @@ </section> <section xml:id="guacamole-protocol-streaming"> <title>Streams and objects</title> - <para>Guacamole supports transfer of audio, video, and image data, as well as files and - arbitrary named pipes.</para> - <para>Streams can be allocated directly with "audio" or "video" instructions for the sake of - playing media, with file instructions for file transfer, with "pipe" instructions for - transfer of arbitrary data between client and server, or exposed as structured sets of - named streams known as "objects".</para> + <para>Guacamole supports transfer of clipboard contents, audio, video, and image data, as + well as files and arbitrary named pipes.</para> + <para>Streams are allocated directly with instructions that associate the new stream with + particular semantics and metadata, such as the "audio" or "video" instructions used for + playing media, the "file" instruction used for file transfer, and the "pipe" instruction + for transfer of completely arbitrary data between client and server. In some cases, the + availability and semantics of streams may be explicitly advertised using structured sets + of named streams known as "objects".</para> <para>Once a stream is allocated, data is sent along the stream in chunks using "blob" instructions, which may be acknowledged by the receiving end by "ack" instructions. The end of the stream is finally signalled with an "end" instruction.</para> http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/8af1857c/src/references/instructions/client/event/clipboard.xml ---------------------------------------------------------------------- diff --git a/src/references/instructions/client/event/clipboard.xml b/src/references/instructions/client/event/clipboard.xml deleted file mode 100644 index c9ae7c2..0000000 --- a/src/references/instructions/client/event/clipboard.xml +++ /dev/null @@ -1,23 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<section xml:id="client-clipboard-instruction" - xmlns="http://docbook.org/ns/docbook"; version="5.0" xml:lang="en" - xmlns:xi="http://www.w3.org/2001/XInclude";> - - - - <title>clipboard</title> - <indexterm> - <primary>clipboard</primary> - </indexterm> - <para>Sets the server-side clipboard to the given data.</para> - <variablelist> - <varlistentry> - <term><parameter>data</parameter></term> - <listitem> - <para>The data the clipboard should be set to.</para> - </listitem> - </varlistentry> - </variablelist> - -</section> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/8af1857c/src/references/instructions/server/event/clipboard.xml ---------------------------------------------------------------------- diff --git a/src/references/instructions/server/event/clipboard.xml b/src/references/instructions/server/event/clipboard.xml deleted file mode 100644 index ccc4906..0000000 --- a/src/references/instructions/server/event/clipboard.xml +++ /dev/null @@ -1,18 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<section xml:id="server-clipboard-instruction" xmlns="http://docbook.org/ns/docbook"; - version="5.0" xml:lang="en" xmlns:xi="http://www.w3.org/2001/XInclude";> - <title>clipboard</title> - <indexterm> - <primary>clipboard</primary> - </indexterm> - <para>Sets the client-side clipboard to the given data.</para> - <variablelist> - <varlistentry> - <term><parameter>data</parameter></term> - <listitem> - <para>The data the clipboard should be set to.</para> - </listitem> - </varlistentry> - </variablelist> -</section> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/8af1857c/src/references/instructions/server/stream/clipboard.xml ---------------------------------------------------------------------- diff --git a/src/references/instructions/server/stream/clipboard.xml b/src/references/instructions/server/stream/clipboard.xml new file mode 100644 index 0000000..09ce151 --- /dev/null +++ b/src/references/instructions/server/stream/clipboard.xml @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<section xml:id="clipboard-instruction" xmlns="http://docbook.org/ns/docbook"; version="5.0" + xml:lang="en" xmlns:xi="http://www.w3.org/2001/XInclude";> + <title>clipboard</title> + <indexterm> + <primary>clipboard</primary> + </indexterm> + <para>Allocates a new stream, associating it with the given clipboard metadata. The clipboard + data will later be sent along the stream with blob instructions. If sent by the client, this + data will be the contents of the client-side clipboard. If sent by the server, this data + will be the contents of the clipboard within the remote desktop.</para> + <variablelist> + <varlistentry> + <term><parameter>stream</parameter></term> + <listitem> + <para>The index of the stream to allocate.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mimetype</parameter></term> + <listitem> + <para>The mimetype of the clipboard data being sent. In most cases, this will be + "text/plain".</para> + </listitem> + </varlistentry> + </variablelist> +</section> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/8af1857c/src/references/protocol.xml ---------------------------------------------------------------------- diff --git a/src/references/protocol.xml b/src/references/protocol.xml index ee15d8b..121df33 100644 --- a/src/references/protocol.xml +++ b/src/references/protocol.xml @@ -56,6 +56,7 @@ <xi:include href="instructions/server/stream/ack.xml"/> <xi:include href="instructions/server/stream/audio.xml"/> <xi:include href="instructions/server/stream/blob.xml"/> + <xi:include href="instructions/server/stream/clipboard.xml"/> <xi:include href="instructions/server/stream/end.xml"/> <xi:include href="instructions/server/stream/file.xml"/> <xi:include href="instructions/server/stream/img.xml"/> @@ -125,16 +126,7 @@ <primary>client instructions</primary> <secondary>events</secondary> </indexterm> - <xi:include href="instructions/client/event/clipboard.xml"/> <xi:include href="instructions/client/event/key.xml"/> <xi:include href="instructions/client/event/mouse.xml"/> </section> - <section xml:id="server-events"> - <title>Server events</title> - <indexterm> - <primary>server instructions</primary> - <secondary>events</secondary> - </indexterm> - <xi:include href="instructions/server/event/clipboard.xml"/> - </section> </appendix>
