* Added some performance improvements to BackupPC::Xfer::RsyncFileIO
[BackupPC.git] / doc-src / BackupPC.pod
index 0200209..60f5b01 100644 (file)
@@ -238,7 +238,7 @@ are not always up to date and the searching is limited, so Gmane is
 a good alternative.  See:
 
     http://news.gmane.org/index.php?prefix=gmane.comp.sysutils.backup.backuppc
-    http://sourceforge.net/mailarchive/forum.php?forum_id=503
+    http://sourceforge.net/mailarchive/forum.php?forum=backuppc-users
 
 You can subscribe to these lists by visiting:
 
@@ -363,8 +363,7 @@ compression is on.
 
 =item *
 
-Perl version 5.6.0 or later. BackupPC has been tested with
-version 5.6.x, and 5.8.x. If you don't have perl, please
+Perl version 5.8.0 or later.  If you don't have perl, please
 see L<http://www.cpan.org>.
 
 =item *
@@ -407,7 +406,7 @@ L<http://rsync.samba.org>. Use "rsync --version" to check your version.
 For BackupPC to use Rsync you will also need to install the perl
 File::RsyncP module, which is available from
 L<http://perlrsync.sourceforge.net>.
-Version 0.70 or later is required.
+Version 0.68 or later is required.
 
 =item *
 
@@ -966,10 +965,9 @@ Alternatively, rather than backup all the file systems as a single
 share ("/"), it is easier to restore a single file system if you backup
 each file system separately.  To do this you should list each file system
 mount point in $Conf{TarShareName} or $Conf{RsyncShareName}, and add the
---one-file-system option to $Conf{TarClientCmd} or add --one-file-system
-(note the different punctuation) to $Conf{RsyncArgs}.  In this case there
-is no need to exclude /proc explicitly since it looks like a different
-file system.
+--one-file-system option to $Conf{TarClientCmd} or $Conf{RsyncArgs}.
+In this case there is no need to exclude /proc explicitly since it looks
+like a different file system.
 
 Next you should decide whether to run tar over ssh, rsh or nfs. Ssh is
 the preferred method. Rsh is not secure and therefore not recommended.
@@ -1180,7 +1178,7 @@ This is because setuid scripts are disabled by the kernel in most
 flavors of unix and linux.
 
 To see if your perl has setuid emulation, see if there is a program
-called sperl5.6.0 (or sperl5.8.2 etc, based on your perl version)
+called sperl5.8.0 (or sperl5.8.2 etc, based on your perl version)
 in the place where perl is installed. If you can't find this program,
 then you have two options: rebuild and reinstall perl with the setuid
 emulation turned on (answer "y" to the question "Do you want to do
@@ -1455,6 +1453,43 @@ the -a option and rsync -H.  However, the large number of hardlinks
 in the pool will make the memory usage large and the copy very slow.
 Don't forget to stop BackupPC while the copy runs.
 
+Starting in 3.0.0 a new script bin/BackupPC_tarPCCopy can be
+used to assist the copy process.  Given one or more pc paths
+(eg: TOPDIR/pc/HOST or TOPDIR/pc/HOST/nnn), BackupPC_tarPCCopy 
+creates a tar archive with all the hardlinks pointing to ../cpool/....
+Any files not hardlinked (eg: backups, LOG etc) are included
+verbatim.
+
+You will need to specify the -P option to tar when you extract
+the archive generated by BackupPC_tarPCCopy since the hardlink
+targets are outside of the directory being extracted.
+
+To copy a complete store (ie: __TOPDIR__) using BackupPC_tarPCCopy
+you should:
+
+=over 4
+
+=item *
+
+stop BackupPC so that the store is static.
+
+=item *
+
+copy the cpool, conf and log directory trees using any technique
+(like cp, rsync or tar) wihtout the need to preserve hardlinks.
+
+=item *
+
+copy the pc directory using BackupPC_tarPCCopy:
+
+    su __BACKUPPCUSER__
+    cd NEW_TOPDIR
+    mkdir pc
+    cd pc
+    __INSTALLDIR__/bin/BackupPC_tarPCCopy __TOPDIR__/pc | tar xvPf -
+
+=back
+
 =back
 
 =head2 Fixing installation problems
@@ -2724,7 +2759,7 @@ instead of X.0Y. The first digit is for major new releases, the middle
 digit is for significant feature releases and improvements (most of
 the releases have been in this category), and the last digit is for
 bug fixes. You should think of the old 1.00, 1.01, 1.02 and 1.03 as
-1..0, 1.1.0, 1.2.0 and 1.3.0.
+1.0.0, 1.1.0, 1.2.0 and 1.3.0.
 
 Additionally, patches might be made available.  A patched version
 number is of the form X.Y.ZplN (eg: 2.1.0pl2), where N is the
@@ -2738,7 +2773,7 @@ See L<http://backuppc.sourceforge.net>.
 
 =head1 Copyright
 
-Copyright (C) 2001-2006 Craig Barratt
+Copyright (C) 2001-2007 Craig Barratt
 
 =head1 Credits
 
@@ -2764,18 +2799,23 @@ Javier Gonzalez provided the Spanish translation, es.pm for v2.0.0.
 
 Manfred Herrmann provided the German translation, de.pm for v2.0.0.
 Manfred continues to support de.pm updates for each new version,
-together with some help frmo Ralph Paßgang.
+together with some help from Ralph Paßgang.
 
 Lorenzo Cappelletti provided the Italian translation, it.pm for v2.1.0.
+Giuseppe Iuculano and Vittorio Macchi updated it for 3.0.0.
 
 Lieven Bridts provided the Dutch translation, nl.pm, for v2.1.0,
-with some tweaks from Guus Houtzager.
+with some tweaks from Guus Houtzager, and updates for 3.0.0.
 
 Reginaldo Ferreira provided the Portuguese Brazillian translation
 pt_br.pm for v2.2.0.
 
 Rich Duzenbury provided the RSS feed option to the CGI interface.
 
+Jono Woodhouse from CapeSoft Software (www.capesoft.com) provided a
+new CSS skin for 3.0.0 with several layout improvements.  Sean Cameron
+(also from CapeSoft) designed new and more compact file icons for 3.0.0.
+
 Many people have reported bugs, made useful suggestions and helped
 with testing; see the ChangeLog and the mail lists.