summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul C. Buetow (mars.fritz.box) <paul@buetow.org>2014-06-21 11:06:15 +0200
committerPaul C. Buetow (mars.fritz.box) <paul@buetow.org>2014-06-21 11:06:15 +0200
commit5df48fce7c860f68e5d8045a343758de8b8b3983 (patch)
tree96e326f150bf695d1b8021bc9ec5ccd38f109f38 /docs
parentaa68812f83d0a5a4e4784052c9825e092d2fbefc (diff)
update manpage
Diffstat (limited to 'docs')
-rw-r--r--docs/netdiff.pod25
1 files changed, 22 insertions, 3 deletions
diff --git a/docs/netdiff.pod b/docs/netdiff.pod
index 0408990..b4c04ce 100644
--- a/docs/netdiff.pod
+++ b/docs/netdiff.pod
@@ -4,16 +4,35 @@ netdiff - A netdiff project
=head1 WTF?
-A simple script to diff two files via the network.
+A simple script to diff a file or a directory of two hosts over the network.
-=head2 usage
+This is very helpfull if you want to find out any difference of these two hosts.
-ClusterSSH onto two hosts at the same time and run on both hosts the same command like:
+=head2 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.
+
+=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:
+
+ 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.