document BackupPC_xls_report, merge all hosts into single sheet so you can use autofilter

[BackupPC.git] / doc / Search.pm

diff --git a/doc/Search.pm b/doc/Search.pm
index 697c7d5..3bc3921 100644 (file)
--- a/doc/Search.pm
+++ b/doc/Search.pm
@@ -109,11 +109,16 @@ You will also need a few additional cpan modules
 
 =item File::Pid
 
+=item Spreadsheet::WriteExcel
+
 =back
 
+Last module, C<Spreadsheet::WriteExcel> is needed only if you want to use
+C<BackupPC_xls_report> to generate Excel reports from your backup data.
+
 Easiest way to install them is using C<cpan> shell.
 
-  $ sudo cpan File::Pid
+  $ sudo cpan File::Pid Spreadsheet::WriteExcel
 
 =head1 Creation of initial database
 
@@ -150,6 +155,19 @@ B<Documentation is still incomplete>.
 Now that you finished installation, you can select new options from
 menu on the left and example search and archival.
 
+=head1 Reporting in Excel
+
+Often, it is useful to be able to present report about your BackupPC hosts, number
+of snapshots, total size and other useful info. While all those information can
+be accessed using web browser, for analysis it's useful to have them in spreadsheet
+form. With this data, you can monitor changes on your backup cycle, effects of changes
+on your server or network to your BackupPC installation and so on.
+
+You can create Excel spreadsheet (which works perfectly with Gnumeric also) using
+following command:
+
+  $ sudo -u backuppc /data/backuppc/bin/BackupPC_xls_report
+
 =head1 Related projects
 
 BackupPC allready has archival host which might suit your needs better (and