working on a manpage

This commit is contained in:
Axel Kittenberger 2010-11-27 23:28:44 +00:00
parent b077d2e713
commit 4cc58347f8
2 changed files with 63 additions and 6 deletions

View File

@ -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

55
doc/lsyncd.1.txt Normal file
View File

@ -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 <axkibe@gmail.com> 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).