fix manpage and add man install target

gamelinux · Jun 17, 2010 · 05c75a6 · 05c75a6
1 parent 96cf398
commit 05c75a6
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 25 deletions.
diff --git a/Makefile b/Makefile
@@ -4,12 +4,22 @@ CONFDIR=${PREFIX}/etc/prads
 
 build:
 	@echo "You need libpcre-dev and libpcap-dev to compile this program."
-	${MAKE} -C src/
+	${MAKE} CONFDIR=${CONFDIR} -C src/
 
 clean:
 	${MAKE} -C src/ $@
+	rm -f doc/prads.1 doc/prads.1.gz
 
-install: 
+.PHONY: man
+man: doc/prads.1.gz
+
+doc/prads.1.gz: doc/prads.1
+	@>$@<$< gzip -9
+
+doc/prads.1: doc/prads.man
+	rst2man $< >$@
+
+install: man
 	# binary
 	install -d ${DESTDIR}${BINDIR}
 	install -m 755 -o root -g root src/prads ${DESTDIR}${BINDIR}/prads

diff --git a/doc/prads.man b/doc/prads.man
@@ -8,10 +8,10 @@ Passive Real-time Asset Detection System
 
 :Author: edwardfjellskaal@gmail.com
 :Date:   2010-06-17
-:Copyright: public domain
-:Version: 0.1
+:Copyright: GPL
+:Version: 0.2
 :Manual section: 1
-:Manual group: Networking
+:Manual group: networking
 
 .. TODO: authors and author with name <email>
 
@@ -23,7 +23,8 @@ SYNOPSIS
 DESCRIPTION
 ===========
 
-Is a Passive Real-time Asset Detection System.
+PRADS is a Passive Real-time Asset Detection System.
+
 It passively listen to network traffic and gathers information
 on hosts and services it sees on the network. This information
 can be used to map your network, letting you know what services
@@ -45,36 +46,38 @@ passively, PRADS should have it implemented!
 OPTIONS
 =======
 
- -i             : network device (default: eth0)
- -r             : read pcap file
- -c             : prads config file
- -b             : berkeley packet filter
- -u             : user
- -g             : group
- -D             : enables daemon mode
- -h             : this help message
- -v             : verbose
- -a             : home nets (eg: '192.168.0.0/25,10.0.0.0/255.0.0.0')
+-i <iface>              Network device <iface> (default: eth0).
+-r <file>               Read pcap <file>.
+-c <file>               Read config from <file>.
+-b <filter>             Apply Berkeley packet filter <filter>.
+-u <user>               Run as user <user>.
+-g <group>              Run as group <group>.
+-a <nets>               Specify home nets (eg: '192.168.0.0/25,10.0.0.0/255.0.0.0').
+-D                      Enables daemon mode.
+-h                      This help message.
+-v                      Verbose.
 
 PROBLEMS
 ========
 
-1. None
+1. Doesn't detect everything out there :-P
 
 SEE ALSO
 ========
 
-* `PRADS <http://prads.projects.linpro.no/>`__
-* `p0f <http://lcamtuf.coredump.cx/p0f.shtml>`__
-* `PADS <http://passive.sourceforge.net/>`__
+* PRADS <http://prads.projects.linpro.no/>
+* p0f <http://lcamtuf.coredump.cx/p0f.shtml>
+* PADS <http://passive.sourceforge.net/>
 
 BUGS
 ====
 
-- Report bugs here:
-* http://github.com/gamelinux/prads/issues
+Report bugs here:
+
+- http://github.com/gamelinux/prads/issues 
+
+For general questions:
 
-- For general questions:
-* http://projects.linpro.no/mailman/listinfo/prads-devel 
-* http://projects.linpro.no/mailman/listinfo/prads-users
+- http://projects.linpro.no/mailman/listinfo/prads-devel 
+- http://projects.linpro.no/mailman/listinfo/prads-users