add minimal manpage

4 files changed, 16 insertions, 105 deletions

diff --git a/README.txt b/README.txt
index 815c823..98f6a27 100644
--- a/README.txt
+++ b/README.txt
@@ -88,8 +88,8 @@ Customize
         man ./docs/netdiff.1
 
   Renaming netdiff into your project name
-    Rename all files which have *netdiff* included into your own new
-    package name. You can do that with:
+    Rename all files which have *netdiff* included into your own new package
+    name. You can do that with:
 
         PROJECTNAME=yourproject
         find . -name \*netdiff\* | 
diff --git a/docs/netdiff.1 b/docs/netdiff.1
index c7e16a8..849457c 100644
--- a/docs/netdiff.1
+++ b/docs/netdiff.1
@@ -123,8 +123,8 @@
 .rm #[ #] #H #V #F C
 .\" ========================================================================
 .\"
-.IX Title "TEMPLATE 1"
-.TH TEMPLATE 1 "2014-04-10" "netdiff 0.0.0" "User Commands"
+.IX Title "NETDIFF 1"
+.TH NETDIFF 1 "2014-06-20" "netdiff 0.0.0" "User Commands"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
diff --git a/docs/netdiff.pod b/docs/netdiff.pod
index 51d3e63..fa9fbb7 100644
--- a/docs/netdiff.pod
+++ b/docs/netdiff.pod
@@ -4,111 +4,22 @@ netdiff - A netdiff project
 
 =head1 WTF?
 
-You may use this project in order to build your own Debian package for your own project. This has been tested with Debian GNU/Linux Squeeze and Debian GNU/Linux Wheezy. 
+A simple script to diff two files via the network.
 
-Feel free to modify any aspects. This project is just an empty example netdiff.
+=head2 usage
 
-Follow these steps:
+ClusterSSH onto two hosts at the same time and run on both hosts the same command like:
 
-=head2 Install required packages
+    netdiff HOSTNAME FILENAME 
 
-Run the following:
+Where HOSTNAME can be the hostname of the first or the second host. Depending on this the script will decide to be the client or the server role.
 
-    sudo aptitude install lintian devscripts dpkg-dev make perl
+=head1 LICENSE
 
-Todo: Ensure this are the correct packages. In order to test that I would have to setup a blank Debian system.
+See package description or project website.
 
-=head2 Compile the project
+=head1 AUTHOR
 
-Go to the to level directory and run
+Paul Buetow - <http://netdiff.buetow.org>
 
-    make
-
-To test run
-
-    ./bin/netdiff
-
-It should print out the version number of the project.
-
-=head2 Create a Debian package
-
-Go to the to level directory and run
-
-    make deb
-
-It will create the files like:
-
-    ../netdiff_0.0.0.0_all.deb
-    ../netdiff_0.0.0.0.dsc
-    ../netdiff_0.0.0.0_amd64.changes
-    ../netdiff_0.0.0.0.tar.gz
-
-It should create a debian package in ../. Check and install it, e.g:
-
-    lintian --pedantic ../netdiff_0.0.0.0_all.deb 
-    sudo dpkg -i ../netdiff_0.0.0.0_all.deb 
-
-Run 
-
-    dpkg -L netdiff
-
-to see whats in there. You can now run
-
-    /usr/bin/netdiff
-
-or for example
-
-    man netdiff
-
-=head2 Read the Makefile
-
-Read the Makefile in order to understand what's going on.
-
-=head1 Customize
-
-Now, since you understood everything feel free to customize everything the way you want it. E.g.: 
-
-    Don't use POD for documentation but LaTeX
-
-    Compile a C program
-
-    Include a ./lib dir, add it to the 'install' Makefile rule
-
-    etc etc.
-
-You should also consider the following:
-
-=head2 Manual page
-
-This netdiff is using POD for creating manual pages. Edit ./docs/netdiff.pod and run 
-
-    make documentation
-
-in order to build ./docs/netdiff.1. The page will be included in the resulting debian package automatically. You can review the page with
-
-    man ./docs/netdiff.1
-
-=head2 Renaming netdiff into your project name 
-
-Rename all files which have *netdiff* included into your own new package name. You can do that with:
-
-    PROJECTNAME=yourproject
-    find . -name \*netdiff\* | 
-    while read netdiff; do git mv $netdiff ${netdiff/netdiff/$PROJECTNAME}; done
-
-Search all content and rename *netdiff* into your own new package name. You can do that with:
-
-    grep -R netdiff . | grep -v .git | 
-    cut -d: -f1 | uniq | xargs sed -i "s/netdiff/$PROJECTNAME/g"  
-
-=head2 Updating ./debian
-
-Edit the following files accordingly to your new project (e.g. with vim):
-
-    vim ./debian/{control,copyright,README}
-
-=head2 Update changelog
-
-Go to the to level directory and run
-
-    dch -i
+=cut
diff --git a/docs/netdiff.txt b/docs/netdiff.txt
index 815c823..98f6a27 100644
--- a/docs/netdiff.txt
+++ b/docs/netdiff.txt
@@ -88,8 +88,8 @@ Customize
         man ./docs/netdiff.1
 
   Renaming netdiff into your project name
-    Rename all files which have *netdiff* included into your own new
-    package name. You can do that with:
+    Rename all files which have *netdiff* included into your own new package
+    name. You can do that with:
 
         PROJECTNAME=yourproject
         find . -name \*netdiff\* |