diff --git a/Makefile.am b/Makefile.am index e3101e9..946bee7 100644 --- a/Makefile.am +++ b/Makefile.am @@ -13,18 +13,26 @@ datarootdir = @datarootdir@ EXTRA_DIST = config.h.in inotify-nosys.h manpage.xml lsyncd.conf.xml -nodist_man1_MANS = lsyncd.1 +nodist_man1_MANS = lsyncd.1 lsyncd.conf.xml.5 check-syntax: $(CC) -c -O2 -Wall $(CHK_SOURCES) -o/dev/null -lsyncd.1: manpage.xml +lsyncd.1: manpage.lsyncd.xml xsltproc -''-nonet \ -''-param man.charmap.use.subset "0" \ -''-param make.year.ranges "1" \ -''-param make.single.year.ranges "1" \ /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \ - manpage.xml + $< + +lsyncd.conf.xml.5: manpage.lsyncd.conf.xml + xsltproc -''-nonet \ + -''-param man.charmap.use.subset "0" \ + -''-param make.year.ranges "1" \ + -''-param make.single.year.ranges "1" \ + /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \ + $< AM_CFLAGS=-Wall AM_LIBS= diff --git a/lsyncd.conf.xml b/lsyncd.conf.xml index 01241ca..3241950 100644 --- a/lsyncd.conf.xml +++ b/lsyncd.conf.xml @@ -42,7 +42,7 @@ This is a default config file template for lsyncd. only '%r' will be replaced with r when recursive operation is wanted, d when not. - exclude file will be replaced with -exclude-from FILE + exclude-file will be replaced with -exclude-from FILE source will be the source path to sync from diff --git a/manpage.xml b/manpage.lsyncd.xml similarity index 70% rename from manpage.xml rename to manpage.lsyncd.xml index 2ae0c52..ce70467 100644 --- a/manpage.xml +++ b/manpage.lsyncd.xml @@ -43,76 +43,65 @@ General documentation about man-pages and man-page-formatting: man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ --> - - - - - - - - - - - - ]> - &dhtitle; - &dhpackage; + lsyncd User Manual + lsyncd - &dhfirstname; - &dhsurname; + Junichi + Uekawa Wrote this manpage for the Debian system.
- &dhemail; + dancer@debian.org +
+ + + Axel + Kittenberger + Strives to keep this uptodate. +
+ axel.kittenberger@univie.ac.at
2008 - &dhusername; + Junichi Uekawa, Axel Kittenberger - This manual page was written for the Debian system - (but may be used by others). 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. - On Debian systems, the complete text of the GNU General Public - License can be found in - /usr/share/common-licenses/GPL. - &dhucpackage; - &dhsection; + LSYNCD + 1 &dhpackage; - A rsync-based tool to monitor a directory and update modifications + A rsync-based tool to monitor a directory including subdirectories and update modifications. &dhpackage; + - + - source - target + source + target &dhpackage; @@ -134,18 +123,11 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ DESCRIPTION - This manual page documents briefly the - &dhpackage; - command. - This manual page was written for the Debian distribution - because the original program does not have a manual page. - Instead, it has a README documentation in plain text. - &dhpackage; is a program that uses rsync to synchronize local directories with a remote machine running rsyncd. Lsyncd watches multiple directory trees through - inotify. It will first rsync all directories with the remote - host, and then sync single files by collecting the inotify + 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. @@ -158,49 +140,65 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ variablelist.term.break.after parameters to control the term elements. --> - + + + config file to read config from. See lsyncd.conf.xml5 + Default: /etc/lsyncd.conf.xml if no , is given in the commandline. If they are given and --conf is not given no config file will be loaded. + + + + + + Log debug messages + - + Do not call rsync, run dry only + - + Exclude file handlet to rsync (DEFAULT: None). + - + Put log here (DEFAULT: /var/log/lsyncd). + - + Do not detach, log to stdout/stderr. + - + Call this binary to sync (DEFAULT: /usr/bin/rsync). + - + Create a file with pid of application. + - + Only log errors. @@ -212,6 +210,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ Show summary of options. + @@ -223,6 +222,12 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ FILES + + /etc/lsyncd.conf.xml + + The default location of configuration file. + + /var/log/lsyncd @@ -235,7 +240,10 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ DIAGNOSTICS - The following diagnostics may be issued + + &dhpackage; provides some return codes, that can be used in scripts: @@ -255,44 +263,62 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ 0 Program exited successfully. + 1 Out of memory. + 2 File was not found, or failed to write. + 3 - rsync execution somehow failed. + binary (most likely rsync) returned non-zero result on startup. + 4 - Not enough command-line arguments were given to lsyncd invocation. + Something wrong the command-line arguments in the lsyncd invocation. + 5 Too many exclude files were specified. + + 6 + Something wrong with the config file. + + + + 255 + Internal failure. + - - + SEE ALSO - + + + lsyncd.conf.xml + 5 + + rsync 1 - - + + The programs are documented fully in README file available in /usr/share/doc/lsyncd/README.gz. -