korg/e2fsprogs
0
0
Fork 0
mirror of https://git.kernel.org/pub/scm/fs/ext2/e2fsprogs.git synced 2024-11-24 18:43:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Clean up e2image man page, mostly based on suggestions from

Browse Source 
Benno Schulenberg.
This commit is contained in:
Theodore Ts'o 2005-06-20 08:26:50 -04:00
parent 9d3cce87be
commit b7c1d202e4
2 changed files with 27 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
misc/ChangeLog
View File

@ -1,3 +1,8 @@
2005-06-20 Theodore Ts'o <tytso@mit.edu>
* e2image.8.in: Clean up e2image man page, mostly based on
suggestions from Benno Schulenberg.
2005-06-16 Theodore Ts'o <tytso@mit.edu> 2005-06-16 Theodore Ts'o <tytso@mit.edu>
* mke2fs.c (PRS): Fix missing close parenthesis from bad inode * mke2fs.c (PRS): Fix missing close parenthesis from bad inode

40
misc/e2image.8.in
View File

@ -4,7 +4,7 @@
.\" .\"
.TH E2IMAGE 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" .TH E2IMAGE 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
.SH NAME .SH NAME
e2image \- Save critical ext2/ext3 filesystem data to a file e2image \- Save critical ext2/ext3 filesystem metadata to a file
.SH SYNOPSIS .SH SYNOPSIS
.B e2image .B e2image
[ [
@ -15,7 +15,7 @@ e2image \- Save critical ext2/ext3 filesystem data to a file
.SH DESCRIPTION .SH DESCRIPTION
The The
.B e2image .B e2image
program will save critical filesystem data on the ext2 filesystem located on program will save critical ext2 or ext3 filesystem metadata located on
.I device .I device
to a file specified by to a file specified by
.IR image-file . .IR image-file .
@ -25,8 +25,8 @@ and
.BR debugfs , .BR debugfs ,
by using the by using the
.B \-i .B \-i
option to those programs. This can be used by an expert in assisting option to those programs. This can assist an expert in
the recovery of catastrophically corrupted filesystems. In the future, recovering catastrophically corrupted filesystems. In the future,
e2fsck will be enhanced to be able to use the image file to help e2fsck will be enhanced to be able to use the image file to help
recover a badly damaged filesystem. recover a badly damaged filesystem.
.PP .PP
@ -37,20 +37,20 @@ is \-, then the output of
will be sent to standard output, so that the output can be piped to will be sent to standard output, so that the output can be piped to
another program, such as another program, such as
.BR gzip (1). .BR gzip (1).
(Note that is currently only supported when (Note that this is currently only supported when
creating a raw image file using the creating a raw image file using the
.B \-r .B \-r
option, since the process of creating a normal image file currently option, since the process of creating a normal image file currently
requires random-access access to the file, which can not be done using a requires random access to the file, which cannot be done using a
pipe. This restriction will hopefully be lifted in a future version of pipe. This restriction will hopefully be lifted in a future version of
.BR e2image .) .BR e2image .)
.PP .PP
It is a very good idea to periodically (at boot time and It is a very good idea to create image files for all of
every week or so) to create image files for all of filesystems on a system and save the partition
filesystems on a system, as well as saving the partition layout (which can be generated using the
layout (which can be generated using the using
.B fdisk \-l .B fdisk \-l
command). Ideally the image file should be stored on some filesystem command) at regular intervals --- at boot time, and/or every week or so.
The image file should be stored on some filesystem
other that other that
the filesystem whose data it contains, to ensure that its data is the filesystem whose data it contains, to ensure that its data is
accessible in the case where the filesystem has been badly damaged. accessible in the case where the filesystem has been badly damaged.
@ -62,13 +62,13 @@ Hence, if the image file
needs to be copied to another location, it should needs to be copied to another location, it should
either be compressed first or copied using the either be compressed first or copied using the
.B \-\-sparse=always .B \-\-sparse=always
option to GNU version of option to the GNU version of
.BR cp . .BR cp .
.PP .PP
The size of an ext2 image file depends primarily on the size of the The size of an ext2 image file depends primarily on the size of the
filesystems and how many inodes are in use. For a typical 10 gigabyte filesystems and how many inodes are in use. For a typical 10 gigabyte
filesystem, with 200,000 inodes in use out of 1.2 million inodes, the filesystem, with 200,000 inodes in use out of 1.2 million inodes, the
image file be approximately 35 megabytes; a 4 gigabyte filesystem with image file will be approximately 35 megabytes; a 4 gigabyte filesystem with
15,000 inodes in use out of 550,000 inodes will result in a 3 megabyte 15,000 inodes in use out of 550,000 inodes will result in a 3 megabyte
image file. Image files tend to be quite image file. Image files tend to be quite
compressible; an image file taking up 32 megabytes of space on compressible; an image file taking up 32 megabytes of space on
@ -85,7 +85,7 @@ back to the device in emergency situations.
.B WARNING!!!! .B WARNING!!!!
The The
.B \-I .B \-I
option should only be used as desperation measure when other option should only be used as a desperation measure when other
alternatives have failed. If the filesystem has changed since the image alternatives have failed. If the filesystem has changed since the image
file was created, data file was created, data
.B will .B will
@ -109,9 +109,9 @@ filesystem itself!) Secondly, the raw image file also includes indirect
blocks and directory blocks, which the standard image file does not have, blocks and directory blocks, which the standard image file does not have,
although this may change in the future. although this may change in the future.
.PP .PP
Raw image files are sometimes used when sending filesystems to as part Raw image files are sometimes used when sending filesystems to the maintainer
of bug reports to e2fsprogs. When used in this capacity, the as part of bug reports to e2fsprogs. When used in this capacity, the
recommended command is (replace hda1 with appropriate device): recommended command is as follows (replace hda1 with the appropriate device):
.PP .PP
.br .br
\ \fBe2image \-r /dev/hda1 \- | bzip2 > hda1.e2i.bz2\fR \ \fBe2image \-r /dev/hda1 \- | bzip2 > hda1.e2i.bz2\fR
@ -124,7 +124,11 @@ may wish to keep confidential. To address this concern, the
option can be specified. This will cause option can be specified. This will cause
.B e2image .B e2image
to scramble directory entries and zero out any unused portions to scramble directory entries and zero out any unused portions
of the directory blocks before writing them to the image file. of the directory blocks before writing the image file. However,
the
.B \-s
option will prevent analysis of problems related to hash-tree indexed
directories.
.PP .PP
.SH AUTHOR .SH AUTHOR
.B e2image .B e2image