From 580fa3a5a7c9ae9875b7720470b29ebb8c01ab76 Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Sat, 26 Apr 2014 17:43:41 +0100 Subject: [PATCH] Documentation updates --- README.md | 42 ++++++++++++++++++++++------------------- docs/content/about.md | 4 ++-- docs/content/contact.md | 4 ++-- docs/content/docs.md | 8 +++----- docs/content/drive.md | 2 +- docs/content/local.md | 4 ++-- docs/content/s3.md | 2 +- docs/content/swift.md | 2 +- 8 files changed, 35 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index cd9d3665e..45280c795 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Rclone [![Logo](http://rclone.org/img/rclone-120x120.png)](http://rclone.org/) -Sync files and directories to and from +Rclone is a command line program to sync files and directories to and from * Google Drive * Amazon S3 @@ -43,15 +43,13 @@ Or alternatively if you have Go installed use and this will build the binary in `$GOPATH/bin`. -You can then modify the source and submit patches. - Configure --------- First you'll need to configure rclone. As the object storage systems have quite complicated authentication these are kept in a config file `.rclone.conf` in your home directory by default. (You can use the --config option to choose a different config file.) +`--config` option to choose a different config file.) The easiest way to make the config is to run rclone with the config option, Eg @@ -63,7 +61,7 @@ Usage Rclone syncs a directory tree from local to remote. -Its basic syntax is like this +Its basic syntax is Syntax: [options] subcommand @@ -84,7 +82,7 @@ Sync the source to the destination. Doesn't transfer unchanged files, testing first by modification time then by MD5SUM. Deletes any files that exist in source that don't exist in destination. Since this can cause data loss, test -first with the -dry-run flag. +first with the `--dry-run` flag. rclone ls [remote:path] @@ -92,7 +90,7 @@ List all the objects in the the path. rclone lsd [remote:path] -List all directoryes/objects/buckets in the the path. +List all directories/objects/buckets in the the path. rclone mkdir remote:path @@ -114,17 +112,23 @@ 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 + +``` + --checkers=8: Number of checkers to run in parallel. + --config="~/.rclone.conf": Config file. + -n, --dry-run=false: Do a trial run with no permanent changes + --modify-window=1ns: Max time diff to be considered the same + -q, --quiet=false: Print as little stuff as possible + --stats=1m0s: Interval to print stats + --transfers=4: Number of file transfers to run in parallel. + -v, --verbose=false: Print lots more stuff +``` Developer options: - * `-cpuprofile=""`: Write cpu profile to file + +``` + --cpuprofile="": Write cpu profile to file +``` Local Filesystem ---------------- @@ -133,7 +137,7 @@ Paths are specified as normal filesystem paths, so rclone sync /home/source /tmp/destination -Will sync source to destination +Will sync `/home/source` to `/tmp/destination` Swift / Rackspace cloudfiles / Memset Memstore ---------------------------------------------- @@ -170,7 +174,7 @@ Google drive Paths are specified as drive:path Drive paths may be as deep as required. The initial setup for drive involves getting a token from Google drive -which you need to do in your browser. The `rclone config` walks you +which you need to do in your browser. `rclone config` walks you through it. To copy a local directory to a drive directory called backup @@ -228,7 +232,7 @@ The project website is at: * https://github.com/ncw/rclone -There you can file bug reports, ask for help or contribute patches. +There you can file bug reports, ask for help or send pull requests. Authors ------- diff --git a/docs/content/about.md b/docs/content/about.md index 153d779ff..70b59834e 100644 --- a/docs/content/about.md +++ b/docs/content/about.md @@ -2,7 +2,7 @@ title: "Rclone" description: "rclone syncs files to and from Google Drive, S3, Swift and Cloudfiles." type: page -date: "2014-03-19" +date: "2014-04-26" groups: ["about"] --- @@ -11,7 +11,7 @@ Rclone [![Logo](/img/rclone-120x120.png)](http://rclone.org/) -Sync files and directories to and from +Rclone is a command line program to sync files and directories to and from * Google Drive * Amazon S3 diff --git a/docs/content/contact.md b/docs/content/contact.md index 30a4bfcbe..7b72f1321 100644 --- a/docs/content/contact.md +++ b/docs/content/contact.md @@ -1,12 +1,12 @@ --- title: "Contact" description: "Contact the rclone project" -date: "2014-03-19" +date: "2014-04-26" --- Contact the rclone project - * [Github project page for source and reporting bugs](http://github.com/ncw/rclone) + * [Github project page for source, reporting bugs and pull requests](http://github.com/ncw/rclone) * Google+ page for general comments Or email [Nick Craig-Wood](mailto:nick@craig-wood.com) diff --git a/docs/content/docs.md b/docs/content/docs.md index 7bccc92db..0f1824a22 100644 --- a/docs/content/docs.md +++ b/docs/content/docs.md @@ -1,7 +1,7 @@ --- title: "Documentation" description: "Rclone Documentation" -date: "2014-03-19" +date: "2014-04-26" --- Install @@ -9,7 +9,7 @@ Install Rclone is a Go program and comes as a single binary file. -[Download the relevant binary.](/downloads/) +[Download](/downloads/) the relevant binary. Or alternatively if you have Go installed use @@ -17,15 +17,13 @@ Or alternatively if you have Go installed use and this will build the binary in `$GOPATH/bin`. -You can then modify the source and submit patches. - Configure --------- First you'll need to configure rclone. As the object storage systems have quite complicated authentication these are kept in a config file `.rclone.conf` in your home directory by default. (You can use the -`-config` option to choose a different config file.) +`--config` option to choose a different config file.) The easiest way to make the config is to run rclone with the config option: diff --git a/docs/content/drive.md b/docs/content/drive.md index ce0dd0431..6ec0065bb 100644 --- a/docs/content/drive.md +++ b/docs/content/drive.md @@ -1,7 +1,7 @@ --- title: "Google drive" description: "Rclone docs for Google drive" -date: "2014-03-19" +date: "2014-04-26" --- Paths are specified as `drive:path` diff --git a/docs/content/local.md b/docs/content/local.md index 9b168f736..2a90b8a13 100644 --- a/docs/content/local.md +++ b/docs/content/local.md @@ -1,7 +1,7 @@ --- title: "Local Filesystem" description: "Rclone docs for the local filesystem" -date: "2014-03-19" +date: "2014-04-26" --- Local Filesystem @@ -19,7 +19,7 @@ but it is probably easier not to. Modified time ------------- -We read and write the modified time using an accuracy determined by +Rclone reads and writes the modified time using an accuracy determined by the OS. Typically this is 1ns on Linux, 10 ns on Windows and 1 Second on OS X. diff --git a/docs/content/s3.md b/docs/content/s3.md index ba6db56e1..3440c6510 100644 --- a/docs/content/s3.md +++ b/docs/content/s3.md @@ -1,7 +1,7 @@ --- title: "Amazon S3" description: "Rclone docs for Amazon S3" -date: "2014-03-19" +date: "2014-04-26" --- Paths are specified as `remote:bucket` or `remote:` diff --git a/docs/content/swift.md b/docs/content/swift.md index 829260593..fe0ebd9c5 100644 --- a/docs/content/swift.md +++ b/docs/content/swift.md @@ -1,7 +1,7 @@ --- title: "Swift" description: "Swift" -date: "2014-03-19" +date: "2014-04-26" --- Swift refers to [Openstack Object Storage](http://www.openstack.org/software/openstack-storage/).