jgaunt/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-12-06 00:03:32 +00:00
Code Issues Projects Releases Wiki Activity

docs: fix various markdownlint issues

Browse Source
This commit is contained in:
albertony
2025-11-01 16:47:09 +01:00
parent f361cdf1cb
commit 7672c3d586
14 changed files with 292 additions and 225 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/content/b2.md
View File

@@ -78,7 +78,6 @@ List the contents of a bucket
rclone ls remote:bucket
```
Sync `/home/local/directory` to the remote bucket, deleting any
excess files in the bucket.
@@ -98,7 +97,7 @@ Follow Backblaze's docs to create an Application Key with the required
permission and add the `applicationKeyId` as the `account` and the
`Application Key` itself as the `key`.
Note that you must put the _applicationKeyId_ as the `account` – you
Note that you must put the *applicationKeyId* as the `account` – you
can't use the master Account ID. If you try then B2 will return 401
errors.
@@ -192,7 +191,7 @@ You may opt in to a "hard delete" of files with the `--b2-hard-delete`
flag which permanently removes files on deletion instead of hiding
them.
Old versions of files, where available, are visible using the
Old versions of files, where available, are visible using the
`--b2-versions` flag.
It is also possible to view a bucket as it was at a certain point in time,

8
docs/content/box.md
View File

@@ -109,7 +109,9 @@ rclone ls remote:
To copy a local directory to an Box directory called backup
rclone copy /home/source remote:backup
```console
rclone copy /home/source remote:backup
```
### Using rclone with an Enterprise account with SSO
@@ -249,8 +251,8 @@ either be actually deleted from Box or moved to the trash.
Emptying the trash is supported via the rclone however cleanup command
however this deletes every trashed file and folder individually so it
may take a very long time.
Emptying the trash via the WebUI does not have this limitation
may take a very long time.
Emptying the trash via the WebUI does not have this limitation
so it is advised to empty the trash via the WebUI.
### Root folder ID

43
docs/content/crypt.md
View File

@@ -707,9 +707,9 @@ the same in the new encrypted remote.
This will have the following advantages
* `rclone sync` will check the checksums while copying
* you can use `rclone check` between the encrypted remotes
* you don't decrypt and encrypt unnecessarily
- `rclone sync` will check the checksums while copying
- you can use `rclone check` between the encrypted remotes
- you don't decrypt and encrypt unnecessarily
For example, let's say you have your original remote at `remote:` with
the encrypted version at `eremote:` with path `remote:crypt`. You
@@ -719,11 +719,15 @@ as `eremote:`.
To sync the two remotes you would do
rclone sync --interactive remote:crypt remote2:crypt
```console
rclone sync --interactive remote:crypt remote2:crypt
```
And to check the integrity you would do
rclone check remote:crypt remote2:crypt
```console
rclone check remote:crypt remote2:crypt
```
## File formats
@@ -734,8 +738,8 @@ has a header and is divided into chunks.
#### Header
* 8 bytes magic string `RCLONE\x00\x00`
* 24 bytes Nonce (IV)
- 8 bytes magic string `RCLONE\x00\x00`
- 24 bytes Nonce (IV)
The initial nonce is generated from the operating systems crypto
strong random number generator. The nonce is incremented for each
@@ -753,8 +757,8 @@ authenticate messages.
Each chunk contains:
* 16 Bytes of Poly1305 authenticator
* 1 - 65536 bytes XSalsa20 encrypted data
- 16 Bytes of Poly1305 authenticator
- 1 - 65536 bytes XSalsa20 encrypted data
64k chunk size was chosen as the best performing chunk size (the
authenticator takes too much time below this and the performance drops
@@ -767,15 +771,15 @@ This uses a 32 byte (256 bit key) key derived from the user password.
1 byte file will encrypt to
* 32 bytes header
* 17 bytes data chunk
- 32 bytes header
- 17 bytes data chunk
49 bytes total
1 MiB (1048576 bytes) file will encrypt to
* 32 bytes header
* 16 chunks of 65568 bytes
- 32 bytes header
- 16 chunks of 65568 bytes
1049120 bytes total (a 0.05% overhead). This is the overhead for big
files.
@@ -798,8 +802,8 @@ it on the cloud storage system.
This means that
* filenames with the same name will encrypt the same
* filenames which start the same won't have a common prefix
- filenames with the same name will encrypt the same
- filenames which start the same won't have a common prefix
This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of
which are derived from the user password.
@@ -808,8 +812,8 @@ After encryption they are written out using a modified version of
standard `base32` encoding as described in RFC4648. The standard
encoding is modified in two ways:
* it becomes lower case (no-one likes upper case filenames!)
* we strip the padding character `=`
- it becomes lower case (no-one likes upper case filenames!)
- we strip the padding character `=`
`base32` is used rather than the more efficient `base64` so rclone can be
used on case insensitive remotes (e.g. Windows, Box, Dropbox, Onedrive etc).
@@ -825,6 +829,7 @@ then rclone uses an internal one.
encrypted data. For full protection against this you should always use
a salt.
## SEE ALSO
## See Also
* [rclone cryptdecode](/commands/rclone_cryptdecode/) - Show forward/reverse mapping of encrypted filenames
- [rclone cryptdecode](/commands/rclone_cryptdecode/) - Show forward/reverse
mapping of encrypted filenames.

35
docs/content/dropbox.md
View File

@@ -604,10 +604,9 @@ issue an error message `File name disallowed - not uploading` if it
attempts to upload one of those file names, but the sync won't fail.
Some errors may occur if you try to sync copyright-protected files
because Dropbox has its own [copyright detector](https://techcrunch.com/2014/03/30/how-dropbox-knows-when-youre-sharing-copyrighted-stuff-without-actually-looking-at-your-stuff/) that
prevents this sort of file being downloaded. This will return the error `ERROR :
/path/to/your/file: Failed to copy: failed to open source object:
path/restricted_content/.`
because Dropbox has its own [copyright detector](https://techcrunch.com/2014/03/30/how-dropbox-knows-when-youre-sharing-copyrighted-stuff-without-actually-looking-at-your-stuff/)
that prevents this sort of file being downloaded. This will return the error
`ERROR : /path/to/your/file: Failed to copy: failed to open source object: path/restricted_content/.`
If you have more than 10,000 files in a directory then `rclone purge
dropbox:dir` will return the error `Failed to purge: There are too
@@ -617,7 +616,8 @@ many files involved in this operation`. As a work-around do an
When using `rclone link` you'll need to set `--expire` if using a
non-personal account otherwise the visibility may not be correct.
(Note that `--expire` isn't supported on personal accounts). See the
[forum discussion](https://forum.rclone.org/t/rclone-link-dropbox-permissions/23211) and the
[forum discussion](https://forum.rclone.org/t/rclone-link-dropbox-permissions/23211)
and the
[dropbox SDK issue](https://github.com/dropbox/dropbox-sdk-go-unofficial/issues/75).
Modification times for Dropbox Paper documents are not exact, and
@@ -627,23 +627,34 @@ or so, or use `--ignore-times` to force a full sync.
## Get your own Dropbox App ID
When you use rclone with Dropbox in its default configuration you are using rclone's App ID. This is shared between all the rclone users.
When you use rclone with Dropbox in its default configuration you are using
rclone's App ID. This is shared between all the rclone users.
Here is how to create your own Dropbox App ID for rclone:
1. Log into the [Dropbox App console](https://www.dropbox.com/developers/apps/create) with your Dropbox Account (It need not
to be the same account as the Dropbox you want to access)
1. Log into the [Dropbox App console](https://www.dropbox.com/developers/apps/create)
with your Dropbox Account (It need not to be the same account as the Dropbox you
want to access)
2. Choose an API => Usually this should be `Dropbox API`
3. Choose the type of access you want to use => `Full Dropbox` or `App Folder`. If you want to use Team Folders, `Full Dropbox` is required ([see here](https://www.dropboxforum.com/t5/Dropbox-API-Support-Feedback/How-to-create-team-folder-inside-my-app-s-folder/m-p/601005/highlight/true#M27911)).
3. Choose the type of access you want to use => `Full Dropbox` or `App Folder`.
If you want to use Team Folders, `Full Dropbox` is required
([see here](https://www.dropboxforum.com/t5/Dropbox-API-Support-Feedback/How-to-create-team-folder-inside-my-app-s-folder/m-p/601005/highlight/true#M27911)).
4. Name your App. The app name is global, so you can't use `rclone` for example
5. Click the button `Create App`
6. Switch to the `Permissions` tab. Enable at least the following permissions: `account_info.read`, `files.metadata.write`, `files.content.write`, `files.content.read`, `sharing.write`. The `files.metadata.read` and `sharing.read` checkboxes will be marked too. Click `Submit`
6. Switch to the `Permissions` tab. Enable at least the following permissions:
`account_info.read`, `files.metadata.write`, `files.content.write`, `files.content.read`,
`sharing.write`. The `files.metadata.read` and `sharing.read` checkboxes will be
marked too. Click `Submit`
7. Switch to the `Settings` tab. Fill `OAuth2 - Redirect URIs` as `http://localhost:53682/` and click on `Add`
7. Switch to the `Settings` tab. Fill `OAuth2 - Redirect URIs` as `http://localhost:53682/`
and click on `Add`
8. Find the `App key` and `App secret` values on the `Settings` tab. Use these values in rclone config to add a new remote or edit an existing remote. The `App key` setting corresponds to `client_id` in rclone config, the `App secret` corresponds to `client_secret`
8. Find the `App key` and `App secret` values on the `Settings` tab. Use these
values in rclone config to add a new remote or edit an existing remote.
The `App key` setting corresponds to `client_id` in rclone config, the
`App secret` corresponds to `client_secret`

