LSYNCD(1)
NAME
lsyncd - A rsync-based tool to monitor a directory including
subdirectories and update modifications.
SYNOPSIS
lsyncd [--binary FILE] [--conf FILE] [--debug] [--delay SECS]
[--dryrun] [--exclude-file FILE] [--logfile FILE] [--no-daemon]
[--pidfile FILE] [--scarce] [--stubborn] [source] [target...]
lsyncd [{--help} | {--version}]
DESCRIPTION
lsyncd is a program that uses rsync to synchronize local directories
with a or several remote machine(s) running rsyncd. Lsyncd watches
multiple directory trees through inotify. On startup it will rsync all
directories with the remote host(s), and then sync single directories
by collecting the inotify events. This tool is a light-weight live
mirror solution.
OPTIONS
The program takes options starting with two dashes (`-'). A summary of
options is included below.
- --binary FILE
- Call this binary to sync (DEFAULT: /usr/bin/rsync).
- --conf FILE
- config file to read config from. See lsyncd.conf.xml(5)
- Default: /etc/lsyncd.conf.xml if no source, target is given in the
commandline. If they are given and [--conf] is not given no config
file will be loaded. - --debug
- Log debug messages
- --deleay SECS
- If <delay/> is greater than zero, lsyncd waits this amount of
seconds between an event and calling the binary. All events for a
directory in this timeframe will be aggregated to one call. Default is 5 seconds.
<delay/> - --dryrun
- Do not call rsync, run dry only
- --exclude-file FILE
- Exclude file handlet to rsync (DEFAULT: None).
- --logfile FILE
- Put log here (DEFAULT: /var/log/lsyncd).
- --no-daemon
- Do not detach, log to stdout/stderr.
- --pidfile FILE
- Create a file with pid of application.
- --scarce
- Only log errors.
- --stubborn
- Continue even if startup sync fails.
- --help
- Show summary of options.
- --version
- Show version of program.
FILES
- /etc/lsyncd.conf.xml
- The default location of configuration file.
- /var/log/lsyncd
- The default location of log file. Make sure the running user has
write access to this file, or specify a different log file name.
DIAGNOSTICS
lsyncd provides some return codes, that can be used in scripts:
- Code Diagnostic
0 Program exited successfully.
1 Out of memory.
2 File was not found, or failed to write.
3 binary (most likely rsync) returned - non-zero result on startup.
- 4 Something wrong the command-line arguments
- in the lsyncd invocation.
- 5 Too many exclude files were specified.
6 Something wrong with the config file.
7 Kernel cannot do inotify.
255 Internal failure.
SEE ALSO
The programs are documented fully in README file available in
/usr/share/doc/lsyncd/README.gz.
AUTHORS
- Junichi Uekawa <dancer@debian.org>
- Wrote this manpage for the Debian system.
- Axel Kittenberger <axel.kittenberger@univie.ac.at>
- Strives to keep this up to date.
COPYRIGHT
Copyright (C) 2008 Junichi Uekawa, Axel Kittenberger
- Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU General Public License, Version 2 or (at
your option) any later version published by the Free Software
Foundation.