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 2018/04/02 19:20:39 UTC

[06/23] guacamole-server git commit: GUACAMOLE-269: Add documentation for the defines and variables.

GUACAMOLE-269: Add documentation for the defines and variables.


Project: http://git-wip-us.apache.org/repos/asf/guacamole-server/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-server/commit/2ace9385
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-server/tree/2ace9385
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-server/diff/2ace9385

Branch: refs/heads/master
Commit: 2ace9385a27d77e3fbf1f987b3bf3f0ce6af7ebc
Parents: 5583748
Author: Nick Couchman <vn...@apache.org>
Authored: Thu Feb 22 20:10:16 2018 -0500
Committer: Nick Couchman <vn...@apache.org>
Committed: Thu Mar 8 10:48:21 2018 -0500

----------------------------------------------------------------------
 src/protocols/ssh/ttymode.h | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/guacamole-server/blob/2ace9385/src/protocols/ssh/ttymode.h
----------------------------------------------------------------------
diff --git a/src/protocols/ssh/ttymode.h b/src/protocols/ssh/ttymode.h
index 524051e..e1a0101 100644
--- a/src/protocols/ssh/ttymode.h
+++ b/src/protocols/ssh/ttymode.h
@@ -22,11 +22,31 @@
 
 #include "config.h"
 
+/**
+ * The SSH TTY mode encoding opcode that terminates
+ * the list of TTY modes.
+ */
 #define GUAC_SSH_TTY_OP_END 0
+
+/**
+ * The SSH tty mode encoding opcode that configures
+ * the TTY erase code to configure the server
+ * backspace key.
+ */
 #define GUAC_SSH_TTY_OP_VERASE 3
 
+/**
+ * The default ASCII code to send for the backspace
+ * key that will be sent to the SSH server.
+ */
 #define GUAC_SSH_TERM_DEFAULT_BACKSPACE 127
 
+/**
+ * The array of TTY mode encoding data to send to the
+ * SSH server.  These consist of pairs of byte codes
+ * and uint32 (4-byte) values, with a 0 to terminate
+ * the list.
+ */
 extern const char GUAC_SSH_TTY_MODES[6];
 
 #endif