johanels/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-12-12 06:24:14 +01:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

docs: fix markdownlint issue md003/heading-style

Browse Source
This commit is contained in:
albertony
2025-07-10 15:20:41 +02:00
parent a8605abd34
commit 0bb4d0a985
9 changed files with 57 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@@ -166,7 +166,7 @@ git rebase master
If you rebase commits that have been pushed to GitHub, then you will have to If you rebase commits that have been pushed to GitHub, then you will have to
[replace your previously pushed commits](#replacing-your-previously-pushed-commits). [replace your previously pushed commits](#replacing-your-previously-pushed-commits).
### Squashing your commits ### ### Squashing your commits
To combine your commits into one commit: To combine your commits into one commit:

16
MAINTAINERS.md
View File

@@ -1,4 +1,4 @@
# Maintainers guide for rclone # # Maintainers guide for rclone
Current active maintainers of rclone are: Current active maintainers of rclone are:
@@ -29,7 +29,7 @@ Current active maintainers of rclone are:
This is a guide for how to be an rclone maintainer. This is mostly a write-up This is a guide for how to be an rclone maintainer. This is mostly a write-up
of what I (@ncw) attempt to do. of what I (@ncw) attempt to do.
## Triaging Tickets ## ## Triaging Tickets
When a ticket comes in it should be triaged. This means it should be classified When a ticket comes in it should be triaged. This means it should be classified
by adding labels and placed into a milestone. Quite a lot of tickets need a bit by adding labels and placed into a milestone. Quite a lot of tickets need a bit
@@ -79,12 +79,12 @@ Tickets [with no milestone](https://github.com/rclone/rclone/issues?utf8=✓&q=i
are good candidates for ones that have slipped between the gaps and need are good candidates for ones that have slipped between the gaps and need
following up. following up.
## Closing Tickets ## ## Closing Tickets
Close tickets as soon as you can - make sure they are tagged with a release. Close tickets as soon as you can - make sure they are tagged with a release.
Post a link to a beta in the ticket with the fix in, asking for feedback. Post a link to a beta in the ticket with the fix in, asking for feedback.
## Pull requests ## ## Pull requests
Try to process pull requests promptly! Try to process pull requests promptly!
@@ -98,12 +98,12 @@ After merging the commit, in your local master branch, do `git pull` then run
Sometimes pull requests need to be left open for a while - this especially true Sometimes pull requests need to be left open for a while - this especially true
of contributions of new backends which take a long time to get right. of contributions of new backends which take a long time to get right.
## Merges ## ## Merges
If you are merging a branch locally then do `git merge --ff-only branch-name` to If you are merging a branch locally then do `git merge --ff-only branch-name` to
avoid a merge commit. You'll need to rebase the branch if it doesn't merge cleanly. avoid a merge commit. You'll need to rebase the branch if it doesn't merge cleanly.
## Release cycle ## ## Release cycle
Rclone aims for a 6-8 week release cycle. Sometimes release cycles take longer Rclone aims for a 6-8 week release cycle. Sometimes release cycles take longer
if there is something big to merge that didn't stabilize properly or for personal if there is something big to merge that didn't stabilize properly or for personal
@@ -121,11 +121,11 @@ Follow the instructions in RELEASE.md for making the release. Note that the
testing part is the most time-consuming often needing several rounds of test testing part is the most time-consuming often needing several rounds of test
and fix depending on exactly how many new features rclone has gained. and fix depending on exactly how many new features rclone has gained.
## Mailing list ## ## Mailing list
There is now an invite-only mailing list for rclone developers `rclone-dev` on There is now an invite-only mailing list for rclone developers `rclone-dev` on
google groups. google groups.
## TODO ## ## TODO
I should probably make a <dev@rclone.org> to register with cloud providers. I should probably make a <dev@rclone.org> to register with cloud providers.

3
README.md
View File

@@ -168,8 +168,7 @@ Please see the [rclone website](https://rclone.org/) for:
- <https://rclone.org/downloads/> - <https://rclone.org/downloads/>
License ## License
-------
This is free software under the terms of the MIT license (check the This is free software under the terms of the MIT license (check the
[COPYING file](/COPYING) included in this package). [COPYING file](/COPYING) included in this package).

6
docs/content/authors.md
View File

@@ -6,13 +6,11 @@ description: "Rclone Authors and Contributors"
# Authors and contributors # Authors and contributors
Authors ## Authors
-------
- Nick Craig-Wood <nick@craig-wood.com> - Nick Craig-Wood <nick@craig-wood.com>
Contributors ## Contributors
------------
{{< rem `email addresses removed from here need to be added to {{< rem `email addresses removed from here need to be added to
bin/.ignore-emails to make sure update-authors.py doesn't immediately bin/.ignore-emails to make sure update-authors.py doesn't immediately

2
docs/content/downloads.md
View File

@@ -52,7 +52,7 @@ adopted as first class builds yet.
See [the release signing docs](/release_signing/) for how to verify See [the release signing docs](/release_signing/) for how to verify
signatures on the release. signatures on the release.
## Script download and install ## ## Script download and install
To install rclone on Linux/macOS/BSD systems, run: To install rclone on Linux/macOS/BSD systems, run:

26
docs/content/faq.md
View File

@@ -5,12 +5,12 @@ description: "Rclone Frequently Asked Questions"
# Frequently Asked Questions # Frequently Asked Questions
### Do all cloud storage systems support all rclone commands ### ### Do all cloud storage systems support all rclone commands
Yes they do. All the rclone commands (e.g. `sync`, `copy`, etc.) will Yes they do. All the rclone commands (e.g. `sync`, `copy`, etc.) will
work on all the remote storage systems. work on all the remote storage systems.
### Can I copy the config from one machine to another ### ### Can I copy the config from one machine to another
Sure! Rclone stores all of its config in a single file. If you want Sure! Rclone stores all of its config in a single file. If you want
to find this file, run `rclone config file` which will tell you where to find this file, run `rclone config file` which will tell you where
@@ -18,7 +18,7 @@ it is.
See the [remote setup docs](/remote_setup/) for more info. See the [remote setup docs](/remote_setup/) for more info.
### How do I configure rclone on a remote / headless box with no browser? ### ### How do I configure rclone on a remote / headless box with no browser?
This has now been documented in its own [remote setup page](/remote_setup/). This has now been documented in its own [remote setup page](/remote_setup/).
@@ -36,7 +36,7 @@ you can create an empty config file to get rid of this notice, for example:
rclone config touch rclone config touch
``` ```
### Can rclone sync directly from drive to s3 ### ### Can rclone sync directly from drive to s3
Rclone can sync between two remote cloud storage systems just fine. Rclone can sync between two remote cloud storage systems just fine.
@@ -51,7 +51,7 @@ e.g.
rclone sync --interactive drive:Folder s3:bucket rclone sync --interactive drive:Folder s3:bucket
``` ```
### Using rclone from multiple locations at the same time ### ### Using rclone from multiple locations at the same time
You can use rclone from multiple places at the same time if you choose You can use rclone from multiple places at the same time if you choose
different subdirectory for the output, e.g. different subdirectory for the output, e.g.
@@ -73,7 +73,7 @@ The file names you upload from Server A and Server B should be
different in this case, otherwise some file systems (e.g. Drive) may different in this case, otherwise some file systems (e.g. Drive) may
make duplicates. make duplicates.
### Why doesn't rclone support partial transfers / binary diffs like rsync? ### ### Why doesn't rclone support partial transfers / binary diffs like rsync?
Rclone stores each file you transfer as a native object on the remote Rclone stores each file you transfer as a native object on the remote
cloud storage system. This means that you can see the files you cloud storage system. This means that you can see the files you
@@ -95,12 +95,12 @@ it would be possible to make partial downloads work. However to make
this work efficiently this would require storing a significant amount this work efficiently this would require storing a significant amount
of metadata, which breaks the desired 1:1 mapping of files to objects. of metadata, which breaks the desired 1:1 mapping of files to objects.
### Can rclone do bi-directional sync? ### ### Can rclone do bi-directional sync?
Yes, since rclone v1.58.0, [bidirectional cloud sync](/bisync/) is Yes, since rclone v1.58.0, [bidirectional cloud sync](/bisync/) is
available. available.
### Can I use rclone with an HTTP proxy? ### ### Can I use rclone with an HTTP proxy?
Yes. rclone will follow the standard environment variables for Yes. rclone will follow the standard environment variables for
proxies, similar to cURL and other programs. proxies, similar to cURL and other programs.
@@ -147,7 +147,7 @@ export NO_PROXY=$no_proxy
Note that the FTP backend does not support `ftp_proxy` yet. Note that the FTP backend does not support `ftp_proxy` yet.
### Rclone gives x509: failed to load system roots and no roots provided error ### ### Rclone gives x509: failed to load system roots and no roots provided error
This means that `rclone` can't find the SSL root certificates. Likely This means that `rclone` can't find the SSL root certificates. Likely
you are running `rclone` on a NAS with a cut-down Linux OS, or you are running `rclone` on a NAS with a cut-down Linux OS, or
@@ -183,7 +183,7 @@ if it doesn't work without.
curl --insecure -o /etc/ssl/certs/ca-certificates.crt https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt curl --insecure -o /etc/ssl/certs/ca-certificates.crt https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt
``` ```
### Rclone gives Failed to load config file: function not implemented error ### ### Rclone gives Failed to load config file: function not implemented error
Likely this means that you are running rclone on Linux version not Likely this means that you are running rclone on Linux version not
supported by the go runtime, ie earlier than version 2.6.23. supported by the go runtime, ie earlier than version 2.6.23.
@@ -191,7 +191,7 @@ supported by the go runtime, ie earlier than version 2.6.23.
See the [system requirements section in the go install See the [system requirements section in the go install
docs](https://golang.org/doc/install) for full details. docs](https://golang.org/doc/install) for full details.
### All my uploaded docx/xlsx/pptx files appear as archive/zip ### ### All my uploaded docx/xlsx/pptx files appear as archive/zip
This is caused by uploading these files from a Windows computer which This is caused by uploading these files from a Windows computer which
hasn't got the Microsoft Office suite installed. The easiest way to hasn't got the Microsoft Office suite installed. The easiest way to
@@ -199,7 +199,7 @@ fix is to install the Word viewer and the Microsoft Office
Compatibility Pack for Word, Excel, and PowerPoint 2007 and later Compatibility Pack for Word, Excel, and PowerPoint 2007 and later
versions' file formats versions' file formats
### tcp lookup some.domain.com no such host ### ### tcp lookup some.domain.com no such host
This happens when rclone cannot resolve a domain. Please check that This happens when rclone cannot resolve a domain. Please check that
your DNS setup is generally working, e.g. your DNS setup is generally working, e.g.
@@ -223,7 +223,7 @@ name resolver by setting `GODEBUG=netdns=cgo` (and recompile rclone
from source with CGO enabled if necessary). See the from source with CGO enabled if necessary). See the
[name resolution section in the go docs](https://golang.org/pkg/net/#hdr-Name_Resolution). [name resolution section in the go docs](https://golang.org/pkg/net/#hdr-Name_Resolution).
### Failed to start auth webserver on Windows ### ### Failed to start auth webserver on Windows
```text ```text
Error: config failed to refresh token: failed to start auth webserver: listen tcp 127.0.0.1:53682: bind: An attempt was made to access a socket in a way forbidden by its access permissions. Error: config failed to refresh token: failed to start auth webserver: listen tcp 127.0.0.1:53682: bind: An attempt was made to access a socket in a way forbidden by its access permissions.

40
docs/content/overview.md
View File

@@ -4,13 +4,13 @@ description: "Overview of cloud storage systems"
type: page type: page
--- ---
# Overview of cloud storage systems # # Overview of cloud storage systems
Each cloud storage system is slightly different. Rclone attempts to Each cloud storage system is slightly different. Rclone attempts to
provide a unified interface to them, but some underlying differences provide a unified interface to them, but some underlying differences
show through. show through.
## Features ## ## Features
Here is an overview of the major features of each cloud storage system. Here is an overview of the major features of each cloud storage system.
@@ -112,7 +112,7 @@ top-level sum.
¹³ Uloz.to provides server-calculated MD5 hash upon file upload. MD5 and SHA256 ¹³ Uloz.to provides server-calculated MD5 hash upon file upload. MD5 and SHA256
hashes are client-calculated and stored as metadata fields. hashes are client-calculated and stored as metadata fields.
### Hash ### ### Hash
The cloud storage system supports various hash types of the objects. The cloud storage system supports various hash types of the objects.
The hashes are used when transferring data as an integrity check and The hashes are used when transferring data as an integrity check and
@@ -122,7 +122,7 @@ the `check` command.
To use the verify checksums when transferring between cloud storage To use the verify checksums when transferring between cloud storage
systems they must support a common hash type. systems they must support a common hash type.
### ModTime ### ### ModTime
Almost all cloud storage systems store some sort of timestamp Almost all cloud storage systems store some sort of timestamp
on objects, but several of them not something that is appropriate on objects, but several of them not something that is appropriate
@@ -166,7 +166,7 @@ means they do also support modtime-only operations.
Storage systems with `D` in the ModTime column means that the Storage systems with `D` in the ModTime column means that the
following symbols apply to directories as well as files. following symbols apply to directories as well as files.
### Case Insensitive ### ### Case Insensitive
If a cloud storage systems is case sensitive then it is possible to If a cloud storage systems is case sensitive then it is possible to
have two files which differ only in case, e.g. `file.txt` and have two files which differ only in case, e.g. `file.txt` and
@@ -189,7 +189,7 @@ Most of the time this doesn't cause any problems as people tend to
avoid files whose name differs only by case even on case sensitive avoid files whose name differs only by case even on case sensitive
systems. systems.
### Duplicate files ### ### Duplicate files
If a cloud storage system allows duplicate files then it can have two If a cloud storage system allows duplicate files then it can have two
objects with the same name. objects with the same name.
@@ -197,7 +197,7 @@ objects with the same name.
This confuses rclone greatly when syncing - use the `rclone dedupe` This confuses rclone greatly when syncing - use the `rclone dedupe`
command to rename or remove duplicates. command to rename or remove duplicates.
### Restricted filenames ### ### Restricted filenames
Some cloud storage systems might have restrictions on the characters Some cloud storage systems might have restrictions on the characters
that are usable in file or directory names. that are usable in file or directory names.
@@ -465,7 +465,7 @@ it to your Windows filesystem, this will fail. These characters are not
valid in filenames on Windows, and you have told rclone not to work around valid in filenames on Windows, and you have told rclone not to work around
this by converting them to valid fullwidth variants. this by converting them to valid fullwidth variants.
### MIME Type ### ### MIME Type
MIME types (also known as media types) classify types of documents MIME types (also known as media types) classify types of documents
using a simple text classification, e.g. `text/html` or using a simple text classification, e.g. `text/html` or
@@ -501,7 +501,7 @@ The levels of metadata support are
See [the metadata docs](/docs/#metadata) for more info. See [the metadata docs](/docs/#metadata) for more info.
## Optional Features ## ## Optional Features
All rclone remotes support a base command set. Other features depend All rclone remotes support a base command set. Other features depend
upon backend-specific capabilities. upon backend-specific capabilities.
@@ -574,12 +574,12 @@ purging a directory inside a bucket, files are deleted individually.
⁵ Use the `--onedrive-delta` flag to enable. ⁵ Use the `--onedrive-delta` flag to enable.
### Purge ### ### Purge
This deletes a directory quicker than just deleting all the files in This deletes a directory quicker than just deleting all the files in
the directory. the directory.
### Copy ### ### Copy
Used when copying an object to and from the same remote. This known Used when copying an object to and from the same remote. This known
as a server-side copy so you can copy a file without downloading it as a server-side copy so you can copy a file without downloading it
@@ -589,7 +589,7 @@ and uploading it again. It is used if you use `rclone copy` or
If the server doesn't support `Copy` directly then for copy operations If the server doesn't support `Copy` directly then for copy operations
the file is downloaded then re-uploaded. the file is downloaded then re-uploaded.
### Move ### ### Move
Used when moving/renaming an object on the same remote. This is known Used when moving/renaming an object on the same remote. This is known
as a server-side move of a file. This is used in `rclone move` if the as a server-side move of a file. This is used in `rclone move` if the
@@ -599,13 +599,13 @@ If the server isn't capable of `Move` then rclone simulates it with
`Copy` then delete. If the server doesn't support `Copy` then rclone `Copy` then delete. If the server doesn't support `Copy` then rclone
will download the file and re-upload it. will download the file and re-upload it.
### DirMove ### ### DirMove
This is used to implement `rclone move` to move a directory if This is used to implement `rclone move` to move a directory if
possible. If it isn't then it will use `Move` on each file (which possible. If it isn't then it will use `Move` on each file (which
falls back to `Copy` then download and upload - see `Move` section). falls back to `Copy` then download and upload - see `Move` section).
### CleanUp ### ### CleanUp
This is used for emptying the trash for a remote by `rclone cleanup`. This is used for emptying the trash for a remote by `rclone cleanup`.
@@ -615,31 +615,31 @@ error.
‡‡ Note that while Box implements this it has to delete every file ‡‡ Note that while Box implements this it has to delete every file
individually so it will be slower than emptying the trash via the WebUI individually so it will be slower than emptying the trash via the WebUI
### ListR ### ### ListR
The remote supports a recursive list to list all the contents beneath The remote supports a recursive list to list all the contents beneath
a directory quickly. This enables the `--fast-list` flag to work. a directory quickly. This enables the `--fast-list` flag to work.
See the [rclone docs](/docs/#fast-list) for more details. See the [rclone docs](/docs/#fast-list) for more details.
### StreamUpload ### ### StreamUpload
Some remotes allow files to be uploaded without knowing the file size Some remotes allow files to be uploaded without knowing the file size
in advance. This allows certain operations to work without spooling the in advance. This allows certain operations to work without spooling the
file to local disk first, e.g. `rclone rcat`. file to local disk first, e.g. `rclone rcat`.
### MultithreadUpload ### ### MultithreadUpload
Some remotes allow transfers to the remote to be sent as chunks in Some remotes allow transfers to the remote to be sent as chunks in
parallel. If this is supported then rclone will use multi-thread parallel. If this is supported then rclone will use multi-thread
copying to transfer files much faster. copying to transfer files much faster.
### LinkSharing ### ### LinkSharing
Sets the necessary permissions on a file or folder and prints a link Sets the necessary permissions on a file or folder and prints a link
that allows others to access them, even if they don't have an account that allows others to access them, even if they don't have an account
on the particular cloud provider. on the particular cloud provider.
### About ### ### About
Rclone `about` prints quota information for a remote. Typical output Rclone `about` prints quota information for a remote. Typical output
includes bytes used, free, quota and in trash. includes bytes used, free, quota and in trash.
@@ -653,7 +653,7 @@ rclone union remote.
See [rclone about command](https://rclone.org/commands/rclone_about/) See [rclone about command](https://rclone.org/commands/rclone_about/)
### EmptyDir ### ### EmptyDir
The remote supports empty directories. See [Limitations](/bugs/#limitations) The remote supports empty directories. See [Limitations](/bugs/#limitations)
for details. Most Object/Bucket-based remotes do not support this. for details. Most Object/Bucket-based remotes do not support this.

20
docs/content/privacy.md
View File

@@ -3,9 +3,9 @@ title: "Privacy Policy"
description: "Rclone Privacy Policy" description: "Rclone Privacy Policy"
--- ---
# Rclone Privacy Policy # # Rclone Privacy Policy
## What is this Privacy Policy for? ## ## What is this Privacy Policy for?
This privacy policy is for this website <https://rclone.org> and governs the This privacy policy is for this website <https://rclone.org> and governs the
privacy of its users who choose to use it. privacy of its users who choose to use it.
@@ -15,14 +15,14 @@ outlines the obligations & requirements of the users, the website and website
owners. Furthermore the way this website processes, stores and protects user owners. Furthermore the way this website processes, stores and protects user
data and information will also be detailed within this policy. data and information will also be detailed within this policy.
## The Website ## ## The Website
This website and its owners take a proactive approach to user privacy and This website and its owners take a proactive approach to user privacy and
ensure the necessary steps are taken to protect the privacy of its users ensure the necessary steps are taken to protect the privacy of its users
throughout their visiting experience. This website complies to all UK national throughout their visiting experience. This website complies to all UK national
laws and requirements for user privacy. laws and requirements for user privacy.
## Use of Cookies ## ## Use of Cookies
This website uses cookies to better the users experience while visiting the This website uses cookies to better the users experience while visiting the
website. Where applicable this website uses a cookie control system allowing website. Where applicable this website uses a cookie control system allowing
@@ -55,7 +55,7 @@ cookies are used for conversion and referral tracking and typically expire
after 30 days, though some may take longer. No personal information is stored, after 30 days, though some may take longer. No personal information is stored,
saved or collected. saved or collected.
## Contact & Communication ## ## Contact & Communication
Users contacting this website and/or its owners do so at their own discretion Users contacting this website and/or its owners do so at their own discretion
and provide any such personal details requested at their own risk. Your and provide any such personal details requested at their own risk. Your
@@ -66,7 +66,7 @@ This website and its owners use any information submitted to provide you with
further information about the products / services they offer or to assist you further information about the products / services they offer or to assist you
in answering any questions or queries you may have submitted. in answering any questions or queries you may have submitted.
## External Links ## ## External Links
Although this website only looks to include quality, safe and relevant external Although this website only looks to include quality, safe and relevant external
links, users are advised adopt a policy of caution before clicking any external links, users are advised adopt a policy of caution before clicking any external
@@ -78,7 +78,7 @@ note they click on external links at their own risk and this website and its
owners cannot be held liable for any damages or implications caused by visiting owners cannot be held liable for any damages or implications caused by visiting
any external links mentioned. any external links mentioned.
## Adverts and Sponsored Links ## ## Adverts and Sponsored Links
This website may contain sponsored links and adverts. These will typically be This website may contain sponsored links and adverts. These will typically be
served through our advertising partners, to whom may have detailed privacy served through our advertising partners, to whom may have detailed privacy
@@ -92,7 +92,7 @@ on sponsored external links at their own risk and this website and its owners
cannot be held liable for any damages or implications caused by visiting any cannot be held liable for any damages or implications caused by visiting any
external links mentioned. external links mentioned.
### Social Media Platforms ## ### Social Media Platforms
Communication, engagement and actions taken through external social media Communication, engagement and actions taken through external social media
platforms that this website and its owners participate on are subject to the platforms that this website and its owners participate on are subject to the
@@ -113,7 +113,7 @@ discretion and note that the social media platform may track and save your
request to share a web page respectively through your social media platform request to share a web page respectively through your social media platform
account. account.
## Use of Cloud API User Data ## ## Use of Cloud API User Data
Rclone is a command-line program to manage files on cloud storage. Its sole Rclone is a command-line program to manage files on cloud storage. Its sole
purpose is to access and manipulate user content in the [supported](/overview/) purpose is to access and manipulate user content in the [supported](/overview/)
@@ -131,7 +131,7 @@ section and followed by the privacy policy of Rclone.
local configuration file. local configuration file.
- Rclone does not share any user data with third parties. - Rclone does not share any user data with third parties.
## Resources & Further Information ## ## Resources & Further Information
- [Data Protection Act 1998](http://www.legislation.gov.uk/ukpga/1998/29/contents) - [Data Protection Act 1998](http://www.legislation.gov.uk/ukpga/1998/29/contents)
- [Privacy and Electronic Communications Regulations 2003](http://www.legislation.gov.uk/uksi/2003/2426/contents/made) - [Privacy and Electronic Communications Regulations 2003](http://www.legislation.gov.uk/uksi/2003/2426/contents/made)

2
docs/content/rc.md
View File

@@ -2505,7 +2505,7 @@ curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' '
} }
``` ```
## Debugging rclone with pprof ## ## Debugging rclone with pprof
If you use the `--rc` flag this will also enable the use of the go If you use the `--rc` flag this will also enable the use of the go
profiling tools on the same port. profiling tools on the same port.