From 99ea89ad0d385b9dedf1684fb511405c16d81997 Mon Sep 17 00:00:00 2001 From: Daniel Black Date: Sat, 4 May 2013 13:11:09 +1000 Subject: [PATCH] Fix documentation spelling bits, and a few links --- COPYING | 6 +++--- README.md | 8 ++++---- doc/lsyncd.1.txt | 10 +++++----- examples/lecho.lua | 3 +-- 4 files changed, 13 insertions(+), 14 deletions(-) diff --git a/COPYING b/COPYING index ac131e6..d7cbb94 100644 --- a/COPYING +++ b/COPYING @@ -313,8 +313,8 @@ Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + Lsyncd version 2.X, Copyright (C) 2013 Axel Kittenberger + Lsyncd comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. @@ -328,7 +328,7 @@ school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. + `Lsyncd' (which makes synchronises directories) written by Axel Kittenberger. , 1 April 1989 Ty Coon, President of Vice diff --git a/README.md b/README.md index 90aae63..e4d8e23 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ Description ----------- Lsyncd watches a local directory trees event monitor interface (inotify or fsevents). It aggregates and combines events for a few seconds and then spawns one (or more) process(es) to synchronize the changes. By default this is [rsync](http://rsync.samba.org/). Lsyncd is thus a light-weight live mirror solution that is comparatively easy to install not requiring new filesystems or block devices and does not hamper local filesystem performance. -Rsync+ssh is an advanced action configuration that uses a SSH to act file and directory moves directly on the target instead of retransmitting the move destination over the wire. +Rsync+ssh is an advanced action configuration that uses a SSH to act file and directory moves directly on the target instead of re-transmitting the move destination over the wire. -Fine-grained customization can be achieved through the config file. Custom action configs can even be written from scratch in cascading layers ranging from shell scripts to code written in the [Lua language](http://www.lua.org/) This way simplicity can be balanced with powerfulness. See the manual for details [Lsyncd21Manual](https://github.com/axkibe/lsyncd/wiki/Manual-to-Lsyncd-2.1.x) +Fine-grained customization can be achieved through the config file. Custom action configs can even be written from scratch in cascading layers ranging from shell scripts to code written in the [Lua language](http://www.lua.org/). This way simple, powerful and flexible configurations can be acheived. See the manual for details [Lsyncd21Manual](https://github.com/axkibe/lsyncd/wiki/Manual-to-Lsyncd-2.1.x) License: [GPLv2](http://www.fsf.org/licensing/licenses/info/GPLv2.html) or any later GPL version. @@ -24,12 +24,12 @@ Lsyncd usage examples --------------------- ```lsyncd -rsync /home remotehost.org::share/``` -This watches and rsyncs the local directory /home with all subdirectories and +This watches and rsyncs the local directory /home with all sub-directories and transfers them to 'remotehost' using the rsync-share 'share'. ```lsyncd -rsyncssh /home remotehost.org backup-home/``` -This will also rsync/watch '/home', but it uses a ssh connection to make moves local on the remotehost instead of retransmitting the moved file over the wire. +This will also rsync/watch '/home', but it uses a ssh connection to make moves local on the remotehost instead of re-transmitting the moved file over the wire. Some more complicated examples, tips and tricks you can find in the [Lsyncd21Manual](https://github.com/axkibe/lsyncd/wiki/Manual-to-Lsyncd-2.1.x). diff --git a/doc/lsyncd.1.txt b/doc/lsyncd.1.txt index a0e4e7a..bb8edcd 100644 --- a/doc/lsyncd.1.txt +++ b/doc/lsyncd.1.txt @@ -31,17 +31,17 @@ Lsyncd(1) watches local directory trees through an event monitor interface then spawns one or more processes to synchronize the changes. By default this is rsync(1). Lsyncd is thus a light-weight asynchronous live mirror solution that is comparatively easy to install not requiring new filesystems or -blockdevices and does not hamper local filesystem performance. +block devices and does not hamper local filesystem performance. Rsync+ssh is an advanced action configuration that uses a SSH(1) to act file -and directory moves directly on the target instead of retransmitting the move +and directory moves directly on the target instead of re-transmitting the move destination over the wire. Fine-grained customization can be achieved through the CONFIG-FILE. Custom action configs can even be written from scratch in cascading layers ranging from shell scripts to code written in the LUA(1) language. This way simplicity can be balanced with powerfulness. See the online manual for details on the -CONFIG-FILE http://code.google.com/p/lsyncd/wiki/Lsyncd20Manual +CONFIG-FILE https://github.com/axkibe/lsyncd/wiki/Manual-to-Lsyncd-2.0.x . Note that under normal configuration Lsyncd will delete pre-existing files in the target directories that are not present in the respective source directory. @@ -55,7 +55,7 @@ OPTIONS Show a help message. *-insist*:: - Continues startup even if a startup rsync cannot connect. + Continues start up even if rsync cannot connect. *-log* 'LEVEL':: Controls which kind of events are logged. By default Lsyncd logs 'Normal' @@ -88,7 +88,7 @@ EXIT STATUS SEE ALSO -------- -Online Manual: http://code.google.com/p/lsyncd/wiki/Lsyncd2 +Online Manual: https://github.com/axkibe/lsyncd/wiki/Lsyncd-2.1.x-%E2%80%96-What's-New%3F VERSION ------ diff --git a/examples/lecho.lua b/examples/lecho.lua index 2258b9c..4a09ce8 100644 --- a/examples/lecho.lua +++ b/examples/lecho.lua @@ -1,8 +1,7 @@ ----- -- User configuration file for lsyncd. -- --- This example uses local bash commands to keep two local --- directory trees in sync. +-- This example uses just echos the operations -- -----