summaryrefslogtreecommitdiffstats
path: root/system/extundelete/extundelete.1
diff options
context:
space:
mode:
Diffstat (limited to 'system/extundelete/extundelete.1')
-rw-r--r--system/extundelete/extundelete.1117
1 files changed, 117 insertions, 0 deletions
diff --git a/system/extundelete/extundelete.1 b/system/extundelete/extundelete.1
new file mode 100644
index 0000000000..0eadd3efad
--- /dev/null
+++ b/system/extundelete/extundelete.1
@@ -0,0 +1,117 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH EXTUNDELETE 1 "September 29, 2010"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+extundelete \- utility to undelete files from an ext3 or ext4 partition.
+.SH SYNOPSIS
+.B extundelete
+.RI [ options ] " device-file" ...
+.br
+.SH DESCRIPTION
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
+.\" respectively.
+\fBextundelete\fP is a utility that can recover deleted files from an ext3 or ext4 partition
+.br
+extundelete uses the information stored in the partition's journal to attempt to recover
+a file that has been deleted from the partition.
+.br
+There is no guarantee that any particular file will be able to be undeleted, so always try to have
+a good backup system in place, or at least put one in place after recovering your files!
+
+.SH OPTIONS
+.TP
+.B \-\-version
+Prints the version number of extundelete.
+.TP
+.B \-\-help
+Print a brief usage summary for extundelete.
+.TP
+.B Partition name
+Name of the partition that has deleted files, such as /dev/sda3.
+.br
+Could also be the file name of a copy of the partition, such as that made with dd.
+.TP
+.B \-\-superblock
+Prints information about the filesystem from the superblock.
+.TP
+.B \-\-journal \-\-superblock
+Prints information about the journal from the journal's superblock.
+.TP
+.B \-\-inode #
+Prints the information from the inode number of the filesystem given, such as "\-\-inode 2".
+.TP
+.B \-\-block #
+Prints the contents of the block, called as "\-\-block 9652".
+.TP
+.B \-\-restore\-file path/to/deleted/file
+Attempts to restore the file which was deleted at the given filename, called as "\-\-restore-file dirname/filename".
+.TP
+.B \-\-restore\-inode #
+Used to restore inodes by number, called as "\-\-restore-inode 2569".
+.br
+Also accepts a list of inodes separated by only commas, such as "\-\-restore-inode 2569,5692,6925".
+.TP
+.B \-\-restore\-files filename
+Restores a list of files. First, construct a list of files in the same style as would be
+.br
+used in the \-\-restore\-file option, and save it to the file "filename".
+.br
+Then, this option may be used to attempt to restore those files with a single call to extundelete.
+.br
+This form also reduces redundancy from multiple calls parsing the journal multiple times.
+.TP
+.B \-\-restore\-all
+Restores all files possible to undelete to their names before deletion, when possible.
+Other files are restored to a filename like "file.NNNN".
+.TP
+.B \-\-restore\-directory path/of/directory
+Restores all files possible to link to specified directory to their names before deletion, when possible.
+.TP
+.B \-j journal_dev
+Specifies the device that is the external journal of the file system.
+.TP
+.B \-b block_number
+Specifies the block number of the backup superblock to be used when opening the file system.
+.TP
+.B \-B block_size
+Specifies the block size of the partition to be used when opening the file system.
+.TP
+.B \-\-before date
+Only restore files deleted before the date specified, which should be in the form of the number of seconds since the UNIX epoch.
+Use a shell command like
+.br
+$ date \-d "Aug 1 9:02" +%s
+.br
+to convert a human-readable date to the proper format. The conversion from the number of seconds to a readable format may be found
+by using either of the following:
+.br
+$ date \-d@1234567890
+.br
+$ perl \-le "print scalar localtime 1234567890"
+.TP
+.B \-\-after date
+Only restore files deleted after the date specified, which should be in the form of the number of seconds since the UNIX epoch.
+.br
+See the notes for the \-\-before option for more information.
+.br
+.SH AUTHOR
+extundelete was written by Nic Case <number9652@users.sourceforge.net> Copyright (C) 2009, 2012
+.PP
+This manual page was written by Elías Alejandro Año Mendoza <ealmdz@gmail.com>,
+for the Debian project (and may be used by others).