From 4cc58347f8238a6c4306154cc3121b4212b3ebd2 Mon Sep 17 00:00:00 2001 From: Axel Kittenberger Date: Sat, 27 Nov 2010 23:28:44 +0000 Subject: [PATCH] working on a manpage --- Makefile.am | 14 ++++++------ doc/lsyncd.1.txt | 55 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+), 6 deletions(-) create mode 100644 doc/lsyncd.1.txt diff --git a/Makefile.am b/Makefile.am index 21a37cd..39033a9 100644 --- a/Makefile.am +++ b/Makefile.am @@ -20,17 +20,20 @@ dist_example_DATA = \ examples/lrsyncssh.lua TESTS = tests/l4-rsync-data.sh +man1_MANS = doc/lsyncd.1 + +doc/lsyncd.1: doc/lsyncd.1.xml + xsltproc -o $@ -nonet /etc/asciidoc/docbook-xsl/manpage.xsl $< + +doc/lsyncd.1.xml: doc/lsyncd.1.txt + asciidoc -o $@ -b docbook -d manpage $< if RUNNER - -# installs the runner +# installs the runner script runnerdir = $(RUNNER_DIR) runner_DATA = lsyncd.lua - else - # or compiles it into the binary - lsyncd_LDADD += luac.o objarch: | lsyncd.o @@ -48,6 +51,5 @@ luac.o: luac.out objarch objtarget luac.out: lsyncd.lua luac $< - endif diff --git a/doc/lsyncd.1.txt b/doc/lsyncd.1.txt new file mode 100644 index 0000000..c959494 --- /dev/null +++ b/doc/lsyncd.1.txt @@ -0,0 +1,55 @@ +lsyncd(1) +========= +:doctype: manpage + +NAME +---- +lsyncd - daemon to live synchronize dircectory trees with (remote) targets. + +SYNOPSIS +-------- +config file: :: + {zwsp}*lsyncd* ['OPTIONS'] 'CONFIG-FILE' + +default rsync behaviour: :: + {zwsp}*lsyncd* ['OPTIONS'] -rsync 'SOURCE' 'TARGET' ... + +default rync+ssh bevahior (moves and deletes through ssh): :: + {zwsp}*lsyncd* ['OPTIONS'] -rsyncssh 'SOURCE' 'HOST' 'TARGETDIR' ... + +DESCRTIPTION +------------ +Lsyncd(1) + +OPTIONS +------- +TODO + +EXIT STATUS +----------- +*0*:: + Terminated on a TERM signal(7) + +*-1*:: + Failure (syntax, unrecoverable error condition, internal failure) + +SEE ALSO +-------- +Online Manual: http://code.google.com/p/lsyncd/wiki/Lsyncd2 + +VERSION +------ + This man page is in development (TODOX) for lsyncd(1) version 2.0 + +AUTOR +----- +Axel Kittenberger 2010 + +COPYING +------- +Copyright \(C) 2010 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). + +