include manual page

diff --git a/src/Makefile b/src/Makefile
index 364fd89361b4ada4e0c49b8d0ef071fecf1f12bc..ca85eeca43901fc506b3b412a68438cf6f915249 100644 (file)
--- a/src/Makefile
+++ b/src/Makefile
@@ -7,7 +7,14 @@ export DOCDIR=${PREFIX}/share/doc
 export MAN1DIR=${MANDIR}/man1/
 export PERLDIR=${PREFIX}/share/perl5
 
 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)
 
 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
        $(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}
        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:         
 
 .PHONY: clean
 clean:         

diff --git a/src/pve-firewall b/src/pve-firewall
index 7de7355e8140244d6a2ad1f33c0492307cae0f05..875a753691845c03d85496530fea4a6ffb675b8b 100755 (executable)
--- a/src/pve-firewall
+++ b/src/pve-firewall
@@ -251,7 +251,7 @@ __PACKAGE__->register_method ({
     name => 'stop',
     path => 'stop',
     method => 'POST',
     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 => {},
     parameters => {
        additionalProperties => 0,
        properties => {},


@@ -342,7 +342,7 @@ __PACKAGE__->register_method ({
     name => 'compile',
     path => 'compile',
     method => 'POST',
     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 => {},
     parameters => {
        additionalProperties => 0,
        properties => {},


@@ -397,16 +397,14 @@ __END__
 
 =head1 NAME
                                           
 
 =head1 NAME
                                           

-pvestatd - PVE Firewall Daemon
+pve-firewall - PVE Firewall Daemon

 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 

-pve-firewall
+=include synopsis

 
 =head1 DESCRIPTION
 
 This service updates iptables rules periodically.
 
 
 =head1 DESCRIPTION
 
 This service updates iptables rules periodically.
 

-
-
-
+=include pve_copyright