docs: fix various typos
This commit is contained in:
parent
6fb1c8f51c
commit
3d424c6e08
17 changed files with 32 additions and 32 deletions
|
@ -135,7 +135,7 @@ then change into the project root and run
|
||||||
|
|
||||||
make test
|
make test
|
||||||
|
|
||||||
This command is run daily on the the integration test server. You can
|
This command is run daily on the integration test server. You can
|
||||||
find the results at https://pub.rclone.org/integration-tests/
|
find the results at https://pub.rclone.org/integration-tests/
|
||||||
|
|
||||||
## Code Organisation ##
|
## Code Organisation ##
|
||||||
|
|
|
@ -577,7 +577,7 @@ Eg
|
||||||
37600 fubuwic
|
37600 fubuwic
|
||||||
|
|
||||||
|
|
||||||
Any of the filtering options can be applied to this commmand.
|
Any of the filtering options can be applied to this command.
|
||||||
|
|
||||||
There are several related list commands
|
There are several related list commands
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,7 @@ eg `remote:directory/subdirectory` or `/directory/subdirectory`.
|
||||||
During the initial setup with `rclone config` you will specify the target
|
During the initial setup with `rclone config` you will specify the target
|
||||||
remote. The target remote can either be a local path or another remote.
|
remote. The target remote can either be a local path or another remote.
|
||||||
|
|
||||||
Subfolders can be used in target remote. Asume a alias remote named `backup`
|
Subfolders can be used in target remote. Assume a alias remote named `backup`
|
||||||
with the target `mydrive:private/backup`. Invoking `rclone mkdir backup:desktop`
|
with the target `mydrive:private/backup`. Invoking `rclone mkdir backup:desktop`
|
||||||
is exactly the same as invoking `rclone mkdir mydrive:private/backup/desktop`.
|
is exactly the same as invoking `rclone mkdir mydrive:private/backup/desktop`.
|
||||||
|
|
||||||
|
|
|
@ -270,7 +270,7 @@ start and finish the upload) and another 2 requests for each chunk:
|
||||||
|
|
||||||
#### Versions ####
|
#### Versions ####
|
||||||
|
|
||||||
Versions can be viewd with the `--b2-versions` flag. When it is set
|
Versions can be viewed with the `--b2-versions` flag. When it is set
|
||||||
rclone will show and act on older versions of files. For example
|
rclone will show and act on older versions of files. For example
|
||||||
|
|
||||||
Listing without `--b2-versions`
|
Listing without `--b2-versions`
|
||||||
|
|
|
@ -262,7 +262,7 @@ There is an issue with wrapping the remotes in this order:
|
||||||
During testing, I experienced a lot of bans with the remotes in this order.
|
During testing, I experienced a lot of bans with the remotes in this order.
|
||||||
I suspect it might be related to how crypt opens files on the cloud provider
|
I suspect it might be related to how crypt opens files on the cloud provider
|
||||||
which makes it think we're downloading the full file instead of small chunks.
|
which makes it think we're downloading the full file instead of small chunks.
|
||||||
Organizing the remotes in this order yelds better results:
|
Organizing the remotes in this order yields better results:
|
||||||
<span style="color:green">**cloud remote** -> **cache** -> **crypt**</span>
|
<span style="color:green">**cloud remote** -> **cache** -> **crypt**</span>
|
||||||
|
|
||||||
#### absolute remote paths ####
|
#### absolute remote paths ####
|
||||||
|
|
|
@ -17,11 +17,11 @@ You can use it like this to output a single file
|
||||||
|
|
||||||
rclone cat remote:path/to/file
|
rclone cat remote:path/to/file
|
||||||
|
|
||||||
Or like this to output any file in dir or subdirectories.
|
Or like this to output any file in dir or its subdirectories.
|
||||||
|
|
||||||
rclone cat remote:path/to/dir
|
rclone cat remote:path/to/dir
|
||||||
|
|
||||||
Or like this to output any .txt files in dir or subdirectories.
|
Or like this to output any .txt files in dir or its subdirectories.
|
||||||
|
|
||||||
rclone --include "*.txt" cat remote:path/to/dir
|
rclone --include "*.txt" cat remote:path/to/dir
|
||||||
|
|
||||||
|
|
|
@ -18,7 +18,7 @@ For example to update the env_auth field of a remote of name myremote you would
|
||||||
|
|
||||||
rclone config update myremote swift env_auth true
|
rclone config update myremote swift env_auth true
|
||||||
|
|
||||||
If the remote uses oauth the token will be updated, if you don't
|
If the remote uses OAuth the token will be updated, if you don't
|
||||||
require this add an extra parameter thus:
|
require this add an extra parameter thus:
|
||||||
|
|
||||||
rclone config update myremote swift env_auth true config_refresh_token false
|
rclone config update myremote swift env_auth true config_refresh_token false
|
||||||
|
|
|
@ -11,8 +11,8 @@ Copy url content to dest.
|
||||||
### Synopsis
|
### Synopsis
|
||||||
|
|
||||||
|
|
||||||
Download urls content and copy it to destination
|
Download url's content and copy it to destination
|
||||||
without saving it in tmp storage.
|
without saving it in temporary storage.
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
@ -348,7 +348,7 @@ It is also possible to specify a "timetable" of limits, which will cause
|
||||||
certain limits to be applied at certain times. To specify a timetable, format your
|
certain limits to be applied at certain times. To specify a timetable, format your
|
||||||
entries as "WEEKDAY-HH:MM,BANDWIDTH WEEKDAY-HH:MM,BANDWIDTH..." where:
|
entries as "WEEKDAY-HH:MM,BANDWIDTH WEEKDAY-HH:MM,BANDWIDTH..." where:
|
||||||
WEEKDAY is optional element.
|
WEEKDAY is optional element.
|
||||||
It could be writen as whole world or only using 3 first characters.
|
It could be written as whole world or only using 3 first characters.
|
||||||
HH:MM is an hour from 00:00 to 23:59.
|
HH:MM is an hour from 00:00 to 23:59.
|
||||||
|
|
||||||
An example of a typical timetable to avoid link saturation during daytime
|
An example of a typical timetable to avoid link saturation during daytime
|
||||||
|
@ -366,7 +366,7 @@ An example of timetable with WEEKDAY could be:
|
||||||
|
|
||||||
`--bwlimit "Mon-00:00,512 Fri-23:59,10M Sat-10:00,1M Sun-20:00,off"`
|
`--bwlimit "Mon-00:00,512 Fri-23:59,10M Sat-10:00,1M Sun-20:00,off"`
|
||||||
|
|
||||||
It mean that, the transfer bandwidh will be set to 512kBytes/sec on Monday.
|
It mean that, the transfer bandwidth will be set to 512kBytes/sec on Monday.
|
||||||
It will raise to 10Mbytes/s before the end of Friday.
|
It will raise to 10Mbytes/s before the end of Friday.
|
||||||
At 10:00 on Sunday it will be set to 1Mbyte/s.
|
At 10:00 on Sunday it will be set to 1Mbyte/s.
|
||||||
From 20:00 at Sunday will be unlimited.
|
From 20:00 at Sunday will be unlimited.
|
||||||
|
|
|
@ -162,7 +162,7 @@ directories.
|
||||||
### Root folder ID ###
|
### Root folder ID ###
|
||||||
|
|
||||||
You can set the `root_folder_id` for rclone. This is the directory
|
You can set the `root_folder_id` for rclone. This is the directory
|
||||||
(identified by its `Folder ID`) that rclone considers to be a the root
|
(identified by its `Folder ID`) that rclone considers to be the root
|
||||||
of your drive.
|
of your drive.
|
||||||
|
|
||||||
Normally you will leave this blank and rclone will determine the
|
Normally you will leave this blank and rclone will determine the
|
||||||
|
@ -321,7 +321,7 @@ docs](/docs/#fast-list) for more details.
|
||||||
It does this by combining multiple `list` calls into a single API request.
|
It does this by combining multiple `list` calls into a single API request.
|
||||||
|
|
||||||
This works by combining many `'%s' in parents` filters into one expression.
|
This works by combining many `'%s' in parents` filters into one expression.
|
||||||
To list the contents of directories a, b and c, the the following requests will be send by the regular `List` function:
|
To list the contents of directories a, b and c, the following requests will be send by the regular `List` function:
|
||||||
```
|
```
|
||||||
trashed=false and 'a' in parents
|
trashed=false and 'a' in parents
|
||||||
trashed=false and 'b' in parents
|
trashed=false and 'b' in parents
|
||||||
|
@ -407,7 +407,7 @@ pdf`, or if you prefer openoffice/libreoffice formats you might use
|
||||||
`--drive-export-formats ods,odt,odp`.
|
`--drive-export-formats ods,odt,odp`.
|
||||||
|
|
||||||
Note that rclone adds the extension to the google doc, so if it is
|
Note that rclone adds the extension to the google doc, so if it is
|
||||||
calles `My Spreadsheet` on google docs, it will be exported as `My
|
called `My Spreadsheet` on google docs, it will be exported as `My
|
||||||
Spreadsheet.xlsx` or `My Spreadsheet.pdf` etc.
|
Spreadsheet.xlsx` or `My Spreadsheet.pdf` etc.
|
||||||
|
|
||||||
When importing files into Google Drive, rclone will conververt all
|
When importing files into Google Drive, rclone will conververt all
|
||||||
|
@ -417,7 +417,7 @@ rclone will not convert any files by default, since the conversion
|
||||||
is lossy process.
|
is lossy process.
|
||||||
|
|
||||||
The conversion must result in a file with the same extension when
|
The conversion must result in a file with the same extension when
|
||||||
the `--drive-export-formats` rules are applied to the uploded document.
|
the `--drive-export-formats` rules are applied to the uploaded document.
|
||||||
|
|
||||||
Here are some examples for allowed and prohibited conversions.
|
Here are some examples for allowed and prohibited conversions.
|
||||||
|
|
||||||
|
@ -434,7 +434,7 @@ Here are some examples for allowed and prohibited conversions.
|
||||||
This limitation can be disabled by specifying `--drive-allow-import-name-change`.
|
This limitation can be disabled by specifying `--drive-allow-import-name-change`.
|
||||||
When using this flag, rclone can convert multiple files types resulting
|
When using this flag, rclone can convert multiple files types resulting
|
||||||
in the same document type at once, eg with `--drive-import-formats docx,odt,txt`,
|
in the same document type at once, eg with `--drive-import-formats docx,odt,txt`,
|
||||||
all files having these extension would result in a doument represented as a docx file.
|
all files having these extension would result in a document represented as a docx file.
|
||||||
This brings the additional risk of overwriting a document, if multiple files
|
This brings the additional risk of overwriting a document, if multiple files
|
||||||
have the same stem. Many rclone operations will not handle this name change
|
have the same stem. Many rclone operations will not handle this name change
|
||||||
in any way. They assume an equal name when copying files and might copy the
|
in any way. They assume an equal name when copying files and might copy the
|
||||||
|
@ -446,7 +446,7 @@ listed here. Some of these additional ones might only be available when
|
||||||
the operating system provides the correct MIME type entries.
|
the operating system provides the correct MIME type entries.
|
||||||
|
|
||||||
This list can be changed by Google Drive at any time and might not
|
This list can be changed by Google Drive at any time and might not
|
||||||
represent the currently available converions.
|
represent the currently available conversions.
|
||||||
|
|
||||||
| Extension | Mime Type | Description |
|
| Extension | Mime Type | Description |
|
||||||
| --------- |-----------| ------------|
|
| --------- |-----------| ------------|
|
||||||
|
@ -470,8 +470,8 @@ represent the currently available converions.
|
||||||
| xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | Microsoft Office Spreadsheet |
|
| xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | Microsoft Office Spreadsheet |
|
||||||
| zip | application/zip | A ZIP file of HTML, Images CSS |
|
| zip | application/zip | A ZIP file of HTML, Images CSS |
|
||||||
|
|
||||||
Google douments can also be exported as link files. These files will
|
Google documents can also be exported as link files. These files will
|
||||||
open a browser window for the Google Docs website of that dument
|
open a browser window for the Google Docs website of that document
|
||||||
when opened. The link file extension has to be specified as a
|
when opened. The link file extension has to be specified as a
|
||||||
`--drive-export-formats` parameter. They will match all available
|
`--drive-export-formats` parameter. They will match all available
|
||||||
Google Documents.
|
Google Documents.
|
||||||
|
|
|
@ -60,7 +60,7 @@ A `?` matches any character except a slash `/`.
|
||||||
- matches "lass"
|
- matches "lass"
|
||||||
- doesn't match "floss"
|
- doesn't match "floss"
|
||||||
|
|
||||||
A `[` and `]` together make a a character class, such as `[a-z]` or
|
A `[` and `]` together make a character class, such as `[a-z]` or
|
||||||
`[aeiou]` or `[[:alpha:]]`. See the [go regexp
|
`[aeiou]` or `[[:alpha:]]`. See the [go regexp
|
||||||
docs](https://golang.org/pkg/regexp/syntax/) for more info on these.
|
docs](https://golang.org/pkg/regexp/syntax/) for more info on these.
|
||||||
|
|
||||||
|
|
|
@ -122,7 +122,7 @@ The modified time is stored as metadata on the object as
|
||||||
`X-Object-Meta-Mtime` as floating point since the epoch accurate to 1
|
`X-Object-Meta-Mtime` as floating point since the epoch accurate to 1
|
||||||
ns.
|
ns.
|
||||||
|
|
||||||
This is a defacto standard (used in the official python-swiftclient
|
This is a de facto standard (used in the official python-swiftclient
|
||||||
amongst others) for storing the modification time for an object.
|
amongst others) for storing the modification time for an object.
|
||||||
|
|
||||||
Note that Hubic wraps the Swift backend, so most of the properties of
|
Note that Hubic wraps the Swift backend, so most of the properties of
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
# error codes
|
# error codes
|
||||||
# 0 - exited without problems
|
# 0 - exited without problems
|
||||||
# 1 - parameters not supported were used or some unexpected error occured
|
# 1 - parameters not supported were used or some unexpected error occurred
|
||||||
# 2 - OS not supported by this script
|
# 2 - OS not supported by this script
|
||||||
# 3 - installed version of rclone is up to date
|
# 3 - installed version of rclone is up to date
|
||||||
# 4 - supported unzip tools are not available
|
# 4 - supported unzip tools are not available
|
||||||
|
@ -142,7 +142,7 @@ esac
|
||||||
cd $unzip_dir/*
|
cd $unzip_dir/*
|
||||||
|
|
||||||
|
|
||||||
#mounting rclone to enviroment
|
#mounting rclone to environment
|
||||||
|
|
||||||
case $OS in
|
case $OS in
|
||||||
'linux')
|
'linux')
|
||||||
|
|
|
@ -274,9 +274,9 @@ upload files bigger than 5GB.
|
||||||
Note that files uploaded *both* with multipart upload *and* through
|
Note that files uploaded *both* with multipart upload *and* through
|
||||||
crypt remotes do not have MD5 sums.
|
crypt remotes do not have MD5 sums.
|
||||||
|
|
||||||
Rclone switches from single part uploads to multipart uploads at the
|
rclone switches from single part uploads to multipart uploads at the
|
||||||
point specified by `--s3-upload-cutoff`. This can be a maximum of 5GB
|
point specified by `--s3-upload-cutoff`. This can be a maximum of 5GB
|
||||||
and a minimum of 0 (ie always upload mulipart files).
|
and a minimum of 0 (ie always upload multipart files).
|
||||||
|
|
||||||
The chunk sizes used in the multipart upload are specified by
|
The chunk sizes used in the multipart upload are specified by
|
||||||
`--s3-chunk-size` and the number of chunks uploaded concurrently is
|
`--s3-chunk-size` and the number of chunks uploaded concurrently is
|
||||||
|
@ -292,7 +292,7 @@ single part transfers will be faster.
|
||||||
|
|
||||||
Increasing `--s3-upload-concurrency` will increase throughput (8 would
|
Increasing `--s3-upload-concurrency` will increase throughput (8 would
|
||||||
be a sensible value) and increasing `--s3-chunk-size` also increases
|
be a sensible value) and increasing `--s3-chunk-size` also increases
|
||||||
througput (16M would be sensible). Increasing either of these will
|
throughput (16M would be sensible). Increasing either of these will
|
||||||
use more memory. The default values are high enough to gain most of
|
use more memory. The default values are high enough to gain most of
|
||||||
the possible performance without using too much memory.
|
the possible performance without using too much memory.
|
||||||
|
|
||||||
|
@ -1172,7 +1172,7 @@ storage_class =
|
||||||
|
|
||||||
To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the "[Applications & API](https://cloud.digitalocean.com/settings/api/tokens)" page of the DigitalOcean control panel. They will be needed when promted by `rclone config` for your `access_key_id` and `secret_access_key`.
|
To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the "[Applications & API](https://cloud.digitalocean.com/settings/api/tokens)" page of the DigitalOcean control panel. They will be needed when promted by `rclone config` for your `access_key_id` and `secret_access_key`.
|
||||||
|
|
||||||
When prompted for a `region` or `location_constraint`, press enter to use the default value. The region must be included in the `endpoint` setting (e.g. `nyc3.digitaloceanspaces.com`). The defualt values can be used for other settings.
|
When prompted for a `region` or `location_constraint`, press enter to use the default value. The region must be included in the `endpoint` setting (e.g. `nyc3.digitaloceanspaces.com`). The default values can be used for other settings.
|
||||||
|
|
||||||
Going through the whole process of creating a new remote by running `rclone config`, each prompt should be answered as shown below:
|
Going through the whole process of creating a new remote by running `rclone config`, each prompt should be answered as shown below:
|
||||||
|
|
||||||
|
|
|
@ -173,9 +173,9 @@ excess files in the container.
|
||||||
|
|
||||||
rclone sync /home/local/directory remote:container
|
rclone sync /home/local/directory remote:container
|
||||||
|
|
||||||
### Configuration from an Openstack credentials file ###
|
### Configuration from an OpenStack credentials file ###
|
||||||
|
|
||||||
An Opentstack credentials file typically looks something something
|
An OpenStack credentials file typically looks something something
|
||||||
like this (without the comments)
|
like this (without the comments)
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
@ -20,7 +20,7 @@ The last remote is the topmost remote and replaces files with the same name from
|
||||||
|
|
||||||
Only the last remote is used to write to and delete from, all other remotes are read-only.
|
Only the last remote is used to write to and delete from, all other remotes are read-only.
|
||||||
|
|
||||||
Subfolders can be used in target remote. Asume a union remote named `backup`
|
Subfolders can be used in target remote. Assume a union remote named `backup`
|
||||||
with the remotes `mydrive:private/backup mydrive2:/backup`. Invoking `rclone mkdir backup:desktop`
|
with the remotes `mydrive:private/backup mydrive2:/backup`. Invoking `rclone mkdir backup:desktop`
|
||||||
is exactly the same as invoking `rclone mkdir mydrive2:/backup/desktop`.
|
is exactly the same as invoking `rclone mkdir mydrive2:/backup/desktop`.
|
||||||
|
|
||||||
|
|
|
@ -100,7 +100,7 @@ Plain WebDAV does not support modified times. However when used with
|
||||||
Owncloud or Nextcloud rclone will support modified times.
|
Owncloud or Nextcloud rclone will support modified times.
|
||||||
|
|
||||||
Likewise plain WebDAV does not support hashes, however when used with
|
Likewise plain WebDAV does not support hashes, however when used with
|
||||||
Owncloud or Nexcloud rclone will support SHA1 and MD5 hashes.
|
Owncloud or Nextcloud rclone will support SHA1 and MD5 hashes.
|
||||||
Depending on the exact version of Owncloud or Nextcloud hashes may
|
Depending on the exact version of Owncloud or Nextcloud hashes may
|
||||||
appear on all objects, or only on objects which had a hash uploaded
|
appear on all objects, or only on objects which had a hash uploaded
|
||||||
with them.
|
with them.
|
||||||
|
|
Loading…
Reference in a new issue