Add ntfscmp manual

configure.ac

@@ -375,6 +375,7 @@ AC_CONFIG_FILES([
 	ntfsprogs/ntfscat.8
 	ntfsprogs/ntfsclone.8
 	ntfsprogs/ntfscluster.8
+	ntfsprogs/ntfscmp.8
 	ntfsprogs/ntfscp.8
 	ntfsprogs/ntfsfix.8
 	ntfsprogs/ntfsinfo.8

ntfsprogs/Makefile.am

@@ -20,7 +20,7 @@ EXTRA_PROGRAMS		= ntfsdump_logfile ntfswipe ntfstruncate ntfsmove \
 man_MANS		= mkntfs.8 ntfsfix.8 ntfslabel.8 ntfsinfo.8 \
 			  ntfsundelete.8 ntfsresize.8 ntfsprogs.8 ntfsls.8 \
 			  ntfsclone.8 ntfscluster.8 ntfscat.8 ntfscp.8 \
-			  ntfsmount.8
+			  ntfsmount.8 ntfscmp.8
 EXTRA_MANS		=
 
 CLEANFILES		= $(EXTRA_PROGRAMS)

ntfsprogs/ntfscmp.8.in

@@ -0,0 +1,82 @@
+.\" Copyright (c) 2005\-2006 Szabolcs Szakacsits.
+.\" This file may be copied under the terms of the GNU Public License.
+.\"
+.TH NTFSCMP 8 "April 2006" "ntfsprogs @VERSION@"
+.SH NAME
+ntfscmp \- compare two NTFS filesystems and tell the differences
+.SH SYNOPSIS
+.B ntfscmp
+[\fIOPTIONS\fR]
+.I DEVICE1
+.I DEVICE2
+.br
+.SH DESCRIPTION
+The
+.B ntfscmp
+program makes a comparison between two NTFS filesystems from all aspects and 
+reports all varianses it finds.
+The filesystems can be on block devices or images files. Ntfscmp can be used
+for volume verification however its primarily purpose was to be an efficient
+development tool, used to quickly locate, identify and check the correctness
+of the metadata changes made to NTFS. 
+
+If one is interested only in the NTFS metadata changes then it could be useful
+to compare the metadata images created by 
+using the --metadata option of
+.BR ntfsclone (8)
+to eliminate the usually uninteresting timestamp changes.
+
+The terse output of
+.B ntfscmp
+is intentional because the provided information is enough in each case
+to determine the exact differences. This can be achieved, for instance,
+if one compares the verbose outputs of
+.BR ntfsinfo (8)
+for each reported inodes by the 
+.BR diff (1)
+utility.
+.SH OPTIONS
+Below is a summary of the options that
+.B ntfscmp
+accepts.
+.TP
+\fB\-P\fR, \fB\-\-no\-progress\-bar\fR
+Don't show progress bars.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+More informational output.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display help and exit.
+.SH EXIT CODES
+The exit code is 0 on success, non\-zero otherwise.
+.SH KNOWN ISSUES
+No problem is known. If you would find otherwise then please send
+your report to the development team:
+.nh
+linux\-ntfs\-dev@lists.sourceforge.net
+.hy
+.SH AUTHOR
+.B ntfscmp
+was written by Szabolcs Szakacsits (szaka@sienet.hu).
+.SH AVAILABILITY
+.B ntfscmp
+is part of the
+.B ntfsprogs
+package and is available from:
+.br
+.nh
+http://www.linux\-ntfs.org/content/view/19/37
+.hy
+.sp
+The manual pages are available online at:
+.br
+.nh
+http://man.linux-ntfs.org/
+.hy
+.SH SEE ALSO
+.BR ntfsinfo (8),
+.BR ntfscat (8),
+.BR diff (1),
+.BR ntfsclone (8),
+.BR ntfsprogs (8)