From 16adff04371097ad96ea620f1045fd55e5b7a6dc Mon Sep 17 00:00:00 2001
From: Dietmar Maurer <dietmar@proxmox.com>
Date: Fri, 16 May 2014 10:32:01 +0200
Subject: [PATCH] include manual page

---
 src/Makefile     | 13 +++++++++++--
 src/pve-firewall | 12 +++++-------
 2 files changed, 16 insertions(+), 9 deletions(-)

diff --git a/src/Makefile b/src/Makefile
index 364fd89..ca85eec 100644
--- a/src/Makefile
+++ b/src/Makefile
@@ -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: 	
diff --git a/src/pve-firewall b/src/pve-firewall
index 7de7355..875a753 100755
--- a/src/pve-firewall
+++ b/src/pve-firewall
@@ -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
-- 
2.39.2