vitalif
/
e2fsprogs
mirror of https://github.com/vitalif/e2fsprogs
1
0
Fork 0
Code Issues Releases Wiki Activity

Remove unnecessary escape before tab in man pages 

Also fixed a number of other minor nits in the resize2fs and e2image
man pages.

Addresses-Debian-Bug: #674453, #674694

Signed-off-by: "Theodore Ts'o" <tytso@mit.edu>
bitmap-optimize
Theodore Ts'o 2012-05-27 22:03:39 -04:00
parent 9b01faa8b2
commit 4780e8707e
2 changed files with 54 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
misc/e2image.8.in
View File

@ -15,11 +15,11 @@ e2image \- Save critical ext2/ext3/ext4 filesystem metadata to a file
.SH DESCRIPTION
The
.B e2image
program will save critical ext2, ext3, or ext4 filesystem metadata located on
.I device
to a file specified by
program will save critical ext2, ext3, or ext4 filesystem metadata located on
.I device
to a file specified by
.IR image-file .
The image file may be examined by
The image file may be examined by
.B dumpe2fs
and
.BR debugfs ,
@ -30,15 +30,15 @@ recovering catastrophically corrupted filesystems. In the future,
e2fsck will be enhanced to be able to use the image file to help
recover a badly damaged filesystem.
.PP
If
If
.I image-file
is \-, then the output of
is \-, then the output of
.B e2image
will be sent to standard output, so that the output can be piped to
another program, such as
.BR gzip (1).
another program, such as
.BR gzip (1).
(Note that this is currently only supported when
creating a raw image file using the
creating a raw image file using the
.B \-r
option, since the process of creating a normal image file, or QCOW2
image currently
@ -48,21 +48,21 @@ pipe. This restriction will hopefully be lifted in a future version of
.PP
It is a very good idea to create image files for all of
filesystems on a system and save the partition
layout (which can be generated using the
layout (which can be generated using the
.B fdisk \-l
command) at regular intervals --- at boot time, and/or every week or so.
The image file should be stored on some filesystem other than
the filesystem whose data it contains, to ensure that this data is
accessible in the case where the filesystem has been badly damaged.
.PP
To save disk space,
To save disk space,
.B e2image
creates the image file as a sparse file, or in QCOW2 format.
Hence, if the sparse image file
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
option to the GNU version of
option to the GNU version of
.BR cp .
This does not apply to the QCOW2 image, which is not sparse.
.PP
@ -77,15 +77,15 @@ disk will generally compress down to 3 or 4 megabytes.
.PP
.SH RESTORING FILESYSTEM METADATA USING AN IMAGE FILE
.PP
The
.B \-I
The
.B \-I
option will cause e2image to install the metadata stored in the image
file back to the device. It can be used to restore the filesystem metadata
file back to the device. It can be used to restore the filesystem metadata
back to the device in emergency situations.
.PP
.B WARNING!!!!
The
.B \-I
.B \-I
option should only be used as a desperation measure when other
alternatives have failed. If the filesystem has changed since the image
file was created, data
@ -95,13 +95,13 @@ backup of the filesystem first, in case you wish to try other recovery
strategies afterwards.
.PP
.SH RAW IMAGE FILES
The
The
.B \-r
option will create a raw image file instead of a normal image file.
option will create a raw image file instead of a normal image file.
A raw image file differs
from a normal image file in two ways. First, the filesystem metadata is
placed in the proper position so that e2fsck, dumpe2fs, debugfs,
etc. can be run directly on the raw image file. In order to minimize
etc.\& can be run directly on the raw image file. In order to minimize
the amount of disk space consumed by a raw image file, the file is
created as a sparse file. (Beware of copying or
compressing/decompressing this file with utilities that don't understand
@ -115,18 +115,18 @@ as part of bug reports to e2fsprogs. When used in this capacity, the
recommended command is as follows (replace hda1 with the appropriate device):
.PP
.br
\ \fBe2image \-r /dev/hda1 \- | bzip2 > hda1.e2i.bz2\fR
\fBe2image \-r /dev/hda1 \- | bzip2 > hda1.e2i.bz2\fR
.PP
This will only send the metadata information, without any data blocks.
This will only send the metadata information, without any data blocks.
However, the filenames in the directory blocks can still reveal
information about the contents of the filesystem that the bug reporter
may wish to keep confidential. To address this concern, the
.B \-s
option can be specified. This will cause
.B e2image
.B e2image
to scramble directory entries and zero out any unused portions
of the directory blocks before writing the image file. However,
the
the
.B \-s
option will prevent analysis of problems related to hash-tree indexed
directories.
@ -172,11 +172,11 @@ such as for example
.BR qemu-img .
.PP
.SH AUTHOR
.B e2image
.B e2image
was written by Theodore Ts'o (tytso@mit.edu).
.SH AVAILABILITY
.B e2image
is part of the e2fsprogs package and is available from
is part of the e2fsprogs package and is available from
http://e2fsprogs.sourceforge.net.
.SH SEE ALSO
.BR dumpe2fs (8),

56
resize/resize2fs.8.in
View File

@ -11,7 +11,7 @@ resize2fs \- ext2/ext3/ext4 file system resizer
.B \-fFpPM
]
[
.B \-d
.B \-d
.I debug-flags
]
[
@ -23,31 +23,31 @@ resize2fs \- ext2/ext3/ext4 file system resizer
.I size
]
.SH DESCRIPTION
The
.B resize2fs
The
.B resize2fs
program will resize ext2, ext3, or ext4 file systems. It can be used to
enlarge or shrink an unmounted file system located on
enlarge or shrink an unmounted file system located on
.IR device .
If the filesystem is mounted, it can be used to expand the size of the
mounted filesystem, assuming the kernel supports on-line resizing. (As
of this writing, the Linux 2.6 kernel supports on-line resize for
filesystems mounted using ext3 and ext4.).
.PP
The
The
.I size
parameter specifies the requested new size of the filesystem.
If no units are specified, the units of the
.I size
parameter shall be the filesystem blocksize of the filesystem.
Optionally, the
Optionally, the
.I size
parameter may be suffixed by one of the following the units
parameter may be suffixed by one of the following the units
designators: 's', 'K', 'M', or 'G',
for 512 byte sectors, kilobytes, megabytes, or gigabytes, respectively.
The
The
.I size
of the filesystem may never be larger than the size of the partition.
If
If
.I size
parameter is not specified, it will default to the size of the partition.
.PP
@ -63,50 +63,50 @@ The
.B resize2fs
program does not manipulate the size of partitions. If you wish to enlarge
a filesystem, you must make sure you can expand the size of the
underlying partition first. This can be done using
underlying partition first. This can be done using
.BR fdisk (8)
by deleting the partition and recreating it with a larger size or using
.BR lvextend (8),
if you're using the logical volume manager
.BR lvm (8).
When
When
recreating the partition, make sure you create it with the same starting
disk cylinder as before! Otherwise, the resize operation will
certainly not work, and you may lose your entire filesystem.
disk cylinder as before! Otherwise, the resize operation will
certainly not work, and you may lose your entire filesystem.
After running
.BR fdisk (8),
run resize2fs to resize the ext2 filesystem
run resize2fs to resize the ext2 filesystem
to use all of the space in the newly enlarged partition.
.PP
If you wish to shrink an ext2 partition, first use
If you wish to shrink an ext2 partition, first use
.B resize2fs
to shrink the size of filesystem. Then you may use
to shrink the size of filesystem. Then you may use
.BR fdisk (8)
to shrink the size of the partition. When shrinking the size of
the partition, make sure you do not make it smaller than the new size
to shrink the size of the partition. When shrinking the size of
the partition, make sure you do not make it smaller than the new size
of the ext2 filesystem!
.SH OPTIONS
.TP
.B \-d \fIdebug-flags
Turns on various resize2fs debugging features, if they have been compiled
Turns on various resize2fs debugging features, if they have been compiled
into the binary.
.I debug-flags
should be computed by adding the numbers of the desired features
should be computed by adding the numbers of the desired features
from the following list:
.br
\ 2\ \-\ Debug block relocations
2 \-\ Debug block relocations
.br
\ 4\ \-\ Debug inode relocations
4 \-\ Debug inode relocations
.br
\ 8\ \-\ Debug moving the inode table
8 \-\ Debug moving the inode table
.TP
.B \-f
Forces resize2fs to proceed with the filesystem resize operation, overriding
Forces resize2fs to proceed with the filesystem resize operation, overriding
some safety checks which resize2fs normally enforces.
.TP
.B \-F
Flush the filesystem device's buffer caches before beginning. Only
really useful for doing
really useful for doing
.B resize2fs
time trials.
.TP
@ -116,7 +116,7 @@ Shrink the filesystem to the minimum size.
.B \-p
Prints out a percentage completion bars for each
.B resize2fs
operation during an offline resize, so that the user can keep track
operation during an offline resize, so that the user can keep track
of what the program is doing.
.TP
.B \-P
@ -136,7 +136,7 @@ incorrect, especially for filesystems with 1k and 2k blocksizes.
was written by Theodore Ts'o <tytso@mit.edu>.
.SH COPYRIGHT
Resize2fs is Copyright 1998 by Theodore Ts'o and PowerQuest, Inc. All
rights reserved.
rights reserved.
As of April, 2000
.B Resize2fs
may be redistributed under the terms of the GPL.
@ -144,5 +144,5 @@ may be redistributed under the terms of the GPL.
.BR fdisk (8),
.BR e2fsck (8),
.BR mke2fs (8),
.BR lvm (8),
.BR lvm (8),
.BR lvextend (8)