"rsync for cloud storage" - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files
Go azure-blobazure-blob-storageazure-filesbackblaze-b2cloud-storagedropboxencryptionftpfuse-filesystemgogolanggoogle-cloud-storagegoogle-driveonedriveopenstack-swiftrclones3sftpsyncwebdav
docs: fix markdownlint issue md003/heading-style
albertony0bb4d0a9852e
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex e14a4b927..b711e4377 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -166,7 +166,7 @@ git rebase masterIf you rebase commits that have been pushed to GitHub, then you will have to[replace your previously pushed commits](#replacing-your-previously-pushed-commits).-### Squashing your commits ###+### Squashing your commitsTo combine your commits into one commit:diff --git a/MAINTAINERS.md b/MAINTAINERS.mdindex 018f4add0..a6e149602 100644--- a/MAINTAINERS.md+++ b/MAINTAINERS.md@@ -1,4 +1,4 @@-# Maintainers guide for rclone #+# Maintainers guide for rcloneCurrent 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-upof what I (@ncw) attempt to do.-## Triaging Tickets ##+## Triaging TicketsWhen a ticket comes in it should be triaged. This means it should be classifiedby 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=iare good candidates for ones that have slipped between the gaps and needfollowing up.-## Closing Tickets ##+## Closing TicketsClose 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.-## Pull requests ##+## Pull requestsTry to process pull requests promptly!@@ -98,12 +98,12 @@ After merging the commit, in your local master branch, do `git pull` then runSometimes pull requests need to be left open for a while - this especially trueof contributions of new backends which take a long time to get right.-## Merges ##+## MergesIf you are merging a branch locally then do `git merge --ff-only branch-name` toavoid a merge commit. You'll need to rebase the branch if it doesn't merge cleanly.-## Release cycle ##+## Release cycleRclone aims for a 6-8 week release cycle. Sometimes release cycles take longerif 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 thetesting part is the most time-consuming often needing several rounds of testand fix depending on exactly how many new features rclone has gained.-## Mailing list ##+## Mailing listThere is now an invite-only mailing list for rclone developers `rclone-dev` ongoogle groups.-## TODO ##+## TODOI should probably make a <[email protected]> to register with cloud providers.diff --git a/README.md b/README.mdindex 27b444951..237541fd0 100644--- a/README.md+++ b/README.md@@ -168,8 +168,7 @@ Please see the [rclone website](https://rclone.org/) for:- <https://rclone.org/downloads/>-License--------+## LicenseThis is free software under the terms of the MIT license (check the[COPYING file](/COPYING) included in this package).diff --git a/docs/content/authors.md b/docs/content/authors.mdindex 71fe6c11a..56cc8d51f 100644--- a/docs/content/authors.md+++ b/docs/content/authors.md@@ -6,13 +6,11 @@ description: "Rclone Authors and Contributors"# Authors and contributors-Authors--------+## Authors- Nick Craig-Wood <[email protected]>-Contributors-------------+## Contributors{{< rem `email addresses removed from here need to be added tobin/.ignore-emails to make sure update-authors.py doesn't immediatelydiff --git a/docs/content/downloads.md b/docs/content/downloads.mdindex 3ee3e13f2..f23b5d10d 100644--- a/docs/content/downloads.md+++ b/docs/content/downloads.md@@ -52,7 +52,7 @@ adopted as first class builds yet.See [the release signing docs](/release_signing/) for how to verifysignatures on the release.-## Script download and install ##+## Script download and installTo install rclone on Linux/macOS/BSD systems, run:diff --git a/docs/content/faq.md b/docs/content/faq.mdindex 8addc7132..6b5e5a427 100644--- a/docs/content/faq.md+++ b/docs/content/faq.md@@ -5,12 +5,12 @@ description: "Rclone Frequently Asked Questions"# Frequently Asked Questions-### Do all cloud storage systems support all rclone commands ###+### Do all cloud storage systems support all rclone commandsYes they do. All the rclone commands (e.g. `sync`, `copy`, etc.) willwork 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 anotherSure! Rclone stores all of its config in a single file. If you wantto 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.-### 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/).@@ -36,7 +36,7 @@ you can create an empty config file to get rid of this notice, for example:rclone config touch```-### Can rclone sync directly from drive to s3 ###+### Can rclone sync directly from drive to s3Rclone can sync between two remote cloud storage systems just fine.@@ -51,7 +51,7 @@ e.g.rclone sync --interactive drive:Folder s3:bucket```-### Using rclone from multiple locations at the same time ###+### Using rclone from multiple locations at the same timeYou can use rclone from multiple places at the same time if you choosedifferent subdirectory for the output, e.g.@@ -73,7 +73,7 @@ The file names you upload from Server A and Server B should bedifferent in this case, otherwise some file systems (e.g. Drive) maymake 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 remotecloud 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 makethis work efficiently this would require storing a significant amountof 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/) isavailable.-### Can I use rclone with an HTTP proxy? ###+### Can I use rclone with an HTTP proxy?Yes. rclone will follow the standard environment variables forproxies, similar to cURL and other programs.@@ -147,7 +147,7 @@ export NO_PROXY=$no_proxyNote 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 errorThis means that `rclone` can't find the SSL root certificates. Likelyyou 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```-### Rclone gives Failed to load config file: function not implemented error ###+### Rclone gives Failed to load config file: function not implemented errorLikely this means that you are running rclone on Linux version notsupported 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 installdocs](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/zipThis is caused by uploading these files from a Windows computer whichhasn'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 OfficeCompatibility Pack for Word, Excel, and PowerPoint 2007 and laterversions' file formats-### tcp lookup some.domain.com no such host ###+### tcp lookup some.domain.com no such hostThis happens when rclone cannot resolve a domain. Please check thatyour DNS setup is generally working, e.g.@@ -223,7 +223,7 @@ name resolver by setting `GODEBUG=netdns=cgo` (and recompile rclonefrom source with CGO enabled if necessary). See the[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```textError: 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.diff --git a/docs/content/overview.md b/docs/content/overview.mdindex 8b316ff77..b3ef4be61 100644--- a/docs/content/overview.md+++ b/docs/content/overview.md@@ -4,13 +4,13 @@ description: "Overview of cloud storage systems"type: page----# Overview of cloud storage systems #+# Overview of cloud storage systemsEach cloud storage system is slightly different. Rclone attempts toprovide a unified interface to them, but some underlying differencesshow through.-## Features ##+## FeaturesHere 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 SHA256hashes are client-calculated and stored as metadata fields.-### Hash ###+### HashThe cloud storage system supports various hash types of the objects.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 storagesystems they must support a common hash type.-### ModTime ###+### ModTimeAlmost all cloud storage systems store some sort of timestampon 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 thefollowing symbols apply to directories as well as files.-### Case Insensitive ###+### Case InsensitiveIf a cloud storage systems is case sensitive then it is possible tohave 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 toavoid files whose name differs only by case even on case sensitivesystems.-### Duplicate files ###+### Duplicate filesIf a cloud storage system allows duplicate files then it can have twoobjects with the same name.@@ -197,7 +197,7 @@ objects with the same name.This confuses rclone greatly when syncing - use the `rclone dedupe`command to rename or remove duplicates.-### Restricted filenames ###+### Restricted filenamesSome cloud storage systems might have restrictions on the charactersthat are usable in file or directory names.@@ -465,7 +465,7 @@ it to your Windows filesystem, this will fail. These characters are notvalid in filenames on Windows, and you have told rclone not to work aroundthis by converting them to valid fullwidth variants.-### MIME Type ###+### MIME TypeMIME types (also known as media types) classify types of documentsusing a simple text classification, e.g. `text/html` or@@ -501,7 +501,7 @@ The levels of metadata support areSee [the metadata docs](/docs/#metadata) for more info.-## Optional Features ##+## Optional FeaturesAll rclone remotes support a base command set. Other features dependupon backend-specific capabilities.@@ -574,12 +574,12 @@ purging a directory inside a bucket, files are deleted individually.⁵ Use the `--onedrive-delta` flag to enable.-### Purge ###+### PurgeThis deletes a directory quicker than just deleting all the files inthe directory.-### Copy ###+### CopyUsed when copying an object to and from the same remote. This knownas 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` orIf the server doesn't support `Copy` directly then for copy operationsthe file is downloaded then re-uploaded.-### Move ###+### MoveUsed when moving/renaming an object on the same remote. This is knownas 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 rclonewill download the file and re-upload it.-### DirMove ###+### DirMoveThis is used to implement `rclone move` to move a directory ifpossible. If it isn't then it will use `Move` on each file (whichfalls back to `Copy` then download and upload - see `Move` section).-### CleanUp ###+### CleanUpThis 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 fileindividually so it will be slower than emptying the trash via the WebUI-### ListR ###+### ListRThe remote supports a recursive list to list all the contents beneatha directory quickly. This enables the `--fast-list` flag to work.See the [rclone docs](/docs/#fast-list) for more details.-### StreamUpload ###+### StreamUploadSome remotes allow files to be uploaded without knowing the file sizein advance. This allows certain operations to work without spooling thefile to local disk first, e.g. `rclone rcat`.-### MultithreadUpload ###+### MultithreadUploadSome remotes allow transfers to the remote to be sent as chunks inparallel. If this is supported then rclone will use multi-threadcopying to transfer files much faster.-### LinkSharing ###+### LinkSharingSets the necessary permissions on a file or folder and prints a linkthat allows others to access them, even if they don't have an accounton the particular cloud provider.-### About ###+### AboutRclone `about` prints quota information for a remote. Typical outputincludes bytes used, free, quota and in trash.@@ -653,7 +653,7 @@ rclone union remote.See [rclone about command](https://rclone.org/commands/rclone_about/)-### EmptyDir ###+### EmptyDirThe remote supports empty directories. See [Limitations](/bugs/#limitations)for details. Most Object/Bucket-based remotes do not support this.diff --git a/docs/content/privacy.md b/docs/content/privacy.mdindex df2cc1530..b02b61d51 100644--- a/docs/content/privacy.md+++ b/docs/content/privacy.md@@ -3,9 +3,9 @@ title: "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 theprivacy of its users who choose to use it.@@ -15,14 +15,14 @@ outlines the obligations & requirements of the users, the website and websiteowners. Furthermore the way this website processes, stores and protects userdata and information will also be detailed within this policy.-## The Website ##+## The WebsiteThis website and its owners take a proactive approach to user privacy andensure the necessary steps are taken to protect the privacy of its usersthroughout their visiting experience. This website complies to all UK nationallaws and requirements for user privacy.-## Use of Cookies ##+## Use of CookiesThis website uses cookies to better the users experience while visiting thewebsite. Where applicable this website uses a cookie control system allowing@@ -55,7 +55,7 @@ cookies are used for conversion and referral tracking and typically expireafter 30 days, though some may take longer. No personal information is stored,saved or collected.-## Contact & Communication ##+## Contact & CommunicationUsers contacting this website and/or its owners do so at their own discretionand 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 withfurther information about the products / services they offer or to assist youin answering any questions or queries you may have submitted.-## External Links ##+## External LinksAlthough this website only looks to include quality, safe and relevant externallinks, 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 itsowners cannot be held liable for any damages or implications caused by visitingany external links mentioned.-## Adverts and Sponsored Links ##+## Adverts and Sponsored LinksThis website may contain sponsored links and adverts. These will typically beserved 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 ownerscannot be held liable for any damages or implications caused by visiting anyexternal links mentioned.-### Social Media Platforms ##+### Social Media PlatformsCommunication, engagement and actions taken through external social mediaplatforms 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 yourrequest to share a web page respectively through your social media platformaccount.-## Use of Cloud API User Data ##+## Use of Cloud API User DataRclone is a command-line program to manage files on cloud storage. Its solepurpose 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.- 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)- [Privacy and Electronic Communications Regulations 2003](http://www.legislation.gov.uk/uksi/2003/2426/contents/made)diff --git a/docs/content/rc.md b/docs/content/rc.mdindex a108adab7..e190ce7ee 100644--- a/docs/content/rc.md+++ b/docs/content/rc.md@@ -2505,7 +2505,7 @@ curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' '}```-## Debugging rclone with pprof ##+## Debugging rclone with pprofIf you use the `--rc` flag this will also enable the use of the goprofiling tools on the same port.