misc/e2undo.8.in

   1 .\" -*- nroff -*-
   2 .\" Copyright 2008 by Theodore Ts'o.  All Rights Reserved.
   3 .\" This file may be copied under the terms of the GNU Public License.
   4 .\"
   5 .TH E2UNDO 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
   6 .SH NAME
   7 e2undo \- Replay an undo log for an ext2/ext3/ext4 filesystem
   8 .SH SYNOPSIS
   9 .B e2undo
  10 [
  11 .B \-f
  12 ]
  13 [
  14 .B \-h
  15 ]
  16 [
  17 .B \-n
  18 ]
  19 [
  20 .B \-o
  21 .I offset
  22 ]
  23 [
  24 .B \-v
  25 ]
  26 [
  27 .B \-z
  28 .I undo_file
  29 ]
  30 .I undo_log device
  31 .SH DESCRIPTION
  32 .B e2undo
  33 will replay the undo log
  34 .I undo_log
  35 for an ext2/ext3/ext4 filesystem found on
  36 .IR device .
  37 This can be
  38 used to undo a failed operation by an e2fsprogs program.
  39 .SH OPTIONS
  40 .TP
  41 .B \-f
  42 Normally,
  43 .B e2undo
  44 will check the filesystem superblock to make sure the undo log matches
  45 with the filesystem on the device.  If they do not match,
  46 .B e2undo
  47 will refuse to apply the undo log as a safety mechanism.  The
  48 .B \-f
  49 option disables this safety mechanism.
  50 .TP
  51 .B \-h
  52 Display a usage message.
  53 .TP
  54 .B \-n
  55 Dry-run; do not actually write blocks back to the filesystem.
  56 .TP
  57 .BI \-o " offset"
  58 Specify the filesystem's
  59 .I offset
  60 (in bytes) from the beginning of the device or file.
  61 .TP
  62 .B \-v
  63 Report which block we're currently replaying.
  64 .TP
  65 .BI \-z " undo_file"
  66 Before overwriting a file system block, write the old contents of the block to
  67 an undo file.  This undo file can be used with e2undo(8) to restore the old
  68 contents of the file system should something go wrong.  If the empty string is
  69 passed as the undo_file argument, the undo file will be written to a file named
  70 e2undo-\fIdevice\fR.e2undo in the directory specified via the
  71 \fIE2FSPROGS_UNDO_DIR\fR environment variable.
  72
  73 WARNING: The undo file cannot be used to recover from a power or system crash.
  74 .SH AUTHOR
  75 .B e2undo
  76 was written by Aneesh Kumar K.V. (aneesh.kumar@linux.vnet.ibm.com)
  77 .SH AVAILABILITY
  78 .B e2undo
  79 is part of the e2fsprogs package and is available from
  80 http://e2fsprogs.sourceforge.net.
  81 .SH SEE ALSO
  82 .BR mke2fs (8),
  83 .BR tune2fs (8)
  84