[16/27] btrfs-progs: Convert man page for btrfsck
diff mbox

Message ID 1396427378-10487-17-git-send-email-quwenruo@cn.fujitsu.com
State Awaiting Upstream
Delegated to: David Sterba
Headers show

Commit Message

Qu Wenruo April 2, 2014, 8:29 a.m. UTC
Convert man page for btrfsck.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
 Documentation/Makefile    |  2 +-
 Documentation/btrfsck.txt | 55 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 56 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/btrfsck.txt

Patch
diff mbox

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 4040951..b4d8281 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -3,7 +3,7 @@  MAN8_TXT =
 
 # Top level commands
 MAN8_TXT += btrfs.txt
-#MAN8_TXT += btrfsck.txt
+MAN8_TXT += btrfsck.txt
 #MAN8_TXT += btrfs-convert.txt
 #MAN8_TXT += btrfs-debug-tree.txt
 #MAN8_TXT += btrfs-find-root.txt
diff --git a/Documentation/btrfsck.txt b/Documentation/btrfsck.txt
new file mode 100644
index 0000000..751c4d0
--- /dev/null
+++ b/Documentation/btrfsck.txt
@@ -0,0 +1,55 @@ 
+btrfsck(8)
+==========
+
+NAME
+----
+btrfsck - check or repair a btrfs filesystem offline
+
+SYNOPSIS
+--------
+'btrfsck' [options] <device>
+
+DESCRIPTION
+-----------
+'btrfsck' is used to check and optionally repair of a Btrfs filesystem.
+
+Now, it can only be run on an unmounted FS.
+<device> is the device file where the filesystem is stored.
+
+'btrfsck' is just an alias of 'btrfs check' command.
+
+WARNING: Considering it is not well-tested in real-life situations yet.
+If you have a broken Btrfs filesystem, btrfsck may not repair but cause
+additional damages. 
+
+
+OPTIONS
+-------
+-s|--support <superblock>::
+use <superblock>th superblock copy.
+--repair::
+try to repair the filesystem.
+--init-csum-tree::
+create a new CRC tree.
+--init-extent-tree::
+create a new extent tree.
+
+EXIT STATUS
+-----------
+'btrfsck' returns a zero exist status if it succeeds. Non zero is
+returned in case of failure.
+
+AVAILABILITY
+------------
+'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
+development,
+and not suitable for any uses other than benchmarking and review.
+Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
+further details.
+
+SEE ALSO
+--------
+`mkfs.btrfs`(8),
+`btrfs-scrub`(8),
+`btrfs-rescue`(8)
+`btrfs-check`(8)