summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoel Martin <github@martintribe.org>2011-01-12 18:09:54 -0600
committerJoel Martin <github@martintribe.org>2011-01-12 18:09:54 -0600
commit6d1e216115d5ab84dafed0c91c40f58f7857c877 (patch)
treef31b592d73b1ec35736097c542d2ea51e6861d8b /docs
parent932e7318b93ecbb59bdf6c22917cc70e03831d86 (diff)
downloadwebsockify-6d1e216115d5ab84dafed0c91c40f58f7857c877.tar.gz
fork noVNC, rename to websockify, cleanup.
Split of wsproxy from noVNC and rename it websockify.
Diffstat (limited to 'docs')
-rw-r--r--docs/TODO34
-rw-r--r--docs/browsers.md126
-rw-r--r--docs/links70
-rw-r--r--docs/rfb_notes147
-rw-r--r--docs/rfbproto-3.3.pdfbin110778 -> 0 bytes
-rw-r--r--docs/rfbproto-3.7.pdfbin165552 -> 0 bytes
-rw-r--r--docs/rfbproto-3.8.pdfbin143840 -> 0 bytes
7 files changed, 0 insertions, 377 deletions
diff --git a/docs/TODO b/docs/TODO
index c64cace..1166e5e 100644
--- a/docs/TODO
+++ b/docs/TODO
@@ -1,35 +1 @@
-Short Term:
-
-- Keyboard layout/internationalization support
- - convert keyCode into proper charCode
-
-- Test on IE 9 preview 3.
-
-- Status bar menu/buttons:
- - Explanatory hover text over buttons
-
- - Configuration menu:
- - Tunable: speed vs. bandwidth selection
- - Tunable: CPU use versus latency.
- - Scaling
-
- - Keyboard menu:
- - Ctrl Lock, Alt Lock, SysRq Lock
- - Highlight menu icon when keys are locked
-
- - Clipboard button -> popup:
- - text, clear and send buttons
-
- wstelnet: support CSI L and CSI M
-
-Medium Term:
-
-- VNC performance and regression playback suite.
-
-- Viewport support
-
-- Touchscreen testing/support.
-
-- wswrapper:
- - epoll_* support
-
diff --git a/docs/browsers.md b/docs/browsers.md
deleted file mode 100644
index ad52fd3..0000000
--- a/docs/browsers.md
+++ /dev/null
@@ -1,126 +0,0 @@
-## noVNC: Browser Support
-
-### Ubuntu Karmic (9.10)
-
-<table>
- <tr>
- <th>Browser</th>
- <th>Status</th>
- <th>Performance/Notes</th>
- </tr> <tr>
- <td>Chrome 7.0.510.0</td>
- <td><strong>Broken</strong></td>
- <td>WebKit render bug (see note 3)</td>
- </tr> <tr>
- <td>Chrome 5.0.375.29</td>
- <td>Excellent</td>
- <td>Very fast. Native WebSockets.</td>
- </tr> <tr>
- <td>Firefox 4.0 Beta 6</td>
- <td>Excellent</td>
- <td>Fast. Native WebSockets. SSL cert hassle (see note 2)</td>
- </tr> <tr>
- <td>Firefox 3.6.1</td>
- <td>Good</td>
- <td>Slowed by web-socket-js overhead. Local cursor causes segfault.</td>
- </tr> <tr>
- <td>Arora 0.10.1</td>
- <td>Fair</td>
- <td>Slow due to broken putImageData and web-socket-js.</td>
- </tr> <tr>
- <td>Opera 10.60</td>
- <td>Poor</td>
- <td>web-socket-js problems, mouse/keyboard issues (see note 1)</td>
- </tr> <tr>
- <td>Konqueror 4.3.2</td>
- <td><strong>Broken</strong></td>
- <td>web-socket-js never loads</td>
- </tr>
-</table>
-
-
-### Ubuntu Jaunty (9.04)
-
-<table>
- <tr>
- <th>Browser</th>
- <th>Status</th>
- <th>Performance/Notes</th>
- </tr> <tr>
- <td>Chrome 5.0.375.29</td>
- <td>Excellent</td>
- <td>Very fast. Native WebSockets.</td>
- </tr> <tr>
- <td>Firefox 3.5</td>
- <td>Good</td>
- <td>Slowed by web-socket-js overhead.</td>
- </tr> <tr>
- <td>Firefox 3.0.17</td>
- <td>Fair</td>
- <td>Works fine but is slow.</td>
- </tr> <tr>
- <td>Arora 0.5</td>
- <td>Fair</td>
- <td>Slow due to broken putImageData and web-socket-js.</td>
- </tr> <tr>
- <td>Opera 10.60</td>
- <td>Poor</td>
- <td>web-socket-js problems, mouse/keyboard issues (see note 1)</td>
- </tr> <tr>
- <td>Konqueror 4.2.2</td>
- <td><strong>Broken</strong></td>
- <td>web-socket-js never loads</td>
- </tr>
-</table>
-
-
-### Windows XP
-
-<table>
- <tr>
- <th>Browser</th>
- <th>Status</th>
- <th>Performance/Notes</th>
- </tr> <tr>
- <td>Chrome 5.0.375.99</td>
- <td>Excellent</td>
- <td>Very fast. Native WebSockets.</td>
- </tr> <tr>
- <td>Safari 5.0</td>
- <td>Excellent</td>
- <td>Fast. Native WebSockets.</td>
- </tr> <tr>
- <td>Firefox 3.0.19</td>
- <td>Good</td>
- <td>Some overhead from web-socket-js.</td>
- </tr> <tr>
- <td>IE 6, 7, 8</td>
- <td><strong>Non-starter</strong></td>
- <td>No basic Canvas support. Javascript painfully slow.</td>
- </tr>
-</table>
-
-
-* Note 1: Opera interacts poorly with web-socket-js. After two
- disconnects the browser tab or Flash often hang. Although Javascript
- is faster than Firefox 3.5, the high variability of web-socket-js
- performance results in overall performance being lower. Middle mouse
- clicks and keyboard events need some work to work properly under
- Opera. Also, Opera does not have support for setting the cursor
- style url to a data URI scheme, so cursor pseudo-encoding is
- disabled.
-
-* Note 2: Firefox 4.0 Beta does not provide a direct way to accept
- SSL certificates via WebSockets. You can work around this by
- navigating directly to the WebSockets port using 'https://' and
- accepting the certificate. Then return to noVNC and connect
- normally.
-
-* Note 3: Browsers using WebKit build 66396 through 68867
- (Chrome/Chromium build 57968 through 61278) have a Canvas rendering
- bug. The WebKit bug is <a
- href="https://bugs.webkit.org/show_bug.cgi?id=46319">#46319</a>.
- The noVNC bug is <a
- href="http://github.com/kanaka/novnc/issues/#issue/28">#28</a>.
-
-
diff --git a/docs/links b/docs/links
deleted file mode 100644
index 8cb4da1..0000000
--- a/docs/links
+++ /dev/null
@@ -1,70 +0,0 @@
-New tight PNG protocol:
- http://wiki.qemu.org/VNC_Tight_PNG
- http://xf.iksaif.net/blog/index.php?post/2010/06/14/QEMU:-Tight-PNG-and-some-profiling
-
-RFB protocol and extensions:
- http://tigervnc.org/cgi-bin/rfbproto
-
-Canvas Browser Compatibility:
- http://philip.html5.org/tests/canvas/suite/tests/results.html
-
-WebSockets API standard:
- http://www.whatwg.org/specs/web-apps/current-work/complete.html#websocket
- http://dev.w3.org/html5/websockets/
- http://www.ietf.org/id/draft-ietf-hybi-thewebsocketprotocol-00.txt
-
-Browser Keyboard Events detailed:
- http://unixpapa.com/js/key.html
-
-ActionScript (Flash) WebSocket implementation:
- http://github.com/gimite/web-socket-js
-
-ActionScript (Flash) crypto/TLS library:
- http://code.google.com/p/as3crypto
- http://github.com/lyokato/as3crypto_patched
-
-TLS Protocol:
- http://en.wikipedia.org/wiki/Transport_Layer_Security
-
-Generate self-signed certificate:
- http://docs.python.org/dev/library/ssl.html#certificates
-
-Cursor appearance/style (for Cursor pseudo-encoding):
- http://en.wikipedia.org/wiki/ICO_(file_format)
- http://www.daubnet.com/en/file-format-cur
- https://developer.mozilla.org/en/Using_URL_values_for_the_cursor_property
-
-
-RDP Protocol specification:
- http://msdn.microsoft.com/en-us/library/cc240445(v=PROT.10).aspx
-
-
-Related projects:
-
- guacamole: http://guacamole.sourceforge.net/
-
- - Web client, but Java servlet does pre-processing
-
- jsvnc: http://code.google.com/p/jsvnc/
-
- - No releases
-
- webvnc: http://code.google.com/p/webvnc/
-
- - Jetty web server gateway, no updates since April 2008.
-
- RealVNC Java applet: http://www.realvnc.com/support/javavncviewer.html
-
- - Java applet
-
- Flashlight-VNC: http://www.wizhelp.com/flashlight-vnc/
-
- - Adobe Flash implementation
-
- FVNC: http://osflash.org/fvnc
-
- - Adbove Flash implementation
-
- CanVNC: http://canvnc.sourceforge.net/
-
- - HTML client with REST to VNC python proxy. Mostly vapor.
diff --git a/docs/rfb_notes b/docs/rfb_notes
deleted file mode 100644
index 643e16c..0000000
--- a/docs/rfb_notes
+++ /dev/null
@@ -1,147 +0,0 @@
-5.1.1 ProtocolVersion: 12, 12 bytes
-
- - Sent by server, max supported
- 12 ascii - "RFB 003.008\n"
- - Response by client, version to use
- 12 ascii - "RFB 003.003\n"
-
-5.1.2 Authentication: >=4, [16, 4] bytes
-
- - Sent by server
- CARD32 - authentication-scheme
- 0 - connection failed
- CARD32 - length
- length - reason
- 1 - no authentication
-
- 2 - VNC authentication
- 16 CARD8 - challenge (random bytes)
-
- - Response by client (if VNC authentication)
- 16 CARD8 - client encrypts the challenge with DES, using user
- password as key, sends resulting 16 byte response
-
- - Response by server (if VNC authentication)
- CARD32 - 0 - OK
- 1 - failed
- 2 - too-many
-
-5.1.3 ClientInitialisation: 1 byte
- - Sent by client
- CARD8 - shared-flag, 0 exclusive, non-zero shared
-
-5.1.4 ServerInitialisation: >=24 bytes
- - Sent by server
- CARD16 - framebuffer-width
- CARD16 - framebuffer-height
- 16 byte PIXEL_FORMAT - server-pixel-format
- CARD8 - bits-per-pixel
- CARD8 - depth
- CARD8 - big-endian-flag, non-zero is big endian
- CARD8 - true-color-flag, non-zero then next 6 apply
- CARD16 - red-max
- CARD16 - green-max
- CARD16 - blue-max
- CARD8 - red-shift
- CARD8 - green-shift
- CARD8 - blue-shift
- 3 bytes - padding
- CARD32 - name-length
-
- CARD8[length] - name-string
-
-
-
-Client to Server Messages:
-
-5.2.1 SetPixelFormat: 20 bytes
- CARD8: 0 - message-type
- ...
-
-5.2.2 FixColourMapEntries: >=6 bytes
- CARD8: 1 - message-type
- ...
-
-5.2.3 SetEncodings: >=8 bytes
- CARD8: 2 - message-type
- CARD8 - padding
- CARD16 - numer-of-encodings
-
- CARD32 - encoding-type in preference order
- 0 - raw
- 1 - copy-rectangle
- 2 - RRE
- 4 - CoRRE
- 5 - hextile
-
-5.2.4 FramebufferUpdateRequest (10 bytes)
- CARD8: 3 - message-type
- CARD8 - incremental (0 for full-update, non-zero for incremental)
- CARD16 - x-position
- CARD16 - y-position
- CARD16 - width
- CARD16 - height
-
-
-5.2.5 KeyEvent: 8 bytes
- CARD8: 4 - message-type
- CARD8 - down-flag
- 2 bytes - padding
- CARD32 - key (X-Windows keysym values)
-
-5.2.6 PointerEvent: 6 bytes
- CARD8: 5 - message-type
- CARD8 - button-mask
- CARD16 - x-position
- CARD16 - y-position
-
-5.2.7 ClientCutText: >=9 bytes
- CARD8: 6 - message-type
- ...
-
-
-Server to Client Messages:
-
-5.3.1 FramebufferUpdate
- CARD8: 0 - message-type
- 1 byte - padding
- CARD16 - number-of-rectangles
-
- CARD16 - x-position
- CARD16 - y-position
- CARD16 - width
- CARD16 - height
- CARD16 - encoding-type:
- 0 - raw
- 1 - copy rectangle
- 2 - RRE
- 4 - CoRRE
- 5 - hextile
-
- raw:
- - width x height pixel values
-
- copy rectangle:
- CARD16 - src-x-position
- CARD16 - src-y-position
-
- RRE:
- CARD32 - N number-of-subrectangles
- Nxd bytes - background-pixel-value (d bits-per-pixel)
-
- ...
-
-5.3.2 SetColourMapEntries (no support)
- CARD8: 1 - message-type
- ...
-
-5.3.3 Bell
- CARD8: 2 - message-type
-
-5.3.4 ServerCutText
- CARD8: 3 - message-type
-
-
-
-
-
diff --git a/docs/rfbproto-3.3.pdf b/docs/rfbproto-3.3.pdf
deleted file mode 100644
index 56b8764..0000000
--- a/docs/rfbproto-3.3.pdf
+++ /dev/null
Binary files differ
diff --git a/docs/rfbproto-3.7.pdf b/docs/rfbproto-3.7.pdf
deleted file mode 100644
index 1ef5462..0000000
--- a/docs/rfbproto-3.7.pdf
+++ /dev/null
Binary files differ
diff --git a/docs/rfbproto-3.8.pdf b/docs/rfbproto-3.8.pdf
deleted file mode 100644
index 8f0730f..0000000
--- a/docs/rfbproto-3.8.pdf
+++ /dev/null
Binary files differ