documentation for action: restore

git-svn-id: svn://tug.org/texlive/trunk@8093 c570f23f-e606-0410-a88d-b1316a301751

1 files changed, 35 insertions, 5 deletions

diff --git a/Master/texmf/scripts/texlive/tlmgr.pl b/Master/texmf/scripts/texlive/tlmgr.pl
index fae6380ca8c..664dda052b2 100755
--- a/Master/texmf/scripts/texlive/tlmgr.pl
+++ b/Master/texmf/scripts/texlive/tlmgr.pl
@@ -433,8 +433,10 @@ sub action_restore {
   #   restores pkg to revision rev
   my $opt_backupdir;
   my $opt_force;
+  my $opt_dry = 0;
   Getopt::Long::Configure(qw(no_pass_through));
   GetOptions("backupdir=s" => \$opt_backupdir,
+             "dry-run"     => \$opt_dry,
              "force"       => \$opt_force) or pod2usage(2);
   if (!defined($opt_backupdir)) {
     die "restore needs --backupdir\n";
@@ -480,9 +482,8 @@ sub action_restore {
         exit(0);
       }
     }
-    if ($opt_dry) {
-      print "Installing $pkg\n";
-    } else {
+    print "Restoring $pkg, $rev from $opt_backupdir/${pkg}_r${rev}.tar.lzma\n";
+    if (!$opt_dry) {
       # first remove the package, then reinstall it
       # this way we get rid of useless files
       # force the deinstallation since we will reinstall it
@@ -1135,8 +1136,37 @@ written to the terminal.
 If this option is given it must specify an existing directory where a 
 snapshot of the current package as installed will be saved before 
 the packages is updated. This way one can go back in case an update
-turned out as not working. NOTE that the "go-back" functionality is
-still missing. Work-in-progress!!!
+turned out as not working. See the action B<restore> for details.
+
+=back
+
+=item B<restore --backupdir dir [pkg [rev]]>
+
+If no B<pkg> and B[rev] is given list all packages the available 
+backup revisions.
+
+With B<pkg> given but without B<rev> lists all available backup revisions
+of B<pkg>.
+
+With both B<pkg> an B<rev> given tries to restore the package from its
+backup.
+
+The option B<--backupdir dir> is obligatory and has to specify a directory
+with backups.
+
+Options:
+
+=over 8
+
+=item B<--dry-run>
+
+Nothing is actually restored; instead, the actions to be performed are
+written to the terminal.
+
+=item B<--backupdir directory>
+
+This is an obligatory argument and has to specify a directory where
+backups are to be found.
 
 =back