Add git ignore file to avoid accidentially including build products in repository
[binmatch.git] / README
1 binmatch performs a binary-matching search for the file <needle> in the file <haystack>,
2 reporting the offset of <needle> in <haystack> for each occurrence.
3
4 Offsets are reported in hexadecimal unless the "-d" decimal option is used.
5
6 Program information messages are written to stderr to avoid confusing the matching address
7 reports that are written to stdout. This allows the program to be used with pipes and further filters.
8
9 The program uses memory-mapped files to make the search as efficient as possible.
10
11 Usage: ./binmatch:  [-d] -n <needle> -h <haystack>
12         -d      print matching addresses in decimal not hexadecimal
13         -n      path to the file containing the needle
14         -h      path to the file containing the haystack
15
16         Information messages are written to stderr and only matches are written to stdout.
17         This allows the output to be piped through other filters.
18