update documentation0.1.5

6 files changed, 71 insertions, 73 deletions

diff --git a/Makefile b/Makefile
index 0a682c3..93c1a1c 100644
--- a/Makefile
+++ b/Makefile
@@ -35,7 +35,8 @@ version:
 documentation:
 	pod2man --release="$(NAME) $$(cat .version)" \
 		--center="User Commands" ./docs/$(NAME).pod > ./docs/$(NAME).1
-	pod2text ./docs/$(NAME).pod | tee ./docs/$(NAME).txt > README.txt
+	pod2text ./docs/$(NAME).pod > ./docs/$(NAME).txt
+	cp ./docs/$(NAME).pod README.pod
 
 # Build a debian package (don't sign it, modify the arguments if you want to sign it)
 deb: all
diff --git a/README.pod b/README.pod
new file mode 100644
index 0000000..7124d5c
--- /dev/null
+++ b/README.pod
@@ -0,0 +1,48 @@
+=head1 NAME
+
+netdiff - A simple script to diff a file or a directory of two hosts over the network.
+
+This is very helpful if you want to find out any difference of these two hosts.
+
+=head2 SYNOPSYS
+
+  netdiff HOSTNAME PATH [PORT] [ADDITIONAL DIFF OPTS]
+
+=head2 USAGE
+
+Cluster-SSH into two hosts at the same time and run on both hosts the same 
+(simultaneous) command:
+
+    netdiff HOSTNAME PATH
+
+Where HOSTNAME can be the hostname of the first or the second host. Depending on this the script will decide to be in the client or the server role.
+
+And where PATH musst be a full qualified path to a file or a directory.
+
+Netdiff transfers everything in PATH (recursively and encrypted via OpenSSL/AES) to the other host and computes a diff of it. The latter with the diff tool.
+
+If no port is specified the default port will be used which is defined in
+
+  /etc/default/netdiff
+
+=head2 EXAMPLE
+
+A common use case is to find out the differences of the PAM configuration. On most systems the PAM configuration is spread into several small configuration files which are hard to compare by hand between two hosts. 
+
+Given two hosts one.example.com and two.example.com. Just run this command on both hosts simultaneously:
+
+  netdiff one.example.com /etc/pam.d
+
+The same affect, but the other way around, would be the following command:
+
+  netdiff two.example.com /etc/pam.d
+
+=head1 LICENSE
+
+See package description or project website.
+
+=head1 AUTHOR
+
+Paul Buetow - <http://netdiff.buetow.org>
+
+=cut
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 592b729..0000000
--- a/README.txt
+++ /dev/null
@@ -1,52 +0,0 @@
-NAME
-    netdiff - A simple script to diff a file or a directory of two hosts
-    over the network.
-
-    This is very helpful if you want to find out any difference of these two
-    hosts.
-
-  SYNOPSYS
-      netdiff HOSTNAME PATH [PORT] [ADDITIONAL DIFF OPTS]
-
-  USAGE
-    Cluster-SSH into two hosts at the same time and run on both hosts the
-    same (simultaneous):
-
-        netdiff HOSTNAME PATH
-
-    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.
-
-    And where PATH musst be a full qualified path to a file or a directory.
-
-    Netdiff transfers everything in PATH (recursively and encrypted via
-    OpenSSL/AES) to the other host and computes a diff of it.
-
-    If no port is specified the default port will be used, which is defined
-    in
-
-      /etc/default/netdiff
-
-  EXAMPLE
-    A common use case is to find out the differences of the PAM
-    configuration. On most systems the PAM configuration is spread into
-    several small configuration files which are hard to compare by hand
-    between two hosts.
-
-    Given two hosts one.example.com and two.example.com. Just run this
-    command on both hosts:
-
-      netdiff one.example.com /etc/pam.d
-
-    The same affect, but the other way around would be the following
-    command:
-
-      netdiff two.example.com /etc/pam.d
-
-LICENSE
-    See package description or project website.
-
-AUTHOR
-    Paul Buetow - <http://netdiff.buetow.org>
-
diff --git a/docs/netdiff.1 b/docs/netdiff.1
index 850cce3..634f5c7 100644
--- a/docs/netdiff.1
+++ b/docs/netdiff.1
@@ -124,7 +124,7 @@
 .\" ========================================================================
 .\"
 .IX Title "NETDIFF 1"
-.TH NETDIFF 1 "2014-06-21" "netdiff 0.1.4" "User Commands"
+.TH NETDIFF 1 "2014-06-22" "netdiff 0.1.4" "User Commands"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -141,19 +141,19 @@ This is very helpful if you want to find out any difference of these two hosts.
 .SS "\s-1USAGE\s0"
 .IX Subsection "USAGE"
 Cluster-SSH into two hosts at the same time and run on both hosts the same 
