diff --git a/manpage.lsyncd.conf.xml b/manpage.lsyncd.conf.xml new file mode 100644 index 0000000..24b98e2 --- /dev/null +++ b/manpage.lsyncd.conf.xml @@ -0,0 +1,148 @@ + +.
will be generated. You may view the +manual page with: nroff -man .
| less'. A typical entry +in a Makefile or Makefile.am is: + +DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl +XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0" + +manpage.1: manpage.xml + $(XP) $(DB2MAN) $< + +The xsltproc binary is found in the xsltproc package. The XSL files are in +docbook-xsl. A description of the parameters you can use can be found in the +docbook-xsl-doc-* packages. Please remember that if you create the nroff +version in one of the debian/rules file targets (such as build), you will need +to include xsltproc and docbook-xsl in your Build-Depends control field. +Alternatively use the xmlto command/package. That will also automatically +pull in xsltproc and docbook-xsl. + +Notes for using docbook2x: docbook2x-man does not automatically create the +AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as + ... . + +To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections +read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be +found in the docbook-xsl-doc-html package. + +Validation can be done using: `xmllint -''-noout -''-valid manpage.xml` + +General documentation about man-pages and man-page-formatting: +man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ + +--> +]> + + + + lsyncd User Manual + lsyncd + + + Axel + Kittenberger +
+ axel.kittenberger@univie.ac.at +
+ + + + 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. + + + + LSYNCD.CONF.XML + 5 + + + lsyncd.conf.xml + xconfig file for lsyncd + + + + DESCRIPTION + lsyncd.conf.xml is used to configure the lsyncd daemon. + Note that any command line options can overrule settings in the config file. A lsyncd configuration file has an XML grammar. That means tags have to be closed with a / and the such. Following explanations will be provided with an example for each. + The config file must start with as root node. A "version" parameter has to be present which specifies the lsyncd version the config file is written for, currently this is 1.25. + <lsyncd version="1.25"> + + + SETTINGS + Next is optionally a node. It controls lsyncd global settings. Any setting is optional. + <settings> + If a node is present all debug messages will be logged. Default is a normal verbosity. + <debug/> + If a node is present only error messages will be logged. Default is a normal verbosity. + <scarce/> + If a node is present lsyncd will not detach and log to stdout/stderr. Default is to detach as daemon. + <no-daemon/> + If a node is present lsyncd will not call any actions (rsync) for test purposes. Default is not to run dry. + <dry-run/> + With an entry an exclusion file can be specified with a "filename" parameter. This will be passed to rsync and follows rsyncs grammar for exclude files. Default is not to pass an exlude file to rsync. + <exclude-from filename="/etc/lsyncd.exclude"/> + With a node to location of the logfile can be changed. Default is /var/log/lsyncd. Take care that the user which lsyncd is running with can write to this file. + <logfile filename="/var/log/lsyncd"/> + A node specifies the binary lsyncd will call to sync stuff. Usually you want this to be rsync. Default is /usr/bin/rsync. + <binary filename="/usr/bin/rsync"/> + If a node is present lsyncd will write its pid there. Default is not to write a pidfile. + <pidfile filename="/var/run/lsyncd.pid"/> + With a node you can control the arguments lsyncd will call the <binary> (rsync) with. Each child node will specify one argument. <option> specifies a literal argument. Only %r will be replaced with 'r' when rsycnd is supposed to work recursive (on startup of lsyncd) or 'd' on normal operations. <exclude-file> will be replaced with if an <exclude-from> file is specified. <source> will be replaced the source directory to sync from. <destination> will be replace to the target to sync to. Default arguments are . + <callopts> + <option text="-lt%r"/> + <option text="--delete"/> + <exclude-file/> + <source/> + <destination/> + </callopts> + End of (optional) settings section. + </settings> + + + + DIRECTORIES + With nodes arbitrarily many sources to be watched can be specified. Within a <directory> entry you can again specify , and a node which will override global settings just for this source. See SETTINGS for details on this options. + The mandatory node specifies with the paramater "path" the directory to watch and sync. (once in a while something is mandatory :-). Also at least one node has to specified where to sync to. This has to be a format accepted by rsync. + <directory> + <source path="/absolute/path/to/source"/> + <target path="desthost::module/"/> + </directory> + + End of a lsyncd.conf.xml file. + </lsyncd> + + + FILES + + + /etc/lsyncd.conf.xml + + The default location of the configuration file. + + + + + + SEE ALSO + + + lsyncd + 1 + + + +