[04/27] btrfs-progs: Convert man page for btrfs-balance.
diff mbox

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

Commit Message

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

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

Patch
diff mbox

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 1fa2b35..4839b6d 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -18,7 +18,7 @@  MAN8_TXT += btrfs.txt
 # Sub commands for btrfs
 MAN8_TXT += btrfs-subvolume.txt
 MAN8_TXT += btrfs-filesystem.txt
-#MAN8_TXT += btrfs-balance.txt
+MAN8_TXT += btrfs-balance.txt
 #MAN8_TXT += btrfs-device.txt
 #MAN8_TXT += btrfs-scrub.txt
 #MAN8_TXT += btrfs-check.txt
diff --git a/Documentation/btrfs-balance.txt b/Documentation/btrfs-balance.txt
new file mode 100644
index 0000000..2289fdf
--- /dev/null
+++ b/Documentation/btrfs-balance.txt
@@ -0,0 +1,77 @@ 
+btrfs-balance(8)
+================
+
+NAME
+----
+btrfs-balance - balance btrfs filesystem
+
+SYNOPSIS
+--------
+'btrfs [filesystem] balance' <subcommand>|<args>
+
+DESCRIPTION
+-----------
+'btrfs balance' is used to balance chunks in a btrfs filesystem across
+multiple or even single device.
+
+SUBCOMMAND
+----------
+<path>::
+Balance chunks across the devices *online*.
++
+'btrfs balance <path>' is deprecated,
+please use 'btrfs balance start' command instead.
+
+'start' [options] <path>::
+Balance chunks across the devices *online*.
++
+Balance and/or convert (change allocation profile of) chunks that
+passed all filters in a comma-separated list of filters for a
+particular chunk type.
+If filter list is not given balance all chunks of that type.
+In case none of the -d, -m or -s options is
+given balance all chunks in a filesystem.
++
+`Options`
++
+-d[filters]::::
+act on data chunks
+-m[filters]::::
+act on metadata chunks
+-s[filters]::::
+act on system chunks (only under -f)
+-v::::
+be verbose
+-f::::
+force reducing of metadata integrity
+
+'pause' <path>::
+Pause running balance.
+
+'cancel' <path>::
+Cancel running or paused balance.
+
+'resume' <path>::
+Resume interrupted balance.
+
+'status' [-v] <path>::
+Show status of running or paused balance.
++
+If '-v' option is given, output will be verbose.
+
+EXIT STATUS
+-----------
+'btrfs balance' 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),