mirror of
https://github.com/rclone/rclone.git
synced 2025-12-10 05:13:45 +00:00
docs: improve grammar and fix typos (#5361)
This alters some comments in source files, but is interested mainly in documentation files and help messages.
This commit is contained in:
Atílio Antônio
GitHub
@@ -278,7 +278,7 @@ This will make `parameter` be `with"quote` and `parameter2` be
|
||||
`with'quote`.
|
||||
|
||||
If you leave off the `=parameter` then rclone will substitute `=true`
|
||||
which works very well with flags. For example to use s3 configured in
|
||||
which works very well with flags. For example, to use s3 configured in
|
||||
the environment you could use:
|
||||
|
||||
rclone lsd :s3,env_auth:
|
||||
@@ -485,7 +485,7 @@ it will give an error.
|
||||
This option controls the bandwidth limit. For example
|
||||
|
||||
--bwlimit 10M
|
||||
|
||||
|
||||
would mean limit the upload and download bandwidth to 10 MiB/s.
|
||||
**NB** this is **bytes** per second not **bits** per second. To use a
|
||||
single limit, specify the desired bandwidth in KiB/s, or use a
|
||||
@@ -664,12 +664,12 @@ they are incorrect as it would normally.
|
||||
|
||||
### --compare-dest=DIR ###
|
||||
|
||||
When using `sync`, `copy` or `move` DIR is checked in addition to the
|
||||
destination for files. If a file identical to the source is found that
|
||||
file is NOT copied from source. This is useful to copy just files that
|
||||
When using `sync`, `copy` or `move` DIR is checked in addition to the
|
||||
destination for files. If a file identical to the source is found that
|
||||
file is NOT copied from source. This is useful to copy just files that
|
||||
have changed since the last backup.
|
||||
|
||||
You must use the same remote as the destination of the sync. The
|
||||
You must use the same remote as the destination of the sync. The
|
||||
compare directory must not overlap the destination directory.
|
||||
|
||||
See `--copy-dest` and `--backup-dir`.
|
||||
@@ -772,9 +772,9 @@ connection to go through to a remote object storage system. It is
|
||||
|
||||
### --copy-dest=DIR ###
|
||||
|
||||
When using `sync`, `copy` or `move` DIR is checked in addition to the
|
||||
destination for files. If a file identical to the source is found that
|
||||
file is server-side copied from DIR to the destination. This is useful
|
||||
When using `sync`, `copy` or `move` DIR is checked in addition to the
|
||||
destination for files. If a file identical to the source is found that
|
||||
file is server-side copied from DIR to the destination. This is useful
|
||||
for incremental backup.
|
||||
|
||||
The remote in use must support server-side copy and you must
|
||||
@@ -951,7 +951,7 @@ default, and responds to key `u` for toggling human-readable format.
|
||||
|
||||
### --ignore-case-sync ###
|
||||
|
||||
Using this option will cause rclone to ignore the case of the files
|
||||
Using this option will cause rclone to ignore the case of the files
|
||||
when synchronizing so files will not be copied/synced when the
|
||||
existing filenames are the same, even if the casing is different.
|
||||
|
||||
@@ -1097,7 +1097,7 @@ warnings and significant events.
|
||||
|
||||
### --use-json-log ###
|
||||
|
||||
This switches the log format to JSON for rclone. The fields of json log
|
||||
This switches the log format to JSON for rclone. The fields of json log
|
||||
are level, msg, source, time.
|
||||
|
||||
### --low-level-retries NUMBER ###
|
||||
@@ -1479,7 +1479,7 @@ Disable retries with `--retries 1`.
|
||||
|
||||
### --retries-sleep=TIME ###
|
||||
|
||||
This sets the interval between each retry specified by `--retries`
|
||||
This sets the interval between each retry specified by `--retries`
|
||||
|
||||
The default is `0`. Use `0` to disable.
|
||||
|
||||
@@ -1516,9 +1516,9 @@ Note that on macOS you can send a SIGINFO (which is normally ctrl-T in
|
||||
the terminal) to make the stats print immediately.
|
||||
|
||||
### --stats-file-name-length integer ###
|
||||
By default, the `--stats` output will truncate file names and paths longer
|
||||
than 40 characters. This is equivalent to providing
|
||||
`--stats-file-name-length 40`. Use `--stats-file-name-length 0` to disable
|
||||
By default, the `--stats` output will truncate file names and paths longer
|
||||
than 40 characters. This is equivalent to providing
|
||||
`--stats-file-name-length 40`. Use `--stats-file-name-length 0` to disable
|
||||
any truncation of file names printed by stats.
|
||||
|
||||
### --stats-log-level string ###
|
||||
@@ -1562,14 +1562,14 @@ The default is `bytes`.
|
||||
### --suffix=SUFFIX ###
|
||||
|
||||
When using `sync`, `copy` or `move` any files which would have been
|
||||
overwritten or deleted will have the suffix added to them. If there
|
||||
is a file with the same path (after the suffix has been added), then
|
||||
overwritten or deleted will have the suffix added to them. If there
|
||||
is a file with the same path (after the suffix has been added), then
|
||||
it will be overwritten.
|
||||
|
||||
The remote in use must support server-side move or copy and you must
|
||||
use the same remote as the destination of the sync.
|
||||
|
||||
This is for use with files to add the suffix in the current directory
|
||||
This is for use with files to add the suffix in the current directory
|
||||
or with `--backup-dir`. See `--backup-dir` for more info.
|
||||
|
||||
For example
|
||||
@@ -1633,7 +1633,7 @@ will depend on the backend. For HTTP based backends it is an HTTP
|
||||
PUT/GET/POST/etc and its response. For FTP/SFTP it is a round trip
|
||||
transaction over TCP.
|
||||
|
||||
For example to limit rclone to 10 transactions per second use
|
||||
For example, to limit rclone to 10 transactions per second use
|
||||
`--tpslimit 10`, or to 1 transaction every 2 seconds use `--tpslimit
|
||||
0.5`.
|
||||
|
||||
@@ -1749,7 +1749,7 @@ quickly using the least amount of memory.
|
||||
|
||||
However, some remotes have a way of listing all files beneath a
|
||||
directory in one (or a small number) of transactions. These tend to
|
||||
be the bucket based remotes (e.g. S3, B2, GCS, Swift, Hubic).
|
||||
be the bucket-based remotes (e.g. S3, B2, GCS, Swift, Hubic).
|
||||
|
||||
If you use the `--fast-list` flag then rclone will use this method for
|
||||
listing directories. This will have the following consequences for
|
||||
@@ -1898,8 +1898,8 @@ This option defaults to `false`.
|
||||
|
||||
Configuration Encryption
|
||||
------------------------
|
||||
Your configuration file contains information for logging in to
|
||||
your cloud services. This means that you should keep your
|
||||
Your configuration file contains information for logging in to
|
||||
your cloud services. This means that you should keep your
|
||||
`rclone.conf` file in a secure location.
|
||||
|
||||
If you are in an environment where that isn't possible, you can
|
||||
@@ -1947,8 +1947,8 @@ encryption from your configuration.
|
||||
|
||||
There is no way to recover the configuration if you lose your password.
|
||||
|
||||
rclone uses [nacl secretbox](https://godoc.org/golang.org/x/crypto/nacl/secretbox)
|
||||
which in turn uses XSalsa20 and Poly1305 to encrypt and authenticate
|
||||
rclone uses [nacl secretbox](https://godoc.org/golang.org/x/crypto/nacl/secretbox)
|
||||
which in turn uses XSalsa20 and Poly1305 to encrypt and authenticate
|
||||
your configuration with secret-key cryptography.
|
||||
The password is SHA-256 hashed, which produces the key for secretbox.
|
||||
The hashed password is not stored.
|
||||
@@ -2000,8 +2000,8 @@ script method of supplying the password enhances the security of
|
||||
the config password considerably.
|
||||
|
||||
If you are running rclone inside a script, unless you are using the
|
||||
`--password-command` method, you might want to disable
|
||||
password prompts. To do that, pass the parameter
|
||||
`--password-command` method, you might want to disable
|
||||
password prompts. To do that, pass the parameter
|
||||
`--ask-password=false` to rclone. This will make rclone fail instead
|
||||
of asking for a password if `RCLONE_CONFIG_PASS` doesn't contain
|
||||
a valid password, and `--password-command` has not been supplied.
|
||||
@@ -2039,9 +2039,9 @@ Write CPU profile to file. This can be analysed with `go tool pprof`.
|
||||
The `--dump` flag takes a comma separated list of flags to dump info
|
||||
about.
|
||||
|
||||
Note that some headers including `Accept-Encoding` as shown may not
|
||||
Note that some headers including `Accept-Encoding` as shown may not
|
||||
be correct in the request and the response may not show `Content-Encoding`
|
||||
if the go standard libraries auto gzip encoding was in effect. In this case
|
||||
if the go standard libraries auto gzip encoding was in effect. In this case
|
||||
the body of the request will be gunzipped before showing it.
|
||||
|
||||
The available flags are:
|
||||
@@ -2279,7 +2279,7 @@ this order and the first one with a value is used.
|
||||
- Parameters in connection strings, e.g. `myRemote,skip_links:`
|
||||
- Flag values as supplied on the command line, e.g. `--skip-links`
|
||||
- Remote specific environment vars, e.g. `RCLONE_CONFIG_MYREMOTE_SKIP_LINKS` (see above).
|
||||
- Backend specific environment vars, e.g. `RCLONE_LOCAL_SKIP_LINKS`.
|
||||
- Backend-specific environment vars, e.g. `RCLONE_LOCAL_SKIP_LINKS`.
|
||||
- Backend generic environment vars, e.g. `RCLONE_SKIP_LINKS`.
|
||||
- Config file, e.g. `skip_links = true`.
|
||||
- Default values, e.g. `false` - these can't be changed.
|
||||
|
||||
Reference in New Issue
Block a user