include manual page
authorDietmar Maurer <dietmar@proxmox.com>
Fri, 16 May 2014 08:32:01 +0000 (10:32 +0200)
committerDietmar Maurer <dietmar@proxmox.com>
Fri, 16 May 2014 08:32:01 +0000 (10:32 +0200)
src/Makefile
src/pve-firewall

index 364fd89..ca85eec 100644 (file)
@@ -7,7 +7,14 @@ export DOCDIR=${PREFIX}/share/doc
 export MAN1DIR=${MANDIR}/man1/
 export PERLDIR=${PREFIX}/share/perl5
 
-all: pvefw-logger
+all: pve-firewall.1 pvefw-logger
+
+%.1: %.1.pod
+       rm -f $@
+       cat $<|pod2man -n $* -s 1 -r ${VERSION} -c "Proxmox Documentation" >$@
+
+pve-firewall.1.pod: pve-firewall
+       perl -I.. ./pve-firewall printmanpod >$@
 
 CPPFLAGS:=$(shell dpkg-buildflags --get CPPFLAGS)
 CFLAGS:=$(shell dpkg-buildflags --get CFLAGS)
@@ -19,11 +26,13 @@ pvefw-logger: pvefw-logger.c
        $(shell pkg-config libnetfilter_log glib-2.0 gthread-2.0 --libs --cflags)
 
 .PHONY: install
-install: pve-firewall pvefw-logger
+install: pve-firewall pve-firewall.1 pvefw-logger
        make -C PVE install
        install -d -m 0755 ${DESTDIR}/${SBINDIR}
        install -m 0755 pve-firewall ${DESTDIR}/${SBINDIR}
        install -m 0755 --strip pvefw-logger ${DESTDIR}/${SBINDIR}
+       install -d ${MAN1DIR}
+       install -m 0644 pve-firewall.1 ${MAN1DIR}
 
 .PHONY: clean
 clean:         
index 7de7355..875a753 100755 (executable)
@@ -251,7 +251,7 @@ __PACKAGE__->register_method ({
     name => 'stop',
     path => 'stop',
     method => 'POST',
-    description => "Stop firewall. This will remove all rules installed by this script. The host is unprotected afterwards.",
+    description => "Stop firewall. This removes all Proxmox VE related iptable rules. The host is unprotected afterwards.",
     parameters => {
        additionalProperties => 0,
        properties => {},
@@ -342,7 +342,7 @@ __PACKAGE__->register_method ({
     name => 'compile',
     path => 'compile',
     method => 'POST',
-    description => "Compile amd print firewall rules. This is only for testing.",
+    description => "Compile and print firewall rules. This is useful for testing.",
     parameters => {
        additionalProperties => 0,
        properties => {},
@@ -397,16 +397,14 @@ __END__
 
 =head1 NAME
                                           
-pvestatd - PVE Firewall Daemon
+pve-firewall - PVE Firewall Daemon
 
 =head1 SYNOPSIS
 
-pve-firewall
+=include synopsis
 
 =head1 DESCRIPTION
 
 This service updates iptables rules periodically.
 
-
-
-
+=include pve_copyright