lib: Splitting up configfile.cc to contain Unix and Windows support in separate sourc...
[barry.git] / doc / www / backups.php
blob1ec253902802d3565fd1689b7df3d4289998d8a4
1 <? include ("barry.inc"); ?>
3 <? createHeader("Backing up your BlackBerry Data"); ?>
6 <? createSubHeader("Introduction"); ?>
8 <p>Backups are currently performed using the Barry Backup GUI program, located
9 in the gui/ directory of the source tarball. Instructions for building the
10 GUI can be found on the <? createLink("install", "Install"); ?> and
11 <? createLink("cvs", "git"); ?> pages.</p>
14 <? createSubHeader("GTK+ Themes"); ?>
16 <p>The Barry Backup GUI program is written using the GTK+ library. If you
17 do not use the Gnome desktop, then the default theme for GTK+ applications
18 often looks terrible.</p>
20 <p>Themes can be chosen for GTK+ apps without Gnome's settings
21 or daemons interfering with your desktop of choice.</p>
23 <p>Search under the /usr/share/themes directory for 'gtkrc' files. Pick
24 the one you like best, and then include it by reference in your .gtkrc-2.0
25 config file in your home directory.</p>
27 <p>For example, suppose you want to use the GTK+ Clearlooks theme.
28 Your .gtkrc-2.0 file would contain:</p>
30 <pre>
31 include "/usr/share/themes/Clearlooks/gtk-2.0/gtkrc"
32 </pre>
35 <? createSubHeader("Main Screen"); ?>
38 <p>When Backup starts, it scans the USB bus for all the Blackberry devices
39 it can find and lists them in the main screen. The first device listed
40 is automatically connected and highlighted.</p>
42 <p>You can connect to different devices on the fly by selecting the
43 desired device in the list. The currently highlighted device determines
44 what device the buttons to the right will operate on.</p>
46 <p>When connecting to a device for the first time, you are prompted to
47 give the device a name. This will be linked to the device's PIN number
48 for easy identification later.</p>
50 <p>The main screen presents you with a number of options.</p>
52 <? createImage("backup.png"); ?>
56 <? createSubHeader("Backup Button"); ?>
58 <p>The Backup button initiates the backup process for the currently selected
59 device. Multiple backups and restores can be run at once.</p>
61 <p>When backing up your device, your data is saved by default in a
62 compressed tar file in your home directory, under ~/.barry, organized by
63 PIN number. Each tar backup file is given a timestamp in its filename.
64 The destination directory can be changed per device, using the Config...
65 button.</p>
67 <p>When the backup starts, you are prompted to give the backup an optional
68 name. If you specify a name, it will be used as part of the tar filename.</p>
72 <? createSubHeader("Restore Button"); ?>
74 <p>Pressing the Restore button will show a File Open dialog, pointing
75 to your ~/.barry directory, for the current device PIN.</p>
77 <? createImage("restore.png"); ?>
79 <p>You are not limited to the tar files in this directory, nor are you
80 limited to backup files from the same device. You can use this tool
81 to copy data from one device to another.</p>
83 <p>The restore is governed by your current configuration, which determines
84 what databases are restored. Any database that is restored will be
85 completely erased before the backup data is re-written. If the source
86 backup file contains no data for that database, then the database
87 will merely be erased.</p>
89 <p>There are some databases that are read-only on the BlackBerry.
90 In addition, if your device is connected to a BES, you may not be
91 able to restore your data. If you get errors when trying to
92 restore a certain read-only database, disable that database in
93 the Restore Configuration dialog, as described below.</p>
97 <? createSubHeader("Config Button"); ?>
99 <p>Pressing the Config button opens the config options dialog as shown
100 below.</p>
102 <? createImage("config.png"); ?>
104 <p>You can rename your device here, set a different backup target directory,
105 and select whether backups should have labels or not. If this checkbox
106 is selected, you will be prompted for an optional label each time you
107 create a new backup.</p>
109 <? createImage("label.png"); ?>
111 <p>Both backup and restore operations have their own database filters
112 which can be configured here. For the backup filter, only the enabled
113 databases will be saved. For the restore filter, only the enabled
114 databases will be restored, even if the backup file contains more data.</p>
116 <p>Each filter configure button provides essentially the same dialog,
117 containing a list of databases available on your device, as well as
118 checkboxes to enable them.</p>
120 <? createImage("config-backup.png"); ?>
122 <p>This configuration is saved per device PIN. If you backup a different
123 device, you will need to configure its backup strategy again. You can only
124 change the configuration for the current device with these dialogs.</p>
128 <? createSubHeader("Disconnect Buttons"); ?>
130 <p>The Disconnect and Disconnect All buttons let you escape the device's
131 Desktop mode while keeping the program running. It is possible to disconnect
132 during a backup or restore, but this may leave your device data in an
133 unknown state.</p>
135 <? createSubHeader("Rescan Button"); ?>
137 <p>This button refreshes the device list, which is useful when a new device
138 has been plugged in.</p>