-(simultaneous):
+(simultaneous) command:
 .PP
 .Vb 1
 \&    netdiff HOSTNAME PATH
 .Ve
 .PP
-Where \s-1HOSTNAME\s0 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.
+Where \s-1HOSTNAME\s0 can be the hostname of the first or the second host. Depending on this the script will decide to be in the client or the server role.
 .PP
 And where \s-1PATH\s0 musst be a full qualified path to a file or a directory.
 .PP
-Netdiff transfers everything in \s-1PATH\s0 (recursively and encrypted via OpenSSL/AES) to the other host and computes a diff of it.
+Netdiff transfers everything in \s-1PATH\s0 (recursively and encrypted via OpenSSL/AES) to the other host and computes a diff of it. The latter with the diff tool.
 .PP
-If no port is specified the default port will be used, which is defined in
+If no port is specified the default port will be used which is defined in
 .PP
 .Vb 1
 \&  /etc/default/netdiff
@@ -162,13 +162,13 @@ If no port is specified the default port will be used, which is defined in
 .IX Subsection "EXAMPLE"
 A common use case is to find out the differences of the \s-1PAM\s0 configuration. On most systems the \s-1PAM\s0 configuration is spread into several small configuration files which are hard to compare by hand between two hosts.
 .PP
-Given two hosts one.example.com and two.example.com. Just run this command on both hosts:
+Given two hosts one.example.com and two.example.com. Just run this command on both hosts simultaneously:
 .PP
 .Vb 1
 \&  netdiff one.example.com /etc/pam.d
 .Ve
 .PP
-The same affect, but the other way around would be the following command:
+The same affect, but the other way around, would be the following command:
 .PP
 .Vb 1
 \&  netdiff two.example.com /etc/pam.d
diff --git a/docs/netdiff.pod b/docs/netdiff.pod
index 9dc26ad..7124d5c 100644
--- a/docs/netdiff.pod
+++ b/docs/netdiff.pod
@@ -11,17 +11,17 @@ This is very helpful if you want to find out any difference of these two hosts.
 =head2 USAGE
 
 Cluster-SSH into two hosts at the same time and run on both hosts the same 
-(simultaneous):
+(simultaneous) command:
 
     netdiff HOSTNAME PATH
 
-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.
+Where HOSTNAME can be the hostname of the first or the second host. Depending on this the script will decide to be in the client or the server role.
 
 And where PATH musst be a full qualified path to a file or a directory.
 
-Netdiff transfers everything in PATH (recursively and encrypted via OpenSSL/AES) to the other host and computes a diff of it.
+Netdiff transfers everything in PATH (recursively and encrypted via OpenSSL/AES) to the other host and computes a diff of it. The latter with the diff tool.
 
-If no port is specified the default port will be used, which is defined in
+If no port is specified the default port will be used which is defined in
 
   /etc/default/netdiff
 
@@ -29,11 +29,11 @@ If no port is specified the default port will be used, which is defined in
 
 A common use case is to find out the differences of the PAM configuration. On most systems the PAM configuration is spread into several small configuration files which are hard to compare by hand between two hosts. 
 
-Given two hosts one.example.com and two.example.com. Just run this command on both hosts:
+Given two hosts one.example.com and two.example.com. Just run this command on both hosts simultaneously:
 
   netdiff one.example.com /etc/pam.d
 
-The same affect, but the other way around would be the following command:
+The same affect, but the other way around, would be the following command:
 
   netdiff two.example.com /etc/pam.d
 
diff --git a/docs/netdiff.txt b/docs/netdiff.txt
index 592b729..1b8a403 100644
--- a/docs/netdiff.txt
+++ b/docs/netdiff.txt
@@ -10,20 +10,21 @@ NAME
 
   USAGE
     Cluster-SSH into two hosts at the same time and run on both hosts the
-    same (simultaneous):
+    same (simultaneous) command:
 
         netdiff HOSTNAME PATH
 
     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.
+    Depending on this the script will decide to be in the client or the
+    server role.
 
     And where PATH musst be a full qualified path to a file or a directory.
 
     Netdiff transfers everything in PATH (recursively and encrypted via
-    OpenSSL/AES) to the other host and computes a diff of it.
+    OpenSSL/AES) to the other host and computes a diff of it. The latter
+    with the diff tool.
 
-    If no port is specified the default port will be used, which is defined
+    If no port is specified the default port will be used which is defined
     in
 
       /etc/default/netdiff
@@ -35,11 +36,11 @@ NAME
     between two hosts.
 
     Given two hosts one.example.com and two.example.com. Just run this
-    command on both hosts:
+    command on both hosts simultaneously:
 
       netdiff one.example.com /etc/pam.d
 
-    The same affect, but the other way around would be the following
+    The same affect, but the other way around, would be the following
     command:
 
       netdiff two.example.com /etc/pam.d