Add README and man page

diff --git a/Makefile b/Makefile
index 57013838f3d6af13dd09c74c9a5df25470beb6a1..20d36146326438f7a8b0a798916ecf52e951fd7a 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -20,8 +20,7 @@ BINDIR = /usr/local/bin
 MANDIR = /usr/local/man
 
 
-all: strip6in4 
-#strip6in4.1
+all: strip6in4 strip6in4.1
 
 strip6in4: strip6in4.o encap.o
        gcc ${CFLAGS} --std=gnu99 strip6in4.o encap.o -ostrip6in4 ${LDLIBS}
@@ -32,12 +31,12 @@ strip6in4.o: strip6in4.h strip6in4.c
 encap.o: encap.c strip6in4.h encap.h
        gcc ${CFLAGS} ${LDLIBS} --std=gnu99 -c encap.c -oencap.o
 
-#strip6in4.1: strip6in4.pod
-#      pod2man -s 1 -c "strip6in4" strip6in4.pod > strip6in4.1
+strip6in4.1: strip6in4.pod
+       pod2man -s 1 -c "strip6in4" strip6in4.pod > strip6in4.1
 
 install: strip6in4
        install -m 755 -o bin -g bin strip6in4 ${BINDIR}/strip6in4
-#      install -m 444 -o bin -g bin strin6in4 ${MANDIR}/man1/strip6in4.1
+       install -m 444 -o bin -g bin strip6in4.1 ${MANDIR}/man1/strip6in4.1
 
 uninstall:
        rm -f ${BINDIR}/strip6in4

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..af530ed
--- /dev/null
+++ b/README
@@ -0,0 +1,29 @@
+This program takes a libpcap capture, locates 6in4 or 4in6 traffic and
+de-encapsulates that traffic into a raw IP (libpcap compatible) capture.
+
+Usage:
+Usage: strip6in4 [-v] [-h] [-V] input_file output_file
+          -v   verbose. May be repeated for additional verbosity.
+          -V   Version information
+          -h   Help
+
+strip6in4 is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+strip6in4 is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with strip6in4.  If not, see <http://www.gnu.org/licenses/>.
+
+
+Copyright 2013
+Samuel Jero
+Masters Student
+Internetworking Research Group
+Ohio University
+sj323707@ohio.edu

diff --git a/strip6in4.pod b/strip6in4.pod
new file mode 100644 (file)
index 0000000..9136f49
--- /dev/null
+++ b/strip6in4.pod
@@ -0,0 +1,38 @@
+=head1 NAME
+
+strip6in4 - de-encapsulate 6in4 or 4in6 traffic in a libpcap capture to a separate capture
+
+=head1 SYNOPSIS
+
+B<strip6in4> [-v] [-h] [-V] I<input_file> I<output_file>
+
+=head1 DESCRIPTION
+
+B<strip6in4> takes a libpcap capture, locates 6in4 or 4in6 traffic and
+de-encapsulates that traffic into a raw IP (libpcap compatible) capture.
+
+=head1 OPTIONS
+
+=over 5
+
+=item B<-v>
+       
+Verbose, repeat for additional verbosity
+
+=item B<-V>
+       
+Version information
+
+=item B<-h>
+       
+Help message
+
+=back
+
+=head1 AUTHOR
+
+Samuel Jero <sj323707@ohio.edu>
+
+=head1 SEE ALSO
+
+B<tcpdump>(8)