blob: 8ea27e1d424d5c78efb5ef4fd2328bba379703e8 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<appendix xml:id="protocol-reference" xmlns="http://docbook.org/ns/docbook" version="5.0"
xml:lang="en" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>Guacamole protocol reference</title>
<indexterm>
<primary>Guacamole protocol</primary>
</indexterm>
<indexterm>
<primary>protocol reference</primary>
</indexterm>
<indexterm>
<primary>instructions</primary>
</indexterm>
<section xml:id="drawing-instructions">
<title>Drawing instructions</title>
<indexterm>
<primary>drawing instructions</primary>
</indexterm>
<indexterm>
<primary>instructions</primary>
<secondary>drawing</secondary>
</indexterm>
<indexterm>
<primary>server instructions</primary>
<secondary>drawing</secondary>
</indexterm>
<xi:include href="instructions/server/drawing/arc.xml"/>
<xi:include href="instructions/server/drawing/cfill.xml"/>
<xi:include href="instructions/server/drawing/clip.xml"/>
<xi:include href="instructions/server/drawing/close.xml"/>
<xi:include href="instructions/server/drawing/copy.xml"/>
<xi:include href="instructions/server/drawing/cstroke.xml"/>
<xi:include href="instructions/server/drawing/cursor.xml"/>
<xi:include href="instructions/server/drawing/curve.xml"/>
<xi:include href="instructions/server/drawing/dispose.xml"/>
<xi:include href="instructions/server/drawing/distort.xml"/>
<xi:include href="instructions/server/drawing/identity.xml"/>
<xi:include href="instructions/server/drawing/lfill.xml"/>
<xi:include href="instructions/server/drawing/line.xml"/>
<xi:include href="instructions/server/drawing/lstroke.xml"/>
<xi:include href="instructions/server/drawing/move.xml"/>
<xi:include href="instructions/server/drawing/pop.xml"/>
<xi:include href="instructions/server/drawing/push.xml"/>
<xi:include href="instructions/server/drawing/rect.xml"/>
<xi:include href="instructions/server/drawing/reset.xml"/>
<xi:include href="instructions/server/drawing/set.xml"/>
<xi:include href="instructions/server/drawing/shade.xml"/>
<xi:include href="instructions/server/drawing/size.xml"/>
<xi:include href="instructions/server/drawing/start.xml"/>
<xi:include href="instructions/server/drawing/transfer.xml"/>
<xi:include href="instructions/server/drawing/transform.xml"/>
</section>
<section xml:id="streaming-instructions">
<title>Streaming instructions</title>
<xi:include href="instructions/server/stream/ack.xml"/>
<xi:include href="instructions/server/stream/argv.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"/>
<xi:include href="instructions/server/stream/nest.xml"/>
<xi:include href="instructions/server/stream/pipe.xml"/>
<xi:include href="instructions/server/stream/video.xml"/>
</section>
<section xml:id="object-instructions">
<title>Object instructions</title>
<xi:include href="instructions/server/object/body.xml"/>
<xi:include href="instructions/server/object/filesystem.xml"/>
<xi:include href="instructions/server/object/get.xml"/>
<xi:include href="instructions/server/object/put.xml"/>
<xi:include href="instructions/server/object/undefine.xml"/>
</section>
<section xml:id="client-handshake-instructions">
<title>Client handshake instructions</title>
<xi:include href="instructions/client/handshake/audio.xml"/>
<xi:include href="instructions/client/handshake/connect.xml"/>
<xi:include href="instructions/client/handshake/image.xml"/>
<xi:include href="instructions/client/handshake/select.xml"/>
<xi:include href="instructions/client/handshake/size.xml"/>
<xi:include href="instructions/client/handshake/video.xml"/>
</section>
<section xml:id="server-handshake-instructions">
<title>Server handshake instructions</title>
<xi:include href="instructions/server/handshake/args.xml"/>
</section>
<section xml:id="client-control-instructions">
<title>Client control instructions</title>
<indexterm>
<primary>control instructions</primary>
</indexterm>
<indexterm>
<primary>instructions</primary>
<secondary>control</secondary>
</indexterm>
<indexterm>
<primary>client instructions</primary>
<secondary>control</secondary>
</indexterm>
<xi:include href="instructions/client/control/disconnect.xml"/>
<xi:include href="instructions/client/control/nop.xml"/>
<xi:include href="instructions/client/control/sync.xml"/>
</section>
<section xml:id="server-control-instructions">
<title>Server control instructions</title>
<indexterm>
<primary>server instructions</primary>
<secondary>control</secondary>
</indexterm>
<xi:include href="instructions/server/control/disconnect.xml"/>
<xi:include href="instructions/server/control/error.xml"/>
<xi:include href="instructions/server/control/log.xml"/>
<xi:include href="instructions/server/control/mouse.xml"/>
<xi:include href="instructions/server/control/nop.xml"/>
<xi:include href="instructions/server/control/ready.xml"/>
<xi:include href="instructions/server/control/sync.xml"/>
</section>
<section xml:id="client-events">
<title>Client events</title>
<indexterm>
<primary>events</primary>
</indexterm>
<indexterm>
<primary>instructions</primary>
<secondary>events</secondary>
</indexterm>
<indexterm>
<primary>client instructions</primary>
<secondary>events</secondary>
</indexterm>
<xi:include href="instructions/client/event/key.xml"/>
<xi:include href="instructions/client/event/mouse.xml"/>
<xi:include href="instructions/client/event/size.xml"/>
</section>
</appendix>