Documentation Enhancements

[GoogleCodeExporter]

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

Original issue reported on code.google.com by randy.re...@gmail.com on 18 May 2011 at 8:44

[GoogleCodeExporter]

Dear Randy, Thank you a lot for you interest and for your suggestions!

I added you to the contributers List, please use the wiki to directly improve 
the docs in the way you think it is a good idea. Dont worry, be brave, when I 
find time I'll review the changes expost.

rsyncOps is by default "-ltus", if not provided by user. 

Kind regards, Axel

Original comment by axk...@gmail.com on 18 May 2011 at 9:51

[GoogleCodeExporter]

I just fixed those entries. 

Original comment by axk...@gmail.com on 11 Jun 2011 at 2:16

• Changed state: Fixed

[GoogleCodeExporter]

Perfect.  Sorry I haven't been contributting a lot myself.  Currently
traveling Europe :)  But just a reminder you have made a great piece of
software!  I, and the company I work for thank you for it!

Original comment by randy.re...@gmail.com on 15 Jun 2011 at 11:43

[GoogleCodeExporter]

Thank you :-)

Original comment by axk...@gmail.com on 15 Jun 2011 at 11:54