Add manpage

diff --git a/Makefile b/Makefile
index b0a30309feba0a5e9953a423352e939522f84e5f..4462725252bd4eacf6f5df3523e44f5f92cb5a1c 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,7 +1,7 @@
 ###############################################################################
 #Author: Samuel Jero
 #
-# Date: 11/2011
+# Date: 12/2012
 #
 # Makefile for program dccp2tcp
 ###############################################################################
@@ -20,7 +20,7 @@ BINDIR = /usr/local/bin
 MANDIR = /usr/local/man
 
 
-all: dccp2tcp
+all: dccp2tcp dccp2tcp.1
 
 dccp2tcp: dccp2tcp.o encap.o connections.o
        gcc ${CFLAGS} ${LDLIBS} --std=gnu99 dccp2tcp.o encap.o connections.o -odccp2tcp
@@ -34,13 +34,16 @@ encap.o: encap.c dccp2tcp.h encap.h
 connections.o: dccp2tcp.h connections.c
        gcc ${CFLAGS} ${LDLIBS} --std=gnu99 -c connections.c -oconnections.o
 
+dccp2tcp.1: dccp2tcp.pod
+       pod2man -s 1 -c "dccp2tcp" dccp2tcp.pod > dccp2tcp.1
+
 install: dccp2tcp
        install -m 755 -o bin -g bin dccp2tcp ${BINDIR}/dccp2tcp
-#      install -m 444 -o bin -g bin dccp2tcp.1 ${MANDIR}/man1/dccp2tcp.1
+       install -m 444 -o bin -g bin dccp2tcp.1 ${MANDIR}/man1/dccp2tcp.1
 
 uninstall:
        rm -f ${BINDIR}/dccp2tcp
-#      rm -r ${MANDIR}/man1/dccp2tcp.1
+       rm -f ${MANDIR}/man1/dccp2tcp.1
 
 clean:
-       rm -f *~ dccp2tcp core *.o
+       rm -f *~ dccp2tcp core *.o dccp2tcp.1

diff --git a/dccp2tcp.pod b/dccp2tcp.pod
new file mode 100644 (file)
index 0000000..0ba5446
--- /dev/null
+++ b/dccp2tcp.pod
@@ -0,0 +1,53 @@
+=head1 NAME
+
+dccp2tcp - convert DCCP packet captures to TCP captures for analysis with B<tcptrace>
+
+=head1 SYNOPSIS
+
+B<dccp2tcp> [-d] [-y] [-g] [-s] I<input_file> I<output_file> 
+
+=head1 DESCRIPTION
+
+B<dccp2tcp> takes a tcpdump packet capture of DCCP connections and converts it to a symantically
+equivalent TCP capture for analysis using standard TCP tools like B<tcptrace>.
+
+In order to utilize this program effectively you will also need B<tcptrace>, which you can download
+from http://www.tcptrace.org and the version of B<xplot> available from http://www.tcptrace.org under
+"Useful Companion Programs".
+
+B<dccp2tcp> only supports DCCP CCID 2 with 48 bit sequence numbers at this time. Further, checksums are
+not computed on the output packets---they are simply zeroed.
+
+=head1 OPTIONS
+
+=over 5
+
+=item B<-d>
+       
+Debug, repeat for additional verbosity
+
+=item B<-y>
+
+Shift the window line (yellow) in B<tcptrace> to the highest received acknowledgment.
+Normally this line is just a constant amount more than the ack number(i.e. useless).
+
+=item B<-g>
+
+Shift the ack line (green) in B<tcptrace> to the highest received acknowledgment.
+Normally this line is the standard TCP ack number, which, for DCCP, translates to
+the highest contiguous acknowledgement in the ack vector.
+
+=item B<-s>
+
+Converts the DCCP ack vector to TCP SACK blocks. Specify B<-s> twice to only see
+those Ack vectors with loss intervals in them.
+
+=back
+
+=head1 AUTHOR
+
+Samuel Jero <sj323707@ohio.edu>
+
+=head1 SEE ALSO
+
+B<tcptrace>(1), B<xplot>(1)