From 687477b34dbc8a64495b75a3e8139086171fd8d1 Mon Sep 17 00:00:00 2001
From: Nick Craig-Wood <nick@craig-wood.com>
Date: Tue, 7 Aug 2018 20:58:00 +0100
Subject: [PATCH] rc: add core/stats and vfs/refresh to the docs

---
 docs/content/rc.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)

diff --git a/docs/content/rc.md b/docs/content/rc.md
index 182a18b12..5598174f2 100644
--- a/docs/content/rc.md
+++ b/docs/content/rc.md
@@ -120,6 +120,40 @@ The most interesting values for most people are:
 This returns PID of current process.
 Useful for stopping rclone process.
 
+### core/stats: Returns stats about current transfers.
+
+This returns all available stats
+
+	rclone rc core/stats
+
+Returns following values:
+{
+	"speed": average speed in bytes/sec since start of the process,
+	"bytes": total transferred bytes since the start of the process,
+	"errors": number of errors,
+	"checks": number of checked files,
+	"transfers": number of transferred files,
+	"deletes" : number of deleted files,
+	"elapsedTime": time in seconds since the start of the process,
+	"lastError": last occurred error,
+	"transferring": an array of currently active file transfers:
+		[
+			{
+				"bytes": total transferred bytes for this file,
+				"eta": estimated time in seconds until file transfer completion
+				"name": name of the file,
+				"percentage": progress of the file transfer in percent,
+				"speed": speed in bytes/sec,
+				"speedAvg": speed in bytes/sec as an exponentially weighted moving average,
+				"size": size of the file in bytes
+			}
+		],
+	"checking": an array of names of currently active file checks
+		[]
+}
+Values for "transferring", "checking" and "lastError" are only assigned if data is available.
+The value for "eta" is null if an eta cannot be determined.
+
 ### rc/error: This returns an error
 
 This returns an error with the input as part of its error string.
@@ -152,6 +186,23 @@ starting with dir will forget that dir, eg
 
     rclone rc vfs/forget file=hello file2=goodbye dir=home/junk
 
+### vfs/refresh: Refresh the directory cache.
+
+This reads the directories for the specified paths and freshens the
+directory cache.
+
+If no paths are passed in then it will refresh the root directory.
+
+    rclone rc vfs/refresh
+
+Otherwise pass directories in as dir=path. Any parameter key
+starting with dir will refresh that directory, eg
+
+    rclone rc vfs/refresh dir=home/junk dir2=data/misc
+
+If the parameter recursive=true is given the whole directory tree
+will get refreshed. This refresh will use --fast-list if enabled.
+
 <!--- autogenerated stop -->
 
 ## Accessing the remote control via HTTP