From 3d424c6e08eb70b784f122dd19ea69e94e013833 Mon Sep 17 00:00:00 2001 From: Ben Boeckel Date: Wed, 27 Mar 2019 15:12:24 -0400 Subject: [PATCH] docs: fix various typos --- CONTRIBUTING.md | 2 +- MANUAL.md | 2 +- docs/content/alias.md | 2 +- docs/content/b2.md | 2 +- docs/content/cache.md | 2 +- docs/content/commands/rclone_cat.md | 4 ++-- docs/content/commands/rclone_config_update.md | 2 +- docs/content/commands/rclone_copyurl.md | 4 ++-- docs/content/docs.md | 4 ++-- docs/content/drive.md | 16 ++++++++-------- docs/content/filtering.md | 2 +- docs/content/hubic.md | 2 +- docs/content/install.sh | 4 ++-- docs/content/s3.md | 8 ++++---- docs/content/swift.md | 4 ++-- docs/content/union.md | 2 +- docs/content/webdav.md | 2 +- 17 files changed, 32 insertions(+), 32 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc7ef343c..551537a87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -135,7 +135,7 @@ then change into the project root and run 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/ ## Code Organisation ## diff --git a/MANUAL.md b/MANUAL.md index 516bd63be..19cdbbe9e 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -577,7 +577,7 @@ Eg 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 diff --git a/docs/content/alias.md b/docs/content/alias.md index 24a3cf897..01a791c9c 100644 --- a/docs/content/alias.md +++ b/docs/content/alias.md @@ -15,7 +15,7 @@ eg `remote:directory/subdirectory` or `/directory/subdirectory`. 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. -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` is exactly the same as invoking `rclone mkdir mydrive:private/backup/desktop`. diff --git a/docs/content/b2.md b/docs/content/b2.md index 11f23a4c8..08cc5ebcb 100644 --- a/docs/content/b2.md +++ b/docs/content/b2.md @@ -270,7 +270,7 @@ start and finish the upload) and another 2 requests for each chunk: #### 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 Listing without `--b2-versions` diff --git a/docs/content/cache.md b/docs/content/cache.md index cc9bde8b5..836667a0a 100644 --- a/docs/content/cache.md +++ b/docs/content/cache.md @@ -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. 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. -Organizing the remotes in this order yelds better results: +Organizing the remotes in this order yields better results: **cloud remote** -> **cache** -> **crypt** #### absolute remote paths #### diff --git a/docs/content/commands/rclone_cat.md b/docs/content/commands/rclone_cat.md index be35ac273..42ea5dcfb 100644 --- a/docs/content/commands/rclone_cat.md +++ b/docs/content/commands/rclone_cat.md @@ -17,11 +17,11 @@ You can use it like this to output a single 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 -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 diff --git a/docs/content/commands/rclone_config_update.md b/docs/content/commands/rclone_config_update.md index 656efdcac..fc1d48231 100644 --- a/docs/content/commands/rclone_config_update.md +++ b/docs/content/commands/rclone_config_update.md @@ -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 -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: rclone config update myremote swift env_auth true config_refresh_token false diff --git a/docs/content/commands/rclone_copyurl.md b/docs/content/commands/rclone_copyurl.md index b8ff856c5..95290f71b 100644 --- a/docs/content/commands/rclone_copyurl.md +++ b/docs/content/commands/rclone_copyurl.md @@ -11,8 +11,8 @@ Copy url content to dest. ### Synopsis -Download urls content and copy it to destination -without saving it in tmp storage. +Download url's content and copy it to destination +without saving it in temporary storage. ``` diff --git a/docs/content/docs.md b/docs/content/docs.md index a1dd245f9..d77b2e103 100644 --- a/docs/content/docs.md +++ b/docs/content/docs.md @@ -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 entries as "WEEKDAY-HH:MM,BANDWIDTH WEEKDAY-HH:MM,BANDWIDTH..." where: 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. 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"` -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. At 10:00 on Sunday it will be set to 1Mbyte/s. From 20:00 at Sunday will be unlimited. diff --git a/docs/content/drive.md b/docs/content/drive.md index 723871bc7..3bd7763ee 100644 --- a/docs/content/drive.md +++ b/docs/content/drive.md @@ -162,7 +162,7 @@ directories. ### Root folder ID ### 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. 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. 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 'b' in parents @@ -407,7 +407,7 @@ pdf`, or if you prefer openoffice/libreoffice formats you might use `--drive-export-formats ods,odt,odp`. 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. 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. 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. @@ -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`. 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`, -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 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 @@ -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. 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 | | --------- |-----------| ------------| @@ -470,8 +470,8 @@ represent the currently available converions. | xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | Microsoft Office Spreadsheet | | zip | application/zip | A ZIP file of HTML, Images CSS | -Google douments can also be exported as link files. These files will -open a browser window for the Google Docs website of that dument +Google documents can also be exported as link files. These files will +open a browser window for the Google Docs website of that document when opened. The link file extension has to be specified as a `--drive-export-formats` parameter. They will match all available Google Documents. diff --git a/docs/content/filtering.md b/docs/content/filtering.md index 2c2dd587b..783e97a5f 100644 --- a/docs/content/filtering.md +++ b/docs/content/filtering.md @@ -60,7 +60,7 @@ A `?` matches any character except a slash `/`. - matches "lass" - 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 docs](https://golang.org/pkg/regexp/syntax/) for more info on these. diff --git a/docs/content/hubic.md b/docs/content/hubic.md index bc02ee0d4..d7ae9a18f 100644 --- a/docs/content/hubic.md +++ b/docs/content/hubic.md @@ -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 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. Note that Hubic wraps the Swift backend, so most of the properties of diff --git a/docs/content/install.sh b/docs/content/install.sh index 33f93e60d..60714ab25 100755 --- a/docs/content/install.sh +++ b/docs/content/install.sh @@ -2,7 +2,7 @@ # error codes # 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 # 3 - installed version of rclone is up to date # 4 - supported unzip tools are not available @@ -142,7 +142,7 @@ esac cd $unzip_dir/* -#mounting rclone to enviroment +#mounting rclone to environment case $OS in 'linux') diff --git a/docs/content/s3.md b/docs/content/s3.md index fe3e7db4d..4754457f7 100644 --- a/docs/content/s3.md +++ b/docs/content/s3.md @@ -274,9 +274,9 @@ upload files bigger than 5GB. Note that files uploaded *both* with multipart upload *and* through 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 -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 `--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 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 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`. -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: diff --git a/docs/content/swift.md b/docs/content/swift.md index ce809c8fd..5a1858f11 100644 --- a/docs/content/swift.md +++ b/docs/content/swift.md @@ -173,9 +173,9 @@ excess files in the 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) ``` diff --git a/docs/content/union.md b/docs/content/union.md index 1c77702b4..3f5805358 100644 --- a/docs/content/union.md +++ b/docs/content/union.md @@ -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. -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` is exactly the same as invoking `rclone mkdir mydrive2:/backup/desktop`. diff --git a/docs/content/webdav.md b/docs/content/webdav.md index 6662aabe3..e8a7f277b 100644 --- a/docs/content/webdav.md +++ b/docs/content/webdav.md @@ -100,7 +100,7 @@ Plain WebDAV does not support modified times. However when used with Owncloud or Nextcloud rclone will support modified times. 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 appear on all objects, or only on objects which had a hash uploaded with them.