Tidy the help

This commit is contained in:
Nick Craig-Wood 2014-03-16 00:28:32 +00:00
parent fec3661fe1
commit 5575ee2933

View File

@ -49,6 +49,7 @@ rclone config
Here is an example of making an s3 configuration
```
$ rclone config
No remotes found - make a new one
n) New remote
q) Quit config
@ -126,6 +127,8 @@ rclone ls remote:// - list a bucket
rclone sync /home/local/directory remote://bucket
```
See the next section for more details.
Usage
-----
@ -135,8 +138,10 @@ Its basic syntax is like this
Syntax: [options] subcommand <parameters> <parameters...>
Each subcommand looks like this. See below for how to specify the
source and destination paths.
See below for how to specify the source and destination paths.
Subcommands
-----------
rclone copy source://path dest://path
@ -180,17 +185,17 @@ compares sizes and MD5SUMs and prints a report of files which
don't match. It doesn't alter the source or destination.
General options:
-config Location of the config file
-transfers=4: Number of file transfers to run in parallel.
-checkers=8: Number of MD5SUM checkers to run in parallel.
-dry-run=false: Do a trial run with no permanent changes
-modify-window=1ns: Max time difference to be considered the same - this is automatically set usually
-quiet=false: Print as little stuff as possible
-stats=1m0s: Interval to print stats
-verbose=false: Print lots more stuff
* `-config` Location of the config file
* `-transfers=4`: Number of file transfers to run in parallel.
* `-checkers=8`: Number of MD5SUM checkers to run in parallel.
* `-dry-run=false`: Do a trial run with no permanent changes
* `-modify-window=1ns`: Max time difference to be considered the same - this is automatically set usually
* `-quiet=false`: Print as little stuff as possible
* `-stats=1m0s`: Interval to print stats
* `-verbose=false`: Print lots more stuff
Developer options:
-cpuprofile="": Write cpu profile to file
* `-cpuprofile=""`: Write cpu profile to file
Local Filesystem
----------------
@ -204,15 +209,15 @@ Will sync source to destination
Swift / Rackspace cloudfiles / Memset Memstore
----------------------------------------------
Paths are specified as remote://container or remote:// for the lsd
command.
Paths are specified as remote://container (or remote:// for the `lsd`
command.)
So to copy a local directory to a swift container called backup
So to copy a local directory to a swift container called backup:
rclone sync /home/source swift://backup
The modified time is stored as metadata on the object as
'X-Object-Meta-Mtime' as floating point since the epoch.
`X-Object-Meta-Mtime` as floating point since the epoch.
This is a defacto standard (used in the official python-swiftclient
amongst others) for storing the modification time (as read using
@ -228,7 +233,7 @@ So to copy a local directory to a s3 container called backup
rclone sync /home/source s3://backup
The modified time is stored as metadata on the object as
"X-Amz-Meta-Mtime" as floating point since the epoch.
`X-Amz-Meta-Mtime` as floating point since the epoch.
Google drive
------------