update documentation

gamelinux · Jun 21, 2010 · a5d52b5 · a5d52b5
1 parent 200a522
commit a5d52b5
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 15 deletions.
diff --git a/Makefile b/Makefile
@@ -12,20 +12,19 @@ clean:
 	rm -f doc/prads.1 doc/prads.1.gz
 
 .PHONY: man
-man: doc/prads.1.gz
+man: doc/prads.1.gz doc/prads-asset-report.1.gz doc/prads-wirefuzz.1.gz doc/prads2snort.1.gz
 
-doc/prads.1.gz: doc/prads.1
+doc/%.1.gz: doc/%.1
 	@>$@<$< gzip -9
 
-doc/prads.1: doc/prads.man
+doc/%.1: doc/%.man
 	rst2man $< >$@
 
 install: man
 	# binaries
 	install -d ${DESTDIR}${BINDIR}
 	install -m 755 -o root -g root src/prads ${DESTDIR}${BINDIR}/prads
 	install -m 755 -o root -g root tools/prads-asset-report ${DESTDIR}${BINDIR}/prads-asset-report
-	install -m 755 -o root -g root tools/prads-wirefuzz ${DESTDIR}${BINDIR}/prads-wirefuzz
 	install -m 755 -o root -g root tools/prads2snort ${DESTDIR}${BINDIR}/prads2snort
 	# config
 	install -d ${DESTDIR}${CONFDIR}
@@ -52,6 +51,9 @@ install: man
 	install -m 644 -o root -g root etc/web-application.sig ${DESTDIR}${CONFDIR}/
 	# ports 
 	install -m 644 -o root -g root etc/udp.ports ${DESTDIR}${CONFDIR}/
+	# man pages
 	install -m 644 -o root -g root doc/prads.1.gz ${DESTDIR}${MANDIR}/
+	install -m 644 -o root -g root doc/prads-asset-report.1.gz ${DESTDIR}${MANDIR}/
+	install -m 644 -o root -g root doc/prads2snort.1.gz ${DESTDIR}${MANDIR}/
 
 .PHONY: build clean install
diff --git a/doc/prads-asset-report.man b/doc/prads-asset-report.man
@@ -25,20 +25,19 @@ DESCRIPTION
 
 PRADS is a Passive Real-time Asset Detection System.
 
-It passively listen to network traffic and gathers information
+PRADS passively listens 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
 and hosts are alive/used, or can be used together with your
 favorite IDS/IPS setup for "event to host/service" correlation.
 
-Gathering info about your hosts in real-time, will also let you
+Gathering info about your hosts in real-time will also let you
 detect assets that are just connected to the network for a short
 period of time, where a active network scan (nmap etc.) would take
 long time, and not common to run continually, hence missing the asset. 
 
-prads-asset-report reads prads-asset.log and parses the hosts
-and tries to print out some usefull information about the hosts
-prads has gathered info about.
+prads-asset-report parses prads-asset.log prints out some useful
+information about the hosts prads has managed to gather info about.
 
 OPTIONS
 =======
@@ -53,7 +52,7 @@ OPTIONS
 PROBLEMS
 ========
 
-1. Much more logic can be buildt into it!
+1. Much more logic can be built into it!
 
 SEE ALSO
 ========

diff --git a/doc/prads2snort.man b/doc/prads2snort.man
@@ -44,11 +44,11 @@ PRADS2SNORT is the tool that does this!
 OPTIONS
 =======
 
--i|--infile <file>          file to feed prads2snort.pl
--o|--outfile <file>         file to write host_attribute data to (host_attribute.xml)
--d|--default <os>           set Default OS if unknown (linux,bsd,macos,windows)
--v|--verbose                prints out OS, frag, stream and confidence of asset
--h|--help                   this help message
+-i, --infile <file>          file to feed prads2snort.pl
+-o, --outfile <file>         file to write host_attribute data to (host_attribute.xml)
+-d, --default <os>           set Default OS if unknown (linux,bsd,macos,windows)
+-v, --verbose                prints out OS, frag, stream and confidence of asset
+-h, --help                   this help message
 --version                   show prads2snort.pl version
 
 PROBLEMS