axkibe/lsyncd — Issue #60: Documentation Enhancements
Author: axkibe
Created: 2011-11-16 15:06:00+00:00
State: open

Originally filed by randy.re...@gmail.com on 2011-05-18T20:44:03

I figured I would open an issue to track Documentation errors and desired enhancements. This is a great product and would be even more heavily adopted if documentation was up to snuff.

First thing that should be added:
The Configuration file Settings section does not mention the "pidfile" option. This is very handy and I only found out about it by searching the lua code.
Additionally, the documentation should probably highlight all default values for the options.

Secondly, the examples which show how to write a Level 4 lua configuration show something along the lines of:
"sync{source="/home/user/src/", target="foohost.com:~/trg/", rsyncOps="-ltus"}"
This did nothing for me, I was alerted that I need something like 'config=default.rsync'. To fix I assumed it should look like:
"sync{default.rsync, source="/home/user/src/", target="foohost.com:~/trg/", rsyncOps="-ltus"}"

I fear that my assumption could be erroneous. Part of me feels that by specifying "default.rsync" then the rsyncOps will be ignored... maybe should make this a bit more clear.

Anyway, I am just wanting to help improve, we have been using lsyncd since the 1.2x versions :)

Cheers,

Randy