Many files:

[tools/e2fsprogs.git] / debugfs / debugfs.8.in

diff --git a/debugfs/debugfs.8.in b/debugfs/debugfs.8.in
index 72b12ec..bc4928e 100644 (file)
--- a/debugfs/debugfs.8.in
+++ b/debugfs/debugfs.8.in
@@ -8,9 +8,6 @@ debugfs \- ext2 file system debugger
 .SH SYNOPSIS
 .B debugfs
 [
 .SH SYNOPSIS
 .B debugfs
 [

-.B \-w
-]
-[

 .B \-f 
 cmd_file
 ]
 .B \-f 
 cmd_file
 ]


@@ -19,8 +16,14 @@ cmd_file
 request
 ]
 [
 request
 ]
 [

+.B \-V
+]
+[
+.B \-w
+[

 device
 ]
 device
 ]

+]

 .SH DESCRIPTION
 The 
 .B debugfs 
 .SH DESCRIPTION
 The 
 .B debugfs 


@@ -34,8 +37,8 @@ file system (e.g /dev/hdXX).
 .SH OPTIONS
 .TP
 .I -w
 .SH OPTIONS
 .TP
 .I -w

-Specify that the file system should be open in read-write mode. Without this
-option, the file system is open in read-only mode.
+Specifies that the file system should be opened in read-write mode.
+Without this option, the file system is opened in read-only mode.

 .TP
 .I -f cmd_file
 Causes 
 .TP
 .I -f cmd_file
 Causes 


@@ -44,7 +47,7 @@ to read in commands from
 .IR cmd_file , 
 and execute them.  When 
 .B debugfs
 .IR cmd_file , 
 and execute them.  When 
 .B debugfs

-is finsihed executing those commands, it will exit.
+is finished executing those commands, it will exit.

 .TP 
 .I -R request
 Causes 
 .TP 
 .I -R request
 Causes 


@@ -52,6 +55,11 @@ Causes
 to execute the single command 
 .IR request ,
 and then exit.
 to execute the single command 
 .IR request ,
 and then exit.

+.TP
+.I -V
+print the version number of 
+.B debugfs
+and exit.

 .SH COMMANDS
 .B debugfs
 is an interactive debugger. It understands a number of commands.
 .SH COMMANDS
 .B debugfs
 is an interactive debugger. It understands a number of commands.


@@ -95,10 +103,10 @@ Expand the directory
 .I find_free_block [goal]
 Find the first free block, starting from
 .I goal
 .I find_free_block [goal]
 Find the first free block, starting from
 .I goal

-and allocates it.
+and allocate it.

 .TP
 .I find_free_inode [dir [mode]]
 .TP
 .I find_free_inode [dir [mode]]

-Find a free inode and allocates it.  If present, 
+Find a free inode and allocate it.  If present, 

 .I dir
 specifies the inode number of the directory 
 which the inode is to be located.  The second 
 .I dir
 specifies the inode number of the directory 
 which the inode is to be located.  The second 


@@ -114,14 +122,14 @@ as not allocated.
 .TP
 .I freei filespec
 Free the inode specified by 
 .TP
 .I freei filespec
 Free the inode specified by 

-.I filespec
+.IR filespec .

 .TP
 .I help
 Print a list of commands understood by 
 .BR debugfs (8).
 .TP
 .I icheck block ...
 .TP
 .I help
 Print a list of commands understood by 
 .BR debugfs (8).
 .TP
 .I icheck block ...

-Print a listing of the inodes which use the one or more block specified
+Print a listing of the inodes which use the one or more blocks specified

 on the command line.
 .TP
 .I initialize device blocksize
 on the command line.
 .TP
 .I initialize device blocksize


@@ -136,11 +144,11 @@ program.  This is just a call to the low-level library, which sets up
 the superblock and block descriptors.
 .TP
 .I kill_file filespec
 the superblock and block descriptors.
 .TP
 .I kill_file filespec

-Dellocate the inode 
+Deallocate the inode 

 .I filespec
 and its blocks.  Note that this does not remove any directory
 entries (if any) to this inode.  See the 
 .I filespec
 and its blocks.  Note that this does not remove any directory
 entries (if any) to this inode.  See the 

-.I rm
+.BR rm (1)

 command if you wish to unlink a file.
 .TP
 .I ln filespec dest_file
 command if you wish to unlink a file.
 .TP
 .I ln filespec dest_file


@@ -170,7 +178,7 @@ and
 device numbers must be specified.
 .TP
 .I ncheck inode_num ...
 device numbers must be specified.
 .TP
 .I ncheck inode_num ...

-Take the requested list of inode numbers, and print a listing of pathnams
+Take the requested list of inode numbers, and print a listing of pathnames

 to those inodes.
 .TP
 .I open [-w] device
 to those inodes.
 .TP
 .I open [-w] device


@@ -186,7 +194,7 @@ Quit
 .I rm pathname
 Unlink 
 .IR pathname .
 .I rm pathname
 Unlink 
 .IR pathname .

-If this cuases the inode pointed to by 
+If this causes the inode pointed to by 

 .I pathname
 to have no other references, deallocate the file.  This command functions
 as the unlink() system call.
 .I pathname
 to have no other references, deallocate the file.  This command functions
 as the unlink() system call.


@@ -241,16 +249,23 @@ Many
 commands take a
 .I filespec
 as an argument to specify an inode (as opposed to a pathname) 
 commands take a
 .I filespec
 as an argument to specify an inode (as opposed to a pathname) 

-in the filesystem which is currently opened by debugfs. The
+in the filesystem which is currently opened by 
+.BR debugfs . 
+The

 .I filespec
 argument may be specified in two forms.  The first form is an inode 
 number surrounded by angle brackets, e.g., 
 .IR <2> .
 The second form is a pathname; if the pathname is prefixed by a forward slash
 ('/'), then it is interpreted relative to the root of the filesystem 
 .I filespec
 argument may be specified in two forms.  The first form is an inode 
 number surrounded by angle brackets, e.g., 
 .IR <2> .
 The second form is a pathname; if the pathname is prefixed by a forward slash
 ('/'), then it is interpreted relative to the root of the filesystem 

-which is currently opened by debugfs.  If not, the pathname is 
-interpreted relative to the current working directory as maintained 
-by debugfs.  This may be modified by using the debugfs command
+which is currently opened by 
+.BR debugfs .
+If not, the pathname is 
+interpreted relative to the current working directory as maintained by 
+.BR debugfs .  
+This may be modified by using the 
+.B debugfs
+command

 .IR cd .
 .SH AUTHOR
 .B debugfs
 .IR cd .
 .SH AUTHOR
 .B debugfs