added manpage for grml-addtun

diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644 (file)
index 0000000..f5c1319
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,45 @@
+install_ = install
+
+etc = ${DESTDIR}/etc/
+usr = ${DESTDIR}/usr
+usrbin = $(usr)/bin
+usrsbin = $(usr)/sbin
+usrshare = $(usr)/share/$(name_)
+usrdoc = $(usr)/share/doc/$(name_)
+man8 = $(usr)/share/man/man8/
+man1 = $(usr)/share/man/man1/
+
+
+%.html : %.txt ;
+       asciidoc -b xhtml11 $^
+
+%.gz : %.txt ;
+       asciidoc -d manpage -b docbook $^
+       #sed -i 's/<emphasis role="strong">/<emphasis role="bold">/g' `echo $^ |sed -e 's/.txt/.xml/'`
+       xsltproc -nonet /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl `echo $^ |sed -e 's/.txt/.xml/'` &>/dev/null
+       gzip -f --best `echo $^ |sed -e 's/.txt//'`
+
+
+MANPAGES = grml-addtun.8
+
+all: doc
+
+doc: doc_man doc_html
+doc_html: $(addsuffix .html, $(MANPAGES))
+doc_man: $(addsuffix .gz, $(MANPAGES))
+
+
+install: all
+       # install .html dokumentation
+       $(install_) -d -m 755 $(usrdoc)
+       @for i in $(MANPAGES); do \
+               $(install_) -vm 644 $$i.html $(usrdoc); done
+       # install manpages
+       $(install_) -d -m 755 $(man8)
+       @for i in $(MANPAGES); do \
+               $(install_) -vm 644 $$i.gz $(man8); done
+
+clean:
+       @for i in $(MANPAGES); do \
+               rm -fv $$i.html $$i.xml $$i.gz $$i; done
+

diff --git a/docs/grml-addtun.8.txt b/docs/grml-addtun.8.txt
new file mode 100644 (file)
index 0000000..701d437
--- /dev/null
+++ b/docs/grml-addtun.8.txt
@@ -0,0 +1,71 @@
+GRML-ADDTUN(1)
+==============
+Michael Gebetsroither <michael.geb@gmx.at>
+
+
+NAME
+----
+grml-addtun - creates persistent tun/tap devices with bridge handling
+
+
+SYNOPSIS
+--------
+*grml-addtun* [OPTIONS] <tun1> <tun2> ...
+
+
+DESCRIPTION
+-----------
+This manual page documents briefly the *grml-addtun* command.
+
+*grml-addtun* is a script to create persistent tun/tap devices with integrated
+bridge handling.
+
+
+OPTIONS
+-------
+*-d*::
+Delete the given tun/tap devices and remove them from the bridge (if given with -b).
+
+*-u <user>*::
+Make tun devices useable from <user> without special permissions.
+
+*-g <group>*::
+Make tun devices useable from <group> without special permissions.
+
+*-b <bridge>*::
+Remove/delete given tun devices from <bridge>.
+
+*-a*::
+Automatic bridge handling, eg. create bridge if not existing and delete it if
+no more devices are part of it after removing the given tun/tap devices.
+
+*-h*::
+Show the help message.
+
+
+EXAMPLES
+--------
+Config sampe for /etc/network/interfaces with bridge and tun/tap devices.
+This creates tap0..tap3 which are part of bridge vnet.
+
+-------------
+    auto vnet
+    iface vnet inet static
+        post-up  /root/bin/grml-addtun -u einstein -b vnet tap{0..3}
+        pre-down /root/bin/grml-addtun -u einstein -b vnet -d tap{0..3}
+        bridge_ports none
+        address 192.168.10.1
+        netmask 255.255.255.0
+-------------
+
+
+SEE ALSO
+--------
+grml-ap(8), grml-bridge(8), grml-router(8)
+
+
+AUTHOR
+------
+grml-addtun was written by Michael Gebetsroither <gebi@grml.org>
+
+This manual page was written by Michael Gebetsroither <gebi@grml.org>