From 0bb4d0a9852e79d64b1b89d51d0b5c01e6f985ee Mon Sep 17 00:00:00 2001 From: albertony <12441419+albertony@users.noreply.github.com> Date: Thu, 10 Jul 2025 15:20:41 +0200 Subject: [PATCH] docs: fix markdownlint issue md003/heading-style --- CONTRIBUTING.md | 2 +- MAINTAINERS.md | 16 ++++++++-------- README.md | 3 +-- docs/content/authors.md | 6 ++---- docs/content/downloads.md | 2 +- docs/content/faq.md | 26 ++++++++++++------------- docs/content/overview.md | 40 +++++++++++++++++++-------------------- docs/content/privacy.md | 20 ++++++++++---------- docs/content/rc.md | 2 +- 9 files changed, 57 insertions(+), 60 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e14a4b927..b711e4377 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -166,7 +166,7 @@ git rebase master 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). -### Squashing your commits ### +### Squashing your commits To combine your commits into one commit: diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 018f4add0..a6e149602 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,4 +1,4 @@ -# Maintainers guide for rclone # +# Maintainers guide for rclone 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 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 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 following up. -## Closing Tickets ## +## Closing Tickets 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. -## Pull requests ## +## Pull requests 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 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 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 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 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 google groups. -## TODO ## +## TODO I should probably make a to register with cloud providers. diff --git a/README.md b/README.md index 27b444951..237541fd0 100644 --- a/README.md +++ b/README.md @@ -168,8 +168,7 @@ Please see the [rclone website](https://rclone.org/) for: - -License -------- +## License This 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.md index 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 -Contributors ------------- +## Contributors {{< rem `email addresses removed from here need to be added to bin/.ignore-emails to make sure update-authors.py doesn't immediately diff --git a/docs/content/downloads.md b/docs/content/downloads.md index 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 verify signatures on the release. -## Script download and install ## +## Script download and install To install rclone on Linux/macOS/BSD systems, run: diff --git a/docs/content/faq.md b/docs/content/faq.md index 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 commands Yes they do. All the rclone commands (e.g. `sync`, `copy`, etc.) will 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 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. -### 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 s3 Rclone 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 time You can use rclone from multiple places at the same time if you choose 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 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 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 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 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 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. -### 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 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 ``` -### 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 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 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 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 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 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 [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 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. diff --git a/docs/content/overview.md b/docs/content/overview.md index 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 systems Each cloud storage system is slightly different. Rclone attempts to provide a unified interface to them, but some underlying differences show through. -## Features ## +## Features 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 hashes are client-calculated and stored as metadata fields. -### Hash ### +### Hash The 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 storage systems they must support a common hash type. -### ModTime ### +### ModTime Almost all cloud storage systems store some sort of timestamp 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 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 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 systems. -### Duplicate files ### +### Duplicate files If a cloud storage system allows duplicate files then it can have two objects 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 filenames Some cloud storage systems might have restrictions on the characters 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 this by converting them to valid fullwidth variants. -### MIME Type ### +### MIME Type MIME types (also known as media types) classify types of documents 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. -## Optional Features ## +## Optional Features All rclone remotes support a base command set. Other features depend 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. -### Purge ### +### Purge This deletes a directory quicker than just deleting all the files in the directory. -### Copy ### +### Copy 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 @@ -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 the file is downloaded then re-uploaded. -### Move ### +### Move 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 @@ -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 will download the file and re-upload it. -### DirMove ### +### DirMove 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 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`. @@ -615,31 +615,31 @@ error. ‡‡ 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 -### ListR ### +### ListR The remote supports a recursive list to list all the contents beneath a directory quickly. This enables the `--fast-list` flag to work. See the [rclone docs](/docs/#fast-list) for more details. -### StreamUpload ### +### StreamUpload Some remotes allow files to be uploaded without knowing the file size in advance. This allows certain operations to work without spooling the file to local disk first, e.g. `rclone rcat`. -### MultithreadUpload ### +### MultithreadUpload Some remotes allow transfers to the remote to be sent as chunks in parallel. If this is supported then rclone will use multi-thread copying to transfer files much faster. -### LinkSharing ### +### LinkSharing 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 on the particular cloud provider. -### About ### +### About Rclone `about` prints quota information for a remote. Typical output 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/) -### EmptyDir ### +### EmptyDir The 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.md index 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 and governs the 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 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 ensure the necessary steps are taken to protect the privacy of its users throughout their visiting experience. This website complies to all UK national laws and requirements for user privacy. -## Use of Cookies ## +## Use of Cookies This website uses cookies to better the users experience while visiting the 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, saved or collected. -## Contact & Communication ## +## Contact & Communication 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 @@ -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 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 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 any external links mentioned. -## Adverts and Sponsored Links ## +## Adverts and Sponsored Links This website may contain sponsored links and adverts. These will typically be 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 external links mentioned. -### Social Media Platforms ## +### Social Media Platforms Communication, engagement and actions taken through external social media 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 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 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. - 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.md index 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 pprof If you use the `--rc` flag this will also enable the use of the go profiling tools on the same port.