10
docs/content/onedrive.md
View File

@@ -147,7 +147,9 @@ To create your own Client ID, please follow these steps:
- If you have not created an Azure account, you will be prompted to. This is free,
but you need to provide a phone number, address, and credit card for identity
verification.
2. Enter a name for your app, choose account type `Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)`,
2. Enter a name for your app, choose account type `Accounts in any organizational
directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts
(e.g. Skype, Xbox)`,
select `Web` in `Redirect URI`, then type (do not copy and paste)
`http://localhost:53682/` and click Register. Copy and keep the
`Application (client) ID` under the app name for later use.
@@ -170,7 +172,8 @@ The access_scopes option allows you to configure the permissions requested by rc
See [Microsoft Docs](https://docs.microsoft.com/en-us/graph/permissions-reference#files-permissions)
for more information about the different scopes.
The `Sites.Read.All` permission is required if you need to [search SharePoint sites when configuring the remote](https://github.com/rclone/rclone/pull/5883).
The `Sites.Read.All` permission is required if you need to
[search SharePoint sites when configuring the remote](https://github.com/rclone/rclone/pull/5883).
However, if that permission is not assigned, you need to exclude `Sites.Read.All`
from your access scopes or set `disable_site_permission` option to true in the
advanced options.
@@ -1109,7 +1112,8 @@ setting:
1. `Install-Module -Name Microsoft.Online.SharePoint.PowerShell` (in case you
haven't installed this already)
2. `Import-Module Microsoft.Online.SharePoint.PowerShell -DisableNameChecking`
3. `Connect-SPOService -Url https://YOURSITE-admin.sharepoint.com -Credential YOU@YOURSITE.COM` (replacing `YOURSITE`, `YOU`, `YOURSITE.COM` with the actual values; this will
3. `Connect-SPOService -Url https://YOURSITE-admin.sharepoint.com -Credential YOU@YOURSITE.COM`
(replacing `YOURSITE`, `YOU`, `YOURSITE.COM` with the actual values; this will
prompt for your credentials)
4. `Set-SPOTenant -EnableMinimumVersionRequirement $False`
5. `Disconnect-SPOService` (to disconnect from the server)

7
docs/content/oracleobjectstorage/_index.md
View File

@@ -156,10 +156,10 @@ rclone ls remote:bucket
rclone ls remote:bucket --max-depth 1
```
## Authentication Providers
## Authentication Providers
OCI has various authentication methods. To learn more about authentication methods please refer [oci authentication
methods](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm)
OCI has various authentication methods. To learn more about authentication methods
please refer [oci authentication methods](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm)
These choices can be specified in the rclone config file.
Rclone supports the following OCI authentication provider.
@@ -900,4 +900,5 @@ Options:
{{< rem autogenerated options stop >}}
## Tutorials
### [Mounting Buckets](/oracleobjectstorage/tutorial_mount/)

2
docs/content/oracleobjectstorage/tutorial_mount.md
View File

@@ -41,7 +41,7 @@ From repo : ol8_developer
Summary : rsync for cloud storage
URL : http://rclone.org/
License : MIT
Description : Rclone is a command line program to sync files and directories to and from various cloud services.
Description : Rclone is a command line program to sync files and directories to and from various cloud services.
```
To run it as a mount helper you should symlink rclone binary to /sbin/mount.rclone

8
docs/content/pcloud.md
View File

@@ -161,15 +161,17 @@ The command will enumerate available directories, allowing you to locate the
appropriate Folder ID for subsequent use.
Example:
```
```console
$ rclone lsf --dirs-only -Fip --csv TestPcloud:
dxxxxxxxx2,My Music/
dxxxxxxxx3,My Pictures/
dxxxxxxxx4,My Videos/
```
So if the folder you want rclone to use your is "My Music/", then use the returned id from ```rclone lsf``` command (ex. `dxxxxxxxx2`) as
the `root_folder_id` variable value in the config file.
So if the folder you want rclone to use your is "My Music/", then use the returned
id from ```rclone lsf``` command (ex. `dxxxxxxxx2`) as the `root_folder_id` variable
value in the config file.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/pcloud/pcloud.go then run make backenddocs" >}}
### Standard options

6
docs/content/remote_setup.md
View File

@@ -16,7 +16,8 @@ three ways of doing it, described below.
## Configuring using rclone authorize
On the headless machine run [rclone config](/commands/rclone_config), but
answer `N` to the question `Use web browser to automatically authenticate rclone with remote?`.
answer `N` to the question `Use web browser to automatically authenticate
rclone with remote?`.
```text
Use web browser to automatically authenticate rclone with remote?
@@ -108,7 +109,8 @@ ssh -L localhost:53682:localhost:53682 username@remote_server
```
Then on the headless machine run [rclone config](/commands/rclone_config) and
answer `Y` to the question `Use web browser to automatically authenticate rclone with remote?`.
answer `Y` to the question `Use web browser to automatically authenticate rclone
with remote?`.
```text
Use web browser to automatically authenticate rclone with remote?

4
docs/content/webdav.md
View File

@@ -531,7 +531,7 @@ installed and configured, an access token is obtained by running the
`oidc-token` command. The following example shows a (shortened)
access token obtained from the *XDC* OIDC Provider.
```
```text
paul@celebrimbor:~$ oidc-token XDC
eyJraWQ[...]QFXDt0
paul@celebrimbor:~$
@@ -555,7 +555,7 @@ edit the advanced config and enter the command to get a bearer token
The following example config shows a WebDAV endpoint that uses
oidc-agent to supply an access token from the *XDC* OIDC Provider.
```
```ini
[dcache]
type = webdav
url = https://dcache.example.org/