From: TJ <ubuntu@tjworld.net>
Date: Tue, 26 Oct 2010 05:19:11 +0000 (+0100)
Subject: Include a description
X-Git-Url: https://iam.tj/gitweb/gitweb.cgi?p=binmatch.git;a=commitdiff_plain;h=985963008b0544239a17e0f085eb6c83c75d7bdb

Include a description
---

diff --git a/README b/README
new file mode 100644
index 0000000..bc3d007
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+binmatch performs a binary-matching search for the file <needle> in the file <haystack>,
+reporting the offset of <needle> in <haystack> for each occurance.
+
+Offsets are reported in hexadecimal unless the "-d" decimal option is used.
+
+Program information messages are written to stderr to avoid confusing the matching address
+reports that are written to stdout. This allows the program to be used with pipes and further filters.
+
+The program uses memory-mapped files to make the search as efficient as possible.
+
+Usage: ./binmatch:  [-d] -n <needle> -h <haystack>
+	-d	print matching addresses in decimal not hexadecimal
+	-n	path to the file containing the needle
+	-h	path to the file containing the haystack
+
+	Information messages are written to stderr and only matches are written to stdout.
+	This allows the output to be piped through other filters.
+