Imported reiserfsprogs-3.6.18

debugreiserfs/debugreiserfs.8

@@ -1,13 +1,13 @@
 .\" -*- nroff -*-
 .\" Copyright 1996-2004 Hans Reiser.
 .\" 
-.TH DEBUGREISERFS 8 "February 2004" "Reiserfsprogs 3.6.13"
+.TH DEBUGREISERFS 8 "February 2004" "Reiserfsprogs 3.6.18"
 .SH NAME
-debugreiserfs \- debugging tool for the ReiserFS filesystem
+debugreiserfs \- The debugging tool for the ReiserFS filesystem.
 .SH SYNOPSIS
 .B debugreiserfs
 [
-.B -dDJmoqpS
+.B -dDJmoqpuSV
 ] [
 .B -j \fIdevice
 ] [
@@ -21,69 +21,77 @@ debugreiserfs \- debugging tool for the ReiserFS filesystem
 .\" ] [
 .I device
 .SH DESCRIPTION
-It helps sometimes to solve problems with reiserfs filesystems. Being
-called without options it prints super block of reiserfs filesystem found
+\fBdebugreiserfs\fR sometimes helps to solve problems with reiserfs filesystems. 
+When run without options it prints the super block of the ReiserFS filesystem found
 on the \fIdevice\fR.
 .TP
 .I device
 is the special file corresponding to the device (e.g /dev/hdXX for
-IDE disk partition or /dev/sdXX for SCSI disk partition).
+an IDE disk partition or /dev/sdXX for a SCSI disk partition).
 .SH OPTIONS
 .TP
 \fB-j\fR \fIdevice\fR
-print contents of journal. Also with the option -p it allows to pack
-journal into archive with other metadata  
+prints the contents of the journal. The option -p allows it to pack the journal 
+with other metadata into the archive.
 .TP
 \fB-J\fR
-print journal header.
+prints the journal header.
 .TP
 .B -d
-print formatted nodes of the internal tree of the filesystem
+prints the formatted nodes of the internal tree of the filesystem.
 .TP
 .B -D
-print formatted nodes of all used blocks of the filesystem
+prints the formatted nodes of all used blocks of the filesystem.
 .TP
 .B -m
-print contents of bitmap (not very useful)
+prints the contents of the bitmap (slightly useful).
 .TP
 .B -o
-print objectid map (not very useful)
+prints the objectid map (slightly useful).
 .TP
 \fB-B\fR \fIfile\fR
-extract the filesystem list of bad blocks to the specified file.
+takes the list of bad blocks stored in the internal ReiserFS tree and translates it 
+into an ascii list written to the specified file.
 .TP
 \fB-1\fR \fIblocknumber\fR
-print specified block of the filesystem
+prints the specified block of the filesystem.
 .TP
 .\" \fB-s
 .\" scans the partition and prints a line when any kind of reiserfs
 .\" formatted nodes found. Can be used to find specific key in the filesystem.
 .\" .TP
 .B -p
-Makes \fBdebugreiserfs\fR to find filesystem metadata This option
-exists to help reiserfsck debugging. If reiserfsck fails - you may
-extract filesystem metadata with \fBdebugreiserfs\fR -p
-/dev/xxx |gzip -c > xxx.gz. We download that data and make the
-filesystem similar to your with gunzip -c xxx.gz | unpack /dev/xxx
-(unpack is included into reiserfsprogs package). This usually allows
-to reproduce and debug the problem quickly. When data file is not too
-large.
+extracts the filesystem's metadata with \fBdebugreiserfs\fR -p /dev/xxx | gzip -c > 
+xxx.gz. None of your data are packed unless a filesystem corruption presents when 
+the whole block having this corruption is packed. You send us the output, and we use 
+it to create a filesystem with the same strucure as yours using \fBdebugreiserfs -u\fR.
+When the data file is not too large, this usually allows us to quickly reproduce 
+and debug the problem.
+.TP
+.B -u
+builds the ReiserFS filesystem image with gunzip -c xxx.gz | \fBdebugreiserfs\fR 
+-u /dev/image of the previously packed metadata with \fBdebugreiserfs -p\fR. The
+result image is not the same as the original filesystem, because mostly only metadata
+were packed with \fBdebugreiserfs -p\fR, but the filesystem structure is completely 
+recreated.
 .TP
 .B -S 
 When -S is not specified -p 
 .\" and -s 
-deals with blocks marked used in the
-filesystem bitmap. With this option set they will work with whole
-device.
+deals with blocks marked used in the filesystem bitmap only. With this option 
+set \fBdebugreiserfs\fR will work with the entire device.
 .TP
 .B -q
-Suppress showing speed of progress when 
+When 
 .\" -s or 
--p is in use
+-p is in use, suppress showing the speed of progress.
 .SH AUTHOR
-This version of \fBdebugreiserfs\fR has been written by Hans Reiser <reiser@namesys.com>.
+This version of \fBdebugreiserfs\fR has been written by Vitaly Fertman 
+<vitaly@namesys.com>.
 .SH BUGS
-There are probably few of them. Please, report bugs to ReiserFS mail-list <reiserfs-list@namesys.com>.
+Please report bugs to the ReiserFS developers <reiserfs-dev@namesys.com>, providing
+as much information as possible--your hardware, kernel, patches, settings, all printed
+messages; check the syslog file for any related information.
 .SH SEE ALSO
 .BR reiserfsck (8),
 .BR mkreiserfs (8)