diff --git a/cmd/backend/backend.go b/cmd/backend/backend.go index 936e903c2..85b7e44bd 100644 --- a/cmd/backend/backend.go +++ b/cmd/backend/backend.go @@ -145,7 +145,7 @@ Run them with The help below will explain what arguments each command takes. -See [the "rclone backend" command](/commands/rclone_backend/) for more +See the [backend](/commands/rclone_backend/) command for more info on how to pass options and arguments. These can be run on a running backend using the rc command diff --git a/cmd/check/check.go b/cmd/check/check.go index ec58deb22..886c36a58 100644 --- a/cmd/check/check.go +++ b/cmd/check/check.go @@ -139,6 +139,10 @@ Checks the files in the source and destination match. It compares sizes and hashes (MD5 or SHA1) and logs a report of files that don't match. It doesn't alter the source or destination. +For the [crypt](/crypt/) remote there is a dedicated command, +[cryptcheck](/commands/rclone_cryptcheck/), that are able to check +the checksums of the crypted files. + If you supply the |--size-only| flag, it will only compare the sizes not the hashes as well. Use this for a quick check. diff --git a/cmd/copy/copy.go b/cmd/copy/copy.go index ba2815852..33175e1f7 100644 --- a/cmd/copy/copy.go +++ b/cmd/copy/copy.go @@ -28,13 +28,18 @@ var commandDefinition = &cobra.Command{ Long: strings.ReplaceAll(` Copy the source to the destination. Does not transfer files that are identical on source and destination, testing by size and modification -time or MD5SUM. Doesn't delete files from the destination. +time or MD5SUM. Doesn't delete files from the destination. If you +want to also delete files from destination, to make it match source, +use the [sync](/commands/rclone_sync/) command instead. Note that it is always the contents of the directory that is synced, -not the directory so when source:path is a directory, it's the +not the directory itself. So when source:path is a directory, it's the contents of source:path that are copied, not the directory name and contents. +To copy single files, use the [copyto](/commands/rclone_copyto/) +command instead. + If dest:path doesn't exist, it is created and the source:path contents go there. diff --git a/cmd/copyto/copyto.go b/cmd/copyto/copyto.go index ed6ff7b16..02d2af21e 100644 --- a/cmd/copyto/copyto.go +++ b/cmd/copyto/copyto.go @@ -21,8 +21,8 @@ If source:path is a file or directory then it copies it to a file or directory named dest:path. This can be used to upload single files to other than their current -name. If the source is a directory then it acts exactly like the copy -command. +name. If the source is a directory then it acts exactly like the +[copy](/commands/rclone_copy/) command. So diff --git a/cmd/cryptcheck/cryptcheck.go b/cmd/cryptcheck/cryptcheck.go index 7ef0e86a4..ec0597da7 100644 --- a/cmd/cryptcheck/cryptcheck.go +++ b/cmd/cryptcheck/cryptcheck.go @@ -23,9 +23,9 @@ var commandDefinition = &cobra.Command{ Use: "cryptcheck remote:path cryptedremote:path", Short: `Cryptcheck checks the integrity of a crypted remote.`, Long: ` -rclone cryptcheck checks a remote against a crypted remote. This is -the equivalent of running rclone check, but able to check the -checksums of the crypted remote. +rclone cryptcheck checks a remote against a [crypted](/crypt/) remote. +This is the equivalent of running rclone [check](/commands/rclone_check/), +but able to check the checksums of the crypted remote. For it to work the underlying remote of the cryptedremote must support some kind of checksum. diff --git a/cmd/cryptdecode/cryptdecode.go b/cmd/cryptdecode/cryptdecode.go index bdfd3e221..27ab93df1 100644 --- a/cmd/cryptdecode/cryptdecode.go +++ b/cmd/cryptdecode/cryptdecode.go @@ -38,7 +38,7 @@ use it like this rclone cryptdecode --reverse encryptedremote: filename1 filename2 Another way to accomplish this is by using the ` + "`rclone backend encode` (or `decode`)" + `command. -See the documentation on the ` + "`crypt`" + ` overlay for more info. +See the documentation on the [crypt](/crypt/) overlay for more info. `, Run: func(command *cobra.Command, args []string) { cmd.CheckArgs(2, 11, command, args) diff --git a/cmd/delete/delete.go b/cmd/delete/delete.go index 19816cb3a..a432dbe56 100644 --- a/cmd/delete/delete.go +++ b/cmd/delete/delete.go @@ -25,16 +25,16 @@ var commandDefinition = &cobra.Command{ Short: `Remove the files in path.`, // Warning! "|" will be replaced by backticks below Long: strings.ReplaceAll(` -Remove the files in path. Unlike |purge| it obeys include/exclude -filters so can be used to selectively delete files. +Remove the files in path. Unlike [purge](/commands/rclone_purge/) it +obeys include/exclude filters so can be used to selectively delete files. |rclone delete| only deletes files but leaves the directory structure alone. If you want to delete a directory and all of its contents use -the |purge| command. +the [purge](/commands/rclone_purge/) command. If you supply the |--rmdirs| flag, it will remove all empty directories along with it. -You can also use the separate command |rmdir| or |rmdirs| to -delete empty directories only. +You can also use the separate command [rmdir](/commands/rclone_rmdir/) or +[rmdirs](/commands/rclone_rmdirs/) to delete empty directories only. For example, to delete all files bigger than 100 MiB, you may first want to check what would be deleted (use either): diff --git a/cmd/hashsum/hashsum.go b/cmd/hashsum/hashsum.go index d2be8fe5f..64dfde4ce 100644 --- a/cmd/hashsum/hashsum.go +++ b/cmd/hashsum/hashsum.go @@ -93,6 +93,9 @@ not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling any hash for any remote. +For the MD5 and SHA1 algorithms there are also dedicated commands, +[md5sum](/commands/rclone_md5sum/) and [sha1sum](/commands/rclone_sha1sum/). + This command can also hash data received on standard input (stdin), by not passing a remote:path, or by passing a hyphen as remote:path when there is data to read (if not, the hypen will be treated literaly, diff --git a/cmd/md5sum/md5sum.go b/cmd/md5sum/md5sum.go index 4f85c8c93..665ae4467 100644 --- a/cmd/md5sum/md5sum.go +++ b/cmd/md5sum/md5sum.go @@ -28,6 +28,10 @@ not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling MD5 for any remote. +For other algorithms, see the [hashsum](/commands/rclone_hashsum/) +command. Running ` + "`rclone md5sum remote:path`" + ` is equivalent +to running ` + "`rclone hashsum MD5 remote:path`" + `. + This command can also hash data received on standard input (stdin), by not passing a remote:path, or by passing a hyphen as remote:path when there is data to read (if not, the hypen will be treated literaly, diff --git a/cmd/move/move.go b/cmd/move/move.go index 20ca46209..3d7f87167 100644 --- a/cmd/move/move.go +++ b/cmd/move/move.go @@ -33,6 +33,9 @@ Moves the contents of the source directory to the destination directory. Rclone will error if the source and destination overlap and the remote does not support a server-side directory move operation. +To move single files, use the [moveto](/commands/rclone_moveto/) +command instead. + If no filters are in use and if possible this will server-side move |source:path| into |dest:path|. After this |source:path| will no longer exist. @@ -43,7 +46,8 @@ move will be used, otherwise it will copy it (server-side if possible) into |dest:path| then delete the original (if no errors on copy) in |source:path|. -If you want to delete empty source directories after move, use the --delete-empty-src-dirs flag. +If you want to delete empty source directories after move, use the +|--delete-empty-src-dirs| flag. See the [--no-traverse](/docs/#no-traverse) option for controlling whether rclone lists the destination directory or not. Supplying this diff --git a/cmd/moveto/moveto.go b/cmd/moveto/moveto.go index 8390371db..8d81bb3d3 100644 --- a/cmd/moveto/moveto.go +++ b/cmd/moveto/moveto.go @@ -22,7 +22,7 @@ directory named dest:path. This can be used to rename files or upload single files to other than their existing name. If the source is a directory then it acts exactly -like the move command. +like the [move](/commands/rclone_move/) command. So diff --git a/cmd/ncdu/ncdu.go b/cmd/ncdu/ncdu.go index aea2501eb..7f63c8b04 100644 --- a/cmd/ncdu/ncdu.go +++ b/cmd/ncdu/ncdu.go @@ -69,6 +69,10 @@ but is useful as it stands. Note that it might take some time to delete big files/directories. The UI won't respond in the meantime since the deletion is done synchronously. + +For a non-interactive listing of the remote, see the +[tree](/commands/rclone_tree/) command. To just get the total size of +the remote you can also use the [size](/commands/rclone_size/) command. `, Run: func(command *cobra.Command, args []string) { cmd.CheckArgs(1, 1, command, args) diff --git a/cmd/purge/purge.go b/cmd/purge/purge.go index 137e3bd18..335615cf9 100644 --- a/cmd/purge/purge.go +++ b/cmd/purge/purge.go @@ -17,9 +17,10 @@ var commandDefinition = &cobra.Command{ Short: `Remove the path and all of its contents.`, Long: ` Remove the path and all of its contents. Note that this does not obey -include/exclude filters - everything will be removed. Use the ` + "`delete`" + ` -command if you want to selectively delete files. To delete empty directories only, -use command ` + "`rmdir`" + ` or ` + "`rmdirs`" + `. +include/exclude filters - everything will be removed. Use the +[delete](/commands/rclone_delete/) command if you want to selectively +delete files. To delete empty directories only, use command +[rmdir](/commands/rclone_rmdir/) or [rmdirs](/commands/rclone_rmdirs/). **Important**: Since this can cause data loss, test first with the ` + "`--dry-run` or the `--interactive`/`-i`" + ` flag. diff --git a/cmd/rmdir/rmdir.go b/cmd/rmdir/rmdir.go index 31b958a5b..9b532ca47 100644 --- a/cmd/rmdir/rmdir.go +++ b/cmd/rmdir/rmdir.go @@ -18,10 +18,10 @@ var commandDefinition = &cobra.Command{ Long: ` This removes empty directory given by path. Will not remove the path if it has any objects in it, not even empty subdirectories. Use -command ` + "`rmdirs`" + ` (or ` + "`delete`" + ` with option ` + "`--rmdirs`" + `) -to do that. +command [rmdirs](/commands/rclone_rmdirs/) (or [delete](/commands/rclone_delete/) +with option ` + "`--rmdirs`" + `) to do that. -To delete a path and any objects in it, use ` + "`purge`" + ` command. +To delete a path and any objects in it, use [purge](/commands/rclone_purge/) command. `, Run: func(command *cobra.Command, args []string) { cmd.CheckArgs(1, 1, command, args) diff --git a/cmd/rmdirs/rmdirs.go b/cmd/rmdirs/rmdirs.go index 4631dee85..41788c527 100644 --- a/cmd/rmdirs/rmdirs.go +++ b/cmd/rmdirs/rmdirs.go @@ -26,15 +26,16 @@ that only contain empty directories), that it finds under the path. The root path itself will also be removed if it is empty, unless you supply the ` + "`--leave-root`" + ` flag. -Use command ` + "`rmdir`" + ` to delete just the empty directory -given by path, not recurse. +Use command [rmdir](/commands/rclone_rmdir/) to delete just the empty +directory given by path, not recurse. This is useful for tidying up remotes that rclone has left a lot of -empty directories in. For example the ` + "`delete`" + ` command will -delete files but leave the directory structure (unless used with -option ` + "`--rmdirs`" + `). +empty directories in. For example the [delete](/commands/rclone_delete/) +command will delete files but leave the directory structure (unless +used with option ` + "`--rmdirs`" + `). -To delete a path and any objects in it, use ` + "`purge`" + ` command. +To delete a path and any objects in it, use [purge](/commands/rclone_purge/) +command. `, Run: func(command *cobra.Command, args []string) { cmd.CheckArgs(1, 1, command, args) diff --git a/cmd/serve/webdav/webdav.go b/cmd/serve/webdav/webdav.go index a618c6c06..89a76b230 100644 --- a/cmd/serve/webdav/webdav.go +++ b/cmd/serve/webdav/webdav.go @@ -59,9 +59,8 @@ based on the ModTime and Size of the object. If this flag is set to "auto" then rclone will choose the first supported hash on the backend or you can use a named hash such as -"MD5" or "SHA-1". - -Use "rclone hashsum" to see the full list. +"MD5" or "SHA-1". Use the [hashsum](/commands/rclone_hashsum/) command +to see the full list. ` + httplib.Help + vfs.Help + proxy.Help, RunE: func(command *cobra.Command, args []string) error { diff --git a/cmd/sha1sum/sha1sum.go b/cmd/sha1sum/sha1sum.go index 78a70de51..1c3115a8b 100644 --- a/cmd/sha1sum/sha1sum.go +++ b/cmd/sha1sum/sha1sum.go @@ -28,6 +28,10 @@ not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling SHA-1 for any remote. +For other algorithms, see the [hashsum](/commands/rclone_hashsum/) +command. Running ` + "`rclone sha1sum remote:path`" + ` is equivalent +to running ` + "`rclone hashsum SHA1 remote:path`" + `. + This command can also hash data received on standard input (stdin), by not passing a remote:path, or by passing a hyphen as remote:path when there is data to read (if not, the hypen will be treated literaly, diff --git a/cmd/sync/sync.go b/cmd/sync/sync.go index 2bb085073..c0c1885ba 100644 --- a/cmd/sync/sync.go +++ b/cmd/sync/sync.go @@ -28,7 +28,9 @@ Sync the source to the destination, changing the destination only. Doesn't transfer files that are identical on source and destination, testing by size and modification time or MD5SUM. Destination is updated to match source, including deleting files -if necessary (except duplicate objects, see below). +if necessary (except duplicate objects, see below). If you don't +want to delete files from destination, use the +[copy](/commands/rclone_copy/) command instead. **Important**: Since this can cause data loss, test first with the ` + "`--dry-run` or the `--interactive`/`-i`" + ` flag. @@ -42,7 +44,7 @@ those providers that support it) are also not yet handled. It is always the contents of the directory that is synced, not the directory itself. So when source:path is a directory, it's the contents of source:path that are copied, not the directory name and contents. See -extended explanation in the ` + "`" + `copy` + "`" + ` command above if unsure. +extended explanation in the [copy](/commands/rclone_copy/) command if unsure. If dest:path doesn't exist, it is created and the source:path contents go there. diff --git a/cmd/tree/tree.go b/cmd/tree/tree.go index 4986c4d70..4bd899462 100644 --- a/cmd/tree/tree.go +++ b/cmd/tree/tree.go @@ -84,11 +84,15 @@ For example 1 directories, 5 files You can use any of the filtering options with the tree command (e.g. ---include and --exclude). You can also use --fast-list. +` + "`--include` and `--exclude`" + `. You can also use ` + "`--fast-list`" + `. The tree command has many options for controlling the listing which -are compatible with the tree command. Note that not all of them have +are compatible with the tree command, for example you can include file +sizes with ` + "`--size`" + `. Note that not all of them have short options as they conflict with rclone's short options. + +For a more interactive navigation of the remote see the +[ncdu](/commands/rclone_ncdu/) command. `, RunE: func(command *cobra.Command, args []string) error { cmd.CheckArgs(1, 1, command, args) diff --git a/docs/content/rc.md b/docs/content/rc.md index be642bd62..8ea6b77d6 100644 --- a/docs/content/rc.md +++ b/docs/content/rc.md @@ -8,10 +8,10 @@ description: "Remote controlling rclone with its API" If rclone is run with the `--rc` flag then it starts an HTTP server which can be used to remote control rclone using its API. -You can either use the [rclone rc](#api-rc) command to access the API +You can either use the [rc](#api-rc) command to access the API or [use HTTP directly](#api-http). -If you just want to run a remote control then see the [rcd command](/commands/rclone_rcd/). +If you just want to run a remote control then see the [rcd](/commands/rclone_rcd/) command. ## Supported parameters @@ -544,8 +544,7 @@ This takes the following parameters: - state - state to restart with - used with continue - result - result to restart with - used with continue - -See the [config create command](/commands/rclone_config_create/) command for more information on the above. +See the [config create](/commands/rclone_config_create/) command for more information on the above. **Authentication is required for this call.** @@ -555,7 +554,7 @@ Parameters: - name - name of remote to delete -See the [config delete command](/commands/rclone_config_delete/) command for more information on the above. +See the [config delete](/commands/rclone_config_delete/) command for more information on the above. **Authentication is required for this call.** @@ -566,7 +565,7 @@ Returns a JSON object: Where keys are remote names and values are the config parameters. -See the [config dump command](/commands/rclone_config_dump/) command for more information on the above. +See the [config dump](/commands/rclone_config_dump/) command for more information on the above. **Authentication is required for this call.** @@ -576,7 +575,7 @@ Parameters: - 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](/commands/rclone_config_dump/) command for more information on the above. **Authentication is required for this call.** @@ -585,7 +584,7 @@ See the [config dump command](/commands/rclone_config_dump/) command for more in Returns - remotes - array of remote names -See the [listremotes command](/commands/rclone_listremotes/) command for more information on the above. +See the [listremotes](/commands/rclone_listremotes/) command for more information on the above. **Authentication is required for this call.** @@ -596,8 +595,7 @@ This takes the following parameters: - name - name of remote - parameters - a map of \{ "key": "value" \} pairs - -See the [config password command](/commands/rclone_config_password/) command for more information on the above. +See the [config password](/commands/rclone_config_password/) command for more information on the above. **Authentication is required for this call.** @@ -606,7 +604,7 @@ See the [config password command](/commands/rclone_config_password/) command for Returns a JSON object: - providers - array of objects -See the [config providers command](/commands/rclone_config_providers/) command for more information on the above. +See the [config providers](/commands/rclone_config_providers/) command for more information on the above. **Authentication is required for this call.** @@ -625,8 +623,7 @@ This takes the following parameters: - state - state to restart with - used with continue - result - result to restart with - used with continue - -See the [config update command](/commands/rclone_config_update/) command for more information on the above. +See the [config update](/commands/rclone_config_update/) command for more information on the above. **Authentication is required for this call.** @@ -1072,7 +1069,7 @@ This takes the following parameters: The result is as returned from rclone about --json -See the [about command](/commands/rclone_size/) command for more information on the above. +See the [about](/commands/rclone_size/) command for more information on the above. **Authentication is required for this call.** @@ -1082,7 +1079,7 @@ This takes the following parameters: - fs - a remote name string e.g. "drive:" -See the [cleanup command](/commands/rclone_cleanup/) command for more information on the above. +See the [cleanup](/commands/rclone_cleanup/) command for more information on the above. **Authentication is required for this call.** @@ -1104,8 +1101,9 @@ This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" - url - string, URL to read from - - autoFilename - boolean, set to true to retrieve destination file name from url -See the [copyurl command](/commands/rclone_copyurl/) command for more information on the above. +- autoFilename - boolean, set to true to retrieve destination file name from url + +See the [copyurl](/commands/rclone_copyurl/) command for more information on the above. **Authentication is required for this call.** @@ -1115,7 +1113,7 @@ This takes the following parameters: - fs - a remote name string e.g. "drive:" -See the [delete command](/commands/rclone_delete/) command for more information on the above. +See the [delete](/commands/rclone_delete/) command for more information on the above. **Authentication is required for this call.** @@ -1126,7 +1124,7 @@ This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" -See the [deletefile command](/commands/rclone_deletefile/) command for more information on the above. +See the [deletefile](/commands/rclone_deletefile/) command for more information on the above. **Authentication is required for this call.** @@ -1209,7 +1207,7 @@ Returns: - list - This is an array of objects as described in the lsjson command -See the [lsjson command](/commands/rclone_lsjson/) for more information on the above and examples. +See the [lsjson](/commands/rclone_lsjson/) for more information on the above and examples. **Authentication is required for this call.** @@ -1220,7 +1218,7 @@ This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" -See the [mkdir command](/commands/rclone_mkdir/) command for more information on the above. +See the [mkdir](/commands/rclone_mkdir/) command for more information on the above. **Authentication is required for this call.** @@ -1248,7 +1246,7 @@ Returns: - url - URL of the resource -See the [link command](/commands/rclone_link/) command for more information on the above. +See the [link](/commands/rclone_link/) command for more information on the above. **Authentication is required for this call.** @@ -1259,7 +1257,7 @@ This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" -See the [purge command](/commands/rclone_purge/) command for more information on the above. +See the [purge](/commands/rclone_purge/) command for more information on the above. **Authentication is required for this call.** @@ -1270,7 +1268,7 @@ This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" -See the [rmdir command](/commands/rclone_rmdir/) command for more information on the above. +See the [rmdir](/commands/rclone_rmdir/) command for more information on the above. **Authentication is required for this call.** @@ -1281,7 +1279,8 @@ This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" - leaveRoot - boolean, set to true not to delete the root -See the [rmdirs command](/commands/rclone_rmdirs/) command for more information on the above. + +See the [rmdirs](/commands/rclone_rmdirs/) command for more information on the above. **Authentication is required for this call.** @@ -1297,7 +1296,7 @@ Returns: - bytes - number of bytes in those files - sizeless - number of files with unknown size, included in count but not accounted for in bytes -See the [size command](/commands/rclone_size/) command for more information on the above. +See the [size](/commands/rclone_size/) command for more information on the above. **Authentication is required for this call.** @@ -1317,7 +1316,7 @@ The result is Note that if you are only interested in files then it is much more efficient to set the filesOnly flag in the options. -See the [lsjson command](/commands/rclone_lsjson/) for more information on the above and examples. +See the [lsjson](/commands/rclone_lsjson/) for more information on the above and examples. **Authentication is required for this call.** @@ -1328,7 +1327,8 @@ This takes the following parameters: - fs - a remote name string e.g. "drive:" - remote - a path within that remote e.g. "dir" - each part in body represents a file to be uploaded -See the [uploadfile command](/commands/rclone_uploadfile/) command for more information on the above. + +See the [uploadfile](/commands/rclone_uploadfile/) command for more information on the above. **Authentication is required for this call.** @@ -1542,8 +1542,7 @@ This takes the following parameters: - dstFs - a remote name string e.g. "drive:dst" for the destination - createEmptySrcDirs - create empty src directories on destination if set - -See the [copy command](/commands/rclone_copy/) command for more information on the above. +See the [copy](/commands/rclone_copy/) command for more information on the above. **Authentication is required for this call.** @@ -1556,8 +1555,7 @@ This takes the following parameters: - createEmptySrcDirs - create empty src directories on destination if set - deleteEmptySrcDirs - delete empty src directories if set - -See the [move command](/commands/rclone_move/) command for more information on the above. +See the [move](/commands/rclone_move/) command for more information on the above. **Authentication is required for this call.** @@ -1570,7 +1568,7 @@ This takes the following parameters: - createEmptySrcDirs - create empty src directories on destination if set -See the [sync command](/commands/rclone_sync/) command for more information on the above. +See the [sync](/commands/rclone_sync/) command for more information on the above. **Authentication is required for this call.** diff --git a/fs/config/rc.go b/fs/config/rc.go index db5d48cca..78f6d4866 100644 --- a/fs/config/rc.go +++ b/fs/config/rc.go @@ -20,7 +20,7 @@ Returns a JSON object: Where keys are remote names and values are the config parameters. -See the [config dump command](/commands/rclone_config_dump/) command for more information on the above. +See the [config dump](/commands/rclone_config_dump/) command for more information on the above. `, }) } @@ -41,7 +41,7 @@ Parameters: - 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](/commands/rclone_config_dump/) command for more information on the above. `, }) } @@ -65,7 +65,7 @@ func init() { Returns - remotes - array of remote names -See the [listremotes command](/commands/rclone_listremotes/) command for more information on the above. +See the [listremotes](/commands/rclone_listremotes/) command for more information on the above. `, }) } @@ -89,7 +89,7 @@ func init() { Returns a JSON object: - providers - array of objects -See the [config providers command](/commands/rclone_config_providers/) command for more information on the above. +See the [config providers](/commands/rclone_config_providers/) command for more information on the above. `, }) } @@ -133,7 +133,7 @@ func init() { - parameters - a map of \{ "key": "value" \} pairs ` + extraHelp + ` -See the [config ` + name + ` command](/commands/rclone_config_` + name + `/) command for more information on the above.`, +See the [config ` + name + `](/commands/rclone_config_` + name + `/) command for more information on the above.`, }) } } @@ -203,7 +203,7 @@ Parameters: - name - name of remote to delete -See the [config delete command](/commands/rclone_config_delete/) command for more information on the above. +See the [config delete](/commands/rclone_config_delete/) command for more information on the above. `, }) } diff --git a/fs/operations/rc.go b/fs/operations/rc.go index 848b56ca1..b8c59ce2d 100644 --- a/fs/operations/rc.go +++ b/fs/operations/rc.go @@ -41,7 +41,7 @@ Returns: - list - This is an array of objects as described in the lsjson command -See the [lsjson command](/commands/rclone_lsjson/) for more information on the above and examples. +See the [lsjson](/commands/rclone_lsjson/) command for more information on the above and examples. `, }) } @@ -90,7 +90,7 @@ The result is Note that if you are only interested in files then it is much more efficient to set the filesOnly flag in the options. -See the [lsjson command](/commands/rclone_lsjson/) for more information on the above and examples. +See the [lsjson](/commands/rclone_lsjson/) command for more information on the above and examples. `, }) } @@ -127,7 +127,7 @@ func init() { The result is as returned from rclone about --json -See the [about command](/commands/rclone_size/) command for more information on the above. +See the [about](/commands/rclone_about/) command for more information on the above. `, }) } @@ -202,11 +202,11 @@ func init() { {name: "mkdir", title: "Make a destination directory or container"}, {name: "rmdir", title: "Remove an empty directory or container"}, {name: "purge", title: "Remove a directory or container and all of its contents"}, - {name: "rmdirs", title: "Remove all the empty directories in the path", help: "- leaveRoot - boolean, set to true not to delete the root"}, + {name: "rmdirs", title: "Remove all the empty directories in the path", help: "- leaveRoot - boolean, set to true not to delete the root\n"}, {name: "delete", title: "Remove files in the path", noRemote: true}, {name: "deletefile", title: "Remove the single file pointed to"}, - {name: "copyurl", title: "Copy the URL to the object", help: "- url - string, URL to read from\n - autoFilename - boolean, set to true to retrieve destination file name from url"}, - {name: "uploadfile", title: "Upload file using multiform/form-data", help: "- each part in body represents a file to be uploaded", needsRequest: true}, + {name: "copyurl", title: "Copy the URL to the object", help: "- url - string, URL to read from\n - autoFilename - boolean, set to true to retrieve destination file name from url\n"}, + {name: "uploadfile", title: "Upload file using multiform/form-data", help: "- each part in body represents a file to be uploaded\n", needsRequest: true}, {name: "cleanup", title: "Remove trashed files in the remote or path", noRemote: true}, } { op := op @@ -226,7 +226,7 @@ func init() { - fs - a remote name string e.g. "drive:" ` + remote + op.help + ` -See the [` + op.name + ` command](/commands/rclone_` + op.name + `/) command for more information on the above. +See the [` + op.name + `](/commands/rclone_` + op.name + `/) command for more information on the above. `, }) } @@ -334,7 +334,7 @@ Returns: - count - number of files - bytes - number of bytes in those files -See the [size command](/commands/rclone_size/) command for more information on the above. +See the [size](/commands/rclone_size/) command for more information on the above. `, }) } @@ -373,7 +373,7 @@ Returns: - url - URL of the resource -See the [link command](/commands/rclone_link/) command for more information on the above. +See the [link](/commands/rclone_link/) command for more information on the above. `, }) } diff --git a/fs/sync/rc.go b/fs/sync/rc.go index 7dee9dea2..42ca315f6 100644 --- a/fs/sync/rc.go +++ b/fs/sync/rc.go @@ -27,7 +27,7 @@ func init() { - createEmptySrcDirs - create empty src directories on destination if set ` + moveHelp + ` -See the [` + name + ` command](/commands/rclone_` + name + `/) command for more information on the above.`, +See the [` + name + `](/commands/rclone_` + name + `/) command for more information on the above.`, }) } }