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

docs/compress: but a warning at the top

Browse Source
This commit is contained in:
buengese 2021-01-17 02:31:30 +01:00
parent 45b57822d5
commit a39a5d261c
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/content/compress.md
View File

@ -6,11 +6,14 @@ description: "Compression Remote"
{{< icon "fas fa-compress" >}}Compress (Experimental)
-----------------------------------------
### Warning
This remote is currently **experimental**. Things may break and data may be lost. Anything you do with this remote is
at your own risk. Please understand the risks associated with using experimental code and don't use this remote in
critical applications.
The `Compress` remote adds compression to another remote. It is best used with remotes containing
many large compressible files.
Please read the [warnings](#warnings) before using this remote.
To use this remote, all you need to do is specify another remote and a compression mode to use:
```
@ -80,11 +83,6 @@ correct metadata files will not be recognized by rclone.
The compressed files will be named `*.###########.gz` where `*` is the base file and the `#` part is base64 encoded
size of the uncompressed file. The file names should not be changed by anything other than the rclone compression backend.
#### Experimental
This remote is currently **experimental**. Things may break and data may be lost. Anything you do with this remote is
at your own risk. Please understand the risks associated with using experimental code and don't use this remote in
critical applications.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/compress/compress.go then run make backenddocs" >}}
### Standard Options