From 9883b1af51a1c433a7104d255a8b6fdd79e9e8b5 Mon Sep 17 00:00:00 2001
From: Teemu Toivanen <netti+git@profnetti.fi>
Date: Tue, 1 Mar 2016 14:58:36 +0200
Subject: [PATCH] Faq: how to limit bandwidth

Example to faq documentation how bandwidth limiting can be done with pipeviewer.
---
 docs/faq.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/docs/faq.rst b/docs/faq.rst
index c811786bc..bfd0c4881 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -264,6 +264,32 @@ Since only the files cache is used in the display of files status,
 those files are reported as being added when, really, chunks are
 already used.
 
+
+Is there a way to limit bandwidth with |project_name|?
+------------------------------------------------------
+
+There is no command line option to limit bandwidth with |project_name|, but
+bandwidth limiting can be accomplished with pipeviewer_:
+
+Create a wrapper script:  /usr/local/bin/pv-wrapper  ::
+
+    #!/bin/bash
+        ## -q, --quiet              do not output any transfer information at all
+        ## -L, --rate-limit RATE    limit transfer to RATE bytes per second
+    export RATE=307200
+    pv -q -L $RATE  | "$@"
+
+Add BORG_RSH environment variable to use pipeviewer wrapper script with ssh. ::
+
+    export BORG_RSH='/usr/local/bin/pv-wrapper.sh ssh'
+
+Now |project_name| will be bandwidth limited. Nice thing about pv is that you can change rate-limit on the fly: ::
+
+    pv -R $(pidof pv) -L 102400
+
+.. _pipeviewer: http://www.ivarch.com/programs/pv.shtml
+
+
 Why was Borg forked from Attic?
 -------------------------------