lsyncd/doc/manpage/lsyncd.1.txt

108 lines
3.2 KiB
Plaintext
Raw Normal View History

2010-11-27 23:28:44 +00:00
lsyncd(1)
=========
:doctype: manpage
2010-11-30 19:44:42 +00:00
:man source: Lsyncd
:man manual: Lsyncd
2016-06-08 07:15:31 +00:00
:man version: 2.1.5
:date: June 2016
2010-11-27 23:28:44 +00:00
NAME
----
2011-11-22 09:43:37 +00:00
lsyncd - a daemon to continuously synchronize directory trees
2010-11-27 23:28:44 +00:00
SYNOPSIS
--------
2010-11-30 19:44:42 +00:00
config file:::
2012-04-04 13:52:36 +00:00
{nbsp} *lsyncd* ['OPTIONS'] 'CONFIG-FILE'
2010-11-27 23:28:44 +00:00
2010-11-30 19:44:42 +00:00
default rsync behaviour:::
2012-04-04 13:52:36 +00:00
{nbsp} *lsyncd* ['OPTIONS'] -rsync 'SOURCEDIR' 'TARGET' ...
2010-11-27 23:28:44 +00:00
2012-04-04 13:52:36 +00:00
default rync+ssh behaviour (moves and deletes through ssh):::
{nbsp} *lsyncd* ['OPTIONS'] -rsyncssh 'SOURCEDIR' 'TARGETHOST' 'TARGETDIR' ...
2011-02-28 14:19:40 +00:00
2012-04-04 13:52:36 +00:00
default direct behaviour (local file operations/rsync):::
{nbsp} *lsyncd* ['OPTIONS'] -direct 'SOURCEDIR' 'TARGETDIR' ...
2010-11-27 23:28:44 +00:00
2012-02-10 20:08:10 +00:00
DESCRIPTION
2010-11-27 23:28:44 +00:00
------------
2011-08-25 11:34:44 +00:00
Lsyncd(1) watches local directory trees through an event monitor interface
(inotify, fsevents). It aggregates and combines events for a few seconds and
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
block devices and does not hamper local filesystem performance.
2010-11-30 13:20:12 +00:00
Rsync+ssh is an advanced action configuration that uses a SSH(1) to act file
and directory moves directly on the target instead of re-transmitting the move
2010-11-30 13:20:12 +00:00
destination over the wire.
2011-08-25 11:34:44 +00:00
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
2016-06-08 07:15:31 +00:00
CONFIG-FILE https://axkibe.github.io/lsyncd/config/file/ .
2011-08-25 11:34:44 +00:00
Note that under normal configuration Lsyncd will delete pre-existing files in
the target directories that are not present in the respective source directory.
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.
2011-08-25 11:34:44 +00:00
*-insist*::
Continues start up even if rsync cannot connect.
2011-08-25 11:34:44 +00:00
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
2011-11-22 09:43:37 +00:00
only. *-log all* will log all debug messages.
2010-11-30 19:12:52 +00:00
*-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.
2011-11-22 09:43:37 +00:00
*-pidfile* 'FILE'::
2010-11-30 19:12:52 +00:00
Lsyncd will write its process ID in 'FILE'.
*-runner* 'FILE'::
2011-11-22 09:43:37 +00:00
Makes the Lsyncd core load the part of Lsyncd written in Lua from 'FILE'.
2010-11-30 19:12:52 +00:00
*-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
--------
2016-06-08 07:15:31 +00:00
Online Manual: https://axkibe.github.io/lsyncd/
2010-11-27 23:28:44 +00:00
VERSION
------
2016-06-08 07:15:31 +00:00
This man page is for lsyncd(1) version 2.1.5
2010-11-27 23:28:44 +00:00
2010-11-30 19:12:52 +00:00
AUTHOR
------
2016-06-08 07:15:31 +00:00
Axel Kittenberger, <axkibe@gmail.com> 2010-2016
2010-11-27 23:28:44 +00:00
2011-11-22 09:43:37 +00:00
COPYING
-------
2016-06-08 07:15:31 +00:00
Copyright \(C) 2010-2016 Axel Kittenberger. Free use of this software is granted
2010-11-27 23:28:44 +00:00
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).