mirror of
https://github.com/rclone/rclone.git
synced 2024-11-26 02:14:42 +01:00
rc: fix formatting of docs
This commit is contained in:
parent
378a3f4133
commit
1868c77e16
@ -340,6 +340,7 @@ Authentication is required for this call.
|
|||||||
### config/get: Get a remote in the config file. {#config/get}
|
### config/get: Get a remote in the config file. {#config/get}
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- name - name of remote to get
|
- name - name of remote to get
|
||||||
|
|
||||||
See the [config dump command](/commands/rclone_config_dump/) command for more information on the above.
|
See the [config dump command](/commands/rclone_config_dump/) command for more information on the above.
|
||||||
@ -482,6 +483,7 @@ If group is not provided then summed up stats for all groups will be
|
|||||||
returned.
|
returned.
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
|
|
||||||
- group - name of the stats group (string)
|
- group - name of the stats group (string)
|
||||||
|
|
||||||
Returns the following values:
|
Returns the following values:
|
||||||
@ -523,8 +525,8 @@ This clears counters and errors for all stats or specific stats group if group
|
|||||||
is provided.
|
is provided.
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
|
|
||||||
- group - name of the stats group (string)
|
- group - name of the stats group (string)
|
||||||
```
|
|
||||||
|
|
||||||
### core/transferred: Returns stats about completed transfers. {#core/transferred}
|
### core/transferred: Returns stats about completed transfers. {#core/transferred}
|
||||||
|
|
||||||
@ -538,6 +540,7 @@ returned.
|
|||||||
Note only the last 100 completed transfers are returned.
|
Note only the last 100 completed transfers are returned.
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
|
|
||||||
- group - name of the stats group (string)
|
- group - name of the stats group (string)
|
||||||
|
|
||||||
Returns the following values:
|
Returns the following values:
|
||||||
@ -561,6 +564,7 @@ Returns the following values:
|
|||||||
### core/version: Shows the current version of rclone and the go runtime. {#core/version}
|
### 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
|
This shows the current version of go and the go runtime
|
||||||
|
|
||||||
- version - rclone version, eg "v1.44"
|
- version - rclone version, eg "v1.44"
|
||||||
- decomposed - version number as [major, minor, patch, subpatch]
|
- decomposed - version number as [major, minor, patch, subpatch]
|
||||||
- note patch and subpatch will be 999 for a git compiled version
|
- note patch and subpatch will be 999 for a git compiled version
|
||||||
@ -574,14 +578,17 @@ This shows the current version of go and the go runtime
|
|||||||
Parameters - None
|
Parameters - None
|
||||||
|
|
||||||
Results
|
Results
|
||||||
|
|
||||||
- jobids - array of integer job ids
|
- jobids - array of integer job ids
|
||||||
|
|
||||||
### job/status: Reads the status of the job ID {#job/status}
|
### job/status: Reads the status of the job ID {#job/status}
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
|
|
||||||
- jobid - id of the job (integer)
|
- jobid - id of the job (integer)
|
||||||
|
|
||||||
Results
|
Results
|
||||||
|
|
||||||
- finished - boolean
|
- finished - boolean
|
||||||
- duration - time in seconds that the job ran for
|
- duration - time in seconds that the job ran for
|
||||||
- endTime - time the job finished (eg "2018-10-26T18:50:20.528746884+01:00")
|
- endTime - time the job finished (eg "2018-10-26T18:50:20.528746884+01:00")
|
||||||
@ -596,6 +603,7 @@ Results
|
|||||||
### job/stop: Stop the running job {#job/stop}
|
### job/stop: Stop the running job {#job/stop}
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
|
|
||||||
- jobid - id of the job (integer)
|
- jobid - id of the job (integer)
|
||||||
|
|
||||||
### operations/about: Return the space used on the remote {#operations/about}
|
### operations/about: Return the space used on the remote {#operations/about}
|
||||||
|
@ -88,6 +88,7 @@ If group is not provided then summed up stats for all groups will be
|
|||||||
returned.
|
returned.
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
|
|
||||||
- group - name of the stats group (string)
|
- group - name of the stats group (string)
|
||||||
|
|
||||||
Returns the following values:
|
Returns the following values:
|
||||||
@ -140,6 +141,7 @@ returned.
|
|||||||
Note only the last 100 completed transfers are returned.
|
Note only the last 100 completed transfers are returned.
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
|
|
||||||
- group - name of the stats group (string)
|
- group - name of the stats group (string)
|
||||||
|
|
||||||
Returns the following values:
|
Returns the following values:
|
||||||
@ -192,8 +194,8 @@ This clears counters and errors for all stats or specific stats group if group
|
|||||||
is provided.
|
is provided.
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
|
|
||||||
- group - name of the stats group (string)
|
- group - name of the stats group (string)
|
||||||
` + "```" + `
|
|
||||||
`,
|
`,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
@ -37,6 +37,7 @@ func init() {
|
|||||||
AuthRequired: true,
|
AuthRequired: true,
|
||||||
Help: `
|
Help: `
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- name - name of remote to get
|
- name - name of remote to get
|
||||||
|
|
||||||
See the [config dump command](/commands/rclone_config_dump/) command for more information on the above.
|
See the [config dump command](/commands/rclone_config_dump/) command for more information on the above.
|
||||||
|
@ -168,6 +168,7 @@ func init() {
|
|||||||
Title: "Shows the current version of rclone and the go runtime.",
|
Title: "Shows the current version of rclone and the go runtime.",
|
||||||
Help: `
|
Help: `
|
||||||
This shows the current version of go and the go runtime
|
This shows the current version of go and the go runtime
|
||||||
|
|
||||||
- version - rclone version, eg "v1.44"
|
- version - rclone version, eg "v1.44"
|
||||||
- decomposed - version number as [major, minor, patch, subpatch]
|
- decomposed - version number as [major, minor, patch, subpatch]
|
||||||
- note patch and subpatch will be 999 for a git compiled version
|
- note patch and subpatch will be 999 for a git compiled version
|
||||||
|
@ -237,9 +237,11 @@ func init() {
|
|||||||
Fn: rcJobStatus,
|
Fn: rcJobStatus,
|
||||||
Title: "Reads the status of the job ID",
|
Title: "Reads the status of the job ID",
|
||||||
Help: `Parameters
|
Help: `Parameters
|
||||||
|
|
||||||
- jobid - id of the job (integer)
|
- jobid - id of the job (integer)
|
||||||
|
|
||||||
Results
|
Results
|
||||||
|
|
||||||
- finished - boolean
|
- finished - boolean
|
||||||
- duration - time in seconds that the job ran for
|
- duration - time in seconds that the job ran for
|
||||||
- endTime - time the job finished (eg "2018-10-26T18:50:20.528746884+01:00")
|
- endTime - time the job finished (eg "2018-10-26T18:50:20.528746884+01:00")
|
||||||
@ -282,6 +284,7 @@ func init() {
|
|||||||
Help: `Parameters - None
|
Help: `Parameters - None
|
||||||
|
|
||||||
Results
|
Results
|
||||||
|
|
||||||
- jobids - array of integer job ids
|
- jobids - array of integer job ids
|
||||||
`,
|
`,
|
||||||
})
|
})
|
||||||
@ -300,6 +303,7 @@ func init() {
|
|||||||
Fn: rcJobStop,
|
Fn: rcJobStop,
|
||||||
Title: "Stop the running job",
|
Title: "Stop the running job",
|
||||||
Help: `Parameters
|
Help: `Parameters
|
||||||
|
|
||||||
- jobid - id of the job (integer)
|
- jobid - id of the job (integer)
|
||||||
`,
|
`,
|
||||||
})
|
})
|
||||||
|
Loading…
Reference in New Issue
Block a user