TrueCloudLab/rclone
16
0
Fork 2
Code Issues 1 Pull requests 1 Projects Releases Packages Wiki Activity Actions

rc: add anchor tags to the docs so links are consistent

Browse source
This commit is contained in:
Nick Craig-Wood 2019-08-13 11:54:13 +01:00
parent 535f5f3c99
commit 8247c8a6af
2 changed files with 53 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
cmd/rc/rc.go
View file

@ -236,7 +236,7 @@ func list() error {
if !ok {
return errors.New("bad JSON")
}
fmt.Printf("### %s: %s\n\n", info["Path"], info["Title"])
fmt.Printf("### %s: %s {#%s}\n\n", info["Path"], info["Title"], info["Path"])
fmt.Printf("%s\n\n", info["Help"])
if authRequired := info["AuthRequired"]; authRequired != nil {
if authRequired.(bool) {

104
docs/content/rc.md
View file

@ -260,7 +260,7 @@ $ rclone rc --json '{ "group": "job/1" }' core/stats
## Supported commands
<!--- autogenerated start - run make rcdocs - don't edit here -->
### cache/expire: Purge a remote from cache
### cache/expire: Purge a remote from cache {#cache/expire}
Purge a remote from the cache backend. Supports either a directory or a file.
Params:
@ -272,7 +272,7 @@ Eg
rclone rc cache/expire remote=path/to/sub/folder/
rclone rc cache/expire remote=/ withData=true
### cache/fetch: Fetch file chunks
### cache/fetch: Fetch file chunks {#cache/fetch}
Ensure the specified file chunks are cached on disk.
@ -299,11 +299,11 @@ specify files to fetch, eg
File names will automatically be encrypted when the a crypt remote
is used on top of the cache.
### cache/stats: Get cache stats
### cache/stats: Get cache stats {#cache/stats}
Show statistics for the cache remote.
### config/create: create the config for a remote.
### config/create: create the config for a remote. {#config/create}
This takes the following parameters
@ -315,7 +315,7 @@ See the [config create command](/commands/rclone_config_create/) command for mor
Authentication is required for this call.
### config/delete: Delete a remote in the config file.
### config/delete: Delete a remote in the config file. {#config/delete}
Parameters:
- name - name of remote to delete
@ -324,7 +324,7 @@ See the [config delete command](/commands/rclone_config_delete/) command for mor
Authentication is required for this call.
### config/dump: Dumps the config file.
### config/dump: Dumps the config file. {#config/dump}
Returns a JSON object:
- key: value
@ -335,7 +335,7 @@ See the [config dump command](/commands/rclone_config_dump/) command for more in
Authentication is required for this call.
### config/get: Get a remote in the config file.
### config/get: Get a remote in the config file. {#config/get}
Parameters:
- name - name of remote to get
@ -344,7 +344,7 @@ See the [config dump command](/commands/rclone_config_dump/) command for more in
Authentication is required for this call.
### config/listremotes: Lists the remotes in the config file.
### config/listremotes: Lists the remotes in the config file. {#config/listremotes}
Returns
- remotes - array of remote names
@ -353,7 +353,7 @@ See the [listremotes command](/commands/rclone_listremotes/) command for more in
Authentication is required for this call.
### config/password: password the config for a remote.
### config/password: password the config for a remote. {#config/password}
This takes the following parameters
@ -364,7 +364,7 @@ See the [config password command](/commands/rclone_config_password/) command for
Authentication is required for this call.
### config/providers: Shows how providers are configured in the config file.
### config/providers: Shows how providers are configured in the config file. {#config/providers}
Returns a JSON object:
- providers - array of objects
@ -373,7 +373,7 @@ See the [config providers command](/commands/rclone_config_providers/) command f
Authentication is required for this call.
### config/update: update the config for a remote.
### config/update: update the config for a remote. {#config/update}
This takes the following parameters
@ -384,7 +384,7 @@ See the [config update command](/commands/rclone_config_update/) command for mor
Authentication is required for this call.
### core/bwlimit: Set the bandwidth limit.
### core/bwlimit: Set the bandwidth limit. {#core/bwlimit}
This sets the bandwidth limit to that passed in.
@ -416,13 +416,13 @@ except only one bandwidth may be specified.
In either case "rate" is returned as a human readable string, and
"bytesPerSecond" is returned as a number.
### core/gc: Runs a garbage collection.
### core/gc: Runs a garbage collection. {#core/gc}
This tells the go runtime to do a garbage collection run. It isn't
necessary to call this normally, but it can be useful for debugging
memory problems.
### core/group-list: Returns list of stats.
### core/group-list: Returns list of stats. {#core/group-list}
This returns list of stats groups currently in memory.
@ -437,7 +437,7 @@ Returns the following values:
]
}
### core/memstats: Returns the memory statistics
### core/memstats: Returns the memory statistics {#core/memstats}
This returns the memory statistics of the running program. What the values mean
are explained in the go docs: https://golang.org/pkg/runtime/#MemStats
@ -449,7 +449,7 @@ The most interesting values for most people are:
* Sys: this is the total amount of memory requested from the OS
* It is virtual memory so may include unused memory
### core/obscure: Obscures a string passed in.
### core/obscure: Obscures a string passed in. {#core/obscure}
Pass a clear string and rclone will obscure it for the config file:
- clear - string
@ -457,12 +457,12 @@ Pass a clear string and rclone will obscure it for the config file:
Returns
- obscured - string
### core/pid: Return PID of current process
### core/pid: Return PID of current process {#core/pid}
This returns PID of current process.
Useful for stopping rclone process.
### core/stats: Returns stats about current transfers.
### core/stats: Returns stats about current transfers. {#core/stats}
This returns all available stats:
@ -507,7 +507,7 @@ Returns the following values:
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.
### core/stats-reset: Reset stats.
### core/stats-reset: Reset stats. {#core/stats-reset}
This clears counters and errors for all stats or specific stats group if group
is provided.
@ -515,7 +515,7 @@ is provided.
Parameters
- group - name of the stats group (string)
### core/transferred: Returns stats about completed transfers.
### core/transferred: Returns stats about completed transfers. {#core/transferred}
This returns stats about completed transfers:
@ -544,7 +544,7 @@ Returns the following values:
]
}
### core/version: Shows the current version of rclone and the go runtime.
### core/version: Shows the current version of rclone and the go runtime. {#core/version}
This shows the current version of go and the go runtime
- version - rclone version, eg "v1.44"
@ -555,14 +555,14 @@ This shows the current version of go and the go runtime
- arch - cpu architecture in use according to Go
- goVersion - version of Go runtime in use
### job/list: Lists the IDs of the running jobs
### job/list: Lists the IDs of the running jobs {#job/list}
Parameters - None
Results
- jobids - array of integer job ids
### job/status: Reads the status of the job ID
### job/status: Reads the status of the job ID {#job/status}
Parameters
- jobid - id of the job (integer)
@ -579,12 +579,12 @@ Results
- output - output of the job as would have been returned if called synchronously
- progress - output of the progress related to the underlying job
### job/stop: Stop the running job
### job/stop: Stop the running job {#job/stop}
Parameters
- jobid - id of the job (integer)
### operations/about: Return the space used on the remote
### operations/about: Return the space used on the remote {#operations/about}
This takes the following parameters
@ -596,7 +596,7 @@ See the [about command](/commands/rclone_size/) command for more information on
Authentication is required for this call.
### operations/cleanup: Remove trashed files in the remote or path
### operations/cleanup: Remove trashed files in the remote or path {#operations/cleanup}
This takes the following parameters
@ -606,7 +606,7 @@ See the [cleanup command](/commands/rclone_cleanup/) command for more informatio
Authentication is required for this call.
### operations/copyfile: Copy a file from source remote to destination remote
### operations/copyfile: Copy a file from source remote to destination remote {#operations/copyfile}
This takes the following parameters
@ -617,7 +617,7 @@ This takes the following parameters
Authentication is required for this call.
### operations/copyurl: Copy the URL to the object
### operations/copyurl: Copy the URL to the object {#operations/copyurl}
This takes the following parameters
@ -629,7 +629,7 @@ See the [copyurl command](/commands/rclone_copyurl/) command for more informatio
Authentication is required for this call.
### operations/delete: Remove files in the path
### operations/delete: Remove files in the path {#operations/delete}
This takes the following parameters
@ -639,7 +639,7 @@ See the [delete command](/commands/rclone_delete/) command for more information
Authentication is required for this call.
### operations/deletefile: Remove the single file pointed to
### operations/deletefile: Remove the single file pointed to {#operations/deletefile}
This takes the following parameters
@ -650,7 +650,7 @@ See the [deletefile command](/commands/rclone_deletefile/) command for more info
Authentication is required for this call.
### operations/fsinfo: Return information about the remote
### operations/fsinfo: Return information about the remote {#operations/fsinfo}
This takes the following parameters
@ -707,7 +707,7 @@ This command does not have a command line equivalent so use this instead:
rclone rc --loopback operations/fsinfo fs=remote:
### operations/list: List the given remote and path in JSON format
### operations/list: List the given remote and path in JSON format {#operations/list}
This takes the following parameters
@ -729,7 +729,7 @@ See the [lsjson command](/commands/rclone_lsjson/) for more information on the a
Authentication is required for this call.
### operations/mkdir: Make a destination directory or container
### operations/mkdir: Make a destination directory or container {#operations/mkdir}
This takes the following parameters
@ -740,7 +740,7 @@ See the [mkdir command](/commands/rclone_mkdir/) command for more information on
Authentication is required for this call.
### operations/movefile: Move a file from source remote to destination remote
### operations/movefile: Move a file from source remote to destination remote {#operations/movefile}
This takes the following parameters
@ -751,7 +751,7 @@ This takes the following parameters
Authentication is required for this call.
### operations/publiclink: Create or retrieve a public link to the given file or folder.
### operations/publiclink: Create or retrieve a public link to the given file or folder. {#operations/publiclink}
This takes the following parameters
@ -766,7 +766,7 @@ See the [link command](/commands/rclone_link/) command for more information on t
Authentication is required for this call.
### operations/purge: Remove a directory or container and all of its contents
### operations/purge: Remove a directory or container and all of its contents {#operations/purge}
This takes the following parameters
@ -777,7 +777,7 @@ See the [purge command](/commands/rclone_purge/) command for more information on
Authentication is required for this call.
### operations/rmdir: Remove an empty directory or container
### operations/rmdir: Remove an empty directory or container {#operations/rmdir}
This takes the following parameters
@ -788,7 +788,7 @@ See the [rmdir command](/commands/rclone_rmdir/) command for more information on
Authentication is required for this call.
### operations/rmdirs: Remove all the empty directories in the path
### operations/rmdirs: Remove all the empty directories in the path {#operations/rmdirs}
This takes the following parameters
@ -800,7 +800,7 @@ See the [rmdirs command](/commands/rclone_rmdirs/) command for more information
Authentication is required for this call.
### operations/size: Count the number of bytes and files in remote
### operations/size: Count the number of bytes and files in remote {#operations/size}
This takes the following parameters
@ -815,12 +815,12 @@ See the [size command](/commands/rclone_size/) command for more information on t
Authentication is required for this call.
### options/blocks: List all the option blocks
### options/blocks: List all the option blocks {#options/blocks}
Returns
- options - a list of the options block names
### options/get: Get all the options
### options/get: Get all the options {#options/get}
Returns an object where keys are option block names and values are an
object with the current option values in.
@ -828,7 +828,7 @@ object with the current option values in.
This shows the internal names of the option within rclone which should
map to the external options very easily with a few exceptions.
### options/set: Set an option
### options/set: Set an option {#options/set}
Parameters
@ -855,23 +855,23 @@ And this sets NOTICE level logs (normal without -v)
rclone rc options/set --json '{"main": {"LogLevel": 6}}'
### rc/error: This returns an error
### rc/error: This returns an error {#rc/error}
This returns an error with the input as part of its error string.
Useful for testing error handling.
### rc/list: List all the registered remote control commands
### rc/list: List all the registered remote control commands {#rc/list}
This lists all the registered remote control commands as a JSON map in
the commands response.
### rc/noop: Echo the input to the output parameters
### rc/noop: Echo the input to the output parameters {#rc/noop}
This echoes the input parameters to the output parameters for testing
purposes. It can be used to check that rclone is still alive and to
check that parameter passing is working properly.
### rc/noopauth: Echo the input to the output parameters requiring auth
### rc/noopauth: Echo the input to the output parameters requiring auth {#rc/noopauth}
This echoes the input parameters to the output parameters for testing
purposes. It can be used to check that rclone is still alive and to
@ -879,7 +879,7 @@ check that parameter passing is working properly.
Authentication is required for this call.
### sync/copy: copy a directory from source remote to destination remote
### sync/copy: copy a directory from source remote to destination remote {#sync/copy}
This takes the following parameters
@ -891,7 +891,7 @@ See the [copy command](/commands/rclone_copy/) command for more information on t
Authentication is required for this call.
### sync/move: move a directory from source remote to destination remote
### sync/move: move a directory from source remote to destination remote {#sync/move}
This takes the following parameters
@ -904,7 +904,7 @@ See the [move command](/commands/rclone_move/) command for more information on t
Authentication is required for this call.
### sync/sync: sync a directory from source remote to destination remote
### sync/sync: sync a directory from source remote to destination remote {#sync/sync}
This takes the following parameters
@ -916,7 +916,7 @@ See the [sync command](/commands/rclone_sync/) command for more information on t
Authentication is required for this call.
### vfs/forget: Forget files or directories in the directory cache.
### vfs/forget: Forget files or directories in the directory cache. {#vfs/forget}
This forgets the paths in the directory cache causing them to be
re-read from the remote when needed.
@ -932,7 +932,7 @@ starting with dir will forget that dir, eg
rclone rc vfs/forget file=hello file2=goodbye dir=home/junk
### vfs/poll-interval: Get the status or update the value of the poll-interval option.
### vfs/poll-interval: Get the status or update the value of the poll-interval option. {#vfs/poll-interval}
Without any parameter given this returns the current status of the
poll-interval setting.
@ -954,7 +954,7 @@ If poll-interval is updated or disabled temporarily, some changes
might not get picked up by the polling function, depending on the
used remote.
### vfs/refresh: Refresh the directory cache.
### vfs/refresh: Refresh the directory cache. {#vfs/refresh}
This reads the directories for the specified paths and freshens the
directory cache.