Imported Debian patch 2.0.1+dfsg-1
[packages/binwalk.git] / debian / binwalk.1
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.44.1.
2 .TH BINWALK "1" "August 2014" "binwalk v2.0.1" "User Commands"
3 .SH NAME
4 binwalk \- tool for searching binary images for embedded files and executable code
5 .SH SYNOPSIS
6 .B binwalk
7 [\fIOPTIONS\fR] [\fIFILE1\fR] [\fIFILE2\fR] [\fIFILE3\fR] ...
8 .SH DESCRIPTION
9 Binwalk v2.0.0
10 Craig Heffner, http://www.binwalk.org
11 .SS "Signature Scan Options:"
12 .TP
13 \fB\-B\fR, \fB\-\-signature\fR
14 Scan target file(s) for common file signatures
15 .TP
16 \fB\-R\fR, \fB\-\-raw=\fR<str>
17 Scan target file(s) for the specified sequence of bytes
18 .TP
19 \fB\-A\fR, \fB\-\-opcodes\fR
20 Scan target file(s) for common executable opcodes
21 .TP
22 \fB\-C\fR, \fB\-\-cast\fR
23 Cast offsets as a given data type (use \fB\-y\fR to specify the data type / endianness)
24 .TP
25 \fB\-m\fR, \fB\-\-magic=\fR<file>
26 Specify a custom magic file to use
27 .TP
28 \fB\-b\fR, \fB\-\-dumb\fR
29 Disable smart signature keywords
30 .SS "Extraction Options:"
31 .TP
32 \fB\-e\fR, \fB\-\-extract\fR
33 Automatically extract known file types
34 .TP
35 \fB\-D\fR, \fB\-\-dd=\fR<type:ext:cmd>
36 Extract <type> signatures, give the files an extension of <ext>, and execute <cmd>
37 .TP
38 \fB\-M\fR, \fB\-\-matryoshka\fR
39 Recursively scan extracted files
40 .TP
41 \fB\-d\fR, \fB\-\-depth=\fR<int>
42 Limit matryoshka recursion depth (default: 8 levels deep)
43 .TP
44 \fB\-j\fR, \fB\-\-size=\fR<int>
45 Limit the size of each extracted file
46 .TP
47 \fB\-r\fR, \fB\-\-rm\fR
48 Cleanup extracted / zero\-size files after extraction
49 .TP
50 \fB\-z\fR, \fB\-\-carve\fR
51 Carve data from files, but don't execute extraction utilities
52 .SS "Entropy Analysis Options:"
53 .TP
54 \fB\-E\fR, \fB\-\-entropy\fR
55 Calculate file entropy
56 .TP
57 \fB\-J\fR, \fB\-\-save\fR
58 Save plot as a PNG
59 .TP
60 \fB\-N\fR, \fB\-\-nplot\fR
61 Do not generate an entropy plot graph
62 .TP
63 \fB\-Q\fR, \fB\-\-nlegend\fR
64 Omit the legend from the entropy plot graph
65 .SS "Binary Diffing Options:"
66 .TP
67 \fB\-W\fR, \fB\-\-hexdump\fR
68 Perform a hexdump / diff of a file or files
69 .TP
70 \fB\-G\fR, \fB\-\-green\fR
71 Only show lines containing bytes that are the same among all files
72 .TP
73 \fB\-i\fR, \fB\-\-red\fR
74 Only show lines containing bytes that are different among all files
75 .TP
76 \fB\-U\fR, \fB\-\-blue\fR
77 Only show lines containing bytes that are different among some files
78 .TP
79 \fB\-w\fR, \fB\-\-terse\fR
80 Diff all files, but only display a hex dump of the first file
81 .SS "Fuzzy Hash Options:"
82 .TP
83 \fB\-F\fR, \fB\-\-fuzzy\fR
84 Perform fuzzy hash matching on files/directories
85 .TP
86 \fB\-u\fR, \fB\-\-cutoff=\fR<int>
87 Set the cutoff percentage
88 .TP
89 \fB\-S\fR, \fB\-\-strings\fR
90 Diff strings inside files instead of the entire file
91 .TP
92 \fB\-s\fR, \fB\-\-same\fR
93 Only show files that are the same
94 .TP
95 \fB\-p\fR, \fB\-\-diff\fR
96 Only show files that are different
97 .TP
98 \fB\-n\fR, \fB\-\-name\fR
99 Only compare files whose base names are the same
100 .TP
101 \fB\-L\fR, \fB\-\-symlinks\fR
102 Don't ignore symlinks
103 .SS "Heuristic Compression Options:"
104 .TP
105 \fB\-H\fR, \fB\-\-heuristic\fR
106 Heuristically classify high entropy data
107 .TP
108 \fB\-a\fR, \fB\-\-trigger=\fR<float>
109 Set the entropy trigger level (0.0 \- 1.0, default: 0.90)
110 .SS "Raw Compression Options:"
111 .TP
112 \fB\-X\fR, \fB\-\-deflate\fR
113 Scan for raw deflate compression streams
114 .SS "Binary Visualization Options:"
115 .TP
116 \fB\-3\fR, \fB\-\-3D\fR
117 Generate a 3D binary visualization
118 .TP
119 \fB\-2\fR, \fB\-\-2D\fR
120 Project data points onto 3D cube walls only
121 .TP
122 \fB\-Z\fR, \fB\-\-points=\fR<int>
123 Set the maximum number of plotted data points
124 .TP
125 \fB\-V\fR, \fB\-\-grids\fR
126 Display the x\-y\-z grids in the resulting plot
127 .SS "General Options:"
128 .TP
129 \fB\-l\fR, \fB\-\-length=\fR<int>
130 Number of bytes to scan
131 .TP
132 \fB\-o\fR, \fB\-\-offset=\fR<int>
133 Start scan at this file offset
134 .TP
135 \fB\-K\fR, \fB\-\-block=\fR<int>
136 Set file block size
137 .TP
138 \fB\-g\fR, \fB\-\-swap=\fR<int>
139 Reverse every n bytes before scanning
140 .TP
141 \fB\-I\fR, \fB\-\-invalid\fR
142 Show results marked as invalid
143 .TP
144 \fB\-x\fR, \fB\-\-exclude=\fR<str>
145 Exclude results that match <str>
146 .TP
147 \fB\-y\fR, \fB\-\-include=\fR<str>
148 Only show results that match <str>
149 .TP
150 \fB\-f\fR, \fB\-\-log=\fR<file>
151 Log results to file
152 .TP
153 \fB\-c\fR, \fB\-\-csv\fR
154 Log results to file in CSV format
155 .TP
156 \fB\-t\fR, \fB\-\-term\fR
157 Format output to fit the terminal window
158 .TP
159 \fB\-q\fR, \fB\-\-quiet\fR
160 Suppress output to stdout
161 .TP
162 \fB\-v\fR, \fB\-\-verbose\fR
163 Enable verbose output
164 .TP
165 \fB\-h\fR, \fB\-\-help\fR
166 Show help output