Updated ChangeLog and AUTHORS
[barry.git] / doc / www / backups.php
blob7542976edb944a3b6018bf6f9e2a0df70823550f
1 <? createHeader("Backing up your BlackBerry Data"); ?>
3 <? include ("barry.inc"); ?>
6 <div class="subHeader">Introduction</div>
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"); ?> page.</p>
13 <div class="subHeader">Backup Interface</div>
16 <p>When Backup starts, it scans the USB bus for Blackberry devices. If it
17 finds one, it assumes that is the device you want to work with. If it
18 finds two, it prompts you to select the device to backup.</p>
20 <p>When connecting to a device for the first time, you are prompted to
21 give the device a name. This will be linked to the device's PIN number
22 for easy identification later.</p>
24 <p>The main screen presents you with two options: Backup and Restore.</p>
26 <img src="backup.png" border=1 />
28 <p>When backing up your device, your data is saved in a compressed tar file
29 in your home directory, under ~/.barry, organized by PIN number. Each tar
30 backup file is given a timestamp in its filename.</p>
32 <p>When the backup starts, you are prompted to give the backup an optional
33 name. If you specify a name, it will be used as part of the tar filename.</p>
37 <div class="subHeader">Restore</div>
39 <p>Pressing the Restore button will show a File Open dialog, pointing
40 to your ~/.barry directory, for the current device PIN.</p>
42 <img src="restore.png" border=1 />
44 <p>You are not limited to the tar files in this directory, nor are you
45 limited to backup files from the same device. You can use this tool
46 to copy data from one device to another.</p>
48 <p>The restore is governed by your current configuration, which determines
49 what databases are restored. Any database that is restored will be
50 completely erased before the backup data is re-written.</p>
52 <p>There are some databases that are read-only on the BlackBerry.
53 In addition, if your device is connected to a BES, you may not be
54 able to restore your data. If you get errors when trying to
55 restore a certain read-only database, disable that database in
56 the Restore Configuration dialog, as described below.</p>
60 <div class="subHeader">Configuration</div>
62 <p>Configuration is performed via the Edit menu, and provides two
63 filters for determining what databases are accessed during backup and
64 restore operations. You can also change the device name here, and turn
65 off the backup name prompt.</p>
67 <img src="config.png" border=1 />
69 <p>Each configure button provides essentially the same dialog, containing a
70 list of databases available on your device, as well as checkboxes to
71 enable them.</p>
73 <p>For the backup filter, only the enabled databases will be saved.
74 For the restore filter, only the enabled databases will be restored,
75 even if the backup file contains more data.</p>
77 <img src="config-backup.png" border=1 />
79 <p>This configuration is saved per device PIN. If you backup a different
80 device, you will need to configure its backup strategy again. You can only
81 change the configuration for the current device with these dialogs.</p>