doc: added documentation for the Desktop GUI, as well as other updates
[barry.git] / doc / www / desktop.php
blob9f8facf92359a8da0fad7145c7a3313ad164dee7
1 <? include ("barry.inc"); ?>
3 <? createHeader("The Barry Desktop GUI"); ?>
5 <? createSubHeader("Main Screen"); ?>
7 <p>Below is the main screen of the Barry Desktop GUI. (Click the buttons
8 in the image to get more detailed help.)
10 <p>
11 <center>
12 <img src="desktop-main.png" width="480" height="352"
13 alt="Barry Desktop main screen" usemap="#desktopmainmap" />
14 <map name="desktopmainmap">
15 <area shape="rect" coords="6,39 152,121"
16 <? createHref("backups"); ?> alt="Launch Backup GUI" />
17 <area shape="rect" coords="166,39 313,121"
18 <? createHref("guisync"); ?> alt="Sync Mode" />
19 <area shape="rect" coords="326,39, 472,121"
20 <? createHref("guimodem"); ?> alt="Modem Launcher" />
21 <area shape="rect" coords="6,134 152,217"
22 <? createHref("migrate"); ?> alt="Migrate Device" />
23 <area shape="rect" coords="166,134 312,217"
24 <? createHref("browse"); ?> alt="Database Browse Mode" />
25 </map>
26 </center>
28 <p>The screen is focused on the available modes that the Desktop supports.
29 Each button will either launch an application, or open a new mode or dialog
30 box to accomplish its task.
32 <p>The red berry in the top left corner is the main menu. It supports the
33 following operations:
34 <ul>
35 <li>Enable / disable verbose logging</li>
36 <li>Give a name to the currently selected device</li>
37 <li>Perform a USB reset on the currently selected device</li>
38 <li>Re-scan the USB bus for new devices</li>
39 <li>Display the About dialog</li>
40 <li>Exit</li>
41 </ul>
43 <p>The currently selected device is chosen by the dropdown list in the lower
44 right corner of the screen. This determines which device will be opened
45 for Syncing, Modem, and Database Browsing. Backup and Migrate (Device Switch)
46 have their own methods for selecting devices.
48 <p>If your device is not password protected, a screenshot is taken and
49 displayed in the lower right hand corner of the screen, as shown.