From fab78f4fd309ee6b0953f4a6d2fbc60775ec34ad Mon Sep 17 00:00:00 2001
From: Rafael Garcia-Suarez <rgarciasuarez@mandriva.org>
Date: Mon, 13 Feb 2006 14:14:11 +0000
Subject: First concise version of the urpmi.recover manpage. Probably need to
 add more complete examples.

---
 pod/urpmi.recover.8.pod | 52 +++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 50 insertions(+), 2 deletions(-)

(limited to 'pod')

diff --git a/pod/urpmi.recover.8.pod b/pod/urpmi.recover.8.pod
index ae66750e..1cce8077 100644
--- a/pod/urpmi.recover.8.pod
+++ b/pod/urpmi.recover.8.pod
@@ -10,22 +10,70 @@ urpmi.recover - manages repackaging of old RPMs and rollbacks
 
 =head1 DESCRIPTION
 
+B<urpmi.recover> is a tool to help management of RPM rollbacks. It has
+three main functions:
+
+C<urpmi.recover --checkpoint> is used to define a point in your system
+that you consider stable, and to start storing info that will enable you
+to rollback installations and upgrades to this state.
+
+C<urpmi.recover --list> is used to list chronologically all installations
+and upgrades on your system.
+
+C<urpmi.recover --rollback> is used to roll back installations and
+upgrades to a previous point in the past (at most until your checkpoint.)
+
 =head1 OPTIONS
 
 =over 4
 
 =item --checkpoint
 
+Define the repackaging checkpoint. From now on, using rpm and/or
+urpmi/urpme to install, upgrade or remove packages, the older packages
+will be stored in F</var/spool/repackage>, or whatever directory you set
+the C<%_repackage_dir> rpm macro to. This way one can use them for
+rollbacks.
+
+Technically, using this option writes a file
+F</etc/rpm/macros.d/urpmi.recover.macros> that overrides the rpm macros
+used to set up the repackaging functionalities of rpm. You can change
+C<%_repackage_dir> there if you want to. Note that you'll probably need
+plenty of space to store repackaged rpms for a long timeframe.
+
+You can also choose to turn off repackaging by setting
+C<%_repackage_all_erasures> to 0 in this file. (Of course if you do so
+rollbacks won't be possible anymore.)
+
 =item --noclean
 
-=item --list
+C<--checkpoint> defines a new checkpoint and removes everything in the
+repackage directory. To prevent this cleaning, use the C<--noclean>
+option.
+
+=item --list <date>
+
+Lists all installations and upgrades from now since the provided date. The
+date parser is quite elaborated, so you can give a date in ISO format or
+close to it (C<YYYY-MM-DD hh:mm:ss>) or a duration (e.g. "1 day ago").
 
 =item --list-all
 
-=item --rollback
+Lists all installations and upgrades known to the RPM database.
+
+=item --rollback <date>
+
+=item --rollback <number of transactions>
+
+Roll back the system to the given date (see C<--list> for accepted date
+formats), or roll backs the given number of transactions.
 
 =back
 
+=head1 FILES
+
+    /etc/rpm/macros.d/urpmi.recover.macros
+
 =head1 AUTHOR
 
 Rafael Garcia-Suarez, <rgarciasuarez@mandriva.com>
-- 
cgit v1.2.1