LSYNCD(1)

πŸ’– LSYNCD(1) β€” the lsyncd manual, bestie edition πŸ’–

okay so welcome to lsyncd, a whole icon, a legend, a daemon that just. keeps your directories in sync. forever. no cap. this is the LSYNCD(1) manual page and i'm gonna walk you through it like we're texting at 2am πŸ¦‹


✨ NAME ✨

lsyncd β€” a daemon to continuously synchronize directory trees πŸ’…


✨ SYNOPSIS ✨

so there's four ways to call her, depends on the vibe you want:

config file β€” the customizable route

lsyncd [OPTIONS] CONFIG-FILE

default rsync behaviour

lsyncd [OPTIONS] -rsync SOURCEDIR TARGET ...

default rync+ssh behaviour (moves and deletes through ssh)

lsyncd [OPTIONS] -rsyncssh SOURCEDIR TARGETHOST TARGETDIR ...

default direct behaviour (local file operations/rsync)

lsyncd [OPTIONS] -direct SOURCEDIR TARGETDIR ...

✨ DESCRIPTION ✨

so Lsyncd(1) watches your local directory trees through an event monitor interface (inotify, fsevents). she collects and combines all those events for a few seconds, and then she spawns one or more processes to actually do the synchronizing. by default that process is rsync(1). so basically? she's a light-weight asynchronous live mirror solution πŸͺž that's comparatively easy to install, doesn't need new filesystems or block devices, and does not hamper your local filesystem performance. obsessed fr fr.

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 destination over the wire. it's giving efficiency, it's giving "why would you send that twice" πŸ‘‘

fine-grained customization? absolutely achievable through the CONFIG-FILE. custom action configs can even be written from scratch in cascading layers, ranging from shell scripts all the way to code written in the LUA(1) language. this way simplicity can be balanced with powerfulness 🌈. see the online manual for details on the CONFIG-FILE at https://axkibe.github.io/lsyncd/manual/config/file/ .

⚠️ heads up bestie, this one matters: under normal configuration Lsyncd will delete pre-existing files in the target directories that are not present in the respective source directory. so like. she's thorough. she's committed. know that before you run her 😭

✨ OPTIONS ✨

  • -delay SECS β€” Overrides the default delay times. πŸ•
  • -help β€” Show a help message. the classic.
  • -insist β€” Continues start up even if rsync cannot connect. she's stubborn and i respect it πŸ’…
  • -log LEVEL β€” Controls which kind of events are logged. By default Lsyncd logs Normal and Error Messages. -log scarce will make Lsyncd log Error messages only. -log all will log all debug messages. pick your chaos level 🎚️
  • -log Category β€” Turns on a specific debug message. E.g. -log Exec will log all processes as they are spawned. so nosy, love her πŸ™ˆ
  • -nodaemon β€” Lsyncd will not detach from the invoker and log as well to stdout/err. she stays right there with you 🫢
  • -pidfile 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.

✨ EXIT STATUS ✨

  • (128+SIGNUM) β€” Terminated by Signal (143 by TERM) πŸ’€
  • -1 β€” Failure (syntax, unrecoverable error condition, internal failure) 😭

✨ SEE ALSO ✨

Online Manual: https://axkibe.github.io/lsyncd/ 🌸


✨ VERSION ✨

This man page is for lsyncd(1) version 2.2.0 ⭐


✨ AUTHOR ✨

Axel Kittenberger, <axkibe@gmail.com> 2010-2017 πŸ‘‘


✨ COPYING ✨

Copyright (C) 2010-2017 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). 🌈


and that's the whole page bestie πŸ’– this one's from Lsyncd 2.2.1, dated January 2017, filed under LSYNCD(1) β€” go forth and sync, you main character πŸŽ€βœ¨πŸ¦‹