xfs
[Top] [All Lists]

[PATCH V2] xfsprogs: document all commands in xfs_io

To: xfs-oss <xfs@xxxxxxxxxxx>
Subject: [PATCH V2] xfsprogs: document all commands in xfs_io
From: Eric Sandeen <sandeen@xxxxxxxxxxx>
Date: Sat, 08 Dec 2012 14:55:18 -0600
In-reply-to: <50C39123.6050303@xxxxxxxxxxx>
References: <50C39123.6050303@xxxxxxxxxxx>
User-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:17.0) Gecko/17.0 Thunderbird/17.0
Add missing command documentation to xfs_io(8) manpage.
fiemap, fpunch, chproj, lsproj, and setfl are all missing.

setfl seems to not work today in any case, and nothing
in xfstests uses it; I will send another patch to simply
remove it from xfs_io, as I don't think it's terribly useful,
and hasn't worked forever anyway.

Also fix references to the fallocate manpage, which is (now?)
in section 2, not section 3 of the man pages.  (Since it's
a syscall, not a library function).

Signed-off-by: Eric Sandeen <sandeen@xxxxxxxxxxx>
---

diff --git a/man/man8/xfs_io.8 b/man/man8/xfs_io.8
index f7c6935..33a5944 100644
--- a/man/man8/xfs_io.8
+++ b/man/man8/xfs_io.8
@@ -245,6 +245,12 @@ Prints the block mapping for the current open file. Refer 
to the
 .BR xfs_bmap (8)
 manual page for complete documentation.
 .TP
+.BI "fiemap [ \-alv ] [ \-n " nx " ]"
+Prints the block mapping for the current open file using the fiemap
+ioctl.  Options behave as described in the
+.BR xfs_bmap (8)
+manual page.
+.TP
 .BI "extsize [ \-R | \-D ] [ " value " ]"
 Display and/or modify the preferred extent size used when allocating
 space for the currently open file. If the
@@ -355,17 +361,23 @@ manual page.
 .BI "falloc [ \-k ]" " offset length"
 Allocates reserved, unwritten space for part of a file using the
 fallocate routine as described in the
-.BR fallocate (3)
+.BR fallocate (2)
 manual page.
 .RS 1.0i
 .PD 0
 .TP 0.4i
 .B \-k
 will set the FALLOC_FL_KEEP_SIZE flag as described in
-.BR fallocate (3).
+.BR fallocate (2).
 .PD
 .RE
 .TP
+.BI fpunch " offset length"
+Punches (de-allocates) blocks in the file by calling fallocate with 
+the FALLOC_FL_PUNCH_HOLE flag as described in the
+.BR fallocate (2)
+manual page.
+.TP
 .BI truncate " offset"
 Truncates the current file at the given offset using
 .BR ftruncate (2).
@@ -575,6 +587,24 @@ Selected statistics from
 and the XFS_IOC_FSGEOMETRY
 system call on the filesystem where the current file resides.
 .TP
+.BR chproj " [ " \-R | \-D " ]"
+Modifies the project identifier associated with the current path. The 
+.B \-R
+option will recursively descend if the current path is a directory. The 
+.B \-D
+option will also recursively descend, only setting modifying projects 
+on subdirectories.  See the
+.BR xfs_quota (8)
+manual page for more information about project identifiers.
+.TP
+.BR lsproj " [ " \-R | \-D " ]"
+Displays the project identifier associated with the current path. The 
+.B \-R
+and
+.B \-D
+options behave as described above, in
+.B chproj.
+.TP
 .BR parent " [ " \-cpv " ]"
 By default this command prints out the parent inode numbers,
 inode generation numbers and basenames of all the hardlinks which

<Prev in Thread] Current Thread [Next in Thread>