Imported Upstream version 0.3.5
[anytun.git] / doc / Makefile
1 ##
2 ##  anytun
3 ##
4 ##  The secure anycast tunneling protocol (satp) defines a protocol used
5 ##  for communication between any combination of unicast and anycast
6 ##  tunnel endpoints.  It has less protocol overhead than IPSec in Tunnel
7 ##  mode and allows tunneling of every ETHER TYPE protocol (e.g.
8 ##  ethernet, ip, arp ...). satp directly includes cryptography and
9 ##  message authentication based on the methods used by SRTP.  It is
10 ##  intended to deliver a generic, scaleable and secure solution for
11 ##  tunneling and relaying of packets of any protocol.
12 ##
13 ##
14 ##  Copyright (C) 2007-2014 Markus Grüneis, Othmar Gsenger, Erwin Nindl,
15 ##                          Christian Pointner <satp@wirdorange.org>
16 ##
17 ##  This file is part of Anytun.
18 ##
19 ##  Anytun is free software: you can redistribute it and/or modify
20 ##  it under the terms of the GNU General Public License as published by
21 ##  the Free Software Foundation, either version 3 of the License, or
22 ##  any later version.
23 ##
24 ##  Anytun is distributed in the hope that it will be useful,
25 ##  but WITHOUT ANY WARRANTY; without even the implied warranty of
26 ##  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27 ##  GNU General Public License for more details.
28 ##
29 ##  You should have received a copy of the GNU General Public License
30 ##  along with Anytun.  If not, see <http://www.gnu.org/licenses/>.
31 ##
32 ##  In addition, as a special exception, the copyright holders give
33 ##  permission to link the code of portions of this program with the
34 ##  OpenSSL library under certain conditions as described in each
35 ##  individual source file, and distribute linked combinations
36 ##  including the two.
37 ##  You must obey the GNU General Public License in all respects
38 ##  for all of the code used other than OpenSSL.  If you modify
39 ##  file(s) with this exception, you may extend this exception to your
40 ##  version of the file(s), but you are not obligated to do so.  If you
41 ##  do not wish to do so, delete this exception statement from your
42 ##  version.  If you delete this exception statement from all source
43 ##  files in the program, then also delete it here.
44 ##
45
46 VERSION=$(shell cat ../version)
47
48 MANPAGES := anytun.8 anytun-controld.8 anytun-config.8 anytun-showtables.8 #anyrtpproxy.8
49 XML := $(MANPAGES:%.8=%.8.xml)
50
51 .PHONY: clean realclean
52
53 all: manpage
54
55 define create-manpage
56         a2x -f manpage $(1)
57         @ sed -i -e 's/\[FIXME: source\]/anytun ${VERSION}/' $(2)
58         @ sed -i -e 's/\[FIXME: manual\]/$(2:.8=) user manual/' $(2)
59         @ sed -i -e 's/^\($(subst -,\\-,$(2:.8=))\)$$/\\fB\1\\fR/' $(2)
60         @ sed -i -e 's/^  \[ \([^ ]*\)/  [ \\fB\1\\fR/' $(2)
61 endef
62
63 %.8: %.8.txt
64         $(call create-manpage,$<,$@)
65
66 manpage: $(MANPAGES)
67
68 clean:
69         rm -f $(XML)
70
71 realclean:
72         rm -f $(MANPAGES)