extern/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2024-11-23 00:43:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

rc: add core/stats and vfs/refresh to the docs

Browse Source
This commit is contained in:
Nick Craig-Wood 2018-08-07 20:58:00 +01:00
parent 40d383e223
commit 687477b34d
1 changed files with 51 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/content/rc.md
View File

@ -120,6 +120,40 @@ The most interesting values for most people are:
This returns PID of current process. This returns PID of current process.
Useful for stopping rclone 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 ### rc/error: This returns an error
This returns an error with the input as part of its error string. 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 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 --> <!--- autogenerated stop -->
## Accessing the remote control via HTTP ## Accessing the remote control via HTTP