summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlexander E. Patrakov <patrakov@gmail.com>2018-08-12 03:17:16 +0800
committerAlexander E. Patrakov <patrakov@gmail.com>2018-09-14 20:31:59 +0500
commit4c38179d15ee5011a9144843fc655194409dd506 (patch)
treed08a3281e0c72623607ab76e652e2dbb389f2cf2 /docs
parentd1314d4b3a2dba261ba293ec90c0e3204042734b (diff)
downloadnovnc-4c38179d15ee5011a9144843fc655194409dd506.tar.gz
Show dot when there is no visible cursor
Disabled by default.
Diffstat (limited to 'docs')
-rw-r--r--docs/API.md5
-rw-r--r--docs/EMBEDDING.md3
2 files changed, 8 insertions, 0 deletions
diff --git a/docs/API.md b/docs/API.md
index a81da5c..ae7fb66 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -53,6 +53,11 @@ protocol stream.
should be sent whenever the container changes dimensions. Disabled
by default.
+`showDotCursor`
+ - Is a `boolean` indicating whether a dot cursor should be shown
+ instead of a zero-sized or fully-transparent cursor if the server
+ sets such invisible cursor. Disabled by default.
+
`capabilities` *Read only*
- Is an `Object` indicating which optional extensions are available
on the server. Some methods may only be called if the corresponding
diff --git a/docs/EMBEDDING.md b/docs/EMBEDDING.md
index cad80ef..5399b48 100644
--- a/docs/EMBEDDING.md
+++ b/docs/EMBEDDING.md
@@ -61,6 +61,9 @@ query string. Currently the following options are available:
* `resize` - How to resize the remote session if it is not the same size as
the browser window. Can be one of `off`, `scale` and `remote`.
+* `show_dot` - If a dot cursor should be shown when the remote server provides
+ no local cursor, or provides a fully-transparent (invisible) cursor.
+
* `logging` - The console log level. Can be one of `error`, `warn`, `info` or
`debug`.