path: root/Documentation/btrfs-replace.txt
diff options
authorQu Wenruo <>2014-04-02 16:29:25 +0800
committerDavid Sterba <>2014-04-22 14:15:22 +0200
commitbc341bbd16b14ab95f94751c87e5e7fbedd56134 (patch)
tree9a88264c75e4a2b33733dc76510a33c531d0a6e8 /Documentation/btrfs-replace.txt
parent05c6d72830d3b08f1803e205a13c310f689ae801 (diff)
btrfs-progs: Convert man page for btrfs-replace.
Convert man page for btrfs-replace. Signed-off-by: Qu Wenruo <> Signed-off-by: David Sterba <>
Diffstat (limited to 'Documentation/btrfs-replace.txt')
1 files changed, 76 insertions, 0 deletions
diff --git a/Documentation/btrfs-replace.txt b/Documentation/btrfs-replace.txt
new file mode 100644
index 00000000..8c5dcc4f
--- /dev/null
+++ b/Documentation/btrfs-replace.txt
@@ -0,0 +1,76 @@
+btrfs-replace - replace devices managed by btrfs with other device.
+'btrfs replace' <subcommand> <args>
+'btrfs replace' is used to replace btrfs managed devices with other device.
+'start' [-Bfr] <srcdev>|<devid> <targetdev> <path>::
+Replace device of a btrfs filesystem.
+On a live filesystem, duplicate the data to the target device which
+is currently stored on the source device.
+If the source device is not available anymore, or if the -r option is set,
+the data is built only using the RAID redundancy mechanisms.
+After completion of the operation, the source device is removed from the
+If the <srcdev> is a numerical value, it is assumed to be the device id
+of the filesystem which is mounted at <path>, otherwise is is
+the path to the source device. If the source device is disconnected,
+from the system, you have to use the devid parameter format.
+The <targetdev> needs to be same size or larger than the <srcdev>.
+only read from <srcdev> if no other zero-defect mirror exists.
+(enable this if your drive has lots of read errors, the access would be very
+force using and overwriting <targetdev> even if it looks like
+containing a valid btrfs filesystem.
+A valid filesystem is assumed if a btrfs superblock is found which contains a
+correct checksum. Devices which are currently mounted are
+never allowed to be used as the <targetdev>.
+no background replace.
+'status' [-1] <mount_point>::
+Print status and progress information of a running device replace operation.
+print once instead of print continuously until the replace
+operation finishes (or is canceled)
+'cancel' <mount_point>::
+Cancel a running device replace operation.
+'btrfs replace' returns a zero exist status if it succeeds. Non zero is
+returned in case of failure.
+'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
+and not suitable for any uses other than benchmarking and review.
+Please refer to the btrfs wiki for
+further details.