Update web page
[presencevnc] / www / index.html
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
3        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
5 <head>\r
6  <title>Presence VNC - A touchscreen friendly VNC client</title>\r
7  <style type="text/css">\r
8   @import "clean.css";\r
9  </style>\r
10 </head>\r
11 <body>\r
12 \r
13 <h1>Presence VNC</h1>\r
14 <p id="head">A touchscreen friendly VNC client</p>\r
15 \r
16 <ul class="menu">\r
17  <li><a href="https://garage.maemo.org/projects/presencevnc/">Garage Home</a></li>\r
18  <li><a href="https://garage.maemo.org/tracker/?group_id=1831">Bug Tracker</a></li>\r
19  <li><a href="http://maemo.org/packages/view/presencevnc/">Package Page</a></li>\r
20 </ul>\r
21 \r
22 \r
23 <div class="main">\r
24 <h2>Features</h2>\r
25 <p><img src="portrait.png" alt="Presence VNC main window, portrait mode" /></p>\r
26 \r
27 <ul>\r
28  <li>Viewport can be dragged around without using scrollbars</li>\r
29  <li>Touchpad-like mouse input: Tap the screen for a single click, tap twice for a double click, single tap plus dragging motion to drag objects on the remote desktop</li>\r
30  <li>Magnification can be changed via zoom slider (double-click for 1:1)</li>\r
31  <li>Configurable volume buttons</li>\r
32  <li>Portrait mode support</li>\r
33  <li>Support for server-initiated connections (Listen for Incoming Connections)</li>\r
34 </ul>\r
35 \r
36 <h2>Download</h2>\r
37 <p>\r
38 Presence VNC for <strong>Nokia N900</strong> can be <a href="http://maemo.org/downloads/product/raw/Maemo5/presencevnc/?get_installfile">installed from Maemo Extras</a>, older versions and source code are available from the <a href="https://garage.maemo.org/frs/?group_id=1831">project filelist</a>.\r
39 The current development version is accessible through a <a href="https://garage.maemo.org/scm/?group_id=1831">git repository</a>:\r
40 </p>\r
41 <pre>\r
42 git clone https://vcs.maemo.org/git/presencevnc\r
43 </pre>\r
44 \r
45 <p>\r
46 A port for the <strong>Nokia N9</strong> can be found <a href="http://talk.maemo.org/showthread.php?p=1194229#post1194229">in this thread</a>.\r
47 \r
48 </p>\r
49 \r
50 \r
51 <h2>Help</h2>\r
52 \r
53 <!--\r
54 <h3>Introduction</h3>\r
55 <p>TODO </p>\r
56 -->\r
57 \r
58 <h3>Connecting</h3>\r
59 <p><img src="connecting.png" alt="Connect to VNC Server" /></p>\r
60 <p>Enter the hostname or IP address of the computer running the VNC server.\r
61 You can specify the display number after a colon. (e.g.: <tt>hostname:1</tt>)\r
62 If no display is given, 0 will be assumed.\r
63 (A number &ge;100 will be interpreted as a port number. Otherwise, Presence VNC will connect to port 5900 + display.)</p>\r
64 \r
65 <p>Pressing the arrow symbol next to the input field will bring up the list of recently used hosts.\r
66 Additionally, you can select the <strong>Listen for incoming connections</strong> option to accept a "reverse" connection from the server.\r
67 You can specify the port to listen on after clicking the <strong>Listen</strong> button.\r
68 Servers that support this feature include x11vnc (<tt>-connect</tt>), RealVNC and TightVNC (right-click on icon -&gt; "Add New Client").\r
69 </p>\r
70 \r
71 \r
72 <p>Please note that all data transferred using VNC (except your password) is <em>unencrypted</em>. That means your session could be viewed/recorded and even taken over by someone else on your network.\r
73 To prevent this, you can use <a href="http://en.wikipedia.org/wiki/Secure_Shell">SSH</a> or <a href="http://en.wikipedia.org/wiki/Virtual_private_network">VPN</a> to create an encrypted tunnel for your VNC connection. (<a href="http://wiki.maemo.org/Presencevnc">HOWTO (SSH, Linux)</a>)</p>\r
74 \r
75 <p>When the <strong>View only</strong> option is selected, no mouse or keyboard events will be sent to the server.\r
76 In this mode, you can also use the cursor keys on the keyboard to scroll the viewport.\r
77 </p>\r
78 \r
79 \r
80 <h3>Main window</h3>\r
81 <p><img src="main_100.png" alt="Presence VNC main window, 100% zoom" /></p>\r
82 \r
83 <h4>Toolbar</h4>\r
84 <dl>\r
85  <dt>...</dt>\r
86  <dd>Shows a menu of various other keys unavailable from hardware/on-screen keyboard. Please note that the modifier keys (<strong>Win</strong> or <strong>Alt</strong>) will stay pressed until you press them a second time in the <strong>...</strong> menu.</dd>\r
87 \r
88  <dt>Tab, Esc, PgUp, PgDn, Return</dt>\r
89  <dd>Send Tab, Escape, Page Up, Page Down or Return, respectively.</dd>\r
90 \r
91  <dt>On-screen keyboard</dt>\r
92  <dd>Opens the on-screen keyboard (OSK). If the hardware keyboard is open, this button has no effect.<br />\r
93 <em>Limitations:</em>\r
94 The OSK Return key does not work, please use the toolbar button instead. <!-- You can blame Nokia for this one -->\r
95 The Backspace button will only delete text still visible in the OSK, you may need to use its counterpart in the <strong>...</strong> menu or the hardware keyboard.</dd>\r
96 \r
97  <dt>Zoom slider</dt>\r
98  <dd>You can change the zoom level by dragging the slider. At its lowest setting (left), the remote display will be resized to fit the available screen space; the highest setting (right) will double the size of the remote display.\r
99 Double clicking the slider will set the zoom to 100%.</dd>\r
100 \r
101  <dt>Fullscreen</dt>\r
102  <dd>Hides menu and toolbar.\r
103 To leave fullscreen mode, press the button in the lower right corner (visible for a few seconds after each mouse/keyboard input).</dd>\r
104 </dl>\r
105 \r
106 <h3>Preferences</h3>\r
107 <p><img src="preferences.png" alt="Preferences window" /></p>\r
108 <dl>\r
109  <dt>Screen rotation</dt>\r
110  <dd>Wether you want automatic screen rotation when the device is rotated or fixed portrait/landscape mode. Default: Automatic</dd>\r
111 \r
112  <dt>Left/Right zoom button</dt>\r
113  <dd>Allows you to assign actions to the zoom/volume buttons of the N900.\r
114  The default actions are left and right click, respectively.</dd>\r
115 \r
116  <dt>Disable tapping</dt>\r
117  <dd>If this option is checked, tapping your finger on the displayed remote desktop will not produce mouse clicks.\r
118  You can still click using the zoom/volume buttons (see above).\r
119  This option is off by default.</dd>\r
120 \r
121  <dt>Always show local cursor</dt>\r
122  <dd>When enabled, Presence VNC will show a small rectangle to indicate the cursor position.\r
123  This option is especially useful on slow connections (laggy remote cursor).\r
124  Zooming will not affect the size of the local cursor.\r
125  Default: off</dd>\r
126 \r
127  <dt>Zoom to cursor</dt>\r
128  <dd>When enabled, zooming will keep the cursor near to the middle of the screen.\r
129  Otherwise, the center of the currently visible area will be kept visible.\r
130  Default: on</dd>\r
131 </dl>\r
132 \r
133 <h3>Command line options</h3>\r
134 <p>\r
135 Connections can also be initiated from the command line. An overview of the syntax and available options can be displayed using the <tt>--help</tt> switch:\r
136 </p>\r
137 \r
138 <pre>\r
139 Usage: ./presencevnc [options] [URL [quality]]\r
140 \r
141 Options:\r
142  --help            Print this text and exit.\r
143  --listen [port]   Listen for incoming connections on given port, or 5500 if omitted. Cannot be used with an URL.\r
144  --viewonly        Don't send mouse/keyboard input to remote desktop. This is only useful if you also supply a URL, or --listen.\r
145 \r
146 URLs:\r
147  vnc://:password@server:display\r
148 \r
149  Password and display can be omitted, e.g. vnc://server is a valid URL.\r
150  Optionally, you can define the quality as a second argument (1-3, where 1 is the best). Default is 2.\r
151 </pre>\r
152 \r
153 </div>\r
154 \r
155 <p id="footer">&copy;2010&ndash;2012 Christian Pulvermacher</p>\r
156 </body>\r
157 </html>\r