mirror of
https://github.com/rclone/rclone.git
synced 2025-12-12 06:24:14 +01:00
docs: consistent markdown list format
This commit is contained in:
albertony
@@ -27,70 +27,70 @@ option:
|
|||||||
|
|
||||||
See the following for detailed instructions for
|
See the following for detailed instructions for
|
||||||
|
|
||||||
* [1Fichier](/fichier/)
|
- [1Fichier](/fichier/)
|
||||||
* [Akamai Netstorage](/netstorage/)
|
- [Akamai Netstorage](/netstorage/)
|
||||||
* [Alias](/alias/)
|
- [Alias](/alias/)
|
||||||
* [Amazon S3](/s3/)
|
- [Amazon S3](/s3/)
|
||||||
* [Backblaze B2](/b2/)
|
- [Backblaze B2](/b2/)
|
||||||
* [Box](/box/)
|
- [Box](/box/)
|
||||||
* [Chunker](/chunker/) - transparently splits large files for other remotes
|
- [Chunker](/chunker/) - transparently splits large files for other remotes
|
||||||
* [Citrix ShareFile](/sharefile/)
|
- [Citrix ShareFile](/sharefile/)
|
||||||
* [Compress](/compress/)
|
- [Compress](/compress/)
|
||||||
* [Cloudinary](/cloudinary/)
|
- [Cloudinary](/cloudinary/)
|
||||||
* [Combine](/combine/)
|
- [Combine](/combine/)
|
||||||
* [Crypt](/crypt/) - to encrypt other remotes
|
- [Crypt](/crypt/) - to encrypt other remotes
|
||||||
* [DigitalOcean Spaces](/s3/#digitalocean-spaces)
|
- [DigitalOcean Spaces](/s3/#digitalocean-spaces)
|
||||||
* [Digi Storage](/koofr/#digi-storage)
|
- [Digi Storage](/koofr/#digi-storage)
|
||||||
* [Dropbox](/dropbox/)
|
- [Dropbox](/dropbox/)
|
||||||
* [Enterprise File Fabric](/filefabric/)
|
- [Enterprise File Fabric](/filefabric/)
|
||||||
* [FileLu Cloud Storage](/filelu/)
|
- [FileLu Cloud Storage](/filelu/)
|
||||||
* [Files.com](/filescom/)
|
- [Files.com](/filescom/)
|
||||||
* [FTP](/ftp/)
|
- [FTP](/ftp/)
|
||||||
* [Gofile](/gofile/)
|
- [Gofile](/gofile/)
|
||||||
* [Google Cloud Storage](/googlecloudstorage/)
|
- [Google Cloud Storage](/googlecloudstorage/)
|
||||||
* [Google Drive](/drive/)
|
- [Google Drive](/drive/)
|
||||||
* [Google Photos](/googlephotos/)
|
- [Google Photos](/googlephotos/)
|
||||||
* [Hasher](/hasher/) - to handle checksums for other remotes
|
- [Hasher](/hasher/) - to handle checksums for other remotes
|
||||||
* [HDFS](/hdfs/)
|
- [HDFS](/hdfs/)
|
||||||
* [Hetzner Storage Box](/sftp/#hetzner-storage-box)
|
- [Hetzner Storage Box](/sftp/#hetzner-storage-box)
|
||||||
* [HiDrive](/hidrive/)
|
- [HiDrive](/hidrive/)
|
||||||
* [HTTP](/http/)
|
- [HTTP](/http/)
|
||||||
* [iCloud Drive](/iclouddrive/)
|
- [iCloud Drive](/iclouddrive/)
|
||||||
* [Internet Archive](/internetarchive/)
|
- [Internet Archive](/internetarchive/)
|
||||||
* [Jottacloud](/jottacloud/)
|
- [Jottacloud](/jottacloud/)
|
||||||
* [Koofr](/koofr/)
|
- [Koofr](/koofr/)
|
||||||
* [Linkbox](/linkbox/)
|
- [Linkbox](/linkbox/)
|
||||||
* [Mail.ru Cloud](/mailru/)
|
- [Mail.ru Cloud](/mailru/)
|
||||||
* [Mega](/mega/)
|
- [Mega](/mega/)
|
||||||
* [Memory](/memory/)
|
- [Memory](/memory/)
|
||||||
* [Microsoft Azure Blob Storage](/azureblob/)
|
- [Microsoft Azure Blob Storage](/azureblob/)
|
||||||
* [Microsoft Azure Files Storage](/azurefiles/)
|
- [Microsoft Azure Files Storage](/azurefiles/)
|
||||||
* [Microsoft OneDrive](/onedrive/)
|
- [Microsoft OneDrive](/onedrive/)
|
||||||
* [OpenStack Swift / Rackspace Cloudfiles / Blomp Cloud Storage / Memset Memstore](/swift/)
|
- [OpenStack Swift / Rackspace Cloudfiles / Blomp Cloud Storage / Memset Memstore](/swift/)
|
||||||
* [OpenDrive](/opendrive/)
|
- [OpenDrive](/opendrive/)
|
||||||
* [Oracle Object Storage](/oracleobjectstorage/)
|
- [Oracle Object Storage](/oracleobjectstorage/)
|
||||||
* [Pcloud](/pcloud/)
|
- [Pcloud](/pcloud/)
|
||||||
* [PikPak](/pikpak/)
|
- [PikPak](/pikpak/)
|
||||||
* [Pixeldrain](/pixeldrain/)
|
- [Pixeldrain](/pixeldrain/)
|
||||||
* [premiumize.me](/premiumizeme/)
|
- [premiumize.me](/premiumizeme/)
|
||||||
* [put.io](/putio/)
|
- [put.io](/putio/)
|
||||||
* [Proton Drive](/protondrive/)
|
- [Proton Drive](/protondrive/)
|
||||||
* [QingStor](/qingstor/)
|
- [QingStor](/qingstor/)
|
||||||
* [Quatrix by Maytech](/quatrix/)
|
- [Quatrix by Maytech](/quatrix/)
|
||||||
* [rsync.net](/sftp/#rsync-net)
|
- [rsync.net](/sftp/#rsync-net)
|
||||||
* [Seafile](/seafile/)
|
- [Seafile](/seafile/)
|
||||||
* [SFTP](/sftp/)
|
- [SFTP](/sftp/)
|
||||||
* [Sia](/sia/)
|
- [Sia](/sia/)
|
||||||
* [SMB](/smb/)
|
- [SMB](/smb/)
|
||||||
* [Storj](/storj/)
|
- [Storj](/storj/)
|
||||||
* [SugarSync](/sugarsync/)
|
- [SugarSync](/sugarsync/)
|
||||||
* [Union](/union/)
|
- [Union](/union/)
|
||||||
* [Uloz.to](/ulozto/)
|
- [Uloz.to](/ulozto/)
|
||||||
* [Uptobox](/uptobox/)
|
- [Uptobox](/uptobox/)
|
||||||
* [WebDAV](/webdav/)
|
- [WebDAV](/webdav/)
|
||||||
* [Yandex Disk](/yandex/)
|
- [Yandex Disk](/yandex/)
|
||||||
* [Zoho WorkDrive](/zoho/)
|
- [Zoho WorkDrive](/zoho/)
|
||||||
* [The local filesystem](/local/)
|
- [The local filesystem](/local/)
|
||||||
|
|
||||||
Basic syntax
|
Basic syntax
|
||||||
-----
|
-----
|
||||||
@@ -138,37 +138,37 @@ rclone uses a system of subcommands. For example
|
|||||||
|
|
||||||
The main rclone commands with most used first
|
The main rclone commands with most used first
|
||||||
|
|
||||||
* [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.
|
- [rclone config](/commands/rclone_config/) - Enter an interactive configuration session.
|
||||||
* [rclone copy](/commands/rclone_copy/) - Copy files from source to dest, skipping already copied.
|
- [rclone copy](/commands/rclone_copy/) - Copy files from source to dest, skipping already copied.
|
||||||
* [rclone sync](/commands/rclone_sync/) - Make source and dest identical, modifying destination only.
|
- [rclone sync](/commands/rclone_sync/) - Make source and dest identical, modifying destination only.
|
||||||
* [rclone bisync](/commands/rclone_bisync/) - [Bidirectional synchronization](/bisync/) between two paths.
|
- [rclone bisync](/commands/rclone_bisync/) - [Bidirectional synchronization](/bisync/) between two paths.
|
||||||
* [rclone move](/commands/rclone_move/) - Move files from source to dest.
|
- [rclone move](/commands/rclone_move/) - Move files from source to dest.
|
||||||
* [rclone delete](/commands/rclone_delete/) - Remove the contents of path.
|
- [rclone delete](/commands/rclone_delete/) - Remove the contents of path.
|
||||||
* [rclone purge](/commands/rclone_purge/) - Remove the path and all of its contents.
|
- [rclone purge](/commands/rclone_purge/) - Remove the path and all of its contents.
|
||||||
* [rclone mkdir](/commands/rclone_mkdir/) - Make the path if it doesn't already exist.
|
- [rclone mkdir](/commands/rclone_mkdir/) - Make the path if it doesn't already exist.
|
||||||
* [rclone rmdir](/commands/rclone_rmdir/) - Remove the path.
|
- [rclone rmdir](/commands/rclone_rmdir/) - Remove the path.
|
||||||
* [rclone rmdirs](/commands/rclone_rmdirs/) - Remove any empty directories under the path.
|
- [rclone rmdirs](/commands/rclone_rmdirs/) - Remove any empty directories under the path.
|
||||||
* [rclone check](/commands/rclone_check/) - Check if the files in the source and destination match.
|
- [rclone check](/commands/rclone_check/) - Check if the files in the source and destination match.
|
||||||
* [rclone ls](/commands/rclone_ls/) - List all the objects in the path with size and path.
|
- [rclone ls](/commands/rclone_ls/) - List all the objects in the path with size and path.
|
||||||
* [rclone lsd](/commands/rclone_lsd/) - List all directories/containers/buckets in the path.
|
- [rclone lsd](/commands/rclone_lsd/) - List all directories/containers/buckets in the path.
|
||||||
* [rclone lsl](/commands/rclone_lsl/) - List all the objects in the path with size, modification time and path.
|
- [rclone lsl](/commands/rclone_lsl/) - List all the objects in the path with size, modification time and path.
|
||||||
* [rclone md5sum](/commands/rclone_md5sum/) - Produce an md5sum file for all the objects in the path.
|
- [rclone md5sum](/commands/rclone_md5sum/) - Produce an md5sum file for all the objects in the path.
|
||||||
* [rclone sha1sum](/commands/rclone_sha1sum/) - Produce a sha1sum file for all the objects in the path.
|
- [rclone sha1sum](/commands/rclone_sha1sum/) - Produce a sha1sum file for all the objects in the path.
|
||||||
* [rclone size](/commands/rclone_size/) - Return the total size and number of objects in remote:path.
|
- [rclone size](/commands/rclone_size/) - Return the total size and number of objects in remote:path.
|
||||||
* [rclone version](/commands/rclone_version/) - Show the version number.
|
- [rclone version](/commands/rclone_version/) - Show the version number.
|
||||||
* [rclone cleanup](/commands/rclone_cleanup/) - Clean up the remote if possible.
|
- [rclone cleanup](/commands/rclone_cleanup/) - Clean up the remote if possible.
|
||||||
* [rclone dedupe](/commands/rclone_dedupe/) - Interactively find duplicate files and delete/rename them.
|
- [rclone dedupe](/commands/rclone_dedupe/) - Interactively find duplicate files and delete/rename them.
|
||||||
* [rclone authorize](/commands/rclone_authorize/) - Remote authorization.
|
- [rclone authorize](/commands/rclone_authorize/) - Remote authorization.
|
||||||
* [rclone cat](/commands/rclone_cat/) - Concatenate any files and send them to stdout.
|
- [rclone cat](/commands/rclone_cat/) - Concatenate any files and send them to stdout.
|
||||||
* [rclone copyto](/commands/rclone_copyto/) - Copy files from source to dest, skipping already copied.
|
- [rclone copyto](/commands/rclone_copyto/) - Copy files from source to dest, skipping already copied.
|
||||||
* [rclone completion](/commands/rclone_completion/) - Output shell completion scripts for rclone.
|
- [rclone completion](/commands/rclone_completion/) - Output shell completion scripts for rclone.
|
||||||
* [rclone gendocs](/commands/rclone_gendocs/) - Output markdown docs for rclone to the directory supplied.
|
- [rclone gendocs](/commands/rclone_gendocs/) - Output markdown docs for rclone to the directory supplied.
|
||||||
* [rclone listremotes](/commands/rclone_listremotes/) - List all the remotes in the config file.
|
- [rclone listremotes](/commands/rclone_listremotes/) - List all the remotes in the config file.
|
||||||
* [rclone mount](/commands/rclone_mount/) - Mount the remote as a mountpoint.
|
- [rclone mount](/commands/rclone_mount/) - Mount the remote as a mountpoint.
|
||||||
* [rclone moveto](/commands/rclone_moveto/) - Move file or directory from source to dest.
|
- [rclone moveto](/commands/rclone_moveto/) - Move file or directory from source to dest.
|
||||||
* [rclone obscure](/commands/rclone_obscure/) - Obscure password for use in the rclone.conf
|
- [rclone obscure](/commands/rclone_obscure/) - Obscure password for use in the rclone.conf
|
||||||
* [rclone cryptcheck](/commands/rclone_cryptcheck/) - Check the integrity of an encrypted remote.
|
- [rclone cryptcheck](/commands/rclone_cryptcheck/) - Check the integrity of an encrypted remote.
|
||||||
* [rclone about](/commands/rclone_about/) - Get quota information from the remote.
|
- [rclone about](/commands/rclone_about/) - Get quota information from the remote.
|
||||||
|
|
||||||
See the [commands index](/commands/) for the full list.
|
See the [commands index](/commands/) for the full list.
|
||||||
|
|
||||||
@@ -368,9 +368,9 @@ Will get their own names
|
|||||||
### Valid remote names
|
### Valid remote names
|
||||||
|
|
||||||
Remote names are case sensitive, and must adhere to the following rules:
|
Remote names are case sensitive, and must adhere to the following rules:
|
||||||
- May contain number, letter, `_`, `-`, `.`, `+`, `@` and space.
|
- May contain number, letter, `_`, `-`, `.`, `+`, `@` and space.
|
||||||
- May not start with `-` or space.
|
- May not start with `-` or space.
|
||||||
- May not end with space.
|
- May not end with space.
|
||||||
|
|
||||||
Starting with rclone version 1.61, any Unicode numbers and letters are allowed,
|
Starting with rclone version 1.61, any Unicode numbers and letters are allowed,
|
||||||
while in older versions it was limited to plain ASCII (0-9, A-Z, a-z). If you use
|
while in older versions it was limited to plain ASCII (0-9, A-Z, a-z). If you use
|
||||||
@@ -660,14 +660,14 @@ the string only contains a single number, then the unit suffix is optional
|
|||||||
and will default to seconds, i.e. a plain decimal value will be treated
|
and will default to seconds, i.e. a plain decimal value will be treated
|
||||||
as a number of seconds. The following suffixes are valid:
|
as a number of seconds. The following suffixes are valid:
|
||||||
|
|
||||||
* `ms` - Milliseconds
|
- `ms` - Milliseconds
|
||||||
* `s` - Seconds
|
- `s` - Seconds
|
||||||
* `m` - Minutes
|
- `m` - Minutes
|
||||||
* `h` - Hours
|
- `h` - Hours
|
||||||
* `d` - Days
|
- `d` - Days
|
||||||
* `w` - Weeks
|
- `w` - Weeks
|
||||||
* `M` - Months
|
- `M` - Months
|
||||||
* `y` - Years
|
- `y` - Years
|
||||||
|
|
||||||
Examples: "10", "300ms", "-1.5h" or "2h45m".
|
Examples: "10", "300ms", "-1.5h" or "2h45m".
|
||||||
|
|
||||||
@@ -965,17 +965,17 @@ The exact default is a bit complex to describe, due to changes
|
|||||||
introduced through different versions of rclone while preserving
|
introduced through different versions of rclone while preserving
|
||||||
backwards compatibility, but in most cases it is as simple as:
|
backwards compatibility, but in most cases it is as simple as:
|
||||||
|
|
||||||
- `%APPDATA%/rclone/rclone.conf` on Windows
|
- `%APPDATA%/rclone/rclone.conf` on Windows
|
||||||
- `~/.config/rclone/rclone.conf` on other
|
- `~/.config/rclone/rclone.conf` on other
|
||||||
|
|
||||||
The complete logic is as follows: Rclone will look for an existing
|
The complete logic is as follows: Rclone will look for an existing
|
||||||
configuration file in any of the following locations, in priority order:
|
configuration file in any of the following locations, in priority order:
|
||||||
|
|
||||||
1. `rclone.conf` (in program directory, where rclone executable is)
|
1. `rclone.conf` (in program directory, where rclone executable is)
|
||||||
2. `%APPDATA%/rclone/rclone.conf` (only on Windows)
|
2. `%APPDATA%/rclone/rclone.conf` (only on Windows)
|
||||||
3. `$XDG_CONFIG_HOME/rclone/rclone.conf` (on all systems, including Windows)
|
3. `$XDG_CONFIG_HOME/rclone/rclone.conf` (on all systems, including Windows)
|
||||||
4. `~/.config/rclone/rclone.conf` (see below for explanation of ~ symbol)
|
4. `~/.config/rclone/rclone.conf` (see below for explanation of ~ symbol)
|
||||||
5. `~/.rclone.conf`
|
5. `~/.rclone.conf`
|
||||||
|
|
||||||
If no existing configuration file is found, then a new one will be created
|
If no existing configuration file is found, then a new one will be created
|
||||||
in the following location:
|
in the following location:
|
||||||
@@ -991,9 +991,9 @@ in the following location:
|
|||||||
The `~` symbol in paths above represent the home directory of the current user
|
The `~` symbol in paths above represent the home directory of the current user
|
||||||
on any OS, and the value is defined as following:
|
on any OS, and the value is defined as following:
|
||||||
|
|
||||||
- On Windows: `%HOME%` if defined, else `%USERPROFILE%`, or else `%HOMEDRIVE%\%HOMEPATH%`.
|
- On Windows: `%HOME%` if defined, else `%USERPROFILE%`, or else `%HOMEDRIVE%\%HOMEPATH%`.
|
||||||
- On Unix: `$HOME` if defined, else by looking up current user in OS-specific user database
|
- On Unix: `$HOME` if defined, else by looking up current user in OS-specific user database
|
||||||
(e.g. passwd file), or else use the result from shell command `cd && pwd`.
|
(e.g. passwd file), or else use the result from shell command `cd && pwd`.
|
||||||
|
|
||||||
If you run `rclone config file` you will see where the default location is for
|
If you run `rclone config file` you will see where the default location is for
|
||||||
you. Running `rclone config touch` will ensure a configuration file exists,
|
you. Running `rclone config touch` will ensure a configuration file exists,
|
||||||
@@ -2995,38 +2995,38 @@ Filtering
|
|||||||
|
|
||||||
For the filtering options
|
For the filtering options
|
||||||
|
|
||||||
* `--delete-excluded`
|
- `--delete-excluded`
|
||||||
* `--filter`
|
- `--filter`
|
||||||
* `--filter-from`
|
- `--filter-from`
|
||||||
* `--exclude`
|
- `--exclude`
|
||||||
* `--exclude-from`
|
- `--exclude-from`
|
||||||
* `--exclude-if-present`
|
- `--exclude-if-present`
|
||||||
* `--include`
|
- `--include`
|
||||||
* `--include-from`
|
- `--include-from`
|
||||||
* `--files-from`
|
- `--files-from`
|
||||||
* `--files-from-raw`
|
- `--files-from-raw`
|
||||||
* `--min-size`
|
- `--min-size`
|
||||||
* `--max-size`
|
- `--max-size`
|
||||||
* `--min-age`
|
- `--min-age`
|
||||||
* `--max-age`
|
- `--max-age`
|
||||||
* `--hash-filter`
|
- `--hash-filter`
|
||||||
* `--dump filters`
|
- `--dump filters`
|
||||||
* `--metadata-include`
|
- `--metadata-include`
|
||||||
* `--metadata-include-from`
|
- `--metadata-include-from`
|
||||||
* `--metadata-exclude`
|
- `--metadata-exclude`
|
||||||
* `--metadata-exclude-from`
|
- `--metadata-exclude-from`
|
||||||
* `--metadata-filter`
|
- `--metadata-filter`
|
||||||
* `--metadata-filter-from`
|
- `--metadata-filter-from`
|
||||||
|
|
||||||
See the [filtering section](/filtering/).
|
See the [filtering section](/filtering/).
|
||||||
|
|
||||||
Remote control
|
Remote control
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
For the remote control options and for instructions on how to remote control rclone
|
For the remote control options and for instructions on how to remote control rclone:
|
||||||
|
|
||||||
* `--rc`
|
- `--rc`
|
||||||
* and anything starting with `--rc-`
|
- Anything starting with `--rc-`
|
||||||
|
|
||||||
See [the remote control section](/rc/).
|
See [the remote control section](/rc/).
|
||||||
|
|
||||||
@@ -3093,17 +3093,17 @@ messages may not be valid after the retry. If rclone has done a retry
|
|||||||
it will log a high priority message if the retry was successful.
|
it will log a high priority message if the retry was successful.
|
||||||
|
|
||||||
### List of exit codes
|
### List of exit codes
|
||||||
* `0` - Success
|
- `0` - Success
|
||||||
* `1` - Error not otherwise categorised
|
- `1` - Error not otherwise categorised
|
||||||
* `2` - Syntax or usage error
|
- `2` - Syntax or usage error
|
||||||
* `3` - Directory not found
|
- `3` - Directory not found
|
||||||
* `4` - File not found
|
- `4` - File not found
|
||||||
* `5` - Temporary error (one that more retries might fix) (Retry errors)
|
- `5` - Temporary error (one that more retries might fix) (Retry errors)
|
||||||
* `6` - Less serious errors (like 461 errors from dropbox) (NoRetry errors)
|
- `6` - Less serious errors (like 461 errors from dropbox) (NoRetry errors)
|
||||||
* `7` - Fatal error (one that more retries won't fix, like account suspended) (Fatal errors)
|
- `7` - Fatal error (one that more retries won't fix, like account suspended) (Fatal errors)
|
||||||
* `8` - Transfer exceeded - limit set by --max-transfer reached
|
- `8` - Transfer exceeded - limit set by --max-transfer reached
|
||||||
* `9` - Operation successful, but no files transferred (Requires [`--error-on-no-transfer`](#error-on-no-transfer))
|
- `9` - Operation successful, but no files transferred (Requires [`--error-on-no-transfer`](#error-on-no-transfer))
|
||||||
* `10` - Duration exceeded - limit set by --max-duration reached
|
- `10` - Duration exceeded - limit set by --max-duration reached
|
||||||
|
|
||||||
Environment Variables
|
Environment Variables
|
||||||
---------------------
|
---------------------
|
||||||
|
|||||||
Reference in New Issue
Block a user