lsyncd/doc/lsyncd.1.txt

97 lines
2.8 KiB
Plaintext
Raw Normal View History

2010-11-27 23:28:44 +00:00
lsyncd(1)
=========
:doctype: manpage
NAME
----
2010-11-30 19:12:52 +00:00
lsyncd - a daemon to continously syncronize dircectory trees
2010-11-27 23:28:44 +00:00
SYNOPSIS
--------
config file: ::
{zwsp}*lsyncd* ['OPTIONS'] 'CONFIG-FILE'
default rsync behaviour: ::
{zwsp}*lsyncd* ['OPTIONS'] -rsync 'SOURCE' 'TARGET' ...
default rync+ssh bevahior (moves and deletes through ssh): ::
{zwsp}*lsyncd* ['OPTIONS'] -rsyncssh 'SOURCE' 'HOST' 'TARGETDIR' ...
DESCRTIPTION
------------
2010-11-30 13:20:12 +00:00
Lsyncd(1) watches a local directory trees event monitor interface (inotify).
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(1).
Lsyncd is thus a light-weight live mirror solution that is comparatively easy
to install not requiring new filesystems or blockdevices 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 retransmating the move
destination over the wire.
More fine-grained customizaton can be achieved through the CONFIG-FILE. Custom
action configurations 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 powerfullness. See the online manual for
details on the CONFIG-FILE http://code.google.com/p/lsyncd/wiki/Lsyncd2.0Manual
2010-11-27 23:28:44 +00:00
OPTIONS
-------
2010-11-30 13:20:12 +00:00
*-delay* 'SECS'::
Overrides the default delay times.
*-help*::
Show a help message.
2010-11-30 19:12:52 +00:00
*-log* 'LEVEL'::
2010-11-30 13:20:12 +00:00
Controls which kind of events are logged. By default Lsyncd logs 'Normal'
and 'Error' Messages. *-log scarce* will make Lsyncd log Error messages
2010-11-30 19:12:52 +00:00
only. *-log all* will log all
debug messages.
*-log* 'Category'::
Turns on a specific debug message. E.g. *-log Exec* will log
all processes as they are spawned.
*-nodaemon*::
Lsyncd will not detach from the invoker and log as well to stdout/err.
*-pifile* 'FILE'::
Lsyncd will write its process ID in 'FILE'.
*-runner* 'FILE'::
Makes the Lsyncd core load the part of Lsyncd written in Lua from 'FILE'
*-version*::
Writes version information and exits.
2010-11-27 23:28:44 +00:00
EXIT STATUS
-----------
*0*::
Terminated on a TERM signal(7)
*-1*::
Failure (syntax, unrecoverable error condition, internal failure)
SEE ALSO
--------
Online Manual: http://code.google.com/p/lsyncd/wiki/Lsyncd2
VERSION
------
This man page is in development (TODOX) for lsyncd(1) version 2.0
2010-11-30 19:12:52 +00:00
AUTHOR
------
Axel Kittenberger, <axkibe@gmail.com> 2010
2010-11-27 23:28:44 +00:00
COPYING
-------
Copyright \(C) 2010 Axel Kittenberger. Free use of this software is granted
under the terms of the GNU General Public License (GPL) version 2, or any later
version. Free redistrubition of this Documentation (/doc directory) is granted
under the terms of the Creative Commons 3.0 Attribution License (CC-3.0-BY).